# Applicants (*ats.applicants*) ## Overview ### Available Operations * [list](#list) - List Applicants * [create](#create) - Create Applicant * [get](#get) - Get Applicant * [update](#update) - Update Applicant * [delete](#delete) - Delete Applicant ## list List Applicants ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.ats.applicants.list({ serviceId: "salesforce", filter: { jobId: "1234", }, passThrough: { "search": "San Francisco", }, fields: "id,updated_at", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { atsApplicantsList } from "@apideck/sdk/funcs/atsApplicantsList.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await atsApplicantsList(apideck, { serviceId: "salesforce", filter: { jobId: "1234", }, passThrough: { "search": "San Francisco", }, fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AtsApplicantsAllRequest](../../models/operations/atsapplicantsallrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.AtsApplicantsAllResponse](../../models/operations/atsapplicantsallresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## create Create Applicant ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; import { RFCDate } from "@apideck/sdk/types"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.ats.applicants.create({ serviceId: "salesforce", applicant: { name: "Elon Musk", firstName: "Elon", lastName: "Musk", middleName: "D.", initials: "EM", birthday: new RFCDate("2000-08-12"), coverLetter: "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photoUrl: "https://unavatar.io/elon-musk", headline: "PepsiCo, Inc, Central Perk", title: "CEO", emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", ], }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", "", ], }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], websites: [ { id: "12345", url: "http://example.com", type: "primary", }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], stageId: "12345", recruiterId: "12345", coordinatorId: "12345", applicationIds: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], applications: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], followers: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], sources: [ "Job site", ], confidential: false, anonymized: true, tags: [ "New", ], archived: false, ownerId: "54321", recordUrl: "https://app.intercom.io/contacts/12345", deleted: true, passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { atsApplicantsCreate } from "@apideck/sdk/funcs/atsApplicantsCreate.js"; import { RFCDate } from "@apideck/sdk/types"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await atsApplicantsCreate(apideck, { serviceId: "salesforce", applicant: { name: "Elon Musk", firstName: "Elon", lastName: "Musk", middleName: "D.", initials: "EM", birthday: new RFCDate("2000-08-12"), coverLetter: "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photoUrl: "https://unavatar.io/elon-musk", headline: "PepsiCo, Inc, Central Perk", title: "CEO", emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", ], }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", "", ], }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], websites: [ { id: "12345", url: "http://example.com", type: "primary", }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], stageId: "12345", recruiterId: "12345", coordinatorId: "12345", applicationIds: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], applications: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], followers: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], sources: [ "Job site", ], confidential: false, anonymized: true, tags: [ "New", ], archived: false, ownerId: "54321", recordUrl: "https://app.intercom.io/contacts/12345", deleted: true, passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AtsApplicantsAddRequest](../../models/operations/atsapplicantsaddrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.AtsApplicantsAddResponse](../../models/operations/atsapplicantsaddresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## get Get Applicant ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.ats.applicants.get({ id: "", serviceId: "salesforce", fields: "id,updated_at", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { atsApplicantsGet } from "@apideck/sdk/funcs/atsApplicantsGet.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await atsApplicantsGet(apideck, { id: "", serviceId: "salesforce", fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AtsApplicantsOneRequest](../../models/operations/atsapplicantsonerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.AtsApplicantsOneResponse](../../models/operations/atsapplicantsoneresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## update Update Applicant ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; import { RFCDate } from "@apideck/sdk/types"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.ats.applicants.update({ id: "", serviceId: "salesforce", applicant: { name: "Elon Musk", firstName: "Elon", lastName: "Musk", middleName: "D.", initials: "EM", birthday: new RFCDate("2000-08-12"), coverLetter: "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photoUrl: "https://unavatar.io/elon-musk", headline: "PepsiCo, Inc, Central Perk", title: "CEO", emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ {}, ], }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], websites: [ { id: "12345", url: "http://example.com", type: "primary", }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], stageId: "12345", recruiterId: "12345", coordinatorId: "12345", applicationIds: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], applications: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], followers: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], sources: [ "Job site", ], confidential: false, anonymized: true, tags: [ "New", ], archived: false, ownerId: "54321", recordUrl: "https://app.intercom.io/contacts/12345", deleted: true, passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { atsApplicantsUpdate } from "@apideck/sdk/funcs/atsApplicantsUpdate.js"; import { RFCDate } from "@apideck/sdk/types"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await atsApplicantsUpdate(apideck, { id: "", serviceId: "salesforce", applicant: { name: "Elon Musk", firstName: "Elon", lastName: "Musk", middleName: "D.", initials: "EM", birthday: new RFCDate("2000-08-12"), coverLetter: "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photoUrl: "https://unavatar.io/elon-musk", headline: "PepsiCo, Inc, Central Perk", title: "CEO", emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], websites: [ { id: "12345", url: "http://example.com", type: "primary", }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], stageId: "12345", recruiterId: "12345", coordinatorId: "12345", applicationIds: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], applications: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], followers: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], sources: [ "Job site", ], confidential: false, anonymized: true, tags: [ "New", ], archived: false, ownerId: "54321", recordUrl: "https://app.intercom.io/contacts/12345", deleted: true, passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AtsApplicantsUpdateRequest](../../models/operations/atsapplicantsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.AtsApplicantsUpdateResponse](../../models/operations/atsapplicantsupdateresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## delete Delete Applicant ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.ats.applicants.delete({ id: "", serviceId: "salesforce", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { atsApplicantsDelete } from "@apideck/sdk/funcs/atsApplicantsDelete.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await atsApplicantsDelete(apideck, { id: "", serviceId: "salesforce", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AtsApplicantsDeleteRequest](../../models/operations/atsapplicantsdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.AtsApplicantsDeleteResponse](../../models/operations/atsapplicantsdeleteresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* |