@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
|
@@ -1,489 +0,0 @@
|
|
|
1
|
-
# Application
|
|
2
|
-
(*application*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [createAtsApplication](#createatsapplication) - Create an application
|
|
9
|
-
* [getAtsApplication](#getatsapplication) - Retrieve an application
|
|
10
|
-
* [listAtsApplications](#listatsapplications) - List all applications
|
|
11
|
-
* [patchAtsApplication](#patchatsapplication) - Update an application
|
|
12
|
-
* [removeAtsApplication](#removeatsapplication) - Remove an application
|
|
13
|
-
* [updateAtsApplication](#updateatsapplication) - Update an application
|
|
14
|
-
|
|
15
|
-
## createAtsApplication
|
|
16
|
-
|
|
17
|
-
Create an application
|
|
18
|
-
|
|
19
|
-
### Example Usage
|
|
20
|
-
|
|
21
|
-
<!-- UsageSnippet language="typescript" operationID="createAtsApplication" method="post" path="/ats/{connection_id}/application" -->
|
|
22
|
-
```typescript
|
|
23
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
24
|
-
|
|
25
|
-
const unifiedTo = new UnifiedTo({
|
|
26
|
-
security: {
|
|
27
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
28
|
-
},
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
async function run() {
|
|
32
|
-
const result = await unifiedTo.application.createAtsApplication({
|
|
33
|
-
atsApplication: {},
|
|
34
|
-
connectionId: "<id>",
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
console.log(result);
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
run();
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Standalone function
|
|
44
|
-
|
|
45
|
-
The standalone function version of this method:
|
|
46
|
-
|
|
47
|
-
```typescript
|
|
48
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
49
|
-
import { atsCreateAtsApplication } from "@unified-api/typescript-sdk/funcs/atsCreateAtsApplication.js";
|
|
50
|
-
|
|
51
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
52
|
-
// You can create one instance of it to use across an application.
|
|
53
|
-
const unifiedTo = new UnifiedToCore({
|
|
54
|
-
security: {
|
|
55
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
56
|
-
},
|
|
57
|
-
});
|
|
58
|
-
|
|
59
|
-
async function run() {
|
|
60
|
-
const res = await atsCreateAtsApplication(unifiedTo, {
|
|
61
|
-
atsApplication: {},
|
|
62
|
-
connectionId: "<id>",
|
|
63
|
-
});
|
|
64
|
-
if (res.ok) {
|
|
65
|
-
const { value: result } = res;
|
|
66
|
-
console.log(result);
|
|
67
|
-
} else {
|
|
68
|
-
console.log("atsCreateAtsApplication failed:", res.error);
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
run();
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
### Parameters
|
|
76
|
-
|
|
77
|
-
| Parameter | Type | Required | Description |
|
|
78
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
79
|
-
| `request` | [operations.CreateAtsApplicationRequest](../../sdk/models/operations/createatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
80
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
81
|
-
| `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. |
|
|
82
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
83
|
-
|
|
84
|
-
### Response
|
|
85
|
-
|
|
86
|
-
**Promise\<[shared.AtsApplication](../../sdk/models/shared/atsapplication.md)\>**
|
|
87
|
-
|
|
88
|
-
### Errors
|
|
89
|
-
|
|
90
|
-
| Error Type | Status Code | Content Type |
|
|
91
|
-
| --------------- | --------------- | --------------- |
|
|
92
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
93
|
-
|
|
94
|
-
## getAtsApplication
|
|
95
|
-
|
|
96
|
-
Retrieve an application
|
|
97
|
-
|
|
98
|
-
### Example Usage
|
|
99
|
-
|
|
100
|
-
<!-- UsageSnippet language="typescript" operationID="getAtsApplication" method="get" path="/ats/{connection_id}/application/{id}" -->
|
|
101
|
-
```typescript
|
|
102
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
103
|
-
|
|
104
|
-
const unifiedTo = new UnifiedTo({
|
|
105
|
-
security: {
|
|
106
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
107
|
-
},
|
|
108
|
-
});
|
|
109
|
-
|
|
110
|
-
async function run() {
|
|
111
|
-
const result = await unifiedTo.application.getAtsApplication({
|
|
112
|
-
connectionId: "<id>",
|
|
113
|
-
id: "<id>",
|
|
114
|
-
});
|
|
115
|
-
|
|
116
|
-
console.log(result);
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
run();
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
### Standalone function
|
|
123
|
-
|
|
124
|
-
The standalone function version of this method:
|
|
125
|
-
|
|
126
|
-
```typescript
|
|
127
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
128
|
-
import { atsGetAtsApplication } from "@unified-api/typescript-sdk/funcs/atsGetAtsApplication.js";
|
|
129
|
-
|
|
130
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
131
|
-
// You can create one instance of it to use across an application.
|
|
132
|
-
const unifiedTo = new UnifiedToCore({
|
|
133
|
-
security: {
|
|
134
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
135
|
-
},
|
|
136
|
-
});
|
|
137
|
-
|
|
138
|
-
async function run() {
|
|
139
|
-
const res = await atsGetAtsApplication(unifiedTo, {
|
|
140
|
-
connectionId: "<id>",
|
|
141
|
-
id: "<id>",
|
|
142
|
-
});
|
|
143
|
-
if (res.ok) {
|
|
144
|
-
const { value: result } = res;
|
|
145
|
-
console.log(result);
|
|
146
|
-
} else {
|
|
147
|
-
console.log("atsGetAtsApplication failed:", res.error);
|
|
148
|
-
}
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
run();
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
### Parameters
|
|
155
|
-
|
|
156
|
-
| Parameter | Type | Required | Description |
|
|
157
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
158
|
-
| `request` | [operations.GetAtsApplicationRequest](../../sdk/models/operations/getatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
159
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
160
|
-
| `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. |
|
|
161
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
162
|
-
|
|
163
|
-
### Response
|
|
164
|
-
|
|
165
|
-
**Promise\<[shared.AtsApplication](../../sdk/models/shared/atsapplication.md)\>**
|
|
166
|
-
|
|
167
|
-
### Errors
|
|
168
|
-
|
|
169
|
-
| Error Type | Status Code | Content Type |
|
|
170
|
-
| --------------- | --------------- | --------------- |
|
|
171
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
172
|
-
|
|
173
|
-
## listAtsApplications
|
|
174
|
-
|
|
175
|
-
List all applications
|
|
176
|
-
|
|
177
|
-
### Example Usage
|
|
178
|
-
|
|
179
|
-
<!-- UsageSnippet language="typescript" operationID="listAtsApplications" method="get" path="/ats/{connection_id}/application" -->
|
|
180
|
-
```typescript
|
|
181
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
182
|
-
|
|
183
|
-
const unifiedTo = new UnifiedTo({
|
|
184
|
-
security: {
|
|
185
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
186
|
-
},
|
|
187
|
-
});
|
|
188
|
-
|
|
189
|
-
async function run() {
|
|
190
|
-
const result = await unifiedTo.application.listAtsApplications({
|
|
191
|
-
connectionId: "<id>",
|
|
192
|
-
});
|
|
193
|
-
|
|
194
|
-
console.log(result);
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
run();
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
### Standalone function
|
|
201
|
-
|
|
202
|
-
The standalone function version of this method:
|
|
203
|
-
|
|
204
|
-
```typescript
|
|
205
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
206
|
-
import { atsListAtsApplications } from "@unified-api/typescript-sdk/funcs/atsListAtsApplications.js";
|
|
207
|
-
|
|
208
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
209
|
-
// You can create one instance of it to use across an application.
|
|
210
|
-
const unifiedTo = new UnifiedToCore({
|
|
211
|
-
security: {
|
|
212
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
213
|
-
},
|
|
214
|
-
});
|
|
215
|
-
|
|
216
|
-
async function run() {
|
|
217
|
-
const res = await atsListAtsApplications(unifiedTo, {
|
|
218
|
-
connectionId: "<id>",
|
|
219
|
-
});
|
|
220
|
-
if (res.ok) {
|
|
221
|
-
const { value: result } = res;
|
|
222
|
-
console.log(result);
|
|
223
|
-
} else {
|
|
224
|
-
console.log("atsListAtsApplications failed:", res.error);
|
|
225
|
-
}
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
run();
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
### Parameters
|
|
232
|
-
|
|
233
|
-
| Parameter | Type | Required | Description |
|
|
234
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
235
|
-
| `request` | [operations.ListAtsApplicationsRequest](../../sdk/models/operations/listatsapplicationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
236
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
237
|
-
| `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. |
|
|
238
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
239
|
-
|
|
240
|
-
### Response
|
|
241
|
-
|
|
242
|
-
**Promise\<[shared.AtsApplication[]](../../models/.md)\>**
|
|
243
|
-
|
|
244
|
-
### Errors
|
|
245
|
-
|
|
246
|
-
| Error Type | Status Code | Content Type |
|
|
247
|
-
| --------------- | --------------- | --------------- |
|
|
248
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
249
|
-
|
|
250
|
-
## patchAtsApplication
|
|
251
|
-
|
|
252
|
-
Update an application
|
|
253
|
-
|
|
254
|
-
### Example Usage
|
|
255
|
-
|
|
256
|
-
<!-- UsageSnippet language="typescript" operationID="patchAtsApplication" method="patch" path="/ats/{connection_id}/application/{id}" -->
|
|
257
|
-
```typescript
|
|
258
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
259
|
-
|
|
260
|
-
const unifiedTo = new UnifiedTo({
|
|
261
|
-
security: {
|
|
262
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
263
|
-
},
|
|
264
|
-
});
|
|
265
|
-
|
|
266
|
-
async function run() {
|
|
267
|
-
const result = await unifiedTo.application.patchAtsApplication({
|
|
268
|
-
atsApplication: {},
|
|
269
|
-
connectionId: "<id>",
|
|
270
|
-
id: "<id>",
|
|
271
|
-
});
|
|
272
|
-
|
|
273
|
-
console.log(result);
|
|
274
|
-
}
|
|
275
|
-
|
|
276
|
-
run();
|
|
277
|
-
```
|
|
278
|
-
|
|
279
|
-
### Standalone function
|
|
280
|
-
|
|
281
|
-
The standalone function version of this method:
|
|
282
|
-
|
|
283
|
-
```typescript
|
|
284
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
285
|
-
import { atsPatchAtsApplication } from "@unified-api/typescript-sdk/funcs/atsPatchAtsApplication.js";
|
|
286
|
-
|
|
287
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
288
|
-
// You can create one instance of it to use across an application.
|
|
289
|
-
const unifiedTo = new UnifiedToCore({
|
|
290
|
-
security: {
|
|
291
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
292
|
-
},
|
|
293
|
-
});
|
|
294
|
-
|
|
295
|
-
async function run() {
|
|
296
|
-
const res = await atsPatchAtsApplication(unifiedTo, {
|
|
297
|
-
atsApplication: {},
|
|
298
|
-
connectionId: "<id>",
|
|
299
|
-
id: "<id>",
|
|
300
|
-
});
|
|
301
|
-
if (res.ok) {
|
|
302
|
-
const { value: result } = res;
|
|
303
|
-
console.log(result);
|
|
304
|
-
} else {
|
|
305
|
-
console.log("atsPatchAtsApplication failed:", res.error);
|
|
306
|
-
}
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
run();
|
|
310
|
-
```
|
|
311
|
-
|
|
312
|
-
### Parameters
|
|
313
|
-
|
|
314
|
-
| Parameter | Type | Required | Description |
|
|
315
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
316
|
-
| `request` | [operations.PatchAtsApplicationRequest](../../sdk/models/operations/patchatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
317
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
318
|
-
| `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. |
|
|
319
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
320
|
-
|
|
321
|
-
### Response
|
|
322
|
-
|
|
323
|
-
**Promise\<[shared.AtsApplication](../../sdk/models/shared/atsapplication.md)\>**
|
|
324
|
-
|
|
325
|
-
### Errors
|
|
326
|
-
|
|
327
|
-
| Error Type | Status Code | Content Type |
|
|
328
|
-
| --------------- | --------------- | --------------- |
|
|
329
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
330
|
-
|
|
331
|
-
## removeAtsApplication
|
|
332
|
-
|
|
333
|
-
Remove an application
|
|
334
|
-
|
|
335
|
-
### Example Usage
|
|
336
|
-
|
|
337
|
-
<!-- UsageSnippet language="typescript" operationID="removeAtsApplication" method="delete" path="/ats/{connection_id}/application/{id}" -->
|
|
338
|
-
```typescript
|
|
339
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
340
|
-
|
|
341
|
-
const unifiedTo = new UnifiedTo({
|
|
342
|
-
security: {
|
|
343
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
344
|
-
},
|
|
345
|
-
});
|
|
346
|
-
|
|
347
|
-
async function run() {
|
|
348
|
-
const result = await unifiedTo.application.removeAtsApplication({
|
|
349
|
-
connectionId: "<id>",
|
|
350
|
-
id: "<id>",
|
|
351
|
-
});
|
|
352
|
-
|
|
353
|
-
console.log(result);
|
|
354
|
-
}
|
|
355
|
-
|
|
356
|
-
run();
|
|
357
|
-
```
|
|
358
|
-
|
|
359
|
-
### Standalone function
|
|
360
|
-
|
|
361
|
-
The standalone function version of this method:
|
|
362
|
-
|
|
363
|
-
```typescript
|
|
364
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
365
|
-
import { atsRemoveAtsApplication } from "@unified-api/typescript-sdk/funcs/atsRemoveAtsApplication.js";
|
|
366
|
-
|
|
367
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
368
|
-
// You can create one instance of it to use across an application.
|
|
369
|
-
const unifiedTo = new UnifiedToCore({
|
|
370
|
-
security: {
|
|
371
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
372
|
-
},
|
|
373
|
-
});
|
|
374
|
-
|
|
375
|
-
async function run() {
|
|
376
|
-
const res = await atsRemoveAtsApplication(unifiedTo, {
|
|
377
|
-
connectionId: "<id>",
|
|
378
|
-
id: "<id>",
|
|
379
|
-
});
|
|
380
|
-
if (res.ok) {
|
|
381
|
-
const { value: result } = res;
|
|
382
|
-
console.log(result);
|
|
383
|
-
} else {
|
|
384
|
-
console.log("atsRemoveAtsApplication failed:", res.error);
|
|
385
|
-
}
|
|
386
|
-
}
|
|
387
|
-
|
|
388
|
-
run();
|
|
389
|
-
```
|
|
390
|
-
|
|
391
|
-
### Parameters
|
|
392
|
-
|
|
393
|
-
| Parameter | Type | Required | Description |
|
|
394
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
395
|
-
| `request` | [operations.RemoveAtsApplicationRequest](../../sdk/models/operations/removeatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
396
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
397
|
-
| `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. |
|
|
398
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
399
|
-
|
|
400
|
-
### Response
|
|
401
|
-
|
|
402
|
-
**Promise\<[operations.RemoveAtsApplicationResponse](../../sdk/models/operations/removeatsapplicationresponse.md)\>**
|
|
403
|
-
|
|
404
|
-
### Errors
|
|
405
|
-
|
|
406
|
-
| Error Type | Status Code | Content Type |
|
|
407
|
-
| --------------- | --------------- | --------------- |
|
|
408
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
409
|
-
|
|
410
|
-
## updateAtsApplication
|
|
411
|
-
|
|
412
|
-
Update an application
|
|
413
|
-
|
|
414
|
-
### Example Usage
|
|
415
|
-
|
|
416
|
-
<!-- UsageSnippet language="typescript" operationID="updateAtsApplication" method="put" path="/ats/{connection_id}/application/{id}" -->
|
|
417
|
-
```typescript
|
|
418
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
419
|
-
|
|
420
|
-
const unifiedTo = new UnifiedTo({
|
|
421
|
-
security: {
|
|
422
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
423
|
-
},
|
|
424
|
-
});
|
|
425
|
-
|
|
426
|
-
async function run() {
|
|
427
|
-
const result = await unifiedTo.application.updateAtsApplication({
|
|
428
|
-
atsApplication: {},
|
|
429
|
-
connectionId: "<id>",
|
|
430
|
-
id: "<id>",
|
|
431
|
-
});
|
|
432
|
-
|
|
433
|
-
console.log(result);
|
|
434
|
-
}
|
|
435
|
-
|
|
436
|
-
run();
|
|
437
|
-
```
|
|
438
|
-
|
|
439
|
-
### Standalone function
|
|
440
|
-
|
|
441
|
-
The standalone function version of this method:
|
|
442
|
-
|
|
443
|
-
```typescript
|
|
444
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
445
|
-
import { atsUpdateAtsApplication } from "@unified-api/typescript-sdk/funcs/atsUpdateAtsApplication.js";
|
|
446
|
-
|
|
447
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
448
|
-
// You can create one instance of it to use across an application.
|
|
449
|
-
const unifiedTo = new UnifiedToCore({
|
|
450
|
-
security: {
|
|
451
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
452
|
-
},
|
|
453
|
-
});
|
|
454
|
-
|
|
455
|
-
async function run() {
|
|
456
|
-
const res = await atsUpdateAtsApplication(unifiedTo, {
|
|
457
|
-
atsApplication: {},
|
|
458
|
-
connectionId: "<id>",
|
|
459
|
-
id: "<id>",
|
|
460
|
-
});
|
|
461
|
-
if (res.ok) {
|
|
462
|
-
const { value: result } = res;
|
|
463
|
-
console.log(result);
|
|
464
|
-
} else {
|
|
465
|
-
console.log("atsUpdateAtsApplication failed:", res.error);
|
|
466
|
-
}
|
|
467
|
-
}
|
|
468
|
-
|
|
469
|
-
run();
|
|
470
|
-
```
|
|
471
|
-
|
|
472
|
-
### Parameters
|
|
473
|
-
|
|
474
|
-
| Parameter | Type | Required | Description |
|
|
475
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
476
|
-
| `request` | [operations.UpdateAtsApplicationRequest](../../sdk/models/operations/updateatsapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
477
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
478
|
-
| `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. |
|
|
479
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
480
|
-
|
|
481
|
-
### Response
|
|
482
|
-
|
|
483
|
-
**Promise\<[shared.AtsApplication](../../sdk/models/shared/atsapplication.md)\>**
|
|
484
|
-
|
|
485
|
-
### Errors
|
|
486
|
-
|
|
487
|
-
| Error Type | Status Code | Content Type |
|
|
488
|
-
| --------------- | --------------- | --------------- |
|
|
489
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
# Applicationstatus
|
|
2
|
-
(*applicationstatus*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [listAtsApplicationstatuses](#listatsapplicationstatuses) - List all applicationstatuses
|
|
9
|
-
|
|
10
|
-
## listAtsApplicationstatuses
|
|
11
|
-
|
|
12
|
-
List all applicationstatuses
|
|
13
|
-
|
|
14
|
-
### Example Usage
|
|
15
|
-
|
|
16
|
-
<!-- UsageSnippet language="typescript" operationID="listAtsApplicationstatuses" method="get" path="/ats/{connection_id}/applicationstatus" -->
|
|
17
|
-
```typescript
|
|
18
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
19
|
-
|
|
20
|
-
const unifiedTo = new UnifiedTo({
|
|
21
|
-
security: {
|
|
22
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
23
|
-
},
|
|
24
|
-
});
|
|
25
|
-
|
|
26
|
-
async function run() {
|
|
27
|
-
const result = await unifiedTo.applicationstatus.listAtsApplicationstatuses({
|
|
28
|
-
connectionId: "<id>",
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
console.log(result);
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
run();
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
### Standalone function
|
|
38
|
-
|
|
39
|
-
The standalone function version of this method:
|
|
40
|
-
|
|
41
|
-
```typescript
|
|
42
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
43
|
-
import { atsListAtsApplicationstatuses } from "@unified-api/typescript-sdk/funcs/atsListAtsApplicationstatuses.js";
|
|
44
|
-
|
|
45
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
46
|
-
// You can create one instance of it to use across an application.
|
|
47
|
-
const unifiedTo = new UnifiedToCore({
|
|
48
|
-
security: {
|
|
49
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
50
|
-
},
|
|
51
|
-
});
|
|
52
|
-
|
|
53
|
-
async function run() {
|
|
54
|
-
const res = await atsListAtsApplicationstatuses(unifiedTo, {
|
|
55
|
-
connectionId: "<id>",
|
|
56
|
-
});
|
|
57
|
-
if (res.ok) {
|
|
58
|
-
const { value: result } = res;
|
|
59
|
-
console.log(result);
|
|
60
|
-
} else {
|
|
61
|
-
console.log("atsListAtsApplicationstatuses failed:", res.error);
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
run();
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
### Parameters
|
|
69
|
-
|
|
70
|
-
| Parameter | Type | Required | Description |
|
|
71
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
72
|
-
| `request` | [operations.ListAtsApplicationstatusesRequest](../../sdk/models/operations/listatsapplicationstatusesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
73
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
74
|
-
| `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. |
|
|
75
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
76
|
-
|
|
77
|
-
### Response
|
|
78
|
-
|
|
79
|
-
**Promise\<[shared.AtsStatus[]](../../models/.md)\>**
|
|
80
|
-
|
|
81
|
-
### Errors
|
|
82
|
-
|
|
83
|
-
| Error Type | Status Code | Content Type |
|
|
84
|
-
| --------------- | --------------- | --------------- |
|
|
85
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|