@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,983 +0,0 @@
|
|
|
1
|
-
# Location
|
|
2
|
-
(*location*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [createCommerceLocation](#createcommercelocation) - Create a location
|
|
9
|
-
* [createHrisLocation](#createhrislocation) - Create a location
|
|
10
|
-
* [getCommerceLocation](#getcommercelocation) - Retrieve a location
|
|
11
|
-
* [getHrisLocation](#gethrislocation) - Retrieve a location
|
|
12
|
-
* [listCommerceLocations](#listcommercelocations) - List all locations
|
|
13
|
-
* [listHrisLocations](#listhrislocations) - List all locations
|
|
14
|
-
* [patchCommerceLocation](#patchcommercelocation) - Update a location
|
|
15
|
-
* [patchHrisLocation](#patchhrislocation) - Update a location
|
|
16
|
-
* [removeCommerceLocation](#removecommercelocation) - Remove a location
|
|
17
|
-
* [removeHrisLocation](#removehrislocation) - Remove a location
|
|
18
|
-
* [updateCommerceLocation](#updatecommercelocation) - Update a location
|
|
19
|
-
* [updateHrisLocation](#updatehrislocation) - Update a location
|
|
20
|
-
|
|
21
|
-
## createCommerceLocation
|
|
22
|
-
|
|
23
|
-
Create a location
|
|
24
|
-
|
|
25
|
-
### Example Usage
|
|
26
|
-
|
|
27
|
-
<!-- UsageSnippet language="typescript" operationID="createCommerceLocation" method="post" path="/commerce/{connection_id}/location" -->
|
|
28
|
-
```typescript
|
|
29
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
30
|
-
|
|
31
|
-
const unifiedTo = new UnifiedTo({
|
|
32
|
-
security: {
|
|
33
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
34
|
-
},
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
async function run() {
|
|
38
|
-
const result = await unifiedTo.location.createCommerceLocation({
|
|
39
|
-
commerceLocation: {
|
|
40
|
-
name: "<value>",
|
|
41
|
-
},
|
|
42
|
-
connectionId: "<id>",
|
|
43
|
-
});
|
|
44
|
-
|
|
45
|
-
console.log(result);
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
run();
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
### Standalone function
|
|
52
|
-
|
|
53
|
-
The standalone function version of this method:
|
|
54
|
-
|
|
55
|
-
```typescript
|
|
56
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
57
|
-
import { commerceCreateCommerceLocation } from "@unified-api/typescript-sdk/funcs/commerceCreateCommerceLocation.js";
|
|
58
|
-
|
|
59
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
60
|
-
// You can create one instance of it to use across an application.
|
|
61
|
-
const unifiedTo = new UnifiedToCore({
|
|
62
|
-
security: {
|
|
63
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
64
|
-
},
|
|
65
|
-
});
|
|
66
|
-
|
|
67
|
-
async function run() {
|
|
68
|
-
const res = await commerceCreateCommerceLocation(unifiedTo, {
|
|
69
|
-
commerceLocation: {
|
|
70
|
-
name: "<value>",
|
|
71
|
-
},
|
|
72
|
-
connectionId: "<id>",
|
|
73
|
-
});
|
|
74
|
-
if (res.ok) {
|
|
75
|
-
const { value: result } = res;
|
|
76
|
-
console.log(result);
|
|
77
|
-
} else {
|
|
78
|
-
console.log("commerceCreateCommerceLocation failed:", res.error);
|
|
79
|
-
}
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
run();
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
### Parameters
|
|
86
|
-
|
|
87
|
-
| Parameter | Type | Required | Description |
|
|
88
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
89
|
-
| `request` | [operations.CreateCommerceLocationRequest](../../sdk/models/operations/createcommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
90
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
91
|
-
| `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. |
|
|
92
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
93
|
-
|
|
94
|
-
### Response
|
|
95
|
-
|
|
96
|
-
**Promise\<[shared.CommerceLocation](../../sdk/models/shared/commercelocation.md)\>**
|
|
97
|
-
|
|
98
|
-
### Errors
|
|
99
|
-
|
|
100
|
-
| Error Type | Status Code | Content Type |
|
|
101
|
-
| --------------- | --------------- | --------------- |
|
|
102
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
103
|
-
|
|
104
|
-
## createHrisLocation
|
|
105
|
-
|
|
106
|
-
Create a location
|
|
107
|
-
|
|
108
|
-
### Example Usage
|
|
109
|
-
|
|
110
|
-
<!-- UsageSnippet language="typescript" operationID="createHrisLocation" method="post" path="/hris/{connection_id}/location" -->
|
|
111
|
-
```typescript
|
|
112
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
113
|
-
|
|
114
|
-
const unifiedTo = new UnifiedTo({
|
|
115
|
-
security: {
|
|
116
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
117
|
-
},
|
|
118
|
-
});
|
|
119
|
-
|
|
120
|
-
async function run() {
|
|
121
|
-
const result = await unifiedTo.location.createHrisLocation({
|
|
122
|
-
hrisLocation: {},
|
|
123
|
-
connectionId: "<id>",
|
|
124
|
-
});
|
|
125
|
-
|
|
126
|
-
console.log(result);
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
run();
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
### Standalone function
|
|
133
|
-
|
|
134
|
-
The standalone function version of this method:
|
|
135
|
-
|
|
136
|
-
```typescript
|
|
137
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
138
|
-
import { locationCreateHrisLocation } from "@unified-api/typescript-sdk/funcs/locationCreateHrisLocation.js";
|
|
139
|
-
|
|
140
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
141
|
-
// You can create one instance of it to use across an application.
|
|
142
|
-
const unifiedTo = new UnifiedToCore({
|
|
143
|
-
security: {
|
|
144
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
145
|
-
},
|
|
146
|
-
});
|
|
147
|
-
|
|
148
|
-
async function run() {
|
|
149
|
-
const res = await locationCreateHrisLocation(unifiedTo, {
|
|
150
|
-
hrisLocation: {},
|
|
151
|
-
connectionId: "<id>",
|
|
152
|
-
});
|
|
153
|
-
if (res.ok) {
|
|
154
|
-
const { value: result } = res;
|
|
155
|
-
console.log(result);
|
|
156
|
-
} else {
|
|
157
|
-
console.log("locationCreateHrisLocation failed:", res.error);
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
run();
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
### Parameters
|
|
165
|
-
|
|
166
|
-
| Parameter | Type | Required | Description |
|
|
167
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
168
|
-
| `request` | [operations.CreateHrisLocationRequest](../../sdk/models/operations/createhrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
169
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
170
|
-
| `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. |
|
|
171
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
172
|
-
|
|
173
|
-
### Response
|
|
174
|
-
|
|
175
|
-
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
176
|
-
|
|
177
|
-
### Errors
|
|
178
|
-
|
|
179
|
-
| Error Type | Status Code | Content Type |
|
|
180
|
-
| --------------- | --------------- | --------------- |
|
|
181
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
182
|
-
|
|
183
|
-
## getCommerceLocation
|
|
184
|
-
|
|
185
|
-
Retrieve a location
|
|
186
|
-
|
|
187
|
-
### Example Usage
|
|
188
|
-
|
|
189
|
-
<!-- UsageSnippet language="typescript" operationID="getCommerceLocation" method="get" path="/commerce/{connection_id}/location/{id}" -->
|
|
190
|
-
```typescript
|
|
191
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
192
|
-
|
|
193
|
-
const unifiedTo = new UnifiedTo({
|
|
194
|
-
security: {
|
|
195
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
196
|
-
},
|
|
197
|
-
});
|
|
198
|
-
|
|
199
|
-
async function run() {
|
|
200
|
-
const result = await unifiedTo.location.getCommerceLocation({
|
|
201
|
-
connectionId: "<id>",
|
|
202
|
-
id: "<id>",
|
|
203
|
-
});
|
|
204
|
-
|
|
205
|
-
console.log(result);
|
|
206
|
-
}
|
|
207
|
-
|
|
208
|
-
run();
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
### Standalone function
|
|
212
|
-
|
|
213
|
-
The standalone function version of this method:
|
|
214
|
-
|
|
215
|
-
```typescript
|
|
216
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
217
|
-
import { commerceGetCommerceLocation } from "@unified-api/typescript-sdk/funcs/commerceGetCommerceLocation.js";
|
|
218
|
-
|
|
219
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
220
|
-
// You can create one instance of it to use across an application.
|
|
221
|
-
const unifiedTo = new UnifiedToCore({
|
|
222
|
-
security: {
|
|
223
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
224
|
-
},
|
|
225
|
-
});
|
|
226
|
-
|
|
227
|
-
async function run() {
|
|
228
|
-
const res = await commerceGetCommerceLocation(unifiedTo, {
|
|
229
|
-
connectionId: "<id>",
|
|
230
|
-
id: "<id>",
|
|
231
|
-
});
|
|
232
|
-
if (res.ok) {
|
|
233
|
-
const { value: result } = res;
|
|
234
|
-
console.log(result);
|
|
235
|
-
} else {
|
|
236
|
-
console.log("commerceGetCommerceLocation failed:", res.error);
|
|
237
|
-
}
|
|
238
|
-
}
|
|
239
|
-
|
|
240
|
-
run();
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
### Parameters
|
|
244
|
-
|
|
245
|
-
| Parameter | Type | Required | Description |
|
|
246
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
247
|
-
| `request` | [operations.GetCommerceLocationRequest](../../sdk/models/operations/getcommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
248
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
249
|
-
| `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. |
|
|
250
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
251
|
-
|
|
252
|
-
### Response
|
|
253
|
-
|
|
254
|
-
**Promise\<[shared.CommerceLocation](../../sdk/models/shared/commercelocation.md)\>**
|
|
255
|
-
|
|
256
|
-
### Errors
|
|
257
|
-
|
|
258
|
-
| Error Type | Status Code | Content Type |
|
|
259
|
-
| --------------- | --------------- | --------------- |
|
|
260
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
261
|
-
|
|
262
|
-
## getHrisLocation
|
|
263
|
-
|
|
264
|
-
Retrieve a location
|
|
265
|
-
|
|
266
|
-
### Example Usage
|
|
267
|
-
|
|
268
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisLocation" method="get" path="/hris/{connection_id}/location/{id}" -->
|
|
269
|
-
```typescript
|
|
270
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
271
|
-
|
|
272
|
-
const unifiedTo = new UnifiedTo({
|
|
273
|
-
security: {
|
|
274
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
275
|
-
},
|
|
276
|
-
});
|
|
277
|
-
|
|
278
|
-
async function run() {
|
|
279
|
-
const result = await unifiedTo.location.getHrisLocation({
|
|
280
|
-
connectionId: "<id>",
|
|
281
|
-
id: "<id>",
|
|
282
|
-
});
|
|
283
|
-
|
|
284
|
-
console.log(result);
|
|
285
|
-
}
|
|
286
|
-
|
|
287
|
-
run();
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
### Standalone function
|
|
291
|
-
|
|
292
|
-
The standalone function version of this method:
|
|
293
|
-
|
|
294
|
-
```typescript
|
|
295
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
296
|
-
import { locationGetHrisLocation } from "@unified-api/typescript-sdk/funcs/locationGetHrisLocation.js";
|
|
297
|
-
|
|
298
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
299
|
-
// You can create one instance of it to use across an application.
|
|
300
|
-
const unifiedTo = new UnifiedToCore({
|
|
301
|
-
security: {
|
|
302
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
303
|
-
},
|
|
304
|
-
});
|
|
305
|
-
|
|
306
|
-
async function run() {
|
|
307
|
-
const res = await locationGetHrisLocation(unifiedTo, {
|
|
308
|
-
connectionId: "<id>",
|
|
309
|
-
id: "<id>",
|
|
310
|
-
});
|
|
311
|
-
if (res.ok) {
|
|
312
|
-
const { value: result } = res;
|
|
313
|
-
console.log(result);
|
|
314
|
-
} else {
|
|
315
|
-
console.log("locationGetHrisLocation failed:", res.error);
|
|
316
|
-
}
|
|
317
|
-
}
|
|
318
|
-
|
|
319
|
-
run();
|
|
320
|
-
```
|
|
321
|
-
|
|
322
|
-
### Parameters
|
|
323
|
-
|
|
324
|
-
| Parameter | Type | Required | Description |
|
|
325
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
326
|
-
| `request` | [operations.GetHrisLocationRequest](../../sdk/models/operations/gethrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
327
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
328
|
-
| `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. |
|
|
329
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
330
|
-
|
|
331
|
-
### Response
|
|
332
|
-
|
|
333
|
-
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
334
|
-
|
|
335
|
-
### Errors
|
|
336
|
-
|
|
337
|
-
| Error Type | Status Code | Content Type |
|
|
338
|
-
| --------------- | --------------- | --------------- |
|
|
339
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
340
|
-
|
|
341
|
-
## listCommerceLocations
|
|
342
|
-
|
|
343
|
-
List all locations
|
|
344
|
-
|
|
345
|
-
### Example Usage
|
|
346
|
-
|
|
347
|
-
<!-- UsageSnippet language="typescript" operationID="listCommerceLocations" method="get" path="/commerce/{connection_id}/location" -->
|
|
348
|
-
```typescript
|
|
349
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
350
|
-
|
|
351
|
-
const unifiedTo = new UnifiedTo({
|
|
352
|
-
security: {
|
|
353
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
354
|
-
},
|
|
355
|
-
});
|
|
356
|
-
|
|
357
|
-
async function run() {
|
|
358
|
-
const result = await unifiedTo.location.listCommerceLocations({
|
|
359
|
-
connectionId: "<id>",
|
|
360
|
-
});
|
|
361
|
-
|
|
362
|
-
console.log(result);
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
run();
|
|
366
|
-
```
|
|
367
|
-
|
|
368
|
-
### Standalone function
|
|
369
|
-
|
|
370
|
-
The standalone function version of this method:
|
|
371
|
-
|
|
372
|
-
```typescript
|
|
373
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
374
|
-
import { commerceListCommerceLocations } from "@unified-api/typescript-sdk/funcs/commerceListCommerceLocations.js";
|
|
375
|
-
|
|
376
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
377
|
-
// You can create one instance of it to use across an application.
|
|
378
|
-
const unifiedTo = new UnifiedToCore({
|
|
379
|
-
security: {
|
|
380
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
381
|
-
},
|
|
382
|
-
});
|
|
383
|
-
|
|
384
|
-
async function run() {
|
|
385
|
-
const res = await commerceListCommerceLocations(unifiedTo, {
|
|
386
|
-
connectionId: "<id>",
|
|
387
|
-
});
|
|
388
|
-
if (res.ok) {
|
|
389
|
-
const { value: result } = res;
|
|
390
|
-
console.log(result);
|
|
391
|
-
} else {
|
|
392
|
-
console.log("commerceListCommerceLocations failed:", res.error);
|
|
393
|
-
}
|
|
394
|
-
}
|
|
395
|
-
|
|
396
|
-
run();
|
|
397
|
-
```
|
|
398
|
-
|
|
399
|
-
### Parameters
|
|
400
|
-
|
|
401
|
-
| Parameter | Type | Required | Description |
|
|
402
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
403
|
-
| `request` | [operations.ListCommerceLocationsRequest](../../sdk/models/operations/listcommercelocationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
404
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
405
|
-
| `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. |
|
|
406
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
407
|
-
|
|
408
|
-
### Response
|
|
409
|
-
|
|
410
|
-
**Promise\<[shared.CommerceLocation[]](../../models/.md)\>**
|
|
411
|
-
|
|
412
|
-
### Errors
|
|
413
|
-
|
|
414
|
-
| Error Type | Status Code | Content Type |
|
|
415
|
-
| --------------- | --------------- | --------------- |
|
|
416
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
417
|
-
|
|
418
|
-
## listHrisLocations
|
|
419
|
-
|
|
420
|
-
List all locations
|
|
421
|
-
|
|
422
|
-
### Example Usage
|
|
423
|
-
|
|
424
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisLocations" method="get" path="/hris/{connection_id}/location" -->
|
|
425
|
-
```typescript
|
|
426
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
427
|
-
|
|
428
|
-
const unifiedTo = new UnifiedTo({
|
|
429
|
-
security: {
|
|
430
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
431
|
-
},
|
|
432
|
-
});
|
|
433
|
-
|
|
434
|
-
async function run() {
|
|
435
|
-
const result = await unifiedTo.location.listHrisLocations({
|
|
436
|
-
connectionId: "<id>",
|
|
437
|
-
});
|
|
438
|
-
|
|
439
|
-
console.log(result);
|
|
440
|
-
}
|
|
441
|
-
|
|
442
|
-
run();
|
|
443
|
-
```
|
|
444
|
-
|
|
445
|
-
### Standalone function
|
|
446
|
-
|
|
447
|
-
The standalone function version of this method:
|
|
448
|
-
|
|
449
|
-
```typescript
|
|
450
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
451
|
-
import { locationListHrisLocations } from "@unified-api/typescript-sdk/funcs/locationListHrisLocations.js";
|
|
452
|
-
|
|
453
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
454
|
-
// You can create one instance of it to use across an application.
|
|
455
|
-
const unifiedTo = new UnifiedToCore({
|
|
456
|
-
security: {
|
|
457
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
458
|
-
},
|
|
459
|
-
});
|
|
460
|
-
|
|
461
|
-
async function run() {
|
|
462
|
-
const res = await locationListHrisLocations(unifiedTo, {
|
|
463
|
-
connectionId: "<id>",
|
|
464
|
-
});
|
|
465
|
-
if (res.ok) {
|
|
466
|
-
const { value: result } = res;
|
|
467
|
-
console.log(result);
|
|
468
|
-
} else {
|
|
469
|
-
console.log("locationListHrisLocations failed:", res.error);
|
|
470
|
-
}
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
run();
|
|
474
|
-
```
|
|
475
|
-
|
|
476
|
-
### Parameters
|
|
477
|
-
|
|
478
|
-
| Parameter | Type | Required | Description |
|
|
479
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
480
|
-
| `request` | [operations.ListHrisLocationsRequest](../../sdk/models/operations/listhrislocationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
481
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
482
|
-
| `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. |
|
|
483
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
484
|
-
|
|
485
|
-
### Response
|
|
486
|
-
|
|
487
|
-
**Promise\<[shared.HrisLocation[]](../../models/.md)\>**
|
|
488
|
-
|
|
489
|
-
### Errors
|
|
490
|
-
|
|
491
|
-
| Error Type | Status Code | Content Type |
|
|
492
|
-
| --------------- | --------------- | --------------- |
|
|
493
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
494
|
-
|
|
495
|
-
## patchCommerceLocation
|
|
496
|
-
|
|
497
|
-
Update a location
|
|
498
|
-
|
|
499
|
-
### Example Usage
|
|
500
|
-
|
|
501
|
-
<!-- UsageSnippet language="typescript" operationID="patchCommerceLocation" method="patch" path="/commerce/{connection_id}/location/{id}" -->
|
|
502
|
-
```typescript
|
|
503
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
504
|
-
|
|
505
|
-
const unifiedTo = new UnifiedTo({
|
|
506
|
-
security: {
|
|
507
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
508
|
-
},
|
|
509
|
-
});
|
|
510
|
-
|
|
511
|
-
async function run() {
|
|
512
|
-
const result = await unifiedTo.location.patchCommerceLocation({
|
|
513
|
-
commerceLocation: {
|
|
514
|
-
name: "<value>",
|
|
515
|
-
},
|
|
516
|
-
connectionId: "<id>",
|
|
517
|
-
id: "<id>",
|
|
518
|
-
});
|
|
519
|
-
|
|
520
|
-
console.log(result);
|
|
521
|
-
}
|
|
522
|
-
|
|
523
|
-
run();
|
|
524
|
-
```
|
|
525
|
-
|
|
526
|
-
### Standalone function
|
|
527
|
-
|
|
528
|
-
The standalone function version of this method:
|
|
529
|
-
|
|
530
|
-
```typescript
|
|
531
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
532
|
-
import { commercePatchCommerceLocation } from "@unified-api/typescript-sdk/funcs/commercePatchCommerceLocation.js";
|
|
533
|
-
|
|
534
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
535
|
-
// You can create one instance of it to use across an application.
|
|
536
|
-
const unifiedTo = new UnifiedToCore({
|
|
537
|
-
security: {
|
|
538
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
539
|
-
},
|
|
540
|
-
});
|
|
541
|
-
|
|
542
|
-
async function run() {
|
|
543
|
-
const res = await commercePatchCommerceLocation(unifiedTo, {
|
|
544
|
-
commerceLocation: {
|
|
545
|
-
name: "<value>",
|
|
546
|
-
},
|
|
547
|
-
connectionId: "<id>",
|
|
548
|
-
id: "<id>",
|
|
549
|
-
});
|
|
550
|
-
if (res.ok) {
|
|
551
|
-
const { value: result } = res;
|
|
552
|
-
console.log(result);
|
|
553
|
-
} else {
|
|
554
|
-
console.log("commercePatchCommerceLocation failed:", res.error);
|
|
555
|
-
}
|
|
556
|
-
}
|
|
557
|
-
|
|
558
|
-
run();
|
|
559
|
-
```
|
|
560
|
-
|
|
561
|
-
### Parameters
|
|
562
|
-
|
|
563
|
-
| Parameter | Type | Required | Description |
|
|
564
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
565
|
-
| `request` | [operations.PatchCommerceLocationRequest](../../sdk/models/operations/patchcommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
566
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
567
|
-
| `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. |
|
|
568
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
569
|
-
|
|
570
|
-
### Response
|
|
571
|
-
|
|
572
|
-
**Promise\<[shared.CommerceLocation](../../sdk/models/shared/commercelocation.md)\>**
|
|
573
|
-
|
|
574
|
-
### Errors
|
|
575
|
-
|
|
576
|
-
| Error Type | Status Code | Content Type |
|
|
577
|
-
| --------------- | --------------- | --------------- |
|
|
578
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
579
|
-
|
|
580
|
-
## patchHrisLocation
|
|
581
|
-
|
|
582
|
-
Update a location
|
|
583
|
-
|
|
584
|
-
### Example Usage
|
|
585
|
-
|
|
586
|
-
<!-- UsageSnippet language="typescript" operationID="patchHrisLocation" method="patch" path="/hris/{connection_id}/location/{id}" -->
|
|
587
|
-
```typescript
|
|
588
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
589
|
-
|
|
590
|
-
const unifiedTo = new UnifiedTo({
|
|
591
|
-
security: {
|
|
592
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
593
|
-
},
|
|
594
|
-
});
|
|
595
|
-
|
|
596
|
-
async function run() {
|
|
597
|
-
const result = await unifiedTo.location.patchHrisLocation({
|
|
598
|
-
hrisLocation: {},
|
|
599
|
-
connectionId: "<id>",
|
|
600
|
-
id: "<id>",
|
|
601
|
-
});
|
|
602
|
-
|
|
603
|
-
console.log(result);
|
|
604
|
-
}
|
|
605
|
-
|
|
606
|
-
run();
|
|
607
|
-
```
|
|
608
|
-
|
|
609
|
-
### Standalone function
|
|
610
|
-
|
|
611
|
-
The standalone function version of this method:
|
|
612
|
-
|
|
613
|
-
```typescript
|
|
614
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
615
|
-
import { locationPatchHrisLocation } from "@unified-api/typescript-sdk/funcs/locationPatchHrisLocation.js";
|
|
616
|
-
|
|
617
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
618
|
-
// You can create one instance of it to use across an application.
|
|
619
|
-
const unifiedTo = new UnifiedToCore({
|
|
620
|
-
security: {
|
|
621
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
622
|
-
},
|
|
623
|
-
});
|
|
624
|
-
|
|
625
|
-
async function run() {
|
|
626
|
-
const res = await locationPatchHrisLocation(unifiedTo, {
|
|
627
|
-
hrisLocation: {},
|
|
628
|
-
connectionId: "<id>",
|
|
629
|
-
id: "<id>",
|
|
630
|
-
});
|
|
631
|
-
if (res.ok) {
|
|
632
|
-
const { value: result } = res;
|
|
633
|
-
console.log(result);
|
|
634
|
-
} else {
|
|
635
|
-
console.log("locationPatchHrisLocation failed:", res.error);
|
|
636
|
-
}
|
|
637
|
-
}
|
|
638
|
-
|
|
639
|
-
run();
|
|
640
|
-
```
|
|
641
|
-
|
|
642
|
-
### Parameters
|
|
643
|
-
|
|
644
|
-
| Parameter | Type | Required | Description |
|
|
645
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
646
|
-
| `request` | [operations.PatchHrisLocationRequest](../../sdk/models/operations/patchhrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
647
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
648
|
-
| `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. |
|
|
649
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
650
|
-
|
|
651
|
-
### Response
|
|
652
|
-
|
|
653
|
-
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
654
|
-
|
|
655
|
-
### Errors
|
|
656
|
-
|
|
657
|
-
| Error Type | Status Code | Content Type |
|
|
658
|
-
| --------------- | --------------- | --------------- |
|
|
659
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
660
|
-
|
|
661
|
-
## removeCommerceLocation
|
|
662
|
-
|
|
663
|
-
Remove a location
|
|
664
|
-
|
|
665
|
-
### Example Usage
|
|
666
|
-
|
|
667
|
-
<!-- UsageSnippet language="typescript" operationID="removeCommerceLocation" method="delete" path="/commerce/{connection_id}/location/{id}" -->
|
|
668
|
-
```typescript
|
|
669
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
670
|
-
|
|
671
|
-
const unifiedTo = new UnifiedTo({
|
|
672
|
-
security: {
|
|
673
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
674
|
-
},
|
|
675
|
-
});
|
|
676
|
-
|
|
677
|
-
async function run() {
|
|
678
|
-
const result = await unifiedTo.location.removeCommerceLocation({
|
|
679
|
-
connectionId: "<id>",
|
|
680
|
-
id: "<id>",
|
|
681
|
-
});
|
|
682
|
-
|
|
683
|
-
console.log(result);
|
|
684
|
-
}
|
|
685
|
-
|
|
686
|
-
run();
|
|
687
|
-
```
|
|
688
|
-
|
|
689
|
-
### Standalone function
|
|
690
|
-
|
|
691
|
-
The standalone function version of this method:
|
|
692
|
-
|
|
693
|
-
```typescript
|
|
694
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
695
|
-
import { commerceRemoveCommerceLocation } from "@unified-api/typescript-sdk/funcs/commerceRemoveCommerceLocation.js";
|
|
696
|
-
|
|
697
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
698
|
-
// You can create one instance of it to use across an application.
|
|
699
|
-
const unifiedTo = new UnifiedToCore({
|
|
700
|
-
security: {
|
|
701
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
702
|
-
},
|
|
703
|
-
});
|
|
704
|
-
|
|
705
|
-
async function run() {
|
|
706
|
-
const res = await commerceRemoveCommerceLocation(unifiedTo, {
|
|
707
|
-
connectionId: "<id>",
|
|
708
|
-
id: "<id>",
|
|
709
|
-
});
|
|
710
|
-
if (res.ok) {
|
|
711
|
-
const { value: result } = res;
|
|
712
|
-
console.log(result);
|
|
713
|
-
} else {
|
|
714
|
-
console.log("commerceRemoveCommerceLocation failed:", res.error);
|
|
715
|
-
}
|
|
716
|
-
}
|
|
717
|
-
|
|
718
|
-
run();
|
|
719
|
-
```
|
|
720
|
-
|
|
721
|
-
### Parameters
|
|
722
|
-
|
|
723
|
-
| Parameter | Type | Required | Description |
|
|
724
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
725
|
-
| `request` | [operations.RemoveCommerceLocationRequest](../../sdk/models/operations/removecommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
726
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
727
|
-
| `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. |
|
|
728
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
729
|
-
|
|
730
|
-
### Response
|
|
731
|
-
|
|
732
|
-
**Promise\<[operations.RemoveCommerceLocationResponse](../../sdk/models/operations/removecommercelocationresponse.md)\>**
|
|
733
|
-
|
|
734
|
-
### Errors
|
|
735
|
-
|
|
736
|
-
| Error Type | Status Code | Content Type |
|
|
737
|
-
| --------------- | --------------- | --------------- |
|
|
738
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
739
|
-
|
|
740
|
-
## removeHrisLocation
|
|
741
|
-
|
|
742
|
-
Remove a location
|
|
743
|
-
|
|
744
|
-
### Example Usage
|
|
745
|
-
|
|
746
|
-
<!-- UsageSnippet language="typescript" operationID="removeHrisLocation" method="delete" path="/hris/{connection_id}/location/{id}" -->
|
|
747
|
-
```typescript
|
|
748
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
749
|
-
|
|
750
|
-
const unifiedTo = new UnifiedTo({
|
|
751
|
-
security: {
|
|
752
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
753
|
-
},
|
|
754
|
-
});
|
|
755
|
-
|
|
756
|
-
async function run() {
|
|
757
|
-
const result = await unifiedTo.location.removeHrisLocation({
|
|
758
|
-
connectionId: "<id>",
|
|
759
|
-
id: "<id>",
|
|
760
|
-
});
|
|
761
|
-
|
|
762
|
-
console.log(result);
|
|
763
|
-
}
|
|
764
|
-
|
|
765
|
-
run();
|
|
766
|
-
```
|
|
767
|
-
|
|
768
|
-
### Standalone function
|
|
769
|
-
|
|
770
|
-
The standalone function version of this method:
|
|
771
|
-
|
|
772
|
-
```typescript
|
|
773
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
774
|
-
import { locationRemoveHrisLocation } from "@unified-api/typescript-sdk/funcs/locationRemoveHrisLocation.js";
|
|
775
|
-
|
|
776
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
777
|
-
// You can create one instance of it to use across an application.
|
|
778
|
-
const unifiedTo = new UnifiedToCore({
|
|
779
|
-
security: {
|
|
780
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
781
|
-
},
|
|
782
|
-
});
|
|
783
|
-
|
|
784
|
-
async function run() {
|
|
785
|
-
const res = await locationRemoveHrisLocation(unifiedTo, {
|
|
786
|
-
connectionId: "<id>",
|
|
787
|
-
id: "<id>",
|
|
788
|
-
});
|
|
789
|
-
if (res.ok) {
|
|
790
|
-
const { value: result } = res;
|
|
791
|
-
console.log(result);
|
|
792
|
-
} else {
|
|
793
|
-
console.log("locationRemoveHrisLocation failed:", res.error);
|
|
794
|
-
}
|
|
795
|
-
}
|
|
796
|
-
|
|
797
|
-
run();
|
|
798
|
-
```
|
|
799
|
-
|
|
800
|
-
### Parameters
|
|
801
|
-
|
|
802
|
-
| Parameter | Type | Required | Description |
|
|
803
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
804
|
-
| `request` | [operations.RemoveHrisLocationRequest](../../sdk/models/operations/removehrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
805
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
806
|
-
| `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. |
|
|
807
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
808
|
-
|
|
809
|
-
### Response
|
|
810
|
-
|
|
811
|
-
**Promise\<[operations.RemoveHrisLocationResponse](../../sdk/models/operations/removehrislocationresponse.md)\>**
|
|
812
|
-
|
|
813
|
-
### Errors
|
|
814
|
-
|
|
815
|
-
| Error Type | Status Code | Content Type |
|
|
816
|
-
| --------------- | --------------- | --------------- |
|
|
817
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
818
|
-
|
|
819
|
-
## updateCommerceLocation
|
|
820
|
-
|
|
821
|
-
Update a location
|
|
822
|
-
|
|
823
|
-
### Example Usage
|
|
824
|
-
|
|
825
|
-
<!-- UsageSnippet language="typescript" operationID="updateCommerceLocation" method="put" path="/commerce/{connection_id}/location/{id}" -->
|
|
826
|
-
```typescript
|
|
827
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
828
|
-
|
|
829
|
-
const unifiedTo = new UnifiedTo({
|
|
830
|
-
security: {
|
|
831
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
832
|
-
},
|
|
833
|
-
});
|
|
834
|
-
|
|
835
|
-
async function run() {
|
|
836
|
-
const result = await unifiedTo.location.updateCommerceLocation({
|
|
837
|
-
commerceLocation: {
|
|
838
|
-
name: "<value>",
|
|
839
|
-
},
|
|
840
|
-
connectionId: "<id>",
|
|
841
|
-
id: "<id>",
|
|
842
|
-
});
|
|
843
|
-
|
|
844
|
-
console.log(result);
|
|
845
|
-
}
|
|
846
|
-
|
|
847
|
-
run();
|
|
848
|
-
```
|
|
849
|
-
|
|
850
|
-
### Standalone function
|
|
851
|
-
|
|
852
|
-
The standalone function version of this method:
|
|
853
|
-
|
|
854
|
-
```typescript
|
|
855
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
856
|
-
import { commerceUpdateCommerceLocation } from "@unified-api/typescript-sdk/funcs/commerceUpdateCommerceLocation.js";
|
|
857
|
-
|
|
858
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
859
|
-
// You can create one instance of it to use across an application.
|
|
860
|
-
const unifiedTo = new UnifiedToCore({
|
|
861
|
-
security: {
|
|
862
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
863
|
-
},
|
|
864
|
-
});
|
|
865
|
-
|
|
866
|
-
async function run() {
|
|
867
|
-
const res = await commerceUpdateCommerceLocation(unifiedTo, {
|
|
868
|
-
commerceLocation: {
|
|
869
|
-
name: "<value>",
|
|
870
|
-
},
|
|
871
|
-
connectionId: "<id>",
|
|
872
|
-
id: "<id>",
|
|
873
|
-
});
|
|
874
|
-
if (res.ok) {
|
|
875
|
-
const { value: result } = res;
|
|
876
|
-
console.log(result);
|
|
877
|
-
} else {
|
|
878
|
-
console.log("commerceUpdateCommerceLocation failed:", res.error);
|
|
879
|
-
}
|
|
880
|
-
}
|
|
881
|
-
|
|
882
|
-
run();
|
|
883
|
-
```
|
|
884
|
-
|
|
885
|
-
### Parameters
|
|
886
|
-
|
|
887
|
-
| Parameter | Type | Required | Description |
|
|
888
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
889
|
-
| `request` | [operations.UpdateCommerceLocationRequest](../../sdk/models/operations/updatecommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
890
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
891
|
-
| `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. |
|
|
892
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
893
|
-
|
|
894
|
-
### Response
|
|
895
|
-
|
|
896
|
-
**Promise\<[shared.CommerceLocation](../../sdk/models/shared/commercelocation.md)\>**
|
|
897
|
-
|
|
898
|
-
### Errors
|
|
899
|
-
|
|
900
|
-
| Error Type | Status Code | Content Type |
|
|
901
|
-
| --------------- | --------------- | --------------- |
|
|
902
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
903
|
-
|
|
904
|
-
## updateHrisLocation
|
|
905
|
-
|
|
906
|
-
Update a location
|
|
907
|
-
|
|
908
|
-
### Example Usage
|
|
909
|
-
|
|
910
|
-
<!-- UsageSnippet language="typescript" operationID="updateHrisLocation" method="put" path="/hris/{connection_id}/location/{id}" -->
|
|
911
|
-
```typescript
|
|
912
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
913
|
-
|
|
914
|
-
const unifiedTo = new UnifiedTo({
|
|
915
|
-
security: {
|
|
916
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
917
|
-
},
|
|
918
|
-
});
|
|
919
|
-
|
|
920
|
-
async function run() {
|
|
921
|
-
const result = await unifiedTo.location.updateHrisLocation({
|
|
922
|
-
hrisLocation: {},
|
|
923
|
-
connectionId: "<id>",
|
|
924
|
-
id: "<id>",
|
|
925
|
-
});
|
|
926
|
-
|
|
927
|
-
console.log(result);
|
|
928
|
-
}
|
|
929
|
-
|
|
930
|
-
run();
|
|
931
|
-
```
|
|
932
|
-
|
|
933
|
-
### Standalone function
|
|
934
|
-
|
|
935
|
-
The standalone function version of this method:
|
|
936
|
-
|
|
937
|
-
```typescript
|
|
938
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
939
|
-
import { locationUpdateHrisLocation } from "@unified-api/typescript-sdk/funcs/locationUpdateHrisLocation.js";
|
|
940
|
-
|
|
941
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
942
|
-
// You can create one instance of it to use across an application.
|
|
943
|
-
const unifiedTo = new UnifiedToCore({
|
|
944
|
-
security: {
|
|
945
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
946
|
-
},
|
|
947
|
-
});
|
|
948
|
-
|
|
949
|
-
async function run() {
|
|
950
|
-
const res = await locationUpdateHrisLocation(unifiedTo, {
|
|
951
|
-
hrisLocation: {},
|
|
952
|
-
connectionId: "<id>",
|
|
953
|
-
id: "<id>",
|
|
954
|
-
});
|
|
955
|
-
if (res.ok) {
|
|
956
|
-
const { value: result } = res;
|
|
957
|
-
console.log(result);
|
|
958
|
-
} else {
|
|
959
|
-
console.log("locationUpdateHrisLocation failed:", res.error);
|
|
960
|
-
}
|
|
961
|
-
}
|
|
962
|
-
|
|
963
|
-
run();
|
|
964
|
-
```
|
|
965
|
-
|
|
966
|
-
### Parameters
|
|
967
|
-
|
|
968
|
-
| Parameter | Type | Required | Description |
|
|
969
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
970
|
-
| `request` | [operations.UpdateHrisLocationRequest](../../sdk/models/operations/updatehrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
971
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
972
|
-
| `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. |
|
|
973
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
974
|
-
|
|
975
|
-
### Response
|
|
976
|
-
|
|
977
|
-
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
978
|
-
|
|
979
|
-
### Errors
|
|
980
|
-
|
|
981
|
-
| Error Type | Status Code | Content Type |
|
|
982
|
-
| --------------- | --------------- | --------------- |
|
|
983
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|