### SyncFinishedWebhookPayload Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/syncfinishedwebhookpayload.md

Demonstrates how to import and instantiate the SyncFinishedWebhookPayload in TypeScript. Ensure you have the Kombo SDK installed.

```typescript
import { SyncFinishedWebhookPayload } from "@kombo-api/sdk/models";

let value: SyncFinishedWebhookPayload = {
  id: "<id>",
  type: "sync-finished",
  data: {
    sync_id: "<id>",
    sync_state: "<value>",
    sync_started_at: new Date("2024-10-08T05:46:10.483Z"),
    sync_ended_at: new Date("2024-09-10T14:02:10.039Z"),
    sync_duration_seconds: 56309,
    integration_id: "<id>",
    integration_tool: "<value>",
    integration_category: "ATS",
    end_user: {
      organization_name: "<value>",
      creator_email: "Austen11@yahoo.com",
      origin_id: "<id>",
    },
    log_url: "https://sad-tenant.com/",
  },
};
```

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

### GetAtsApplicationStagesPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsapplicationstagespositiveresponse.md

Demonstrates how to import and instantiate the GetAtsApplicationStagesPositiveResponse model with sample data. Ensure the SDK is installed and imported correctly.

```typescript
import { GetAtsApplicationStagesPositiveResponse } from "@kombo-api/sdk/models";

let value: GetAtsApplicationStagesPositiveResponse = {
  status: "success",
  data: {
    next:
      "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    results: [
      {
        id: "5J7L4b48wBfffYwek9Az9pkM",
        remote_id: "32",
        name: "Initial Screening",
        changed_at: new Date("2022-08-07T14:01:29.196Z"),
        remote_deleted_at: null,
      },
    ],
  },
};
```

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

### Example Usage of PutAtsApplicationsApplicationIdStagePositiveResponse

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/putatsapplicationsapplicationidstagepositiveresponse.md

Demonstrates how to import and initialize the PutAtsApplicationsApplicationIdStagePositiveResponse model. Ensure the SDK is installed.

```typescript
import { PutAtsApplicationsApplicationIdStagePositiveResponse } from "@kombo-api/sdk/models";

let value: PutAtsApplicationsApplicationIdStagePositiveResponse = {
  status: "success",
  data: {},
  warnings: [],
};
```

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

### TypeScript Example Usage

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/gethrisemployeedocumentcategoriespositiveresponse.md

Shows how to import and instantiate the GetHrisEmployeeDocumentCategoriesPositiveResponse model with sample data. Ensure the SDK is installed and imported correctly.

```typescript
import { GetHrisEmployeeDocumentCategoriesPositiveResponse } from "@kombo-api/sdk/models";

let value: GetHrisEmployeeDocumentCategoriesPositiveResponse = {
  status: "success",
  data: {
    next:
      "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    results: [
      {
        id: "26vafvWSRmbhNcxJYqjCzuJg",
        remote_id: "32",
        name: "Employment contract",
        changed_at: new Date("2022-08-07T14:01:29.196Z"),
        remote_deleted_at: null,
      },
    ],
  },
};
```

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

### Create HRIS Employee with Kombo SDK (Full Example)

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/sdks/hris/README.md

This example shows a comprehensive way to create an HRIS employee using the Kombo SDK, including detailed properties like first name, start date, and work location with key numbers. It demonstrates a more complete data payload.

```typescript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.hris.createEmployeeWithForm({
    properties: {
      "firstName": "John",
      "startDate": "2025-01-01T00:00:00Z",
      "workLocation": {
        "site": "8e422bf8cav",
        "keyNumbers": {
          "0": 142,
          "1": 525,
          "2": 63,
        },
      },
    },
  });

  console.log(result);
}

run();
```

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

### GetAtsRolesPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsrolespositiveresponse.md

Demonstrates how to import and instantiate the GetAtsRolesPositiveResponse model with sample data. Ensure you have the SDK installed.

```typescript
import { GetAtsRolesPositiveResponse } from "@kombo-api/sdk/models";

let value: GetAtsRolesPositiveResponse = {
  status: "success",
  data: {
    next:
      "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    results: [
      {
        id: "26vafvWSRmbhNcxJYqjCzuJg",
        remote_id: "32",
        remote_label: "Hiring Manager",
        scope: "JOB",
        unified_type: "HIRING_MANAGER",
        changed_at: new Date("2022-08-07T14:01:29.196Z"),
        remote_deleted_at: null,
      },
    ],
  },
};
```

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

