@unified-api/typescript-sdk 2.9.3 → 2.9.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/FUNCTIONS.md +108 -0
  2. package/README.md +36 -15
  3. package/RUNTIMES.md +22 -0
  4. package/docs/sdks/account/README.md +501 -0
  5. package/docs/sdks/accounting/README.md +3629 -0
  6. package/docs/sdks/activity/README.md +501 -0
  7. package/docs/sdks/apicall/README.md +165 -0
  8. package/docs/sdks/application/README.md +501 -0
  9. package/docs/sdks/applicationstatus/README.md +88 -0
  10. package/docs/sdks/ats/README.md +3710 -0
  11. package/docs/sdks/auth/README.md +173 -0
  12. package/docs/sdks/branch/README.md +501 -0
  13. package/docs/sdks/call/README.md +88 -0
  14. package/docs/sdks/candidate/README.md +501 -0
  15. package/docs/sdks/channel/README.md +171 -0
  16. package/docs/sdks/class/README.md +501 -0
  17. package/docs/sdks/collection/README.md +501 -0
  18. package/docs/sdks/commerce/README.md +2477 -0
  19. package/docs/sdks/commit/README.md +501 -0
  20. package/docs/sdks/company/README.md +1240 -0
  21. package/docs/sdks/connection/README.md +485 -0
  22. package/docs/sdks/contact/README.md +1489 -0
  23. package/docs/sdks/course/README.md +501 -0
  24. package/docs/sdks/crm/README.md +2971 -0
  25. package/docs/sdks/customer/README.md +501 -0
  26. package/docs/sdks/deal/README.md +501 -0
  27. package/docs/sdks/document/README.md +501 -0
  28. package/docs/sdks/employee/README.md +501 -0
  29. package/docs/sdks/enrich/README.md +169 -0
  30. package/docs/sdks/event/README.md +501 -0
  31. package/docs/sdks/file/README.md +501 -0
  32. package/docs/sdks/genai/README.md +169 -0
  33. package/docs/sdks/group/README.md +995 -0
  34. package/docs/sdks/hris/README.md +2311 -0
  35. package/docs/sdks/instructor/README.md +501 -0
  36. package/docs/sdks/integration/README.md +248 -0
  37. package/docs/sdks/interview/README.md +501 -0
  38. package/docs/sdks/inventory/README.md +501 -0
  39. package/docs/sdks/invoice/README.md +501 -0
  40. package/docs/sdks/issue/README.md +84 -0
  41. package/docs/sdks/item/README.md +501 -0
  42. package/docs/sdks/job/README.md +501 -0
  43. package/docs/sdks/journal/README.md +501 -0
  44. package/docs/sdks/kms/README.md +995 -0
  45. package/docs/sdks/lead/README.md +501 -0
  46. package/docs/sdks/link/README.md +501 -0
  47. package/docs/sdks/list/README.md +501 -0
  48. package/docs/sdks/lms/README.md +1983 -0
  49. package/docs/sdks/location/README.md +995 -0
  50. package/docs/sdks/login/README.md +90 -0
  51. package/docs/sdks/martech/README.md +995 -0
  52. package/docs/sdks/member/README.md +501 -0
  53. package/docs/sdks/message/README.md +501 -0
  54. package/docs/sdks/messaging/README.md +665 -0
  55. package/docs/sdks/metadata/README.md +501 -0
  56. package/docs/sdks/model/README.md +88 -0
  57. package/docs/sdks/note/README.md +501 -0
  58. package/docs/sdks/order/README.md +501 -0
  59. package/docs/sdks/organization/README.md +665 -0
  60. package/docs/sdks/page/README.md +501 -0
  61. package/docs/sdks/passthrough/README.md +671 -0
  62. package/docs/sdks/payment/README.md +1323 -0
  63. package/docs/sdks/payout/README.md +171 -0
  64. package/docs/sdks/payslip/README.md +171 -0
  65. package/docs/sdks/person/README.md +88 -0
  66. package/docs/sdks/pipeline/README.md +501 -0
  67. package/docs/sdks/project/README.md +501 -0
  68. package/docs/sdks/prompt/README.md +88 -0
  69. package/docs/sdks/pullrequest/README.md +501 -0
  70. package/docs/sdks/refund/README.md +171 -0
  71. package/docs/sdks/repo/README.md +2477 -0
  72. package/docs/sdks/repository/README.md +501 -0
  73. package/docs/sdks/scim/README.md +995 -0
  74. package/docs/sdks/scorecard/README.md +501 -0
  75. package/docs/sdks/space/README.md +501 -0
  76. package/docs/sdks/storage/README.md +501 -0
  77. package/docs/sdks/student/README.md +501 -0
  78. package/docs/sdks/task/README.md +995 -0
  79. package/docs/sdks/taxrate/README.md +501 -0
  80. package/docs/sdks/ticket/README.md +501 -0
  81. package/docs/sdks/ticketing/README.md +1489 -0
  82. package/docs/sdks/timeoff/README.md +171 -0
  83. package/docs/sdks/transaction/README.md +501 -0
  84. package/docs/sdks/uc/README.md +582 -0
  85. package/docs/sdks/unified/README.md +1601 -0
  86. package/docs/sdks/unifiedto/README.md +7 -0
  87. package/docs/sdks/user/README.md +501 -0
  88. package/docs/sdks/webhook/README.md +647 -0
  89. package/lib/config.d.ts +3 -3
  90. package/lib/config.js +3 -3
  91. package/lib/primitives.d.ts +2 -0
  92. package/lib/primitives.d.ts.map +1 -1
  93. package/lib/primitives.js +53 -0
  94. package/lib/primitives.js.map +1 -1
  95. package/package.json +3 -1
  96. package/sdk/models/shared/index.d.ts +1 -0
  97. package/sdk/models/shared/index.d.ts.map +1 -1
  98. package/sdk/models/shared/index.js +1 -0
  99. package/sdk/models/shared/index.js.map +1 -1
  100. package/sdk/models/shared/kmspage.d.ts +5 -0
  101. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  102. package/sdk/models/shared/kmspage.js +7 -0
  103. package/sdk/models/shared/kmspage.js.map +1 -1
  104. package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
  105. package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
  106. package/sdk/models/shared/kmspagemetadata.js +63 -0
  107. package/sdk/models/shared/kmspagemetadata.js.map +1 -0
  108. package/sdk/models/shared/kmsspace.d.ts +2 -0
  109. package/sdk/models/shared/kmsspace.d.ts.map +1 -1
  110. package/sdk/models/shared/kmsspace.js +4 -0
  111. package/sdk/models/shared/kmsspace.js.map +1 -1
  112. package/sdk/models/shared/security.d.ts +2 -2
  113. package/sdk/models/shared/security.d.ts.map +1 -1
  114. package/sdk/models/shared/security.js +2 -2
  115. package/sdk/models/shared/security.js.map +1 -1
  116. package/sdk/types/operations.d.ts +5 -3
  117. package/sdk/types/operations.d.ts.map +1 -1
  118. package/sdk/types/operations.js +3 -0
  119. package/sdk/types/operations.js.map +1 -1
  120. package/src/lib/config.ts +3 -3
  121. package/src/lib/primitives.ts +62 -0
  122. package/src/sdk/models/shared/index.ts +1 -0
  123. package/src/sdk/models/shared/kmspage.ts +16 -0
  124. package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
  125. package/src/sdk/models/shared/kmsspace.ts +6 -0
  126. package/src/sdk/models/shared/security.ts +4 -4
  127. package/src/sdk/types/operations.ts +11 -5
