### Initialize Guides Object

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/guides.md

Demonstrates how to import and initialize an empty Guides object in TypeScript.

```typescript
import { Guides } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Guides = {};
```

--------------------------------

### Instantiate Setup Model

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/setup.md

Demonstrates how to import and instantiate the Setup model with an empty sections array.

```typescript
import { Setup } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Setup = {
  sections: [],
};
```

--------------------------------

### CreateAssessmentOrderResult Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/createassessmentorderresult.md

Demonstrates how to instantiate and use the CreateAssessmentOrderResult model in TypeScript. Ensure you have the necessary SDK package installed.

```typescript
import { CreateAssessmentOrderResult } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: CreateAssessmentOrderResult = {
  id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  testUrl: "https://exmaple.com/integrations/candidate/test",
};
```

--------------------------------

### HrisUpdateEmploymentRequestDtoType Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/hrisupdateemploymentrequestdtotype.md

Demonstrates how to import and use the HrisUpdateEmploymentRequestDtoType to create an employment object. Ensure you have the necessary SDK package installed.

```typescript
import { HrisUpdateEmploymentRequestDtoType } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: HrisUpdateEmploymentRequestDtoType = {
  id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  label: "Permanent",
  remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  type: {},
};

```

--------------------------------

### Initialize SetupInformation

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/setupinformation.md

Demonstrates how to import and initialize an empty SetupInformation object. This is useful for creating a new configuration or when starting with default values.

```typescript
import { SetupInformation } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: SetupInformation = {};
```

--------------------------------

### TypeScript Example Usage

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/atsdeletebackgroundcheckpackagerequest.md

Demonstrates how to instantiate and use the AtsDeleteBackgroundCheckPackageRequest model in TypeScript. Ensure you have the necessary SDK package installed.

```typescript
import { AtsDeleteBackgroundCheckPackageRequest } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: AtsDeleteBackgroundCheckPackageRequest = {
  prefer: "heartbeat",
  id: "<id>",
  xAccountId: "<id>",
};
```

--------------------------------

### Instantiate GuideStepMeta

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/guidestepmeta.md

Demonstrates how to import and instantiate the GuideStepMeta model with required fields.

```typescript
import { GuideStepMeta } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: GuideStepMeta = {
  content: "<value>",
  title: "<value>",
};
```

--------------------------------

### LmsGetCourseRequest Usage Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/lmsgetcourserequest.md

Demonstrates how to import and instantiate the LmsGetCourseRequest model with common fields. Ensure you have the necessary SDK package installed.

```typescript
import { LmsGetCourseRequest } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: LmsGetCourseRequest = {
  prefer: "heartbeat",
  fields:
    "id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider,localizations,authors,unified_custom_fields",
  id: "<id>",
  xAccountId: "<id>",
};

```

--------------------------------

### Instantiate GuideSectionMeta

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/guidesectionmeta.md

Demonstrates how to import and instantiate the GuideSectionMeta model with required fields.

```typescript
import { GuideSectionMeta } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: GuideSectionMeta = {
  content: "<value>",
  title: "<value>",
};
```

--------------------------------

### HrisListShiftsRequest Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/hrislistshiftsrequest.md

Demonstrates how to instantiate and use the HrisListShiftsRequest model with filter options and account ID. Ensure the SDK is installed and imported correctly.

```typescript
import { HrisListShiftsRequest } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: HrisListShiftsRequest = {
  prefer: "heartbeat",
  filter: {
    endsBefore: "2024-01-15T17:00",
    startsAfter: "2024-01-15T09:00",
    updatedAfter: new Date("2020-01-01T00:00:00.000Z"),
  },
  xAccountId: "<id>",
};
```

--------------------------------

### AtsGetApplicationRequest Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/atsgetapplicationrequest.md

Demonstrates how to instantiate and configure an AtsGetApplicationRequest object. This is useful for setting request parameters like 'prefer', 'expand', 'fields', 'id', 'include', and 'xAccountId'.