### TypeScript Example Usage

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/postatscandidatesrequestbodycountrycityreference.md

Demonstrates how to import and initialize a PostAtsCandidatesRequestBodyCountryCityReference object in TypeScript. Ensure the SDK is installed.

```typescript
import { PostAtsCandidatesRequestBodyCountryCityReference } from "@kombo-api/sdk/models";

let value: PostAtsCandidatesRequestBodyCountryCityReference = {
  wid: "<id>",
};
```

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

### Add Application Note - SDK Client (Specific Example)

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/sdks/ats/README.md

Example of adding an application note with specific content and application ID using the Kombo SDK client. This demonstrates a successful request.

```typescript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.ats.addApplicationNote({
    application_id: "8Xi6iZrwusZqJmDGXs49GBmJ",
    body: {
      content: "A new message from the candidate is available in YourChat!",
      content_type: "PLAIN_TEXT",
    },
  });

  console.log(result);
}

run();
```

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

### GetAtsApplicationStagesPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsapplicationstagespositiveresponse.md

An example of the GetAtsApplicationStagesPositiveResponse JSON structure, including pagination information and a list of application stages.

```json
{
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "5J7L4b48wBfffYwek9Az9pkM",
"remote_id": "32",
"name": "Initial Screening",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null
}
]
}
```

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

### Add Candidate Tag - SDK Instance (Specific Example)

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/sdks/ats/README.md

An example demonstrating how to add a specific tag 'Excellent Fit' to a candidate using the Kombo SDK instance. This requires the 'Manage tags' permission.

```typescript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.ats.addCandidateTag({
    candidate_id: "8Xi6iZrwusZqJmDGXs49GBmJ",
    body: {
      tag: {
        name: "Excellent Fit",
      },
    },
  });

  console.log(result);
}

run();
```

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

### GetAtsUsersPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsuserspositiveresponse.md

This is an example of the GetAtsUsersPositiveResponse structure, showing pagination details and a sample user entry.

```json
{
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJ YqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@kombo.dev",
"status": "ACTIVE",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"system_roles": [
{
"remote_id": "32",
"remote_label": "Hiring Manager",
"scope": "JOB",
"unified_type": "HIRING_MANAGER"
}
]
}
]
}
```

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

### Basic SDK Usage Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/README.md

Initialize the Kombo SDK with an API key and check its validity. Ensure you replace the placeholder with your actual bearer token.

```typescript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.general.checkApiKey();

  console.log(result);
}

run();
```

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

### Get Connect Integration By Token Token Positive Response Setup Status Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getconnectintegrationbytokentokenpositiveresponsesetupstatus.md

Demonstrates how to import and assign a value to the GetConnectIntegrationByTokenTokenPositiveResponseSetupStatus type.

```typescript
import { GetConnectIntegrationByTokenTokenPositiveResponseSetupStatus } from "@kombo-api/sdk/models";

let value: GetConnectIntegrationByTokenTokenPositiveResponseSetupStatus = 
  "COMPLETED";
```

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

### Get Hris Timesheets Positive Response Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/gethristimesheetspositiveresponse.md

This JSON object represents a successful response from the Get Hris Timesheets API. It includes pagination details like 'next' cursor and a 'results' array containing timesheet entries. Each timesheet entry details employee information, start and end times, breaks, approval status, and custom fields.

```json
{
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "C1BB1C36-FE1D-4185-AAB8-0716D8FBA017",
"remote_id": "446655440000",
"employee_id": "289AD550-8659-4305-92B2-6EAA006AAB17",
"started_at": "2025-04-16T09:02:00Z",
"ended_at": "2025-04-16T16:59:00Z",
"timezone": "-04:00",
"payable_hours": 8,
"unpaid_break_minutes": 30,
"breaks": [
{
"ended_at": "2025-04-16T12:30:00Z",
"paid": false,
"started_at": "2025-04-16T12:00:00Z"
}
],
"approval_status": "APPROVED",
"approved_at": "2025-04-16T17:05:31Z",
"comment": "Sprint planning \u0026 code review",
"custom_fields": {},
"integration_fields": [],
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": {}
}
]
}
```

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

### Create Setup Link (Example 1)

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/sdks/general/README.md

Use this snippet to create an embedded setup link for a specific integration. This is useful for integrating the setup flow directly into your application's UI.

```typescript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.general.createSetupLink({
    integration_id: "personio:93fCvorjZ2jas7ZekX1V1n5d",
    body: {
      link_type: "EMBEDDED",
    },
  });

  console.log(result);
}

run();
```

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

