Skip to content

speakeasy-sdks/stackone-client-csharp

BranchesTags
 
 

Repository files navigation

StackOne.Client

Developer-friendly & type-safe Csharp SDK specifically catered to leverage StackOne.Client API.

Summary

Documents: The documentation for the StackOne Unified API - DOCUMENTS

Table of Contents

SDK Installation

NuGet

To add the NuGet package to a .NET project:

dotnet add package StackOneHQ.Client

Locally

To add a reference to a local instance of the SDK in a .NET project:

dotnet add reference src/StackOneHQ/Client/StackOneHQ.Client.csproj

SDK Example Usage

List Employees

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

HrisListEmployeesRequest req = new HrisListEmployeesRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,skills",
    Filter = new HrisListEmployeesFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Expand = "company,employments,work_location,home_location,groups,skills",
    Include = "avatar_url,avatar,custom_fields,job_description,benefits",
};

HrisListEmployeesResponse? res = await sdk.Hris.Employees.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
Username
Password		 http HTTP Basic

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

ConnectSessionCreate req = new ConnectSessionCreate() {
    Categories = new List<ConnectSessionCreateCategory>() {
        ConnectSessionCreateCategory.Ats,
        ConnectSessionCreateCategory.Hris,
        ConnectSessionCreateCategory.Ticketing,
        ConnectSessionCreateCategory.Crm,
        ConnectSessionCreateCategory.Iam,
        ConnectSessionCreateCategory.Marketing,
        ConnectSessionCreateCategory.Lms,
        ConnectSessionCreateCategory.Iam,
        ConnectSessionCreateCategory.Documents,
        ConnectSessionCreateCategory.Ticketing,
        ConnectSessionCreateCategory.Screening,
        ConnectSessionCreateCategory.Messaging,
        ConnectSessionCreateCategory.Accounting,
    },
    OriginOwnerId = "<id>",
    OriginOwnerName = "<value>",
};

var res = await sdk.ConnectSessions.CreateAsync(req);

// handle response

Available Resources and Operations

Available methods

Accounts

Applications

Ats

Ats.Applications

Ats.Applications.Documents

  • List - List Application Documents

Ats.Assessments

Ats.Assessments.Packages

  • Get - Get Assessments Package

Ats.BackgroundChecks

Ats.BackgroundChecks.Packages

  • Get - Get Background Check Package

Ats.Candidates

  • Create - Create Candidate
  • Get - Get Candidate

Ats.Candidates.CustomFieldDefinitions

  • Get - Get Candidate Custom Field Definition

Ats.Candidates.Notes

  • List - List Candidate Notes

Ats.CustomFieldDefinitions

Ats.Departments

  • Get - Get Department

Ats.Documents.ApplicationCategories

  • Get - Get Application Document Category

Ats.Interviews

  • List - List Interviews

Ats.InterviewStages

  • List - List Interview Stages
  • Get - Get Interview Stage

Ats.JobPostings

  • Get - Get Job Posting

Ats.Jobs

  • Get - Get Job

Ats.Lists

  • List - Get all Lists
  • Get - Get List

Ats.Locations

  • List - List locations
  • Get - Get Location

Ats.Offers

Ats.RejectedReasons

  • List - List Rejected Reasons
  • Get - Get Rejected Reason

Ats.Users

BackgroundChecks

Connectors

  • ListMeta - List Connector Meta Information
  • GetMeta - Get Connector Meta Information

ConnectSessions

Courses

  • List - List Courses

Crm

Crm.Contacts

Crm.CustomFieldDefinitions.Contacts

  • List - List Contact Custom Field Definitions
  • Get - Get Contact Custom Field Definition

Crm.Lists

  • List - Get all Lists
  • Get - Get List

Documents

Documents.Drives

  • List - List Drives

Documents.Files

Documents.Folders

  • List - List Folders
  • Get - Get Folder

Drives

  • Get - Get Drive

Hris

Hris.Benefits

  • Get - Get Benefit

Hris.Companies

  • Get - Get Company Group

Hris.Departments

  • Get - Get Department Group

Hris.Documents.EmployeeCategories

  • List - List Employee Document Categories
  • Get - Get Employee Document Category

Hris.Employees

Hris.Employees.Documents

Hris.Employees.Employments

  • List - List Employee Employments
  • Update - Update Employee Employment