@@ -0,0 +1,3710 @@
1
+ # Ats
2
+ (*ats*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [createAtsActivity](#createatsactivity) - Create an activity
9
+ * [createAtsApplication](#createatsapplication) - Create an application
10
+ * [createAtsCandidate](#createatscandidate) - Create a candidate
11
+ * [createAtsDocument](#createatsdocument) - Create a document
12
+ * [createAtsInterview](#createatsinterview) - Create an interview
13
+ * [createAtsJob](#createatsjob) - Create a job
14
+ * [createAtsScorecard](#createatsscorecard) - Create a scorecard
15
+ * [getAtsActivity](#getatsactivity) - Retrieve an activity
16
+ * [getAtsApplication](#getatsapplication) - Retrieve an application
17
+ * [getAtsCandidate](#getatscandidate) - Retrieve a candidate
18
+ * [getAtsCompany](#getatscompany) - Retrieve a company
19
+ * [getAtsDocument](#getatsdocument) - Retrieve a document
20
+ * [getAtsInterview](#getatsinterview) - Retrieve an interview
21
+ * [getAtsJob](#getatsjob) - Retrieve a job
22
+ * [getAtsScorecard](#getatsscorecard) - Retrieve a scorecard
23
+ * [listAtsActivities](#listatsactivities) - List all activities
24
+ * [listAtsApplications](#listatsapplications) - List all applications
25
+ * [listAtsApplicationstatuses](#listatsapplicationstatuses) - List all applicationstatuses
26
+ * [listAtsCandidates](#listatscandidates) - List all candidates
27
+ * [listAtsCompanies](#listatscompanies) - List all companies
28
+ * [listAtsDocuments](#listatsdocuments) - List all documents
29
+ * [listAtsInterviews](#listatsinterviews) - List all interviews
30
+ * [listAtsJobs](#listatsjobs) - List all jobs
31
+ * [listAtsScorecards](#listatsscorecards) - List all scorecards
32
+ * [patchAtsActivity](#patchatsactivity) - Update an activity
33
+ * [patchAtsApplication](#patchatsapplication) - Update an application
34
+ * [patchAtsCandidate](#patchatscandidate) - Update a candidate
35
+ * [patchAtsDocument](#patchatsdocument) - Update a document
36
+ * [patchAtsInterview](#patchatsinterview) - Update an interview
37
+ * [patchAtsJob](#patchatsjob) - Update a job
38
+ * [patchAtsScorecard](#patchatsscorecard) - Update a scorecard
39
+ * [removeAtsActivity](#removeatsactivity) - Remove an activity
40
+ * [removeAtsApplication](#removeatsapplication) - Remove an application
41
+ * [removeAtsCandidate](#removeatscandidate) - Remove a candidate
42
+ * [removeAtsDocument](#removeatsdocument) - Remove a document
43
+ * [removeAtsInterview](#removeatsinterview) - Remove an interview
44
+ * [removeAtsJob](#removeatsjob) - Remove a job
45
+ * [removeAtsScorecard](#removeatsscorecard) - Remove a scorecard
46
+ * [updateAtsActivity](#updateatsactivity) - Update an activity
47
+ * [updateAtsApplication](#updateatsapplication) - Update an application
48
+ * [updateAtsCandidate](#updateatscandidate) - Update a candidate
49
+ * [updateAtsDocument](#updateatsdocument) - Update a document
50
+ * [updateAtsInterview](#updateatsinterview) - Update an interview
51
+ * [updateAtsJob](#updateatsjob) - Update a job
52
+ * [updateAtsScorecard](#updateatsscorecard) - Update a scorecard
53
+
54
+ ## createAtsActivity
55
+
56
+ Create an activity
57
+
58
+ ### Example Usage
59
+
60
+ ```typescript
61
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
62
+
63
+ const unifiedTo = new UnifiedTo({
64
+ security: {
65
+ jwt: "<YOUR_API_KEY_HERE>",
66
+ },
67
+ });
68
+
69
+ async function run() {
70
+ const result = await unifiedTo.ats.createAtsActivity({
71
+ connectionId: "<value>",
72
+ });
73
+
74
+ // Handle the result
75
+ console.log(result);
76
+ }
77
+
78
+ run();
79
+ ```
80
+
81
+ ### Standalone function
82
+
83
+ The standalone function version of this method:
84
+
85
+ ```typescript
86
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
87
+ import { atsCreateAtsActivity } from "@unified-api/typescript-sdk/funcs/atsCreateAtsActivity.js";
88
+
89
+ // Use `UnifiedToCore` for best tree-shaking performance.
90
+ // You can create one instance of it to use across an application.
91
+ const unifiedTo = new UnifiedToCore({
92
+ security: {
93
+ jwt: "<YOUR_API_KEY_HERE>",
94
+ },
95
+ });
96
+
97
+ async function run() {
98
+ const res = await atsCreateAtsActivity(unifiedTo, {
99
+ connectionId: "<value>",
100
+ });
101
+
102
+ if (!res.ok) {
103
+ throw res.error;
104
+ }
105
+
106
+ const { value: result } = res;
107
+
108
+ // Handle the result
109
+ console.log(result);
110
+ }
111
+
112
+ run();
113
+ ```
114
+
115
+ ### Parameters
116
+
117
+ | Parameter | Type | Required | Description |
118
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
119
+ | `request` | [operations.CreateAtsActivityRequest](../../sdk/models/operations/createatsactivityrequest.md) | :heavy_check_mark: | The request object to use for the request. |
120
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
121
+ | `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. |
122
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
123
+
124
+ ### Response
125
+
126
+ **Promise\<[shared.AtsActivity](../../sdk/models/shared/atsactivity.md)\>**
127
+
128
+ ### Errors
129
+
130
+ | Error Type | Status Code | Content Type |
131
+ | --------------- | --------------- | --------------- |
132
+ | errors.SDKError | 4XX, 5XX | \*/\* |
133
+
134
+ ## createAtsApplication
135
+
136
+ Create an application
137
+
138
+ ### Example Usage
139
+
140
+ ```typescript
141
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
142
+
143
+ const unifiedTo = new UnifiedTo({
144
+ security: {
145
+ jwt: "<YOUR_API_KEY_HERE>",
146
+ },
147
+ });
148
+
149
+ async function run() {
150
+ const result = await unifiedTo.ats.createAtsApplication({
151
+ connectionId: "<value>",
152
+ });
153
+
154
+ // Handle the result
155
+ console.log(result);
156
+ }
157
+
158
+ run();
159
+ ```
160
+
161
+ ### Standalone function
162
+
163
+ The standalone function version of this method:
164
+
165
+ ```typescript
166
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
167
+ import { atsCreateAtsApplication } from "@unified-api/typescript-sdk/funcs/atsCreateAtsApplication.js";
168
+
169
+ // Use `UnifiedToCore` for best tree-shaking performance.
170
+ // You can create one instance of it to use across an application.
171
+ const unifiedTo = new UnifiedToCore({
172
+ security: {
173
+ jwt: "<YOUR_API_KEY_HERE>",
174
+ },
175
+ });
176
+
177
+ async function run() {
178
+ const res = await atsCreateAtsApplication(unifiedTo, {
179
+ connectionId: "<value>",
180
+ });
181
+
182
+ if (!res.ok) {
183
+ throw res.error;
184
+ }
185
+
186
+ const { value: result } = res;
187
+
188
+ // Handle the result
189
+ console.log(result);
190
+ }
191
+
192
+ run();
193
+ ```
194
+
195
+ ### Parameters
196
+
197
+ | Parameter | Type | Required | Description |
198
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
199
+ | `request` | [operations.CreateAtsApplicationRequest](../../sdk/models/operations/createatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
200
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
201
+ | `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. |
202
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
203
+
204
+ ### Response
205
+
206
+ **Promise\<[shared.AtsApplication](../../sdk/models/shared/atsapplication.md)\>**
207
+
208
+ ### Errors
209
+
210
+ | Error Type | Status Code | Content Type |
211
+ | --------------- | --------------- | --------------- |
212
+ | errors.SDKError | 4XX, 5XX | \*/\* |
213
+
214
+ ## createAtsCandidate
215
+
216
+ Create a candidate
217
+
218
+ ### Example Usage
219
+
220
+ ```typescript
221
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
222
+
223
+ const unifiedTo = new UnifiedTo({
224
+ security: {
225
+ jwt: "<YOUR_API_KEY_HERE>",
226
+ },
227
+ });
228
+
229
+ async function run() {
230
+ const result = await unifiedTo.ats.createAtsCandidate({
231
+ connectionId: "<value>",
232
+ });
233
+
234
+ // Handle the result
235
+ console.log(result);
236
+ }
237
+
238
+ run();
239
+ ```
240
+
241
+ ### Standalone function
242
+
243
+ The standalone function version of this method:
244
+
245
+ ```typescript
246
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
247
+ import { atsCreateAtsCandidate } from "@unified-api/typescript-sdk/funcs/atsCreateAtsCandidate.js";
248
+
249
+ // Use `UnifiedToCore` for best tree-shaking performance.
250
+ // You can create one instance of it to use across an application.
251
+ const unifiedTo = new UnifiedToCore({
252
+ security: {
253
+ jwt: "<YOUR_API_KEY_HERE>",
254
+ },
255
+ });
256
+
257
+ async function run() {
258
+ const res = await atsCreateAtsCandidate(unifiedTo, {
259
+ connectionId: "<value>",
260
+ });
261
+
262
+ if (!res.ok) {
263
+ throw res.error;
264
+ }
265
+
266
+ const { value: result } = res;
267
+
268
+ // Handle the result
269
+ console.log(result);
270
+ }
271
+
272
+ run();
273
+ ```
274
+
275
+ ### Parameters
276
+
277
+ | Parameter | Type | Required | Description |
278
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
279
+ | `request` | [operations.CreateAtsCandidateRequest](../../sdk/models/operations/createatscandidaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
280
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
281
+ | `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. |
282
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
283
+
284
+ ### Response
285
+
286
+ **Promise\<[shared.AtsCandidate](../../sdk/models/shared/atscandidate.md)\>**
287
+
288
+ ### Errors
289
+
290
+ | Error Type | Status Code | Content Type |
291
+ | --------------- | --------------- | --------------- |
292
+ | errors.SDKError | 4XX, 5XX | \*/\* |
293
+
294
+ ## createAtsDocument
295
+
296
+ Create a document
297
+
298
+ ### Example Usage
299
+
300
+ ```typescript
301
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
302
+
303
+ const unifiedTo = new UnifiedTo({
304
+ security: {
305
+ jwt: "<YOUR_API_KEY_HERE>",
306
+ },
307
+ });
308
+
309
+ async function run() {
310
+ const result = await unifiedTo.ats.createAtsDocument({
311
+ connectionId: "<value>",
312
+ });
313
+
314
+ // Handle the result
315
+ console.log(result);
316
+ }
317
+
318
+ run();
319
+ ```
320
+
321
+ ### Standalone function
322
+
323
+ The standalone function version of this method:
324
+
325
+ ```typescript
326
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
327
+ import { atsCreateAtsDocument } from "@unified-api/typescript-sdk/funcs/atsCreateAtsDocument.js";
328
+
329
+ // Use `UnifiedToCore` for best tree-shaking performance.
330
+ // You can create one instance of it to use across an application.
331
+ const unifiedTo = new UnifiedToCore({
332
+ security: {
333
+ jwt: "<YOUR_API_KEY_HERE>",
334
+ },
335
+ });
336
+
337
+ async function run() {
338
+ const res = await atsCreateAtsDocument(unifiedTo, {
339
+ connectionId: "<value>",
340
+ });
341
+
342
+ if (!res.ok) {
343
+ throw res.error;
344
+ }
345
+
346
+ const { value: result } = res;
347
+
348
+ // Handle the result
349
+ console.log(result);
350
+ }
351
+
352
+ run();
353
+ ```
354
+
355
+ ### Parameters
356
+
357
+ | Parameter | Type | Required | Description |
358
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
359
+ | `request` | [operations.CreateAtsDocumentRequest](../../sdk/models/operations/createatsdocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
360
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
361
+ | `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. |
362
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
363
+
364
+ ### Response
365
+
366
+ **Promise\<[shared.AtsDocument](../../sdk/models/shared/atsdocument.md)\>**
367
+
368
+ ### Errors
369
+
370
+ | Error Type | Status Code | Content Type |
371
+ | --------------- | --------------- | --------------- |
372
+ | errors.SDKError | 4XX, 5XX | \*/\* |
373
+
374
+ ## createAtsInterview
375
+
376
+ Create an interview
377
+
378
+ ### Example Usage
379
+
380
+ ```typescript
381
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
382
+
383
+ const unifiedTo = new UnifiedTo({
384
+ security: {
385
+ jwt: "<YOUR_API_KEY_HERE>",
386
+ },
387
+ });
388
+
389
+ async function run() {
390
+ const result = await unifiedTo.ats.createAtsInterview({
391
+ connectionId: "<value>",
392
+ });
393
+
394
+ // Handle the result
395
+ console.log(result);
396
+ }
397
+
398
+ run();
399
+ ```
400
+
401
+ ### Standalone function
402
+
403
+ The standalone function version of this method:
404
+
405
+ ```typescript
406
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
407
+ import { atsCreateAtsInterview } from "@unified-api/typescript-sdk/funcs/atsCreateAtsInterview.js";
408
+
409
+ // Use `UnifiedToCore` for best tree-shaking performance.
410
+ // You can create one instance of it to use across an application.
411
+ const unifiedTo = new UnifiedToCore({
412
+ security: {
413
+ jwt: "<YOUR_API_KEY_HERE>",
414
+ },
415
+ });
416
+
417
+ async function run() {
418
+ const res = await atsCreateAtsInterview(unifiedTo, {
419
+ connectionId: "<value>",
420
+ });
421
+
422
+ if (!res.ok) {
423
+ throw res.error;
424
+ }
425
+
426
+ const { value: result } = res;
427
+
428
+ // Handle the result
429
+ console.log(result);
430
+ }
431
+
432
+ run();
433
+ ```
434
+
435
+ ### Parameters
436
+
437
+ | Parameter | Type | Required | Description |
438
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
439
+ | `request` | [operations.CreateAtsInterviewRequest](../../sdk/models/operations/createatsinterviewrequest.md) | :heavy_check_mark: | The request object to use for the request. |
440
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
441
+ | `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. |
442
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
443
+
444
+ ### Response
445
+
446
+ **Promise\<[shared.AtsInterview](../../sdk/models/shared/atsinterview.md)\>**
447
+
448
+ ### Errors
449
+
450
+ | Error Type | Status Code | Content Type |
451
+ | --------------- | --------------- | --------------- |
452
+ | errors.SDKError | 4XX, 5XX | \*/\* |
453
+
454
+ ## createAtsJob
455
+
456
+ Create a job
457
+
458
+ ### Example Usage
459
+
460
+ ```typescript
461
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
462
+
463
+ const unifiedTo = new UnifiedTo({
464
+ security: {
465
+ jwt: "<YOUR_API_KEY_HERE>",
466
+ },
467
+ });
468
+
469
+ async function run() {
470
+ const result = await unifiedTo.ats.createAtsJob({
471
+ connectionId: "<value>",
472
+ });
473
+
474
+ // Handle the result
475
+ console.log(result);
476
+ }
477
+
478
+ run();
479
+ ```
480
+
481
+ ### Standalone function
482
+
483
+ The standalone function version of this method:
484
+
485
+ ```typescript
486
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
487
+ import { atsCreateAtsJob } from "@unified-api/typescript-sdk/funcs/atsCreateAtsJob.js";
488
+
489
+ // Use `UnifiedToCore` for best tree-shaking performance.
490
+ // You can create one instance of it to use across an application.
491
+ const unifiedTo = new UnifiedToCore({
492
+ security: {
493
+ jwt: "<YOUR_API_KEY_HERE>",
494
+ },
495
+ });
496
+
497
+ async function run() {
498
+ const res = await atsCreateAtsJob(unifiedTo, {
499
+ connectionId: "<value>",
500
+ });
501
+
502
+ if (!res.ok) {
503
+ throw res.error;
504
+ }
505
+
506
+ const { value: result } = res;
507
+
508
+ // Handle the result
509
+ console.log(result);
510
+ }
511
+
512
+ run();
513
+ ```
514
+
515
+ ### Parameters
516
+
517
+ | Parameter | Type | Required | Description |
518
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
519
+ | `request` | [operations.CreateAtsJobRequest](../../sdk/models/operations/createatsjobrequest.md) | :heavy_check_mark: | The request object to use for the request. |
520
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
521
+ | `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. |
522
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
523
+
524
+ ### Response
525
+
526
+ **Promise\<[shared.AtsJob](../../sdk/models/shared/atsjob.md)\>**
527
+
528
+ ### Errors
529
+
530
+ | Error Type | Status Code | Content Type |
531
+ | --------------- | --------------- | --------------- |
532
+ | errors.SDKError | 4XX, 5XX | \*/\* |
533
+
534
+ ## createAtsScorecard
535
+
536
+ Create a scorecard
537
+
538
+ ### Example Usage
539
+
540
+ ```typescript
541
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
542
+
543
+ const unifiedTo = new UnifiedTo({
544
+ security: {
545
+ jwt: "<YOUR_API_KEY_HERE>",
546
+ },
547
+ });
548
+
549
+ async function run() {
550
+ const result = await unifiedTo.ats.createAtsScorecard({
551
+ connectionId: "<value>",
552
+ });
553
+
554
+ // Handle the result
555
+ console.log(result);
556
+ }
557
+
558
+ run();
559
+ ```
560
+
561
+ ### Standalone function
562
+
563
+ The standalone function version of this method:
564
+
565
+ ```typescript
566
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
567
+ import { atsCreateAtsScorecard } from "@unified-api/typescript-sdk/funcs/atsCreateAtsScorecard.js";
568
+
569
+ // Use `UnifiedToCore` for best tree-shaking performance.
570
+ // You can create one instance of it to use across an application.
571
+ const unifiedTo = new UnifiedToCore({
572
+ security: {
573
+ jwt: "<YOUR_API_KEY_HERE>",
574
+ },
575
+ });
576
+
577
+ async function run() {
578
+ const res = await atsCreateAtsScorecard(unifiedTo, {
579
+ connectionId: "<value>",
580
+ });
581
+
582
+ if (!res.ok) {
583
+ throw res.error;
584
+ }
585
+
586
+ const { value: result } = res;
587
+
588
+ // Handle the result
589
+ console.log(result);
590
+ }
591
+
592
+ run();
593
+ ```
594
+
595
+ ### Parameters
596
+
597
+ | Parameter | Type | Required | Description |
598
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
599
+ | `request` | [operations.CreateAtsScorecardRequest](../../sdk/models/operations/createatsscorecardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
600
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
601
+ | `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. |
602
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
603
+
604
+ ### Response
605
+
606
+ **Promise\<[shared.AtsScorecard](../../sdk/models/shared/atsscorecard.md)\>**
607
+
608
+ ### Errors
609
+
610
+ | Error Type | Status Code | Content Type |
611
+ | --------------- | --------------- | --------------- |
612
+ | errors.SDKError | 4XX, 5XX | \*/\* |
613
+
614
+ ## getAtsActivity
615
+
616
+ Retrieve an activity
617
+
618
+ ### Example Usage
619
+
620
+ ```typescript
621
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
622
+
623
+ const unifiedTo = new UnifiedTo({
624
+ security: {
625
+ jwt: "<YOUR_API_KEY_HERE>",
626
+ },
627
+ });
628
+
629
+ async function run() {
630
+ const result = await unifiedTo.ats.getAtsActivity({
631
+ connectionId: "<value>",
632
+ id: "<id>",
633
+ });
634
+
635
+ // Handle the result
636
+ console.log(result);
637
+ }
638
+
639
+ run();
640
+ ```
641
+
642
+ ### Standalone function
643
+
644
+ The standalone function version of this method:
645
+
646
+ ```typescript
647
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
648
+ import { atsGetAtsActivity } from "@unified-api/typescript-sdk/funcs/atsGetAtsActivity.js";
649
+
650
+ // Use `UnifiedToCore` for best tree-shaking performance.
651
+ // You can create one instance of it to use across an application.
652
+ const unifiedTo = new UnifiedToCore({
653
+ security: {
654
+ jwt: "<YOUR_API_KEY_HERE>",
655
+ },
656
+ });
657
+
658
+ async function run() {
659
+ const res = await atsGetAtsActivity(unifiedTo, {
660
+ connectionId: "<value>",
661
+ id: "<id>",
662
+ });
663
+
664
+ if (!res.ok) {
665
+ throw res.error;
666
+ }
667
+
668
+ const { value: result } = res;
669
+
670
+ // Handle the result
671
+ console.log(result);
672
+ }
673
+
674
+ run();
675
+ ```
676
+
677
+ ### Parameters
678
+
679
+ | Parameter | Type | Required | Description |
680
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
681
+ | `request` | [operations.GetAtsActivityRequest](../../sdk/models/operations/getatsactivityrequest.md) | :heavy_check_mark: | The request object to use for the request. |
682
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
683
+ | `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. |
684
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
685
+
686
+ ### Response
687
+
688
+ **Promise\<[shared.AtsActivity](../../sdk/models/shared/atsactivity.md)\>**
689
+
690
+ ### Errors
691
+
692
+ | Error Type | Status Code | Content Type |
693
+ | --------------- | --------------- | --------------- |
694
+ | errors.SDKError | 4XX, 5XX | \*/\* |
695
+
696
+ ## getAtsApplication
697
+
698
+ Retrieve an application
699
+
700
+ ### Example Usage
701
+
702
+ ```typescript
703
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
704
+
705
+ const unifiedTo = new UnifiedTo({
706
+ security: {
707
+ jwt: "<YOUR_API_KEY_HERE>",
708
+ },
709
+ });
710
+
711
+ async function run() {
712
+ const result = await unifiedTo.ats.getAtsApplication({
713
+ connectionId: "<value>",
714
+ id: "<id>",
715
+ });
716
+
717
+ // Handle the result
718
+ console.log(result);
719
+ }
720
+
721
+ run();
722
+ ```
723
+
724
+ ### Standalone function
725
+
726
+ The standalone function version of this method:
727
+
728
+ ```typescript
729
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
730
+ import { atsGetAtsApplication } from "@unified-api/typescript-sdk/funcs/atsGetAtsApplication.js";
731
+
732
+ // Use `UnifiedToCore` for best tree-shaking performance.
733
+ // You can create one instance of it to use across an application.
734
+ const unifiedTo = new UnifiedToCore({
735
+ security: {
736
+ jwt: "<YOUR_API_KEY_HERE>",
737
+ },
738
+ });
739
+
740
+ async function run() {
741
+ const res = await atsGetAtsApplication(unifiedTo, {
742
+ connectionId: "<value>",
743
+ id: "<id>",
744
+ });
745
+
746
+ if (!res.ok) {
747
+ throw res.error;
748
+ }
749
+
750
+ const { value: result } = res;
751
+
752
+ // Handle the result
753
+ console.log(result);
754
+ }
755
+
756
+ run();
757
+ ```
758
+
759
+ ### Parameters
760
+
761
+ | Parameter | Type | Required | Description |
762
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
763
+ | `request` | [operations.GetAtsApplicationRequest](../../sdk/models/operations/getatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
764
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
765
+ | `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. |
766
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
767
+
768
+ ### Response
769
+
770
+ **Promise\<[shared.AtsApplication](../../sdk/models/shared/atsapplication.md)\>**
771
+
772
+ ### Errors
773
+
774
+ | Error Type | Status Code | Content Type |
775
+ | --------------- | --------------- | --------------- |
776
+ | errors.SDKError | 4XX, 5XX | \*/\* |
777
+
778
+ ## getAtsCandidate
779
+
780
+ Retrieve a candidate
781
+
782
+ ### Example Usage
783
+
784
+ ```typescript
785
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
786
+
787
+ const unifiedTo = new UnifiedTo({
788
+ security: {
789
+ jwt: "<YOUR_API_KEY_HERE>",
790
+ },
791
+ });
792
+
793
+ async function run() {
794
+ const result = await unifiedTo.ats.getAtsCandidate({
795
+ connectionId: "<value>",
796
+ id: "<id>",
797
+ });
798
+
799
+ // Handle the result
800
+ console.log(result);
801
+ }
802
+
803
+ run();
804
+ ```
805
+
806
+ ### Standalone function
807
+
808
+ The standalone function version of this method:
809
+
810
+ ```typescript
811
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
812
+ import { atsGetAtsCandidate } from "@unified-api/typescript-sdk/funcs/atsGetAtsCandidate.js";
813
+
814
+ // Use `UnifiedToCore` for best tree-shaking performance.
815
+ // You can create one instance of it to use across an application.
816
+ const unifiedTo = new UnifiedToCore({
817
+ security: {
818
+ jwt: "<YOUR_API_KEY_HERE>",
819
+ },
820
+ });
821
+
822
+ async function run() {
823
+ const res = await atsGetAtsCandidate(unifiedTo, {
824
+ connectionId: "<value>",
825
+ id: "<id>",
826
+ });
827
+
828
+ if (!res.ok) {
829
+ throw res.error;
830
+ }
831
+
832
+ const { value: result } = res;
833
+
834
+ // Handle the result
835
+ console.log(result);
836
+ }
837
+
838
+ run();
839
+ ```
840
+
841
+ ### Parameters
842
+
843
+ | Parameter | Type | Required | Description |
844
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
845
+ | `request` | [operations.GetAtsCandidateRequest](../../sdk/models/operations/getatscandidaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
846
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
847
+ | `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. |
848
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
849
+
850
+ ### Response
851
+
852
+ **Promise\<[shared.AtsCandidate](../../sdk/models/shared/atscandidate.md)\>**
853
+
854
+ ### Errors
855
+
856
+ | Error Type | Status Code | Content Type |
857
+ | --------------- | --------------- | --------------- |
858
+ | errors.SDKError | 4XX, 5XX | \*/\* |
859
+
860
+ ## getAtsCompany
861
+
862
+ Retrieve a company
863
+
864
+ ### Example Usage
865
+
866
+ ```typescript
867
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
868
+
869
+ const unifiedTo = new UnifiedTo({
870
+ security: {
871
+ jwt: "<YOUR_API_KEY_HERE>",
872
+ },
873
+ });
874
+
875
+ async function run() {
876
+ const result = await unifiedTo.ats.getAtsCompany({
877
+ connectionId: "<value>",
878
+ id: "<id>",
879
+ });
880
+
881
+ // Handle the result
882
+ console.log(result);
883
+ }
884
+
885
+ run();
886
+ ```
887
+
888
+ ### Standalone function
889
+
890
+ The standalone function version of this method:
891
+
892
+ ```typescript
893
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
894
+ import { atsGetAtsCompany } from "@unified-api/typescript-sdk/funcs/atsGetAtsCompany.js";
895
+
896
+ // Use `UnifiedToCore` for best tree-shaking performance.
897
+ // You can create one instance of it to use across an application.
898
+ const unifiedTo = new UnifiedToCore({
899
+ security: {
900
+ jwt: "<YOUR_API_KEY_HERE>",
901
+ },
902
+ });
903
+
904
+ async function run() {
905
+ const res = await atsGetAtsCompany(unifiedTo, {
906
+ connectionId: "<value>",
907
+ id: "<id>",
908
+ });
909
+
910
+ if (!res.ok) {
911
+ throw res.error;
912
+ }
913
+
914
+ const { value: result } = res;
915
+
916
+ // Handle the result
917
+ console.log(result);
918
+ }
919
+
920
+ run();
921
+ ```
922
+
923
+ ### Parameters
924
+
925
+ | Parameter | Type | Required | Description |
926
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
927
+ | `request` | [operations.GetAtsCompanyRequest](../../sdk/models/operations/getatscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
928
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
929
+ | `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. |
930
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
931
+
932
+ ### Response
933
+
934
+ **Promise\<[shared.AtsCompany](../../sdk/models/shared/atscompany.md)\>**
935
+
936
+ ### Errors
937
+
938
+ | Error Type | Status Code | Content Type |
939
+ | --------------- | --------------- | --------------- |
940
+ | errors.SDKError | 4XX, 5XX | \*/\* |
941
+
942
+ ## getAtsDocument
943
+
944
+ Retrieve a document
945
+
946
+ ### Example Usage
947
+
948
+ ```typescript
949
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
950
+
951
+ const unifiedTo = new UnifiedTo({
952
+ security: {
953
+ jwt: "<YOUR_API_KEY_HERE>",
954
+ },
955
+ });
956
+
957
+ async function run() {
958
+ const result = await unifiedTo.ats.getAtsDocument({
959
+ connectionId: "<value>",
960
+ id: "<id>",
961
+ });
962
+
963
+ // Handle the result
964
+ console.log(result);
965
+ }
966
+
967
+ run();
968
+ ```
969
+
970
+ ### Standalone function
971
+
972
+ The standalone function version of this method:
973
+
974
+ ```typescript
975
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
976
+ import { atsGetAtsDocument } from "@unified-api/typescript-sdk/funcs/atsGetAtsDocument.js";
977
+
978
+ // Use `UnifiedToCore` for best tree-shaking performance.
979
+ // You can create one instance of it to use across an application.
980
+ const unifiedTo = new UnifiedToCore({
981
+ security: {
982
+ jwt: "<YOUR_API_KEY_HERE>",
983
+ },
984
+ });
985
+
986
+ async function run() {
987
+ const res = await atsGetAtsDocument(unifiedTo, {
988
+ connectionId: "<value>",
989
+ id: "<id>",
990
+ });
991
+
992
+ if (!res.ok) {
993
+ throw res.error;
994
+ }
995
+
996
+ const { value: result } = res;
997
+
998
+ // Handle the result
999
+ console.log(result);
1000
+ }
1001
+
1002
+ run();
1003
+ ```
1004
+
1005
+ ### Parameters
1006
+
1007
+ | Parameter | Type | Required | Description |
1008
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1009
+ | `request` | [operations.GetAtsDocumentRequest](../../sdk/models/operations/getatsdocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1010
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1011
+ | `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. |
1012
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1013
+
1014
+ ### Response
1015
+
1016
+ **Promise\<[shared.AtsDocument](../../sdk/models/shared/atsdocument.md)\>**
1017
+
1018
+ ### Errors
1019
+
1020
+ | Error Type | Status Code | Content Type |
1021
+ | --------------- | --------------- | --------------- |
1022
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1023
+
1024
+ ## getAtsInterview
1025
+
1026
+ Retrieve an interview
1027
+
1028
+ ### Example Usage
1029
+
1030
+ ```typescript
1031
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1032
+
1033
+ const unifiedTo = new UnifiedTo({
1034
+ security: {
1035
+ jwt: "<YOUR_API_KEY_HERE>",
1036
+ },
1037
+ });
1038
+
1039
+ async function run() {
1040
+ const result = await unifiedTo.ats.getAtsInterview({
1041
+ connectionId: "<value>",
1042
+ id: "<id>",
1043
+ });
1044
+
1045
+ // Handle the result
1046
+ console.log(result);
1047
+ }
1048
+
1049
+ run();
1050
+ ```
1051
+
1052
+ ### Standalone function
1053
+
1054
+ The standalone function version of this method:
1055
+
1056
+ ```typescript
1057
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1058
+ import { atsGetAtsInterview } from "@unified-api/typescript-sdk/funcs/atsGetAtsInterview.js";
1059
+
1060
+ // Use `UnifiedToCore` for best tree-shaking performance.
1061
+ // You can create one instance of it to use across an application.
1062
+ const unifiedTo = new UnifiedToCore({
1063
+ security: {
1064
+ jwt: "<YOUR_API_KEY_HERE>",
1065
+ },
1066
+ });
1067
+
1068
+ async function run() {
1069
+ const res = await atsGetAtsInterview(unifiedTo, {
1070
+ connectionId: "<value>",
1071
+ id: "<id>",
1072
+ });
1073
+
1074
+ if (!res.ok) {
1075
+ throw res.error;
1076
+ }
1077
+
1078
+ const { value: result } = res;
1079
+
1080
+ // Handle the result
1081
+ console.log(result);
1082
+ }
1083
+
1084
+ run();
1085
+ ```
1086
+
1087
+ ### Parameters
1088
+
1089
+ | Parameter | Type | Required | Description |
1090
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1091
+ | `request` | [operations.GetAtsInterviewRequest](../../sdk/models/operations/getatsinterviewrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1092
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1093
+ | `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. |
1094
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1095
+
1096
+ ### Response
1097
+
1098
+ **Promise\<[shared.AtsInterview](../../sdk/models/shared/atsinterview.md)\>**
1099
+
1100
+ ### Errors
1101
+
1102
+ | Error Type | Status Code | Content Type |
1103
+ | --------------- | --------------- | --------------- |
1104
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1105
+
1106
+ ## getAtsJob
1107
+
1108
+ Retrieve a job
1109
+
1110
+ ### Example Usage
1111
+
1112
+ ```typescript
1113
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1114
+
1115
+ const unifiedTo = new UnifiedTo({
1116
+ security: {
1117
+ jwt: "<YOUR_API_KEY_HERE>",
1118
+ },
1119
+ });
1120
+
1121
+ async function run() {
1122
+ const result = await unifiedTo.ats.getAtsJob({
1123
+ connectionId: "<value>",
1124
+ id: "<id>",
1125
+ });
1126
+
1127
+ // Handle the result
1128
+ console.log(result);
1129
+ }
1130
+
1131
+ run();
1132
+ ```
1133
+
1134
+ ### Standalone function
1135
+
1136
+ The standalone function version of this method:
1137
+
1138
+ ```typescript
1139
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1140
+ import { atsGetAtsJob } from "@unified-api/typescript-sdk/funcs/atsGetAtsJob.js";
1141
+
1142
+ // Use `UnifiedToCore` for best tree-shaking performance.
1143
+ // You can create one instance of it to use across an application.
1144
+ const unifiedTo = new UnifiedToCore({
1145
+ security: {
1146
+ jwt: "<YOUR_API_KEY_HERE>",
1147
+ },
1148
+ });
1149
+
1150
+ async function run() {
1151
+ const res = await atsGetAtsJob(unifiedTo, {
1152
+ connectionId: "<value>",
1153
+ id: "<id>",
1154
+ });
1155
+
1156
+ if (!res.ok) {
1157
+ throw res.error;
1158
+ }
1159
+
1160
+ const { value: result } = res;
1161
+
1162
+ // Handle the result
1163
+ console.log(result);
1164
+ }
1165
+
1166
+ run();
1167
+ ```
1168
+
1169
+ ### Parameters
1170
+
1171
+ | Parameter | Type | Required | Description |
1172
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1173
+ | `request` | [operations.GetAtsJobRequest](../../sdk/models/operations/getatsjobrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1174
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1175
+ | `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. |
1176
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1177
+
1178
+ ### Response
1179
+
1180
+ **Promise\<[shared.AtsJob](../../sdk/models/shared/atsjob.md)\>**
1181
+
1182
+ ### Errors
1183
+
1184
+ | Error Type | Status Code | Content Type |
1185
+ | --------------- | --------------- | --------------- |
1186
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1187
+
1188
+ ## getAtsScorecard
1189
+
1190
+ Retrieve a scorecard
1191
+
1192
+ ### Example Usage
1193
+
1194
+ ```typescript
1195
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1196
+
1197
+ const unifiedTo = new UnifiedTo({
1198
+ security: {
1199
+ jwt: "<YOUR_API_KEY_HERE>",
1200
+ },
1201
+ });
1202
+
1203
+ async function run() {
1204
+ const result = await unifiedTo.ats.getAtsScorecard({
1205
+ connectionId: "<value>",
1206
+ id: "<id>",
1207
+ });
1208
+
1209
+ // Handle the result
1210
+ console.log(result);
1211
+ }
1212
+
1213
+ run();
1214
+ ```
1215
+
1216
+ ### Standalone function
1217
+
1218
+ The standalone function version of this method:
1219
+
1220
+ ```typescript
1221
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1222
+ import { atsGetAtsScorecard } from "@unified-api/typescript-sdk/funcs/atsGetAtsScorecard.js";
1223
+
1224
+ // Use `UnifiedToCore` for best tree-shaking performance.
1225
+ // You can create one instance of it to use across an application.
1226
+ const unifiedTo = new UnifiedToCore({
1227
+ security: {
1228
+ jwt: "<YOUR_API_KEY_HERE>",
1229
+ },
1230
+ });
1231
+
1232
+ async function run() {
1233
+ const res = await atsGetAtsScorecard(unifiedTo, {
1234
+ connectionId: "<value>",
1235
+ id: "<id>",
1236
+ });
1237
+
1238
+ if (!res.ok) {
1239
+ throw res.error;
1240
+ }
1241
+
1242
+ const { value: result } = res;
1243
+
1244
+ // Handle the result
1245
+ console.log(result);
1246
+ }
1247
+
1248
+ run();
1249
+ ```
1250
+
1251
+ ### Parameters
1252
+
1253
+ | Parameter | Type | Required | Description |
1254
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1255
+ | `request` | [operations.GetAtsScorecardRequest](../../sdk/models/operations/getatsscorecardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1256
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1257
+ | `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. |
1258
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1259
+
1260
+ ### Response
1261
+
1262
+ **Promise\<[shared.AtsScorecard](../../sdk/models/shared/atsscorecard.md)\>**
1263
+
1264
+ ### Errors
1265
+
1266
+ | Error Type | Status Code | Content Type |
1267
+ | --------------- | --------------- | --------------- |
1268
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1269
+
1270
+ ## listAtsActivities
1271
+
1272
+ List all activities
1273
+
1274
+ ### Example Usage
1275
+
1276
+ ```typescript
1277
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1278
+
1279
+ const unifiedTo = new UnifiedTo({
1280
+ security: {
1281
+ jwt: "<YOUR_API_KEY_HERE>",
1282
+ },
1283
+ });
1284
+
1285
+ async function run() {
1286
+ const result = await unifiedTo.ats.listAtsActivities({
1287
+ connectionId: "<value>",
1288
+ });
1289
+
1290
+ // Handle the result
1291
+ console.log(result);
1292
+ }
1293
+
1294
+ run();
1295
+ ```
1296
+
1297
+ ### Standalone function
1298
+
1299
+ The standalone function version of this method:
1300
+
1301
+ ```typescript
1302
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1303
+ import { atsListAtsActivities } from "@unified-api/typescript-sdk/funcs/atsListAtsActivities.js";
1304
+
1305
+ // Use `UnifiedToCore` for best tree-shaking performance.
1306
+ // You can create one instance of it to use across an application.
1307
+ const unifiedTo = new UnifiedToCore({
1308
+ security: {
1309
+ jwt: "<YOUR_API_KEY_HERE>",
1310
+ },
1311
+ });
1312
+
1313
+ async function run() {
1314
+ const res = await atsListAtsActivities(unifiedTo, {
1315
+ connectionId: "<value>",
1316
+ });
1317
+
1318
+ if (!res.ok) {
1319
+ throw res.error;
1320
+ }
1321
+
1322
+ const { value: result } = res;
1323
+
1324
+ // Handle the result
1325
+ console.log(result);
1326
+ }
1327
+
1328
+ run();
1329
+ ```
1330
+
1331
+ ### Parameters
1332
+
1333
+ | Parameter | Type | Required | Description |
1334
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1335
+ | `request` | [operations.ListAtsActivitiesRequest](../../sdk/models/operations/listatsactivitiesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1336
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1337
+ | `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. |
1338
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1339
+
1340
+ ### Response
1341
+
1342
+ **Promise\<[shared.AtsActivity[]](../../models/.md)\>**
1343
+
1344
+ ### Errors
1345
+
1346
+ | Error Type | Status Code | Content Type |
1347
+ | --------------- | --------------- | --------------- |
1348
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1349
+
1350
+ ## listAtsApplications
1351
+
1352
+ List all applications
1353
+
1354
+ ### Example Usage
1355
+
1356
+ ```typescript
1357
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1358
+
1359
+ const unifiedTo = new UnifiedTo({
1360
+ security: {
1361
+ jwt: "<YOUR_API_KEY_HERE>",
1362
+ },
1363
+ });
1364
+
1365
+ async function run() {
1366
+ const result = await unifiedTo.ats.listAtsApplications({
1367
+ connectionId: "<value>",
1368
+ });
1369
+
1370
+ // Handle the result
1371
+ console.log(result);
1372
+ }
1373
+
1374
+ run();
1375
+ ```
1376
+
1377
+ ### Standalone function
1378
+
1379
+ The standalone function version of this method:
1380
+
1381
+ ```typescript
1382
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1383
+ import { atsListAtsApplications } from "@unified-api/typescript-sdk/funcs/atsListAtsApplications.js";
1384
+
1385
+ // Use `UnifiedToCore` for best tree-shaking performance.
1386
+ // You can create one instance of it to use across an application.
1387
+ const unifiedTo = new UnifiedToCore({
1388
+ security: {
1389
+ jwt: "<YOUR_API_KEY_HERE>",
1390
+ },
1391
+ });
1392
+
1393
+ async function run() {
1394
+ const res = await atsListAtsApplications(unifiedTo, {
1395
+ connectionId: "<value>",
1396
+ });
1397
+
1398
+ if (!res.ok) {
1399
+ throw res.error;
1400
+ }
1401
+
1402
+ const { value: result } = res;
1403
+
1404
+ // Handle the result
1405
+ console.log(result);
1406
+ }
1407
+
1408
+ run();
1409
+ ```
1410
+
1411
+ ### Parameters
1412
+
1413
+ | Parameter | Type | Required | Description |
1414
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1415
+ | `request` | [operations.ListAtsApplicationsRequest](../../sdk/models/operations/listatsapplicationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1416
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1417
+ | `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. |
1418
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1419
+
1420
+ ### Response
1421
+
1422
+ **Promise\<[shared.AtsApplication[]](../../models/.md)\>**
1423
+
1424
+ ### Errors
1425
+
1426
+ | Error Type | Status Code | Content Type |
1427
+ | --------------- | --------------- | --------------- |
1428
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1429
+
1430
+ ## listAtsApplicationstatuses
1431
+
1432
+ List all applicationstatuses
1433
+
1434
+ ### Example Usage
1435
+
1436
+ ```typescript
1437
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1438
+
1439
+ const unifiedTo = new UnifiedTo({
1440
+ security: {
1441
+ jwt: "<YOUR_API_KEY_HERE>",
1442
+ },
1443
+ });
1444
+
1445
+ async function run() {
1446
+ const result = await unifiedTo.ats.listAtsApplicationstatuses({
1447
+ connectionId: "<value>",
1448
+ });
1449
+
1450
+ // Handle the result
1451
+ console.log(result);
1452
+ }
1453
+
1454
+ run();
1455
+ ```
1456
+
1457
+ ### Standalone function
1458
+
1459
+ The standalone function version of this method:
1460
+
1461
+ ```typescript
1462
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1463
+ import { atsListAtsApplicationstatuses } from "@unified-api/typescript-sdk/funcs/atsListAtsApplicationstatuses.js";
1464
+
1465
+ // Use `UnifiedToCore` for best tree-shaking performance.
1466
+ // You can create one instance of it to use across an application.
1467
+ const unifiedTo = new UnifiedToCore({
1468
+ security: {
1469
+ jwt: "<YOUR_API_KEY_HERE>",
1470
+ },
1471
+ });
1472
+
1473
+ async function run() {
1474
+ const res = await atsListAtsApplicationstatuses(unifiedTo, {
1475
+ connectionId: "<value>",
1476
+ });
1477
+
1478
+ if (!res.ok) {
1479
+ throw res.error;
1480
+ }
1481
+
1482
+ const { value: result } = res;
1483
+
1484
+ // Handle the result
1485
+ console.log(result);
1486
+ }
1487
+
1488
+ run();
1489
+ ```
1490
+
1491
+ ### Parameters
1492
+
1493
+ | Parameter | Type | Required | Description |
1494
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1495
+ | `request` | [operations.ListAtsApplicationstatusesRequest](../../sdk/models/operations/listatsapplicationstatusesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1496
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1497
+ | `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. |
1498
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1499
+
1500
+ ### Response
1501
+
1502
+ **Promise\<[shared.AtsStatus[]](../../models/.md)\>**
1503
+
1504
+ ### Errors
1505
+
1506
+ | Error Type | Status Code | Content Type |
1507
+ | --------------- | --------------- | --------------- |
1508
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1509
+
1510
+ ## listAtsCandidates
1511
+
1512
+ List all candidates
1513
+
1514
+ ### Example Usage
1515
+
1516
+ ```typescript
1517
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1518
+
1519
+ const unifiedTo = new UnifiedTo({
1520
+ security: {
1521
+ jwt: "<YOUR_API_KEY_HERE>",
1522
+ },
1523
+ });
1524
+
1525
+ async function run() {
1526
+ const result = await unifiedTo.ats.listAtsCandidates({
1527
+ connectionId: "<value>",
1528
+ });
1529
+
1530
+ // Handle the result
1531
+ console.log(result);
1532
+ }
1533
+
1534
+ run();
1535
+ ```
1536
+
1537
+ ### Standalone function
1538
+
1539
+ The standalone function version of this method:
1540
+
1541
+ ```typescript
1542
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1543
+ import { atsListAtsCandidates } from "@unified-api/typescript-sdk/funcs/atsListAtsCandidates.js";
1544
+
1545
+ // Use `UnifiedToCore` for best tree-shaking performance.
1546
+ // You can create one instance of it to use across an application.
1547
+ const unifiedTo = new UnifiedToCore({
1548
+ security: {
1549
+ jwt: "<YOUR_API_KEY_HERE>",
1550
+ },
1551
+ });
1552
+
1553
+ async function run() {
1554
+ const res = await atsListAtsCandidates(unifiedTo, {
1555
+ connectionId: "<value>",
1556
+ });
1557
+
1558
+ if (!res.ok) {
1559
+ throw res.error;
1560
+ }
1561
+
1562
+ const { value: result } = res;
1563
+
1564
+ // Handle the result
1565
+ console.log(result);
1566
+ }
1567
+
1568
+ run();
1569
+ ```
1570
+
1571
+ ### Parameters
1572
+
1573
+ | Parameter | Type | Required | Description |
1574
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1575
+ | `request` | [operations.ListAtsCandidatesRequest](../../sdk/models/operations/listatscandidatesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1576
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1577
+ | `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. |
1578
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1579
+
1580
+ ### Response
1581
+
1582
+ **Promise\<[shared.AtsCandidate[]](../../models/.md)\>**
1583
+
1584
+ ### Errors
1585
+
1586
+ | Error Type | Status Code | Content Type |
1587
+ | --------------- | --------------- | --------------- |
1588
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1589
+
1590
+ ## listAtsCompanies
1591
+
1592
+ List all companies
1593
+
1594
+ ### Example Usage
1595
+
1596
+ ```typescript
1597
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1598
+
1599
+ const unifiedTo = new UnifiedTo({
1600
+ security: {
1601
+ jwt: "<YOUR_API_KEY_HERE>",
1602
+ },
1603
+ });
1604
+
1605
+ async function run() {
1606
+ const result = await unifiedTo.ats.listAtsCompanies({
1607
+ connectionId: "<value>",
1608
+ });
1609
+
1610
+ // Handle the result
1611
+ console.log(result);
1612
+ }
1613
+
1614
+ run();
1615
+ ```
1616
+
1617
+ ### Standalone function
1618
+
1619
+ The standalone function version of this method:
1620
+
1621
+ ```typescript
1622
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1623
+ import { atsListAtsCompanies } from "@unified-api/typescript-sdk/funcs/atsListAtsCompanies.js";
1624
+
1625
+ // Use `UnifiedToCore` for best tree-shaking performance.
1626
+ // You can create one instance of it to use across an application.
1627
+ const unifiedTo = new UnifiedToCore({
1628
+ security: {
1629
+ jwt: "<YOUR_API_KEY_HERE>",
1630
+ },
1631
+ });
1632
+
1633
+ async function run() {
1634
+ const res = await atsListAtsCompanies(unifiedTo, {
1635
+ connectionId: "<value>",
1636
+ });
1637
+
1638
+ if (!res.ok) {
1639
+ throw res.error;
1640
+ }
1641
+
1642
+ const { value: result } = res;
1643
+
1644
+ // Handle the result
1645
+ console.log(result);
1646
+ }
1647
+
1648
+ run();
1649
+ ```
1650
+
1651
+ ### Parameters
1652
+
1653
+ | Parameter | Type | Required | Description |
1654
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1655
+ | `request` | [operations.ListAtsCompaniesRequest](../../sdk/models/operations/listatscompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1656
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1657
+ | `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. |
1658
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1659
+
1660
+ ### Response
1661
+
1662
+ **Promise\<[shared.AtsCompany[]](../../models/.md)\>**
1663
+
1664
+ ### Errors
1665
+
1666
+ | Error Type | Status Code | Content Type |
1667
+ | --------------- | --------------- | --------------- |
1668
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1669
+
1670
+ ## listAtsDocuments
1671
+
1672
+ List all documents
1673
+
1674
+ ### Example Usage
1675
+
1676
+ ```typescript
1677
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1678
+
1679
+ const unifiedTo = new UnifiedTo({
1680
+ security: {
1681
+ jwt: "<YOUR_API_KEY_HERE>",
1682
+ },
1683
+ });
1684
+
1685
+ async function run() {
1686
+ const result = await unifiedTo.ats.listAtsDocuments({
1687
+ connectionId: "<value>",
1688
+ });
1689
+
1690
+ // Handle the result
1691
+ console.log(result);
1692
+ }
1693
+
1694
+ run();
1695
+ ```
1696
+
1697
+ ### Standalone function
1698
+
1699
+ The standalone function version of this method:
1700
+
1701
+ ```typescript
1702
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1703
+ import { atsListAtsDocuments } from "@unified-api/typescript-sdk/funcs/atsListAtsDocuments.js";
1704
+
1705
+ // Use `UnifiedToCore` for best tree-shaking performance.
1706
+ // You can create one instance of it to use across an application.
1707
+ const unifiedTo = new UnifiedToCore({
1708
+ security: {
1709
+ jwt: "<YOUR_API_KEY_HERE>",
1710
+ },
1711
+ });
1712
+
1713
+ async function run() {
1714
+ const res = await atsListAtsDocuments(unifiedTo, {
1715
+ connectionId: "<value>",
1716
+ });
1717
+
1718
+ if (!res.ok) {
1719
+ throw res.error;
1720
+ }
1721
+
1722
+ const { value: result } = res;
1723
+
1724
+ // Handle the result
1725
+ console.log(result);
1726
+ }
1727
+
1728
+ run();
1729
+ ```
1730
+
1731
+ ### Parameters
1732
+
1733
+ | Parameter | Type | Required | Description |
1734
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1735
+ | `request` | [operations.ListAtsDocumentsRequest](../../sdk/models/operations/listatsdocumentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1736
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1737
+ | `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. |
1738
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1739
+
1740
+ ### Response
1741
+
1742
+ **Promise\<[shared.AtsDocument[]](../../models/.md)\>**
1743
+
1744
+ ### Errors
1745
+
1746
+ | Error Type | Status Code | Content Type |
1747
+ | --------------- | --------------- | --------------- |
1748
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1749
+
1750
+ ## listAtsInterviews
1751
+
1752
+ List all interviews
1753
+
1754
+ ### Example Usage
1755
+
1756
+ ```typescript
1757
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1758
+
1759
+ const unifiedTo = new UnifiedTo({
1760
+ security: {
1761
+ jwt: "<YOUR_API_KEY_HERE>",
1762
+ },
1763
+ });
1764
+
1765
+ async function run() {
1766
+ const result = await unifiedTo.ats.listAtsInterviews({
1767
+ connectionId: "<value>",
1768
+ });
1769
+
1770
+ // Handle the result
1771
+ console.log(result);
1772
+ }
1773
+
1774
+ run();
1775
+ ```
1776
+
1777
+ ### Standalone function
1778
+
1779
+ The standalone function version of this method:
1780
+
1781
+ ```typescript
1782
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1783
+ import { atsListAtsInterviews } from "@unified-api/typescript-sdk/funcs/atsListAtsInterviews.js";
1784
+
1785
+ // Use `UnifiedToCore` for best tree-shaking performance.
1786
+ // You can create one instance of it to use across an application.
1787
+ const unifiedTo = new UnifiedToCore({
1788
+ security: {
1789
+ jwt: "<YOUR_API_KEY_HERE>",
1790
+ },
1791
+ });
1792
+
1793
+ async function run() {
1794
+ const res = await atsListAtsInterviews(unifiedTo, {
1795
+ connectionId: "<value>",
1796
+ });
1797
+
1798
+ if (!res.ok) {
1799
+ throw res.error;
1800
+ }
1801
+
1802
+ const { value: result } = res;
1803
+
1804
+ // Handle the result
1805
+ console.log(result);
1806
+ }
1807
+
1808
+ run();
1809
+ ```
1810
+
1811
+ ### Parameters
1812
+
1813
+ | Parameter | Type | Required | Description |
1814
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1815
+ | `request` | [operations.ListAtsInterviewsRequest](../../sdk/models/operations/listatsinterviewsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1816
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1817
+ | `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. |
1818
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1819
+
1820
+ ### Response
1821
+
1822
+ **Promise\<[shared.AtsInterview[]](../../models/.md)\>**
1823
+
1824
+ ### Errors
1825
+
1826
+ | Error Type | Status Code | Content Type |
1827
+ | --------------- | --------------- | --------------- |
1828
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1829
+
1830
+ ## listAtsJobs
1831
+
1832
+ List all jobs
1833
+
1834
+ ### Example Usage
1835
+
1836
+ ```typescript
1837
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1838
+
1839
+ const unifiedTo = new UnifiedTo({
1840
+ security: {
1841
+ jwt: "<YOUR_API_KEY_HERE>",
1842
+ },
1843
+ });
1844
+
1845
+ async function run() {
1846
+ const result = await unifiedTo.ats.listAtsJobs({
1847
+ connectionId: "<value>",
1848
+ });
1849
+
1850
+ // Handle the result
1851
+ console.log(result);
1852
+ }
1853
+
1854
+ run();
1855
+ ```
1856
+
1857
+ ### Standalone function
1858
+
1859
+ The standalone function version of this method:
1860
+
1861
+ ```typescript
1862
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1863
+ import { atsListAtsJobs } from "@unified-api/typescript-sdk/funcs/atsListAtsJobs.js";
1864
+
1865
+ // Use `UnifiedToCore` for best tree-shaking performance.
1866
+ // You can create one instance of it to use across an application.
1867
+ const unifiedTo = new UnifiedToCore({
1868
+ security: {
1869
+ jwt: "<YOUR_API_KEY_HERE>",
1870
+ },
1871
+ });
1872
+
1873
+ async function run() {
1874
+ const res = await atsListAtsJobs(unifiedTo, {
1875
+ connectionId: "<value>",
1876
+ });
1877
+
1878
+ if (!res.ok) {
1879
+ throw res.error;
1880
+ }
1881
+
1882
+ const { value: result } = res;
1883
+
1884
+ // Handle the result
1885
+ console.log(result);
1886
+ }
1887
+
1888
+ run();
1889
+ ```
1890
+
1891
+ ### Parameters
1892
+
1893
+ | Parameter | Type | Required | Description |
1894
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1895
+ | `request` | [operations.ListAtsJobsRequest](../../sdk/models/operations/listatsjobsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1896
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1897
+ | `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. |
1898
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1899
+
1900
+ ### Response
1901
+
1902
+ **Promise\<[shared.AtsJob[]](../../models/.md)\>**
1903
+
1904
+ ### Errors
1905
+
1906
+ | Error Type | Status Code | Content Type |
1907
+ | --------------- | --------------- | --------------- |
1908
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1909
+
1910
+ ## listAtsScorecards
1911
+
1912
+ List all scorecards
1913
+
1914
+ ### Example Usage
1915
+
1916
+ ```typescript
1917
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1918
+
1919
+ const unifiedTo = new UnifiedTo({
1920
+ security: {
1921
+ jwt: "<YOUR_API_KEY_HERE>",
1922
+ },
1923
+ });
1924
+
1925
+ async function run() {
1926
+ const result = await unifiedTo.ats.listAtsScorecards({
1927
+ connectionId: "<value>",
1928
+ });
1929
+
1930
+ // Handle the result
1931
+ console.log(result);
1932
+ }
1933
+
1934
+ run();
1935
+ ```
1936
+
1937
+ ### Standalone function
1938
+
1939
+ The standalone function version of this method:
1940
+
1941
+ ```typescript
1942
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1943
+ import { atsListAtsScorecards } from "@unified-api/typescript-sdk/funcs/atsListAtsScorecards.js";
1944
+
1945
+ // Use `UnifiedToCore` for best tree-shaking performance.
1946
+ // You can create one instance of it to use across an application.
1947
+ const unifiedTo = new UnifiedToCore({
1948
+ security: {
1949
+ jwt: "<YOUR_API_KEY_HERE>",
1950
+ },
1951
+ });
1952
+
1953
+ async function run() {
1954
+ const res = await atsListAtsScorecards(unifiedTo, {
1955
+ connectionId: "<value>",
1956
+ });
1957
+
1958
+ if (!res.ok) {
1959
+ throw res.error;
1960
+ }
1961
+
1962
+ const { value: result } = res;
1963
+
1964
+ // Handle the result
1965
+ console.log(result);
1966
+ }
1967
+
1968
+ run();
1969
+ ```
1970
+
1971
+ ### Parameters
1972
+
1973
+ | Parameter | Type | Required | Description |
1974
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1975
+ | `request` | [operations.ListAtsScorecardsRequest](../../sdk/models/operations/listatsscorecardsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1976
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1977
+ | `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. |
1978
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1979
+
1980
+ ### Response
1981
+
1982
+ **Promise\<[shared.AtsScorecard[]](../../models/.md)\>**
1983
+
1984
+ ### Errors
1985
+
1986
+ | Error Type | Status Code | Content Type |
1987
+ | --------------- | --------------- | --------------- |
1988
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1989
+
1990
+ ## patchAtsActivity
1991
+
1992
+ Update an activity
1993
+
1994
+ ### Example Usage
1995
+
1996
+ ```typescript
1997
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1998
+
1999
+ const unifiedTo = new UnifiedTo({
2000
+ security: {
2001
+ jwt: "<YOUR_API_KEY_HERE>",
2002
+ },
2003
+ });
2004
+
2005
+ async function run() {
2006
+ const result = await unifiedTo.ats.patchAtsActivity({
2007
+ connectionId: "<value>",
2008
+ id: "<id>",
2009
+ });
2010
+
2011
+ // Handle the result
2012
+ console.log(result);
2013
+ }
2014
+
2015
+ run();
2016
+ ```
2017
+
2018
+ ### Standalone function
2019
+
2020
+ The standalone function version of this method:
2021
+
2022
+ ```typescript
2023
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2024
+ import { atsPatchAtsActivity } from "@unified-api/typescript-sdk/funcs/atsPatchAtsActivity.js";
2025
+
2026
+ // Use `UnifiedToCore` for best tree-shaking performance.
2027
+ // You can create one instance of it to use across an application.
2028
+ const unifiedTo = new UnifiedToCore({
2029
+ security: {
2030
+ jwt: "<YOUR_API_KEY_HERE>",
2031
+ },
2032
+ });
2033
+
2034
+ async function run() {
2035
+ const res = await atsPatchAtsActivity(unifiedTo, {
2036
+ connectionId: "<value>",
2037
+ id: "<id>",
2038
+ });
2039
+
2040
+ if (!res.ok) {
2041
+ throw res.error;
2042
+ }
2043
+
2044
+ const { value: result } = res;
2045
+
2046
+ // Handle the result
2047
+ console.log(result);
2048
+ }
2049
+
2050
+ run();
2051
+ ```
2052
+
2053
+ ### Parameters
2054
+
2055
+ | Parameter | Type | Required | Description |
2056
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2057
+ | `request` | [operations.PatchAtsActivityRequest](../../sdk/models/operations/patchatsactivityrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2058
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2059
+ | `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. |
2060
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2061
+
2062
+ ### Response
2063
+
2064
+ **Promise\<[shared.AtsActivity](../../sdk/models/shared/atsactivity.md)\>**
2065
+
2066
+ ### Errors
2067
+
2068
+ | Error Type | Status Code | Content Type |
2069
+ | --------------- | --------------- | --------------- |
2070
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2071
+
2072
+ ## patchAtsApplication
2073
+
2074
+ Update an application
2075
+
2076
+ ### Example Usage
2077
+
2078
+ ```typescript
2079
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2080
+
2081
+ const unifiedTo = new UnifiedTo({
2082
+ security: {
2083
+ jwt: "<YOUR_API_KEY_HERE>",
2084
+ },
2085
+ });
2086
+
2087
+ async function run() {
2088
+ const result = await unifiedTo.ats.patchAtsApplication({
2089
+ connectionId: "<value>",
2090
+ id: "<id>",
2091
+ });
2092
+
2093
+ // Handle the result
2094
+ console.log(result);
2095
+ }
2096
+
2097
+ run();
2098
+ ```
2099
+
2100
+ ### Standalone function
2101
+
2102
+ The standalone function version of this method:
2103
+
2104
+ ```typescript
2105
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2106
+ import { atsPatchAtsApplication } from "@unified-api/typescript-sdk/funcs/atsPatchAtsApplication.js";
2107
+
2108
+ // Use `UnifiedToCore` for best tree-shaking performance.
2109
+ // You can create one instance of it to use across an application.
2110
+ const unifiedTo = new UnifiedToCore({
2111
+ security: {
2112
+ jwt: "<YOUR_API_KEY_HERE>",
2113
+ },
2114
+ });
2115
+
2116
+ async function run() {
2117
+ const res = await atsPatchAtsApplication(unifiedTo, {
2118
+ connectionId: "<value>",
2119
+ id: "<id>",
2120
+ });
2121
+
2122
+ if (!res.ok) {
2123
+ throw res.error;
2124
+ }
2125
+
2126
+ const { value: result } = res;
2127
+
2128
+ // Handle the result
2129
+ console.log(result);
2130
+ }
2131
+
2132
+ run();
2133
+ ```
2134
+
2135
+ ### Parameters
2136
+
2137
+ | Parameter | Type | Required | Description |
2138
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2139
+ | `request` | [operations.PatchAtsApplicationRequest](../../sdk/models/operations/patchatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2140
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2141
+ | `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. |
2142
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2143
+
2144
+ ### Response
2145
+
2146
+ **Promise\<[shared.AtsApplication](../../sdk/models/shared/atsapplication.md)\>**
2147
+
2148
+ ### Errors
2149
+
2150
+ | Error Type | Status Code | Content Type |
2151
+ | --------------- | --------------- | --------------- |
2152
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2153
+
2154
+ ## patchAtsCandidate
2155
+
2156
+ Update a candidate
2157
+
2158
+ ### Example Usage
2159
+
2160
+ ```typescript
2161
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2162
+
2163
+ const unifiedTo = new UnifiedTo({
2164
+ security: {
2165
+ jwt: "<YOUR_API_KEY_HERE>",
2166
+ },
2167
+ });
2168
+
2169
+ async function run() {
2170
+ const result = await unifiedTo.ats.patchAtsCandidate({
2171
+ connectionId: "<value>",
2172
+ id: "<id>",
2173
+ });
2174
+
2175
+ // Handle the result
2176
+ console.log(result);
2177
+ }
2178
+
2179
+ run();
2180
+ ```
2181
+
2182
+ ### Standalone function
2183
+
2184
+ The standalone function version of this method:
2185
+
2186
+ ```typescript
2187
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2188
+ import { atsPatchAtsCandidate } from "@unified-api/typescript-sdk/funcs/atsPatchAtsCandidate.js";
2189
+
2190
+ // Use `UnifiedToCore` for best tree-shaking performance.
2191
+ // You can create one instance of it to use across an application.
2192
+ const unifiedTo = new UnifiedToCore({
2193
+ security: {
2194
+ jwt: "<YOUR_API_KEY_HERE>",
2195
+ },
2196
+ });
2197
+
2198
+ async function run() {
2199
+ const res = await atsPatchAtsCandidate(unifiedTo, {
2200
+ connectionId: "<value>",
2201
+ id: "<id>",
2202
+ });
2203
+
2204
+ if (!res.ok) {
2205
+ throw res.error;
2206
+ }
2207
+
2208
+ const { value: result } = res;
2209
+
2210
+ // Handle the result
2211
+ console.log(result);
2212
+ }
2213
+
2214
+ run();
2215
+ ```
2216
+
2217
+ ### Parameters
2218
+
2219
+ | Parameter | Type | Required | Description |
2220
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2221
+ | `request` | [operations.PatchAtsCandidateRequest](../../sdk/models/operations/patchatscandidaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
2222
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2223
+ | `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. |
2224
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2225
+
2226
+ ### Response
2227
+
2228
+ **Promise\<[shared.AtsCandidate](../../sdk/models/shared/atscandidate.md)\>**
2229
+
2230
+ ### Errors
2231
+
2232
+ | Error Type | Status Code | Content Type |
2233
+ | --------------- | --------------- | --------------- |
2234
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2235
+
2236
+ ## patchAtsDocument
2237
+
2238
+ Update a document
2239
+
2240
+ ### Example Usage
2241
+
2242
+ ```typescript
2243
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2244
+
2245
+ const unifiedTo = new UnifiedTo({
2246
+ security: {
2247
+ jwt: "<YOUR_API_KEY_HERE>",
2248
+ },
2249
+ });
2250
+
2251
+ async function run() {
2252
+ const result = await unifiedTo.ats.patchAtsDocument({
2253
+ connectionId: "<value>",
2254
+ id: "<id>",
2255
+ });
2256
+
2257
+ // Handle the result
2258
+ console.log(result);
2259
+ }
2260
+
2261
+ run();
2262
+ ```
2263
+
2264
+ ### Standalone function
2265
+
2266
+ The standalone function version of this method:
2267
+
2268
+ ```typescript
2269
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2270
+ import { atsPatchAtsDocument } from "@unified-api/typescript-sdk/funcs/atsPatchAtsDocument.js";
2271
+
2272
+ // Use `UnifiedToCore` for best tree-shaking performance.
2273
+ // You can create one instance of it to use across an application.
2274
+ const unifiedTo = new UnifiedToCore({
2275
+ security: {
2276
+ jwt: "<YOUR_API_KEY_HERE>",
2277
+ },
2278
+ });
2279
+
2280
+ async function run() {
2281
+ const res = await atsPatchAtsDocument(unifiedTo, {
2282
+ connectionId: "<value>",
2283
+ id: "<id>",
2284
+ });
2285
+
2286
+ if (!res.ok) {
2287
+ throw res.error;
2288
+ }
2289
+
2290
+ const { value: result } = res;
2291
+
2292
+ // Handle the result
2293
+ console.log(result);
2294
+ }
2295
+
2296
+ run();
2297
+ ```
2298
+
2299
+ ### Parameters
2300
+
2301
+ | Parameter | Type | Required | Description |
2302
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2303
+ | `request` | [operations.PatchAtsDocumentRequest](../../sdk/models/operations/patchatsdocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2304
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2305
+ | `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. |
2306
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2307
+
2308
+ ### Response
2309
+
2310
+ **Promise\<[shared.AtsDocument](../../sdk/models/shared/atsdocument.md)\>**
2311
+
2312
+ ### Errors
2313
+
2314
+ | Error Type | Status Code | Content Type |
2315
+ | --------------- | --------------- | --------------- |
2316
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2317
+
2318
+ ## patchAtsInterview
2319
+
2320
+ Update an interview
2321
+
2322
+ ### Example Usage
2323
+
2324
+ ```typescript
2325
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2326
+
2327
+ const unifiedTo = new UnifiedTo({
2328
+ security: {
2329
+ jwt: "<YOUR_API_KEY_HERE>",
2330
+ },
2331
+ });
2332
+
2333
+ async function run() {
2334
+ const result = await unifiedTo.ats.patchAtsInterview({
2335
+ connectionId: "<value>",
2336
+ id: "<id>",
2337
+ });
2338
+
2339
+ // Handle the result
2340
+ console.log(result);
2341
+ }
2342
+
2343
+ run();
2344
+ ```
2345
+
2346
+ ### Standalone function
2347
+
2348
+ The standalone function version of this method:
2349
+
2350
+ ```typescript
2351
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2352
+ import { atsPatchAtsInterview } from "@unified-api/typescript-sdk/funcs/atsPatchAtsInterview.js";
2353
+
2354
+ // Use `UnifiedToCore` for best tree-shaking performance.
2355
+ // You can create one instance of it to use across an application.
2356
+ const unifiedTo = new UnifiedToCore({
2357
+ security: {
2358
+ jwt: "<YOUR_API_KEY_HERE>",
2359
+ },
2360
+ });
2361
+
2362
+ async function run() {
2363
+ const res = await atsPatchAtsInterview(unifiedTo, {
2364
+ connectionId: "<value>",
2365
+ id: "<id>",
2366
+ });
2367
+
2368
+ if (!res.ok) {
2369
+ throw res.error;
2370
+ }
2371
+
2372
+ const { value: result } = res;
2373
+
2374
+ // Handle the result
2375
+ console.log(result);
2376
+ }
2377
+
2378
+ run();
2379
+ ```
2380
+
2381
+ ### Parameters
2382
+
2383
+ | Parameter | Type | Required | Description |
2384
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2385
+ | `request` | [operations.PatchAtsInterviewRequest](../../sdk/models/operations/patchatsinterviewrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2386
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2387
+ | `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. |
2388
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2389
+
2390
+ ### Response
2391
+
2392
+ **Promise\<[shared.AtsInterview](../../sdk/models/shared/atsinterview.md)\>**
2393
+
2394
+ ### Errors
2395
+
2396
+ | Error Type | Status Code | Content Type |
2397
+ | --------------- | --------------- | --------------- |
2398
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2399
+
2400
+ ## patchAtsJob
2401
+
2402
+ Update a job
2403
+
2404
+ ### Example Usage
2405
+
2406
+ ```typescript
2407
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2408
+
2409
+ const unifiedTo = new UnifiedTo({
2410
+ security: {
2411
+ jwt: "<YOUR_API_KEY_HERE>",
2412
+ },
2413
+ });
2414
+
2415
+ async function run() {
2416
+ const result = await unifiedTo.ats.patchAtsJob({
2417
+ connectionId: "<value>",
2418
+ id: "<id>",
2419
+ });
2420
+
2421
+ // Handle the result
2422
+ console.log(result);
2423
+ }
2424
+
2425
+ run();
2426
+ ```
2427
+
2428
+ ### Standalone function
2429
+
2430
+ The standalone function version of this method:
2431
+
2432
+ ```typescript
2433
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2434
+ import { atsPatchAtsJob } from "@unified-api/typescript-sdk/funcs/atsPatchAtsJob.js";
2435
+
2436
+ // Use `UnifiedToCore` for best tree-shaking performance.
2437
+ // You can create one instance of it to use across an application.
2438
+ const unifiedTo = new UnifiedToCore({
2439
+ security: {
2440
+ jwt: "<YOUR_API_KEY_HERE>",
2441
+ },
2442
+ });
2443
+
2444
+ async function run() {
2445
+ const res = await atsPatchAtsJob(unifiedTo, {
2446
+ connectionId: "<value>",
2447
+ id: "<id>",
2448
+ });
2449
+
2450
+ if (!res.ok) {
2451
+ throw res.error;
2452
+ }
2453
+
2454
+ const { value: result } = res;
2455
+
2456
+ // Handle the result
2457
+ console.log(result);
2458
+ }
2459
+
2460
+ run();
2461
+ ```
2462
+
2463
+ ### Parameters
2464
+
2465
+ | Parameter | Type | Required | Description |
2466
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2467
+ | `request` | [operations.PatchAtsJobRequest](../../sdk/models/operations/patchatsjobrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2468
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2469
+ | `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. |
2470
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2471
+
2472
+ ### Response
2473
+
2474
+ **Promise\<[shared.AtsJob](../../sdk/models/shared/atsjob.md)\>**
2475
+
2476
+ ### Errors
2477
+
2478
+ | Error Type | Status Code | Content Type |
2479
+ | --------------- | --------------- | --------------- |
2480
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2481
+
2482
+ ## patchAtsScorecard
2483
+
2484
+ Update a scorecard
2485
+
2486
+ ### Example Usage
2487
+
2488
+ ```typescript
2489
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2490
+
2491
+ const unifiedTo = new UnifiedTo({
2492
+ security: {
2493
+ jwt: "<YOUR_API_KEY_HERE>",
2494
+ },
2495
+ });
2496
+
2497
+ async function run() {
2498
+ const result = await unifiedTo.ats.patchAtsScorecard({
2499
+ connectionId: "<value>",
2500
+ id: "<id>",
2501
+ });
2502
+
2503
+ // Handle the result
2504
+ console.log(result);
2505
+ }
2506
+
2507
+ run();
2508
+ ```
2509
+
2510
+ ### Standalone function
2511
+
2512
+ The standalone function version of this method:
2513
+
2514
+ ```typescript
2515
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2516
+ import { atsPatchAtsScorecard } from "@unified-api/typescript-sdk/funcs/atsPatchAtsScorecard.js";
2517
+
2518
+ // Use `UnifiedToCore` for best tree-shaking performance.
2519
+ // You can create one instance of it to use across an application.
2520
+ const unifiedTo = new UnifiedToCore({
2521
+ security: {
2522
+ jwt: "<YOUR_API_KEY_HERE>",
2523
+ },
2524
+ });
2525
+
2526
+ async function run() {
2527
+ const res = await atsPatchAtsScorecard(unifiedTo, {
2528
+ connectionId: "<value>",
2529
+ id: "<id>",
2530
+ });
2531
+
2532
+ if (!res.ok) {
2533
+ throw res.error;
2534
+ }
2535
+
2536
+ const { value: result } = res;
2537
+
2538
+ // Handle the result
2539
+ console.log(result);
2540
+ }
2541
+
2542
+ run();
2543
+ ```
2544
+
2545
+ ### Parameters
2546
+
2547
+ | Parameter | Type | Required | Description |
2548
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2549
+ | `request` | [operations.PatchAtsScorecardRequest](../../sdk/models/operations/patchatsscorecardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2550
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2551
+ | `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. |
2552
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2553
+
2554
+ ### Response
2555
+
2556
+ **Promise\<[shared.AtsScorecard](../../sdk/models/shared/atsscorecard.md)\>**
2557
+
2558
+ ### Errors
2559
+
2560
+ | Error Type | Status Code | Content Type |
2561
+ | --------------- | --------------- | --------------- |
2562
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2563
+
2564
+ ## removeAtsActivity
2565
+
2566
+ Remove an activity
2567
+
2568
+ ### Example Usage
2569
+
2570
+ ```typescript
2571
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2572
+
2573
+ const unifiedTo = new UnifiedTo({
2574
+ security: {
2575
+ jwt: "<YOUR_API_KEY_HERE>",
2576
+ },
2577
+ });
2578
+
2579
+ async function run() {
2580
+ const result = await unifiedTo.ats.removeAtsActivity({
2581
+ connectionId: "<value>",
2582
+ id: "<id>",
2583
+ });
2584
+
2585
+ // Handle the result
2586
+ console.log(result);
2587
+ }
2588
+
2589
+ run();
2590
+ ```
2591
+
2592
+ ### Standalone function
2593
+
2594
+ The standalone function version of this method:
2595
+
2596
+ ```typescript
2597
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2598
+ import { atsRemoveAtsActivity } from "@unified-api/typescript-sdk/funcs/atsRemoveAtsActivity.js";
2599
+
2600
+ // Use `UnifiedToCore` for best tree-shaking performance.
2601
+ // You can create one instance of it to use across an application.
2602
+ const unifiedTo = new UnifiedToCore({
2603
+ security: {
2604
+ jwt: "<YOUR_API_KEY_HERE>",
2605
+ },
2606
+ });
2607
+
2608
+ async function run() {
2609
+ const res = await atsRemoveAtsActivity(unifiedTo, {
2610
+ connectionId: "<value>",
2611
+ id: "<id>",
2612
+ });
2613
+
2614
+ if (!res.ok) {
2615
+ throw res.error;
2616
+ }
2617
+
2618
+ const { value: result } = res;
2619
+
2620
+ // Handle the result
2621
+ console.log(result);
2622
+ }
2623
+
2624
+ run();
2625
+ ```
2626
+
2627
+ ### Parameters
2628
+
2629
+ | Parameter | Type | Required | Description |
2630
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2631
+ | `request` | [operations.RemoveAtsActivityRequest](../../sdk/models/operations/removeatsactivityrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2632
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2633
+ | `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. |
2634
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2635
+
2636
+ ### Response
2637
+
2638
+ **Promise\<[operations.RemoveAtsActivityResponse](../../sdk/models/operations/removeatsactivityresponse.md)\>**
2639
+
2640
+ ### Errors
2641
+
2642
+ | Error Type | Status Code | Content Type |
2643
+ | --------------- | --------------- | --------------- |
2644
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2645
+
2646
+ ## removeAtsApplication
2647
+
2648
+ Remove an application
2649
+
2650
+ ### Example Usage
2651
+
2652
+ ```typescript
2653
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2654
+
2655
+ const unifiedTo = new UnifiedTo({
2656
+ security: {
2657
+ jwt: "<YOUR_API_KEY_HERE>",
2658
+ },
2659
+ });
2660
+
2661
+ async function run() {
2662
+ const result = await unifiedTo.ats.removeAtsApplication({
2663
+ connectionId: "<value>",
2664
+ id: "<id>",
2665
+ });
2666
+
2667
+ // Handle the result
2668
+ console.log(result);
2669
+ }
2670
+
2671
+ run();
2672
+ ```
2673
+
2674
+ ### Standalone function
2675
+
2676
+ The standalone function version of this method:
2677
+
2678
+ ```typescript
2679
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2680
+ import { atsRemoveAtsApplication } from "@unified-api/typescript-sdk/funcs/atsRemoveAtsApplication.js";
2681
+
2682
+ // Use `UnifiedToCore` for best tree-shaking performance.
2683
+ // You can create one instance of it to use across an application.
2684
+ const unifiedTo = new UnifiedToCore({
2685
+ security: {
2686
+ jwt: "<YOUR_API_KEY_HERE>",
2687
+ },
2688
+ });
2689
+
2690
+ async function run() {
2691
+ const res = await atsRemoveAtsApplication(unifiedTo, {
2692
+ connectionId: "<value>",
2693
+ id: "<id>",
2694
+ });
2695
+
2696
+ if (!res.ok) {
2697
+ throw res.error;
2698
+ }
2699
+
2700
+ const { value: result } = res;
2701
+
2702
+ // Handle the result
2703
+ console.log(result);
2704
+ }
2705
+
2706
+ run();
2707
+ ```
2708
+
2709
+ ### Parameters
2710
+
2711
+ | Parameter | Type | Required | Description |
2712
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2713
+ | `request` | [operations.RemoveAtsApplicationRequest](../../sdk/models/operations/removeatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2714
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2715
+ | `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. |
2716
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2717
+
2718
+ ### Response
2719
+
2720
+ **Promise\<[operations.RemoveAtsApplicationResponse](../../sdk/models/operations/removeatsapplicationresponse.md)\>**
2721
+
2722
+ ### Errors
2723
+
2724
+ | Error Type | Status Code | Content Type |
2725
+ | --------------- | --------------- | --------------- |
2726
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2727
+
2728
+ ## removeAtsCandidate
2729
+
2730
+ Remove a candidate
2731
+
2732
+ ### Example Usage
2733
+
2734
+ ```typescript
2735
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2736
+
2737
+ const unifiedTo = new UnifiedTo({
2738
+ security: {
2739
+ jwt: "<YOUR_API_KEY_HERE>",
2740
+ },
2741
+ });
2742
+
2743
+ async function run() {
2744
+ const result = await unifiedTo.ats.removeAtsCandidate({
2745
+ connectionId: "<value>",
2746
+ id: "<id>",
2747
+ });
2748
+
2749
+ // Handle the result
2750
+ console.log(result);
2751
+ }
2752
+
2753
+ run();
2754
+ ```
2755
+
2756
+ ### Standalone function
2757
+
2758
+ The standalone function version of this method:
2759
+
2760
+ ```typescript
2761
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2762
+ import { atsRemoveAtsCandidate } from "@unified-api/typescript-sdk/funcs/atsRemoveAtsCandidate.js";
2763
+
2764
+ // Use `UnifiedToCore` for best tree-shaking performance.
2765
+ // You can create one instance of it to use across an application.
2766
+ const unifiedTo = new UnifiedToCore({
2767
+ security: {
2768
+ jwt: "<YOUR_API_KEY_HERE>",
2769
+ },
2770
+ });
2771
+
2772
+ async function run() {
2773
+ const res = await atsRemoveAtsCandidate(unifiedTo, {
2774
+ connectionId: "<value>",
2775
+ id: "<id>",
2776
+ });
2777
+
2778
+ if (!res.ok) {
2779
+ throw res.error;
2780
+ }
2781
+
2782
+ const { value: result } = res;
2783
+
2784
+ // Handle the result
2785
+ console.log(result);
2786
+ }
2787
+
2788
+ run();
2789
+ ```
2790
+
2791
+ ### Parameters
2792
+
2793
+ | Parameter | Type | Required | Description |
2794
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2795
+ | `request` | [operations.RemoveAtsCandidateRequest](../../sdk/models/operations/removeatscandidaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
2796
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2797
+ | `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. |
2798
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2799
+
2800
+ ### Response
2801
+
2802
+ **Promise\<[operations.RemoveAtsCandidateResponse](../../sdk/models/operations/removeatscandidateresponse.md)\>**
2803
+
2804
+ ### Errors
2805
+
2806
+ | Error Type | Status Code | Content Type |
2807
+ | --------------- | --------------- | --------------- |
2808
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2809
+
2810
+ ## removeAtsDocument
2811
+
2812
+ Remove a document
2813
+
2814
+ ### Example Usage
2815
+
2816
+ ```typescript
2817
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2818
+
2819
+ const unifiedTo = new UnifiedTo({
2820
+ security: {
2821
+ jwt: "<YOUR_API_KEY_HERE>",
2822
+ },
2823
+ });
2824
+
2825
+ async function run() {
2826
+ const result = await unifiedTo.ats.removeAtsDocument({
2827
+ connectionId: "<value>",
2828
+ id: "<id>",
2829
+ });
2830
+
2831
+ // Handle the result
2832
+ console.log(result);
2833
+ }
2834
+
2835
+ run();
2836
+ ```
2837
+
2838
+ ### Standalone function
2839
+
2840
+ The standalone function version of this method:
2841
+
2842
+ ```typescript
2843
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2844
+ import { atsRemoveAtsDocument } from "@unified-api/typescript-sdk/funcs/atsRemoveAtsDocument.js";
2845
+
2846
+ // Use `UnifiedToCore` for best tree-shaking performance.
2847
+ // You can create one instance of it to use across an application.
2848
+ const unifiedTo = new UnifiedToCore({
2849
+ security: {
2850
+ jwt: "<YOUR_API_KEY_HERE>",
2851
+ },
2852
+ });
2853
+
2854
+ async function run() {
2855
+ const res = await atsRemoveAtsDocument(unifiedTo, {
2856
+ connectionId: "<value>",
2857
+ id: "<id>",
2858
+ });
2859
+
2860
+ if (!res.ok) {
2861
+ throw res.error;
2862
+ }
2863
+
2864
+ const { value: result } = res;
2865
+
2866
+ // Handle the result
2867
+ console.log(result);
2868
+ }
2869
+
2870
+ run();
2871
+ ```
2872
+
2873
+ ### Parameters
2874
+
2875
+ | Parameter | Type | Required | Description |
2876
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2877
+ | `request` | [operations.RemoveAtsDocumentRequest](../../sdk/models/operations/removeatsdocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2878
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2879
+ | `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. |
2880
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2881
+
2882
+ ### Response
2883
+
2884
+ **Promise\<[operations.RemoveAtsDocumentResponse](../../sdk/models/operations/removeatsdocumentresponse.md)\>**
2885
+
2886
+ ### Errors
2887
+
2888
+ | Error Type | Status Code | Content Type |
2889
+ | --------------- | --------------- | --------------- |
2890
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2891
+
2892
+ ## removeAtsInterview
2893
+
2894
+ Remove an interview
2895
+
2896
+ ### Example Usage
2897
+
2898
+ ```typescript
2899
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2900
+
2901
+ const unifiedTo = new UnifiedTo({
2902
+ security: {
2903
+ jwt: "<YOUR_API_KEY_HERE>",
2904
+ },
2905
+ });
2906
+
2907
+ async function run() {
2908
+ const result = await unifiedTo.ats.removeAtsInterview({
2909
+ connectionId: "<value>",
2910
+ id: "<id>",
2911
+ });
2912
+
2913
+ // Handle the result
2914
+ console.log(result);
2915
+ }
2916
+
2917
+ run();
2918
+ ```
2919
+
2920
+ ### Standalone function
2921
+
2922
+ The standalone function version of this method:
2923
+
2924
+ ```typescript
2925
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
2926
+ import { atsRemoveAtsInterview } from "@unified-api/typescript-sdk/funcs/atsRemoveAtsInterview.js";
2927
+
2928
+ // Use `UnifiedToCore` for best tree-shaking performance.
2929
+ // You can create one instance of it to use across an application.
2930
+ const unifiedTo = new UnifiedToCore({
2931
+ security: {
2932
+ jwt: "<YOUR_API_KEY_HERE>",
2933
+ },
2934
+ });
2935
+
2936
+ async function run() {
2937
+ const res = await atsRemoveAtsInterview(unifiedTo, {
2938
+ connectionId: "<value>",
2939
+ id: "<id>",
2940
+ });
2941
+
2942
+ if (!res.ok) {
2943
+ throw res.error;
2944
+ }
2945
+
2946
+ const { value: result } = res;
2947
+
2948
+ // Handle the result
2949
+ console.log(result);
2950
+ }
2951
+
2952
+ run();
2953
+ ```
2954
+
2955
+ ### Parameters
2956
+
2957
+ | Parameter | Type | Required | Description |
2958
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2959
+ | `request` | [operations.RemoveAtsInterviewRequest](../../sdk/models/operations/removeatsinterviewrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2960
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2961
+ | `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. |
2962
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2963
+
2964
+ ### Response
2965
+
2966
+ **Promise\<[operations.RemoveAtsInterviewResponse](../../sdk/models/operations/removeatsinterviewresponse.md)\>**
2967
+
2968
+ ### Errors
2969
+
2970
+ | Error Type | Status Code | Content Type |
2971
+ | --------------- | --------------- | --------------- |
2972
+ | errors.SDKError | 4XX, 5XX | \*/\* |
2973
+
2974
+ ## removeAtsJob
2975
+
2976
+ Remove a job
2977
+
2978
+ ### Example Usage
2979
+
2980
+ ```typescript
2981
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
2982
+
2983
+ const unifiedTo = new UnifiedTo({
2984
+ security: {
2985
+ jwt: "<YOUR_API_KEY_HERE>",
2986
+ },
2987
+ });
2988
+
2989
+ async function run() {
2990
+ const result = await unifiedTo.ats.removeAtsJob({
2991
+ connectionId: "<value>",
2992
+ id: "<id>",
2993
+ });
2994
+
2995
+ // Handle the result
2996
+ console.log(result);
2997
+ }
2998
+
2999
+ run();
3000
+ ```
3001
+
3002
+ ### Standalone function
3003
+
3004
+ The standalone function version of this method:
3005
+
3006
+ ```typescript
3007
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
3008
+ import { atsRemoveAtsJob } from "@unified-api/typescript-sdk/funcs/atsRemoveAtsJob.js";
3009
+
3010
+ // Use `UnifiedToCore` for best tree-shaking performance.
3011
+ // You can create one instance of it to use across an application.
3012
+ const unifiedTo = new UnifiedToCore({
3013
+ security: {
3014
+ jwt: "<YOUR_API_KEY_HERE>",
3015
+ },
3016
+ });
3017
+
3018
+ async function run() {
3019
+ const res = await atsRemoveAtsJob(unifiedTo, {
3020
+ connectionId: "<value>",
3021
+ id: "<id>",
3022
+ });
3023
+
3024
+ if (!res.ok) {
3025
+ throw res.error;
3026
+ }
3027
+
3028
+ const { value: result } = res;
3029
+
3030
+ // Handle the result
3031
+ console.log(result);
3032
+ }
3033
+
3034
+ run();
3035
+ ```
3036
+
3037
+ ### Parameters
3038
+
3039
+ | Parameter | Type | Required | Description |
3040
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3041
+ | `request` | [operations.RemoveAtsJobRequest](../../sdk/models/operations/removeatsjobrequest.md) | :heavy_check_mark: | The request object to use for the request. |
3042
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3043
+ | `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. |
3044
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
3045
+
3046
+ ### Response
3047
+
3048
+ **Promise\<[operations.RemoveAtsJobResponse](../../sdk/models/operations/removeatsjobresponse.md)\>**
3049
+
3050
+ ### Errors
3051
+
3052
+ | Error Type | Status Code | Content Type |
3053
+ | --------------- | --------------- | --------------- |
3054
+ | errors.SDKError | 4XX, 5XX | \*/\* |
3055
+
3056
+ ## removeAtsScorecard
3057
+
3058
+ Remove a scorecard
3059
+
3060
+ ### Example Usage
3061
+
3062
+ ```typescript
3063
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
3064
+
3065
+ const unifiedTo = new UnifiedTo({
3066
+ security: {
3067
+ jwt: "<YOUR_API_KEY_HERE>",
3068
+ },
3069
+ });
3070
+
3071
+ async function run() {
3072
+ const result = await unifiedTo.ats.removeAtsScorecard({
3073
+ connectionId: "<value>",
3074
+ id: "<id>",
3075
+ });
3076
+
3077
+ // Handle the result
3078
+ console.log(result);
3079
+ }
3080
+
3081
+ run();
3082
+ ```
3083
+
3084
+ ### Standalone function
3085
+
3086
+ The standalone function version of this method:
3087
+
3088
+ ```typescript
3089
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
3090
+ import { atsRemoveAtsScorecard } from "@unified-api/typescript-sdk/funcs/atsRemoveAtsScorecard.js";
3091
+
3092
+ // Use `UnifiedToCore` for best tree-shaking performance.
3093
+ // You can create one instance of it to use across an application.
3094
+ const unifiedTo = new UnifiedToCore({
3095
+ security: {
3096
+ jwt: "<YOUR_API_KEY_HERE>",
3097
+ },
3098
+ });
3099
+
3100
+ async function run() {
3101
+ const res = await atsRemoveAtsScorecard(unifiedTo, {
3102
+ connectionId: "<value>",
3103
+ id: "<id>",
3104
+ });
3105
+
3106
+ if (!res.ok) {
3107
+ throw res.error;
3108
+ }
3109
+
3110
+ const { value: result } = res;
3111
+
3112
+ // Handle the result
3113
+ console.log(result);
3114
+ }
3115
+
3116
+ run();
3117
+ ```
3118
+
3119
+ ### Parameters
3120
+
3121
+ | Parameter | Type | Required | Description |
3122
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3123
+ | `request` | [operations.RemoveAtsScorecardRequest](../../sdk/models/operations/removeatsscorecardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
3124
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3125
+ | `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. |
3126
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
3127
+
3128
+ ### Response
3129
+
3130
+ **Promise\<[operations.RemoveAtsScorecardResponse](../../sdk/models/operations/removeatsscorecardresponse.md)\>**
3131
+
3132
+ ### Errors
3133
+
3134
+ | Error Type | Status Code | Content Type |
3135
+ | --------------- | --------------- | --------------- |
3136
+ | errors.SDKError | 4XX, 5XX | \*/\* |
3137
+
3138
+ ## updateAtsActivity
3139
+
3140
+ Update an activity
3141
+
3142
+ ### Example Usage
3143
+
3144
+ ```typescript
3145
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
3146
+
3147
+ const unifiedTo = new UnifiedTo({
3148
+ security: {
3149
+ jwt: "<YOUR_API_KEY_HERE>",
3150
+ },
3151
+ });
3152
+
3153
+ async function run() {
3154
+ const result = await unifiedTo.ats.updateAtsActivity({
3155
+ connectionId: "<value>",
3156
+ id: "<id>",
3157
+ });
3158
+
3159
+ // Handle the result
3160
+ console.log(result);
3161
+ }
3162
+
3163
+ run();
3164
+ ```
3165
+
3166
+ ### Standalone function
3167
+
3168
+ The standalone function version of this method:
3169
+
3170
+ ```typescript
3171
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
3172
+ import { atsUpdateAtsActivity } from "@unified-api/typescript-sdk/funcs/atsUpdateAtsActivity.js";
3173
+
3174
+ // Use `UnifiedToCore` for best tree-shaking performance.
3175
+ // You can create one instance of it to use across an application.
3176
+ const unifiedTo = new UnifiedToCore({
3177
+ security: {
3178
+ jwt: "<YOUR_API_KEY_HERE>",
3179
+ },
3180
+ });
3181
+
3182
+ async function run() {
3183
+ const res = await atsUpdateAtsActivity(unifiedTo, {
3184
+ connectionId: "<value>",
3185
+ id: "<id>",
3186
+ });
3187
+
3188
+ if (!res.ok) {
3189
+ throw res.error;
3190
+ }
3191
+
3192
+ const { value: result } = res;
3193
+
3194
+ // Handle the result
3195
+ console.log(result);
3196
+ }
3197
+
3198
+ run();
3199
+ ```
3200
+
3201
+ ### Parameters
3202
+
3203
+ | Parameter | Type | Required | Description |
3204
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3205
+ | `request` | [operations.UpdateAtsActivityRequest](../../sdk/models/operations/updateatsactivityrequest.md) | :heavy_check_mark: | The request object to use for the request. |
3206
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3207
+ | `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. |
3208
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
3209
+
3210
+ ### Response
3211
+
3212
+ **Promise\<[shared.AtsActivity](../../sdk/models/shared/atsactivity.md)\>**
3213
+
3214
+ ### Errors
3215
+
3216
+ | Error Type | Status Code | Content Type |
3217
+ | --------------- | --------------- | --------------- |
3218
+ | errors.SDKError | 4XX, 5XX | \*/\* |
3219
+
3220
+ ## updateAtsApplication
3221
+
3222
+ Update an application
3223
+
3224
+ ### Example Usage
3225
+
3226
+ ```typescript
3227
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
3228
+
3229
+ const unifiedTo = new UnifiedTo({
3230
+ security: {
3231
+ jwt: "<YOUR_API_KEY_HERE>",
3232
+ },
3233
+ });
3234
+
3235
+ async function run() {
3236
+ const result = await unifiedTo.ats.updateAtsApplication({
3237
+ connectionId: "<value>",
3238
+ id: "<id>",
3239
+ });
3240
+
3241
+ // Handle the result
3242
+ console.log(result);
3243
+ }
3244
+
3245
+ run();
3246
+ ```
3247
+
3248
+ ### Standalone function
3249
+
3250
+ The standalone function version of this method:
3251
+
3252
+ ```typescript
3253
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
3254
+ import { atsUpdateAtsApplication } from "@unified-api/typescript-sdk/funcs/atsUpdateAtsApplication.js";
3255
+
3256
+ // Use `UnifiedToCore` for best tree-shaking performance.
3257
+ // You can create one instance of it to use across an application.
3258
+ const unifiedTo = new UnifiedToCore({
3259
+ security: {
3260
+ jwt: "<YOUR_API_KEY_HERE>",
3261
+ },
3262
+ });
3263
+
3264
+ async function run() {
3265
+ const res = await atsUpdateAtsApplication(unifiedTo, {
3266
+ connectionId: "<value>",
3267
+ id: "<id>",
3268
+ });
3269
+
3270
+ if (!res.ok) {
3271
+ throw res.error;
3272
+ }
3273
+
3274
+ const { value: result } = res;
3275
+
3276
+ // Handle the result
3277
+ console.log(result);
3278
+ }
3279
+
3280
+ run();
3281
+ ```
3282
+
3283
+ ### Parameters
3284
+
3285
+ | Parameter | Type | Required | Description |
3286
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3287
+ | `request` | [operations.UpdateAtsApplicationRequest](../../sdk/models/operations/updateatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
3288
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3289
+ | `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. |
3290
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
3291
+
3292
+ ### Response
3293
+
3294
+ **Promise\<[shared.AtsApplication](../../sdk/models/shared/atsapplication.md)\>**
3295
+
3296
+ ### Errors
3297
+
3298
+ | Error Type | Status Code | Content Type |
3299
+ | --------------- | --------------- | --------------- |
3300
+ | errors.SDKError | 4XX, 5XX | \*/\* |
3301
+
3302
+ ## updateAtsCandidate
3303
+
3304
+ Update a candidate
3305
+
3306
+ ### Example Usage
3307
+
3308
+ ```typescript
3309
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
3310
+
3311
+ const unifiedTo = new UnifiedTo({
3312
+ security: {
3313
+ jwt: "<YOUR_API_KEY_HERE>",
3314
+ },
3315
+ });
3316
+
3317
+ async function run() {
3318
+ const result = await unifiedTo.ats.updateAtsCandidate({
3319
+ connectionId: "<value>",
3320
+ id: "<id>",
3321
+ });
3322
+
3323
+ // Handle the result
3324
+ console.log(result);
3325
+ }
3326
+
3327
+ run();
3328
+ ```
3329
+
3330
+ ### Standalone function
3331
+
3332
+ The standalone function version of this method:
3333
+
3334
+ ```typescript
3335
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
3336
+ import { atsUpdateAtsCandidate } from "@unified-api/typescript-sdk/funcs/atsUpdateAtsCandidate.js";
3337
+
3338
+ // Use `UnifiedToCore` for best tree-shaking performance.
3339
+ // You can create one instance of it to use across an application.
3340
+ const unifiedTo = new UnifiedToCore({
3341
+ security: {
3342
+ jwt: "<YOUR_API_KEY_HERE>",
3343
+ },
3344
+ });
3345
+
3346
+ async function run() {
3347
+ const res = await atsUpdateAtsCandidate(unifiedTo, {
3348
+ connectionId: "<value>",
3349
+ id: "<id>",
3350
+ });
3351
+
3352
+ if (!res.ok) {
3353
+ throw res.error;
3354
+ }
3355
+
3356
+ const { value: result } = res;
3357
+
3358
+ // Handle the result
3359
+ console.log(result);
3360
+ }
3361
+
3362
+ run();
3363
+ ```
3364
+
3365
+ ### Parameters
3366
+
3367
+ | Parameter | Type | Required | Description |
3368
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3369
+ | `request` | [operations.UpdateAtsCandidateRequest](../../sdk/models/operations/updateatscandidaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
3370
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3371
+ | `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. |
3372
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
3373
+
3374
+ ### Response
3375
+
3376
+ **Promise\<[shared.AtsCandidate](../../sdk/models/shared/atscandidate.md)\>**
3377
+
3378
+ ### Errors
3379
+
3380
+ | Error Type | Status Code | Content Type |
3381
+ | --------------- | --------------- | --------------- |
3382
+ | errors.SDKError | 4XX, 5XX | \*/\* |
3383
+
3384
+ ## updateAtsDocument
3385
+
3386
+ Update a document
3387
+
3388
+ ### Example Usage
3389
+
3390
+ ```typescript
3391
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
3392
+
3393
+ const unifiedTo = new UnifiedTo({
3394
+ security: {
3395
+ jwt: "<YOUR_API_KEY_HERE>",
3396
+ },
3397
+ });
3398
+
3399
+ async function run() {
3400
+ const result = await unifiedTo.ats.updateAtsDocument({
3401
+ connectionId: "<value>",
3402
+ id: "<id>",
3403
+ });
3404
+
3405
+ // Handle the result
3406
+ console.log(result);
3407
+ }
3408
+
3409
+ run();
3410
+ ```
3411
+
3412
+ ### Standalone function
3413
+
3414
+ The standalone function version of this method:
3415
+
3416
+ ```typescript
3417
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
3418
+ import { atsUpdateAtsDocument } from "@unified-api/typescript-sdk/funcs/atsUpdateAtsDocument.js";
3419
+
3420
+ // Use `UnifiedToCore` for best tree-shaking performance.
3421
+ // You can create one instance of it to use across an application.
3422
+ const unifiedTo = new UnifiedToCore({
3423
+ security: {
3424
+ jwt: "<YOUR_API_KEY_HERE>",
3425
+ },
3426
+ });
3427
+
3428
+ async function run() {
3429
+ const res = await atsUpdateAtsDocument(unifiedTo, {
3430
+ connectionId: "<value>",
3431
+ id: "<id>",
3432
+ });
3433
+
3434
+ if (!res.ok) {
3435
+ throw res.error;
3436
+ }
3437
+
3438
+ const { value: result } = res;
3439
+
3440
+ // Handle the result
3441
+ console.log(result);
3442
+ }
3443
+
3444
+ run();
3445
+ ```
3446
+
3447
+ ### Parameters
3448
+
3449
+ | Parameter | Type | Required | Description |
3450
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3451
+ | `request` | [operations.UpdateAtsDocumentRequest](../../sdk/models/operations/updateatsdocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
3452
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3453
+ | `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. |
3454
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
3455
+
3456
+ ### Response
3457
+
3458
+ **Promise\<[shared.AtsDocument](../../sdk/models/shared/atsdocument.md)\>**
3459
+
3460
+ ### Errors
3461
+
3462
+ | Error Type | Status Code | Content Type |
3463
+ | --------------- | --------------- | --------------- |
3464
+ | errors.SDKError | 4XX, 5XX | \*/\* |
3465
+
3466
+ ## updateAtsInterview
3467
+
3468
+ Update an interview
3469
+
3470
+ ### Example Usage
3471
+
3472
+ ```typescript
3473
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
3474
+
3475
+ const unifiedTo = new UnifiedTo({
3476
+ security: {
3477
+ jwt: "<YOUR_API_KEY_HERE>",
3478
+ },
3479
+ });
3480
+
3481
+ async function run() {
3482
+ const result = await unifiedTo.ats.updateAtsInterview({
3483
+ connectionId: "<value>",
3484
+ id: "<id>",
3485
+ });
3486
+
3487
+ // Handle the result
3488
+ console.log(result);
3489
+ }
3490
+
3491
+ run();
3492
+ ```
3493
+
3494
+ ### Standalone function
3495
+
3496
+ The standalone function version of this method:
3497
+
3498
+ ```typescript
3499
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
3500
+ import { atsUpdateAtsInterview } from "@unified-api/typescript-sdk/funcs/atsUpdateAtsInterview.js";
3501
+
3502
+ // Use `UnifiedToCore` for best tree-shaking performance.
3503
+ // You can create one instance of it to use across an application.
3504
+ const unifiedTo = new UnifiedToCore({
3505
+ security: {
3506
+ jwt: "<YOUR_API_KEY_HERE>",
3507
+ },
3508
+ });
3509
+
3510
+ async function run() {
3511
+ const res = await atsUpdateAtsInterview(unifiedTo, {
3512
+ connectionId: "<value>",
3513
+ id: "<id>",
3514
+ });
3515
+
3516
+ if (!res.ok) {
3517
+ throw res.error;
3518
+ }
3519
+
3520
+ const { value: result } = res;
3521
+
3522
+ // Handle the result
3523
+ console.log(result);
3524
+ }
3525
+
3526
+ run();
3527
+ ```
3528
+
3529
+ ### Parameters
3530
+
3531
+ | Parameter | Type | Required | Description |
3532
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3533
+ | `request` | [operations.UpdateAtsInterviewRequest](../../sdk/models/operations/updateatsinterviewrequest.md) | :heavy_check_mark: | The request object to use for the request. |
3534
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3535
+ | `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. |
3536
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
3537
+
3538
+ ### Response
3539
+
3540
+ **Promise\<[shared.AtsInterview](../../sdk/models/shared/atsinterview.md)\>**
3541
+
3542
+ ### Errors
3543
+
3544
+ | Error Type | Status Code | Content Type |
3545
+ | --------------- | --------------- | --------------- |
3546
+ | errors.SDKError | 4XX, 5XX | \*/\* |
3547
+
3548
+ ## updateAtsJob
3549
+
3550
+ Update a job
3551
+
3552
+ ### Example Usage
3553
+
3554
+ ```typescript
3555
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
3556
+
3557
+ const unifiedTo = new UnifiedTo({
3558
+ security: {
3559
+ jwt: "<YOUR_API_KEY_HERE>",
3560
+ },
3561
+ });
3562
+
3563
+ async function run() {
3564
+ const result = await unifiedTo.ats.updateAtsJob({
3565
+ connectionId: "<value>",
3566
+ id: "<id>",
3567
+ });
3568
+
3569
+ // Handle the result
3570
+ console.log(result);
3571
+ }
3572
+
3573
+ run();
3574
+ ```
3575
+
3576
+ ### Standalone function
3577
+
3578
+ The standalone function version of this method:
3579
+
3580
+ ```typescript
3581
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
3582
+ import { atsUpdateAtsJob } from "@unified-api/typescript-sdk/funcs/atsUpdateAtsJob.js";
3583
+
3584
+ // Use `UnifiedToCore` for best tree-shaking performance.
3585
+ // You can create one instance of it to use across an application.
3586
+ const unifiedTo = new UnifiedToCore({
3587
+ security: {
3588
+ jwt: "<YOUR_API_KEY_HERE>",
3589
+ },
3590
+ });
3591
+
3592
+ async function run() {
3593
+ const res = await atsUpdateAtsJob(unifiedTo, {
3594
+ connectionId: "<value>",
3595
+ id: "<id>",
3596
+ });
3597
+
3598
+ if (!res.ok) {
3599
+ throw res.error;
3600
+ }
3601
+
3602
+ const { value: result } = res;
3603
+
3604
+ // Handle the result
3605
+ console.log(result);
3606
+ }
3607
+
3608
+ run();
3609
+ ```
3610
+
3611
+ ### Parameters
3612
+
3613
+ | Parameter | Type | Required | Description |
3614
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3615
+ | `request` | [operations.UpdateAtsJobRequest](../../sdk/models/operations/updateatsjobrequest.md) | :heavy_check_mark: | The request object to use for the request. |
3616
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3617
+ | `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. |
3618
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
3619
+
3620
+ ### Response
3621
+
3622
+ **Promise\<[shared.AtsJob](../../sdk/models/shared/atsjob.md)\>**
3623
+
3624
+ ### Errors
3625
+
3626
+ | Error Type | Status Code | Content Type |
3627
+ | --------------- | --------------- | --------------- |
3628
+ | errors.SDKError | 4XX, 5XX | \*/\* |
3629
+
3630
+ ## updateAtsScorecard
3631
+
3632
+ Update a scorecard
3633
+
3634
+ ### Example Usage
3635
+
3636
+ ```typescript
3637
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
3638
+
3639
+ const unifiedTo = new UnifiedTo({
3640
+ security: {
3641
+ jwt: "<YOUR_API_KEY_HERE>",
3642
+ },
3643
+ });
3644
+
3645
+ async function run() {
3646
+ const result = await unifiedTo.ats.updateAtsScorecard({
3647
+ connectionId: "<value>",
3648
+ id: "<id>",
3649
+ });
3650
+
3651
+ // Handle the result
3652
+ console.log(result);
3653
+ }
3654
+
3655
+ run();
3656
+ ```
3657
+
3658
+ ### Standalone function
3659
+
3660
+ The standalone function version of this method:
3661
+
3662
+ ```typescript
3663
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
3664
+ import { atsUpdateAtsScorecard } from "@unified-api/typescript-sdk/funcs/atsUpdateAtsScorecard.js";
3665
+
3666
+ // Use `UnifiedToCore` for best tree-shaking performance.
3667
+ // You can create one instance of it to use across an application.
3668
+ const unifiedTo = new UnifiedToCore({
3669
+ security: {
3670
+ jwt: "<YOUR_API_KEY_HERE>",
3671
+ },
3672
+ });
3673
+
3674
+ async function run() {
3675
+ const res = await atsUpdateAtsScorecard(unifiedTo, {
3676
+ connectionId: "<value>",
3677
+ id: "<id>",
3678
+ });
3679
+
3680
+ if (!res.ok) {
3681
+ throw res.error;
3682
+ }
3683
+
3684
+ const { value: result } = res;
3685
+
3686
+ // Handle the result
3687
+ console.log(result);
3688
+ }
3689
+
3690
+ run();
3691
+ ```
3692
+
3693
+ ### Parameters
3694
+
3695
+ | Parameter | Type | Required | Description |
3696
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3697
+ | `request` | [operations.UpdateAtsScorecardRequest](../../sdk/models/operations/updateatsscorecardrequest.md) | :heavy_check_mark: | The request object to use for the request. |
3698
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3699
+ | `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. |
3700
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
3701
+
3702
+ ### Response
3703
+
3704
+ **Promise\<[shared.AtsScorecard](../../sdk/models/shared/atsscorecard.md)\>**
3705
+
3706
+ ### Errors
3707
+
3708
+ | Error Type | Status Code | Content Type |
3709
+ | --------------- | --------------- | --------------- |
3710
+ | errors.SDKError | 4XX, 5XX | \*/\* |