### Instantiate Interview Model

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/interview.md

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

```typescript
import { Interview } from "@kombo-api/sdk/models";

let value: Interview = {
  id: "26vafvWSRmbhNcxJYqjCzuJg",
  remote_id: "32",
  title: "Interview with John Doe",
  starting_at: new Date("2023-06-26T14:30:00Z"),
  ending_at: new Date("2023-06-26T15:30:00Z"),
  location: {
    city: "Berlin",
    country: "DE",
    raw: "Berlin, Germany",
    state: "Berlin",
    street_1: "Lohmühlenstraße 65",
    street_2: null,
    zip_code: "12435",
  },
  canceled: false,
};
```

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

### PostIntegrationsIntegrationIdSetupLinkPositiveResponseData Usage

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/postintegrationsintegrationidsetuplinkpositiveresponsedata.md

Example of how to instantiate and use the PostIntegrationsIntegrationIdSetupLinkPositiveResponseData model with a setup link.

```typescript
import { PostIntegrationsIntegrationIdSetupLinkPositiveResponseData } from "@kombo-api/sdk/models";

let value: PostIntegrationsIntegrationIdSetupLinkPositiveResponseData = {
  link: "https://snoopy-negotiation.biz",
};
```

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

### Instantiate Offer Model

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/offer.md

Demonstrates how to import and create an instance of the Offer model with essential properties.

```typescript
import { Offer } from "@kombo-api/sdk/models";

let value: Offer = {
  id: "76bab8LKuFtqpZ89mofCPMHX",
  remote_id: "6",
  status: "ACCEPTED",
};
```

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

### PutAssessmentPackagesPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/putassessmentpackagespositiveresponse.md

Demonstrates how to import and initialize a PutAssessmentPackagesPositiveResponse object. Ensure the SDK is installed.

```typescript
import { PutAssessmentPackagesPositiveResponse } from "@kombo-api/sdk/models";

let value: PutAssessmentPackagesPositiveResponse = {
  status: "success",
  data: {},
  warnings: [],
};
```

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

### Create Setup Link (Standalone Function - Example 1)

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/sdks/general/README.md

This standalone function version of createSetupLink allows for creating an embedded setup link. It provides error handling for failed requests.

