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