@rippling/rippling-sdk 0.2.0-alpha.25 → 0.2.0-alpha.26
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 +1 -1
- package/client.d.mts +33 -11
- package/client.d.mts.map +1 -1
- package/client.d.ts +33 -11
- package/client.d.ts.map +1 -1
- package/client.js +21 -0
- package/client.js.map +1 -1
- package/client.mjs +21 -0
- package/client.mjs.map +1 -1
- package/functions.d.mts +4 -0
- package/functions.d.mts.map +1 -1
- package/functions.d.ts +4 -0
- package/functions.d.ts.map +1 -1
- package/functions.js +13 -1
- package/functions.js.map +1 -1
- package/functions.mjs +11 -0
- package/functions.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/compensation-bands-details.d.mts +95 -0
- package/resources/compensation-bands-details.d.mts.map +1 -0
- package/resources/compensation-bands-details.d.ts +95 -0
- package/resources/compensation-bands-details.d.ts.map +1 -0
- package/resources/compensation-bands-details.js +29 -0
- package/resources/compensation-bands-details.js.map +1 -0
- package/resources/compensation-bands-details.mjs +25 -0
- package/resources/compensation-bands-details.mjs.map +1 -0
- package/resources/custom-settings.d.mts +270 -0
- package/resources/custom-settings.d.mts.map +1 -0
- package/resources/custom-settings.d.ts +270 -0
- package/resources/custom-settings.d.ts.map +1 -0
- package/resources/custom-settings.js +51 -0
- package/resources/custom-settings.js.map +1 -0
- package/resources/custom-settings.mjs +47 -0
- package/resources/custom-settings.mjs.map +1 -0
- package/resources/departments.d.mts +37 -1
- package/resources/departments.d.mts.map +1 -1
- package/resources/departments.d.ts +37 -1
- package/resources/departments.d.ts.map +1 -1
- package/resources/departments.js +12 -0
- package/resources/departments.js.map +1 -1
- package/resources/departments.mjs +12 -0
- package/resources/departments.mjs.map +1 -1
- package/resources/draft-hires.d.mts +27 -0
- package/resources/draft-hires.d.mts.map +1 -1
- package/resources/draft-hires.d.ts +27 -0
- package/resources/draft-hires.d.ts.map +1 -1
- package/resources/functions/executions.d.mts +6 -82
- package/resources/functions/executions.d.mts.map +1 -1
- package/resources/functions/executions.d.ts +6 -82
- package/resources/functions/executions.d.ts.map +1 -1
- package/resources/functions/executions.js.map +1 -1
- package/resources/functions/executions.mjs.map +1 -1
- package/resources/functions/functions.d.mts +2 -2
- package/resources/functions/functions.d.mts.map +1 -1
- package/resources/functions/functions.d.ts +2 -2
- package/resources/functions/functions.d.ts.map +1 -1
- package/resources/functions/functions.js.map +1 -1
- package/resources/functions/functions.mjs.map +1 -1
- package/resources/functions/index.d.mts +1 -1
- package/resources/functions/index.d.mts.map +1 -1
- package/resources/functions/index.d.ts +1 -1
- package/resources/functions/index.d.ts.map +1 -1
- package/resources/functions/index.js.map +1 -1
- package/resources/functions/index.mjs.map +1 -1
- package/resources/index.d.mts +12 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +12 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +15 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +7 -0
- package/resources/index.mjs.map +1 -1
- package/resources/job-assignments.d.mts +70 -6
- package/resources/job-assignments.d.mts.map +1 -1
- package/resources/job-assignments.d.ts +70 -6
- package/resources/job-assignments.d.ts.map +1 -1
- package/resources/job-assignments.js +22 -0
- package/resources/job-assignments.js.map +1 -1
- package/resources/job-assignments.mjs +22 -0
- package/resources/job-assignments.mjs.map +1 -1
- package/resources/job-codes.d.mts +47 -1
- package/resources/job-codes.d.mts.map +1 -1
- package/resources/job-codes.d.ts +47 -1
- package/resources/job-codes.d.ts.map +1 -1
- package/resources/job-dimensions.d.mts +20 -0
- package/resources/job-dimensions.d.mts.map +1 -1
- package/resources/job-dimensions.d.ts +20 -0
- package/resources/job-dimensions.d.ts.map +1 -1
- package/resources/job-requisitions-write.d.mts +257 -0
- package/resources/job-requisitions-write.d.mts.map +1 -0
- package/resources/job-requisitions-write.d.ts +257 -0
- package/resources/job-requisitions-write.d.ts.map +1 -0
- package/resources/job-requisitions-write.js +15 -0
- package/resources/job-requisitions-write.js.map +1 -0
- package/resources/job-requisitions-write.mjs +11 -0
- package/resources/job-requisitions-write.mjs.map +1 -0
- package/resources/leave-accruals.d.mts +112 -6
- package/resources/leave-accruals.d.mts.map +1 -1
- package/resources/leave-accruals.d.ts +112 -6
- package/resources/leave-accruals.d.ts.map +1 -1
- package/resources/leave-accruals.js +19 -3
- package/resources/leave-accruals.js.map +1 -1
- package/resources/leave-accruals.mjs +19 -3
- package/resources/leave-accruals.mjs.map +1 -1
- package/resources/report-runs.d.mts +149 -0
- package/resources/report-runs.d.mts.map +1 -0
- package/resources/report-runs.d.ts +149 -0
- package/resources/report-runs.d.ts.map +1 -0
- package/resources/report-runs.js +22 -0
- package/resources/report-runs.js.map +1 -0
- package/resources/report-runs.mjs +18 -0
- package/resources/report-runs.mjs.map +1 -0
- package/resources/shared.d.mts +35 -0
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +35 -0
- package/resources/shared.d.ts.map +1 -1
- package/resources/shift-assignments.d.mts +296 -0
- package/resources/shift-assignments.d.mts.map +1 -0
- package/resources/shift-assignments.d.ts +296 -0
- package/resources/shift-assignments.d.ts.map +1 -0
- package/resources/shift-assignments.js +25 -0
- package/resources/shift-assignments.js.map +1 -0
- package/resources/shift-assignments.mjs +21 -0
- package/resources/shift-assignments.mjs.map +1 -0
- package/resources/shiftassignments.d.mts +56 -4
- package/resources/shiftassignments.d.mts.map +1 -1
- package/resources/shiftassignments.d.ts +56 -4
- package/resources/shiftassignments.d.ts.map +1 -1
- package/resources/supergroups/exclusion-members.d.mts +3 -3
- package/resources/supergroups/exclusion-members.d.mts.map +1 -1
- package/resources/supergroups/exclusion-members.d.ts +3 -3
- package/resources/supergroups/exclusion-members.d.ts.map +1 -1
- package/resources/supergroups/exclusion-members.js.map +1 -1
- package/resources/supergroups/exclusion-members.mjs.map +1 -1
- package/resources/supergroups/inclusion-members.d.mts +3 -3
- package/resources/supergroups/inclusion-members.d.mts.map +1 -1
- package/resources/supergroups/inclusion-members.d.ts +3 -3
- package/resources/supergroups/inclusion-members.d.ts.map +1 -1
- package/resources/supergroups/inclusion-members.js.map +1 -1
- package/resources/supergroups/inclusion-members.mjs.map +1 -1
- package/resources/supergroups/index.d.mts +1 -1
- package/resources/supergroups/index.d.mts.map +1 -1
- package/resources/supergroups/index.d.ts +1 -1
- package/resources/supergroups/index.d.ts.map +1 -1
- package/resources/supergroups/index.js.map +1 -1
- package/resources/supergroups/index.mjs.map +1 -1
- package/resources/supergroups/members.d.mts +6 -37
- package/resources/supergroups/members.d.mts.map +1 -1
- package/resources/supergroups/members.d.ts +6 -37
- package/resources/supergroups/members.d.ts.map +1 -1
- package/resources/supergroups/members.js.map +1 -1
- package/resources/supergroups/members.mjs.map +1 -1
- package/resources/supergroups/supergroups.d.mts +2 -2
- package/resources/supergroups/supergroups.d.mts.map +1 -1
- package/resources/supergroups/supergroups.d.ts +2 -2
- package/resources/supergroups/supergroups.d.ts.map +1 -1
- package/resources/supergroups/supergroups.js.map +1 -1
- package/resources/supergroups/supergroups.mjs.map +1 -1
- package/resources/titles.d.mts +126 -0
- package/resources/titles.d.mts.map +1 -0
- package/resources/titles.d.ts +126 -0
- package/resources/titles.d.ts.map +1 -0
- package/resources/titles.js +48 -0
- package/resources/titles.js.map +1 -0
- package/resources/titles.mjs +44 -0
- package/resources/titles.mjs.map +1 -0
- package/resources/unassigned-shifts.d.mts +334 -0
- package/resources/unassigned-shifts.d.mts.map +1 -0
- package/resources/unassigned-shifts.d.ts +334 -0
- package/resources/unassigned-shifts.d.ts.map +1 -0
- package/resources/unassigned-shifts.js +42 -0
- package/resources/unassigned-shifts.js.map +1 -0
- package/resources/unassigned-shifts.mjs +38 -0
- package/resources/unassigned-shifts.mjs.map +1 -0
- package/resources/unassignedshifts.d.mts +382 -1
- package/resources/unassignedshifts.d.mts.map +1 -1
- package/resources/unassignedshifts.d.ts +382 -1
- package/resources/unassignedshifts.d.ts.map +1 -1
- package/resources/unassignedshifts.js +6 -0
- package/resources/unassignedshifts.js.map +1 -1
- package/resources/unassignedshifts.mjs +6 -0
- package/resources/unassignedshifts.mjs.map +1 -1
- package/resources/work-locations.d.mts +95 -1
- package/resources/work-locations.d.mts.map +1 -1
- package/resources/work-locations.d.ts +95 -1
- package/resources/work-locations.d.ts.map +1 -1
- package/resources/work-locations.js +12 -0
- package/resources/work-locations.js.map +1 -1
- package/resources/work-locations.mjs +12 -0
- package/resources/work-locations.mjs.map +1 -1
- package/src/client.ts +153 -3
- package/src/functions.ts +14 -0
- package/src/resources/compensation-bands-details.ts +140 -0
- package/src/resources/custom-settings.ts +371 -0
- package/src/resources/departments.ts +50 -0
- package/src/resources/draft-hires.ts +32 -0
- package/src/resources/functions/executions.ts +8 -104
- package/src/resources/functions/functions.ts +4 -8
- package/src/resources/functions/index.ts +2 -4
- package/src/resources/index.ts +66 -2
- package/src/resources/job-assignments.ts +95 -6
- package/src/resources/job-codes.ts +56 -1
- package/src/resources/job-dimensions.ts +24 -0
- package/src/resources/job-requisitions-write.ts +327 -0
- package/src/resources/leave-accruals.ts +229 -12
- package/src/resources/report-runs.ts +186 -0
- package/src/resources/shared.ts +44 -0
- package/src/resources/shift-assignments.ts +362 -0
- package/src/resources/shiftassignments.ts +70 -5
- package/src/resources/supergroups/exclusion-members.ts +4 -4
- package/src/resources/supergroups/inclusion-members.ts +4 -4
- package/src/resources/supergroups/index.ts +1 -1
- package/src/resources/supergroups/members.ts +7 -49
- package/src/resources/supergroups/supergroups.ts +2 -7
- package/src/resources/titles.ts +181 -0
- package/src/resources/unassigned-shifts.ts +415 -0
- package/src/resources/unassignedshifts.ts +467 -0
- package/src/resources/work-locations.ts +118 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../core/resource';
|
|
4
|
+
import * as BusinessPartnersAPI from './business-partners';
|
|
5
|
+
import * as WorkersAPI from './workers';
|
|
6
|
+
import { APIPromise } from '../core/api-promise';
|
|
7
|
+
import { PageCursorURL, PagePromise } from '../core/pagination';
|
|
8
|
+
import { RequestOptions } from '../internal/request-options';
|
|
9
|
+
import { path } from '../internal/utils/path';
|
|
10
|
+
|
|
11
|
+
export class CompensationBandsDetails extends APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* A List of compensation bands details
|
|
14
|
+
*
|
|
15
|
+
* - Requires: `API Tier 2`
|
|
16
|
+
* - Filterable fields: `created_at`, `updated_at`, `internal_job_code`,
|
|
17
|
+
* `worker_id`
|
|
18
|
+
* - Expandable fields: `worker`
|
|
19
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
20
|
+
*/
|
|
21
|
+
list(
|
|
22
|
+
query: CompensationBandsDetailListParams | null | undefined = {},
|
|
23
|
+
options?: RequestOptions,
|
|
24
|
+
): PagePromise<CompensationBandsDetailListResponsesPageCursorURL, CompensationBandsDetailListResponse> {
|
|
25
|
+
return this._client.getAPIList(
|
|
26
|
+
'/compensation-bands-details',
|
|
27
|
+
PageCursorURL<CompensationBandsDetailListResponse>,
|
|
28
|
+
{ query, ...options },
|
|
29
|
+
);
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Retrieve a specific compensation bands detail
|
|
34
|
+
*/
|
|
35
|
+
retrieve(
|
|
36
|
+
id: string,
|
|
37
|
+
query: CompensationBandsDetailRetrieveParams | null | undefined = {},
|
|
38
|
+
options?: RequestOptions,
|
|
39
|
+
): APIPromise<CompensationBandsDetailRetrieveResponse> {
|
|
40
|
+
return this._client.get(path`/compensation-bands-details/${id}`, { query, ...options });
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export type CompensationBandsDetailListResponsesPageCursorURL =
|
|
45
|
+
PageCursorURL<CompensationBandsDetailListResponse>;
|
|
46
|
+
|
|
47
|
+
export interface CompensationBandsDetailListResponse {
|
|
48
|
+
/**
|
|
49
|
+
* Identifier field
|
|
50
|
+
*/
|
|
51
|
+
id: string;
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Record creation date
|
|
55
|
+
*/
|
|
56
|
+
created_at: string;
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Record update date
|
|
60
|
+
*/
|
|
61
|
+
updated_at: string;
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Internal job code
|
|
65
|
+
*/
|
|
66
|
+
internal_job_code?: string;
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* The worker associated with compensation bands
|
|
70
|
+
*
|
|
71
|
+
* Expandable field
|
|
72
|
+
*/
|
|
73
|
+
worker?: WorkersAPI.Worker;
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* ID of the worker associated with compensation bands
|
|
77
|
+
*/
|
|
78
|
+
worker_id?: string;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Meta information for the response.
|
|
83
|
+
*/
|
|
84
|
+
export interface CompensationBandsDetailRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
85
|
+
/**
|
|
86
|
+
* Identifier field
|
|
87
|
+
*/
|
|
88
|
+
id: string;
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Record creation date
|
|
92
|
+
*/
|
|
93
|
+
created_at: string;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Record update date
|
|
97
|
+
*/
|
|
98
|
+
updated_at: string;
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Internal job code
|
|
102
|
+
*/
|
|
103
|
+
internal_job_code?: string;
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* The worker associated with compensation bands
|
|
107
|
+
*
|
|
108
|
+
* Expandable field
|
|
109
|
+
*/
|
|
110
|
+
worker?: WorkersAPI.Worker;
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* ID of the worker associated with compensation bands
|
|
114
|
+
*/
|
|
115
|
+
worker_id?: string;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
export interface CompensationBandsDetailListParams {
|
|
119
|
+
cursor?: string;
|
|
120
|
+
|
|
121
|
+
expand?: string;
|
|
122
|
+
|
|
123
|
+
filter?: string;
|
|
124
|
+
|
|
125
|
+
order_by?: string;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
export interface CompensationBandsDetailRetrieveParams {
|
|
129
|
+
expand?: string;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
export declare namespace CompensationBandsDetails {
|
|
133
|
+
export {
|
|
134
|
+
type CompensationBandsDetailListResponse as CompensationBandsDetailListResponse,
|
|
135
|
+
type CompensationBandsDetailRetrieveResponse as CompensationBandsDetailRetrieveResponse,
|
|
136
|
+
type CompensationBandsDetailListResponsesPageCursorURL as CompensationBandsDetailListResponsesPageCursorURL,
|
|
137
|
+
type CompensationBandsDetailListParams as CompensationBandsDetailListParams,
|
|
138
|
+
type CompensationBandsDetailRetrieveParams as CompensationBandsDetailRetrieveParams,
|
|
139
|
+
};
|
|
140
|
+
}
|
|
@@ -0,0 +1,371 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../core/resource';
|
|
4
|
+
import * as BusinessPartnersAPI from './business-partners';
|
|
5
|
+
import { APIPromise } from '../core/api-promise';
|
|
6
|
+
import { PageCursorURL, PagePromise } from '../core/pagination';
|
|
7
|
+
import { buildHeaders } from '../internal/headers';
|
|
8
|
+
import { RequestOptions } from '../internal/request-options';
|
|
9
|
+
import { path } from '../internal/utils/path';
|
|
10
|
+
|
|
11
|
+
export class CustomSettings extends APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* A List of Setting
|
|
14
|
+
*
|
|
15
|
+
* - Requires: `Functions API`
|
|
16
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
17
|
+
*/
|
|
18
|
+
list(
|
|
19
|
+
query: CustomSettingListParams | null | undefined = {},
|
|
20
|
+
options?: RequestOptions,
|
|
21
|
+
): PagePromise<CustomSettingListResponsesPageCursorURL, CustomSettingListResponse> {
|
|
22
|
+
return this._client.getAPIList('/custom-settings', PageCursorURL<CustomSettingListResponse>, {
|
|
23
|
+
query,
|
|
24
|
+
...options,
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Create a new Setting
|
|
30
|
+
*/
|
|
31
|
+
create(
|
|
32
|
+
body: CustomSettingCreateParams | null | undefined = {},
|
|
33
|
+
options?: RequestOptions,
|
|
34
|
+
): APIPromise<CustomSettingCreateResponse> {
|
|
35
|
+
return this._client.post('/custom-settings', { body, ...options });
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Retrieve a specific Setting
|
|
40
|
+
*/
|
|
41
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<CustomSettingRetrieveResponse> {
|
|
42
|
+
return this._client.get(path`/custom-settings/${id}`, options);
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Updated a specific Setting
|
|
47
|
+
*/
|
|
48
|
+
update(
|
|
49
|
+
id: string,
|
|
50
|
+
body: CustomSettingUpdateParams | null | undefined = {},
|
|
51
|
+
options?: RequestOptions,
|
|
52
|
+
): APIPromise<CustomSettingUpdateResponse> {
|
|
53
|
+
return this._client.patch(path`/custom-settings/${id}`, { body, ...options });
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Delete a Setting
|
|
58
|
+
*/
|
|
59
|
+
delete(id: string, options?: RequestOptions): APIPromise<void> {
|
|
60
|
+
return this._client.delete(path`/custom-settings/${id}`, {
|
|
61
|
+
...options,
|
|
62
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export type CustomSettingListResponsesPageCursorURL = PageCursorURL<CustomSettingListResponse>;
|
|
68
|
+
|
|
69
|
+
export interface CustomSettingListResponse {
|
|
70
|
+
/**
|
|
71
|
+
* Identifier field
|
|
72
|
+
*/
|
|
73
|
+
id: string;
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Record creation date
|
|
77
|
+
*/
|
|
78
|
+
created_at: string;
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Record update date
|
|
82
|
+
*/
|
|
83
|
+
updated_at: string;
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* The unique api name of the setting
|
|
87
|
+
*/
|
|
88
|
+
api_name?: string;
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Boolean value of the setting, if it has boolean data type
|
|
92
|
+
*/
|
|
93
|
+
boolean_value?: boolean;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Data type of the setting
|
|
97
|
+
*/
|
|
98
|
+
data_type?: string;
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* The display name of setting
|
|
102
|
+
*/
|
|
103
|
+
display_name?: string;
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Number value of the setting, if it has number data type
|
|
107
|
+
*/
|
|
108
|
+
number_value?: number;
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Secret value of the setting, if it has secret data type
|
|
112
|
+
*/
|
|
113
|
+
secret_value?: string;
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* String value of the setting, if it has string data type
|
|
117
|
+
*/
|
|
118
|
+
string_value?: string;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
export interface CustomSettingCreateResponse {
|
|
122
|
+
/**
|
|
123
|
+
* Identifier field
|
|
124
|
+
*/
|
|
125
|
+
id: string;
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Record creation date
|
|
129
|
+
*/
|
|
130
|
+
created_at: string;
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Record update date
|
|
134
|
+
*/
|
|
135
|
+
updated_at: string;
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* The unique api name of the setting
|
|
139
|
+
*/
|
|
140
|
+
api_name?: string;
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* Boolean value of the setting, if it has boolean data type
|
|
144
|
+
*/
|
|
145
|
+
boolean_value?: boolean;
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Data type of the setting
|
|
149
|
+
*/
|
|
150
|
+
data_type?: string;
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* The display name of setting
|
|
154
|
+
*/
|
|
155
|
+
display_name?: string;
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* Number value of the setting, if it has number data type
|
|
159
|
+
*/
|
|
160
|
+
number_value?: number;
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* Secret value of the setting, if it has secret data type
|
|
164
|
+
*/
|
|
165
|
+
secret_value?: string;
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* String value of the setting, if it has string data type
|
|
169
|
+
*/
|
|
170
|
+
string_value?: string;
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Meta information for the response.
|
|
175
|
+
*/
|
|
176
|
+
export interface CustomSettingRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
177
|
+
/**
|
|
178
|
+
* Identifier field
|
|
179
|
+
*/
|
|
180
|
+
id: string;
|
|
181
|
+
|
|
182
|
+
/**
|
|
183
|
+
* Record creation date
|
|
184
|
+
*/
|
|
185
|
+
created_at: string;
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Record update date
|
|
189
|
+
*/
|
|
190
|
+
updated_at: string;
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* The unique api name of the setting
|
|
194
|
+
*/
|
|
195
|
+
api_name?: string;
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Boolean value of the setting, if it has boolean data type
|
|
199
|
+
*/
|
|
200
|
+
boolean_value?: boolean;
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* Data type of the setting
|
|
204
|
+
*/
|
|
205
|
+
data_type?: string;
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* The display name of setting
|
|
209
|
+
*/
|
|
210
|
+
display_name?: string;
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* Number value of the setting, if it has number data type
|
|
214
|
+
*/
|
|
215
|
+
number_value?: number;
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Secret value of the setting, if it has secret data type
|
|
219
|
+
*/
|
|
220
|
+
secret_value?: string;
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* String value of the setting, if it has string data type
|
|
224
|
+
*/
|
|
225
|
+
string_value?: string;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
export interface CustomSettingUpdateResponse {
|
|
229
|
+
/**
|
|
230
|
+
* Identifier field
|
|
231
|
+
*/
|
|
232
|
+
id: string;
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* Record creation date
|
|
236
|
+
*/
|
|
237
|
+
created_at: string;
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* Record update date
|
|
241
|
+
*/
|
|
242
|
+
updated_at: string;
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* The unique api name of the setting
|
|
246
|
+
*/
|
|
247
|
+
api_name?: string;
|
|
248
|
+
|
|
249
|
+
/**
|
|
250
|
+
* Boolean value of the setting, if it has boolean data type
|
|
251
|
+
*/
|
|
252
|
+
boolean_value?: boolean;
|
|
253
|
+
|
|
254
|
+
/**
|
|
255
|
+
* Data type of the setting
|
|
256
|
+
*/
|
|
257
|
+
data_type?: string;
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* The display name of setting
|
|
261
|
+
*/
|
|
262
|
+
display_name?: string;
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Number value of the setting, if it has number data type
|
|
266
|
+
*/
|
|
267
|
+
number_value?: number;
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* Secret value of the setting, if it has secret data type
|
|
271
|
+
*/
|
|
272
|
+
secret_value?: string;
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* String value of the setting, if it has string data type
|
|
276
|
+
*/
|
|
277
|
+
string_value?: string;
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
export interface CustomSettingListParams {
|
|
281
|
+
cursor?: string;
|
|
282
|
+
|
|
283
|
+
order_by?: string;
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
export interface CustomSettingCreateParams {
|
|
287
|
+
/**
|
|
288
|
+
* The unique api name of the setting
|
|
289
|
+
*/
|
|
290
|
+
api_name?: string;
|
|
291
|
+
|
|
292
|
+
/**
|
|
293
|
+
* Boolean value of the setting, if it has boolean data type
|
|
294
|
+
*/
|
|
295
|
+
boolean_value?: boolean;
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Data type of the setting
|
|
299
|
+
*/
|
|
300
|
+
data_type?: string;
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* The display name of setting
|
|
304
|
+
*/
|
|
305
|
+
display_name?: string;
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* Number value of the setting, if it has number data type
|
|
309
|
+
*/
|
|
310
|
+
number_value?: number;
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* Secret value of the setting, if it has secret data type
|
|
314
|
+
*/
|
|
315
|
+
secret_value?: string;
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* String value of the setting, if it has string data type
|
|
319
|
+
*/
|
|
320
|
+
string_value?: string;
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
export interface CustomSettingUpdateParams {
|
|
324
|
+
/**
|
|
325
|
+
* The unique api name of the setting
|
|
326
|
+
*/
|
|
327
|
+
api_name?: string;
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* Boolean value of the setting, if it has boolean data type
|
|
331
|
+
*/
|
|
332
|
+
boolean_value?: boolean;
|
|
333
|
+
|
|
334
|
+
/**
|
|
335
|
+
* Data type of the setting
|
|
336
|
+
*/
|
|
337
|
+
data_type?: string;
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* The display name of setting
|
|
341
|
+
*/
|
|
342
|
+
display_name?: string;
|
|
343
|
+
|
|
344
|
+
/**
|
|
345
|
+
* Number value of the setting, if it has number data type
|
|
346
|
+
*/
|
|
347
|
+
number_value?: number;
|
|
348
|
+
|
|
349
|
+
/**
|
|
350
|
+
* Secret value of the setting, if it has secret data type
|
|
351
|
+
*/
|
|
352
|
+
secret_value?: string;
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* String value of the setting, if it has string data type
|
|
356
|
+
*/
|
|
357
|
+
string_value?: string;
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
export declare namespace CustomSettings {
|
|
361
|
+
export {
|
|
362
|
+
type CustomSettingListResponse as CustomSettingListResponse,
|
|
363
|
+
type CustomSettingCreateResponse as CustomSettingCreateResponse,
|
|
364
|
+
type CustomSettingRetrieveResponse as CustomSettingRetrieveResponse,
|
|
365
|
+
type CustomSettingUpdateResponse as CustomSettingUpdateResponse,
|
|
366
|
+
type CustomSettingListResponsesPageCursorURL as CustomSettingListResponsesPageCursorURL,
|
|
367
|
+
type CustomSettingListParams as CustomSettingListParams,
|
|
368
|
+
type CustomSettingCreateParams as CustomSettingCreateParams,
|
|
369
|
+
type CustomSettingUpdateParams as CustomSettingUpdateParams,
|
|
370
|
+
};
|
|
371
|
+
}
|
|
@@ -22,6 +22,13 @@ export class Departments extends APIResource {
|
|
|
22
22
|
return this._client.getAPIList('/departments', PageCursorURL<Department>, { query, ...options });
|
|
23
23
|
}
|
|
24
24
|
|
|
25
|
+
/**
|
|
26
|
+
* Create a new department
|
|
27
|
+
*/
|
|
28
|
+
create(body: DepartmentCreateParams, options?: RequestOptions): APIPromise<Department> {
|
|
29
|
+
return this._client.post('/departments', { body, ...options });
|
|
30
|
+
}
|
|
31
|
+
|
|
25
32
|
/**
|
|
26
33
|
* Retrieve a specific department
|
|
27
34
|
*/
|
|
@@ -32,6 +39,13 @@ export class Departments extends APIResource {
|
|
|
32
39
|
): APIPromise<DepartmentRetrieveResponse> {
|
|
33
40
|
return this._client.get(path`/departments/${id}`, { query, ...options });
|
|
34
41
|
}
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Updated a specific department
|
|
45
|
+
*/
|
|
46
|
+
update(id: string, body: DepartmentUpdateParams, options?: RequestOptions): APIPromise<Department> {
|
|
47
|
+
return this._client.patch(path`/departments/${id}`, { body, ...options });
|
|
48
|
+
}
|
|
35
49
|
}
|
|
36
50
|
|
|
37
51
|
export type DepartmentsPageCursorURL = PageCursorURL<Department>;
|
|
@@ -102,16 +116,52 @@ export interface DepartmentListParams {
|
|
|
102
116
|
order_by?: string;
|
|
103
117
|
}
|
|
104
118
|
|
|
119
|
+
export interface DepartmentCreateParams {
|
|
120
|
+
/**
|
|
121
|
+
* The name of the department.
|
|
122
|
+
*/
|
|
123
|
+
name: string;
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* The parent department.
|
|
127
|
+
*/
|
|
128
|
+
parent_id?: string;
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* Reference code of the department.
|
|
132
|
+
*/
|
|
133
|
+
reference_code?: string;
|
|
134
|
+
}
|
|
135
|
+
|
|
105
136
|
export interface DepartmentRetrieveParams {
|
|
106
137
|
expand?: string;
|
|
107
138
|
}
|
|
108
139
|
|
|
140
|
+
export interface DepartmentUpdateParams {
|
|
141
|
+
/**
|
|
142
|
+
* The name of the department.
|
|
143
|
+
*/
|
|
144
|
+
name: string;
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* The parent department.
|
|
148
|
+
*/
|
|
149
|
+
parent_id?: string;
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Reference code of the department.
|
|
153
|
+
*/
|
|
154
|
+
reference_code?: string;
|
|
155
|
+
}
|
|
156
|
+
|
|
109
157
|
export declare namespace Departments {
|
|
110
158
|
export {
|
|
111
159
|
type Department as Department,
|
|
112
160
|
type DepartmentRetrieveResponse as DepartmentRetrieveResponse,
|
|
113
161
|
type DepartmentsPageCursorURL as DepartmentsPageCursorURL,
|
|
114
162
|
type DepartmentListParams as DepartmentListParams,
|
|
163
|
+
type DepartmentCreateParams as DepartmentCreateParams,
|
|
115
164
|
type DepartmentRetrieveParams as DepartmentRetrieveParams,
|
|
165
|
+
type DepartmentUpdateParams as DepartmentUpdateParams,
|
|
116
166
|
};
|
|
117
167
|
}
|
|
@@ -152,6 +152,13 @@ export namespace DraftHireCreateParams {
|
|
|
152
152
|
*/
|
|
153
153
|
duties?: string;
|
|
154
154
|
|
|
155
|
+
/**
|
|
156
|
+
* EEOC job classification (e.g., EXECUTIVE, MID_LEVEL, PROFESSIONALS, TECHNICIANS,
|
|
157
|
+
* SALES_WORKERS, SUPPORT_WORKERS, CRAFT_WORKERS, OPERATIVES, HELPERS,
|
|
158
|
+
* SERVICE_WORKERS)
|
|
159
|
+
*/
|
|
160
|
+
eeoc_job_classification?: string;
|
|
161
|
+
|
|
155
162
|
/**
|
|
156
163
|
* Equity number of shares
|
|
157
164
|
*/
|
|
@@ -359,6 +366,11 @@ export namespace DraftHireCreateParams {
|
|
|
359
366
|
*/
|
|
360
367
|
locale?: PersonalInfo.Locale;
|
|
361
368
|
|
|
369
|
+
/**
|
|
370
|
+
* Personal phone number
|
|
371
|
+
*/
|
|
372
|
+
personal_phone?: PersonalInfo.PersonalPhone;
|
|
373
|
+
|
|
362
374
|
/**
|
|
363
375
|
* Race of the candidate
|
|
364
376
|
*/
|
|
@@ -455,6 +467,26 @@ export namespace DraftHireCreateParams {
|
|
|
455
467
|
*/
|
|
456
468
|
timezone?: string;
|
|
457
469
|
}
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Personal phone number
|
|
473
|
+
*/
|
|
474
|
+
export interface PersonalPhone {
|
|
475
|
+
/**
|
|
476
|
+
* Country code for the phone number
|
|
477
|
+
*/
|
|
478
|
+
country_code?: string;
|
|
479
|
+
|
|
480
|
+
/**
|
|
481
|
+
* Phone number extension
|
|
482
|
+
*/
|
|
483
|
+
extension?: string;
|
|
484
|
+
|
|
485
|
+
/**
|
|
486
|
+
* National phone number without country code
|
|
487
|
+
*/
|
|
488
|
+
national_number?: string;
|
|
489
|
+
}
|
|
458
490
|
}
|
|
459
491
|
|
|
460
492
|
/**
|