```typescript
import { KomboCore } from "@kombo-api/sdk/core.js";
import { generalCreateSetupLink } from "@kombo-api/sdk/funcs/generalCreateSetupLink.js";

// Use `KomboCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const kombo = new KomboCore({
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await generalCreateSetupLink(kombo, {
    integration_id: "personio:93fCvorjZ2jas7ZekX1V1n5d",
    body: {
      link_type: "EMBEDDED",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("generalCreateSetupLink failed:", res.error);
  }
}

run();
```

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

### GetAtsInterviewsPositiveResponseApplication Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsinterviewspositiveresponseapplication.md

Demonstrates how to instantiate and use the GetAtsInterviewsPositiveResponseApplication model. Ensure the SDK is imported correctly.

```typescript
import { GetAtsInterviewsPositiveResponseApplication } from "@kombo-api/sdk/models";

let value: GetAtsInterviewsPositiveResponseApplication = {
  id: "<id>",
  remote_id: "<id>",
  outcome: "PENDING",
  rejection_reason_name: "<value>",
  candidate: {
    id: "26vafvWSRmbhNcxJYqjCzuJg",
    remote_id: "32",
    first_name: "John",
    last_name: "Doe",
    email_addresses: [
      {
        email_address: "john.doe@example.com",
        type: "PRIVATE",
      },
    ],
  },
  job: {
    id: "H5daSm8e85Dmvmne3wLeCPhX",
    remote_id: "32",
    name: "Backend Engineer",
  },
};
```

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

### Instantiate SyncFinishedWebhookPayloadData

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/syncfinishedwebhookpayloaddata.md

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

```typescript
import { SyncFinishedWebhookPayloadData } from "@kombo-api/sdk/models";

let value: SyncFinishedWebhookPayloadData = {
  sync_id: "<id>",
  sync_state: "<value>",
  sync_started_at: new Date("2024-11-28T06:47:24.021Z"),
  sync_ended_at: new Date("2025-07-22T21:53:56.960Z"),
  sync_duration_seconds: 411840,
  integration_id: "<id>",
  integration_tool: "<value>",
  integration_category: "LMS",
  end_user: {
    organization_name: "<value>",
    creator_email: "Austen11@yahoo.com",
    origin_id: "<id>",
  },
  log_url: "https://mean-provider.name/",
};
```

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

### Instantiate Employment Model

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/employment.md

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

```typescript
import { Employment } from "@kombo-api/sdk/models";

let value: Employment = {
  id: "12vpXR7BeqYNWDShXRgsonnm",
  remote_id: "859",
  employee_id: "26vafvWSRmbhNcxJYqjCzuJg",
  job_title: "Social Media Marketer",
  pay_rate: 85000,
  pay_period: "YEAR",
  pay_frequency: "SEMIMONTHLY",
  employment_type: "FULL_TIME",
  pay_currency: "EUR",
  effective_date: new Date("2021-01-30T00:00:00Z"),
  changed_at: new Date("2022-08-07T14:01:29.196Z"),
  remote_deleted_at: null,
  custom_fields: {},
};
```

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

### PostAtsJobsJobIdApplicationsPositiveResponseTag Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/postatsjobsjobidapplicationspositiveresponsetag.md

Demonstrates how to import and instantiate the PostAtsJobsJobIdApplicationsPositiveResponseTag model. Ensure you have the Kombo SDK installed.

```typescript
import { PostAtsJobsJobIdApplicationsPositiveResponseTag } from "@kombo-api/sdk/models";

let value: PostAtsJobsJobIdApplicationsPositiveResponseTag = {
  id: "26vafvWSRmbhNcxJYqjCzuJg",
  name: "High Potential",
  remote_id: "32",
};
```

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

### Instantiate IntegrationStateChangedWebhookPayloadData

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/integrationstatechangedwebhookpayloaddata.md

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

```typescript
import { IntegrationStateChangedWebhookPayloadData } from "@kombo-api/sdk/models";

let value: IntegrationStateChangedWebhookPayloadData = {
  integration_tool: "<value>",
  integration_id: "<id>",
  integration_category: "ATS",
  end_user: {
    organization_name: "<value>",
    creator_email: "Cathrine_Simonis@hotmail.com",
    origin_id: "<id>",
  },
  qa_status: "PASSED",
  setup_status: "INCOMPLETE",
  state: "INACTIVE",
  updated_at: new Date("2025-10-12T14:45:13.654Z"),
};
```

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

### Instantiate Assets Model

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/assets.md

Example of how to create an instance of the Assets model with the required URL fields.

```typescript
import { Assets } from "@kombo-api/sdk/models";

let value: Assets = {
  logo_url: "https://well-lit-cellar.biz",
  icon_url: "https://tragic-minority.org/",
  icon_black_url: "https://empty-chainstay.com/",
};
```

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

### TypeScript Example Usage

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getintegrationsintegrationidpositiveresponsereadmodel.md

Demonstrates how to import and instantiate the GetIntegrationsIntegrationIdPositiveResponseReadModel in TypeScript. Ensure you have the Kombo SDK installed.

```typescript
import { GetIntegrationsIntegrationIdPositiveResponseReadModel } from "@kombo-api/sdk/models";

let value: GetIntegrationsIntegrationIdPositiveResponseReadModel = {
  id: "<id>",
  label: "<value>",
  is_available: true,
  coverage_status: "UNSUPPORTED",
  scope_config_setting: "OPTIONAL",
  opted_out_by_customer: false,
  fields: [
    {
      id: "<id>",
      is_available: true,
      coverage_status: "UNSUPPORTED",
      scope_config_setting: "OPTIONAL",
      opted_out_by_customer: true,
    },
  ],
};
```

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

### GetAtsApplicationsApplicationIdAttachmentsPositiveResponseResult Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsapplicationsapplicationidattachmentspositiveresponseresult.md

Demonstrates how to instantiate the GetAtsApplicationsApplicationIdAttachmentsPositiveResponseResult model with sample data. Ensure all required fields are populated correctly.

```typescript
import { GetAtsApplicationsApplicationIdAttachmentsPositiveResponseResult } from "@kombo-api/sdk/models";

let value: GetAtsApplicationsApplicationIdAttachmentsPositiveResponseResult = {
  type: "OTHER",
  id: "<id>",
  remote_id: "<id>",
  data_url: "https://wealthy-fax.com",
  file_name: "example.file",
  content_type: "<value>",
  remote_created_at: null,
  remote_updated_at: new Date("2026-11-12T08:02:01.545Z"),
};
```

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

### Schema2File Model Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/schema2file.md

Demonstrates how to instantiate the Schema2File model with basic properties and file restrictions.

```typescript
import { Schema2File } from "@kombo-api/sdk/models";

let value: Schema2File = {
  label: "<value>",
  required: true,
  type: "file",
  file_restrictions: {
    accepted_mime_types: [
      "<value 1>",
      "<value 2>",
      "<value 3>",
    ],
  },
};
```

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

### IntegrationStateChangedWebhookPayloadEndUser Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/integrationstatechangedwebhookpayloadenduser.md

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

```typescript
import { IntegrationStateChangedWebhookPayloadEndUser } from "@kombo-api/sdk/models";

let value: IntegrationStateChangedWebhookPayloadEndUser = {
  organization_name: "<value>",
  creator_email: "Victor_Littel@hotmail.com",
  origin_id: null,
};
```

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

### GetHrisAbsenceTypesPositiveResponseResult Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/gethrisabsencetypespositiveresponseresult.md

This snippet shows how to import and instantiate the GetHrisAbsenceTypesPositiveResponseResult model with sample data. Ensure the SDK is installed and imported correctly.

```typescript
import { GetHrisAbsenceTypesPositiveResponseResult } from "@kombo-api/sdk/models";

let value: GetHrisAbsenceTypesPositiveResponseResult = {
  id: "xzZoKssDaMZAd62kxayzzQvD",
  remote_id: "91",
  name: "Vacation",
  unit: "DAYS",
  half_days_supported: true,
  exact_times_supported: false,
  changed_at: new Date("2022-08-07T14:01:29.196Z"),
  remote_deleted_at: null,
};
```

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

### Example Usage of DeleteHrisAbsencesAbsenceIdPositiveResponseData

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/deletehrisabsencesabsenceidpositiveresponsedata.md

Demonstrates how to import and instantiate the DeleteHrisAbsencesAbsenceIdPositiveResponseData model with sample data. Ensure the SDK is installed and imported correctly.

```typescript
import { DeleteHrisAbsencesAbsenceIdPositiveResponseData } from "@kombo-api/sdk/models";

let value: DeleteHrisAbsencesAbsenceIdPositiveResponseData = {
  id: "22st2Ji8XpncEYEak8mvQgQF",
  remote_id: "1348",
  employee_id: "JDdUy9kiH5APaGizFrgNmQjM",
  start_date: "2022-08-04T00:00:00Z",
  end_date: "2022-08-05T00:00:00Z",
  start_half_day: true,
  end_half_day: false,
  start_time: "13:15:00",
  end_time: "17:00:00",
  amount: 2,
  unit: "DAYS",
  status: "APPROVED",
  employee_note: "Visiting my family.",
  type_id: "xzZoKssDaMZAd62kxayzzQvD",
  remote_created_at: new Date("2022-08-07T14:01:29.196Z"),
  remote_updated_at: new Date("2022-08-07T14:01:29.196Z"),
  changed_at: new Date("2022-08-07T14:01:29.196Z"),
  remote_deleted_at: new Date("2022-08-07T14:01:29.196Z"),
};

```

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

### GetAtsApplicationsPositiveResponseLocation Usage Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsapplicationspositiveresponselocation.md

Demonstrates how to import and initialize an empty GetAtsApplicationsPositiveResponseLocation object. This can be used as a starting point for creating location data.

```typescript
import { GetAtsApplicationsPositiveResponseLocation } from "@kombo-api/sdk/models";

let value: GetAtsApplicationsPositiveResponseLocation = {};
```

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

### TypeScript SDK GetAtsRejectionReasonsPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsrejectionreasonspositiveresponse.md

Demonstrates how to import and instantiate the GetAtsRejectionReasonsPositiveResponse model with sample data. Ensure the SDK is installed to use this model.

```typescript
import { GetAtsRejectionReasonsPositiveResponse } from "@kombo-api/sdk/models";

let value: GetAtsRejectionReasonsPositiveResponse = {
  status: "success",
  data: {
    next:
      "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    results: [
      {
        id: "76bab8LKuFtqpZ89mofCPMHX",
        remote_id: "6",
        name: "Not a fit",
        changed_at: new Date("2022-08-07T14:01:29.196Z"),
        remote_deleted_at: null,
      },
    ],
  },
};
```

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

### IntegrationCreatedWebhookPayloadEndUser Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/integrationcreatedwebhookpayloadenduser.md

Demonstrates how to import and instantiate the IntegrationCreatedWebhookPayloadEndUser model.

```typescript
import { IntegrationCreatedWebhookPayloadEndUser } from "@kombo-api/sdk/models";

let value: IntegrationCreatedWebhookPayloadEndUser = {
  organization_name: "<value>",
  creator_email: "Janiya.Kirlin7@gmail.com",
  origin_id: "<id>",
};
```

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

### Reviewer Model Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/reviewer.md

Demonstrates how to instantiate and populate a Reviewer object. Ensure all required fields are provided.

```typescript
import { Reviewer } from "@kombo-api/sdk/models";

let value: Reviewer = {
  id: "4EeSSSd9Fr8iiW9mPKmjEVWK",
  remote_id: "1024",
  first_name: "Peter",
  last_name: "Doe",
  display_full_name: "Peter Doe",
  work_email: "peter.doe@acme.com",
  remote_deleted_at: null,
};
```

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

### Get Ats Offers Positive Response Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsofferspositiveresponse.md

This JSON object represents a successful response when fetching offers from an ATS. It includes pagination details and a list of offer results.

```json
{
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "76bab8LKuFtqpZ89mofCPMHX",
"remote_id": "6",
"status": "ACCEPTED",
"employment_start_date": "2022-08-07T14:01:29.196Z",
"application_id": "BAkbueBMBusj9Bg7L1Wps3AR",
"custom_fields": {},
"integration_fields": [],
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"remote_data": null,
"application": {
"candidate": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
]
},
"job": {
"id": "H5daSm8e85Dmvmne3wLeCPhX",
"remote_id": "32",
"name": "Backend Engineer"
}
}
}
]
}
```

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

### Instantiate GetAtsCandidatesCandidateIdAttachmentsPositiveResponse

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatscandidatescandidateidattachmentspositiveresponse.md

Demonstrates how to import and instantiate the GetAtsCandidatesCandidateIdAttachmentsPositiveResponse model with sample data. Ensure the SDK is installed and imported correctly.

```typescript
import { GetAtsCandidatesCandidateIdAttachmentsPositiveResponse } from "@kombo-api/sdk/models";