```typescript
import { AtsGetApplicationRequest } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: AtsGetApplicationRequest = {
  prefer: "heartbeat",
  expand: "documents",
  fields:
    "id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields",
  id: "<id>",
  include: "attachments,custom_fields",
  xAccountId: "<id>",
};

```

--------------------------------

### Get User with Standalone Function

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdks/messaging/README.md

This example demonstrates using the standalone `messagingGetUser` function for better tree-shaking performance. It requires initializing `StackOneCore` and passing it along with the user parameters.

```typescript
import { StackOneCore } from "@stackone/stackone-client-ts/core.js";
import { messagingGetUser } from "@stackone/stackone-client-ts/funcs/messagingGetUser.js";

// Use `StackOneCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const stackOne = new StackOneCore({
  security: {
    password: "",
    username: "",
  },
});

async function run() {
  const res = await messagingGetUser(stackOne, {
    prefer: "heartbeat",
    fields: "id,remote_id,email,username,name,first_name,last_name,bot,active,unified_custom_fields",
    id: "<id>",
    xAccountId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("messagingGetUser failed:", res.error);
  }
}

run();

```

--------------------------------

### Get Account Meta Info with Standalone Function

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdks/accounts/README.md

This example demonstrates using the standalone `accountsGetAccountMetaInfo` function for better tree-shaking performance. It requires initializing `StackOneCore` and handles potential errors from the API call.

```typescript
import { StackOneCore } from "@stackone/stackone-client-ts/core.js";
import { accountsGetAccountMetaInfo } from "@stackone/stackone-client-ts/funcs/accountsGetAccountMetaInfo.js";

// Use `StackOneCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const stackOne = new StackOneCore({
  security: {
    password: "",
    username: "",
  },
});