Hris.Employees.Skills

  • List - List Employee Skills

Hris.Employees.Tasks

  • List - List Employee Tasks

Hris.Employees.WorkEligibility

Hris.Employments

  • List - List Employments

Hris.Groups

Hris.Groups.Companies

  • List - List Companies Groups

Hris.Groups.CostCenters

  • Get - Get Cost Center Group

Hris.Groups.Divisions

  • Get - Get Division Group

Hris.Jobs

Hris.Locations

  • List - List Work Locations

Hris.Shifts

  • Get - Get Shift

Hris.Tasks

Hris.TimeOff

  • List - List time off requests

Hris.TimeOffTypes

  • Get - Get time off type ⚠️ Deprecated

Iam

Iam.Groups

  • List - List Groups

Iam.Policies

  • Get - Get Policy

Iam.Users

Interviews

  • Get - Get Interview

Lms

Lms.Assignments

  • Create - Create User Assignment
  • List - List Assignments
  • Get - Get Assignment

Lms.Categories

  • List - List Categories

Lms.Completions

  • List - List Completions
  • Get - Get Completion

Lms.Content

Lms.Skills

  • Get - Get Skill

Lms.Users

Lms.UsersAssignments

  • Get - Get User Assignment

Marketing

Marketing.Campaigns

  • List - List campaigns
  • Get - Get campaign

Marketing.ContentBlocks

  • Update - Update Content Block

Marketing.Templates

Marketing.Templates.InApp

  • Get - Get In-App Template
  • Update - Update In-App Template

Marketing.Templates.Sms

  • Get - Get SMS Template

Proxy

RequestLogs

Ticketing

Ticketing.Comments

  • Get - Get Comment

Ticketing.Tickets

Ticketing.Tickets.Attachments

  • Get - Get Attachment

Ticketing.Tickets.Comments

  • List - List Comments

Ticketing.Users

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is null, then there are no more pages to be fetched.

Here's an example of one such pagination call:

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

HrisListCompaniesRequest req = new HrisListCompaniesRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,full_name,display_name,created_at,updated_at",
    Filter = new HrisListCompaniesFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
};

HrisListCompaniesResponse? res = await sdk.Hris.GetCompaniesAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply pass a RetryConfig to the call:

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

ConnectSessionCreate req = new ConnectSessionCreate() {
    Categories = new List<ConnectSessionCreateCategory>() {
        ConnectSessionCreateCategory.Ats,
        ConnectSessionCreateCategory.Hris,
        ConnectSessionCreateCategory.Ticketing,
        ConnectSessionCreateCategory.Crm,
        ConnectSessionCreateCategory.Iam,
        ConnectSessionCreateCategory.Marketing,
        ConnectSessionCreateCategory.Lms,
        ConnectSessionCreateCategory.Iam,
        ConnectSessionCreateCategory.Documents,
        ConnectSessionCreateCategory.Ticketing,
        ConnectSessionCreateCategory.Screening,
        ConnectSessionCreateCategory.Messaging,
        ConnectSessionCreateCategory.Accounting,
    },
    OriginOwnerId = "<id>",
    OriginOwnerName = "<value>",
};

var res = await sdk.ConnectSessions.CreateAsync(
    retryConfig: new RetryConfig(
        strategy: RetryConfig.RetryStrategy.BACKOFF,
        backoff: new BackoffStrategy(
            initialIntervalMs: 1L,
            maxIntervalMs: 50L,
            maxElapsedTimeMs: 100L,
            exponent: 1.1
        ),
        retryConnectionErrors: false
    ),
    request: req
);

// handle response

If you'd like to override the default retry strategy for all operations that support retries, you can use the RetryConfig optional parameter when intitializing the SDK:

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(
    retryConfig: new RetryConfig(
        strategy: RetryConfig.RetryStrategy.BACKOFF,
        backoff: new BackoffStrategy(
            initialIntervalMs: 1L,
            maxIntervalMs: 50L,
            maxElapsedTimeMs: 100L,
            exponent: 1.1
        ),
        retryConnectionErrors: false
    ),
    security: new Security() {
        Username = "",
        Password = "",
    }
);