let value: GetAtsCandidatesCandidateIdAttachmentsPositiveResponse = {
  status: "success",
  data: {
    results: [
      {
        id: "EYJjhMQT3LtVKXnTbnRT8s6U",
        application_id: null,
        candidate_id: "BTbkvY2w5ou3z3hdwuKcKzDh",
        type: "CV",
        remote_id: "GUzE666zfyjeoCJX6A8n7wh6",
        data_url: "https://resources.kombo.dev/EYJjhMQT3LtVKXnTbnRT8s6U",
        file_name: "Frank Doe CV.pdf",
        content_type: "application/pdf",
        remote_created_at: null,
        remote_updated_at: null,
      },
    ],
  },
  warnings: [],
};
```

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

### GetAtsTagsPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatstagspositiveresponse.md

Demonstrates how to instantiate and use the GetAtsTagsPositiveResponse model. Ensure the SDK is imported correctly.

```typescript
import { GetAtsTagsPositiveResponse } from "@kombo-api/sdk/models";

let value: GetAtsTagsPositiveResponse = {
  status: "success",
  data: {
    next:
      "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    results: [
      {
        id: "26vafvWSRmbhNcxJYqjCzuJg",
        remote_id: "32",
        name: "High Potential",
        changed_at: new Date("2022-08-07T14:01:29.196Z"),
        remote_deleted_at: null,
      },
    ],
  },
};
```

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

### GetHrisTimesheetsPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/gethristimesheetspositiveresponse.md

Demonstrates how to instantiate and populate a GetHrisTimesheetsPositiveResponse object with sample timesheet data. This includes details like employee information, start and end times, breaks, and approval status.

```typescript
import { GetHrisTimesheetsPositiveResponse } from "@kombo-api/sdk/models";