async function run() {
  const res = await accountsGetAccountMetaInfo(stackOne, {
    id: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("accountsGetAccountMetaInfo failed:", res.error);
  }
}

run();
```

--------------------------------

### Url Model Usage Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/url.md

Demonstrates how to instantiate and use the Url model with hostname, path, query parameters, and the full URL.

```typescript
import { Url } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Url = {
  hostname: "example.com",
  path: "/api/v1/resource",
  queryParams: {
    "page": 1,
    "limit": 10,
  },
  url: "https://example.com/api/v1/resource",
};
```

--------------------------------

### shared.IamGroup4 IamGroupSourceValue Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/iamgroupsourcevalue.md

Example of how to define a shared.IamGroup4 value for IamGroupSourceValue.

```typescript
const value: shared.IamGroup4 = {};
```

--------------------------------

### Instantiate Credentials Model

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/credentials.md

Demonstrates how to import and create an instance of the Credentials model. This is a basic starting point for setting up authentication.

```typescript
import { Credentials } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Credentials = {};
```

--------------------------------

### Instantiate CourseResult

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/courseresult.md

Demonstrates how to create an instance of the CourseResult model with sample data. Ensure you import the necessary types from the SDK.

```typescript
import { CourseResult, LanguageEnumValue } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: CourseResult = {
  data: {
    active: true,
    authors: [
      {
        id: "123",
        name: "John Doe",
      },
    ],
    categories: [
      {
        id: "12345",
        name: "Technology",
      },
    ],
    contentIds: [
      "16873-SOFTWARE-ENG-COURSE",
      "16874-SOFTWARE-ENG-COURSE",
    ],
    coverUrl: "https://www.googledrive.com/?v=16873",
    createdAt: new Date("2021-07-21T14:00:00.000Z"),
    description: "This course acts as learning content for software engineers.",
    duration: "P3Y6M4DT12H30M5S",
    externalReference: "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1",
    id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    languages: [
      {
        value: LanguageEnumValue.EnGB,
      },
    ],
    provider: "Course Provider",
    remoteContentIds: [
      "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "e3cb75bf-aa84-466e-a6c1-b8322b257a49",
    ],
    remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    skills: [
      {
        id: "12345",
        name: "Sales Techniques",
      },
    ],
    title: "Software Engineer Lv 1",
    unifiedCustomFields: {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value",
    },
    updatedAt: new Date("2021-07-21T14:00:00.000Z"),
    url: "https://www.linkedinlearning.com/?v=16873",
  },
};
```

--------------------------------

### Shared.Files4 FilesSourceValue Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/filessourcevalue.md

Example of using the shared.Files4 type for FilesSourceValue.

```typescript
const value: shared.Files4 = {};
```

--------------------------------

### Instantiate Question Object

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/question.md

Demonstrates how to create an instance of the Question model with sample data. Ensure you have imported the necessary types from the SDK.

```typescript
import { Question, QuestionSchemasValue, QuestionValue } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Question = {
  id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  multipleChoiceAnswers: [
    {
      id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    },
  ],
  parentQuestion: {
    conditionType: {
      sourceValue: "EqualsTo",
      value: QuestionSchemasValue.EqualsTo,
    },
    id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    optionIds: [
      "123e4567-e89b-12d3-a456-426614174000",
      "523e1234-e89b-fdd2-a456-762545121101",
    ],
    remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    remoteOptionIds: [
      "123e4567-e89b-12d3-a456-426614174000",
      "523e1234-e89b-fdd2-a456-762545121101",
    ],
  },
  remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  type: {
    sourceValue: "ShortText",
    value: QuestionValue.ShortText,
  },
};

```

--------------------------------

### LmsListUserCompletionsResponse Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/lmslistusercompletionsresponse.md

An example of how to import and use the LmsListUserCompletionsResponse type in TypeScript.

```APIDOC
## LmsListUserCompletionsResponse

### Description
Represents the response object for listing user completions in the LMS.

### Fields

#### `completionsPaginated`
- **Type**: [shared.CompletionsPaginated](../../../sdk/models/shared/completionspaginated.md)
- **Required**: No
- **Description**: The completions with for the users with the given identifier were retrieved.

#### `contentType`
- **Type**: *string*
- **Required**: Yes
- **Description**: HTTP response content type for this operation

#### `headers`
- **Type**: Record<string, *string*[]>
- **Required**: Yes
- **Description**: N/A

#### `statusCode`
- **Type**: *number*
- **Required**: Yes
- **Description**: HTTP response status code for this operation

#### `rawResponse`
- **Type**: [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response)
- **Required**: Yes
- **Description**: Raw HTTP response; suitable for custom response parsing.

### Example Usage
```typescript
import { LmsListUserCompletionsResponse } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: LmsListUserCompletionsResponse = {
  contentType: "<value>",
  headers: {
    "key": [
      "<value 1>",
    ],
    "key1": [
      "<value 1>",
      "<value 2>",
      "<value 3>",
    ],
  },
  statusCode: 495270,
};
```
```

--------------------------------

### LmsCreateUserAssignmentResponse Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/lmscreateuserassignmentresponse.md

An example of how to import and use the LmsCreateUserAssignmentResponse object in TypeScript.

```APIDOC
## LmsCreateUserAssignmentResponse

### Description
Represents the response object for creating a user assignment in the LMS.

### Fields

#### `contentType` (string) - Required
HTTP response content type for this operation.

#### `createResult` (shared.CreateResult) - Optional
The assignment was created successfully.

#### `headers` (Record<string, string[]>) - Required
N/A

#### `statusCode` (number) - Required
HTTP response status code for this operation.

#### `rawResponse` (Response) - Required
Raw HTTP response; suitable for custom response parsing.

### Example Usage

```typescript
import { LmsCreateUserAssignmentResponse } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: LmsCreateUserAssignmentResponse = {
  contentType: "<value>",
  headers: {
    "key": [],
    "key1": [],
    "key2": [
      "<value 1>",
    ],
  },
  statusCode: 708996,
};
```
```

--------------------------------

### Instantiate Content Model

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/content.md

Demonstrates how to create and populate a Content object using the SDK. This includes setting properties like title, description, URLs, associated IDs, and custom fields.

```typescript
import { Content, LanguageEnumValue } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Content = {
  active: true,
  authors: [
    {
      id: "123",
      name: "John Doe",
    },
  ],
  categories: [
    {
      id: "12345",
      name: "Technology",
    },
  ],
  contentUrl: "https://www.youtube.com/watch?v=16873",
  courseIds: [
    "16873-SOFTWARE-ENG-COURSE",
    "16874-SOFTWARE-ENG-COURSE",
  ],
  coverUrl: "https://www.googledrive.com/?v=16873",
  createdAt: new Date("2021-07-21T14:00:00.000Z"),
  description: "This video acts as learning content for software engineers.",
  duration: "P3Y6M4DT12H30M5S",
  externalReference: "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1",
  id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  languages: [
    {
      value: LanguageEnumValue.EnGB,
    },
  ],
  localizations: [
    {
      description:
        "This video acts as learning content for software engineers.",
      title: "Software Engineer Lv 1",
    },
  ],
  mobileLaunchContentUrl: "https://www.mobile.youtube.com/watch?v=16873",
  order: 1,
  provider: "Content Provider",
  remoteCourseIds: [
    "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "e3cb75bf-aa84-466e-a6c1-b8322b257a49",
  ],
  remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  skills: [
    {
      id: "12345",
      name: "Sales Techniques",
    },
  ],
  tags: [
    "Sales Techniques",
    "Customer Service",
  ],
  title: "Software Engineer Lv 1",
  unifiedCustomFields: {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value",
  },
  updatedAt: new Date("2021-07-21T14:00:00.000Z"),
};

```

--------------------------------

### Instantiate AtsCreateOfferRequest

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/atscreateofferrequest.md

Example of how to create an instance of AtsCreateOfferRequest with sample data. Ensure you import the necessary types from the SDK.

```typescript
import {
  AtsCreateOfferRequest,
} from "@stackone/stackone-client-ts/sdk/models/operations";
import {
  AtsCreateOfferRequestDtoValue,
} from "@stackone/stackone-client-ts/sdk/models/shared";

let value: AtsCreateOfferRequest = {
  atsCreateOfferRequestDto: {
    offerHistory: [
      {
        createdAt: new Date("2021-01-01T01:01:01.000Z"),
        startDate: new Date("2021-01-01T01:01:01.000Z"),
        updatedAt: new Date("2021-01-01T01:01:01.000Z"),
      },
    ],
    offerStatus: {
      sourceValue: "Pending",
      value: AtsCreateOfferRequestDtoValue.Pending,
    },
    passthrough: {
      "other_known_names": "John Doe",
    },
    startDate: new Date("2021-01-01T01:01:01.000Z"),
  },
  prefer: "heartbeat",
  xAccountId: "<id>",
};
```

--------------------------------

### HrisGetEmployeeDocumentRequest Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/hrisgetemployeedocumentrequest.md

An example of how to instantiate and use the HrisGetEmployeeDocumentRequest object in TypeScript.

```APIDOC
## HrisGetEmployeeDocumentRequest

### Description
Represents a request to retrieve an employee document from the HRIS system. Allows specifying preferred return fields and other request options.

### Fields

#### `prefer` (string) - Optional
Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example: `heartbeat`

#### `fields` (string) - Optional
The comma separated list of fields that will be returned in the response (if empty, all fields are returned).

Example: `id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields`

#### `id` (string) - Required
Identifier for the employee document.

#### `subResourceId` (string) - Optional
Identifier for a sub-resource related to the employee document.

#### `xAccountId` (string) - Optional
Identifier for the account associated with the request.
```

--------------------------------

### Instantiate Offer Model

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/offer.md

Example of how to create an Offer object with various fields, including custom fields. Ensure all necessary imports are present.

```typescript
import { Offer, OfferValue } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Offer = {
  createdAt: new Date("2021-01-01T01:01:01.000Z"),
  id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  offerHistory: null,
  offerStatus: {
    sourceValue: "Pending",
    value: OfferValue.Pending,
  },
  remoteApplicationId: "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  startDate: new Date("2021-01-01T01:01:01.000Z"),
  unifiedCustomFields: {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value",
  },
  updatedAt: new Date("2021-01-01T01:01:01.000Z"),
};
```

--------------------------------

### AtsGetDepartmentResponse Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/atsgetdepartmentresponse.md

An example of how to import and use the AtsGetDepartmentResponse type in TypeScript.

```APIDOC
## AtsGetDepartmentResponse

### Description
Represents the response object for the AtsGetDepartment operation.

### Fields

#### `contentType` (string) - Required
HTTP response content type for this operation.

#### `departmentResult` (shared.DepartmentResult) - Optional
The department with the given identifier was retrieved.

#### `headers` (Record<string, string[]>) - Required
HTTP response headers.

#### `statusCode` (number) - Required
HTTP response status code for this operation.

#### `rawResponse` (Response) - Required
Raw HTTP response; suitable for custom response parsing.

### Example Usage

```typescript
import { AtsGetDepartmentResponse } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: AtsGetDepartmentResponse = {
  contentType: "<value>",
  headers: {
    "key": [
      "<value 1>",
      "<value 2>",
    ],
  },
  statusCode: 881565,
};
```
```

--------------------------------

### Shared LmsCreateCompletionRequestDto4 Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/lmscreatecompletionrequestdtosourcevalue.md

Example of how to declare and assign an object of type shared.LmsCreateCompletionRequestDto4.

```typescript
const value: shared.LmsCreateCompletionRequestDto4 = {};
```

--------------------------------

### Application Model Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/application.md

Demonstrates how to instantiate and populate the Application model with various fields including application stage, status, candidate details, custom fields, and documents. This is useful for creating or updating application data.

```typescript
import { AnswerValue, Application, ApplicationValue, AtsDocumentApiModelValue } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Application = {
  applicationStage: {
    createdAt: new Date("2021-01-01T01:01:01.000Z"),
    id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    name: "Review",
    order: 1,
    remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    unifiedCustomFields: {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value",
    },
    updatedAt: new Date("2021-01-01T01:01:01.000Z"),
  },
  applicationStageId: "18bcbb1b-3cbc-4198-a999-460861d19480",
  applicationStatus: {
    sourceValue: "Hired",
    value: ApplicationValue.Hired,
  },
  candidate: {
    company: "Company Inc.",
    email: "john.doe@example.com",
    emails: [
      {
        type: "personal",
        value: "sestier.romain123@gmail.com",
      },
    ],
    firstName: "John",
    lastName: "Doe",
    name: "Romain Sestier",
    phoneNumbers: [
      {
        phone: "+447700112233",
      },
    ],
    socialLinks: [
      {
        type: "linkedin",
        url: "https://www.linkedin.com/in/romainsestier/",
      },
    ],
    title: "Software Engineer",
  },
  candidateId: "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  createdAt: new Date("2021-01-01T01:01:01.000Z"),
  customFields: [
    {
      id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      name: "Training Completion Status",
      remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      remoteValueId: "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      value: "Completed",
      valueId: "value_456",
    },
  ],
  documents: [
    {
      category: {},
      categoryId: "6530",
      createdAt: new Date("2021-01-01T01:01:01.000Z"),
      fileFormat: {
        sourceValue: "application/pdf",
        value: AtsDocumentApiModelValue.Pdf,
      },
      id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      name: "My Document",
      remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      remoteUrl: "https://example.com/file.pdf",
      unifiedCustomFields: {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value",
      },
      updatedAt: new Date("2021-01-02T01:01:01.000Z"),
    },
  ],
  id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  jobId: "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
  locationIds: [
    "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
  ],
  questionnaires: [
    {
      answers: [
        {
          id: "answer1",
          type: {
            sourceValue: "Short Text",
            value: AnswerValue.ShortText,
          },
          values: [
            "Yes",
          ],
        },
      ],
      id: "right_to_work",
    },
  ],
  rejectedAt: new Date("2021-01-01T01:01:01.000Z"),
  rejectedReasonIds: [
    "f223d7f6-908b-48f0-9237-b201c307f609",
  ],
  rejectedReasons: [
    {
      id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      label: "Failed Phone Screen",
      rejectedReasonType: null,
      remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      unifiedCustomFields: {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value",
      },
    },
  ],
  remoteApplicationStageId: "18bcbb1b-3cbc-4198-a999-460861d19480",
  remoteCandidateId: "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  remoteJobId: "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
  remoteLocationIds: [
    "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
  ],
  remoteRejectedReasonIds: [
    "f223d7f6-908b-48f0-9237-b201c307f609",
  ],
  resultLinks: [
    {
      label: "test result link",
      url: "http://example.com/test-result/4565765/data",
    },
  ],
  source: {
    id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    name: "LinkedIn",
    remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  },
  unifiedCustomFields: {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value",
  },
  updatedAt: new Date("2021-01-01T01:01:01.000Z"),
};

```

--------------------------------

### Shared IamUserSchemas4 Type Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/iamuserschemassourcevalue.md

Example of using the shared.IamUserSchemas4 type for IamUserSchemasSourceValue.

```typescript
const value: shared.IamUserSchemas4 = {};
```

--------------------------------

### CreateJournalLine Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/createjournalline.md

Demonstrates how to instantiate the CreateJournalLine model with sample data. Ensure you have the necessary SDK package imported.

```typescript
import { CreateJournalLine } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: CreateJournalLine = {
  accountId: "acc_123456789",
  amount: 10010,
  description: "Payment for office supplies",
  taxAmount: 10010,
  taxRateId: "tax_123456789",
};
```

--------------------------------

### Instantiate AtsGetApplicationOfferRequest

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/atsgetapplicationofferrequest.md

Example of how to instantiate the AtsGetApplicationOfferRequest model with common parameters like 'prefer', 'fields', 'id', 'subResourceId', and 'xAccountId'.

```typescript
import { AtsGetApplicationOfferRequest } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: AtsGetApplicationOfferRequest = {
  prefer: "heartbeat",
  fields:
    "id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields",
  id: "<id>",
  subResourceId: "<id>",
  xAccountId: "<id>",
};

```

--------------------------------

### HrisDocumentApiModel4 Value Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/hrisdocumentapimodelsourcevalue.md

Provides an example of assigning a shared.HrisDocumentApiModel4 object to HrisDocumentApiModelSourceValue.

```typescript
const value: shared.HrisDocumentApiModel4 = {};
```

--------------------------------

### HrisCreateTimeOffRequestDtoSchemas4 Type Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/hriscreatetimeoffrequestdtoschemassourcevalue.md

Example of how to declare and assign an object of type shared.HrisCreateTimeOffRequestDtoSchemas4.

```typescript
const value: shared.HrisCreateTimeOffRequestDtoSchemas4 = {};
```

--------------------------------

### Instantiate Resources Model

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/resources.md

Example of how to create an instance of the Resources model with image URLs.

```typescript
import { Resources } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Resources = {
  images: {
    logoUrl: "https://app.stackone.com/assets/logos/hibob.png",
    originalLogoHorizontalUrl:
      "https://app.stackone.com/assets/logos/original/hibob_horizontal.png",
  },
};
```

--------------------------------

### MinimumProficiency Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/minimumproficiency.md

Demonstrates how to import and instantiate the MinimumProficiency model with sample data.

```typescript
import { MinimumProficiency } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: MinimumProficiency = {
  id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  name: "Expert",
  remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
};
```

--------------------------------

### Shared CreateMessage4 Object Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/createmessagesourcevalue.md

Example of assigning a shared.CreateMessage4 object to CreateMessageSourceValue.

```typescript
const value: shared.CreateMessage4 = {};
```

--------------------------------

### StackoneMcpPostSecurity Usage

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/stackonemcppostsecurity.md

Example of how to import and initialize the StackoneMcpPostSecurity model.

```APIDOC
## StackoneMcpPostSecurity

### Description
Represents the security configuration for MCP POST operations.

### Fields

#### `apiKey`
- **Type**: `string`
- **Required**: No
- **Description**: API key for authentication.

#### `basic`
- **Type**: `shared.SchemeBasic` (referencing `../sdk/models/shared/schemebasic.md`)
- **Required**: No
- **Description**: Basic authentication scheme, typically containing username and password.
```

--------------------------------

### Shared Campaign2 Type Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/archived.md

Example of using the shared.Campaign2 archived type.

```typescript
const value: shared.Campaign2 = Campaign2.True;
```

--------------------------------

### EmploymentDepartment Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/employmentdepartment.md

Demonstrates how to create an instance of the EmploymentDepartment model with various properties.

```typescript
import { EmploymentDepartment, EmploymentSchemasDepartmentValue } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: EmploymentDepartment = {
  companyId: "1234567890",
  id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  name: "Engineering",
  ownerIds: [
    "cxIQNjUyEDM0",
    "cxIQNjQzNzA0MQ",
  ],
  parentIds: [
    "cxIQNjUyNDM0",
    "cxIQNjQzNzI0MQ",
  ],
  remoteCompanyId: "1234567890",
  remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  remoteOwnerIds: [
    "475364",
    "4327652",
  ],
  remoteParentIds: [
    "652434",
    "6437241",
  ],
  type: {
    value: EmploymentSchemasDepartmentValue.Team,
  },
  unifiedCustomFields: {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value",
  },
};
```

--------------------------------

### AtsListApplicationsScheduledInterviewsRequest Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/atslistapplicationsscheduledinterviewsrequest.md

An example demonstrating how to instantiate and use the AtsListApplicationsScheduledInterviewsRequest object in TypeScript.

```APIDOC
## AtsListApplicationsScheduledInterviewsRequest

### Description
Represents the request object for listing scheduled interviews for ATS applications.

### Fields

#### `prefer`
- **Type**: string
- **Required**: No
- **Description**: Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)
- **Example**: heartbeat

