https://github.com/stackonehq/stackone-client-csharp

C# SDK for the StackOne API
https://github.com/stackonehq/stackone-client-csharp
Last synced: 12 months ago
JSON representation
C# SDK for the StackOne API
Host: GitHub
URL: https://github.com/stackonehq/stackone-client-csharp
Owner: StackOneHQ
Created: 2025-07-18T15:20:00.000Z (12 months ago)
Default Branch: main
Last Pushed: 2025-07-18T17:08:27.000Z (12 months ago)
Last Synced: 2025-07-18T20:48:50.782Z (12 months ago)
Language: C#
Size: 201 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project

README

          # 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

* [StackOne.Client](#stackoneclient)

  * [SDK Installation](#sdk-installation)

  * [SDK Example Usage](#sdk-example-usage)

  * [Authentication](#authentication)

  * [Available Resources and Operations](#available-resources-and-operations)

  * [Pagination](#pagination)

  * [Retries](#retries)

  * [Error Handling](#error-handling)

  * [Server Selection](#server-selection)

* [Development](#development)

  * [Maturity](#maturity)

  * [Contributions](#contributions)

## SDK Installation

### NuGet

To add the [NuGet](https://www.nuget.org/) package to a .NET project:

```bash

dotnet add package StackOneHQ.Client

```

### Locally

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

```bash

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

```

## SDK Example Usage

### List Employees

```csharp

using StackOneHQ.Client;

using StackOneHQ.Client.Models.Components;

using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {

    Username = "",

    Password = "",

});

HrisListEmployeesRequest req = new HrisListEmployeesRequest() {

    XAccountId = "",

    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 = "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:

```csharp

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.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 = "",

    OriginOwnerName = "",

};

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

// handle response

```

## Available Resources and Operations

Available methods

### [Accounts](docs/sdks/accounts/README.md)

* [List](docs/sdks/accounts/README.md#list) - List Accounts

* [Get](docs/sdks/accounts/README.md#get) - Get Account

* [Delete](docs/sdks/accounts/README.md#delete) - Delete Account

* [Update](docs/sdks/accounts/README.md#update) - Update Account

* [GetMeta](docs/sdks/accounts/README.md#getmeta) - Get meta information of the account

### [Applications](docs/sdks/applications/README.md)

* [GetScorecard](docs/sdks/applications/README.md#getscorecard) - Get Application Scorecard

### [Ats](docs/sdks/ats/README.md)

* [ListApplications](docs/sdks/ats/README.md#listapplications) - List Applications

* [Get](docs/sdks/ats/README.md#get) - Get Application

* [GetApplicationChanges](docs/sdks/ats/README.md#getapplicationchanges) - List Application Changes

* [ListApplicationNotes](docs/sdks/ats/README.md#listapplicationnotes) - List Application Notes

* [CreateApplicationNote](docs/sdks/ats/README.md#createapplicationnote) - Create Application Note

* [GetNote](docs/sdks/ats/README.md#getnote) - Get Application Note

* [UpdateNote](docs/sdks/ats/README.md#updatenote) - Update an Application Note

* [DocumentsUpload](docs/sdks/ats/README.md#documentsupload) - Upload Application Document

* [GetDocument](docs/sdks/ats/README.md#getdocument) - Get Application Document

* [ListCandidates](docs/sdks/ats/README.md#listcandidates) - List Candidates

* [UpdateCandidate](docs/sdks/ats/README.md#updatecandidate) - Update Candidate

* [CreateNote](docs/sdks/ats/README.md#createnote) - Create Candidate Note

* [GetCandidateNote](docs/sdks/ats/README.md#getcandidatenote) - Get Candidate Note

* [ListJobCustomFieldDefinitions](docs/sdks/ats/README.md#listjobcustomfielddefinitions) - List Job Custom Field Definitions

* [GetDepartments](docs/sdks/ats/README.md#getdepartments) - List Departments

* [ListJobs](docs/sdks/ats/README.md#listjobs) - List Jobs

* [CreateJob](docs/sdks/ats/README.md#createjob) - Create Job

* [UpdateJob](docs/sdks/ats/README.md#updatejob) - Update Job

* [GetUser](docs/sdks/ats/README.md#getuser) - Get User

* [ListJobPostings](docs/sdks/ats/README.md#listjobpostings) - List Job Postings

* [OrderAssessments](docs/sdks/ats/README.md#orderassessments) - Order Assessments Request

* [AssessmentsUpdateResult](docs/sdks/ats/README.md#assessmentsupdateresult) - Update Assessments Result

* [UpdateBackgroundCheckPackage](docs/sdks/ats/README.md#updatebackgroundcheckpackage) - Update Background Check Package

* [OrderBackgroundCheck](docs/sdks/ats/README.md#orderbackgroundcheck) - Order Background Check Request

* [UpdateBackgroundCheckResult](docs/sdks/ats/README.md#updatebackgroundcheckresult) - Update Background Check Result

#### [Ats.Applications](docs/sdks/atsapplications/README.md)

* [Create](docs/sdks/atsapplications/README.md#create) - Create Application

* [Update](docs/sdks/atsapplications/README.md#update) - Update an Application

* [ListOffers](docs/sdks/atsapplications/README.md#listoffers) - List Application Offers

* [Move](docs/sdks/atsapplications/README.md#move) - Move Application

* [Reject](docs/sdks/atsapplications/README.md#reject) - Reject Application

* [GetOffer](docs/sdks/atsapplications/README.md#getoffer) - Get Application Offer

* [ScorecardsList](docs/sdks/atsapplications/README.md#scorecardslist) - List Application Scorecards

* [ListScheduledInterviews](docs/sdks/atsapplications/README.md#listscheduledinterviews) - List Applications scheduled interviews

* [GetScheduledInterview](docs/sdks/atsapplications/README.md#getscheduledinterview) - Get Applications scheduled interview

* [DownloadDocument](docs/sdks/atsapplications/README.md#downloaddocument) - Download Application Document

* [ListCustomFieldDefinitions](docs/sdks/atsapplications/README.md#listcustomfielddefinitions) - List Application Custom Field Definitions

* [GetCustomFieldDefinition](docs/sdks/atsapplications/README.md#getcustomfielddefinition) - Get Application Custom Field Definition

#### [Ats.Applications.Documents](docs/sdks/applicationsdocuments/README.md)

* [List](docs/sdks/applicationsdocuments/README.md#list) - List Application Documents

#### [Ats.Assessments](docs/sdks/assessments/README.md)

* [PackagesList](docs/sdks/assessments/README.md#packageslist) - List Assessments Packages

* [GetResults](docs/sdks/assessments/README.md#getresults) - Get Assessments Results

#### [Ats.Assessments.Packages](docs/sdks/assessmentspackages/README.md)

* [Get](docs/sdks/assessmentspackages/README.md#get) - Get Assessments Package

#### [Ats.BackgroundChecks](docs/sdks/atsbackgroundchecks/README.md)

* [PackagesList](docs/sdks/atsbackgroundchecks/README.md#packageslist) - List Background Check Packages

* [CreatePackage](docs/sdks/atsbackgroundchecks/README.md#createpackage) - Create Background Check Package

* [GetResults](docs/sdks/atsbackgroundchecks/README.md#getresults) - Get Background Check Results

#### [Ats.BackgroundChecks.Packages](docs/sdks/backgroundcheckspackages/README.md)

* [Get](docs/sdks/backgroundcheckspackages/README.md#get) - Get Background Check Package

#### [Ats.Candidates](docs/sdks/candidates/README.md)

* [Create](docs/sdks/candidates/README.md#create) - Create Candidate

* [Get](docs/sdks/candidates/README.md#get) - Get Candidate

#### [Ats.Candidates.CustomFieldDefinitions](docs/sdks/candidatescustomfielddefinitions/README.md)

* [Get](docs/sdks/candidatescustomfielddefinitions/README.md#get) - Get Candidate Custom Field Definition

#### [Ats.Candidates.Notes](docs/sdks/notes/README.md)

* [List](docs/sdks/notes/README.md#list) - List Candidate Notes

#### [Ats.CustomFieldDefinitions](docs/sdks/atscustomfielddefinitions/README.md)

* [ListCandidates](docs/sdks/atscustomfielddefinitions/README.md#listcandidates) - List Candidate Custom Field Definitions

* [GetJob](docs/sdks/atscustomfielddefinitions/README.md#getjob) - Get Job Custom Field Definition

#### [Ats.Departments](docs/sdks/atsdepartments/README.md)

* [Get](docs/sdks/atsdepartments/README.md#get) - Get Department

#### [Ats.Documents.ApplicationCategories](docs/sdks/applicationcategories/README.md)

* [Get](docs/sdks/applicationcategories/README.md#get) - Get Application Document Category

#### [Ats.Interviews](docs/sdks/atsinterviews/README.md)

* [List](docs/sdks/atsinterviews/README.md#list) - List Interviews

#### [Ats.InterviewStages](docs/sdks/interviewstages/README.md)

* [List](docs/sdks/interviewstages/README.md#list) - List Interview Stages

* [Get](docs/sdks/interviewstages/README.md#get) - Get Interview Stage

#### [Ats.JobPostings](docs/sdks/jobpostings/README.md)

* [Get](docs/sdks/jobpostings/README.md#get) - Get Job Posting

#### [Ats.Jobs](docs/sdks/atsjobs/README.md)

* [Get](docs/sdks/atsjobs/README.md#get) - Get Job

#### [Ats.Lists](docs/sdks/atslists/README.md)

* [List](docs/sdks/atslists/README.md#list) - Get all Lists

* [Get](docs/sdks/atslists/README.md#get) - Get List

#### [Ats.Locations](docs/sdks/atslocations/README.md)

* [List](docs/sdks/atslocations/README.md#list) - List locations

* [Get](docs/sdks/atslocations/README.md#get) - Get Location

#### [Ats.Offers](docs/sdks/offers/README.md)

* [List](docs/sdks/offers/README.md#list) - List Offers

* [Create](docs/sdks/offers/README.md#create) - Creates an offer

* [Get](docs/sdks/offers/README.md#get) - Get Offer

#### [Ats.RejectedReasons](docs/sdks/rejectedreasons/README.md)

* [List](docs/sdks/rejectedreasons/README.md#list) - List Rejected Reasons

* [Get](docs/sdks/rejectedreasons/README.md#get) - Get Rejected Reason

#### [Ats.Users](docs/sdks/atsusers/README.md)

* [List](docs/sdks/atsusers/README.md#list) - List Users

### [BackgroundChecks](docs/sdks/backgroundchecks/README.md)

* [DeletePackage](docs/sdks/backgroundchecks/README.md#deletepackage) - Delete Background Check Package

### [Connectors](docs/sdks/connectors/README.md)

* [ListMeta](docs/sdks/connectors/README.md#listmeta) - List Connectors Meta Information for all providers

* [GetMeta](docs/sdks/connectors/README.md#getmeta) - Get Connector Meta information for the given provider key

### [ConnectSessions](docs/sdks/connectsessions/README.md)

* [Create](docs/sdks/connectsessions/README.md#create) - Create Connect Session

* [Authenticate](docs/sdks/connectsessions/README.md#authenticate) - Authenticate Connect Session

### [Courses](docs/sdks/courses/README.md)

* [List](docs/sdks/courses/README.md#list) - List Courses

### [Crm](docs/sdks/crm/README.md)

* [GetContact](docs/sdks/crm/README.md#getcontact) - Get Contact

* [UpdateContact](docs/sdks/crm/README.md#updatecontact) - Update Contact (early access)

* [ListAccounts](docs/sdks/crm/README.md#listaccounts) - List Accounts

* [GetAccount](docs/sdks/crm/README.md#getaccount) - Get Account

#### [Crm.Contacts](docs/sdks/contacts/README.md)

* [List](docs/sdks/contacts/README.md#list) - List Contacts

* [Create](docs/sdks/contacts/README.md#create) - Creates a new Contact

#### [Crm.CustomFieldDefinitions.Contacts](docs/sdks/customfielddefinitionscontacts/README.md)

* [List](docs/sdks/customfielddefinitionscontacts/README.md#list) - List Contact Custom Field Definitions

* [Get](docs/sdks/customfielddefinitionscontacts/README.md#get) - Get Contact Custom Field Definition

#### [Crm.Lists](docs/sdks/crmlists/README.md)

* [List](docs/sdks/crmlists/README.md#list) - Get all Lists

* [Get](docs/sdks/crmlists/README.md#get) - Get List

### [Documents](docs/sdks/documents/README.md)

* [ListApplicationCategories](docs/sdks/documents/README.md#listapplicationcategories) - List Application Document Categories

* [UploadFile](docs/sdks/documents/README.md#uploadfile) - Upload File

#### [Documents.Drives](docs/sdks/documentsdrives/README.md)

* [List](docs/sdks/documentsdrives/README.md#list) - List Drives

#### [Documents.Files](docs/sdks/files/README.md)

* [Download](docs/sdks/files/README.md#download) - Download File

* [List](docs/sdks/files/README.md#list) - List Files

* [Get](docs/sdks/files/README.md#get) - Get File

#### [Documents.Folders](docs/sdks/folders/README.md)

* [List](docs/sdks/folders/README.md#list) - List Folders

* [Get](docs/sdks/folders/README.md#get) - Get Folder

### [Drives](docs/sdks/drives/README.md)

* [Get](docs/sdks/drives/README.md#get) - Get Drive

### [Hris](docs/sdks/hris/README.md)

* [GetCompanies](docs/sdks/hris/README.md#getcompanies) - List Companies

* [GetCompany](docs/sdks/hris/README.md#getcompany) - Get Company

* [GetEmployeeCustomFieldDefinition](docs/sdks/hris/README.md#getemployeecustomfielddefinition) - Get employee Custom Field Definition

* [GetEmployee](docs/sdks/hris/README.md#getemployee) - Get Employee

* [ListEmployeeTimeOffRequests](docs/sdks/hris/README.md#listemployeetimeoffrequests) - List Employee Time Off Requests

* [GetEmployeeTimeOffRequest](docs/sdks/hris/README.md#getemployeetimeoffrequest) - Get Employees Time Off Request

* [CancelEmployeeTimeOff](docs/sdks/hris/README.md#cancelemployeetimeoff) - Cancel Employee Time Off Request

* [UpdateEmployeeTimeOffRequest](docs/sdks/hris/README.md#updateemployeetimeoffrequest) - Update Employee Time Off Request

* [UploadEmployeeDocument](docs/sdks/hris/README.md#uploademployeedocument) - Upload Employee Document

* [ListEmployeeDocuments](docs/sdks/hris/README.md#listemployeedocuments) - List Employee Documents

* [GetEmployeeDocument](docs/sdks/hris/README.md#getemployeedocument) - Get Employee Document

* [ListEmployeeTimeOffBalances](docs/sdks/hris/README.md#listemployeetimeoffbalances) - List Employee Time Off Balances

* [GetEmployeeTimeOffBalance](docs/sdks/hris/README.md#getemployeetimeoffbalance) - Get Employee Time Off Balance

* [GetEmployment](docs/sdks/hris/README.md#getemployment) - Get Employment

* [GetGroup](docs/sdks/hris/README.md#getgroup) - Get Group

* [GetTeamGroup](docs/sdks/hris/README.md#getteamgroup) - Get Team Group

* [GetLocation](docs/sdks/hris/README.md#getlocation) - Get Work Location

* [ListPositions](docs/sdks/hris/README.md#listpositions) - List Positions

* [GetPosition](docs/sdks/hris/README.md#getposition) - Get Position

* [ListTimeEntries](docs/sdks/hris/README.md#listtimeentries) - List Time Entries

* [GetTimeEntry](docs/sdks/hris/README.md#gettimeentry) - Get Time Entry

* [GetTimeOffRequest](docs/sdks/hris/README.md#gettimeoffrequest) - Get time off request

* [ListShifts](docs/sdks/hris/README.md#listshifts) - List Shifts

* [~~ListTimeOffTypes~~](docs/sdks/hris/README.md#listtimeofftypes) - List time off types :warning: **Deprecated**

* [ListTimeOffPolicies](docs/sdks/hris/README.md#listtimeoffpolicies) - List Time Off Policies

* [GetTimeOffPolicy](docs/sdks/hris/README.md#gettimeoffpolicy) - Get Time Off Policy

* [ListBenefits](docs/sdks/hris/README.md#listbenefits) - List benefits

* [CreateEmployeeSkill](docs/sdks/hris/README.md#createemployeeskill) - Create Employee Skill

* [GetEmployeeTask](docs/sdks/hris/README.md#getemployeetask) - Get Employee Task

* [GetTask](docs/sdks/hris/README.md#gettask) - Get Task

#### [Hris.Benefits](docs/sdks/benefits/README.md)

* [Get](docs/sdks/benefits/README.md#get) - Get Benefit

#### [Hris.Companies](docs/sdks/companies/README.md)

* [Get](docs/sdks/companies/README.md#get) - Get Company Group

#### [Hris.Departments](docs/sdks/hrisdepartments/README.md)

* [Get](docs/sdks/hrisdepartments/README.md#get) - Get Department Group

#### [Hris.Documents.EmployeeCategories](docs/sdks/employeecategories/README.md)

* [List](docs/sdks/employeecategories/README.md#list) - List Employee Document Categories

* [Get](docs/sdks/employeecategories/README.md#get) - Get Employee Document Category

#### [Hris.Employees](docs/sdks/employees/README.md)

* [ListCustomFieldDefinitions](docs/sdks/employees/README.md#listcustomfielddefinitions) - List employee Custom Field Definitions

* [List](docs/sdks/employees/README.md#list) - List Employees

* [Create](docs/sdks/employees/README.md#create) - Creates an employee

* [Update](docs/sdks/employees/README.md#update) - Updates an employee

* [Invite](docs/sdks/employees/README.md#invite) - Invite Employee

* [CreateTimeOff](docs/sdks/employees/README.md#createtimeoff) - Create Employee Time Off Request

* [BatchUploadDocument](docs/sdks/employees/README.md#batchuploaddocument) - Batch Upload Employee Document

* [WorkEligibilityList](docs/sdks/employees/README.md#workeligibilitylist) - List Employee Work Eligibility

* [CreateWorkEligibilityRequest](docs/sdks/employees/README.md#createworkeligibilityrequest) - Create Employee Work Eligibility Request

* [GetWorkEligibility](docs/sdks/employees/README.md#getworkeligibility) - Get Employees Work Eligibility

* [CreateEmployment](docs/sdks/employees/README.md#createemployment) - Create Employee Employment

* [GetEmployment](docs/sdks/employees/README.md#getemployment) - Get Employee Employment

* [ListTimeOffPolicies](docs/sdks/employees/README.md#listtimeoffpolicies) - List Assigned Time Off Policies

* [GetSkill](docs/sdks/employees/README.md#getskill) - Get Employee Skill

#### [Hris.Employees.Documents](docs/sdks/employeesdocuments/README.md)

* [Download](docs/sdks/employeesdocuments/README.md#download) - Download Employee Document

#### [Hris.Employees.Employments](docs/sdks/employeesemployments/README.md)

* [List](docs/sdks/employeesemployments/README.md#list) - List Employee Employments

* [Update](docs/sdks/employeesemployments/README.md#update) - Update Employee Employment

#### [Hris.Employees.Skills](docs/sdks/employeesskills/README.md)

* [List](docs/sdks/employeesskills/README.md#list) - List Employee Skills

#### [Hris.Employees.Tasks](docs/sdks/employeestasks/README.md)

* [List](docs/sdks/employeestasks/README.md#list) - List Employee Tasks

#### [Hris.Employees.WorkEligibility](docs/sdks/workeligibility/README.md)

* [UpdateRequest](docs/sdks/workeligibility/README.md#updaterequest) - Update Employee Work Eligibility Request

#### [Hris.Employments](docs/sdks/employments/README.md)

* [List](docs/sdks/employments/README.md#list) - List Employments

#### [Hris.Groups](docs/sdks/hrisgroups/README.md)

* [List](docs/sdks/hrisgroups/README.md#list) - List Groups

* [ListDepartments](docs/sdks/hrisgroups/README.md#listdepartments) - List Department Groups

* [ListCostCenters](docs/sdks/hrisgroups/README.md#listcostcenters) - List Cost Center Groups

* [ListTeams](docs/sdks/hrisgroups/README.md#listteams) - List Team Groups

* [ListDivisions](docs/sdks/hrisgroups/README.md#listdivisions) - List Division Groups

#### [Hris.Groups.Companies](docs/sdks/groupscompanies/README.md)

* [List](docs/sdks/groupscompanies/README.md#list) - List Companies Groups

#### [Hris.Groups.CostCenters](docs/sdks/costcenters/README.md)

* [Get](docs/sdks/costcenters/README.md#get) - Get Cost Center Group

#### [Hris.Groups.Divisions](docs/sdks/divisions/README.md)

* [Get](docs/sdks/divisions/README.md#get) - Get Division Group

#### [Hris.Jobs](docs/sdks/hrisjobs/README.md)

* [List](docs/sdks/hrisjobs/README.md#list) - List Jobs

* [Get](docs/sdks/hrisjobs/README.md#get) - Get Job

#### [Hris.Locations](docs/sdks/hrislocations/README.md)

* [List](docs/sdks/hrislocations/README.md#list) - List Work Locations

#### [Hris.Shifts](docs/sdks/shifts/README.md)

* [Get](docs/sdks/shifts/README.md#get) - Get Shift

#### [Hris.Tasks](docs/sdks/tasks/README.md)

* [List](docs/sdks/tasks/README.md#list) - List Tasks

#### [Hris.TimeOff](docs/sdks/timeoff/README.md)

* [List](docs/sdks/timeoff/README.md#list) - List time off requests

#### [~~Hris.TimeOffTypes~~](docs/sdks/timeofftypes/README.md)

* [~~Get~~](docs/sdks/timeofftypes/README.md#get) - Get time off type :warning: **Deprecated**

### [Iam](docs/sdks/iam/README.md)

* [DeleteUser](docs/sdks/iam/README.md#deleteuser) - Delete User

* [ListRoles](docs/sdks/iam/README.md#listroles) - List Roles

* [GetRole](docs/sdks/iam/README.md#getrole) - Get Role

* [GetGroup](docs/sdks/iam/README.md#getgroup) - Get Group

* [ListPolicies](docs/sdks/iam/README.md#listpolicies) - List Policies

#### [Iam.Groups](docs/sdks/iamgroups/README.md)

* [List](docs/sdks/iamgroups/README.md#list) - List Groups

#### [Iam.Policies](docs/sdks/policies/README.md)

* [Get](docs/sdks/policies/README.md#get) - Get Policy

#### [Iam.Users](docs/sdks/iamusers/README.md)

* [List](docs/sdks/iamusers/README.md#list) - List Users

* [Get](docs/sdks/iamusers/README.md#get) - Get User

* [Update](docs/sdks/iamusers/README.md#update) - Update User

### [Interviews](docs/sdks/interviews/README.md)

* [Get](docs/sdks/interviews/README.md#get) - Get Interview

### [Lms](docs/sdks/lms/README.md)

* [GetCourse](docs/sdks/lms/README.md#getcourse) - Get Course

* [ListUserAssignments](docs/sdks/lms/README.md#listuserassignments) - List User Assignments

* [BatchUpsertContent](docs/sdks/lms/README.md#batchupsertcontent) - Batch Upsert Content

* [ListContent](docs/sdks/lms/README.md#listcontent) - List Content

* [CreateUserCompletion](docs/sdks/lms/README.md#createusercompletion) - Create User Completion

* [GetUserCompletion](docs/sdks/lms/README.md#getusercompletion) - Get User Completion

* [DeleteUserCompletion](docs/sdks/lms/README.md#deleteusercompletion) - Delete User Completion

* [GetCategory](docs/sdks/lms/README.md#getcategory) - Get Category

* [ListUsers](docs/sdks/lms/README.md#listusers) - List Users

* [GetUser](docs/sdks/lms/README.md#getuser) - Get User

* [ListSkills](docs/sdks/lms/README.md#listskills) - List Skills

#### [Lms.Assignments](docs/sdks/assignments/README.md)

* [Create](docs/sdks/assignments/README.md#create) - Create User Assignment

* [List](docs/sdks/assignments/README.md#list) - List Assignments

* [Get](docs/sdks/assignments/README.md#get) - Get Assignment

#### [Lms.Categories](docs/sdks/categories/README.md)

* [List](docs/sdks/categories/README.md#list) - List Categories

#### [Lms.Completions](docs/sdks/completions/README.md)

* [List](docs/sdks/completions/README.md#list) - List Completions

* [Get](docs/sdks/completions/README.md#get) - Get Completion

#### [Lms.Content](docs/sdks/content/README.md)

* [Upsert](docs/sdks/content/README.md#upsert) - Upsert Content

* [Get](docs/sdks/content/README.md#get) - Get Content

* [Update](docs/sdks/content/README.md#update) - Update Content

#### [Lms.Skills](docs/sdks/lmsskills/README.md)

* [Get](docs/sdks/lmsskills/README.md#get) - Get Skill

#### [Lms.Users](docs/sdks/lmsusers/README.md)

* [ListCompletions](docs/sdks/lmsusers/README.md#listcompletions) - List User Completions

#### [Lms.UsersAssignments](docs/sdks/usersassignments/README.md)

* [Get](docs/sdks/usersassignments/README.md#get) - Get User Assignment

### [Marketing](docs/sdks/marketing/README.md)

* [TemplatesListEmail](docs/sdks/marketing/README.md#templateslistemail) - List Email Templates

* [CreateEmailTemplate](docs/sdks/marketing/README.md#createemailtemplate) - Create Email Templates

* [GetEmailTemplate](docs/sdks/marketing/README.md#getemailtemplate) - Get Email Templates

* [UpdateEmailTemplate](docs/sdks/marketing/README.md#updateemailtemplate) - Update Email Templates

* [TemplatesListInApp](docs/sdks/marketing/README.md#templateslistinapp) - List In-App Templates

* [CreateInAppTemplate](docs/sdks/marketing/README.md#createinapptemplate) - Create In-App Template

* [ListSmsTemplates](docs/sdks/marketing/README.md#listsmstemplates) - List SMS Templates

* [CreateSmsTemplate](docs/sdks/marketing/README.md#createsmstemplate) - Create SMS Template

* [UpdateSmsTemplate](docs/sdks/marketing/README.md#updatesmstemplate) - Update SMS Template

* [~~ListOmniChannelTemplates~~](docs/sdks/marketing/README.md#listomnichanneltemplates) - List Omni-Channel Templates :warning: **Deprecated**

* [~~GetOmniChannelTemplate~~](docs/sdks/marketing/README.md#getomnichanneltemplate) - Get Omni-Channel Template :warning: **Deprecated**

* [~~UpdateOmniChannelTemplate~~](docs/sdks/marketing/README.md#updateomnichanneltemplate) - Update Omni-Channel Template :warning: **Deprecated**

* [TemplatesListPush](docs/sdks/marketing/README.md#templateslistpush) - List Push Templates

* [UpdatePushTemplate](docs/sdks/marketing/README.md#updatepushtemplate) - Update Push Template

* [ListContentBlocks](docs/sdks/marketing/README.md#listcontentblocks) - List Content Blocks

* [CreateContentBlock](docs/sdks/marketing/README.md#createcontentblock) - Create Content Block

* [GetContentBlock](docs/sdks/marketing/README.md#getcontentblock) - Get Content Blocks

#### [Marketing.Campaigns](docs/sdks/campaigns/README.md)

* [List](docs/sdks/campaigns/README.md#list) - List campaigns

* [Get](docs/sdks/campaigns/README.md#get) - Get campaign

#### [Marketing.ContentBlocks](docs/sdks/contentblocks/README.md)

* [Update](docs/sdks/contentblocks/README.md#update) - Update Content Block

#### [Marketing.Templates](docs/sdks/templates/README.md)

* [~~CreateOmniChannel~~](docs/sdks/templates/README.md#createomnichannel) - Create Omni-Channel Template :warning: **Deprecated**

* [CreatePush](docs/sdks/templates/README.md#createpush) - Create Push Template

* [GetPush](docs/sdks/templates/README.md#getpush) - Get Push Template

#### [Marketing.Templates.InApp](docs/sdks/inapp/README.md)

* [Get](docs/sdks/inapp/README.md#get) - Get In-App Template

* [Update](docs/sdks/inapp/README.md#update) - Update In-App Template

#### [Marketing.Templates.Sms](docs/sdks/sms/README.md)

* [Get](docs/sdks/sms/README.md#get) - Get SMS Template

### [Proxy](docs/sdks/proxy/README.md)

* [Perform](docs/sdks/proxy/README.md#perform) - Proxy Request

### [RequestLogs](docs/sdks/requestlogs/README.md)

* [ListSteps](docs/sdks/requestlogs/README.md#liststeps) - List Step Logs

* [Get](docs/sdks/requestlogs/README.md#get) - Get a Log

* [List](docs/sdks/requestlogs/README.md#list) - List Logs

### [Ticketing](docs/sdks/ticketing/README.md)

* [GetUser](docs/sdks/ticketing/README.md#getuser) - Get User

* [DownloadAttachment](docs/sdks/ticketing/README.md#downloadattachment) - Download Attachment

* [ListTicketTypes](docs/sdks/ticketing/README.md#listtickettypes) - List Ticket Types

* [GetTicketType](docs/sdks/ticketing/README.md#gettickettype) - Get Ticket Type

* [ListCollections](docs/sdks/ticketing/README.md#listcollections) - List Collections

* [ListCollectionTicketTypes](docs/sdks/ticketing/README.md#listcollectiontickettypes) - List Collection Ticket Types

#### [Ticketing.Collections](docs/sdks/collections/README.md)

* [Get](docs/sdks/collections/README.md#get) - Get Collection

#### [Ticketing.Comments](docs/sdks/comments/README.md)

* [Get](docs/sdks/comments/README.md#get) - Get Comment

#### [Ticketing.Tickets](docs/sdks/tickets/README.md)

* [List](docs/sdks/tickets/README.md#list) - List Tickets

* [Create](docs/sdks/tickets/README.md#create) - Create Ticket

* [Get](docs/sdks/tickets/README.md#get) - Get Ticket

* [Update](docs/sdks/tickets/README.md#update) - Update Ticket

* [ListAttachments](docs/sdks/tickets/README.md#listattachments) - List Attachments

* [ListStatuses](docs/sdks/tickets/README.md#liststatuses) - List Ticket Statuses

#### [Ticketing.Tickets.Attachments](docs/sdks/attachments/README.md)

* [Get](docs/sdks/attachments/README.md#get) - Get Attachment

#### [Ticketing.Tickets.Comments](docs/sdks/ticketscomments/README.md)

* [List](docs/sdks/ticketscomments/README.md#list) - List Comments

#### [Ticketing.Users](docs/sdks/ticketingusers/README.md)

* [List](docs/sdks/ticketingusers/README.md#list) - List 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:

```csharp

using StackOneHQ.Client;

using StackOneHQ.Client.Models.Components;

using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {

    Username = "",

    Password = "",

});

HrisListCompaniesRequest req = new HrisListCompaniesRequest() {

    XAccountId = "",

    Fields = "id,remote_id,name,full_name,display_name,created_at,updated_at",

    Filter = new HrisListCompaniesFilter() {

        UpdatedAfter = "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:

```csharp

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.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 = "",

    OriginOwnerName = "",

};

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:

```csharp

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.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 = "",

    OriginOwnerName = "",

};

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

```csharp

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.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 = "",

        OriginOwnerName = "",

    };

    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:

```csharp

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.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 = "",

    OriginOwnerName = "",

};

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](https://www.speakeasy.com/?utm_source=stack-one-client&utm_campaign=csharp)
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/stackonehq/stackone-client-csharp

Awesome Lists containing this project

README