let value: GetHrisTimesheetsPositiveResponse = {
  status: "success",
  data: {
    next:
      "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    results: [
      {
        id: "C1BB1C36-FE1D-4185-AAB8-0716D8FBA017",
        remote_id: "446655440000",
        employee_id: "289AD550-8659-4305-92B2-6EAA006AAB17",
        started_at: new Date("2025-04-16T09:02:00Z"),
        ended_at: new Date("2025-04-16T16:59:00Z"),
        timezone: "-04:00",
        payable_hours: 8,
        unpaid_break_minutes: 30,
        breaks: [
          {
            ended_at: new Date("2025-04-16T12:30:00Z"),
            paid: false,
            started_at: new Date("2025-04-16T12:00:00Z"),
          },
        ],
        approval_status: "APPROVED",
        approved_at: new Date("2025-04-16T17:05:31Z"),
        comment: "Sprint planning & code review",
        custom_fields: {},
        changed_at: new Date("2022-08-07T14:01:29.196Z"),
        remote_deleted_at: null,
      },
    ],
  },
};

```

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

### GetHrisPerformanceReviewCyclesPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/gethrisperformancereviewcyclespositiveresponse.md

Shows how to import and instantiate the GetHrisPerformanceReviewCyclesPositiveResponse model with sample data. This includes details for a performance review cycle, such as its ID, remote ID, name, start date, and change timestamp.

```typescript
import { GetHrisPerformanceReviewCyclesPositiveResponse } from "@kombo-api/sdk/models";