#### `fields`
- **Type**: string
- **Required**: No
- **Description**: Specifies which fields to include in the response. Supports comma-separated values.
- **Example**: "id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields"

#### `filter`
- **Type**: null
- **Required**: No
- **Description**: Placeholder for filter criteria (currently null in example).
- **Example**: null

#### `id`
- **Type**: string
- **Required**: No
- **Description**: Identifier for the request (placeholder).
- **Example**: "<id>"

#### `xAccountId`
- **Type**: string
- **Required**: No
- **Description**: Account ID for the request (placeholder).
- **Example**: "<id>"

### Example Usage
```typescript
import { AtsListApplicationsScheduledInterviewsRequest } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: AtsListApplicationsScheduledInterviewsRequest = {
  prefer: "heartbeat",
  fields:
    "id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields",
  filter: null,
  id: "<id>",
  xAccountId: "<id>",
};
```
```

--------------------------------

### Install with Yarn

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/README.md

Install the StackOne Client TypeScript SDK using yarn.

```bash
yarn add @stackone/stackone-client-ts
```

--------------------------------

### Instantiate FileT Object

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/filet.md

Demonstrates how to create an instance of the FileT model with sample data. Ensure all required fields are populated correctly.

```typescript
import { FileT, FileValue } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: FileT = {
  category: {},
  categoryId: "6530",
  createdAt: new Date("2021-01-01T01:01:01.000Z"),
  fileFormat: {
    sourceValue: "application/pdf",
    value: FileValue.Pdf,
  },
  id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  name: "My Document",
  remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  remoteUrl: "https://example.com/file.pdf",
  updatedAt: new Date("2021-01-02T01:01:01.000Z"),
};
```

--------------------------------

### AtsListApplicationsRequest Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/operations/atslistapplicationsrequest.md

Demonstrates how to instantiate and configure an AtsListApplicationsRequest object with various parameters like prefer, expand, fields, filter, include, and xAccountId.

```typescript
import { AtsListApplicationsRequest } from "@stackone/stackone-client-ts/sdk/models/operations";