ConnectSessionCreate req = new ConnectSessionCreate() {
    Categories = new List<ConnectSessionCreateCategory>() {
        ConnectSessionCreateCategory.Ats,
        ConnectSessionCreateCategory.Hris,
        ConnectSessionCreateCategory.Ticketing,
        ConnectSessionCreateCategory.Crm,
        ConnectSessionCreateCategory.Iam,
        ConnectSessionCreateCategory.Marketing,
        ConnectSessionCreateCategory.Lms,
        ConnectSessionCreateCategory.Iam,
        ConnectSessionCreateCategory.Documents,
        ConnectSessionCreateCategory.Ticketing,
        ConnectSessionCreateCategory.Screening,
        ConnectSessionCreateCategory.Messaging,
        ConnectSessionCreateCategory.Accounting,
    },
    OriginOwnerId = "<id>",
    OriginOwnerName = "<value>",
};

var res = await sdk.ConnectSessions.CreateAsync(req);

// handle response

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.

By default, an API error will raise a StackOneHQ.Client.Models.Errors.APIException exception, which has the following properties:

Property Type Description
Message string The error message
Request HttpRequestMessage The HTTP request
Response HttpResponseMessage The HTTP response

When custom error responses are specified for an operation, the SDK may also throw their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the CreateAsync method throws the following exceptions:

Error Type Status Code Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException 400 application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException 401 application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException 403 application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException 404 application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException 408 application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException 409 application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException 422 application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException 429 application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse 500 application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException 501 application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException 502 application/json
StackOneHQ.Client.Models.Errors.APIException 4XX, 5XX */*

Example

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Errors;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

try
{
    ConnectSessionCreate req = new ConnectSessionCreate() {
        Categories = new List<ConnectSessionCreateCategory>() {
            ConnectSessionCreateCategory.Ats,
            ConnectSessionCreateCategory.Hris,
            ConnectSessionCreateCategory.Ticketing,
            ConnectSessionCreateCategory.Crm,
            ConnectSessionCreateCategory.Iam,
            ConnectSessionCreateCategory.Marketing,
            ConnectSessionCreateCategory.Lms,
            ConnectSessionCreateCategory.Iam,
            ConnectSessionCreateCategory.Documents,
            ConnectSessionCreateCategory.Ticketing,
            ConnectSessionCreateCategory.Screening,
            ConnectSessionCreateCategory.Messaging,
            ConnectSessionCreateCategory.Accounting,
        },
        OriginOwnerId = "<id>",
        OriginOwnerName = "<value>",
    };

    var res = await sdk.ConnectSessions.CreateAsync(req);

    // handle response
}
catch (Exception ex)
{
    if (ex is BadRequestResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is UnauthorizedResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is ForbiddenResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is NotFoundResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is RequestTimedOutResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is ConflictResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is UnprocessableEntityResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is TooManyRequestsResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is InternalServerErrorResponse)
    {
        // Handle exception data
        throw;
    }
    else if (ex is NotImplementedResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is BadGatewayResponseException)
    {
        // Handle exception data
        throw;
    }
    else if (ex is StackOneHQ.Client.Models.Errors.APIException)
    {
        // Handle default exception
        throw;
    }
}

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverUrl: string optional parameter when initializing the SDK client instance. For example:

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(
    serverUrl: "https://api.stackone.com",
    security: new Security() {
        Username = "",
        Password = "",
    }
);

ConnectSessionCreate req = new ConnectSessionCreate() {
    Categories = new List<ConnectSessionCreateCategory>() {
        ConnectSessionCreateCategory.Ats,
        ConnectSessionCreateCategory.Hris,
        ConnectSessionCreateCategory.Ticketing,
        ConnectSessionCreateCategory.Crm,
        ConnectSessionCreateCategory.Iam,
        ConnectSessionCreateCategory.Marketing,
        ConnectSessionCreateCategory.Lms,
        ConnectSessionCreateCategory.Iam,
        ConnectSessionCreateCategory.Documents,
        ConnectSessionCreateCategory.Ticketing,
        ConnectSessionCreateCategory.Screening,
        ConnectSessionCreateCategory.Messaging,
        ConnectSessionCreateCategory.Accounting,
    },
    OriginOwnerId = "<id>",
    OriginOwnerName = "<value>",
};

var res = await sdk.ConnectSessions.CreateAsync(req);

// handle response

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

C# SDK for the StackOne API

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • C# 100.0%