let value: GetHrisPerformanceReviewCyclesPositiveResponse = {
  status: "success",
  data: {
    next:
      "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    results: [
      {
        id: "4B9bKBpX5tnwjiG93TAqF7ci",
        remote_id: "1",
        name: "2025 Annual Performance Review Cycle",
        review_period_start_date: new Date("2025-01-01T00:00:00Z"),
        changed_at: new Date("2022-08-07T14:01:29.196Z"),
        remote_deleted_at: null,
      },
    ],
  },
};
```

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

### Create Job Application using Kombo SDK

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/sdks/ats/README.md

Demonstrates how to create a job application using the Kombo SDK's `ats.createApplication` method. This includes candidate details, attachments, and screening answers.

```typescript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.ats.createApplication({
    job_id: "BDpgnpZ148nrGh4mYHNxJBgx",
    body: {
      stage_id: "8x3YKRDcuRnwShdh96ShBNn1",
      candidate: {
        first_name: "Frank",
        last_name: "Doe",
        email_address: "frank.doe@example.com",
        company: "Acme Inc.",
        title: "Head of Integrations",
        phone_number: "+1-541-754-3010",
        location: {
          city: "New York",
          country: "US",
          state: "NY",
          zip_code: "10016",
        },
        gender: "MALE",
        availability_date: new Date("2021-01-01T00:00:00Z"),
        salary_expectations: {
          period: "YEAR",
          amount: 100000,
        },
      },
      attachments: [
        {
          name: "Frank Doe CV.txt",
          content_type: "text/plain",
          data: "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
          type: "CV",
        },
      ],
      screening_question_answers: [
        {
          question_id: "3phFBNXRweGnDmsU9o2vdPuQ",
          answer: "Yes",
        },
        {
          question_id: "EYJjhMQT3LtVKXnTbnRT8s6U",
          answer: [
            "GUzE666zfyjeoCJX6A8n7wh6",
            "5WPHzzKAv8cx97KtHRUV96U8",
            "7yZfKGzWigXxxRTygqAfHvyE",
          ],
        },
      ],
    },
  });

  console.log(result);
}

run();

```

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

### GetAtsUsersPositiveResponseResult Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/getatsuserspositiveresponseresult.md

Demonstrates how to instantiate and use the GetAtsUsersPositiveResponseResult model. Ensure the SDK is imported before use.

```typescript
import { GetAtsUsersPositiveResponseResult } from "@kombo-api/sdk/models";

let value: GetAtsUsersPositiveResponseResult = {
  id: "<id>",
  remote_id: null,
  first_name: "Jacky",
  last_name: "Goldner",
  status: "ACTIVE",
  changed_at: new Date("2026-01-01T19:08:47.379Z"),
  remote_deleted_at: new Date("2024-03-14T21:49:26.861Z"),
  system_roles: [
    {
      remote_id: "32",
      remote_label: "Hiring Manager",
      scope: "JOB",
      unified_type: "HIRING_MANAGER",
    },
    {
      remote_id: "32",
      remote_label: "Hiring Manager",
      scope: "JOB",
      unified_type: "HIRING_MANAGER",
    },
    {
      remote_id: "1",
      remote_label: "Admin",
      scope: "SYSTEM",
      unified_type: "ADMIN",
    },
  ],
};
```

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

### GetHrisEmployeesFormPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/gethrisemployeesformpositiveresponse.md

This snippet shows how to import and instantiate the GetHrisEmployeesFormPositiveResponse type. It includes a detailed structure for employee properties, such as first name, start date, and work location, along with potential warnings.

```typescript
import { GetHrisEmployeesFormPositiveResponse } from "@kombo-api/sdk/models";