let value: AtsListApplicationsRequest = {
  prefer: "heartbeat",
  expand: "documents",
  fields:
    "id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields",
  filter: {
    createdAfter: new Date("2020-01-01T00:00:00.000Z"),
    updatedAfter: new Date("2020-01-01T00:00:00.000Z"),
  },
  include: "attachments,custom_fields",
  xAccountId: "<id>",
};

```

--------------------------------

### Install with Bun

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/README.md

Install the StackOne Client TypeScript SDK using bun.

```bash
bun add @stackone/stackone-client-ts
```

--------------------------------

### Install with PNPM

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/README.md

Install the StackOne Client TypeScript SDK using pnpm.

```bash
pnpm add @stackone/stackone-client-ts
```

--------------------------------

### Instantiate AccountingCompanyResult

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/accountingcompanyresult.md

Demonstrates how to create an instance of AccountingCompanyResult with sample data. Ensure you have the necessary types imported from the SDK.

```typescript
import { AccountingCompanyResult, AccountingCompanyResultValue } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: AccountingCompanyResult = {
  data: {
    baseCurrency: {
      sourceValue: "USD",
      value: AccountingCompanyResultValue.Usd,
    },
    fiscalYearStartDay: 1,
    fiscalYearStartMonth: 1,
    id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    name: "Acme Corp",
    remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  },
};
```

--------------------------------

### CreatePackage Model Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/createpackage.md

Demonstrates how to instantiate the CreatePackage model with required fields.

```typescript
import { CreatePackage } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: CreatePackage = {
  description:
    "Skills test to gauge a candidate's proficiency in job-specific skills",
  name: "Test 1",
};
```

--------------------------------

### Install with NPM

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/README.md

Install the StackOne Client TypeScript SDK using npm.

```bash
npm add @stackone/stackone-client-ts
```

--------------------------------

### Create a Config Object

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/config.md

Example of how to instantiate and populate a Config object with sections.

```typescript
import { Config } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: Config = {
  sections: [
    {
      content: "<value>",
      title: "<value>",
    },
  ],
};
```

--------------------------------

### Shared Content2 ContentActive Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/contentactive.md

Example of using the shared.Content2 enum for content activity.

```typescript
const value: shared.Content2 = Content2.False;
```

--------------------------------

### Instantiate OffersResult

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/offersresult.md

Demonstrates how to create an instance of the OffersResult model with sample data. Ensure you have imported OffersResult and OfferValue from the SDK.

```typescript
import { OffersResult, OfferValue } from "@stackone/stackone-client-ts/sdk/models/shared";

let value: OffersResult = {
  data: {
    createdAt: new Date("2021-01-01T01:01:01.000Z"),
    id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    offerHistory: [
      {
        createdAt: new Date("2021-01-01T01:01:01.000Z"),
        startDate: new Date("2021-01-01T01:01:01.000Z"),
        updatedAt: new Date("2021-01-01T01:01:01.000Z"),
      },
    ],
    offerStatus: {
      sourceValue: "Pending",
      value: OfferValue.Pending,
    },
    remoteApplicationId: "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    remoteId: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    startDate: new Date("2021-01-01T01:01:01.000Z"),
    unifiedCustomFields: {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value",
    },
    updatedAt: new Date("2021-01-01T01:01:01.000Z"),
  },
};
```

--------------------------------

### AccountingCompany4 Type Example

Source: https://github.com/stackonehq/stackone-client-typescript/blob/main/docs/sdk/models/shared/accountingcompanysourcevalue.md

Example of assigning an empty object to a variable typed as shared.AccountingCompany4.

```typescript
const value: shared.AccountingCompany4 = {};
```