@dsptch-work/api-client 0.1.0
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/LICENSE +21 -0
- package/README.md +130 -0
- package/dist/gen/client/client.gen.d.ts +2 -0
- package/dist/gen/client/client.gen.js +216 -0
- package/dist/gen/client/index.d.ts +8 -0
- package/dist/gen/client/index.js +6 -0
- package/dist/gen/client/types.gen.d.ts +120 -0
- package/dist/gen/client/types.gen.js +2 -0
- package/dist/gen/client/utils.gen.d.ts +37 -0
- package/dist/gen/client/utils.gen.js +228 -0
- package/dist/gen/client.gen.d.ts +12 -0
- package/dist/gen/client.gen.js +3 -0
- package/dist/gen/core/auth.gen.d.ts +18 -0
- package/dist/gen/core/auth.gen.js +14 -0
- package/dist/gen/core/bodySerializer.gen.d.ts +25 -0
- package/dist/gen/core/bodySerializer.gen.js +57 -0
- package/dist/gen/core/params.gen.d.ts +43 -0
- package/dist/gen/core/params.gen.js +100 -0
- package/dist/gen/core/pathSerializer.gen.d.ts +33 -0
- package/dist/gen/core/pathSerializer.gen.js +106 -0
- package/dist/gen/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/gen/core/queryKeySerializer.gen.js +92 -0
- package/dist/gen/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/gen/core/serverSentEvents.gen.js +132 -0
- package/dist/gen/core/types.gen.d.ts +78 -0
- package/dist/gen/core/types.gen.js +2 -0
- package/dist/gen/core/utils.gen.d.ts +19 -0
- package/dist/gen/core/utils.gen.js +87 -0
- package/dist/gen/index.d.ts +2 -0
- package/dist/gen/index.js +2 -0
- package/dist/gen/sdk.gen.d.ts +2686 -0
- package/dist/gen/sdk.gen.js +4719 -0
- package/dist/gen/types.gen.d.ts +16974 -0
- package/dist/gen/types.gen.js +2 -0
- package/dist/gen/zod.gen.d.ts +16833 -0
- package/dist/gen/zod.gen.js +6478 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +5 -0
- package/dist/pagination.d.ts +36 -0
- package/dist/pagination.js +60 -0
- package/package.json +63 -0
|
@@ -0,0 +1,4719 @@
|
|
|
1
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
import { client } from './client.gen.js';
|
|
3
|
+
export class ApprenticeshipApprentices {
|
|
4
|
+
/**
|
|
5
|
+
* List apprenticeship apprentices
|
|
6
|
+
*
|
|
7
|
+
* **Required scope:**
|
|
8
|
+
*
|
|
9
|
+
* `apprenticeship.programs.apprentices:read`
|
|
10
|
+
*
|
|
11
|
+
*/
|
|
12
|
+
static listApprentices(options) {
|
|
13
|
+
return (options.client ?? client).get({
|
|
14
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
15
|
+
url: '/api/v1/apprenticeship/programs/{program_id}/apprentices',
|
|
16
|
+
...options
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Create apprentice
|
|
21
|
+
*
|
|
22
|
+
* **Required scope:**
|
|
23
|
+
*
|
|
24
|
+
* `apprenticeship.programs.apprentices:create`
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
static createApprentice(options) {
|
|
28
|
+
return (options.client ?? client).post({
|
|
29
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
30
|
+
url: '/api/v1/apprenticeship/programs/{program_id}/apprentices',
|
|
31
|
+
...options,
|
|
32
|
+
headers: {
|
|
33
|
+
'Content-Type': 'application/json',
|
|
34
|
+
...options.headers
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
export class ApprenticeshipOccupations {
|
|
40
|
+
/**
|
|
41
|
+
* List apprenticeship occupations
|
|
42
|
+
*
|
|
43
|
+
* **Required scope:**
|
|
44
|
+
*
|
|
45
|
+
* `apprenticeship.programs.occupations:read`
|
|
46
|
+
*
|
|
47
|
+
*/
|
|
48
|
+
static listOccupations(options) {
|
|
49
|
+
return (options.client ?? client).get({
|
|
50
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
51
|
+
url: '/api/v1/apprenticeship/programs/{program_id}/occupations',
|
|
52
|
+
...options
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Create apprenticeship occupation
|
|
57
|
+
*
|
|
58
|
+
* **Required scope:**
|
|
59
|
+
*
|
|
60
|
+
* `apprenticeship.programs.occupations:create`
|
|
61
|
+
*
|
|
62
|
+
*/
|
|
63
|
+
static createOccupation(options) {
|
|
64
|
+
return (options.client ?? client).post({
|
|
65
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
66
|
+
url: '/api/v1/apprenticeship/programs/{program_id}/occupations',
|
|
67
|
+
...options,
|
|
68
|
+
headers: {
|
|
69
|
+
'Content-Type': 'application/json',
|
|
70
|
+
...options.headers
|
|
71
|
+
}
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Update apprenticeship occupation
|
|
76
|
+
*
|
|
77
|
+
* **Required scope:**
|
|
78
|
+
*
|
|
79
|
+
* `apprenticeship.programs.occupations:update`
|
|
80
|
+
*
|
|
81
|
+
*/
|
|
82
|
+
static updateOccupation(options) {
|
|
83
|
+
return (options.client ?? client).patch({
|
|
84
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
85
|
+
url: '/api/v1/apprenticeship/programs/{program_id}/occupations/{id}',
|
|
86
|
+
...options,
|
|
87
|
+
headers: {
|
|
88
|
+
'Content-Type': 'application/json',
|
|
89
|
+
...options.headers
|
|
90
|
+
}
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
export class ApprenticeshipEmployers {
|
|
95
|
+
/**
|
|
96
|
+
* List apprenticeship employers
|
|
97
|
+
*
|
|
98
|
+
* **Required scope:**
|
|
99
|
+
*
|
|
100
|
+
* `apprenticeship.programs.employers:read`
|
|
101
|
+
*
|
|
102
|
+
*/
|
|
103
|
+
static listEmployers(options) {
|
|
104
|
+
return (options.client ?? client).get({
|
|
105
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
106
|
+
url: '/api/v1/apprenticeship/programs/{program_id}/employers',
|
|
107
|
+
...options
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Create apprenticeship employer
|
|
112
|
+
*
|
|
113
|
+
* **Required scope:**
|
|
114
|
+
*
|
|
115
|
+
* `apprenticeship.programs.employers:create`
|
|
116
|
+
*
|
|
117
|
+
*/
|
|
118
|
+
static createEmployer(options) {
|
|
119
|
+
return (options.client ?? client).post({
|
|
120
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
121
|
+
url: '/api/v1/apprenticeship/programs/{program_id}/employers',
|
|
122
|
+
...options,
|
|
123
|
+
headers: {
|
|
124
|
+
'Content-Type': 'application/json',
|
|
125
|
+
...options.headers
|
|
126
|
+
}
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Delete apprenticeship employer
|
|
131
|
+
*
|
|
132
|
+
* **Required scope:**
|
|
133
|
+
*
|
|
134
|
+
* `apprenticeship.programs.employers:delete`
|
|
135
|
+
*
|
|
136
|
+
*/
|
|
137
|
+
static deleteEmployer(options) {
|
|
138
|
+
return (options.client ?? client).delete({
|
|
139
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
140
|
+
url: '/api/v1/apprenticeship/programs/{program_id}/employers/{id}',
|
|
141
|
+
...options
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Update apprenticeship employer
|
|
146
|
+
*
|
|
147
|
+
* **Required scope:**
|
|
148
|
+
*
|
|
149
|
+
* `apprenticeship.programs.employers:update`
|
|
150
|
+
*
|
|
151
|
+
*/
|
|
152
|
+
static updateEmployer(options) {
|
|
153
|
+
return (options.client ?? client).patch({
|
|
154
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
155
|
+
url: '/api/v1/apprenticeship/programs/{program_id}/employers/{id}',
|
|
156
|
+
...options,
|
|
157
|
+
headers: {
|
|
158
|
+
'Content-Type': 'application/json',
|
|
159
|
+
...options.headers
|
|
160
|
+
}
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
export class ApprenticeshipPrograms {
|
|
165
|
+
/**
|
|
166
|
+
* List apprenticeship programs
|
|
167
|
+
*
|
|
168
|
+
* **Required scope:**
|
|
169
|
+
*
|
|
170
|
+
* `apprenticeship.programs:read`
|
|
171
|
+
*
|
|
172
|
+
*/
|
|
173
|
+
static listPrograms(options) {
|
|
174
|
+
return (options?.client ?? client).get({
|
|
175
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
176
|
+
url: '/api/v1/apprenticeship/programs',
|
|
177
|
+
...options
|
|
178
|
+
});
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Create apprenticeship program
|
|
182
|
+
*
|
|
183
|
+
* **Required scope:**
|
|
184
|
+
*
|
|
185
|
+
* `apprenticeship.programs:create`
|
|
186
|
+
*
|
|
187
|
+
*/
|
|
188
|
+
static createProgram(options) {
|
|
189
|
+
return (options?.client ?? client).post({
|
|
190
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
191
|
+
url: '/api/v1/apprenticeship/programs',
|
|
192
|
+
...options,
|
|
193
|
+
headers: {
|
|
194
|
+
'Content-Type': 'application/json',
|
|
195
|
+
...options?.headers
|
|
196
|
+
}
|
|
197
|
+
});
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* Update apprenticeship program
|
|
201
|
+
*
|
|
202
|
+
* **Required scope:**
|
|
203
|
+
*
|
|
204
|
+
* `apprenticeship.programs:update`
|
|
205
|
+
*
|
|
206
|
+
*/
|
|
207
|
+
static updateProgram(options) {
|
|
208
|
+
return (options.client ?? client).patch({
|
|
209
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
210
|
+
url: '/api/v1/apprenticeship/programs/{id}',
|
|
211
|
+
...options,
|
|
212
|
+
headers: {
|
|
213
|
+
'Content-Type': 'application/json',
|
|
214
|
+
...options.headers
|
|
215
|
+
}
|
|
216
|
+
});
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
export class ApprenticeshipWageSchedulePeriods {
|
|
220
|
+
/**
|
|
221
|
+
* List apprenticeship wage schedule periods
|
|
222
|
+
*
|
|
223
|
+
* **Required scope:**
|
|
224
|
+
*
|
|
225
|
+
* `apprenticeship.wage_schedules.periods:read`
|
|
226
|
+
*
|
|
227
|
+
*/
|
|
228
|
+
static listPeriods(options) {
|
|
229
|
+
return (options.client ?? client).get({
|
|
230
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
231
|
+
url: '/api/v1/apprenticeship/wage_schedules/{wage_schedule_id}/periods',
|
|
232
|
+
...options
|
|
233
|
+
});
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* Create apprenticeship wage schedule period
|
|
237
|
+
*
|
|
238
|
+
* **Required scope:**
|
|
239
|
+
*
|
|
240
|
+
* `apprenticeship.wage_schedules.periods:create`
|
|
241
|
+
*
|
|
242
|
+
*/
|
|
243
|
+
static createPeriod(options) {
|
|
244
|
+
return (options.client ?? client).post({
|
|
245
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
246
|
+
url: '/api/v1/apprenticeship/wage_schedules/{wage_schedule_id}/periods',
|
|
247
|
+
...options,
|
|
248
|
+
headers: {
|
|
249
|
+
'Content-Type': 'application/json',
|
|
250
|
+
...options.headers
|
|
251
|
+
}
|
|
252
|
+
});
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* Update apprenticeship wage schedule period
|
|
256
|
+
*
|
|
257
|
+
* **Required scope:**
|
|
258
|
+
*
|
|
259
|
+
* `apprenticeship.wage_schedules.periods:update`
|
|
260
|
+
*
|
|
261
|
+
*/
|
|
262
|
+
static updatePeriod(options) {
|
|
263
|
+
return (options.client ?? client).patch({
|
|
264
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
265
|
+
url: '/api/v1/apprenticeship/wage_schedules/{wage_schedule_id}/periods/{id}',
|
|
266
|
+
...options,
|
|
267
|
+
headers: {
|
|
268
|
+
'Content-Type': 'application/json',
|
|
269
|
+
...options.headers
|
|
270
|
+
}
|
|
271
|
+
});
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
export class ApprenticeshipWageSchedules {
|
|
275
|
+
/**
|
|
276
|
+
* List apprenticeship wage schedules
|
|
277
|
+
*
|
|
278
|
+
* **Required scope:**
|
|
279
|
+
*
|
|
280
|
+
* `apprenticeship.occupations.wage_schedules:read`
|
|
281
|
+
*
|
|
282
|
+
*/
|
|
283
|
+
static listWageSchedules(options) {
|
|
284
|
+
return (options.client ?? client).get({
|
|
285
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
286
|
+
url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules',
|
|
287
|
+
...options
|
|
288
|
+
});
|
|
289
|
+
}
|
|
290
|
+
/**
|
|
291
|
+
* Create apprenticeship wage schedule
|
|
292
|
+
*
|
|
293
|
+
* **Required scope:**
|
|
294
|
+
*
|
|
295
|
+
* `apprenticeship.occupations.wage_schedules:create`
|
|
296
|
+
*
|
|
297
|
+
*/
|
|
298
|
+
static createWageSchedule(options) {
|
|
299
|
+
return (options.client ?? client).post({
|
|
300
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
301
|
+
url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules',
|
|
302
|
+
...options,
|
|
303
|
+
headers: {
|
|
304
|
+
'Content-Type': 'application/json',
|
|
305
|
+
...options.headers
|
|
306
|
+
}
|
|
307
|
+
});
|
|
308
|
+
}
|
|
309
|
+
/**
|
|
310
|
+
* Update apprenticeship wage schedule
|
|
311
|
+
*
|
|
312
|
+
* **Required scope:**
|
|
313
|
+
*
|
|
314
|
+
* `apprenticeship.occupations.wage_schedules:update`
|
|
315
|
+
*
|
|
316
|
+
*/
|
|
317
|
+
static updateWageSchedule(options) {
|
|
318
|
+
return (options.client ?? client).patch({
|
|
319
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
320
|
+
url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules/{id}',
|
|
321
|
+
...options,
|
|
322
|
+
headers: {
|
|
323
|
+
'Content-Type': 'application/json',
|
|
324
|
+
...options.headers
|
|
325
|
+
}
|
|
326
|
+
});
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
export class AssetsAttributes {
|
|
330
|
+
/**
|
|
331
|
+
* List Attributes
|
|
332
|
+
*
|
|
333
|
+
* **Required scope:**
|
|
334
|
+
*
|
|
335
|
+
* `assets.attributes:read`
|
|
336
|
+
*
|
|
337
|
+
*/
|
|
338
|
+
static listAttributes(options) {
|
|
339
|
+
return (options?.client ?? client).get({
|
|
340
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
341
|
+
url: '/api/v1/assets/attributes',
|
|
342
|
+
...options
|
|
343
|
+
});
|
|
344
|
+
}
|
|
345
|
+
/**
|
|
346
|
+
* Create Attribute
|
|
347
|
+
*
|
|
348
|
+
* **Required scope:**
|
|
349
|
+
*
|
|
350
|
+
* `assets.attributes:create`
|
|
351
|
+
*
|
|
352
|
+
*/
|
|
353
|
+
static createAttribute(options) {
|
|
354
|
+
return (options?.client ?? client).post({
|
|
355
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
356
|
+
url: '/api/v1/assets/attributes',
|
|
357
|
+
...options,
|
|
358
|
+
headers: {
|
|
359
|
+
'Content-Type': 'application/json',
|
|
360
|
+
...options?.headers
|
|
361
|
+
}
|
|
362
|
+
});
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
* Delete Attribute
|
|
366
|
+
*
|
|
367
|
+
* **Required scope:**
|
|
368
|
+
*
|
|
369
|
+
* `assets.attributes:delete`
|
|
370
|
+
*
|
|
371
|
+
*/
|
|
372
|
+
static deleteAttribute(options) {
|
|
373
|
+
return (options.client ?? client).delete({
|
|
374
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
375
|
+
url: '/api/v1/assets/attributes/{id}',
|
|
376
|
+
...options
|
|
377
|
+
});
|
|
378
|
+
}
|
|
379
|
+
/**
|
|
380
|
+
* Get Attribute
|
|
381
|
+
*
|
|
382
|
+
* **Required scope:**
|
|
383
|
+
*
|
|
384
|
+
* `assets.attributes:read`
|
|
385
|
+
*
|
|
386
|
+
*/
|
|
387
|
+
static getAttribute(options) {
|
|
388
|
+
return (options.client ?? client).get({
|
|
389
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
390
|
+
url: '/api/v1/assets/attributes/{id}',
|
|
391
|
+
...options
|
|
392
|
+
});
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* Update Attribute
|
|
396
|
+
*
|
|
397
|
+
* **Required scope:**
|
|
398
|
+
*
|
|
399
|
+
* `assets.attributes:update`
|
|
400
|
+
*
|
|
401
|
+
*/
|
|
402
|
+
static updateAttribute(options) {
|
|
403
|
+
return (options.client ?? client).patch({
|
|
404
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
405
|
+
url: '/api/v1/assets/attributes/{id}',
|
|
406
|
+
...options,
|
|
407
|
+
headers: {
|
|
408
|
+
'Content-Type': 'application/json',
|
|
409
|
+
...options.headers
|
|
410
|
+
}
|
|
411
|
+
});
|
|
412
|
+
}
|
|
413
|
+
}
|
|
414
|
+
export class AssetsCategories {
|
|
415
|
+
/**
|
|
416
|
+
* List Categories
|
|
417
|
+
*
|
|
418
|
+
* **Required scope:**
|
|
419
|
+
*
|
|
420
|
+
* `assets.categories:read`
|
|
421
|
+
*
|
|
422
|
+
*/
|
|
423
|
+
static listCategories(options) {
|
|
424
|
+
return (options?.client ?? client).get({
|
|
425
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
426
|
+
url: '/api/v1/assets/categories',
|
|
427
|
+
...options
|
|
428
|
+
});
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* Create Category
|
|
432
|
+
*
|
|
433
|
+
* **Required scope:**
|
|
434
|
+
*
|
|
435
|
+
* `assets.categories:create`
|
|
436
|
+
*
|
|
437
|
+
*/
|
|
438
|
+
static createCategory(options) {
|
|
439
|
+
return (options?.client ?? client).post({
|
|
440
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
441
|
+
url: '/api/v1/assets/categories',
|
|
442
|
+
...options,
|
|
443
|
+
headers: {
|
|
444
|
+
'Content-Type': 'application/json',
|
|
445
|
+
...options?.headers
|
|
446
|
+
}
|
|
447
|
+
});
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* Delete Category
|
|
451
|
+
*
|
|
452
|
+
* **Required scope:**
|
|
453
|
+
*
|
|
454
|
+
* `assets.categories:delete`
|
|
455
|
+
*
|
|
456
|
+
*/
|
|
457
|
+
static deleteCategory(options) {
|
|
458
|
+
return (options.client ?? client).delete({
|
|
459
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
460
|
+
url: '/api/v1/assets/categories/{id}',
|
|
461
|
+
...options
|
|
462
|
+
});
|
|
463
|
+
}
|
|
464
|
+
/**
|
|
465
|
+
* Get Category
|
|
466
|
+
*
|
|
467
|
+
* **Required scope:**
|
|
468
|
+
*
|
|
469
|
+
* `assets.categories:read`
|
|
470
|
+
*
|
|
471
|
+
*/
|
|
472
|
+
static getCategory(options) {
|
|
473
|
+
return (options.client ?? client).get({
|
|
474
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
475
|
+
url: '/api/v1/assets/categories/{id}',
|
|
476
|
+
...options
|
|
477
|
+
});
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* Update Category
|
|
481
|
+
*
|
|
482
|
+
* **Required scope:**
|
|
483
|
+
*
|
|
484
|
+
* `assets.categories:update`
|
|
485
|
+
*
|
|
486
|
+
*/
|
|
487
|
+
static updateCategory(options) {
|
|
488
|
+
return (options.client ?? client).patch({
|
|
489
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
490
|
+
url: '/api/v1/assets/categories/{id}',
|
|
491
|
+
...options,
|
|
492
|
+
headers: {
|
|
493
|
+
'Content-Type': 'application/json',
|
|
494
|
+
...options.headers
|
|
495
|
+
}
|
|
496
|
+
});
|
|
497
|
+
}
|
|
498
|
+
}
|
|
499
|
+
export class AssetsCustodies {
|
|
500
|
+
/**
|
|
501
|
+
* List custodies
|
|
502
|
+
*
|
|
503
|
+
* **Required scope:**
|
|
504
|
+
*
|
|
505
|
+
* `assets.custodies:read`
|
|
506
|
+
*
|
|
507
|
+
*/
|
|
508
|
+
static listCustodies(options) {
|
|
509
|
+
return (options?.client ?? client).get({
|
|
510
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
511
|
+
url: '/api/v1/assets/custodies',
|
|
512
|
+
...options
|
|
513
|
+
});
|
|
514
|
+
}
|
|
515
|
+
/**
|
|
516
|
+
* Show custody
|
|
517
|
+
*
|
|
518
|
+
* **Required scope:**
|
|
519
|
+
*
|
|
520
|
+
* `assets.custodies:read`
|
|
521
|
+
*
|
|
522
|
+
*/
|
|
523
|
+
static getCustody(options) {
|
|
524
|
+
return (options.client ?? client).get({
|
|
525
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
526
|
+
url: '/api/v1/assets/custodies/{id}',
|
|
527
|
+
...options
|
|
528
|
+
});
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
export class AssetsEvents {
|
|
532
|
+
/**
|
|
533
|
+
* List events
|
|
534
|
+
*
|
|
535
|
+
* **Required scope:**
|
|
536
|
+
*
|
|
537
|
+
* `assets.events:read`
|
|
538
|
+
*
|
|
539
|
+
*/
|
|
540
|
+
static listEvents(options) {
|
|
541
|
+
return (options?.client ?? client).get({
|
|
542
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
543
|
+
url: '/api/v1/assets/events',
|
|
544
|
+
...options
|
|
545
|
+
});
|
|
546
|
+
}
|
|
547
|
+
/**
|
|
548
|
+
* Show event
|
|
549
|
+
*
|
|
550
|
+
* **Required scope:**
|
|
551
|
+
*
|
|
552
|
+
* `assets.events:read`
|
|
553
|
+
*
|
|
554
|
+
*/
|
|
555
|
+
static getEvent(options) {
|
|
556
|
+
return (options.client ?? client).get({
|
|
557
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
558
|
+
url: '/api/v1/assets/events/{id}',
|
|
559
|
+
...options
|
|
560
|
+
});
|
|
561
|
+
}
|
|
562
|
+
}
|
|
563
|
+
export class AssetsFormAssignmentTriggers {
|
|
564
|
+
/**
|
|
565
|
+
* List form assignment triggers
|
|
566
|
+
*
|
|
567
|
+
* **Required scope:**
|
|
568
|
+
*
|
|
569
|
+
* `assets.form_assignment_triggers:read`
|
|
570
|
+
*
|
|
571
|
+
*/
|
|
572
|
+
static listFormAssignmentTriggers(options) {
|
|
573
|
+
return (options?.client ?? client).get({
|
|
574
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
575
|
+
url: '/api/v1/assets/form_assignment_triggers',
|
|
576
|
+
...options
|
|
577
|
+
});
|
|
578
|
+
}
|
|
579
|
+
/**
|
|
580
|
+
* Create Form Assignment Trigger
|
|
581
|
+
*
|
|
582
|
+
* **Required scope:**
|
|
583
|
+
*
|
|
584
|
+
* `assets.form_assignment_triggers:create`
|
|
585
|
+
*
|
|
586
|
+
*/
|
|
587
|
+
static createFormAssignmentTrigger(options) {
|
|
588
|
+
return (options.client ?? client).post({
|
|
589
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
590
|
+
url: '/api/v1/assets/form_assignment_triggers',
|
|
591
|
+
...options,
|
|
592
|
+
headers: {
|
|
593
|
+
'Content-Type': 'application/json',
|
|
594
|
+
...options.headers
|
|
595
|
+
}
|
|
596
|
+
});
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* Delete Form Assignment Trigger
|
|
600
|
+
*
|
|
601
|
+
* **Required scope:**
|
|
602
|
+
*
|
|
603
|
+
* `assets.form_assignment_triggers:delete`
|
|
604
|
+
*
|
|
605
|
+
*/
|
|
606
|
+
static deleteFormAssignmentTrigger(options) {
|
|
607
|
+
return (options.client ?? client).delete({
|
|
608
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
609
|
+
url: '/api/v1/assets/form_assignment_triggers/{id}',
|
|
610
|
+
...options
|
|
611
|
+
});
|
|
612
|
+
}
|
|
613
|
+
/**
|
|
614
|
+
* Show form assignment trigger
|
|
615
|
+
*
|
|
616
|
+
* **Required scope:**
|
|
617
|
+
*
|
|
618
|
+
* `assets.form_assignment_triggers:read`
|
|
619
|
+
*
|
|
620
|
+
*/
|
|
621
|
+
static getFormAssignmentTrigger(options) {
|
|
622
|
+
return (options.client ?? client).get({
|
|
623
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
624
|
+
url: '/api/v1/assets/form_assignment_triggers/{id}',
|
|
625
|
+
...options
|
|
626
|
+
});
|
|
627
|
+
}
|
|
628
|
+
/**
|
|
629
|
+
* Update Form Assignment Trigger
|
|
630
|
+
*
|
|
631
|
+
* **Required scope:**
|
|
632
|
+
*
|
|
633
|
+
* `assets.form_assignment_triggers:update`
|
|
634
|
+
*
|
|
635
|
+
*/
|
|
636
|
+
static updateFormAssignmentTrigger(options) {
|
|
637
|
+
return (options.client ?? client).patch({
|
|
638
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
639
|
+
url: '/api/v1/assets/form_assignment_triggers/{id}',
|
|
640
|
+
...options,
|
|
641
|
+
headers: {
|
|
642
|
+
'Content-Type': 'application/json',
|
|
643
|
+
...options.headers
|
|
644
|
+
}
|
|
645
|
+
});
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
export class AssetsInventories {
|
|
649
|
+
/**
|
|
650
|
+
* List inventories
|
|
651
|
+
*
|
|
652
|
+
* **Required scope:**
|
|
653
|
+
*
|
|
654
|
+
* `assets.inventories:read`
|
|
655
|
+
*
|
|
656
|
+
*/
|
|
657
|
+
static listInventories(options) {
|
|
658
|
+
return (options?.client ?? client).get({
|
|
659
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
660
|
+
url: '/api/v1/assets/inventories',
|
|
661
|
+
...options
|
|
662
|
+
});
|
|
663
|
+
}
|
|
664
|
+
/**
|
|
665
|
+
* Show inventory
|
|
666
|
+
*
|
|
667
|
+
* **Required scope:**
|
|
668
|
+
*
|
|
669
|
+
* `assets.inventories:read`
|
|
670
|
+
*
|
|
671
|
+
*/
|
|
672
|
+
static getInventory(options) {
|
|
673
|
+
return (options.client ?? client).get({
|
|
674
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
675
|
+
url: '/api/v1/assets/inventories/{id}',
|
|
676
|
+
...options
|
|
677
|
+
});
|
|
678
|
+
}
|
|
679
|
+
}
|
|
680
|
+
export class AssetsItems {
|
|
681
|
+
/**
|
|
682
|
+
* List items
|
|
683
|
+
*
|
|
684
|
+
* **Required scope:**
|
|
685
|
+
*
|
|
686
|
+
* `assets.items:read`
|
|
687
|
+
*
|
|
688
|
+
*/
|
|
689
|
+
static listItems(options) {
|
|
690
|
+
return (options?.client ?? client).get({
|
|
691
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
692
|
+
url: '/api/v1/assets/items',
|
|
693
|
+
...options
|
|
694
|
+
});
|
|
695
|
+
}
|
|
696
|
+
/**
|
|
697
|
+
* Create item (serial)
|
|
698
|
+
*
|
|
699
|
+
* **Required scope:**
|
|
700
|
+
*
|
|
701
|
+
* `assets.items:create`
|
|
702
|
+
*
|
|
703
|
+
*/
|
|
704
|
+
static createItem(options) {
|
|
705
|
+
return (options.client ?? client).post({
|
|
706
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
707
|
+
url: '/api/v1/assets/items',
|
|
708
|
+
...options,
|
|
709
|
+
headers: {
|
|
710
|
+
'Content-Type': 'application/json',
|
|
711
|
+
...options.headers
|
|
712
|
+
}
|
|
713
|
+
});
|
|
714
|
+
}
|
|
715
|
+
/**
|
|
716
|
+
* Delete item
|
|
717
|
+
*
|
|
718
|
+
* **Required scope:**
|
|
719
|
+
*
|
|
720
|
+
* `assets.items:delete`
|
|
721
|
+
*
|
|
722
|
+
*/
|
|
723
|
+
static deleteItem(options) {
|
|
724
|
+
return (options.client ?? client).delete({
|
|
725
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
726
|
+
url: '/api/v1/assets/items/{id}',
|
|
727
|
+
...options
|
|
728
|
+
});
|
|
729
|
+
}
|
|
730
|
+
/**
|
|
731
|
+
* Show item
|
|
732
|
+
*
|
|
733
|
+
* **Required scope:**
|
|
734
|
+
*
|
|
735
|
+
* `assets.items:read`
|
|
736
|
+
*
|
|
737
|
+
*/
|
|
738
|
+
static getItem(options) {
|
|
739
|
+
return (options.client ?? client).get({
|
|
740
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
741
|
+
url: '/api/v1/assets/items/{id}',
|
|
742
|
+
...options
|
|
743
|
+
});
|
|
744
|
+
}
|
|
745
|
+
/**
|
|
746
|
+
* Update item
|
|
747
|
+
*
|
|
748
|
+
* **Required scope:**
|
|
749
|
+
*
|
|
750
|
+
* `assets.items:update`
|
|
751
|
+
*
|
|
752
|
+
*/
|
|
753
|
+
static updateItem(options) {
|
|
754
|
+
return (options.client ?? client).patch({
|
|
755
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
756
|
+
url: '/api/v1/assets/items/{id}',
|
|
757
|
+
...options,
|
|
758
|
+
headers: {
|
|
759
|
+
'Content-Type': 'application/json',
|
|
760
|
+
...options.headers
|
|
761
|
+
}
|
|
762
|
+
});
|
|
763
|
+
}
|
|
764
|
+
/**
|
|
765
|
+
* Unretire item
|
|
766
|
+
*
|
|
767
|
+
* **Required scope:**
|
|
768
|
+
*
|
|
769
|
+
* `assets.items.retirements:delete`
|
|
770
|
+
*
|
|
771
|
+
*/
|
|
772
|
+
static unretireItem(options) {
|
|
773
|
+
return (options.client ?? client).delete({
|
|
774
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
775
|
+
url: '/api/v1/assets/items/{item_id}/retirement',
|
|
776
|
+
...options
|
|
777
|
+
});
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* Retire item
|
|
781
|
+
*
|
|
782
|
+
* **Required scope:**
|
|
783
|
+
*
|
|
784
|
+
* `assets.items.retirements:create`
|
|
785
|
+
*
|
|
786
|
+
*/
|
|
787
|
+
static retireItem(options) {
|
|
788
|
+
return (options.client ?? client).post({
|
|
789
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
790
|
+
url: '/api/v1/assets/items/{item_id}/retirement',
|
|
791
|
+
...options,
|
|
792
|
+
headers: {
|
|
793
|
+
'Content-Type': 'application/json',
|
|
794
|
+
...options.headers
|
|
795
|
+
}
|
|
796
|
+
});
|
|
797
|
+
}
|
|
798
|
+
/**
|
|
799
|
+
* List service schedules
|
|
800
|
+
*
|
|
801
|
+
* **Required scope:**
|
|
802
|
+
*
|
|
803
|
+
* `assets.items.service_schedules:read`
|
|
804
|
+
*
|
|
805
|
+
*/
|
|
806
|
+
static listServiceSchedules(options) {
|
|
807
|
+
return (options.client ?? client).get({
|
|
808
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
809
|
+
url: '/api/v1/assets/items/{item_id}/service_schedules',
|
|
810
|
+
...options
|
|
811
|
+
});
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* Create service schedule
|
|
815
|
+
*
|
|
816
|
+
* **Required scope:**
|
|
817
|
+
*
|
|
818
|
+
* `assets.items.service_schedules:create`
|
|
819
|
+
*
|
|
820
|
+
*/
|
|
821
|
+
static createServiceSchedule(options) {
|
|
822
|
+
return (options.client ?? client).post({
|
|
823
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
824
|
+
url: '/api/v1/assets/items/{item_id}/service_schedules',
|
|
825
|
+
...options,
|
|
826
|
+
headers: {
|
|
827
|
+
'Content-Type': 'application/json',
|
|
828
|
+
...options.headers
|
|
829
|
+
}
|
|
830
|
+
});
|
|
831
|
+
}
|
|
832
|
+
/**
|
|
833
|
+
* Delete service schedule
|
|
834
|
+
*
|
|
835
|
+
* **Required scope:**
|
|
836
|
+
*
|
|
837
|
+
* `assets.items.service_schedules:delete`
|
|
838
|
+
*
|
|
839
|
+
*/
|
|
840
|
+
static deleteServiceSchedule(options) {
|
|
841
|
+
return (options.client ?? client).delete({
|
|
842
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
843
|
+
url: '/api/v1/assets/items/{item_id}/service_schedules/{id}',
|
|
844
|
+
...options
|
|
845
|
+
});
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* Show service schedule
|
|
849
|
+
*
|
|
850
|
+
* **Required scope:**
|
|
851
|
+
*
|
|
852
|
+
* `assets.items.service_schedules:read`
|
|
853
|
+
*
|
|
854
|
+
*/
|
|
855
|
+
static getServiceSchedule(options) {
|
|
856
|
+
return (options.client ?? client).get({
|
|
857
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
858
|
+
url: '/api/v1/assets/items/{item_id}/service_schedules/{id}',
|
|
859
|
+
...options
|
|
860
|
+
});
|
|
861
|
+
}
|
|
862
|
+
/**
|
|
863
|
+
* Update service schedule
|
|
864
|
+
*
|
|
865
|
+
* **Required scope:**
|
|
866
|
+
*
|
|
867
|
+
* `assets.items.service_schedules:update`
|
|
868
|
+
*
|
|
869
|
+
*/
|
|
870
|
+
static updateServiceSchedule(options) {
|
|
871
|
+
return (options.client ?? client).patch({
|
|
872
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
873
|
+
url: '/api/v1/assets/items/{item_id}/service_schedules/{id}',
|
|
874
|
+
...options,
|
|
875
|
+
headers: {
|
|
876
|
+
'Content-Type': 'application/json',
|
|
877
|
+
...options.headers
|
|
878
|
+
}
|
|
879
|
+
});
|
|
880
|
+
}
|
|
881
|
+
/**
|
|
882
|
+
* List service events
|
|
883
|
+
*
|
|
884
|
+
* **Required scope:**
|
|
885
|
+
*
|
|
886
|
+
* `assets.items.service_events:read`
|
|
887
|
+
*
|
|
888
|
+
*/
|
|
889
|
+
static listServiceEvents(options) {
|
|
890
|
+
return (options.client ?? client).get({
|
|
891
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
892
|
+
url: '/api/v1/assets/items/{item_id}/service_events',
|
|
893
|
+
...options
|
|
894
|
+
});
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
* Create service event
|
|
898
|
+
*
|
|
899
|
+
* **Required scope:**
|
|
900
|
+
*
|
|
901
|
+
* `assets.items.service_events:create`
|
|
902
|
+
*
|
|
903
|
+
*/
|
|
904
|
+
static createServiceEvent(options) {
|
|
905
|
+
return (options.client ?? client).post({
|
|
906
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
907
|
+
url: '/api/v1/assets/items/{item_id}/service_events',
|
|
908
|
+
...options,
|
|
909
|
+
headers: {
|
|
910
|
+
'Content-Type': 'application/json',
|
|
911
|
+
...options.headers
|
|
912
|
+
}
|
|
913
|
+
});
|
|
914
|
+
}
|
|
915
|
+
/**
|
|
916
|
+
* Delete service event
|
|
917
|
+
*
|
|
918
|
+
* **Required scope:**
|
|
919
|
+
*
|
|
920
|
+
* `assets.items.service_events:delete`
|
|
921
|
+
*
|
|
922
|
+
*/
|
|
923
|
+
static deleteServiceEvent(options) {
|
|
924
|
+
return (options.client ?? client).delete({
|
|
925
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
926
|
+
url: '/api/v1/assets/items/{item_id}/service_events/{id}',
|
|
927
|
+
...options
|
|
928
|
+
});
|
|
929
|
+
}
|
|
930
|
+
/**
|
|
931
|
+
* Show service event
|
|
932
|
+
*
|
|
933
|
+
* **Required scope:**
|
|
934
|
+
*
|
|
935
|
+
* `assets.items.service_events:read`
|
|
936
|
+
*
|
|
937
|
+
*/
|
|
938
|
+
static getServiceEvent(options) {
|
|
939
|
+
return (options.client ?? client).get({
|
|
940
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
941
|
+
url: '/api/v1/assets/items/{item_id}/service_events/{id}',
|
|
942
|
+
...options
|
|
943
|
+
});
|
|
944
|
+
}
|
|
945
|
+
/**
|
|
946
|
+
* Update service event
|
|
947
|
+
*
|
|
948
|
+
* **Required scope:**
|
|
949
|
+
*
|
|
950
|
+
* `assets.items.service_events:update`
|
|
951
|
+
*
|
|
952
|
+
*/
|
|
953
|
+
static updateServiceEvent(options) {
|
|
954
|
+
return (options.client ?? client).patch({
|
|
955
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
956
|
+
url: '/api/v1/assets/items/{item_id}/service_events/{id}',
|
|
957
|
+
...options,
|
|
958
|
+
headers: {
|
|
959
|
+
'Content-Type': 'application/json',
|
|
960
|
+
...options.headers
|
|
961
|
+
}
|
|
962
|
+
});
|
|
963
|
+
}
|
|
964
|
+
/**
|
|
965
|
+
* List form assignments
|
|
966
|
+
*
|
|
967
|
+
* **Required scope:**
|
|
968
|
+
*
|
|
969
|
+
* `assets.items.form_assignment_tasks:read`
|
|
970
|
+
*
|
|
971
|
+
*/
|
|
972
|
+
static listFormAssignmentTasks(options) {
|
|
973
|
+
return (options.client ?? client).get({
|
|
974
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
975
|
+
url: '/api/v1/assets/items/{item_id}/form_assignment_tasks',
|
|
976
|
+
...options
|
|
977
|
+
});
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* Create form assignment
|
|
981
|
+
*
|
|
982
|
+
* **Required scope:**
|
|
983
|
+
*
|
|
984
|
+
* `assets.items.form_assignment_tasks:create`
|
|
985
|
+
*
|
|
986
|
+
*/
|
|
987
|
+
static createItemFormAssignmentTask(options) {
|
|
988
|
+
return (options.client ?? client).post({
|
|
989
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
990
|
+
url: '/api/v1/assets/items/{item_id}/form_assignment_tasks',
|
|
991
|
+
...options,
|
|
992
|
+
headers: {
|
|
993
|
+
'Content-Type': 'application/json',
|
|
994
|
+
...options.headers
|
|
995
|
+
}
|
|
996
|
+
});
|
|
997
|
+
}
|
|
998
|
+
/**
|
|
999
|
+
* Show form assignment
|
|
1000
|
+
*
|
|
1001
|
+
* **Required scope:**
|
|
1002
|
+
*
|
|
1003
|
+
* `assets.items.form_assignment_tasks:read`
|
|
1004
|
+
*
|
|
1005
|
+
*/
|
|
1006
|
+
static getFormAssignmentTask(options) {
|
|
1007
|
+
return (options.client ?? client).get({
|
|
1008
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1009
|
+
url: '/api/v1/assets/items/{item_id}/form_assignment_tasks/{id}',
|
|
1010
|
+
...options
|
|
1011
|
+
});
|
|
1012
|
+
}
|
|
1013
|
+
/**
|
|
1014
|
+
* Update form assignment
|
|
1015
|
+
*
|
|
1016
|
+
* **Required scope:**
|
|
1017
|
+
*
|
|
1018
|
+
* `assets.items.form_assignment_tasks:update`
|
|
1019
|
+
*
|
|
1020
|
+
*/
|
|
1021
|
+
static updateFormAssignmentTask(options) {
|
|
1022
|
+
return (options.client ?? client).patch({
|
|
1023
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1024
|
+
url: '/api/v1/assets/items/{item_id}/form_assignment_tasks/{id}',
|
|
1025
|
+
...options,
|
|
1026
|
+
headers: {
|
|
1027
|
+
'Content-Type': 'application/json',
|
|
1028
|
+
...options.headers
|
|
1029
|
+
}
|
|
1030
|
+
});
|
|
1031
|
+
}
|
|
1032
|
+
/**
|
|
1033
|
+
* List documents
|
|
1034
|
+
*
|
|
1035
|
+
* **Required scope:**
|
|
1036
|
+
*
|
|
1037
|
+
* `assets.items.documents:read`
|
|
1038
|
+
*
|
|
1039
|
+
*/
|
|
1040
|
+
static listDocuments(options) {
|
|
1041
|
+
return (options.client ?? client).get({
|
|
1042
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1043
|
+
url: '/api/v1/assets/items/{item_id}/documents',
|
|
1044
|
+
...options
|
|
1045
|
+
});
|
|
1046
|
+
}
|
|
1047
|
+
/**
|
|
1048
|
+
* Create document
|
|
1049
|
+
*
|
|
1050
|
+
* **Required scope:**
|
|
1051
|
+
*
|
|
1052
|
+
* `assets.items.documents:create`
|
|
1053
|
+
*
|
|
1054
|
+
*/
|
|
1055
|
+
static createDocument(options) {
|
|
1056
|
+
return (options.client ?? client).post({
|
|
1057
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1058
|
+
url: '/api/v1/assets/items/{item_id}/documents',
|
|
1059
|
+
...options,
|
|
1060
|
+
headers: {
|
|
1061
|
+
'Content-Type': 'application/json',
|
|
1062
|
+
...options.headers
|
|
1063
|
+
}
|
|
1064
|
+
});
|
|
1065
|
+
}
|
|
1066
|
+
/**
|
|
1067
|
+
* Delete document
|
|
1068
|
+
*
|
|
1069
|
+
* **Required scope:**
|
|
1070
|
+
*
|
|
1071
|
+
* `assets.items.documents:delete`
|
|
1072
|
+
*
|
|
1073
|
+
*/
|
|
1074
|
+
static deleteDocument(options) {
|
|
1075
|
+
return (options.client ?? client).delete({
|
|
1076
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1077
|
+
url: '/api/v1/assets/items/{item_id}/documents/{id}',
|
|
1078
|
+
...options
|
|
1079
|
+
});
|
|
1080
|
+
}
|
|
1081
|
+
/**
|
|
1082
|
+
* Show document
|
|
1083
|
+
*
|
|
1084
|
+
* **Required scope:**
|
|
1085
|
+
*
|
|
1086
|
+
* `assets.items.documents:read`
|
|
1087
|
+
*
|
|
1088
|
+
*/
|
|
1089
|
+
static getDocument(options) {
|
|
1090
|
+
return (options.client ?? client).get({
|
|
1091
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1092
|
+
url: '/api/v1/assets/items/{item_id}/documents/{id}',
|
|
1093
|
+
...options
|
|
1094
|
+
});
|
|
1095
|
+
}
|
|
1096
|
+
/**
|
|
1097
|
+
* Update document
|
|
1098
|
+
*
|
|
1099
|
+
* **Required scope:**
|
|
1100
|
+
*
|
|
1101
|
+
* `assets.items.documents:update`
|
|
1102
|
+
*
|
|
1103
|
+
*/
|
|
1104
|
+
static updateDocument(options) {
|
|
1105
|
+
return (options.client ?? client).patch({
|
|
1106
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1107
|
+
url: '/api/v1/assets/items/{item_id}/documents/{id}',
|
|
1108
|
+
...options,
|
|
1109
|
+
headers: {
|
|
1110
|
+
'Content-Type': 'application/json',
|
|
1111
|
+
...options.headers
|
|
1112
|
+
}
|
|
1113
|
+
});
|
|
1114
|
+
}
|
|
1115
|
+
/**
|
|
1116
|
+
* List document versions
|
|
1117
|
+
*
|
|
1118
|
+
* **Required scope:**
|
|
1119
|
+
*
|
|
1120
|
+
* `assets.items.documents.versions:read`
|
|
1121
|
+
*
|
|
1122
|
+
*/
|
|
1123
|
+
static listVersions(options) {
|
|
1124
|
+
return (options.client ?? client).get({
|
|
1125
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1126
|
+
url: '/api/v1/assets/items/{item_id}/documents/{document_id}/versions',
|
|
1127
|
+
...options
|
|
1128
|
+
});
|
|
1129
|
+
}
|
|
1130
|
+
}
|
|
1131
|
+
export class AssetsProducts {
|
|
1132
|
+
/**
|
|
1133
|
+
* List products
|
|
1134
|
+
*
|
|
1135
|
+
* **Required scope:**
|
|
1136
|
+
*
|
|
1137
|
+
* `assets.products:read`
|
|
1138
|
+
*
|
|
1139
|
+
*/
|
|
1140
|
+
static listProducts(options) {
|
|
1141
|
+
return (options?.client ?? client).get({
|
|
1142
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1143
|
+
url: '/api/v1/assets/products',
|
|
1144
|
+
...options
|
|
1145
|
+
});
|
|
1146
|
+
}
|
|
1147
|
+
/**
|
|
1148
|
+
* Create Product
|
|
1149
|
+
*
|
|
1150
|
+
* **Required scope:**
|
|
1151
|
+
*
|
|
1152
|
+
* `assets.products:create`
|
|
1153
|
+
*
|
|
1154
|
+
*/
|
|
1155
|
+
static createProduct(options) {
|
|
1156
|
+
return (options.client ?? client).post({
|
|
1157
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1158
|
+
url: '/api/v1/assets/products',
|
|
1159
|
+
...options,
|
|
1160
|
+
headers: {
|
|
1161
|
+
'Content-Type': 'application/json',
|
|
1162
|
+
...options.headers
|
|
1163
|
+
}
|
|
1164
|
+
});
|
|
1165
|
+
}
|
|
1166
|
+
/**
|
|
1167
|
+
* Delete Product
|
|
1168
|
+
*
|
|
1169
|
+
* **Required scope:**
|
|
1170
|
+
*
|
|
1171
|
+
* `assets.products:delete`
|
|
1172
|
+
*
|
|
1173
|
+
*/
|
|
1174
|
+
static deleteProduct(options) {
|
|
1175
|
+
return (options.client ?? client).delete({
|
|
1176
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1177
|
+
url: '/api/v1/assets/products/{id}',
|
|
1178
|
+
...options
|
|
1179
|
+
});
|
|
1180
|
+
}
|
|
1181
|
+
/**
|
|
1182
|
+
* Show product
|
|
1183
|
+
*
|
|
1184
|
+
* **Required scope:**
|
|
1185
|
+
*
|
|
1186
|
+
* `assets.products:read`
|
|
1187
|
+
*
|
|
1188
|
+
*/
|
|
1189
|
+
static getProduct(options) {
|
|
1190
|
+
return (options.client ?? client).get({
|
|
1191
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1192
|
+
url: '/api/v1/assets/products/{id}',
|
|
1193
|
+
...options
|
|
1194
|
+
});
|
|
1195
|
+
}
|
|
1196
|
+
/**
|
|
1197
|
+
* Update Product
|
|
1198
|
+
*
|
|
1199
|
+
* **Required scope:**
|
|
1200
|
+
*
|
|
1201
|
+
* `assets.products:update`
|
|
1202
|
+
*
|
|
1203
|
+
*/
|
|
1204
|
+
static updateProduct(options) {
|
|
1205
|
+
return (options.client ?? client).patch({
|
|
1206
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1207
|
+
url: '/api/v1/assets/products/{id}',
|
|
1208
|
+
...options,
|
|
1209
|
+
headers: {
|
|
1210
|
+
'Content-Type': 'application/json',
|
|
1211
|
+
...options.headers
|
|
1212
|
+
}
|
|
1213
|
+
});
|
|
1214
|
+
}
|
|
1215
|
+
/**
|
|
1216
|
+
* Adjust inventory on-hand count
|
|
1217
|
+
*
|
|
1218
|
+
* **Required scope:**
|
|
1219
|
+
*
|
|
1220
|
+
* `assets.products.adjustments:create`
|
|
1221
|
+
*
|
|
1222
|
+
*/
|
|
1223
|
+
static adjustProductInventory(options) {
|
|
1224
|
+
return (options.client ?? client).post({
|
|
1225
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1226
|
+
url: '/api/v1/assets/products/{product_id}/adjustments',
|
|
1227
|
+
...options,
|
|
1228
|
+
headers: {
|
|
1229
|
+
'Content-Type': 'application/json',
|
|
1230
|
+
...options.headers
|
|
1231
|
+
}
|
|
1232
|
+
});
|
|
1233
|
+
}
|
|
1234
|
+
/**
|
|
1235
|
+
* Restock bulk product at site
|
|
1236
|
+
*
|
|
1237
|
+
* **Required scope:**
|
|
1238
|
+
*
|
|
1239
|
+
* `assets.products.restocks:create`
|
|
1240
|
+
*
|
|
1241
|
+
*/
|
|
1242
|
+
static restockProduct(options) {
|
|
1243
|
+
return (options.client ?? client).post({
|
|
1244
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1245
|
+
url: '/api/v1/assets/products/{product_id}/restocks',
|
|
1246
|
+
...options,
|
|
1247
|
+
headers: {
|
|
1248
|
+
'Content-Type': 'application/json',
|
|
1249
|
+
...options.headers
|
|
1250
|
+
}
|
|
1251
|
+
});
|
|
1252
|
+
}
|
|
1253
|
+
/**
|
|
1254
|
+
* List service schedule templates
|
|
1255
|
+
*
|
|
1256
|
+
* **Required scope:**
|
|
1257
|
+
*
|
|
1258
|
+
* `assets.products.service_schedule_templates:read`
|
|
1259
|
+
*
|
|
1260
|
+
*/
|
|
1261
|
+
static listServiceScheduleTemplates(options) {
|
|
1262
|
+
return (options.client ?? client).get({
|
|
1263
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1264
|
+
url: '/api/v1/assets/products/{product_id}/service_schedule_templates',
|
|
1265
|
+
...options
|
|
1266
|
+
});
|
|
1267
|
+
}
|
|
1268
|
+
/**
|
|
1269
|
+
* Create service schedule template
|
|
1270
|
+
*
|
|
1271
|
+
* **Required scope:**
|
|
1272
|
+
*
|
|
1273
|
+
* `assets.products.service_schedule_templates:create`
|
|
1274
|
+
*
|
|
1275
|
+
*/
|
|
1276
|
+
static createServiceScheduleTemplate(options) {
|
|
1277
|
+
return (options.client ?? client).post({
|
|
1278
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1279
|
+
url: '/api/v1/assets/products/{product_id}/service_schedule_templates',
|
|
1280
|
+
...options,
|
|
1281
|
+
headers: {
|
|
1282
|
+
'Content-Type': 'application/json',
|
|
1283
|
+
...options.headers
|
|
1284
|
+
}
|
|
1285
|
+
});
|
|
1286
|
+
}
|
|
1287
|
+
/**
|
|
1288
|
+
* Delete service schedule template
|
|
1289
|
+
*
|
|
1290
|
+
* **Required scope:**
|
|
1291
|
+
*
|
|
1292
|
+
* `assets.products.service_schedule_templates:delete`
|
|
1293
|
+
*
|
|
1294
|
+
*/
|
|
1295
|
+
static deleteServiceScheduleTemplate(options) {
|
|
1296
|
+
return (options.client ?? client).delete({
|
|
1297
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1298
|
+
url: '/api/v1/assets/products/{product_id}/service_schedule_templates/{id}',
|
|
1299
|
+
...options
|
|
1300
|
+
});
|
|
1301
|
+
}
|
|
1302
|
+
/**
|
|
1303
|
+
* Show service schedule template
|
|
1304
|
+
*
|
|
1305
|
+
* **Required scope:**
|
|
1306
|
+
*
|
|
1307
|
+
* `assets.products.service_schedule_templates:read`
|
|
1308
|
+
*
|
|
1309
|
+
*/
|
|
1310
|
+
static getServiceScheduleTemplate(options) {
|
|
1311
|
+
return (options.client ?? client).get({
|
|
1312
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1313
|
+
url: '/api/v1/assets/products/{product_id}/service_schedule_templates/{id}',
|
|
1314
|
+
...options
|
|
1315
|
+
});
|
|
1316
|
+
}
|
|
1317
|
+
/**
|
|
1318
|
+
* Update service schedule template
|
|
1319
|
+
*
|
|
1320
|
+
* **Required scope:**
|
|
1321
|
+
*
|
|
1322
|
+
* `assets.products.service_schedule_templates:update`
|
|
1323
|
+
*
|
|
1324
|
+
*/
|
|
1325
|
+
static updateServiceScheduleTemplate(options) {
|
|
1326
|
+
return (options.client ?? client).patch({
|
|
1327
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1328
|
+
url: '/api/v1/assets/products/{product_id}/service_schedule_templates/{id}',
|
|
1329
|
+
...options,
|
|
1330
|
+
headers: {
|
|
1331
|
+
'Content-Type': 'application/json',
|
|
1332
|
+
...options.headers
|
|
1333
|
+
}
|
|
1334
|
+
});
|
|
1335
|
+
}
|
|
1336
|
+
/**
|
|
1337
|
+
* Seed template schedules onto items
|
|
1338
|
+
*
|
|
1339
|
+
* **Required scope:**
|
|
1340
|
+
*
|
|
1341
|
+
* `assets.products.service_schedule_templates.seeds:create`
|
|
1342
|
+
*
|
|
1343
|
+
*/
|
|
1344
|
+
static seedServiceScheduleTemplate(options) {
|
|
1345
|
+
return (options.client ?? client).post({
|
|
1346
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1347
|
+
url: '/api/v1/assets/products/{product_id}/service_schedule_templates/{service_schedule_template_id}/seeds',
|
|
1348
|
+
...options,
|
|
1349
|
+
headers: {
|
|
1350
|
+
'Content-Type': 'application/json',
|
|
1351
|
+
...options.headers
|
|
1352
|
+
}
|
|
1353
|
+
});
|
|
1354
|
+
}
|
|
1355
|
+
/**
|
|
1356
|
+
* Sync blocked schedules to template cadence
|
|
1357
|
+
*
|
|
1358
|
+
* **Required scope:**
|
|
1359
|
+
*
|
|
1360
|
+
* `assets.products.service_schedule_templates.syncs:create`
|
|
1361
|
+
*
|
|
1362
|
+
*/
|
|
1363
|
+
static syncServiceScheduleTemplate(options) {
|
|
1364
|
+
return (options.client ?? client).post({
|
|
1365
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1366
|
+
url: '/api/v1/assets/products/{product_id}/service_schedule_templates/{service_schedule_template_id}/syncs',
|
|
1367
|
+
...options,
|
|
1368
|
+
headers: {
|
|
1369
|
+
'Content-Type': 'application/json',
|
|
1370
|
+
...options.headers
|
|
1371
|
+
}
|
|
1372
|
+
});
|
|
1373
|
+
}
|
|
1374
|
+
}
|
|
1375
|
+
export class AssetsSites {
|
|
1376
|
+
/**
|
|
1377
|
+
* List sites
|
|
1378
|
+
*
|
|
1379
|
+
* **Required scope:**
|
|
1380
|
+
*
|
|
1381
|
+
* `assets.sites:read`
|
|
1382
|
+
*
|
|
1383
|
+
*/
|
|
1384
|
+
static listAssetsSites(options) {
|
|
1385
|
+
return (options?.client ?? client).get({
|
|
1386
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1387
|
+
url: '/api/v1/assets/sites',
|
|
1388
|
+
...options
|
|
1389
|
+
});
|
|
1390
|
+
}
|
|
1391
|
+
/**
|
|
1392
|
+
* Create Site
|
|
1393
|
+
*
|
|
1394
|
+
* **Required scope:**
|
|
1395
|
+
*
|
|
1396
|
+
* `assets.sites:create`
|
|
1397
|
+
*
|
|
1398
|
+
*/
|
|
1399
|
+
static createSite(options) {
|
|
1400
|
+
return (options.client ?? client).post({
|
|
1401
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1402
|
+
url: '/api/v1/assets/sites',
|
|
1403
|
+
...options,
|
|
1404
|
+
headers: {
|
|
1405
|
+
'Content-Type': 'application/json',
|
|
1406
|
+
...options.headers
|
|
1407
|
+
}
|
|
1408
|
+
});
|
|
1409
|
+
}
|
|
1410
|
+
/**
|
|
1411
|
+
* Delete Site
|
|
1412
|
+
*
|
|
1413
|
+
* **Required scope:**
|
|
1414
|
+
*
|
|
1415
|
+
* `assets.sites:delete`
|
|
1416
|
+
*
|
|
1417
|
+
*/
|
|
1418
|
+
static deleteSite(options) {
|
|
1419
|
+
return (options.client ?? client).delete({
|
|
1420
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1421
|
+
url: '/api/v1/assets/sites/{id}',
|
|
1422
|
+
...options
|
|
1423
|
+
});
|
|
1424
|
+
}
|
|
1425
|
+
/**
|
|
1426
|
+
* Show site
|
|
1427
|
+
*
|
|
1428
|
+
* **Required scope:**
|
|
1429
|
+
*
|
|
1430
|
+
* `assets.sites:read`
|
|
1431
|
+
*
|
|
1432
|
+
*/
|
|
1433
|
+
static getAssetsSite(options) {
|
|
1434
|
+
return (options.client ?? client).get({
|
|
1435
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1436
|
+
url: '/api/v1/assets/sites/{id}',
|
|
1437
|
+
...options
|
|
1438
|
+
});
|
|
1439
|
+
}
|
|
1440
|
+
/**
|
|
1441
|
+
* Update Site
|
|
1442
|
+
*
|
|
1443
|
+
* **Required scope:**
|
|
1444
|
+
*
|
|
1445
|
+
* `assets.sites:update`
|
|
1446
|
+
*
|
|
1447
|
+
*/
|
|
1448
|
+
static updateSite(options) {
|
|
1449
|
+
return (options.client ?? client).patch({
|
|
1450
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1451
|
+
url: '/api/v1/assets/sites/{id}',
|
|
1452
|
+
...options,
|
|
1453
|
+
headers: {
|
|
1454
|
+
'Content-Type': 'application/json',
|
|
1455
|
+
...options.headers
|
|
1456
|
+
}
|
|
1457
|
+
});
|
|
1458
|
+
}
|
|
1459
|
+
}
|
|
1460
|
+
export class AssetsTransfers {
|
|
1461
|
+
/**
|
|
1462
|
+
* List transfers
|
|
1463
|
+
*
|
|
1464
|
+
* **Required scope:**
|
|
1465
|
+
*
|
|
1466
|
+
* `assets.transfers:read`
|
|
1467
|
+
*
|
|
1468
|
+
*/
|
|
1469
|
+
static listTransfers(options) {
|
|
1470
|
+
return (options?.client ?? client).get({
|
|
1471
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1472
|
+
url: '/api/v1/assets/transfers',
|
|
1473
|
+
...options
|
|
1474
|
+
});
|
|
1475
|
+
}
|
|
1476
|
+
/**
|
|
1477
|
+
* Create transfer (site-to-site)
|
|
1478
|
+
*
|
|
1479
|
+
* **Required scope:**
|
|
1480
|
+
*
|
|
1481
|
+
* `assets.transfers:create`
|
|
1482
|
+
*
|
|
1483
|
+
*/
|
|
1484
|
+
static createTransfer(options) {
|
|
1485
|
+
return (options.client ?? client).post({
|
|
1486
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1487
|
+
url: '/api/v1/assets/transfers',
|
|
1488
|
+
...options,
|
|
1489
|
+
headers: {
|
|
1490
|
+
'Content-Type': 'application/json',
|
|
1491
|
+
...options.headers
|
|
1492
|
+
}
|
|
1493
|
+
});
|
|
1494
|
+
}
|
|
1495
|
+
/**
|
|
1496
|
+
* Show transfer
|
|
1497
|
+
*
|
|
1498
|
+
* **Required scope:**
|
|
1499
|
+
*
|
|
1500
|
+
* `assets.transfers:read`
|
|
1501
|
+
*
|
|
1502
|
+
*/
|
|
1503
|
+
static getTransfer(options) {
|
|
1504
|
+
return (options.client ?? client).get({
|
|
1505
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1506
|
+
url: '/api/v1/assets/transfers/{id}',
|
|
1507
|
+
...options
|
|
1508
|
+
});
|
|
1509
|
+
}
|
|
1510
|
+
}
|
|
1511
|
+
export class AssetsVendors {
|
|
1512
|
+
/**
|
|
1513
|
+
* List vendors
|
|
1514
|
+
*
|
|
1515
|
+
* **Required scope:**
|
|
1516
|
+
*
|
|
1517
|
+
* `assets.vendors:read`
|
|
1518
|
+
*
|
|
1519
|
+
*/
|
|
1520
|
+
static listVendors(options) {
|
|
1521
|
+
return (options?.client ?? client).get({
|
|
1522
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1523
|
+
url: '/api/v1/assets/vendors',
|
|
1524
|
+
...options
|
|
1525
|
+
});
|
|
1526
|
+
}
|
|
1527
|
+
/**
|
|
1528
|
+
* Create vendor
|
|
1529
|
+
*
|
|
1530
|
+
* **Required scope:**
|
|
1531
|
+
*
|
|
1532
|
+
* `assets.vendors:create`
|
|
1533
|
+
*
|
|
1534
|
+
*/
|
|
1535
|
+
static createVendor(options) {
|
|
1536
|
+
return (options.client ?? client).post({
|
|
1537
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1538
|
+
url: '/api/v1/assets/vendors',
|
|
1539
|
+
...options,
|
|
1540
|
+
headers: {
|
|
1541
|
+
'Content-Type': 'application/json',
|
|
1542
|
+
...options.headers
|
|
1543
|
+
}
|
|
1544
|
+
});
|
|
1545
|
+
}
|
|
1546
|
+
/**
|
|
1547
|
+
* Delete vendor
|
|
1548
|
+
*
|
|
1549
|
+
* **Required scope:**
|
|
1550
|
+
*
|
|
1551
|
+
* `assets.vendors:delete`
|
|
1552
|
+
*
|
|
1553
|
+
*/
|
|
1554
|
+
static deleteVendor(options) {
|
|
1555
|
+
return (options.client ?? client).delete({
|
|
1556
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1557
|
+
url: '/api/v1/assets/vendors/{id}',
|
|
1558
|
+
...options
|
|
1559
|
+
});
|
|
1560
|
+
}
|
|
1561
|
+
/**
|
|
1562
|
+
* Show vendor
|
|
1563
|
+
*
|
|
1564
|
+
* **Required scope:**
|
|
1565
|
+
*
|
|
1566
|
+
* `assets.vendors:read`
|
|
1567
|
+
*
|
|
1568
|
+
*/
|
|
1569
|
+
static getVendor(options) {
|
|
1570
|
+
return (options.client ?? client).get({
|
|
1571
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1572
|
+
url: '/api/v1/assets/vendors/{id}',
|
|
1573
|
+
...options
|
|
1574
|
+
});
|
|
1575
|
+
}
|
|
1576
|
+
/**
|
|
1577
|
+
* Update vendor
|
|
1578
|
+
*
|
|
1579
|
+
* **Required scope:**
|
|
1580
|
+
*
|
|
1581
|
+
* `assets.vendors:update`
|
|
1582
|
+
*
|
|
1583
|
+
*/
|
|
1584
|
+
static updateVendor(options) {
|
|
1585
|
+
return (options.client ?? client).patch({
|
|
1586
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1587
|
+
url: '/api/v1/assets/vendors/{id}',
|
|
1588
|
+
...options,
|
|
1589
|
+
headers: {
|
|
1590
|
+
'Content-Type': 'application/json',
|
|
1591
|
+
...options.headers
|
|
1592
|
+
}
|
|
1593
|
+
});
|
|
1594
|
+
}
|
|
1595
|
+
}
|
|
1596
|
+
export class AtlasFeatures {
|
|
1597
|
+
/**
|
|
1598
|
+
* List features
|
|
1599
|
+
*
|
|
1600
|
+
* **Required scope:**
|
|
1601
|
+
*
|
|
1602
|
+
* `atlas.features:read`
|
|
1603
|
+
*
|
|
1604
|
+
*/
|
|
1605
|
+
static listFeatures(options) {
|
|
1606
|
+
return (options?.client ?? client).get({
|
|
1607
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1608
|
+
url: '/api/v1/atlas/features',
|
|
1609
|
+
...options
|
|
1610
|
+
});
|
|
1611
|
+
}
|
|
1612
|
+
/**
|
|
1613
|
+
* Show feature
|
|
1614
|
+
*
|
|
1615
|
+
* **Required scope:**
|
|
1616
|
+
*
|
|
1617
|
+
* `atlas.features:read`
|
|
1618
|
+
*
|
|
1619
|
+
*/
|
|
1620
|
+
static getFeature(options) {
|
|
1621
|
+
return (options.client ?? client).get({
|
|
1622
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1623
|
+
url: '/api/v1/atlas/features/{id}',
|
|
1624
|
+
...options
|
|
1625
|
+
});
|
|
1626
|
+
}
|
|
1627
|
+
}
|
|
1628
|
+
export class AtlasSites {
|
|
1629
|
+
/**
|
|
1630
|
+
* List sites
|
|
1631
|
+
*
|
|
1632
|
+
* **Required scope:**
|
|
1633
|
+
*
|
|
1634
|
+
* `atlas.sites:read`
|
|
1635
|
+
*
|
|
1636
|
+
*/
|
|
1637
|
+
static listAtlasSites(options) {
|
|
1638
|
+
return (options?.client ?? client).get({
|
|
1639
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1640
|
+
url: '/api/v1/atlas/sites',
|
|
1641
|
+
...options
|
|
1642
|
+
});
|
|
1643
|
+
}
|
|
1644
|
+
/**
|
|
1645
|
+
* Show site
|
|
1646
|
+
*
|
|
1647
|
+
* **Required scope:**
|
|
1648
|
+
*
|
|
1649
|
+
* `atlas.sites:read`
|
|
1650
|
+
*
|
|
1651
|
+
*/
|
|
1652
|
+
static getAtlasSite(options) {
|
|
1653
|
+
return (options.client ?? client).get({
|
|
1654
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1655
|
+
url: '/api/v1/atlas/sites/{id}',
|
|
1656
|
+
...options
|
|
1657
|
+
});
|
|
1658
|
+
}
|
|
1659
|
+
}
|
|
1660
|
+
export class Billing {
|
|
1661
|
+
/**
|
|
1662
|
+
* List PWA user counts
|
|
1663
|
+
*
|
|
1664
|
+
* **Required scope:**
|
|
1665
|
+
*
|
|
1666
|
+
* `billing.pwa_user_counts_by_project_by_months:read`
|
|
1667
|
+
*
|
|
1668
|
+
*/
|
|
1669
|
+
static listPwaUserCountsByProjectByMonths(options) {
|
|
1670
|
+
return (options?.client ?? client).get({
|
|
1671
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1672
|
+
url: '/api/v1/billing/pwa_user_counts_by_project_by_months',
|
|
1673
|
+
...options
|
|
1674
|
+
});
|
|
1675
|
+
}
|
|
1676
|
+
}
|
|
1677
|
+
export class CertificationPackages {
|
|
1678
|
+
/**
|
|
1679
|
+
* List certification packages
|
|
1680
|
+
*
|
|
1681
|
+
* **Required scope:**
|
|
1682
|
+
*
|
|
1683
|
+
* `certifications.packages:read`
|
|
1684
|
+
*
|
|
1685
|
+
*/
|
|
1686
|
+
static listPackages(options) {
|
|
1687
|
+
return (options?.client ?? client).get({
|
|
1688
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1689
|
+
url: '/api/v1/certifications/packages',
|
|
1690
|
+
...options
|
|
1691
|
+
});
|
|
1692
|
+
}
|
|
1693
|
+
/**
|
|
1694
|
+
* Create certification package
|
|
1695
|
+
*
|
|
1696
|
+
* **Required scope:**
|
|
1697
|
+
*
|
|
1698
|
+
* `certifications.packages:create`
|
|
1699
|
+
*
|
|
1700
|
+
*/
|
|
1701
|
+
static createPackage(options) {
|
|
1702
|
+
return (options?.client ?? client).post({
|
|
1703
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1704
|
+
url: '/api/v1/certifications/packages',
|
|
1705
|
+
...options,
|
|
1706
|
+
headers: {
|
|
1707
|
+
'Content-Type': 'application/json',
|
|
1708
|
+
...options?.headers
|
|
1709
|
+
}
|
|
1710
|
+
});
|
|
1711
|
+
}
|
|
1712
|
+
/**
|
|
1713
|
+
* Delete certification package
|
|
1714
|
+
*
|
|
1715
|
+
* **Required scope:**
|
|
1716
|
+
*
|
|
1717
|
+
* `certifications.packages:delete`
|
|
1718
|
+
*
|
|
1719
|
+
*/
|
|
1720
|
+
static deletePackage(options) {
|
|
1721
|
+
return (options.client ?? client).delete({
|
|
1722
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1723
|
+
url: '/api/v1/certifications/packages/{id}',
|
|
1724
|
+
...options
|
|
1725
|
+
});
|
|
1726
|
+
}
|
|
1727
|
+
/**
|
|
1728
|
+
* Show certification package
|
|
1729
|
+
*
|
|
1730
|
+
* **Required scope:**
|
|
1731
|
+
*
|
|
1732
|
+
* `certifications.packages:read`
|
|
1733
|
+
*
|
|
1734
|
+
*/
|
|
1735
|
+
static getPackage(options) {
|
|
1736
|
+
return (options.client ?? client).get({
|
|
1737
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1738
|
+
url: '/api/v1/certifications/packages/{id}',
|
|
1739
|
+
...options
|
|
1740
|
+
});
|
|
1741
|
+
}
|
|
1742
|
+
/**
|
|
1743
|
+
* Update certification package
|
|
1744
|
+
*
|
|
1745
|
+
* **Required scope:**
|
|
1746
|
+
*
|
|
1747
|
+
* `certifications.packages:update`
|
|
1748
|
+
*
|
|
1749
|
+
*/
|
|
1750
|
+
static updatePackage(options) {
|
|
1751
|
+
return (options.client ?? client).patch({
|
|
1752
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1753
|
+
url: '/api/v1/certifications/packages/{id}',
|
|
1754
|
+
...options,
|
|
1755
|
+
headers: {
|
|
1756
|
+
'Content-Type': 'application/json',
|
|
1757
|
+
...options.headers
|
|
1758
|
+
}
|
|
1759
|
+
});
|
|
1760
|
+
}
|
|
1761
|
+
}
|
|
1762
|
+
export class UserCertifications {
|
|
1763
|
+
/**
|
|
1764
|
+
* List user certifications
|
|
1765
|
+
*
|
|
1766
|
+
* **Required scope:**
|
|
1767
|
+
*
|
|
1768
|
+
* `certifications.user_certifications:read`
|
|
1769
|
+
*
|
|
1770
|
+
*/
|
|
1771
|
+
static listUserCertifications(options) {
|
|
1772
|
+
return (options?.client ?? client).get({
|
|
1773
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1774
|
+
url: '/api/v1/certifications/user_certifications',
|
|
1775
|
+
...options
|
|
1776
|
+
});
|
|
1777
|
+
}
|
|
1778
|
+
/**
|
|
1779
|
+
* Create user certification
|
|
1780
|
+
*
|
|
1781
|
+
* **Required scope:**
|
|
1782
|
+
*
|
|
1783
|
+
* `certifications.user_certifications:create`
|
|
1784
|
+
*
|
|
1785
|
+
*/
|
|
1786
|
+
static createUserCertification(options) {
|
|
1787
|
+
return (options?.client ?? client).post({
|
|
1788
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1789
|
+
url: '/api/v1/certifications/user_certifications',
|
|
1790
|
+
...options,
|
|
1791
|
+
headers: {
|
|
1792
|
+
'Content-Type': 'application/json',
|
|
1793
|
+
...options?.headers
|
|
1794
|
+
}
|
|
1795
|
+
});
|
|
1796
|
+
}
|
|
1797
|
+
/**
|
|
1798
|
+
* Delete user certification
|
|
1799
|
+
*
|
|
1800
|
+
* **Required scope:**
|
|
1801
|
+
*
|
|
1802
|
+
* `certifications.user_certifications:delete`
|
|
1803
|
+
*
|
|
1804
|
+
*/
|
|
1805
|
+
static deleteUserCertification(options) {
|
|
1806
|
+
return (options.client ?? client).delete({
|
|
1807
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1808
|
+
url: '/api/v1/certifications/user_certifications/{id}',
|
|
1809
|
+
...options
|
|
1810
|
+
});
|
|
1811
|
+
}
|
|
1812
|
+
/**
|
|
1813
|
+
* Show user certification
|
|
1814
|
+
*
|
|
1815
|
+
* **Required scope:**
|
|
1816
|
+
*
|
|
1817
|
+
* `certifications.user_certifications:read`
|
|
1818
|
+
*
|
|
1819
|
+
*/
|
|
1820
|
+
static getUserCertification(options) {
|
|
1821
|
+
return (options.client ?? client).get({
|
|
1822
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1823
|
+
url: '/api/v1/certifications/user_certifications/{id}',
|
|
1824
|
+
...options
|
|
1825
|
+
});
|
|
1826
|
+
}
|
|
1827
|
+
/**
|
|
1828
|
+
* Update user certification
|
|
1829
|
+
*
|
|
1830
|
+
* **Required scope:**
|
|
1831
|
+
*
|
|
1832
|
+
* `certifications.user_certifications:update`
|
|
1833
|
+
*
|
|
1834
|
+
*/
|
|
1835
|
+
static updateUserCertification(options) {
|
|
1836
|
+
return (options.client ?? client).patch({
|
|
1837
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1838
|
+
url: '/api/v1/certifications/user_certifications/{id}',
|
|
1839
|
+
...options,
|
|
1840
|
+
headers: {
|
|
1841
|
+
'Content-Type': 'application/json',
|
|
1842
|
+
...options.headers
|
|
1843
|
+
}
|
|
1844
|
+
});
|
|
1845
|
+
}
|
|
1846
|
+
}
|
|
1847
|
+
export class Certifications {
|
|
1848
|
+
/**
|
|
1849
|
+
* List certifications
|
|
1850
|
+
*
|
|
1851
|
+
* **Required scope:**
|
|
1852
|
+
*
|
|
1853
|
+
* `certifications:read`
|
|
1854
|
+
*
|
|
1855
|
+
*/
|
|
1856
|
+
static listCertifications(options) {
|
|
1857
|
+
return (options?.client ?? client).get({
|
|
1858
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1859
|
+
url: '/api/v1/certifications',
|
|
1860
|
+
...options
|
|
1861
|
+
});
|
|
1862
|
+
}
|
|
1863
|
+
/**
|
|
1864
|
+
* Create certification
|
|
1865
|
+
*
|
|
1866
|
+
* **Required scope:**
|
|
1867
|
+
*
|
|
1868
|
+
* `certifications:create`
|
|
1869
|
+
*
|
|
1870
|
+
*/
|
|
1871
|
+
static createCertification(options) {
|
|
1872
|
+
return (options?.client ?? client).post({
|
|
1873
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1874
|
+
url: '/api/v1/certifications',
|
|
1875
|
+
...options,
|
|
1876
|
+
headers: {
|
|
1877
|
+
'Content-Type': 'application/json',
|
|
1878
|
+
...options?.headers
|
|
1879
|
+
}
|
|
1880
|
+
});
|
|
1881
|
+
}
|
|
1882
|
+
/**
|
|
1883
|
+
* Delete certification
|
|
1884
|
+
*
|
|
1885
|
+
* **Required scope:**
|
|
1886
|
+
*
|
|
1887
|
+
* `certifications:delete`
|
|
1888
|
+
*
|
|
1889
|
+
*/
|
|
1890
|
+
static deleteCertification(options) {
|
|
1891
|
+
return (options.client ?? client).delete({
|
|
1892
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1893
|
+
url: '/api/v1/certifications/{id}',
|
|
1894
|
+
...options
|
|
1895
|
+
});
|
|
1896
|
+
}
|
|
1897
|
+
/**
|
|
1898
|
+
* Show certification
|
|
1899
|
+
*
|
|
1900
|
+
* **Required scope:**
|
|
1901
|
+
*
|
|
1902
|
+
* `certifications:read`
|
|
1903
|
+
*
|
|
1904
|
+
*/
|
|
1905
|
+
static getCertification(options) {
|
|
1906
|
+
return (options.client ?? client).get({
|
|
1907
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1908
|
+
url: '/api/v1/certifications/{id}',
|
|
1909
|
+
...options
|
|
1910
|
+
});
|
|
1911
|
+
}
|
|
1912
|
+
/**
|
|
1913
|
+
* Update certification
|
|
1914
|
+
*
|
|
1915
|
+
* **Required scope:**
|
|
1916
|
+
*
|
|
1917
|
+
* `certifications:update`
|
|
1918
|
+
*
|
|
1919
|
+
*/
|
|
1920
|
+
static updateCertification(options) {
|
|
1921
|
+
return (options.client ?? client).patch({
|
|
1922
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1923
|
+
url: '/api/v1/certifications/{id}',
|
|
1924
|
+
...options,
|
|
1925
|
+
headers: {
|
|
1926
|
+
'Content-Type': 'application/json',
|
|
1927
|
+
...options.headers
|
|
1928
|
+
}
|
|
1929
|
+
});
|
|
1930
|
+
}
|
|
1931
|
+
}
|
|
1932
|
+
export class CompaniesDepartments {
|
|
1933
|
+
/**
|
|
1934
|
+
* List departments
|
|
1935
|
+
*
|
|
1936
|
+
* **Required scope:**
|
|
1937
|
+
*
|
|
1938
|
+
* `companies.departments:read`
|
|
1939
|
+
*
|
|
1940
|
+
*/
|
|
1941
|
+
static listDepartments(options) {
|
|
1942
|
+
return (options?.client ?? client).get({
|
|
1943
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1944
|
+
url: '/api/v1/companies/departments',
|
|
1945
|
+
...options
|
|
1946
|
+
});
|
|
1947
|
+
}
|
|
1948
|
+
/**
|
|
1949
|
+
* Create department
|
|
1950
|
+
*
|
|
1951
|
+
* **Required scope:**
|
|
1952
|
+
*
|
|
1953
|
+
* `companies.departments:create`
|
|
1954
|
+
*
|
|
1955
|
+
*/
|
|
1956
|
+
static createDepartment(options) {
|
|
1957
|
+
return (options.client ?? client).post({
|
|
1958
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1959
|
+
url: '/api/v1/companies/departments',
|
|
1960
|
+
...options,
|
|
1961
|
+
headers: {
|
|
1962
|
+
'Content-Type': 'application/json',
|
|
1963
|
+
...options.headers
|
|
1964
|
+
}
|
|
1965
|
+
});
|
|
1966
|
+
}
|
|
1967
|
+
/**
|
|
1968
|
+
* Update department
|
|
1969
|
+
*
|
|
1970
|
+
* **Required scope:**
|
|
1971
|
+
*
|
|
1972
|
+
* `companies.departments:update`
|
|
1973
|
+
*
|
|
1974
|
+
*/
|
|
1975
|
+
static updateDepartment(options) {
|
|
1976
|
+
return (options.client ?? client).patch({
|
|
1977
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1978
|
+
url: '/api/v1/companies/departments/{id}',
|
|
1979
|
+
...options,
|
|
1980
|
+
headers: {
|
|
1981
|
+
'Content-Type': 'application/json',
|
|
1982
|
+
...options.headers
|
|
1983
|
+
}
|
|
1984
|
+
});
|
|
1985
|
+
}
|
|
1986
|
+
}
|
|
1987
|
+
export class Companies {
|
|
1988
|
+
/**
|
|
1989
|
+
* List Companies
|
|
1990
|
+
*
|
|
1991
|
+
* **Required scope:**
|
|
1992
|
+
*
|
|
1993
|
+
* `companies:read`
|
|
1994
|
+
*
|
|
1995
|
+
*/
|
|
1996
|
+
static listCompanies(options) {
|
|
1997
|
+
return (options?.client ?? client).get({
|
|
1998
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
1999
|
+
url: '/api/v1/companies',
|
|
2000
|
+
...options
|
|
2001
|
+
});
|
|
2002
|
+
}
|
|
2003
|
+
/**
|
|
2004
|
+
* Show Company
|
|
2005
|
+
*
|
|
2006
|
+
* **Required scope:**
|
|
2007
|
+
*
|
|
2008
|
+
* `companies:read`
|
|
2009
|
+
*
|
|
2010
|
+
*/
|
|
2011
|
+
static getCompany(options) {
|
|
2012
|
+
return (options.client ?? client).get({
|
|
2013
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2014
|
+
url: '/api/v1/companies/{id}',
|
|
2015
|
+
...options
|
|
2016
|
+
});
|
|
2017
|
+
}
|
|
2018
|
+
}
|
|
2019
|
+
export class ComplianceChecks {
|
|
2020
|
+
/**
|
|
2021
|
+
* List compliance checks
|
|
2022
|
+
*
|
|
2023
|
+
* **Required scope:**
|
|
2024
|
+
*
|
|
2025
|
+
* `compliance.checks:read`
|
|
2026
|
+
*
|
|
2027
|
+
*/
|
|
2028
|
+
static listChecks(options) {
|
|
2029
|
+
return (options?.client ?? client).get({
|
|
2030
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2031
|
+
url: '/api/v1/compliance/checks',
|
|
2032
|
+
...options
|
|
2033
|
+
});
|
|
2034
|
+
}
|
|
2035
|
+
/**
|
|
2036
|
+
* Show compliance check
|
|
2037
|
+
*
|
|
2038
|
+
* **Required scope:**
|
|
2039
|
+
*
|
|
2040
|
+
* `compliance.checks:read`
|
|
2041
|
+
*
|
|
2042
|
+
*/
|
|
2043
|
+
static getCheck(options) {
|
|
2044
|
+
return (options.client ?? client).get({
|
|
2045
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2046
|
+
url: '/api/v1/compliance/checks/{id}',
|
|
2047
|
+
...options
|
|
2048
|
+
});
|
|
2049
|
+
}
|
|
2050
|
+
/**
|
|
2051
|
+
* Update compliance check
|
|
2052
|
+
*
|
|
2053
|
+
* **Required scope:**
|
|
2054
|
+
*
|
|
2055
|
+
* `compliance.checks:update`
|
|
2056
|
+
*
|
|
2057
|
+
*/
|
|
2058
|
+
static updateCheck(options) {
|
|
2059
|
+
return (options.client ?? client).patch({
|
|
2060
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2061
|
+
url: '/api/v1/compliance/checks/{id}',
|
|
2062
|
+
...options,
|
|
2063
|
+
headers: {
|
|
2064
|
+
'Content-Type': 'application/json',
|
|
2065
|
+
...options.headers
|
|
2066
|
+
}
|
|
2067
|
+
});
|
|
2068
|
+
}
|
|
2069
|
+
}
|
|
2070
|
+
export class CustomFieldConfigurations {
|
|
2071
|
+
/**
|
|
2072
|
+
* List custom field configurations
|
|
2073
|
+
*
|
|
2074
|
+
* **Required scope:**
|
|
2075
|
+
*
|
|
2076
|
+
* `custom_field_configs:read`
|
|
2077
|
+
*
|
|
2078
|
+
*/
|
|
2079
|
+
static listCustomFieldConfigs(options) {
|
|
2080
|
+
return (options?.client ?? client).get({
|
|
2081
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2082
|
+
url: '/api/v1/custom_field_configs',
|
|
2083
|
+
...options
|
|
2084
|
+
});
|
|
2085
|
+
}
|
|
2086
|
+
/**
|
|
2087
|
+
* Create custom field configuration
|
|
2088
|
+
*
|
|
2089
|
+
* **Required scope:**
|
|
2090
|
+
*
|
|
2091
|
+
* `custom_field_configs:create`
|
|
2092
|
+
*
|
|
2093
|
+
*/
|
|
2094
|
+
static createCustomFieldConfig(options) {
|
|
2095
|
+
return (options?.client ?? client).post({
|
|
2096
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2097
|
+
url: '/api/v1/custom_field_configs',
|
|
2098
|
+
...options,
|
|
2099
|
+
headers: {
|
|
2100
|
+
'Content-Type': 'application/json',
|
|
2101
|
+
...options?.headers
|
|
2102
|
+
}
|
|
2103
|
+
});
|
|
2104
|
+
}
|
|
2105
|
+
/**
|
|
2106
|
+
* Delete custom field configuration
|
|
2107
|
+
*
|
|
2108
|
+
* **Required scope:**
|
|
2109
|
+
*
|
|
2110
|
+
* `custom_field_configs:delete`
|
|
2111
|
+
*
|
|
2112
|
+
*/
|
|
2113
|
+
static deleteCustomFieldConfig(options) {
|
|
2114
|
+
return (options.client ?? client).delete({
|
|
2115
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2116
|
+
url: '/api/v1/custom_field_configs/{id}',
|
|
2117
|
+
...options
|
|
2118
|
+
});
|
|
2119
|
+
}
|
|
2120
|
+
/**
|
|
2121
|
+
* Show custom field configuration
|
|
2122
|
+
*
|
|
2123
|
+
* **Required scope:**
|
|
2124
|
+
*
|
|
2125
|
+
* `custom_field_configs:read`
|
|
2126
|
+
*
|
|
2127
|
+
*/
|
|
2128
|
+
static getCustomFieldConfig(options) {
|
|
2129
|
+
return (options.client ?? client).get({
|
|
2130
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2131
|
+
url: '/api/v1/custom_field_configs/{id}',
|
|
2132
|
+
...options
|
|
2133
|
+
});
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* Update custom field configuration
|
|
2137
|
+
*
|
|
2138
|
+
* **Required scope:**
|
|
2139
|
+
*
|
|
2140
|
+
* `custom_field_configs:update`
|
|
2141
|
+
*
|
|
2142
|
+
*/
|
|
2143
|
+
static updateCustomFieldConfig(options) {
|
|
2144
|
+
return (options.client ?? client).patch({
|
|
2145
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2146
|
+
url: '/api/v1/custom_field_configs/{id}',
|
|
2147
|
+
...options,
|
|
2148
|
+
headers: {
|
|
2149
|
+
'Content-Type': 'application/json',
|
|
2150
|
+
...options.headers
|
|
2151
|
+
}
|
|
2152
|
+
});
|
|
2153
|
+
}
|
|
2154
|
+
}
|
|
2155
|
+
export class DirectUploads {
|
|
2156
|
+
/**
|
|
2157
|
+
* Create direct upload
|
|
2158
|
+
*
|
|
2159
|
+
* **Required scope:**
|
|
2160
|
+
*
|
|
2161
|
+
* `direct_uploads:create`
|
|
2162
|
+
*
|
|
2163
|
+
*/
|
|
2164
|
+
static createDirectUpload(options) {
|
|
2165
|
+
return (options.client ?? client).post({
|
|
2166
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2167
|
+
url: '/api/v1/direct_uploads',
|
|
2168
|
+
...options,
|
|
2169
|
+
headers: {
|
|
2170
|
+
'Content-Type': 'application/json',
|
|
2171
|
+
...options.headers
|
|
2172
|
+
}
|
|
2173
|
+
});
|
|
2174
|
+
}
|
|
2175
|
+
}
|
|
2176
|
+
export class Forms {
|
|
2177
|
+
/**
|
|
2178
|
+
* List form definitions
|
|
2179
|
+
*
|
|
2180
|
+
* **Required scope:**
|
|
2181
|
+
*
|
|
2182
|
+
* `form_definitions:read`
|
|
2183
|
+
*
|
|
2184
|
+
*/
|
|
2185
|
+
static listFormDefinitions(options) {
|
|
2186
|
+
return (options?.client ?? client).get({
|
|
2187
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2188
|
+
url: '/api/v1/form_definitions',
|
|
2189
|
+
...options
|
|
2190
|
+
});
|
|
2191
|
+
}
|
|
2192
|
+
/**
|
|
2193
|
+
* List form submissions
|
|
2194
|
+
*
|
|
2195
|
+
* **Required scope:**
|
|
2196
|
+
*
|
|
2197
|
+
* `form_submissions:read`
|
|
2198
|
+
*
|
|
2199
|
+
*/
|
|
2200
|
+
static listFormSubmissions(options) {
|
|
2201
|
+
return (options?.client ?? client).get({
|
|
2202
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2203
|
+
url: '/api/v1/form_submissions',
|
|
2204
|
+
...options
|
|
2205
|
+
});
|
|
2206
|
+
}
|
|
2207
|
+
/**
|
|
2208
|
+
* Show form submission
|
|
2209
|
+
*
|
|
2210
|
+
* **Required scope:**
|
|
2211
|
+
*
|
|
2212
|
+
* `form_submissions:read`
|
|
2213
|
+
*
|
|
2214
|
+
*/
|
|
2215
|
+
static getFormSubmission(options) {
|
|
2216
|
+
return (options.client ?? client).get({
|
|
2217
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2218
|
+
url: '/api/v1/form_submissions/{id}',
|
|
2219
|
+
...options
|
|
2220
|
+
});
|
|
2221
|
+
}
|
|
2222
|
+
}
|
|
2223
|
+
export class Groups {
|
|
2224
|
+
/**
|
|
2225
|
+
* List users in group
|
|
2226
|
+
*
|
|
2227
|
+
* **Required scope:**
|
|
2228
|
+
*
|
|
2229
|
+
* `groups.users:read`
|
|
2230
|
+
*
|
|
2231
|
+
*/
|
|
2232
|
+
static listGroupUsers(options) {
|
|
2233
|
+
return (options.client ?? client).get({
|
|
2234
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2235
|
+
url: '/api/v1/groups/{group_id}/users',
|
|
2236
|
+
...options
|
|
2237
|
+
});
|
|
2238
|
+
}
|
|
2239
|
+
/**
|
|
2240
|
+
* Add users to group
|
|
2241
|
+
*
|
|
2242
|
+
* **Required scope:**
|
|
2243
|
+
*
|
|
2244
|
+
* `groups.users:create`
|
|
2245
|
+
*
|
|
2246
|
+
*/
|
|
2247
|
+
static addUsersToGroup(options) {
|
|
2248
|
+
return (options.client ?? client).post({
|
|
2249
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2250
|
+
url: '/api/v1/groups/{group_id}/users',
|
|
2251
|
+
...options,
|
|
2252
|
+
headers: {
|
|
2253
|
+
'Content-Type': 'application/json',
|
|
2254
|
+
...options.headers
|
|
2255
|
+
}
|
|
2256
|
+
});
|
|
2257
|
+
}
|
|
2258
|
+
/**
|
|
2259
|
+
* Remove user from group
|
|
2260
|
+
*
|
|
2261
|
+
* **Required scope:**
|
|
2262
|
+
*
|
|
2263
|
+
* `groups.users:delete`
|
|
2264
|
+
*
|
|
2265
|
+
*/
|
|
2266
|
+
static removeUserFromGroup(options) {
|
|
2267
|
+
return (options.client ?? client).delete({
|
|
2268
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2269
|
+
url: '/api/v1/groups/{group_id}/users/{id}',
|
|
2270
|
+
...options
|
|
2271
|
+
});
|
|
2272
|
+
}
|
|
2273
|
+
/**
|
|
2274
|
+
* List groups
|
|
2275
|
+
*
|
|
2276
|
+
* **Required scope:**
|
|
2277
|
+
*
|
|
2278
|
+
* `groups:read`
|
|
2279
|
+
*
|
|
2280
|
+
*/
|
|
2281
|
+
static listGroups(options) {
|
|
2282
|
+
return (options?.client ?? client).get({
|
|
2283
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2284
|
+
url: '/api/v1/groups',
|
|
2285
|
+
...options
|
|
2286
|
+
});
|
|
2287
|
+
}
|
|
2288
|
+
/**
|
|
2289
|
+
* Create group
|
|
2290
|
+
*
|
|
2291
|
+
* **Required scope:**
|
|
2292
|
+
*
|
|
2293
|
+
* `groups:create`
|
|
2294
|
+
*
|
|
2295
|
+
*/
|
|
2296
|
+
static createGroup(options) {
|
|
2297
|
+
return (options?.client ?? client).post({
|
|
2298
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2299
|
+
url: '/api/v1/groups',
|
|
2300
|
+
...options,
|
|
2301
|
+
headers: {
|
|
2302
|
+
'Content-Type': 'application/json',
|
|
2303
|
+
...options?.headers
|
|
2304
|
+
}
|
|
2305
|
+
});
|
|
2306
|
+
}
|
|
2307
|
+
/**
|
|
2308
|
+
* Delete group
|
|
2309
|
+
*
|
|
2310
|
+
* **Required scope:**
|
|
2311
|
+
*
|
|
2312
|
+
* `groups:delete`
|
|
2313
|
+
*
|
|
2314
|
+
*/
|
|
2315
|
+
static deleteGroup(options) {
|
|
2316
|
+
return (options.client ?? client).delete({
|
|
2317
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2318
|
+
url: '/api/v1/groups/{id}',
|
|
2319
|
+
...options
|
|
2320
|
+
});
|
|
2321
|
+
}
|
|
2322
|
+
/**
|
|
2323
|
+
* Show group
|
|
2324
|
+
*
|
|
2325
|
+
* **Required scope:**
|
|
2326
|
+
*
|
|
2327
|
+
* `groups:read`
|
|
2328
|
+
*
|
|
2329
|
+
*/
|
|
2330
|
+
static getGroup(options) {
|
|
2331
|
+
return (options.client ?? client).get({
|
|
2332
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2333
|
+
url: '/api/v1/groups/{id}',
|
|
2334
|
+
...options
|
|
2335
|
+
});
|
|
2336
|
+
}
|
|
2337
|
+
/**
|
|
2338
|
+
* Update group
|
|
2339
|
+
*
|
|
2340
|
+
* **Required scope:**
|
|
2341
|
+
*
|
|
2342
|
+
* `groups:update`
|
|
2343
|
+
*
|
|
2344
|
+
*/
|
|
2345
|
+
static updateGroup(options) {
|
|
2346
|
+
return (options.client ?? client).patch({
|
|
2347
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2348
|
+
url: '/api/v1/groups/{id}',
|
|
2349
|
+
...options,
|
|
2350
|
+
headers: {
|
|
2351
|
+
'Content-Type': 'application/json',
|
|
2352
|
+
...options.headers
|
|
2353
|
+
}
|
|
2354
|
+
});
|
|
2355
|
+
}
|
|
2356
|
+
}
|
|
2357
|
+
export class ProductionJobScopePrices {
|
|
2358
|
+
/**
|
|
2359
|
+
* List production job scope prices
|
|
2360
|
+
*
|
|
2361
|
+
* **Required scope:**
|
|
2362
|
+
*
|
|
2363
|
+
* `jobs.production.job_scope_prices:read`
|
|
2364
|
+
*
|
|
2365
|
+
*/
|
|
2366
|
+
static listJobScopePrices(options) {
|
|
2367
|
+
return (options.client ?? client).get({
|
|
2368
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2369
|
+
url: '/api/v1/jobs/{job_id}/production/job_scope_prices',
|
|
2370
|
+
...options
|
|
2371
|
+
});
|
|
2372
|
+
}
|
|
2373
|
+
/**
|
|
2374
|
+
* Create production job scope price
|
|
2375
|
+
*
|
|
2376
|
+
* **Required scope:**
|
|
2377
|
+
*
|
|
2378
|
+
* `jobs.production.job_scope_prices:create`
|
|
2379
|
+
*
|
|
2380
|
+
*/
|
|
2381
|
+
static createJobScopePrice(options) {
|
|
2382
|
+
return (options.client ?? client).post({
|
|
2383
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2384
|
+
url: '/api/v1/jobs/{job_id}/production/job_scope_prices',
|
|
2385
|
+
...options,
|
|
2386
|
+
headers: {
|
|
2387
|
+
'Content-Type': 'application/json',
|
|
2388
|
+
...options.headers
|
|
2389
|
+
}
|
|
2390
|
+
});
|
|
2391
|
+
}
|
|
2392
|
+
/**
|
|
2393
|
+
* Delete production job scope price
|
|
2394
|
+
*
|
|
2395
|
+
* **Required scope:**
|
|
2396
|
+
*
|
|
2397
|
+
* `jobs.production.job_scope_prices:delete`
|
|
2398
|
+
*
|
|
2399
|
+
*/
|
|
2400
|
+
static deleteJobScopePrice(options) {
|
|
2401
|
+
return (options.client ?? client).delete({
|
|
2402
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2403
|
+
url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{id}',
|
|
2404
|
+
...options
|
|
2405
|
+
});
|
|
2406
|
+
}
|
|
2407
|
+
/**
|
|
2408
|
+
* Show production job scope price
|
|
2409
|
+
*
|
|
2410
|
+
* **Required scope:**
|
|
2411
|
+
*
|
|
2412
|
+
* `jobs.production.job_scope_prices:read`
|
|
2413
|
+
*
|
|
2414
|
+
*/
|
|
2415
|
+
static getJobScopePrice(options) {
|
|
2416
|
+
return (options.client ?? client).get({
|
|
2417
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2418
|
+
url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{id}',
|
|
2419
|
+
...options
|
|
2420
|
+
});
|
|
2421
|
+
}
|
|
2422
|
+
/**
|
|
2423
|
+
* Update production job scope price
|
|
2424
|
+
*
|
|
2425
|
+
* **Required scope:**
|
|
2426
|
+
*
|
|
2427
|
+
* `jobs.production.job_scope_prices:update`
|
|
2428
|
+
*
|
|
2429
|
+
*/
|
|
2430
|
+
static updateJobScopePrice(options) {
|
|
2431
|
+
return (options.client ?? client).patch({
|
|
2432
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2433
|
+
url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{id}',
|
|
2434
|
+
...options,
|
|
2435
|
+
headers: {
|
|
2436
|
+
'Content-Type': 'application/json',
|
|
2437
|
+
...options.headers
|
|
2438
|
+
}
|
|
2439
|
+
});
|
|
2440
|
+
}
|
|
2441
|
+
}
|
|
2442
|
+
export class PwaTrades {
|
|
2443
|
+
/**
|
|
2444
|
+
* Create Job Trade
|
|
2445
|
+
*
|
|
2446
|
+
* **Required scope:**
|
|
2447
|
+
*
|
|
2448
|
+
* `jobs.pwa.trades:create`
|
|
2449
|
+
*
|
|
2450
|
+
*/
|
|
2451
|
+
static createJobTrade(options) {
|
|
2452
|
+
return (options.client ?? client).post({
|
|
2453
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2454
|
+
url: '/api/v1/jobs/{job_id}/pwa/trades',
|
|
2455
|
+
...options,
|
|
2456
|
+
headers: {
|
|
2457
|
+
'Content-Type': 'application/json',
|
|
2458
|
+
...options.headers
|
|
2459
|
+
}
|
|
2460
|
+
});
|
|
2461
|
+
}
|
|
2462
|
+
/**
|
|
2463
|
+
* Create Project Trade
|
|
2464
|
+
*
|
|
2465
|
+
* **Required scope:**
|
|
2466
|
+
*
|
|
2467
|
+
* `projects.pwa.trades:create`
|
|
2468
|
+
*
|
|
2469
|
+
*/
|
|
2470
|
+
static createProjectTrade(options) {
|
|
2471
|
+
return (options.client ?? client).post({
|
|
2472
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2473
|
+
url: '/api/v1/projects/{project_id}/pwa/trades',
|
|
2474
|
+
...options,
|
|
2475
|
+
headers: {
|
|
2476
|
+
'Content-Type': 'application/json',
|
|
2477
|
+
...options.headers
|
|
2478
|
+
}
|
|
2479
|
+
});
|
|
2480
|
+
}
|
|
2481
|
+
/**
|
|
2482
|
+
* List trades
|
|
2483
|
+
*
|
|
2484
|
+
* **Required scope:**
|
|
2485
|
+
*
|
|
2486
|
+
* `pwa.trades:read`
|
|
2487
|
+
*
|
|
2488
|
+
*/
|
|
2489
|
+
static listTrades(options) {
|
|
2490
|
+
return (options?.client ?? client).get({
|
|
2491
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2492
|
+
url: '/api/v1/pwa/trades',
|
|
2493
|
+
...options
|
|
2494
|
+
});
|
|
2495
|
+
}
|
|
2496
|
+
/**
|
|
2497
|
+
* Show trade
|
|
2498
|
+
*
|
|
2499
|
+
* **Required scope:**
|
|
2500
|
+
*
|
|
2501
|
+
* `pwa.trades:read`
|
|
2502
|
+
*
|
|
2503
|
+
*/
|
|
2504
|
+
static getTrade(options) {
|
|
2505
|
+
return (options.client ?? client).get({
|
|
2506
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2507
|
+
url: '/api/v1/pwa/trades/{id}',
|
|
2508
|
+
...options
|
|
2509
|
+
});
|
|
2510
|
+
}
|
|
2511
|
+
}
|
|
2512
|
+
export class JobWageDeterminationRateRules {
|
|
2513
|
+
/**
|
|
2514
|
+
* List rate rules
|
|
2515
|
+
*
|
|
2516
|
+
* **Required scope:**
|
|
2517
|
+
*
|
|
2518
|
+
* `jobs.pwa.wage_determinations.rate_rules:read`
|
|
2519
|
+
*
|
|
2520
|
+
*/
|
|
2521
|
+
static listRateRules(options) {
|
|
2522
|
+
return (options.client ?? client).get({
|
|
2523
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2524
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules',
|
|
2525
|
+
...options
|
|
2526
|
+
});
|
|
2527
|
+
}
|
|
2528
|
+
/**
|
|
2529
|
+
* Create rate rule
|
|
2530
|
+
*
|
|
2531
|
+
* **Required scope:**
|
|
2532
|
+
*
|
|
2533
|
+
* `jobs.pwa.wage_determinations.rate_rules:create`
|
|
2534
|
+
*
|
|
2535
|
+
*/
|
|
2536
|
+
static createRateRule(options) {
|
|
2537
|
+
return (options.client ?? client).post({
|
|
2538
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2539
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules',
|
|
2540
|
+
...options,
|
|
2541
|
+
headers: {
|
|
2542
|
+
'Content-Type': 'application/json',
|
|
2543
|
+
...options.headers
|
|
2544
|
+
}
|
|
2545
|
+
});
|
|
2546
|
+
}
|
|
2547
|
+
/**
|
|
2548
|
+
* Show rate rule
|
|
2549
|
+
*
|
|
2550
|
+
* **Required scope:**
|
|
2551
|
+
*
|
|
2552
|
+
* `jobs.pwa.wage_determinations.rate_rules:read`
|
|
2553
|
+
*
|
|
2554
|
+
*/
|
|
2555
|
+
static getRateRule(options) {
|
|
2556
|
+
return (options.client ?? client).get({
|
|
2557
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2558
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}',
|
|
2559
|
+
...options
|
|
2560
|
+
});
|
|
2561
|
+
}
|
|
2562
|
+
}
|
|
2563
|
+
export class JobWageDeterminations {
|
|
2564
|
+
/**
|
|
2565
|
+
* List job wage determinations
|
|
2566
|
+
*
|
|
2567
|
+
* **Required scope:**
|
|
2568
|
+
*
|
|
2569
|
+
* `jobs.wage_determinations:read`
|
|
2570
|
+
*
|
|
2571
|
+
*/
|
|
2572
|
+
static listJobWageDeterminations(options) {
|
|
2573
|
+
return (options.client ?? client).get({
|
|
2574
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2575
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations',
|
|
2576
|
+
...options
|
|
2577
|
+
});
|
|
2578
|
+
}
|
|
2579
|
+
/**
|
|
2580
|
+
* Create job wage determination
|
|
2581
|
+
*
|
|
2582
|
+
* **Required scope:**
|
|
2583
|
+
*
|
|
2584
|
+
* `jobs.wage_determinations:create`
|
|
2585
|
+
*
|
|
2586
|
+
*/
|
|
2587
|
+
static createWageDetermination(options) {
|
|
2588
|
+
return (options.client ?? client).post({
|
|
2589
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2590
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations',
|
|
2591
|
+
...options,
|
|
2592
|
+
headers: {
|
|
2593
|
+
'Content-Type': 'application/json',
|
|
2594
|
+
...options.headers
|
|
2595
|
+
}
|
|
2596
|
+
});
|
|
2597
|
+
}
|
|
2598
|
+
/**
|
|
2599
|
+
* Delete job wage determination
|
|
2600
|
+
*
|
|
2601
|
+
* **Required scope:**
|
|
2602
|
+
*
|
|
2603
|
+
* `jobs.wage_determinations:delete`
|
|
2604
|
+
*
|
|
2605
|
+
*/
|
|
2606
|
+
static deleteWageDetermination(options) {
|
|
2607
|
+
return (options.client ?? client).delete({
|
|
2608
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2609
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{id}',
|
|
2610
|
+
...options
|
|
2611
|
+
});
|
|
2612
|
+
}
|
|
2613
|
+
/**
|
|
2614
|
+
* Show job wage determination
|
|
2615
|
+
*
|
|
2616
|
+
* **Required scope:**
|
|
2617
|
+
*
|
|
2618
|
+
* `jobs.wage_determinations:read`
|
|
2619
|
+
*
|
|
2620
|
+
*/
|
|
2621
|
+
static getJobWageDetermination(options) {
|
|
2622
|
+
return (options.client ?? client).get({
|
|
2623
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2624
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{id}',
|
|
2625
|
+
...options
|
|
2626
|
+
});
|
|
2627
|
+
}
|
|
2628
|
+
}
|
|
2629
|
+
export class Jobs {
|
|
2630
|
+
/**
|
|
2631
|
+
* List jobs
|
|
2632
|
+
*
|
|
2633
|
+
* **Required scope:**
|
|
2634
|
+
*
|
|
2635
|
+
* `jobs:read`
|
|
2636
|
+
*
|
|
2637
|
+
*/
|
|
2638
|
+
static listJobs(options) {
|
|
2639
|
+
return (options?.client ?? client).get({
|
|
2640
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2641
|
+
url: '/api/v1/jobs',
|
|
2642
|
+
...options
|
|
2643
|
+
});
|
|
2644
|
+
}
|
|
2645
|
+
/**
|
|
2646
|
+
* Create job
|
|
2647
|
+
*
|
|
2648
|
+
* **Required scope:**
|
|
2649
|
+
*
|
|
2650
|
+
* `jobs:create`
|
|
2651
|
+
*
|
|
2652
|
+
*/
|
|
2653
|
+
static createJob(options) {
|
|
2654
|
+
return (options.client ?? client).post({
|
|
2655
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2656
|
+
url: '/api/v1/jobs',
|
|
2657
|
+
...options,
|
|
2658
|
+
headers: {
|
|
2659
|
+
'Content-Type': 'application/json',
|
|
2660
|
+
...options.headers
|
|
2661
|
+
}
|
|
2662
|
+
});
|
|
2663
|
+
}
|
|
2664
|
+
/**
|
|
2665
|
+
* Show job
|
|
2666
|
+
*
|
|
2667
|
+
* **Required scope:**
|
|
2668
|
+
*
|
|
2669
|
+
* `jobs:read`
|
|
2670
|
+
*
|
|
2671
|
+
*/
|
|
2672
|
+
static getJob(options) {
|
|
2673
|
+
return (options.client ?? client).get({
|
|
2674
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2675
|
+
url: '/api/v1/jobs/{id}',
|
|
2676
|
+
...options
|
|
2677
|
+
});
|
|
2678
|
+
}
|
|
2679
|
+
/**
|
|
2680
|
+
* Update job
|
|
2681
|
+
*
|
|
2682
|
+
* **Required scope:**
|
|
2683
|
+
*
|
|
2684
|
+
* `jobs:update`
|
|
2685
|
+
*
|
|
2686
|
+
*/
|
|
2687
|
+
static updateJob(options) {
|
|
2688
|
+
return (options.client ?? client).patch({
|
|
2689
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2690
|
+
url: '/api/v1/jobs/{id}',
|
|
2691
|
+
...options,
|
|
2692
|
+
headers: {
|
|
2693
|
+
'Content-Type': 'application/json',
|
|
2694
|
+
...options.headers
|
|
2695
|
+
}
|
|
2696
|
+
});
|
|
2697
|
+
}
|
|
2698
|
+
/**
|
|
2699
|
+
* List positions for job
|
|
2700
|
+
*
|
|
2701
|
+
* **Required scope:**
|
|
2702
|
+
*
|
|
2703
|
+
* `jobs.positions:read`
|
|
2704
|
+
*
|
|
2705
|
+
*/
|
|
2706
|
+
static listPositions(options) {
|
|
2707
|
+
return (options.client ?? client).get({
|
|
2708
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2709
|
+
url: '/api/v1/jobs/{job_id}/positions',
|
|
2710
|
+
...options
|
|
2711
|
+
});
|
|
2712
|
+
}
|
|
2713
|
+
/**
|
|
2714
|
+
* Create position for job
|
|
2715
|
+
*
|
|
2716
|
+
* **Required scope:**
|
|
2717
|
+
*
|
|
2718
|
+
* `jobs.positions:create`
|
|
2719
|
+
*
|
|
2720
|
+
*/
|
|
2721
|
+
static createPosition(options) {
|
|
2722
|
+
return (options.client ?? client).post({
|
|
2723
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2724
|
+
url: '/api/v1/jobs/{job_id}/positions',
|
|
2725
|
+
...options,
|
|
2726
|
+
headers: {
|
|
2727
|
+
'Content-Type': 'application/json',
|
|
2728
|
+
...options.headers
|
|
2729
|
+
}
|
|
2730
|
+
});
|
|
2731
|
+
}
|
|
2732
|
+
/**
|
|
2733
|
+
* Update position on job
|
|
2734
|
+
*
|
|
2735
|
+
* **Required scope:**
|
|
2736
|
+
*
|
|
2737
|
+
* `jobs.positions:update`
|
|
2738
|
+
*
|
|
2739
|
+
*/
|
|
2740
|
+
static updatePosition(options) {
|
|
2741
|
+
return (options.client ?? client).patch({
|
|
2742
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2743
|
+
url: '/api/v1/jobs/{job_id}/positions/{id}',
|
|
2744
|
+
...options,
|
|
2745
|
+
headers: {
|
|
2746
|
+
'Content-Type': 'application/json',
|
|
2747
|
+
...options.headers
|
|
2748
|
+
}
|
|
2749
|
+
});
|
|
2750
|
+
}
|
|
2751
|
+
/**
|
|
2752
|
+
* List job templates
|
|
2753
|
+
*
|
|
2754
|
+
* **Required scope:**
|
|
2755
|
+
*
|
|
2756
|
+
* `jobs.templates:read`
|
|
2757
|
+
*
|
|
2758
|
+
*/
|
|
2759
|
+
static listTemplates(options) {
|
|
2760
|
+
return (options?.client ?? client).get({
|
|
2761
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2762
|
+
url: '/api/v1/jobs/templates',
|
|
2763
|
+
...options
|
|
2764
|
+
});
|
|
2765
|
+
}
|
|
2766
|
+
}
|
|
2767
|
+
export class PayPeriods {
|
|
2768
|
+
/**
|
|
2769
|
+
* List pay periods
|
|
2770
|
+
*
|
|
2771
|
+
* **Required scope:**
|
|
2772
|
+
*
|
|
2773
|
+
* `pay_periods:read`
|
|
2774
|
+
*
|
|
2775
|
+
*/
|
|
2776
|
+
static listPayPeriods(options) {
|
|
2777
|
+
return (options?.client ?? client).get({
|
|
2778
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2779
|
+
url: '/api/v1/pay_periods',
|
|
2780
|
+
...options
|
|
2781
|
+
});
|
|
2782
|
+
}
|
|
2783
|
+
}
|
|
2784
|
+
export class CompensationElements {
|
|
2785
|
+
/**
|
|
2786
|
+
* List compensation elements
|
|
2787
|
+
*
|
|
2788
|
+
* **Required scope:**
|
|
2789
|
+
*
|
|
2790
|
+
* `payrolls.compensation_elements:read`
|
|
2791
|
+
*
|
|
2792
|
+
*/
|
|
2793
|
+
static listCompensationElements(options) {
|
|
2794
|
+
return (options?.client ?? client).get({
|
|
2795
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2796
|
+
url: '/api/v1/payrolls/compensation_elements',
|
|
2797
|
+
...options
|
|
2798
|
+
});
|
|
2799
|
+
}
|
|
2800
|
+
/**
|
|
2801
|
+
* Show compensation element
|
|
2802
|
+
*
|
|
2803
|
+
* **Required scope:**
|
|
2804
|
+
*
|
|
2805
|
+
* `payrolls.compensation_elements:read`
|
|
2806
|
+
*
|
|
2807
|
+
*/
|
|
2808
|
+
static getCompensationElement(options) {
|
|
2809
|
+
return (options.client ?? client).get({
|
|
2810
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2811
|
+
url: '/api/v1/payrolls/compensation_elements/{id}',
|
|
2812
|
+
...options
|
|
2813
|
+
});
|
|
2814
|
+
}
|
|
2815
|
+
}
|
|
2816
|
+
export class ExternalMaps {
|
|
2817
|
+
/**
|
|
2818
|
+
* List external maps
|
|
2819
|
+
*
|
|
2820
|
+
* **Required scope:**
|
|
2821
|
+
*
|
|
2822
|
+
* `payrolls.external_maps:read`
|
|
2823
|
+
*
|
|
2824
|
+
*/
|
|
2825
|
+
static listExternalMaps(options) {
|
|
2826
|
+
return (options?.client ?? client).get({
|
|
2827
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2828
|
+
url: '/api/v1/payrolls/external_maps',
|
|
2829
|
+
...options
|
|
2830
|
+
});
|
|
2831
|
+
}
|
|
2832
|
+
/**
|
|
2833
|
+
* Show external map
|
|
2834
|
+
*
|
|
2835
|
+
* **Required scope:**
|
|
2836
|
+
*
|
|
2837
|
+
* `payrolls.external_maps:read`
|
|
2838
|
+
*
|
|
2839
|
+
*/
|
|
2840
|
+
static getExternalMap(options) {
|
|
2841
|
+
return (options.client ?? client).get({
|
|
2842
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2843
|
+
url: '/api/v1/payrolls/external_maps/{id}',
|
|
2844
|
+
...options
|
|
2845
|
+
});
|
|
2846
|
+
}
|
|
2847
|
+
}
|
|
2848
|
+
export class FringeBenefitPlans {
|
|
2849
|
+
/**
|
|
2850
|
+
* List fringe benefit plans
|
|
2851
|
+
*
|
|
2852
|
+
* **Required scope:**
|
|
2853
|
+
*
|
|
2854
|
+
* `payrolls.fringe_benefit_plans:read`
|
|
2855
|
+
*
|
|
2856
|
+
*/
|
|
2857
|
+
static listFringeBenefitPlans(options) {
|
|
2858
|
+
return (options?.client ?? client).get({
|
|
2859
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2860
|
+
url: '/api/v1/payrolls/fringe_benefit_plans',
|
|
2861
|
+
...options
|
|
2862
|
+
});
|
|
2863
|
+
}
|
|
2864
|
+
/**
|
|
2865
|
+
* Create fringe benefit plan
|
|
2866
|
+
*
|
|
2867
|
+
* **Required scope:**
|
|
2868
|
+
*
|
|
2869
|
+
* `payrolls.fringe_benefit_plans:create`
|
|
2870
|
+
*
|
|
2871
|
+
*/
|
|
2872
|
+
static createFringeBenefitPlan(options) {
|
|
2873
|
+
return (options?.client ?? client).post({
|
|
2874
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2875
|
+
url: '/api/v1/payrolls/fringe_benefit_plans',
|
|
2876
|
+
...options,
|
|
2877
|
+
headers: {
|
|
2878
|
+
'Content-Type': 'application/json',
|
|
2879
|
+
...options?.headers
|
|
2880
|
+
}
|
|
2881
|
+
});
|
|
2882
|
+
}
|
|
2883
|
+
/**
|
|
2884
|
+
* Delete fringe benefit plan
|
|
2885
|
+
*
|
|
2886
|
+
* **Required scope:**
|
|
2887
|
+
*
|
|
2888
|
+
* `payrolls.fringe_benefit_plans:delete`
|
|
2889
|
+
*
|
|
2890
|
+
*/
|
|
2891
|
+
static deleteFringeBenefitPlan(options) {
|
|
2892
|
+
return (options.client ?? client).delete({
|
|
2893
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2894
|
+
url: '/api/v1/payrolls/fringe_benefit_plans/{id}',
|
|
2895
|
+
...options
|
|
2896
|
+
});
|
|
2897
|
+
}
|
|
2898
|
+
/**
|
|
2899
|
+
* Show fringe benefit plan
|
|
2900
|
+
*
|
|
2901
|
+
* **Required scope:**
|
|
2902
|
+
*
|
|
2903
|
+
* `payrolls.fringe_benefit_plans:read`
|
|
2904
|
+
*
|
|
2905
|
+
*/
|
|
2906
|
+
static getFringeBenefitPlan(options) {
|
|
2907
|
+
return (options.client ?? client).get({
|
|
2908
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2909
|
+
url: '/api/v1/payrolls/fringe_benefit_plans/{id}',
|
|
2910
|
+
...options
|
|
2911
|
+
});
|
|
2912
|
+
}
|
|
2913
|
+
/**
|
|
2914
|
+
* Update fringe benefit plan
|
|
2915
|
+
*
|
|
2916
|
+
* **Required scope:**
|
|
2917
|
+
*
|
|
2918
|
+
* `payrolls.fringe_benefit_plans:update`
|
|
2919
|
+
*
|
|
2920
|
+
*/
|
|
2921
|
+
static updateFringeBenefitPlan(options) {
|
|
2922
|
+
return (options.client ?? client).patch({
|
|
2923
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2924
|
+
url: '/api/v1/payrolls/fringe_benefit_plans/{id}',
|
|
2925
|
+
...options,
|
|
2926
|
+
headers: {
|
|
2927
|
+
'Content-Type': 'application/json',
|
|
2928
|
+
...options.headers
|
|
2929
|
+
}
|
|
2930
|
+
});
|
|
2931
|
+
}
|
|
2932
|
+
}
|
|
2933
|
+
export class PayrollRuns {
|
|
2934
|
+
/**
|
|
2935
|
+
* List payroll runs
|
|
2936
|
+
*
|
|
2937
|
+
* **Required scope:**
|
|
2938
|
+
*
|
|
2939
|
+
* `payrolls.payroll_runs:read`
|
|
2940
|
+
*
|
|
2941
|
+
*/
|
|
2942
|
+
static listPayrollRuns(options) {
|
|
2943
|
+
return (options?.client ?? client).get({
|
|
2944
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2945
|
+
url: '/api/v1/payrolls/payroll_runs',
|
|
2946
|
+
...options
|
|
2947
|
+
});
|
|
2948
|
+
}
|
|
2949
|
+
/**
|
|
2950
|
+
* Create payroll run
|
|
2951
|
+
*
|
|
2952
|
+
* **Required scope:**
|
|
2953
|
+
*
|
|
2954
|
+
* `payrolls.payroll_runs:create`
|
|
2955
|
+
*
|
|
2956
|
+
*/
|
|
2957
|
+
static createPayrollRun(options) {
|
|
2958
|
+
return (options?.client ?? client).post({
|
|
2959
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2960
|
+
url: '/api/v1/payrolls/payroll_runs',
|
|
2961
|
+
...options,
|
|
2962
|
+
headers: {
|
|
2963
|
+
'Content-Type': 'application/json',
|
|
2964
|
+
...options?.headers
|
|
2965
|
+
}
|
|
2966
|
+
});
|
|
2967
|
+
}
|
|
2968
|
+
/**
|
|
2969
|
+
* Delete payroll run
|
|
2970
|
+
*
|
|
2971
|
+
* **Required scope:**
|
|
2972
|
+
*
|
|
2973
|
+
* `payrolls.payroll_runs:delete`
|
|
2974
|
+
*
|
|
2975
|
+
*/
|
|
2976
|
+
static deletePayrollRun(options) {
|
|
2977
|
+
return (options.client ?? client).delete({
|
|
2978
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2979
|
+
url: '/api/v1/payrolls/payroll_runs/{id}',
|
|
2980
|
+
...options
|
|
2981
|
+
});
|
|
2982
|
+
}
|
|
2983
|
+
/**
|
|
2984
|
+
* Show payroll run
|
|
2985
|
+
*
|
|
2986
|
+
* **Required scope:**
|
|
2987
|
+
*
|
|
2988
|
+
* `payrolls.payroll_runs:read`
|
|
2989
|
+
*
|
|
2990
|
+
*/
|
|
2991
|
+
static getPayrollRun(options) {
|
|
2992
|
+
return (options.client ?? client).get({
|
|
2993
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2994
|
+
url: '/api/v1/payrolls/payroll_runs/{id}',
|
|
2995
|
+
...options
|
|
2996
|
+
});
|
|
2997
|
+
}
|
|
2998
|
+
/**
|
|
2999
|
+
* Update payroll run
|
|
3000
|
+
*
|
|
3001
|
+
* **Required scope:**
|
|
3002
|
+
*
|
|
3003
|
+
* `payrolls.payroll_runs:update`
|
|
3004
|
+
*
|
|
3005
|
+
*/
|
|
3006
|
+
static updatePayrollRun(options) {
|
|
3007
|
+
return (options.client ?? client).patch({
|
|
3008
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3009
|
+
url: '/api/v1/payrolls/payroll_runs/{id}',
|
|
3010
|
+
...options,
|
|
3011
|
+
headers: {
|
|
3012
|
+
'Content-Type': 'application/json',
|
|
3013
|
+
...options.headers
|
|
3014
|
+
}
|
|
3015
|
+
});
|
|
3016
|
+
}
|
|
3017
|
+
}
|
|
3018
|
+
export class PaystubLineItems {
|
|
3019
|
+
/**
|
|
3020
|
+
* List paystub line items
|
|
3021
|
+
*
|
|
3022
|
+
* **Required scope:**
|
|
3023
|
+
*
|
|
3024
|
+
* `paystub_line_items:read`
|
|
3025
|
+
*
|
|
3026
|
+
*/
|
|
3027
|
+
static listPaystubLineItems(options) {
|
|
3028
|
+
return (options?.client ?? client).get({
|
|
3029
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3030
|
+
url: '/api/v1/paystub_line_items',
|
|
3031
|
+
...options
|
|
3032
|
+
});
|
|
3033
|
+
}
|
|
3034
|
+
/**
|
|
3035
|
+
* Create paystub line item
|
|
3036
|
+
*
|
|
3037
|
+
* **Required scope:**
|
|
3038
|
+
*
|
|
3039
|
+
* `paystub_line_items:create`
|
|
3040
|
+
*
|
|
3041
|
+
*/
|
|
3042
|
+
static createPaystubLineItem(options) {
|
|
3043
|
+
return (options?.client ?? client).post({
|
|
3044
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3045
|
+
url: '/api/v1/paystub_line_items',
|
|
3046
|
+
...options,
|
|
3047
|
+
headers: {
|
|
3048
|
+
'Content-Type': 'application/json',
|
|
3049
|
+
...options?.headers
|
|
3050
|
+
}
|
|
3051
|
+
});
|
|
3052
|
+
}
|
|
3053
|
+
/**
|
|
3054
|
+
* Delete paystub line item
|
|
3055
|
+
*
|
|
3056
|
+
* **Required scope:**
|
|
3057
|
+
*
|
|
3058
|
+
* `paystub_line_items:delete`
|
|
3059
|
+
*
|
|
3060
|
+
*/
|
|
3061
|
+
static deletePaystubLineItem(options) {
|
|
3062
|
+
return (options.client ?? client).delete({
|
|
3063
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3064
|
+
url: '/api/v1/paystub_line_items/{id}',
|
|
3065
|
+
...options
|
|
3066
|
+
});
|
|
3067
|
+
}
|
|
3068
|
+
/**
|
|
3069
|
+
* Show paystub line item
|
|
3070
|
+
*
|
|
3071
|
+
* **Required scope:**
|
|
3072
|
+
*
|
|
3073
|
+
* `paystub_line_items:read`
|
|
3074
|
+
*
|
|
3075
|
+
*/
|
|
3076
|
+
static getPaystubLineItem(options) {
|
|
3077
|
+
return (options.client ?? client).get({
|
|
3078
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3079
|
+
url: '/api/v1/paystub_line_items/{id}',
|
|
3080
|
+
...options
|
|
3081
|
+
});
|
|
3082
|
+
}
|
|
3083
|
+
/**
|
|
3084
|
+
* Update paystub line item
|
|
3085
|
+
*
|
|
3086
|
+
* **Required scope:**
|
|
3087
|
+
*
|
|
3088
|
+
* `paystub_line_items:update`
|
|
3089
|
+
*
|
|
3090
|
+
*/
|
|
3091
|
+
static updatePaystubLineItem(options) {
|
|
3092
|
+
return (options.client ?? client).patch({
|
|
3093
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3094
|
+
url: '/api/v1/paystub_line_items/{id}',
|
|
3095
|
+
...options,
|
|
3096
|
+
headers: {
|
|
3097
|
+
'Content-Type': 'application/json',
|
|
3098
|
+
...options.headers
|
|
3099
|
+
}
|
|
3100
|
+
});
|
|
3101
|
+
}
|
|
3102
|
+
}
|
|
3103
|
+
export class Paystubs {
|
|
3104
|
+
/**
|
|
3105
|
+
* List paystubs
|
|
3106
|
+
*
|
|
3107
|
+
* **Required scope:**
|
|
3108
|
+
*
|
|
3109
|
+
* `paystubs:read`
|
|
3110
|
+
*
|
|
3111
|
+
*/
|
|
3112
|
+
static listPaystubs(options) {
|
|
3113
|
+
return (options?.client ?? client).get({
|
|
3114
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3115
|
+
url: '/api/v1/paystubs',
|
|
3116
|
+
...options
|
|
3117
|
+
});
|
|
3118
|
+
}
|
|
3119
|
+
/**
|
|
3120
|
+
* Create paystub
|
|
3121
|
+
*
|
|
3122
|
+
* **Required scope:**
|
|
3123
|
+
*
|
|
3124
|
+
* `paystubs:create`
|
|
3125
|
+
*
|
|
3126
|
+
*/
|
|
3127
|
+
static createPaystub(options) {
|
|
3128
|
+
return (options.client ?? client).post({
|
|
3129
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3130
|
+
url: '/api/v1/paystubs',
|
|
3131
|
+
...options,
|
|
3132
|
+
headers: {
|
|
3133
|
+
'Content-Type': 'application/json',
|
|
3134
|
+
...options.headers
|
|
3135
|
+
}
|
|
3136
|
+
});
|
|
3137
|
+
}
|
|
3138
|
+
/**
|
|
3139
|
+
* Delete paystub
|
|
3140
|
+
*
|
|
3141
|
+
* **Required scope:**
|
|
3142
|
+
*
|
|
3143
|
+
* `paystubs:delete`
|
|
3144
|
+
*
|
|
3145
|
+
*/
|
|
3146
|
+
static deletePaystub(options) {
|
|
3147
|
+
return (options.client ?? client).delete({
|
|
3148
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3149
|
+
url: '/api/v1/paystubs/{id}',
|
|
3150
|
+
...options
|
|
3151
|
+
});
|
|
3152
|
+
}
|
|
3153
|
+
/**
|
|
3154
|
+
* Show paystub
|
|
3155
|
+
*
|
|
3156
|
+
* **Required scope:**
|
|
3157
|
+
*
|
|
3158
|
+
* `paystubs:read`
|
|
3159
|
+
*
|
|
3160
|
+
*/
|
|
3161
|
+
static getPaystub(options) {
|
|
3162
|
+
return (options.client ?? client).get({
|
|
3163
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3164
|
+
url: '/api/v1/paystubs/{id}',
|
|
3165
|
+
...options
|
|
3166
|
+
});
|
|
3167
|
+
}
|
|
3168
|
+
/**
|
|
3169
|
+
* Update paystub
|
|
3170
|
+
*
|
|
3171
|
+
* **Required scope:**
|
|
3172
|
+
*
|
|
3173
|
+
* `paystubs:update`
|
|
3174
|
+
*
|
|
3175
|
+
*/
|
|
3176
|
+
static updatePaystub(options) {
|
|
3177
|
+
return (options.client ?? client).patch({
|
|
3178
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3179
|
+
url: '/api/v1/paystubs/{id}',
|
|
3180
|
+
...options,
|
|
3181
|
+
headers: {
|
|
3182
|
+
'Content-Type': 'application/json',
|
|
3183
|
+
...options.headers
|
|
3184
|
+
}
|
|
3185
|
+
});
|
|
3186
|
+
}
|
|
3187
|
+
}
|
|
3188
|
+
export class PerDiems {
|
|
3189
|
+
/**
|
|
3190
|
+
* List per diems
|
|
3191
|
+
*
|
|
3192
|
+
* List the per diems configured for the company — the named daily allowances
|
|
3193
|
+
* (meals, lodging, travel) available to attach to workers' time. Returned newest
|
|
3194
|
+
* first; narrow the results with the `filter[...]` query parameters.
|
|
3195
|
+
*
|
|
3196
|
+
*
|
|
3197
|
+
* **Required scope:**
|
|
3198
|
+
*
|
|
3199
|
+
* `per_diems:read`
|
|
3200
|
+
*
|
|
3201
|
+
*/
|
|
3202
|
+
static listPerDiems(options) {
|
|
3203
|
+
return (options?.client ?? client).get({
|
|
3204
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3205
|
+
url: '/api/v1/per_diems',
|
|
3206
|
+
...options
|
|
3207
|
+
});
|
|
3208
|
+
}
|
|
3209
|
+
/**
|
|
3210
|
+
* Create per diem
|
|
3211
|
+
*
|
|
3212
|
+
* Create a per diem for the company. `name`, `currency`, and `rate_cents` are
|
|
3213
|
+
* required; the created per diem is returned.
|
|
3214
|
+
*
|
|
3215
|
+
*
|
|
3216
|
+
* **Required scope:**
|
|
3217
|
+
*
|
|
3218
|
+
* `per_diems:create`
|
|
3219
|
+
*
|
|
3220
|
+
*/
|
|
3221
|
+
static createPerDiem(options) {
|
|
3222
|
+
return (options?.client ?? client).post({
|
|
3223
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3224
|
+
url: '/api/v1/per_diems',
|
|
3225
|
+
...options,
|
|
3226
|
+
headers: {
|
|
3227
|
+
'Content-Type': 'application/json',
|
|
3228
|
+
...options?.headers
|
|
3229
|
+
}
|
|
3230
|
+
});
|
|
3231
|
+
}
|
|
3232
|
+
/**
|
|
3233
|
+
* Delete per diem
|
|
3234
|
+
*
|
|
3235
|
+
* Permanently remove a per diem, for undoing one created in error. The removed
|
|
3236
|
+
* rate is returned. A per diem already applied to a time card cannot be removed
|
|
3237
|
+
* (`422`); deactivate it instead with `PATCH is_active: false`, which retires it
|
|
3238
|
+
* while time-card history keeps its reference.
|
|
3239
|
+
*
|
|
3240
|
+
*
|
|
3241
|
+
* **Required scope:**
|
|
3242
|
+
*
|
|
3243
|
+
* `per_diems:delete`
|
|
3244
|
+
*
|
|
3245
|
+
*/
|
|
3246
|
+
static deletePerDiem(options) {
|
|
3247
|
+
return (options.client ?? client).delete({
|
|
3248
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3249
|
+
url: '/api/v1/per_diems/{id}',
|
|
3250
|
+
...options
|
|
3251
|
+
});
|
|
3252
|
+
}
|
|
3253
|
+
/**
|
|
3254
|
+
* Show per diem
|
|
3255
|
+
*
|
|
3256
|
+
* Fetch a single per diem by id.
|
|
3257
|
+
*
|
|
3258
|
+
* **Required scope:**
|
|
3259
|
+
*
|
|
3260
|
+
* `per_diems:read`
|
|
3261
|
+
*
|
|
3262
|
+
*/
|
|
3263
|
+
static getPerDiem(options) {
|
|
3264
|
+
return (options.client ?? client).get({
|
|
3265
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3266
|
+
url: '/api/v1/per_diems/{id}',
|
|
3267
|
+
...options
|
|
3268
|
+
});
|
|
3269
|
+
}
|
|
3270
|
+
/**
|
|
3271
|
+
* Update per diem
|
|
3272
|
+
*
|
|
3273
|
+
* Update a per diem. Only the supplied fields change; the updated per diem is
|
|
3274
|
+
* returned.
|
|
3275
|
+
*
|
|
3276
|
+
*
|
|
3277
|
+
* **Required scope:**
|
|
3278
|
+
*
|
|
3279
|
+
* `per_diems:update`
|
|
3280
|
+
*
|
|
3281
|
+
*/
|
|
3282
|
+
static updatePerDiem(options) {
|
|
3283
|
+
return (options.client ?? client).patch({
|
|
3284
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3285
|
+
url: '/api/v1/per_diems/{id}',
|
|
3286
|
+
...options,
|
|
3287
|
+
headers: {
|
|
3288
|
+
'Content-Type': 'application/json',
|
|
3289
|
+
...options.headers
|
|
3290
|
+
}
|
|
3291
|
+
});
|
|
3292
|
+
}
|
|
3293
|
+
}
|
|
3294
|
+
export class PositionFunctions {
|
|
3295
|
+
/**
|
|
3296
|
+
* List position functions
|
|
3297
|
+
*
|
|
3298
|
+
* **Required scope:**
|
|
3299
|
+
*
|
|
3300
|
+
* `position_functions:read`
|
|
3301
|
+
*
|
|
3302
|
+
*/
|
|
3303
|
+
static listPositionFunctions(options) {
|
|
3304
|
+
return (options?.client ?? client).get({
|
|
3305
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3306
|
+
url: '/api/v1/position_functions',
|
|
3307
|
+
...options
|
|
3308
|
+
});
|
|
3309
|
+
}
|
|
3310
|
+
/**
|
|
3311
|
+
* Create position function
|
|
3312
|
+
*
|
|
3313
|
+
* **Required scope:**
|
|
3314
|
+
*
|
|
3315
|
+
* `position_functions:create`
|
|
3316
|
+
*
|
|
3317
|
+
*/
|
|
3318
|
+
static createPositionFunction(options) {
|
|
3319
|
+
return (options?.client ?? client).post({
|
|
3320
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3321
|
+
url: '/api/v1/position_functions',
|
|
3322
|
+
...options,
|
|
3323
|
+
headers: {
|
|
3324
|
+
'Content-Type': 'application/json',
|
|
3325
|
+
...options?.headers
|
|
3326
|
+
}
|
|
3327
|
+
});
|
|
3328
|
+
}
|
|
3329
|
+
/**
|
|
3330
|
+
* Delete position function
|
|
3331
|
+
*
|
|
3332
|
+
* **Required scope:**
|
|
3333
|
+
*
|
|
3334
|
+
* `position_functions:delete`
|
|
3335
|
+
*
|
|
3336
|
+
*/
|
|
3337
|
+
static deletePositionFunction(options) {
|
|
3338
|
+
return (options.client ?? client).delete({
|
|
3339
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3340
|
+
url: '/api/v1/position_functions/{id}',
|
|
3341
|
+
...options
|
|
3342
|
+
});
|
|
3343
|
+
}
|
|
3344
|
+
/**
|
|
3345
|
+
* Show position function
|
|
3346
|
+
*
|
|
3347
|
+
* **Required scope:**
|
|
3348
|
+
*
|
|
3349
|
+
* `position_functions:read`
|
|
3350
|
+
*
|
|
3351
|
+
*/
|
|
3352
|
+
static getPositionFunction(options) {
|
|
3353
|
+
return (options.client ?? client).get({
|
|
3354
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3355
|
+
url: '/api/v1/position_functions/{id}',
|
|
3356
|
+
...options
|
|
3357
|
+
});
|
|
3358
|
+
}
|
|
3359
|
+
/**
|
|
3360
|
+
* Update position function
|
|
3361
|
+
*
|
|
3362
|
+
* **Required scope:**
|
|
3363
|
+
*
|
|
3364
|
+
* `position_functions:update`
|
|
3365
|
+
*
|
|
3366
|
+
*/
|
|
3367
|
+
static updatePositionFunction(options) {
|
|
3368
|
+
return (options.client ?? client).patch({
|
|
3369
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3370
|
+
url: '/api/v1/position_functions/{id}',
|
|
3371
|
+
...options,
|
|
3372
|
+
headers: {
|
|
3373
|
+
'Content-Type': 'application/json',
|
|
3374
|
+
...options.headers
|
|
3375
|
+
}
|
|
3376
|
+
});
|
|
3377
|
+
}
|
|
3378
|
+
}
|
|
3379
|
+
export class ProductionCompletions {
|
|
3380
|
+
/**
|
|
3381
|
+
* List production completions
|
|
3382
|
+
*
|
|
3383
|
+
* **Required scope:**
|
|
3384
|
+
*
|
|
3385
|
+
* `production.completions:read`
|
|
3386
|
+
*
|
|
3387
|
+
*/
|
|
3388
|
+
static listCompletions(options) {
|
|
3389
|
+
return (options?.client ?? client).get({
|
|
3390
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3391
|
+
url: '/api/v1/production/completions',
|
|
3392
|
+
...options
|
|
3393
|
+
});
|
|
3394
|
+
}
|
|
3395
|
+
/**
|
|
3396
|
+
* Create Production Completion
|
|
3397
|
+
*
|
|
3398
|
+
* **Required scope:**
|
|
3399
|
+
*
|
|
3400
|
+
* `production.completions:create`
|
|
3401
|
+
*
|
|
3402
|
+
*/
|
|
3403
|
+
static createCompletion(options) {
|
|
3404
|
+
return (options?.client ?? client).post({
|
|
3405
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3406
|
+
url: '/api/v1/production/completions',
|
|
3407
|
+
...options,
|
|
3408
|
+
headers: {
|
|
3409
|
+
'Content-Type': 'application/json',
|
|
3410
|
+
...options?.headers
|
|
3411
|
+
}
|
|
3412
|
+
});
|
|
3413
|
+
}
|
|
3414
|
+
/**
|
|
3415
|
+
* Destroy Production Completion
|
|
3416
|
+
*
|
|
3417
|
+
* **Required scope:**
|
|
3418
|
+
*
|
|
3419
|
+
* `production.completions:delete`
|
|
3420
|
+
*
|
|
3421
|
+
*/
|
|
3422
|
+
static deleteCompletion(options) {
|
|
3423
|
+
return (options.client ?? client).delete({
|
|
3424
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3425
|
+
url: '/api/v1/production/completions/{id}',
|
|
3426
|
+
...options
|
|
3427
|
+
});
|
|
3428
|
+
}
|
|
3429
|
+
/**
|
|
3430
|
+
* Show production completion
|
|
3431
|
+
*
|
|
3432
|
+
* **Required scope:**
|
|
3433
|
+
*
|
|
3434
|
+
* `production.completions:read`
|
|
3435
|
+
*
|
|
3436
|
+
*/
|
|
3437
|
+
static getCompletion(options) {
|
|
3438
|
+
return (options.client ?? client).get({
|
|
3439
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3440
|
+
url: '/api/v1/production/completions/{id}',
|
|
3441
|
+
...options
|
|
3442
|
+
});
|
|
3443
|
+
}
|
|
3444
|
+
/**
|
|
3445
|
+
* Update Production Completion
|
|
3446
|
+
*
|
|
3447
|
+
* **Required scope:**
|
|
3448
|
+
*
|
|
3449
|
+
* `production.completions:update`
|
|
3450
|
+
*
|
|
3451
|
+
*/
|
|
3452
|
+
static updateCompletion(options) {
|
|
3453
|
+
return (options.client ?? client).patch({
|
|
3454
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3455
|
+
url: '/api/v1/production/completions/{id}',
|
|
3456
|
+
...options,
|
|
3457
|
+
headers: {
|
|
3458
|
+
'Content-Type': 'application/json',
|
|
3459
|
+
...options.headers
|
|
3460
|
+
}
|
|
3461
|
+
});
|
|
3462
|
+
}
|
|
3463
|
+
}
|
|
3464
|
+
export class Projects {
|
|
3465
|
+
/**
|
|
3466
|
+
* List projects
|
|
3467
|
+
*
|
|
3468
|
+
* List the company's projects — the top-level containers that organize jobs into
|
|
3469
|
+
* federal and regional PWA compliance scopes. Returned oldest first (ordered by
|
|
3470
|
+
* creation time, then id) and scoped to the API key's company, so projects owned
|
|
3471
|
+
* by other companies are excluded. Narrow with the `filter[...]` query parameters
|
|
3472
|
+
* and the `created_at`/`updated_at` time filters; results are paginated.
|
|
3473
|
+
*
|
|
3474
|
+
*
|
|
3475
|
+
* **Required scope:**
|
|
3476
|
+
*
|
|
3477
|
+
* `projects:read`
|
|
3478
|
+
*
|
|
3479
|
+
*/
|
|
3480
|
+
static listProjects(options) {
|
|
3481
|
+
return (options?.client ?? client).get({
|
|
3482
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3483
|
+
url: '/api/v1/projects',
|
|
3484
|
+
...options
|
|
3485
|
+
});
|
|
3486
|
+
}
|
|
3487
|
+
/**
|
|
3488
|
+
* Create project
|
|
3489
|
+
*
|
|
3490
|
+
* Create a project owned by the API key's company (owned_by_company_id is set
|
|
3491
|
+
* automatically from the key). Requires `name`, and `created_by_user_id` must
|
|
3492
|
+
* reference a member of the owning company. `budget_currency` defaults to USD;
|
|
3493
|
+
* when `federal_pwa_mode` is `none`, `asset_owner` is forced to false and the
|
|
3494
|
+
* federal-PWA-only fields (administrator name/email/phone, budget, and the
|
|
3495
|
+
* prevailing-wage lock-in / beginning-of-construction / placed-in-service dates)
|
|
3496
|
+
* are dropped. Returns 201 with the created project; a duplicate name within the
|
|
3497
|
+
* company, a creator outside the owning company, end_date before start_date, an
|
|
3498
|
+
* unknown PWA mode, an unparseable date, or a regional mode without a region each
|
|
3499
|
+
* return 422.
|
|
3500
|
+
*
|
|
3501
|
+
*
|
|
3502
|
+
* **Required scope:**
|
|
3503
|
+
*
|
|
3504
|
+
* `projects:create`
|
|
3505
|
+
*
|
|
3506
|
+
*/
|
|
3507
|
+
static createProject(options) {
|
|
3508
|
+
return (options.client ?? client).post({
|
|
3509
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3510
|
+
url: '/api/v1/projects',
|
|
3511
|
+
...options,
|
|
3512
|
+
headers: {
|
|
3513
|
+
'Content-Type': 'application/json',
|
|
3514
|
+
...options.headers
|
|
3515
|
+
}
|
|
3516
|
+
});
|
|
3517
|
+
}
|
|
3518
|
+
/**
|
|
3519
|
+
* Show project
|
|
3520
|
+
*
|
|
3521
|
+
* Fetch a single project by id. Scoped to the API key's company — a project owned
|
|
3522
|
+
* by another company, or an unknown id, returns 404.
|
|
3523
|
+
*
|
|
3524
|
+
*
|
|
3525
|
+
* **Required scope:**
|
|
3526
|
+
*
|
|
3527
|
+
* `projects:read`
|
|
3528
|
+
*
|
|
3529
|
+
*/
|
|
3530
|
+
static getProject(options) {
|
|
3531
|
+
return (options.client ?? client).get({
|
|
3532
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3533
|
+
url: '/api/v1/projects/{id}',
|
|
3534
|
+
...options
|
|
3535
|
+
});
|
|
3536
|
+
}
|
|
3537
|
+
/**
|
|
3538
|
+
* Update project
|
|
3539
|
+
*
|
|
3540
|
+
* Update a project's attributes. `name` cannot be blanked, and
|
|
3541
|
+
* `created_by_user_id` is immutable — any request that sets, changes, or clears it
|
|
3542
|
+
* returns 422. Switching `federal_pwa_mode` to `none` forces `asset_owner` false
|
|
3543
|
+
* and drops the federal-PWA-only params (previously persisted values are left
|
|
3544
|
+
* untouched); `budget_currency` defaults to USD when blank. A project owned by
|
|
3545
|
+
* another company returns 403; an unknown id returns 404.
|
|
3546
|
+
*
|
|
3547
|
+
*
|
|
3548
|
+
* **Required scope:**
|
|
3549
|
+
*
|
|
3550
|
+
* `projects:update`
|
|
3551
|
+
*
|
|
3552
|
+
*/
|
|
3553
|
+
static updateProject(options) {
|
|
3554
|
+
return (options.client ?? client).patch({
|
|
3555
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3556
|
+
url: '/api/v1/projects/{id}',
|
|
3557
|
+
...options,
|
|
3558
|
+
headers: {
|
|
3559
|
+
'Content-Type': 'application/json',
|
|
3560
|
+
...options.headers
|
|
3561
|
+
}
|
|
3562
|
+
});
|
|
3563
|
+
}
|
|
3564
|
+
}
|
|
3565
|
+
export class Users {
|
|
3566
|
+
/**
|
|
3567
|
+
* Create PWA company user details
|
|
3568
|
+
*
|
|
3569
|
+
* **Required scope:**
|
|
3570
|
+
*
|
|
3571
|
+
* `pwa.company_user_details:create`
|
|
3572
|
+
*
|
|
3573
|
+
*/
|
|
3574
|
+
static createCompanyUserDetail(options) {
|
|
3575
|
+
return (options.client ?? client).post({
|
|
3576
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3577
|
+
url: '/api/v1/pwa/company_user_details',
|
|
3578
|
+
...options,
|
|
3579
|
+
headers: {
|
|
3580
|
+
'Content-Type': 'application/json',
|
|
3581
|
+
...options.headers
|
|
3582
|
+
}
|
|
3583
|
+
});
|
|
3584
|
+
}
|
|
3585
|
+
/**
|
|
3586
|
+
* Update PWA company user details
|
|
3587
|
+
*
|
|
3588
|
+
* **Required scope:**
|
|
3589
|
+
*
|
|
3590
|
+
* `pwa.company_user_details:update`
|
|
3591
|
+
*
|
|
3592
|
+
*/
|
|
3593
|
+
static updateCompanyUserDetail(options) {
|
|
3594
|
+
return (options.client ?? client).patch({
|
|
3595
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3596
|
+
url: '/api/v1/pwa/company_user_details/{id}',
|
|
3597
|
+
...options,
|
|
3598
|
+
headers: {
|
|
3599
|
+
'Content-Type': 'application/json',
|
|
3600
|
+
...options.headers
|
|
3601
|
+
}
|
|
3602
|
+
});
|
|
3603
|
+
}
|
|
3604
|
+
/**
|
|
3605
|
+
* List scheduled compensation changes for user's employment
|
|
3606
|
+
*
|
|
3607
|
+
* **Required scope:**
|
|
3608
|
+
*
|
|
3609
|
+
* `users.companies.scheduled_changes:read`
|
|
3610
|
+
*
|
|
3611
|
+
*/
|
|
3612
|
+
static listUserCompanyScheduledChanges(options) {
|
|
3613
|
+
return (options.client ?? client).get({
|
|
3614
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3615
|
+
url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes',
|
|
3616
|
+
...options
|
|
3617
|
+
});
|
|
3618
|
+
}
|
|
3619
|
+
/**
|
|
3620
|
+
* Create scheduled change to user's employment information
|
|
3621
|
+
*
|
|
3622
|
+
* **Required scope:**
|
|
3623
|
+
*
|
|
3624
|
+
* `users.companies.scheduled_changes:create`
|
|
3625
|
+
*
|
|
3626
|
+
*/
|
|
3627
|
+
static createUserCompanyScheduledChange(options) {
|
|
3628
|
+
return (options.client ?? client).post({
|
|
3629
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3630
|
+
url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes',
|
|
3631
|
+
...options,
|
|
3632
|
+
headers: {
|
|
3633
|
+
'Content-Type': 'application/json',
|
|
3634
|
+
...options.headers
|
|
3635
|
+
}
|
|
3636
|
+
});
|
|
3637
|
+
}
|
|
3638
|
+
/**
|
|
3639
|
+
* Cancel scheduled compensation change (removes the future version from the timeline)
|
|
3640
|
+
*
|
|
3641
|
+
* **Required scope:**
|
|
3642
|
+
*
|
|
3643
|
+
* `users.companies.scheduled_changes:delete`
|
|
3644
|
+
*
|
|
3645
|
+
*/
|
|
3646
|
+
static cancelUserCompanyScheduledChange(options) {
|
|
3647
|
+
return (options.client ?? client).delete({
|
|
3648
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3649
|
+
url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes/{id}',
|
|
3650
|
+
...options
|
|
3651
|
+
});
|
|
3652
|
+
}
|
|
3653
|
+
/**
|
|
3654
|
+
* Update scheduled compensation change
|
|
3655
|
+
*
|
|
3656
|
+
* **Required scope:**
|
|
3657
|
+
*
|
|
3658
|
+
* `users.companies.scheduled_changes:update`
|
|
3659
|
+
*
|
|
3660
|
+
*/
|
|
3661
|
+
static updateScheduledChange(options) {
|
|
3662
|
+
return (options.client ?? client).patch({
|
|
3663
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3664
|
+
url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes/{id}',
|
|
3665
|
+
...options,
|
|
3666
|
+
headers: {
|
|
3667
|
+
'Content-Type': 'application/json',
|
|
3668
|
+
...options.headers
|
|
3669
|
+
}
|
|
3670
|
+
});
|
|
3671
|
+
}
|
|
3672
|
+
/**
|
|
3673
|
+
* Create scheduled termination to user's employment
|
|
3674
|
+
*
|
|
3675
|
+
* **Required scope:**
|
|
3676
|
+
*
|
|
3677
|
+
* `users.companies.scheduled_termination:create`
|
|
3678
|
+
*
|
|
3679
|
+
*/
|
|
3680
|
+
static createScheduledTermination(options) {
|
|
3681
|
+
return (options.client ?? client).post({
|
|
3682
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3683
|
+
url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_termination',
|
|
3684
|
+
...options,
|
|
3685
|
+
headers: {
|
|
3686
|
+
'Content-Type': 'application/json',
|
|
3687
|
+
...options.headers
|
|
3688
|
+
}
|
|
3689
|
+
});
|
|
3690
|
+
}
|
|
3691
|
+
/**
|
|
3692
|
+
* Cancel scheduled termination (restores open-ended employment)
|
|
3693
|
+
*
|
|
3694
|
+
* **Required scope:**
|
|
3695
|
+
*
|
|
3696
|
+
* `users.companies.scheduled_termination:delete`
|
|
3697
|
+
*
|
|
3698
|
+
*/
|
|
3699
|
+
static cancelUserCompanyScheduledTermination(options) {
|
|
3700
|
+
return (options.client ?? client).delete({
|
|
3701
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3702
|
+
url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_termination/{id}',
|
|
3703
|
+
...options
|
|
3704
|
+
});
|
|
3705
|
+
}
|
|
3706
|
+
/**
|
|
3707
|
+
* Create employment for existing user
|
|
3708
|
+
*
|
|
3709
|
+
* **Required scope:**
|
|
3710
|
+
*
|
|
3711
|
+
* `users.companies:create`
|
|
3712
|
+
*
|
|
3713
|
+
*/
|
|
3714
|
+
static createCompany(options) {
|
|
3715
|
+
return (options.client ?? client).post({
|
|
3716
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3717
|
+
url: '/api/v1/users/{user_id}/companies',
|
|
3718
|
+
...options,
|
|
3719
|
+
headers: {
|
|
3720
|
+
'Content-Type': 'application/json',
|
|
3721
|
+
...options.headers
|
|
3722
|
+
}
|
|
3723
|
+
});
|
|
3724
|
+
}
|
|
3725
|
+
/**
|
|
3726
|
+
* Remove employment entirely (retroactive, irreversible)
|
|
3727
|
+
*
|
|
3728
|
+
* **Required scope:**
|
|
3729
|
+
*
|
|
3730
|
+
* `users.companies:delete`
|
|
3731
|
+
*
|
|
3732
|
+
*/
|
|
3733
|
+
static removeUserFromCompany(options) {
|
|
3734
|
+
return (options.client ?? client).delete({
|
|
3735
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3736
|
+
url: '/api/v1/users/{user_id}/companies/{company_id}',
|
|
3737
|
+
...options
|
|
3738
|
+
});
|
|
3739
|
+
}
|
|
3740
|
+
/**
|
|
3741
|
+
* Update user's employment information
|
|
3742
|
+
*
|
|
3743
|
+
* **Required scope:**
|
|
3744
|
+
*
|
|
3745
|
+
* `users.companies:update`
|
|
3746
|
+
*
|
|
3747
|
+
*/
|
|
3748
|
+
static updateCompany(options) {
|
|
3749
|
+
return (options.client ?? client).patch({
|
|
3750
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3751
|
+
url: '/api/v1/users/{user_id}/companies/{company_id}',
|
|
3752
|
+
...options,
|
|
3753
|
+
headers: {
|
|
3754
|
+
'Content-Type': 'application/json',
|
|
3755
|
+
...options.headers
|
|
3756
|
+
}
|
|
3757
|
+
});
|
|
3758
|
+
}
|
|
3759
|
+
/**
|
|
3760
|
+
* List users
|
|
3761
|
+
*
|
|
3762
|
+
* **Required scope:**
|
|
3763
|
+
*
|
|
3764
|
+
* `users:read`
|
|
3765
|
+
*
|
|
3766
|
+
*/
|
|
3767
|
+
static listUsers(options) {
|
|
3768
|
+
return (options?.client ?? client).get({
|
|
3769
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3770
|
+
url: '/api/v1/users',
|
|
3771
|
+
...options
|
|
3772
|
+
});
|
|
3773
|
+
}
|
|
3774
|
+
/**
|
|
3775
|
+
* Create user
|
|
3776
|
+
*
|
|
3777
|
+
* **Required scope:**
|
|
3778
|
+
*
|
|
3779
|
+
* `users:create`
|
|
3780
|
+
*
|
|
3781
|
+
*/
|
|
3782
|
+
static createUser(options) {
|
|
3783
|
+
return (options.client ?? client).post({
|
|
3784
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3785
|
+
url: '/api/v1/users',
|
|
3786
|
+
...options,
|
|
3787
|
+
headers: {
|
|
3788
|
+
'Content-Type': 'application/json',
|
|
3789
|
+
...options.headers
|
|
3790
|
+
}
|
|
3791
|
+
});
|
|
3792
|
+
}
|
|
3793
|
+
/**
|
|
3794
|
+
* Show user
|
|
3795
|
+
*
|
|
3796
|
+
* **Required scope:**
|
|
3797
|
+
*
|
|
3798
|
+
* `users:read`
|
|
3799
|
+
*
|
|
3800
|
+
*/
|
|
3801
|
+
static getUser(options) {
|
|
3802
|
+
return (options.client ?? client).get({
|
|
3803
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3804
|
+
url: '/api/v1/users/{id}',
|
|
3805
|
+
...options
|
|
3806
|
+
});
|
|
3807
|
+
}
|
|
3808
|
+
/**
|
|
3809
|
+
* Update user
|
|
3810
|
+
*
|
|
3811
|
+
* **Required scope:**
|
|
3812
|
+
*
|
|
3813
|
+
* `users:update`
|
|
3814
|
+
*
|
|
3815
|
+
*/
|
|
3816
|
+
static updateUser(options) {
|
|
3817
|
+
return (options.client ?? client).patch({
|
|
3818
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3819
|
+
url: '/api/v1/users/{id}',
|
|
3820
|
+
...options,
|
|
3821
|
+
headers: {
|
|
3822
|
+
'Content-Type': 'application/json',
|
|
3823
|
+
...options.headers
|
|
3824
|
+
}
|
|
3825
|
+
});
|
|
3826
|
+
}
|
|
3827
|
+
}
|
|
3828
|
+
export class Tasks {
|
|
3829
|
+
/**
|
|
3830
|
+
* Create form assignment task
|
|
3831
|
+
*
|
|
3832
|
+
* **Required scope:**
|
|
3833
|
+
*
|
|
3834
|
+
* `tasks.form_assignment_tasks:create`
|
|
3835
|
+
*
|
|
3836
|
+
*/
|
|
3837
|
+
static createFormAssignmentTask(options) {
|
|
3838
|
+
return (options?.client ?? client).post({
|
|
3839
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3840
|
+
url: '/api/v1/tasks/form_assignment_tasks',
|
|
3841
|
+
...options,
|
|
3842
|
+
headers: {
|
|
3843
|
+
'Content-Type': 'application/json',
|
|
3844
|
+
...options?.headers
|
|
3845
|
+
}
|
|
3846
|
+
});
|
|
3847
|
+
}
|
|
3848
|
+
}
|
|
3849
|
+
export class TimeCards {
|
|
3850
|
+
/**
|
|
3851
|
+
* Lock or unlock time card
|
|
3852
|
+
*
|
|
3853
|
+
* **Required scope:**
|
|
3854
|
+
*
|
|
3855
|
+
* `time_cards.locks:update`
|
|
3856
|
+
*
|
|
3857
|
+
*/
|
|
3858
|
+
static setTimeCardLock(options) {
|
|
3859
|
+
return (options.client ?? client).patch({
|
|
3860
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3861
|
+
url: '/api/v1/time_cards/{time_card_id}/lock',
|
|
3862
|
+
...options,
|
|
3863
|
+
headers: {
|
|
3864
|
+
'Content-Type': 'application/json',
|
|
3865
|
+
...options.headers
|
|
3866
|
+
}
|
|
3867
|
+
});
|
|
3868
|
+
}
|
|
3869
|
+
/**
|
|
3870
|
+
* Create manager time card approval
|
|
3871
|
+
*
|
|
3872
|
+
* **Required scope:**
|
|
3873
|
+
*
|
|
3874
|
+
* `time_cards.manager_time_card_approvals:create`
|
|
3875
|
+
*
|
|
3876
|
+
*/
|
|
3877
|
+
static createManagerTimeCardApproval(options) {
|
|
3878
|
+
return (options.client ?? client).post({
|
|
3879
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3880
|
+
url: '/api/v1/time_cards/{time_card_id}/manager_time_card_approvals',
|
|
3881
|
+
...options,
|
|
3882
|
+
headers: {
|
|
3883
|
+
'Content-Type': 'application/json',
|
|
3884
|
+
...options.headers
|
|
3885
|
+
}
|
|
3886
|
+
});
|
|
3887
|
+
}
|
|
3888
|
+
/**
|
|
3889
|
+
* List time card per diems
|
|
3890
|
+
*
|
|
3891
|
+
* **Required scope:**
|
|
3892
|
+
*
|
|
3893
|
+
* `time_cards.per_diems:read`
|
|
3894
|
+
*
|
|
3895
|
+
*/
|
|
3896
|
+
static listTimeCardPerDiems(options) {
|
|
3897
|
+
return (options.client ?? client).get({
|
|
3898
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3899
|
+
url: '/api/v1/time_cards/{time_card_id}/per_diems',
|
|
3900
|
+
...options
|
|
3901
|
+
});
|
|
3902
|
+
}
|
|
3903
|
+
/**
|
|
3904
|
+
* Create time card per diem
|
|
3905
|
+
*
|
|
3906
|
+
* **Required scope:**
|
|
3907
|
+
*
|
|
3908
|
+
* `time_cards.per_diems:create`
|
|
3909
|
+
*
|
|
3910
|
+
*/
|
|
3911
|
+
static createTimeCardPerDiem(options) {
|
|
3912
|
+
return (options.client ?? client).post({
|
|
3913
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3914
|
+
url: '/api/v1/time_cards/{time_card_id}/per_diems',
|
|
3915
|
+
...options,
|
|
3916
|
+
headers: {
|
|
3917
|
+
'Content-Type': 'application/json',
|
|
3918
|
+
...options.headers
|
|
3919
|
+
}
|
|
3920
|
+
});
|
|
3921
|
+
}
|
|
3922
|
+
/**
|
|
3923
|
+
* Delete time card per diem
|
|
3924
|
+
*
|
|
3925
|
+
* **Required scope:**
|
|
3926
|
+
*
|
|
3927
|
+
* `time_cards.per_diems:delete`
|
|
3928
|
+
*
|
|
3929
|
+
*/
|
|
3930
|
+
static deleteTimeCardPerDiem(options) {
|
|
3931
|
+
return (options.client ?? client).delete({
|
|
3932
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3933
|
+
url: '/api/v1/time_cards/{time_card_id}/per_diems/{id}',
|
|
3934
|
+
...options
|
|
3935
|
+
});
|
|
3936
|
+
}
|
|
3937
|
+
/**
|
|
3938
|
+
* Update time card per diem
|
|
3939
|
+
*
|
|
3940
|
+
* **Required scope:**
|
|
3941
|
+
*
|
|
3942
|
+
* `time_cards.per_diems:update`
|
|
3943
|
+
*
|
|
3944
|
+
*/
|
|
3945
|
+
static updateTimeCardPerDiem(options) {
|
|
3946
|
+
return (options.client ?? client).patch({
|
|
3947
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3948
|
+
url: '/api/v1/time_cards/{time_card_id}/per_diems/{id}',
|
|
3949
|
+
...options,
|
|
3950
|
+
headers: {
|
|
3951
|
+
'Content-Type': 'application/json',
|
|
3952
|
+
...options.headers
|
|
3953
|
+
}
|
|
3954
|
+
});
|
|
3955
|
+
}
|
|
3956
|
+
/**
|
|
3957
|
+
* Create worker time card approval
|
|
3958
|
+
*
|
|
3959
|
+
* **Required scope:**
|
|
3960
|
+
*
|
|
3961
|
+
* `time_cards.worker_time_card_approvals:create`
|
|
3962
|
+
*
|
|
3963
|
+
*/
|
|
3964
|
+
static createWorkerTimeCardApproval(options) {
|
|
3965
|
+
return (options.client ?? client).post({
|
|
3966
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3967
|
+
url: '/api/v1/time_cards/{time_card_id}/worker_time_card_approvals',
|
|
3968
|
+
...options,
|
|
3969
|
+
headers: {
|
|
3970
|
+
'Content-Type': 'application/json',
|
|
3971
|
+
...options.headers
|
|
3972
|
+
}
|
|
3973
|
+
});
|
|
3974
|
+
}
|
|
3975
|
+
/**
|
|
3976
|
+
* List time cards
|
|
3977
|
+
*
|
|
3978
|
+
* **Required scope:**
|
|
3979
|
+
*
|
|
3980
|
+
* `time_cards:read`
|
|
3981
|
+
*
|
|
3982
|
+
*/
|
|
3983
|
+
static listTimeCards(options) {
|
|
3984
|
+
return (options?.client ?? client).get({
|
|
3985
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
3986
|
+
url: '/api/v1/time_cards',
|
|
3987
|
+
...options
|
|
3988
|
+
});
|
|
3989
|
+
}
|
|
3990
|
+
/**
|
|
3991
|
+
* Show time card
|
|
3992
|
+
*
|
|
3993
|
+
* **Required scope:**
|
|
3994
|
+
*
|
|
3995
|
+
* `time_cards:read`
|
|
3996
|
+
*
|
|
3997
|
+
*/
|
|
3998
|
+
static getTimeCard(options) {
|
|
3999
|
+
return (options.client ?? client).get({
|
|
4000
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4001
|
+
url: '/api/v1/time_cards/{id}',
|
|
4002
|
+
...options
|
|
4003
|
+
});
|
|
4004
|
+
}
|
|
4005
|
+
}
|
|
4006
|
+
export class PriorPeriodAdjustments {
|
|
4007
|
+
/**
|
|
4008
|
+
* List prior period adjustments
|
|
4009
|
+
*
|
|
4010
|
+
* **Required scope:**
|
|
4011
|
+
*
|
|
4012
|
+
* `time_cards.prior_period_adjustments:read`
|
|
4013
|
+
*
|
|
4014
|
+
*/
|
|
4015
|
+
static listPriorPeriodAdjustments(options) {
|
|
4016
|
+
return (options.client ?? client).get({
|
|
4017
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4018
|
+
url: '/api/v1/time_cards/{time_card_id}/prior_period_adjustments',
|
|
4019
|
+
...options
|
|
4020
|
+
});
|
|
4021
|
+
}
|
|
4022
|
+
/**
|
|
4023
|
+
* Show prior period adjustment
|
|
4024
|
+
*
|
|
4025
|
+
* **Required scope:**
|
|
4026
|
+
*
|
|
4027
|
+
* `time_cards.prior_period_adjustments:read`
|
|
4028
|
+
*
|
|
4029
|
+
*/
|
|
4030
|
+
static getPriorPeriodAdjustment(options) {
|
|
4031
|
+
return (options.client ?? client).get({
|
|
4032
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4033
|
+
url: '/api/v1/time_cards/{time_card_id}/prior_period_adjustments/{id}',
|
|
4034
|
+
...options
|
|
4035
|
+
});
|
|
4036
|
+
}
|
|
4037
|
+
}
|
|
4038
|
+
export class TimeEntries {
|
|
4039
|
+
/**
|
|
4040
|
+
* List time entry versions
|
|
4041
|
+
*
|
|
4042
|
+
* **Required scope:**
|
|
4043
|
+
*
|
|
4044
|
+
* `time_entries.deltas:read`
|
|
4045
|
+
*
|
|
4046
|
+
*/
|
|
4047
|
+
static listDeltas(options) {
|
|
4048
|
+
return (options?.client ?? client).get({
|
|
4049
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4050
|
+
url: '/api/v1/time_entries/deltas',
|
|
4051
|
+
...options
|
|
4052
|
+
});
|
|
4053
|
+
}
|
|
4054
|
+
/**
|
|
4055
|
+
* List time entries
|
|
4056
|
+
*
|
|
4057
|
+
* List the company's time entries — each an atomic block of tracked work with
|
|
4058
|
+
* start/end times, an optional timecode classification, optional job, rate,
|
|
4059
|
+
* and approval status. Results are ordered by start_time then id (ascending)
|
|
4060
|
+
* and cursor-paginated. Narrow with filter[user_id], filter[job_id] (or
|
|
4061
|
+
* filter[job_id][null]=true for entries with no job), and
|
|
4062
|
+
* filter[time_card_id]; the controller also accepts gte/lte time-range
|
|
4063
|
+
* filters on start_time, end_time, created_at, and updated_at.
|
|
4064
|
+
*
|
|
4065
|
+
*
|
|
4066
|
+
* **Required scope:**
|
|
4067
|
+
*
|
|
4068
|
+
* `time_entries:read`
|
|
4069
|
+
*
|
|
4070
|
+
*/
|
|
4071
|
+
static listTimeEntries(options) {
|
|
4072
|
+
return (options?.client ?? client).get({
|
|
4073
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4074
|
+
url: '/api/v1/time_entries',
|
|
4075
|
+
...options
|
|
4076
|
+
});
|
|
4077
|
+
}
|
|
4078
|
+
/**
|
|
4079
|
+
* Create time entry
|
|
4080
|
+
*
|
|
4081
|
+
* Create a time entry. Required: time_card_id, start_time, and end_time;
|
|
4082
|
+
* user_id is derived server-side from the time card. Both start_time and
|
|
4083
|
+
* end_time must fall on a whole-minute boundary (nonzero seconds are
|
|
4084
|
+
* rejected); start_time must fall within the time card's pay period, and
|
|
4085
|
+
* end_time must be after start_time. Optional job_id (the worker must have a
|
|
4086
|
+
* Position covering that job at start_time), timecode_id (must be one of the
|
|
4087
|
+
* company's default timecodes), state, description, hourly_rate_cents (derived
|
|
4088
|
+
* from the position/user default when omitted), and feature_ids. Supplying
|
|
4089
|
+
* feature_ids — or setting feature_allocation_acknowledged true — satisfies a
|
|
4090
|
+
* job that requires a feature allocation.
|
|
4091
|
+
*
|
|
4092
|
+
*
|
|
4093
|
+
* **Required scope:**
|
|
4094
|
+
*
|
|
4095
|
+
* `time_entries:create`
|
|
4096
|
+
*
|
|
4097
|
+
*/
|
|
4098
|
+
static createTimeEntry(options) {
|
|
4099
|
+
return (options.client ?? client).post({
|
|
4100
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4101
|
+
url: '/api/v1/time_entries',
|
|
4102
|
+
...options,
|
|
4103
|
+
headers: {
|
|
4104
|
+
'Content-Type': 'application/json',
|
|
4105
|
+
...options.headers
|
|
4106
|
+
}
|
|
4107
|
+
});
|
|
4108
|
+
}
|
|
4109
|
+
/**
|
|
4110
|
+
* Delete time entry
|
|
4111
|
+
*
|
|
4112
|
+
* Hard-delete a time entry by id (the record is removed) and return its final
|
|
4113
|
+
* serialized representation. Destruction runs the model's after_destroy
|
|
4114
|
+
* cascade — recomputing the time card's rollups, uncategorized allocations,
|
|
4115
|
+
* PWA/actuals (when paystubs exist), and reassigning shifts. Returns 403 when
|
|
4116
|
+
* the entry belongs to another company, and 422 (RecordNotDestroyed) when its
|
|
4117
|
+
* time card is locked.
|
|
4118
|
+
*
|
|
4119
|
+
*
|
|
4120
|
+
* **Required scope:**
|
|
4121
|
+
*
|
|
4122
|
+
* `time_entries:delete`
|
|
4123
|
+
*
|
|
4124
|
+
*/
|
|
4125
|
+
static deleteTimeEntry(options) {
|
|
4126
|
+
return (options.client ?? client).delete({
|
|
4127
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4128
|
+
url: '/api/v1/time_entries/{id}',
|
|
4129
|
+
...options
|
|
4130
|
+
});
|
|
4131
|
+
}
|
|
4132
|
+
/**
|
|
4133
|
+
* Update time entry
|
|
4134
|
+
*
|
|
4135
|
+
* Update an existing time entry by id; every field in the parameters is
|
|
4136
|
+
* optional and only supplied fields change. Authorization is re-checked after
|
|
4137
|
+
* attributes are assigned, so moving the entry to a time card in another
|
|
4138
|
+
* company is forbidden (403). If the change would push categorized allocation
|
|
4139
|
+
* minutes past the time card's worked minutes, the request returns 422 unless
|
|
4140
|
+
* confirm_allocation_conflict is sent true. The feature-allocation cap is
|
|
4141
|
+
* enforced, and because a persisted feature_ids= writes its join rows
|
|
4142
|
+
* immediately, a rejected save rolls them back within the enclosing
|
|
4143
|
+
* transaction.
|
|
4144
|
+
*
|
|
4145
|
+
*
|
|
4146
|
+
* **Required scope:**
|
|
4147
|
+
*
|
|
4148
|
+
* `time_entries:update`
|
|
4149
|
+
*
|
|
4150
|
+
*/
|
|
4151
|
+
static updateTimeEntry(options) {
|
|
4152
|
+
return (options.client ?? client).patch({
|
|
4153
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4154
|
+
url: '/api/v1/time_entries/{id}',
|
|
4155
|
+
...options,
|
|
4156
|
+
headers: {
|
|
4157
|
+
'Content-Type': 'application/json',
|
|
4158
|
+
...options.headers
|
|
4159
|
+
}
|
|
4160
|
+
});
|
|
4161
|
+
}
|
|
4162
|
+
/**
|
|
4163
|
+
* Create manager time entry approval
|
|
4164
|
+
*
|
|
4165
|
+
* **Required scope:**
|
|
4166
|
+
*
|
|
4167
|
+
* `timekeeping.manager_time_entry_approvals:create`
|
|
4168
|
+
*
|
|
4169
|
+
*/
|
|
4170
|
+
static createManagerTimeEntryApproval(options) {
|
|
4171
|
+
return (options.client ?? client).post({
|
|
4172
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4173
|
+
url: '/api/v1/time_entries/{time_entry_id}/manager_time_entry_approvals',
|
|
4174
|
+
...options,
|
|
4175
|
+
headers: {
|
|
4176
|
+
'Content-Type': 'application/json',
|
|
4177
|
+
...options.headers
|
|
4178
|
+
}
|
|
4179
|
+
});
|
|
4180
|
+
}
|
|
4181
|
+
}
|
|
4182
|
+
export class Timecodes {
|
|
4183
|
+
/**
|
|
4184
|
+
* Cancel all scheduled changes
|
|
4185
|
+
*
|
|
4186
|
+
* **Required scope:**
|
|
4187
|
+
*
|
|
4188
|
+
* `timecodes.scheduled_changes:delete`
|
|
4189
|
+
*
|
|
4190
|
+
*/
|
|
4191
|
+
static cancelTimecodeScheduledChanges(options) {
|
|
4192
|
+
return (options.client ?? client).delete({
|
|
4193
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4194
|
+
url: '/api/v1/timecodes/{timecode_id}/scheduled_changes',
|
|
4195
|
+
...options
|
|
4196
|
+
});
|
|
4197
|
+
}
|
|
4198
|
+
/**
|
|
4199
|
+
* List scheduled changes for timecode
|
|
4200
|
+
*
|
|
4201
|
+
* **Required scope:**
|
|
4202
|
+
*
|
|
4203
|
+
* `timecodes.scheduled_changes:read`
|
|
4204
|
+
*
|
|
4205
|
+
*/
|
|
4206
|
+
static listTimecodeScheduledChanges(options) {
|
|
4207
|
+
return (options.client ?? client).get({
|
|
4208
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4209
|
+
url: '/api/v1/timecodes/{timecode_id}/scheduled_changes',
|
|
4210
|
+
...options
|
|
4211
|
+
});
|
|
4212
|
+
}
|
|
4213
|
+
/**
|
|
4214
|
+
* Schedule future correction on timecode
|
|
4215
|
+
*
|
|
4216
|
+
* **Required scope:**
|
|
4217
|
+
*
|
|
4218
|
+
* `timecodes.scheduled_changes:create`
|
|
4219
|
+
*
|
|
4220
|
+
*/
|
|
4221
|
+
static scheduleTimecodeChange(options) {
|
|
4222
|
+
return (options.client ?? client).post({
|
|
4223
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4224
|
+
url: '/api/v1/timecodes/{timecode_id}/scheduled_changes',
|
|
4225
|
+
...options,
|
|
4226
|
+
headers: {
|
|
4227
|
+
'Content-Type': 'application/json',
|
|
4228
|
+
...options.headers
|
|
4229
|
+
}
|
|
4230
|
+
});
|
|
4231
|
+
}
|
|
4232
|
+
/**
|
|
4233
|
+
* Cancel scheduled termination on timecode
|
|
4234
|
+
*
|
|
4235
|
+
* **Required scope:**
|
|
4236
|
+
*
|
|
4237
|
+
* `timecodes.scheduled_terminations:delete`
|
|
4238
|
+
*
|
|
4239
|
+
*/
|
|
4240
|
+
static cancelTimecodeScheduledTermination(options) {
|
|
4241
|
+
return (options.client ?? client).delete({
|
|
4242
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4243
|
+
url: '/api/v1/timecodes/{timecode_id}/scheduled_termination',
|
|
4244
|
+
...options
|
|
4245
|
+
});
|
|
4246
|
+
}
|
|
4247
|
+
/**
|
|
4248
|
+
* List timecodes
|
|
4249
|
+
*
|
|
4250
|
+
* List the company's timecodes — the work-type classifications that mark
|
|
4251
|
+
* tracked time as paid, overtime-eligible, billable, PWA-eligible, holiday,
|
|
4252
|
+
* PTO, or rest-and-recovery. Returned oldest first (ordered by creation time,
|
|
4253
|
+
* then id) and cursor-paginated; narrow with the `filter[created_at]` and
|
|
4254
|
+
* `filter[updated_at]` query parameters.
|
|
4255
|
+
*
|
|
4256
|
+
*
|
|
4257
|
+
* **Required scope:**
|
|
4258
|
+
*
|
|
4259
|
+
* `timecodes:read`
|
|
4260
|
+
*
|
|
4261
|
+
*/
|
|
4262
|
+
static listTimecodes(options) {
|
|
4263
|
+
return (options?.client ?? client).get({
|
|
4264
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4265
|
+
url: '/api/v1/timecodes',
|
|
4266
|
+
...options
|
|
4267
|
+
});
|
|
4268
|
+
}
|
|
4269
|
+
/**
|
|
4270
|
+
* Create timecode
|
|
4271
|
+
*
|
|
4272
|
+
* Create a timecode for the calling company; `name` is the only required
|
|
4273
|
+
* field, and omitted fields take their model/DB defaults. Its owning company
|
|
4274
|
+
* is set automatically from the API key, and an optional `effective_date`
|
|
4275
|
+
* sets the version's `valid_from` (defaulting to the request time). A timecode
|
|
4276
|
+
* marked `pwa: true` may not also be `restricted_to: non_job`.
|
|
4277
|
+
*
|
|
4278
|
+
*
|
|
4279
|
+
* **Required scope:**
|
|
4280
|
+
*
|
|
4281
|
+
* `timecodes:create`
|
|
4282
|
+
*
|
|
4283
|
+
*/
|
|
4284
|
+
static createTimecode(options) {
|
|
4285
|
+
return (options.client ?? client).post({
|
|
4286
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4287
|
+
url: '/api/v1/timecodes',
|
|
4288
|
+
...options,
|
|
4289
|
+
headers: {
|
|
4290
|
+
'Content-Type': 'application/json',
|
|
4291
|
+
...options.headers
|
|
4292
|
+
}
|
|
4293
|
+
});
|
|
4294
|
+
}
|
|
4295
|
+
/**
|
|
4296
|
+
* Terminate timecode
|
|
4297
|
+
*
|
|
4298
|
+
* Terminate a timecode by closing its valid-time range — a soft delete that
|
|
4299
|
+
* sets `valid_to` to the supplied `termination_date` (defaulting to today)
|
|
4300
|
+
* rather than removing the row, and returns the updated timecode. A
|
|
4301
|
+
* `termination_date` earlier than the timecode's `valid_from` returns 422.
|
|
4302
|
+
*
|
|
4303
|
+
*
|
|
4304
|
+
* **Required scope:**
|
|
4305
|
+
*
|
|
4306
|
+
* `timecodes:delete`
|
|
4307
|
+
*
|
|
4308
|
+
*/
|
|
4309
|
+
static terminateTimecode(options) {
|
|
4310
|
+
return (options.client ?? client).delete({
|
|
4311
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4312
|
+
url: '/api/v1/timecodes/{id}',
|
|
4313
|
+
...options,
|
|
4314
|
+
headers: {
|
|
4315
|
+
'Content-Type': 'application/json',
|
|
4316
|
+
...options.headers
|
|
4317
|
+
}
|
|
4318
|
+
});
|
|
4319
|
+
}
|
|
4320
|
+
/**
|
|
4321
|
+
* Show timecode
|
|
4322
|
+
*
|
|
4323
|
+
* Fetch a single timecode by id.
|
|
4324
|
+
*
|
|
4325
|
+
* **Required scope:**
|
|
4326
|
+
*
|
|
4327
|
+
* `timecodes:read`
|
|
4328
|
+
*
|
|
4329
|
+
*/
|
|
4330
|
+
static getTimecode(options) {
|
|
4331
|
+
return (options.client ?? client).get({
|
|
4332
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4333
|
+
url: '/api/v1/timecodes/{id}',
|
|
4334
|
+
...options
|
|
4335
|
+
});
|
|
4336
|
+
}
|
|
4337
|
+
/**
|
|
4338
|
+
* Update timecode
|
|
4339
|
+
*
|
|
4340
|
+
* Update a timecode by applying a bitemporal correction to its
|
|
4341
|
+
* currently-effective version rather than mutating the row in place; `name`
|
|
4342
|
+
* must remain present, and only the fields sent in the body are changed
|
|
4343
|
+
* (omitted fields keep the current version's values). Changing rate-affecting
|
|
4344
|
+
* attributes (billable, overtime_eligible, unpaid, pwa, holiday, pto,
|
|
4345
|
+
* rest_and_recovery, incentive_pay_eligible) enqueues a background rate
|
|
4346
|
+
* re-sync. An `effective_date` in the body is not read here — the correction
|
|
4347
|
+
* takes effect at the record's existing `valid_from`.
|
|
4348
|
+
*
|
|
4349
|
+
*
|
|
4350
|
+
* **Required scope:**
|
|
4351
|
+
*
|
|
4352
|
+
* `timecodes:update`
|
|
4353
|
+
*
|
|
4354
|
+
*/
|
|
4355
|
+
static updateTimecode(options) {
|
|
4356
|
+
return (options.client ?? client).patch({
|
|
4357
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4358
|
+
url: '/api/v1/timecodes/{id}',
|
|
4359
|
+
...options,
|
|
4360
|
+
headers: {
|
|
4361
|
+
'Content-Type': 'application/json',
|
|
4362
|
+
...options.headers
|
|
4363
|
+
}
|
|
4364
|
+
});
|
|
4365
|
+
}
|
|
4366
|
+
}
|
|
4367
|
+
export class JobTimeCardDays {
|
|
4368
|
+
/**
|
|
4369
|
+
* List job time card days
|
|
4370
|
+
*
|
|
4371
|
+
* **Required scope:**
|
|
4372
|
+
*
|
|
4373
|
+
* `timekeeping.job_time_card_days:read`
|
|
4374
|
+
*
|
|
4375
|
+
*/
|
|
4376
|
+
static listJobTimeCardDays(options) {
|
|
4377
|
+
return (options?.client ?? client).get({
|
|
4378
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4379
|
+
url: '/api/v1/timekeeping/job_time_card_days',
|
|
4380
|
+
...options
|
|
4381
|
+
});
|
|
4382
|
+
}
|
|
4383
|
+
/**
|
|
4384
|
+
* Show job time card day
|
|
4385
|
+
*
|
|
4386
|
+
* **Required scope:**
|
|
4387
|
+
*
|
|
4388
|
+
* `timekeeping.job_time_card_days:read`
|
|
4389
|
+
*
|
|
4390
|
+
*/
|
|
4391
|
+
static getJobTimeCardDay(options) {
|
|
4392
|
+
return (options.client ?? client).get({
|
|
4393
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4394
|
+
url: '/api/v1/timekeeping/job_time_card_days/{id}',
|
|
4395
|
+
...options
|
|
4396
|
+
});
|
|
4397
|
+
}
|
|
4398
|
+
}
|
|
4399
|
+
export class AttestationConfigs {
|
|
4400
|
+
/**
|
|
4401
|
+
* List attestation configs
|
|
4402
|
+
*
|
|
4403
|
+
* **Required scope:**
|
|
4404
|
+
*
|
|
4405
|
+
* `timekeeping.pay_period_configs.attestation_configs:read`
|
|
4406
|
+
*
|
|
4407
|
+
*/
|
|
4408
|
+
static listAttestationConfigs(options) {
|
|
4409
|
+
return (options.client ?? client).get({
|
|
4410
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4411
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/attestation_configs',
|
|
4412
|
+
...options
|
|
4413
|
+
});
|
|
4414
|
+
}
|
|
4415
|
+
/**
|
|
4416
|
+
* Create attestation config
|
|
4417
|
+
*
|
|
4418
|
+
* **Required scope:**
|
|
4419
|
+
*
|
|
4420
|
+
* `timekeeping.pay_period_configs.attestation_configs:create`
|
|
4421
|
+
*
|
|
4422
|
+
*/
|
|
4423
|
+
static createAttestationConfig(options) {
|
|
4424
|
+
return (options.client ?? client).post({
|
|
4425
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4426
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/attestation_configs',
|
|
4427
|
+
...options,
|
|
4428
|
+
headers: {
|
|
4429
|
+
'Content-Type': 'application/json',
|
|
4430
|
+
...options.headers
|
|
4431
|
+
}
|
|
4432
|
+
});
|
|
4433
|
+
}
|
|
4434
|
+
/**
|
|
4435
|
+
* Delete attestation config
|
|
4436
|
+
*
|
|
4437
|
+
* **Required scope:**
|
|
4438
|
+
*
|
|
4439
|
+
* `timekeeping.pay_period_configs.attestation_configs:delete`
|
|
4440
|
+
*
|
|
4441
|
+
*/
|
|
4442
|
+
static deleteAttestationConfig(options) {
|
|
4443
|
+
return (options.client ?? client).delete({
|
|
4444
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4445
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/attestation_configs/{id}',
|
|
4446
|
+
...options
|
|
4447
|
+
});
|
|
4448
|
+
}
|
|
4449
|
+
/**
|
|
4450
|
+
* Show attestation config
|
|
4451
|
+
*
|
|
4452
|
+
* **Required scope:**
|
|
4453
|
+
*
|
|
4454
|
+
* `timekeeping.pay_period_configs.attestation_configs:read`
|
|
4455
|
+
*
|
|
4456
|
+
*/
|
|
4457
|
+
static getAttestationConfig(options) {
|
|
4458
|
+
return (options.client ?? client).get({
|
|
4459
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4460
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/attestation_configs/{id}',
|
|
4461
|
+
...options
|
|
4462
|
+
});
|
|
4463
|
+
}
|
|
4464
|
+
}
|
|
4465
|
+
export class Holidays {
|
|
4466
|
+
/**
|
|
4467
|
+
* List holidays
|
|
4468
|
+
*
|
|
4469
|
+
* **Required scope:**
|
|
4470
|
+
*
|
|
4471
|
+
* `timekeeping.pay_period_configs.holidays:read`
|
|
4472
|
+
*
|
|
4473
|
+
*/
|
|
4474
|
+
static listHolidays(options) {
|
|
4475
|
+
return (options.client ?? client).get({
|
|
4476
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4477
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/holidays',
|
|
4478
|
+
...options
|
|
4479
|
+
});
|
|
4480
|
+
}
|
|
4481
|
+
/**
|
|
4482
|
+
* Create holiday
|
|
4483
|
+
*
|
|
4484
|
+
* **Required scope:**
|
|
4485
|
+
*
|
|
4486
|
+
* `timekeeping.pay_period_configs.holidays:create`
|
|
4487
|
+
*
|
|
4488
|
+
*/
|
|
4489
|
+
static createHoliday(options) {
|
|
4490
|
+
return (options.client ?? client).post({
|
|
4491
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4492
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/holidays',
|
|
4493
|
+
...options,
|
|
4494
|
+
headers: {
|
|
4495
|
+
'Content-Type': 'application/json',
|
|
4496
|
+
...options.headers
|
|
4497
|
+
}
|
|
4498
|
+
});
|
|
4499
|
+
}
|
|
4500
|
+
/**
|
|
4501
|
+
* Delete holiday
|
|
4502
|
+
*
|
|
4503
|
+
* **Required scope:**
|
|
4504
|
+
*
|
|
4505
|
+
* `timekeeping.pay_period_configs.holidays:delete`
|
|
4506
|
+
*
|
|
4507
|
+
*/
|
|
4508
|
+
static deleteHoliday(options) {
|
|
4509
|
+
return (options.client ?? client).delete({
|
|
4510
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4511
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/holidays/{id}',
|
|
4512
|
+
...options
|
|
4513
|
+
});
|
|
4514
|
+
}
|
|
4515
|
+
/**
|
|
4516
|
+
* Update holiday
|
|
4517
|
+
*
|
|
4518
|
+
* **Required scope:**
|
|
4519
|
+
*
|
|
4520
|
+
* `timekeeping.pay_period_configs.holidays:update`
|
|
4521
|
+
*
|
|
4522
|
+
*/
|
|
4523
|
+
static updateHoliday(options) {
|
|
4524
|
+
return (options.client ?? client).patch({
|
|
4525
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4526
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/holidays/{id}',
|
|
4527
|
+
...options,
|
|
4528
|
+
headers: {
|
|
4529
|
+
'Content-Type': 'application/json',
|
|
4530
|
+
...options.headers
|
|
4531
|
+
}
|
|
4532
|
+
});
|
|
4533
|
+
}
|
|
4534
|
+
}
|
|
4535
|
+
export class PaySchedules {
|
|
4536
|
+
/**
|
|
4537
|
+
* List pay schedules
|
|
4538
|
+
*
|
|
4539
|
+
* **Required scope:**
|
|
4540
|
+
*
|
|
4541
|
+
* `timekeeping.pay_period_configs:read`
|
|
4542
|
+
*
|
|
4543
|
+
*/
|
|
4544
|
+
static listPayPeriodConfigs(options) {
|
|
4545
|
+
return (options?.client ?? client).get({
|
|
4546
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4547
|
+
url: '/api/v1/timekeeping/pay_period_configs',
|
|
4548
|
+
...options
|
|
4549
|
+
});
|
|
4550
|
+
}
|
|
4551
|
+
/**
|
|
4552
|
+
* Show pay schedule
|
|
4553
|
+
*
|
|
4554
|
+
* **Required scope:**
|
|
4555
|
+
*
|
|
4556
|
+
* `timekeeping.pay_period_configs:read`
|
|
4557
|
+
*
|
|
4558
|
+
*/
|
|
4559
|
+
static getPayPeriodConfig(options) {
|
|
4560
|
+
return (options.client ?? client).get({
|
|
4561
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4562
|
+
url: '/api/v1/timekeeping/pay_period_configs/{uid}',
|
|
4563
|
+
...options
|
|
4564
|
+
});
|
|
4565
|
+
}
|
|
4566
|
+
}
|
|
4567
|
+
export class TimeCardActuals {
|
|
4568
|
+
/**
|
|
4569
|
+
* List time card actuals
|
|
4570
|
+
*
|
|
4571
|
+
* **Required scope:**
|
|
4572
|
+
*
|
|
4573
|
+
* `timekeeping.time_card_actuals:read`
|
|
4574
|
+
*
|
|
4575
|
+
*/
|
|
4576
|
+
static listTimeCardActuals(options) {
|
|
4577
|
+
return (options?.client ?? client).get({
|
|
4578
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4579
|
+
url: '/api/v1/timekeeping/time_card_actuals',
|
|
4580
|
+
...options
|
|
4581
|
+
});
|
|
4582
|
+
}
|
|
4583
|
+
/**
|
|
4584
|
+
* Show time card actuals
|
|
4585
|
+
*
|
|
4586
|
+
* **Required scope:**
|
|
4587
|
+
*
|
|
4588
|
+
* `timekeeping.time_card_actuals:read`
|
|
4589
|
+
*
|
|
4590
|
+
*/
|
|
4591
|
+
static getTimeCardActual(options) {
|
|
4592
|
+
return (options.client ?? client).get({
|
|
4593
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4594
|
+
url: '/api/v1/timekeeping/time_card_actuals/{id}',
|
|
4595
|
+
...options
|
|
4596
|
+
});
|
|
4597
|
+
}
|
|
4598
|
+
}
|
|
4599
|
+
export class UserRoles {
|
|
4600
|
+
/**
|
|
4601
|
+
* List user roles
|
|
4602
|
+
*
|
|
4603
|
+
* **Required scope:**
|
|
4604
|
+
*
|
|
4605
|
+
* `user_roles:read`
|
|
4606
|
+
*
|
|
4607
|
+
*/
|
|
4608
|
+
static listUserRoles(options) {
|
|
4609
|
+
return (options?.client ?? client).get({
|
|
4610
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4611
|
+
url: '/api/v1/user_roles',
|
|
4612
|
+
...options
|
|
4613
|
+
});
|
|
4614
|
+
}
|
|
4615
|
+
/**
|
|
4616
|
+
* Add roles to user
|
|
4617
|
+
*
|
|
4618
|
+
* **Required scope:**
|
|
4619
|
+
*
|
|
4620
|
+
* `user_roles:create`
|
|
4621
|
+
*
|
|
4622
|
+
*/
|
|
4623
|
+
static addUserRoles(options) {
|
|
4624
|
+
return (options.client ?? client).post({
|
|
4625
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4626
|
+
url: '/api/v1/user_roles',
|
|
4627
|
+
...options,
|
|
4628
|
+
headers: {
|
|
4629
|
+
'Content-Type': 'application/json',
|
|
4630
|
+
...options.headers
|
|
4631
|
+
}
|
|
4632
|
+
});
|
|
4633
|
+
}
|
|
4634
|
+
/**
|
|
4635
|
+
* Delete role
|
|
4636
|
+
*
|
|
4637
|
+
* **Required scope:**
|
|
4638
|
+
*
|
|
4639
|
+
* `user_roles:delete`
|
|
4640
|
+
*
|
|
4641
|
+
*/
|
|
4642
|
+
static deleteUserRole(options) {
|
|
4643
|
+
return (options.client ?? client).delete({
|
|
4644
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4645
|
+
url: '/api/v1/user_roles/{id}',
|
|
4646
|
+
...options
|
|
4647
|
+
});
|
|
4648
|
+
}
|
|
4649
|
+
}
|
|
4650
|
+
export class WageDeterminations {
|
|
4651
|
+
/**
|
|
4652
|
+
* List labor rates
|
|
4653
|
+
*
|
|
4654
|
+
* **Required scope:**
|
|
4655
|
+
*
|
|
4656
|
+
* `wage_determinations.labor_rates:read`
|
|
4657
|
+
*
|
|
4658
|
+
*/
|
|
4659
|
+
static listLaborRates(options) {
|
|
4660
|
+
return (options.client ?? client).get({
|
|
4661
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4662
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/labor_rates',
|
|
4663
|
+
...options
|
|
4664
|
+
});
|
|
4665
|
+
}
|
|
4666
|
+
/**
|
|
4667
|
+
* List wage determinations
|
|
4668
|
+
*
|
|
4669
|
+
* **Required scope:**
|
|
4670
|
+
*
|
|
4671
|
+
* `wage_determinations:read`
|
|
4672
|
+
*
|
|
4673
|
+
*/
|
|
4674
|
+
static listWageDeterminations(options) {
|
|
4675
|
+
return (options?.client ?? client).get({
|
|
4676
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4677
|
+
url: '/api/v1/wage_determinations',
|
|
4678
|
+
...options
|
|
4679
|
+
});
|
|
4680
|
+
}
|
|
4681
|
+
/**
|
|
4682
|
+
* Show wage determination
|
|
4683
|
+
*
|
|
4684
|
+
* **Required scope:**
|
|
4685
|
+
*
|
|
4686
|
+
* `wage_determinations:read`
|
|
4687
|
+
*
|
|
4688
|
+
*/
|
|
4689
|
+
static getWageDetermination(options) {
|
|
4690
|
+
return (options.client ?? client).get({
|
|
4691
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4692
|
+
url: '/api/v1/wage_determinations/{id}',
|
|
4693
|
+
...options
|
|
4694
|
+
});
|
|
4695
|
+
}
|
|
4696
|
+
}
|
|
4697
|
+
export class WorkTypes {
|
|
4698
|
+
/**
|
|
4699
|
+
* List work types
|
|
4700
|
+
*
|
|
4701
|
+
* Lists the work types (job type categories) available to the
|
|
4702
|
+
* authenticated company: the shared global catalog (rows with no owning
|
|
4703
|
+
* company) plus the company's own company-specific entries. Returned
|
|
4704
|
+
* newest first and paginated with the `page[...]` cursor parameters.
|
|
4705
|
+
*
|
|
4706
|
+
*
|
|
4707
|
+
* **Required scope:**
|
|
4708
|
+
*
|
|
4709
|
+
* `work_types:read`
|
|
4710
|
+
*
|
|
4711
|
+
*/
|
|
4712
|
+
static listWorkTypes(options) {
|
|
4713
|
+
return (options?.client ?? client).get({
|
|
4714
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
4715
|
+
url: '/api/v1/work_types',
|
|
4716
|
+
...options
|
|
4717
|
+
});
|
|
4718
|
+
}
|
|
4719
|
+
}
|