let value: GetHrisEmployeesFormPositiveResponse = {
  status: "success",
  data: {
    properties: {
      "firstName": {
        label: "First Name",
        required: true,
        description: "Employee's first name",
        unified_key: "first_name",
        type: "text",
        min_length: 1,
        max_length: 100,
        reg_exp: null,
      },
      "startDate": {
        label: "Start Date",
        required: true,
        description: "Employee's start date",
        unified_key: "start_date",
        type: "date",
      },
      "workLocation": {
        label: "Work Location",
        required: false,
        description: "Employee's work location",
        unified_key: null,
        type: "object",
        properties: {
          "site": {
            label: "Site",
            required: true,
            description: "Employee's site",
            unified_key: null,
            type: "single_select",
            options: {
              type: "inline",
              entries: [
                {
                  id: "FXrER44xubBqA9DLgZ3PFNNx",
                  label: "Site 1",
                  unified_value: "1",
                  remote_id: "site_1",
                },
                {
                  id: "2rv75UKT2XBoQXsUb9agiTUm",
                  label: "Site 2",
                  unified_value: "2",
                  remote_id: "site_2",
                },
              ],
            },
          },
          "keyNumbers": {
            label: "Key Numbers",
            required: false,
            description: "Employee's key numbers",
            unified_key: null,
            type: "array",
            item_type: {
              label: "Key Number",
              required: false,
              description:
                "The number of the keys which belong to the employee",
              unified_key: null,
              type: "number",
              min: 0,
              max: 99,
            },
            min_items: 2,
            max_items: 5,
          },
        },
      },
    },
  },
  warnings: [
    {
      message: "<value>",
    },
  ],
};

```

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

### GetToolsCategoryPositiveResponse Example

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/gettoolscategorypositiveresponse.md

This snippet demonstrates how to import and use the GetToolsCategoryPositiveResponse model to structure a successful API response containing tool data. It includes details about tool coverage, assets, and connection guides.

```typescript
import { GetToolsCategoryPositiveResponse } from "@kombo-api/sdk/models";

let value: GetToolsCategoryPositiveResponse = {
  status: "success",
  data: {
    tools: [
      {
        id: "factorial",
        label: "Factorial",
        internal_label: null,
        assets: {
          logo_url:
            "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
          icon_url:
            "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg",
          icon_black_url:
            "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon-black.svg",
        },
        paid_api_details_markdown: null,
        fast_track_details_markdown: null,
        partner_only_details_markdown: null,
        connection_guide_url:
          "https://help.kombo.dev/hc/en-us/articles/18743884123409-Factorial-HR-How-do-I-link-my-account",
        coverage: {
          read_models: [
            {
              id: "hris_employees",
              label: "Employees",
              coverage_status: "SUPPORTED",
              fields: [
                {
                  id: "date_of_birth",
                  coverage_status: "SUPPORTED",
                },
              ],
            },
            {
              id: "hris_teams",
              label: "Groups",
              coverage_status: "UNSUPPORTED",
              fields: [
                {
                  id: "parent_id",
                  coverage_status: "UNSUPPORTED",
                },
              ],
            },
          ],
          write_actions: [
            {
              id: "hris_create_employee",
              label: "Create employee",
              coverage_status: "SUPPORTED",
              fields: [
                {
                  id: "first_name",
                  coverage_status: "SUPPORTED",
                },
              ],
            },
          ],
          features: [
            {
              id: "automatic_source_writing",
              label: "Automatic Source Writing",
              coverage_status: "SUPPORTED",
            },
          ],
        },
      },
    ],
  },
};
```

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

### Example IntegrationDeletedWebhookPayloadData

Source: https://github.com/kombohq/typescript-sdk/blob/main/docs/models/integrationdeletedwebhookpayloaddata.md

Demonstrates how to create an instance of IntegrationDeletedWebhookPayloadData with sample values. Ensure you import the type from the SDK.

```typescript
import { IntegrationDeletedWebhookPayloadData } from "@kombo-api/sdk/models";

let value: IntegrationDeletedWebhookPayloadData = {
  id: "<id>",
  tool: "<value>",
  category: "ASSESSMENT",
  end_user: {
    organization_name: "<value>",
    creator_email: "Chanel.Bechtelar40@gmail.com",
    origin_id: "<id>",
  },
  deleted_at: new Date("2024-05-06T10:21:09.462Z"),
};
```