@rippling/rippling-sdk 0.2.0-alpha.57 → 0.2.0-alpha.59
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/client.d.mts +16 -10
- package/client.d.mts.map +1 -1
- package/client.d.ts +16 -10
- package/client.d.ts.map +1 -1
- package/client.js +21 -7
- package/client.js.map +1 -1
- package/client.mjs +21 -7
- package/client.mjs.map +1 -1
- package/examples/manifest/dental-practice-management/dental-practice-management.ts +0 -6
- package/examples/manifest/gym-membership-management/gym-membership-management.ts +0 -6
- package/examples/manifest/simple-todo-app/simple-todo-app.ts +0 -1
- package/lib/manifest/field.d.mts +0 -2
- package/lib/manifest/field.d.mts.map +1 -1
- package/lib/manifest/field.d.ts +0 -2
- package/lib/manifest/field.d.ts.map +1 -1
- package/lib/manifest/field.js +1 -1
- package/lib/manifest/field.js.map +1 -1
- package/lib/manifest/field.mjs +1 -1
- package/lib/manifest/field.mjs.map +1 -1
- package/lib/manifest/sdui-page.d.mts +0 -8
- package/lib/manifest/sdui-page.d.mts.map +1 -1
- package/lib/manifest/sdui-page.d.ts +0 -8
- package/lib/manifest/sdui-page.d.ts.map +1 -1
- package/lib/manifest/sdui-page.js +0 -4
- package/lib/manifest/sdui-page.js.map +1 -1
- package/lib/manifest/sdui-page.mjs +1 -5
- package/lib/manifest/sdui-page.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/break-policies.d.mts +91 -0
- package/resources/break-policies.d.mts.map +1 -0
- package/resources/break-policies.d.ts +91 -0
- package/resources/break-policies.d.ts.map +1 -0
- package/resources/break-policies.js +32 -0
- package/resources/break-policies.js.map +1 -0
- package/resources/break-policies.mjs +28 -0
- package/resources/break-policies.mjs.map +1 -0
- package/resources/break-types.d.mts +105 -2
- package/resources/break-types.d.mts.map +1 -1
- package/resources/break-types.d.ts +105 -2
- package/resources/break-types.d.ts.map +1 -1
- package/resources/break-types.js +4 -2
- package/resources/break-types.js.map +1 -1
- package/resources/break-types.mjs +4 -2
- package/resources/break-types.mjs.map +1 -1
- package/resources/business-structure-paths.d.mts +109 -0
- package/resources/business-structure-paths.d.mts.map +1 -0
- package/resources/business-structure-paths.d.ts +109 -0
- package/resources/business-structure-paths.d.ts.map +1 -0
- package/resources/business-structure-paths.js +30 -0
- package/resources/business-structure-paths.js.map +1 -0
- package/resources/business-structure-paths.mjs +26 -0
- package/resources/business-structure-paths.mjs.map +1 -0
- package/resources/candidate-applications.d.mts +5 -1
- package/resources/candidate-applications.d.mts.map +1 -1
- package/resources/candidate-applications.d.ts +5 -1
- package/resources/candidate-applications.d.ts.map +1 -1
- package/resources/candidate-applications.js +1 -1
- package/resources/candidate-applications.js.map +1 -1
- package/resources/candidate-applications.mjs +1 -1
- package/resources/candidate-applications.mjs.map +1 -1
- package/resources/employee-documents.d.mts +42 -4
- package/resources/employee-documents.d.mts.map +1 -1
- package/resources/employee-documents.d.ts +42 -4
- package/resources/employee-documents.d.ts.map +1 -1
- package/resources/index.d.mts +4 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +6 -4
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -1
- package/resources/index.mjs.map +1 -1
- package/resources/job-assignments.d.mts +14 -2
- package/resources/job-assignments.d.mts.map +1 -1
- package/resources/job-assignments.d.ts +14 -2
- package/resources/job-assignments.d.ts.map +1 -1
- package/resources/job-assignments.js +2 -1
- package/resources/job-assignments.js.map +1 -1
- package/resources/job-assignments.mjs +2 -1
- package/resources/job-assignments.mjs.map +1 -1
- package/resources/scheduled-job-assignments.d.mts +13 -21
- package/resources/scheduled-job-assignments.d.mts.map +1 -1
- package/resources/scheduled-job-assignments.d.ts +13 -21
- package/resources/scheduled-job-assignments.d.ts.map +1 -1
- package/src/client.ts +55 -17
- package/src/lib/manifest/field.ts +1 -3
- package/src/lib/manifest/sdui-page.ts +1 -12
- package/src/resources/break-policies.ts +126 -0
- package/src/resources/break-types.ts +129 -2
- package/src/resources/business-structure-paths.ts +157 -0
- package/src/resources/candidate-applications.ts +6 -1
- package/src/resources/employee-documents.ts +46 -4
- package/src/resources/index.ts +17 -5
- package/src/resources/job-assignments.ts +21 -1
- package/src/resources/scheduled-job-assignments.ts +13 -23
- 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
- package/resources/metadata/components.d.mts +0 -28
- package/resources/metadata/components.d.mts.map +0 -1
- package/resources/metadata/components.d.ts +0 -28
- package/resources/metadata/components.d.ts.map +0 -1
- package/resources/metadata/components.js +0 -21
- package/resources/metadata/components.js.map +0 -1
- package/resources/metadata/components.mjs +0 -17
- package/resources/metadata/components.mjs.map +0 -1
- package/resources/metadata/index.d.mts +0 -5
- package/resources/metadata/index.d.mts.map +0 -1
- package/resources/metadata/index.d.ts +0 -5
- package/resources/metadata/index.d.ts.map +0 -1
- package/resources/metadata/index.js +0 -13
- package/resources/metadata/index.js.map +0 -1
- package/resources/metadata/index.mjs +0 -6
- package/resources/metadata/index.mjs.map +0 -1
- package/resources/metadata/metadata.d.mts +0 -40
- package/resources/metadata/metadata.d.mts.map +0 -1
- package/resources/metadata/metadata.d.ts +0 -40
- package/resources/metadata/metadata.d.ts.map +0 -1
- package/resources/metadata/metadata.js +0 -37
- package/resources/metadata/metadata.js.map +0 -1
- package/resources/metadata/metadata.mjs +0 -32
- package/resources/metadata/metadata.mjs.map +0 -1
- package/resources/metadata/summary.d.mts +0 -28
- package/resources/metadata/summary.d.mts.map +0 -1
- package/resources/metadata/summary.d.ts +0 -28
- package/resources/metadata/summary.d.ts.map +0 -1
- package/resources/metadata/summary.js +0 -21
- package/resources/metadata/summary.js.map +0 -1
- package/resources/metadata/summary.mjs +0 -17
- package/resources/metadata/summary.mjs.map +0 -1
- package/resources/metadata/types.d.mts +0 -28
- package/resources/metadata/types.d.mts.map +0 -1
- package/resources/metadata/types.d.ts +0 -28
- package/resources/metadata/types.d.ts.map +0 -1
- package/resources/metadata/types.js +0 -21
- package/resources/metadata/types.js.map +0 -1
- package/resources/metadata/types.mjs +0 -17
- package/resources/metadata/types.mjs.map +0 -1
- package/resources/metadata.d.mts +0 -2
- package/resources/metadata.d.mts.map +0 -1
- package/resources/metadata.d.ts +0 -2
- package/resources/metadata.d.ts.map +0 -1
- package/resources/metadata.js +0 -6
- package/resources/metadata.js.map +0 -1
- package/resources/metadata.mjs +0 -3
- package/resources/metadata.mjs.map +0 -1
- package/src/resources/metadata/components.ts +0 -38
- package/src/resources/metadata/index.ts +0 -10
- package/src/resources/metadata/metadata.ts +0 -70
- package/src/resources/metadata/summary.ts +0 -38
- package/src/resources/metadata/types.ts +0 -38
- package/src/resources/metadata.ts +0 -3
|
@@ -11,13 +11,15 @@ export declare class BreakTypes extends APIResource {
|
|
|
11
11
|
* A list of break types.
|
|
12
12
|
*
|
|
13
13
|
* - Requires: `API Tier 2`
|
|
14
|
+
* - Filterable fields: `policy_id`
|
|
15
|
+
* - Expandable fields: `policy`
|
|
14
16
|
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
15
17
|
*/
|
|
16
18
|
list(query?: BreakTypeListParams | null | undefined, options?: RequestOptions): PagePromise<BreakTypeListResponsesPageCursorURL, BreakTypeListResponse>;
|
|
17
19
|
/**
|
|
18
20
|
* Retrieve a specific break type
|
|
19
21
|
*/
|
|
20
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<BreakTypeRetrieveResponse>;
|
|
22
|
+
retrieve(id: string, query?: BreakTypeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<BreakTypeRetrieveResponse>;
|
|
21
23
|
}
|
|
22
24
|
export type BreakTypeListResponsesPageCursorURL = PageCursorURL<BreakTypeListResponse>;
|
|
23
25
|
export interface BreakTypeListResponse {
|
|
@@ -45,6 +47,54 @@ export interface BreakTypeListResponse {
|
|
|
45
47
|
* Whether this is a paid break (true) or unpaid (false).
|
|
46
48
|
*/
|
|
47
49
|
is_paid?: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* The break policy this break type belongs to. Use ?expand=policy to inline the
|
|
52
|
+
* full policy object.
|
|
53
|
+
*
|
|
54
|
+
* Expandable field
|
|
55
|
+
*/
|
|
56
|
+
policy?: BreakTypeListResponse.Policy;
|
|
57
|
+
/**
|
|
58
|
+
* The ID of the break policy this break type belongs to.
|
|
59
|
+
*/
|
|
60
|
+
policy_id?: string;
|
|
61
|
+
}
|
|
62
|
+
export declare namespace BreakTypeListResponse {
|
|
63
|
+
/**
|
|
64
|
+
* The break policy this break type belongs to. Use ?expand=policy to inline the
|
|
65
|
+
* full policy object.
|
|
66
|
+
*
|
|
67
|
+
* Expandable field
|
|
68
|
+
*/
|
|
69
|
+
interface Policy {
|
|
70
|
+
/**
|
|
71
|
+
* Identifier field
|
|
72
|
+
*/
|
|
73
|
+
id: string;
|
|
74
|
+
/**
|
|
75
|
+
* Record creation date
|
|
76
|
+
*/
|
|
77
|
+
created_at: string;
|
|
78
|
+
/**
|
|
79
|
+
* The display name of the break policy. For default policies this is the
|
|
80
|
+
* system-generated label (e.g. 'Default Break policy: All Workers | California');
|
|
81
|
+
* for custom policies this is the admin-provided description.
|
|
82
|
+
*/
|
|
83
|
+
name: string;
|
|
84
|
+
/**
|
|
85
|
+
* Record update date
|
|
86
|
+
*/
|
|
87
|
+
updated_at: string;
|
|
88
|
+
/**
|
|
89
|
+
* ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
|
|
90
|
+
*/
|
|
91
|
+
country_code?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Whether this is a system-seeded default policy (true) or a custom policy created
|
|
94
|
+
* by an admin (false).
|
|
95
|
+
*/
|
|
96
|
+
is_default?: boolean;
|
|
97
|
+
}
|
|
48
98
|
}
|
|
49
99
|
/**
|
|
50
100
|
* Meta information for the response.
|
|
@@ -74,12 +124,65 @@ export interface BreakTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
|
74
124
|
* Whether this is a paid break (true) or unpaid (false).
|
|
75
125
|
*/
|
|
76
126
|
is_paid?: boolean;
|
|
127
|
+
/**
|
|
128
|
+
* The break policy this break type belongs to. Use ?expand=policy to inline the
|
|
129
|
+
* full policy object.
|
|
130
|
+
*
|
|
131
|
+
* Expandable field
|
|
132
|
+
*/
|
|
133
|
+
policy?: BreakTypeRetrieveResponse.Policy;
|
|
134
|
+
/**
|
|
135
|
+
* The ID of the break policy this break type belongs to.
|
|
136
|
+
*/
|
|
137
|
+
policy_id?: string;
|
|
138
|
+
}
|
|
139
|
+
export declare namespace BreakTypeRetrieveResponse {
|
|
140
|
+
/**
|
|
141
|
+
* The break policy this break type belongs to. Use ?expand=policy to inline the
|
|
142
|
+
* full policy object.
|
|
143
|
+
*
|
|
144
|
+
* Expandable field
|
|
145
|
+
*/
|
|
146
|
+
interface Policy {
|
|
147
|
+
/**
|
|
148
|
+
* Identifier field
|
|
149
|
+
*/
|
|
150
|
+
id: string;
|
|
151
|
+
/**
|
|
152
|
+
* Record creation date
|
|
153
|
+
*/
|
|
154
|
+
created_at: string;
|
|
155
|
+
/**
|
|
156
|
+
* The display name of the break policy. For default policies this is the
|
|
157
|
+
* system-generated label (e.g. 'Default Break policy: All Workers | California');
|
|
158
|
+
* for custom policies this is the admin-provided description.
|
|
159
|
+
*/
|
|
160
|
+
name: string;
|
|
161
|
+
/**
|
|
162
|
+
* Record update date
|
|
163
|
+
*/
|
|
164
|
+
updated_at: string;
|
|
165
|
+
/**
|
|
166
|
+
* ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
|
|
167
|
+
*/
|
|
168
|
+
country_code?: string;
|
|
169
|
+
/**
|
|
170
|
+
* Whether this is a system-seeded default policy (true) or a custom policy created
|
|
171
|
+
* by an admin (false).
|
|
172
|
+
*/
|
|
173
|
+
is_default?: boolean;
|
|
174
|
+
}
|
|
77
175
|
}
|
|
78
176
|
export interface BreakTypeListParams {
|
|
79
177
|
cursor?: string;
|
|
178
|
+
expand?: string;
|
|
179
|
+
filter?: string;
|
|
80
180
|
order_by?: string;
|
|
81
181
|
}
|
|
182
|
+
export interface BreakTypeRetrieveParams {
|
|
183
|
+
expand?: string;
|
|
184
|
+
}
|
|
82
185
|
export declare namespace BreakTypes {
|
|
83
|
-
export { type BreakTypeListResponse as BreakTypeListResponse, type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse, type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL, type BreakTypeListParams as BreakTypeListParams, };
|
|
186
|
+
export { type BreakTypeListResponse as BreakTypeListResponse, type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse, type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL, type BreakTypeListParams as BreakTypeListParams, type BreakTypeRetrieveParams as BreakTypeRetrieveParams, };
|
|
84
187
|
}
|
|
85
188
|
//# sourceMappingURL=break-types.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"break-types.d.mts","sourceRoot":"","sources":["../src/resources/break-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"break-types.d.mts","sourceRoot":"","sources":["../src/resources/break-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;IAO1E;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;;;;OAKG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB,CAAC,IAAI;IACzE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,yBAAyB,CAAC,MAAM,CAAC;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;;;;OAKG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -11,13 +11,15 @@ export declare class BreakTypes extends APIResource {
|
|
|
11
11
|
* A list of break types.
|
|
12
12
|
*
|
|
13
13
|
* - Requires: `API Tier 2`
|
|
14
|
+
* - Filterable fields: `policy_id`
|
|
15
|
+
* - Expandable fields: `policy`
|
|
14
16
|
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
15
17
|
*/
|
|
16
18
|
list(query?: BreakTypeListParams | null | undefined, options?: RequestOptions): PagePromise<BreakTypeListResponsesPageCursorURL, BreakTypeListResponse>;
|
|
17
19
|
/**
|
|
18
20
|
* Retrieve a specific break type
|
|
19
21
|
*/
|
|
20
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<BreakTypeRetrieveResponse>;
|
|
22
|
+
retrieve(id: string, query?: BreakTypeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<BreakTypeRetrieveResponse>;
|
|
21
23
|
}
|
|
22
24
|
export type BreakTypeListResponsesPageCursorURL = PageCursorURL<BreakTypeListResponse>;
|
|
23
25
|
export interface BreakTypeListResponse {
|
|
@@ -45,6 +47,54 @@ export interface BreakTypeListResponse {
|
|
|
45
47
|
* Whether this is a paid break (true) or unpaid (false).
|
|
46
48
|
*/
|
|
47
49
|
is_paid?: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* The break policy this break type belongs to. Use ?expand=policy to inline the
|
|
52
|
+
* full policy object.
|
|
53
|
+
*
|
|
54
|
+
* Expandable field
|
|
55
|
+
*/
|
|
56
|
+
policy?: BreakTypeListResponse.Policy;
|
|
57
|
+
/**
|
|
58
|
+
* The ID of the break policy this break type belongs to.
|
|
59
|
+
*/
|
|
60
|
+
policy_id?: string;
|
|
61
|
+
}
|
|
62
|
+
export declare namespace BreakTypeListResponse {
|
|
63
|
+
/**
|
|
64
|
+
* The break policy this break type belongs to. Use ?expand=policy to inline the
|
|
65
|
+
* full policy object.
|
|
66
|
+
*
|
|
67
|
+
* Expandable field
|
|
68
|
+
*/
|
|
69
|
+
interface Policy {
|
|
70
|
+
/**
|
|
71
|
+
* Identifier field
|
|
72
|
+
*/
|
|
73
|
+
id: string;
|
|
74
|
+
/**
|
|
75
|
+
* Record creation date
|
|
76
|
+
*/
|
|
77
|
+
created_at: string;
|
|
78
|
+
/**
|
|
79
|
+
* The display name of the break policy. For default policies this is the
|
|
80
|
+
* system-generated label (e.g. 'Default Break policy: All Workers | California');
|
|
81
|
+
* for custom policies this is the admin-provided description.
|
|
82
|
+
*/
|
|
83
|
+
name: string;
|
|
84
|
+
/**
|
|
85
|
+
* Record update date
|
|
86
|
+
*/
|
|
87
|
+
updated_at: string;
|
|
88
|
+
/**
|
|
89
|
+
* ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
|
|
90
|
+
*/
|
|
91
|
+
country_code?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Whether this is a system-seeded default policy (true) or a custom policy created
|
|
94
|
+
* by an admin (false).
|
|
95
|
+
*/
|
|
96
|
+
is_default?: boolean;
|
|
97
|
+
}
|
|
48
98
|
}
|
|
49
99
|
/**
|
|
50
100
|
* Meta information for the response.
|
|
@@ -74,12 +124,65 @@ export interface BreakTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
|
74
124
|
* Whether this is a paid break (true) or unpaid (false).
|
|
75
125
|
*/
|
|
76
126
|
is_paid?: boolean;
|
|
127
|
+
/**
|
|
128
|
+
* The break policy this break type belongs to. Use ?expand=policy to inline the
|
|
129
|
+
* full policy object.
|
|
130
|
+
*
|
|
131
|
+
* Expandable field
|
|
132
|
+
*/
|
|
133
|
+
policy?: BreakTypeRetrieveResponse.Policy;
|
|
134
|
+
/**
|
|
135
|
+
* The ID of the break policy this break type belongs to.
|
|
136
|
+
*/
|
|
137
|
+
policy_id?: string;
|
|
138
|
+
}
|
|
139
|
+
export declare namespace BreakTypeRetrieveResponse {
|
|
140
|
+
/**
|
|
141
|
+
* The break policy this break type belongs to. Use ?expand=policy to inline the
|
|
142
|
+
* full policy object.
|
|
143
|
+
*
|
|
144
|
+
* Expandable field
|
|
145
|
+
*/
|
|
146
|
+
interface Policy {
|
|
147
|
+
/**
|
|
148
|
+
* Identifier field
|
|
149
|
+
*/
|
|
150
|
+
id: string;
|
|
151
|
+
/**
|
|
152
|
+
* Record creation date
|
|
153
|
+
*/
|
|
154
|
+
created_at: string;
|
|
155
|
+
/**
|
|
156
|
+
* The display name of the break policy. For default policies this is the
|
|
157
|
+
* system-generated label (e.g. 'Default Break policy: All Workers | California');
|
|
158
|
+
* for custom policies this is the admin-provided description.
|
|
159
|
+
*/
|
|
160
|
+
name: string;
|
|
161
|
+
/**
|
|
162
|
+
* Record update date
|
|
163
|
+
*/
|
|
164
|
+
updated_at: string;
|
|
165
|
+
/**
|
|
166
|
+
* ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
|
|
167
|
+
*/
|
|
168
|
+
country_code?: string;
|
|
169
|
+
/**
|
|
170
|
+
* Whether this is a system-seeded default policy (true) or a custom policy created
|
|
171
|
+
* by an admin (false).
|
|
172
|
+
*/
|
|
173
|
+
is_default?: boolean;
|
|
174
|
+
}
|
|
77
175
|
}
|
|
78
176
|
export interface BreakTypeListParams {
|
|
79
177
|
cursor?: string;
|
|
178
|
+
expand?: string;
|
|
179
|
+
filter?: string;
|
|
80
180
|
order_by?: string;
|
|
81
181
|
}
|
|
182
|
+
export interface BreakTypeRetrieveParams {
|
|
183
|
+
expand?: string;
|
|
184
|
+
}
|
|
82
185
|
export declare namespace BreakTypes {
|
|
83
|
-
export { type BreakTypeListResponse as BreakTypeListResponse, type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse, type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL, type BreakTypeListParams as BreakTypeListParams, };
|
|
186
|
+
export { type BreakTypeListResponse as BreakTypeListResponse, type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse, type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL, type BreakTypeListParams as BreakTypeListParams, type BreakTypeRetrieveParams as BreakTypeRetrieveParams, };
|
|
84
187
|
}
|
|
85
188
|
//# sourceMappingURL=break-types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"break-types.d.ts","sourceRoot":"","sources":["../src/resources/break-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"break-types.d.ts","sourceRoot":"","sources":["../src/resources/break-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;IAO1E;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;;;;OAKG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB,CAAC,IAAI;IACzE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,yBAAyB,CAAC,MAAM,CAAC;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;;;;OAKG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
package/resources/break-types.js
CHANGED
|
@@ -13,6 +13,8 @@ class BreakTypes extends resource_1.APIResource {
|
|
|
13
13
|
* A list of break types.
|
|
14
14
|
*
|
|
15
15
|
* - Requires: `API Tier 2`
|
|
16
|
+
* - Filterable fields: `policy_id`
|
|
17
|
+
* - Expandable fields: `policy`
|
|
16
18
|
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
17
19
|
*/
|
|
18
20
|
list(query = {}, options) {
|
|
@@ -24,8 +26,8 @@ class BreakTypes extends resource_1.APIResource {
|
|
|
24
26
|
/**
|
|
25
27
|
* Retrieve a specific break type
|
|
26
28
|
*/
|
|
27
|
-
retrieve(id, options) {
|
|
28
|
-
return this._client.get((0, path_1.path) `/break-types/${id}/`, options);
|
|
29
|
+
retrieve(id, query = {}, options) {
|
|
30
|
+
return this._client.get((0, path_1.path) `/break-types/${id}/`, { query, ...options });
|
|
29
31
|
}
|
|
30
32
|
}
|
|
31
33
|
exports.BreakTypes = BreakTypes;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"break-types.js","sourceRoot":"","sources":["../src/resources/break-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC
|
|
1
|
+
{"version":3,"file":"break-types.js","sourceRoot":"","sources":["../src/resources/break-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;OAOG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,0BAAoC,CAAA,EAAE;YACpF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF;AA7BD,gCA6BC"}
|
|
@@ -10,6 +10,8 @@ export class BreakTypes extends APIResource {
|
|
|
10
10
|
* A list of break types.
|
|
11
11
|
*
|
|
12
12
|
* - Requires: `API Tier 2`
|
|
13
|
+
* - Filterable fields: `policy_id`
|
|
14
|
+
* - Expandable fields: `policy`
|
|
13
15
|
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
14
16
|
*/
|
|
15
17
|
list(query = {}, options) {
|
|
@@ -21,8 +23,8 @@ export class BreakTypes extends APIResource {
|
|
|
21
23
|
/**
|
|
22
24
|
* Retrieve a specific break type
|
|
23
25
|
*/
|
|
24
|
-
retrieve(id, options) {
|
|
25
|
-
return this._client.get(path `/break-types/${id}/`, options);
|
|
26
|
+
retrieve(id, query = {}, options) {
|
|
27
|
+
return this._client.get(path `/break-types/${id}/`, { query, ...options });
|
|
26
28
|
}
|
|
27
29
|
}
|
|
28
30
|
//# sourceMappingURL=break-types.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"break-types.mjs","sourceRoot":"","sources":["../src/resources/break-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"break-types.mjs","sourceRoot":"","sources":["../src/resources/break-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;OAOG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,aAAoC,CAAA,EAAE;YACpF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF"}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as BusinessPartnersAPI from "./business-partners.mjs";
|
|
3
|
+
import * as JobCodesAPI from "./job-codes.mjs";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
5
|
+
import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
|
|
6
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
7
|
+
/**
|
|
8
|
+
* Business structure used for defining hierarchy of company's org attributes
|
|
9
|
+
*/
|
|
10
|
+
export declare class BusinessStructurePaths extends APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* A list of business-structure-paths.
|
|
13
|
+
*
|
|
14
|
+
* - Requires: `API Tier 2`
|
|
15
|
+
* - Expandable fields: `parent`, `job_codes`
|
|
16
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
17
|
+
*/
|
|
18
|
+
list(query?: BusinessStructurePathListParams | null | undefined, options?: RequestOptions): PagePromise<BusinessStructurePathListResponsesPageCursorURL, BusinessStructurePathListResponse>;
|
|
19
|
+
/**
|
|
20
|
+
* Retrieve a specific business-structure-path
|
|
21
|
+
*/
|
|
22
|
+
retrieve(id: string, query?: BusinessStructurePathRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<BusinessStructurePathRetrieveResponse>;
|
|
23
|
+
}
|
|
24
|
+
export type BusinessStructurePathListResponsesPageCursorURL = PageCursorURL<BusinessStructurePathListResponse>;
|
|
25
|
+
export interface BusinessStructurePathListResponse {
|
|
26
|
+
/**
|
|
27
|
+
* Identifier field
|
|
28
|
+
*/
|
|
29
|
+
id: string;
|
|
30
|
+
/**
|
|
31
|
+
* Record creation date
|
|
32
|
+
*/
|
|
33
|
+
created_at: string;
|
|
34
|
+
/**
|
|
35
|
+
* Record update date
|
|
36
|
+
*/
|
|
37
|
+
updated_at: string;
|
|
38
|
+
/**
|
|
39
|
+
* Ordered list of full JobCode objects for each job in the path, top to bottom.
|
|
40
|
+
* Populate via ?expand=job_codes. Requires both business-structure-paths.read and
|
|
41
|
+
* job-codes.read scopes.
|
|
42
|
+
*
|
|
43
|
+
* Expandable field
|
|
44
|
+
*/
|
|
45
|
+
job_codes?: Array<JobCodesAPI.JobCode>;
|
|
46
|
+
/**
|
|
47
|
+
* Ordered list of Job code IDs from top to bottom.
|
|
48
|
+
*/
|
|
49
|
+
job_codes_id?: Array<string>;
|
|
50
|
+
/**
|
|
51
|
+
* Name of the path (e.g. 'SF Office > Coffee > Barista').
|
|
52
|
+
*/
|
|
53
|
+
name?: string;
|
|
54
|
+
parent?: unknown;
|
|
55
|
+
/**
|
|
56
|
+
* Id of the parent BusinessStructurePath. None for root path.
|
|
57
|
+
*/
|
|
58
|
+
parent_id?: string;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Meta information for the response.
|
|
62
|
+
*/
|
|
63
|
+
export interface BusinessStructurePathRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
64
|
+
/**
|
|
65
|
+
* Identifier field
|
|
66
|
+
*/
|
|
67
|
+
id: string;
|
|
68
|
+
/**
|
|
69
|
+
* Record creation date
|
|
70
|
+
*/
|
|
71
|
+
created_at: string;
|
|
72
|
+
/**
|
|
73
|
+
* Record update date
|
|
74
|
+
*/
|
|
75
|
+
updated_at: string;
|
|
76
|
+
/**
|
|
77
|
+
* Ordered list of full JobCode objects for each job in the path, top to bottom.
|
|
78
|
+
* Populate via ?expand=job_codes. Requires both business-structure-paths.read and
|
|
79
|
+
* job-codes.read scopes.
|
|
80
|
+
*
|
|
81
|
+
* Expandable field
|
|
82
|
+
*/
|
|
83
|
+
job_codes?: Array<JobCodesAPI.JobCode>;
|
|
84
|
+
/**
|
|
85
|
+
* Ordered list of Job code IDs from top to bottom.
|
|
86
|
+
*/
|
|
87
|
+
job_codes_id?: Array<string>;
|
|
88
|
+
/**
|
|
89
|
+
* Name of the path (e.g. 'SF Office > Coffee > Barista').
|
|
90
|
+
*/
|
|
91
|
+
name?: string;
|
|
92
|
+
parent?: unknown;
|
|
93
|
+
/**
|
|
94
|
+
* Id of the parent BusinessStructurePath. None for root path.
|
|
95
|
+
*/
|
|
96
|
+
parent_id?: string;
|
|
97
|
+
}
|
|
98
|
+
export interface BusinessStructurePathListParams {
|
|
99
|
+
cursor?: string;
|
|
100
|
+
expand?: string;
|
|
101
|
+
order_by?: string;
|
|
102
|
+
}
|
|
103
|
+
export interface BusinessStructurePathRetrieveParams {
|
|
104
|
+
expand?: string;
|
|
105
|
+
}
|
|
106
|
+
export declare namespace BusinessStructurePaths {
|
|
107
|
+
export { type BusinessStructurePathListResponse as BusinessStructurePathListResponse, type BusinessStructurePathRetrieveResponse as BusinessStructurePathRetrieveResponse, type BusinessStructurePathListResponsesPageCursorURL as BusinessStructurePathListResponsesPageCursorURL, type BusinessStructurePathListParams as BusinessStructurePathListParams, type BusinessStructurePathRetrieveParams as BusinessStructurePathRetrieveParams, };
|
|
108
|
+
}
|
|
109
|
+
//# sourceMappingURL=business-structure-paths.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"business-structure-paths.d.mts","sourceRoot":"","sources":["../src/resources/business-structure-paths.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,KAAK,WAAW,wBAAoB;AAC3C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+CAA+C,EAAE,iCAAiC,CAAC;IAQlG;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAGrD;AAED,MAAM,MAAM,+CAA+C,GACzD,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAEnD,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qCAAsC,SAAQ,mBAAmB,CAAC,IAAI;IACrF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,+CAA+C,IAAI,+CAA+C,EACvG,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as BusinessPartnersAPI from "./business-partners.js";
|
|
3
|
+
import * as JobCodesAPI from "./job-codes.js";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
5
|
+
import { PageCursorURL, PagePromise } from "../core/pagination.js";
|
|
6
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
7
|
+
/**
|
|
8
|
+
* Business structure used for defining hierarchy of company's org attributes
|
|
9
|
+
*/
|
|
10
|
+
export declare class BusinessStructurePaths extends APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* A list of business-structure-paths.
|
|
13
|
+
*
|
|
14
|
+
* - Requires: `API Tier 2`
|
|
15
|
+
* - Expandable fields: `parent`, `job_codes`
|
|
16
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
17
|
+
*/
|
|
18
|
+
list(query?: BusinessStructurePathListParams | null | undefined, options?: RequestOptions): PagePromise<BusinessStructurePathListResponsesPageCursorURL, BusinessStructurePathListResponse>;
|
|
19
|
+
/**
|
|
20
|
+
* Retrieve a specific business-structure-path
|
|
21
|
+
*/
|
|
22
|
+
retrieve(id: string, query?: BusinessStructurePathRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<BusinessStructurePathRetrieveResponse>;
|
|
23
|
+
}
|
|
24
|
+
export type BusinessStructurePathListResponsesPageCursorURL = PageCursorURL<BusinessStructurePathListResponse>;
|
|
25
|
+
export interface BusinessStructurePathListResponse {
|
|
26
|
+
/**
|
|
27
|
+
* Identifier field
|
|
28
|
+
*/
|
|
29
|
+
id: string;
|
|
30
|
+
/**
|
|
31
|
+
* Record creation date
|
|
32
|
+
*/
|
|
33
|
+
created_at: string;
|
|
34
|
+
/**
|
|
35
|
+
* Record update date
|
|
36
|
+
*/
|
|
37
|
+
updated_at: string;
|
|
38
|
+
/**
|
|
39
|
+
* Ordered list of full JobCode objects for each job in the path, top to bottom.
|
|
40
|
+
* Populate via ?expand=job_codes. Requires both business-structure-paths.read and
|
|
41
|
+
* job-codes.read scopes.
|
|
42
|
+
*
|
|
43
|
+
* Expandable field
|
|
44
|
+
*/
|
|
45
|
+
job_codes?: Array<JobCodesAPI.JobCode>;
|
|
46
|
+
/**
|
|
47
|
+
* Ordered list of Job code IDs from top to bottom.
|
|
48
|
+
*/
|
|
49
|
+
job_codes_id?: Array<string>;
|
|
50
|
+
/**
|
|
51
|
+
* Name of the path (e.g. 'SF Office > Coffee > Barista').
|
|
52
|
+
*/
|
|
53
|
+
name?: string;
|
|
54
|
+
parent?: unknown;
|
|
55
|
+
/**
|
|
56
|
+
* Id of the parent BusinessStructurePath. None for root path.
|
|
57
|
+
*/
|
|
58
|
+
parent_id?: string;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Meta information for the response.
|
|
62
|
+
*/
|
|
63
|
+
export interface BusinessStructurePathRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
64
|
+
/**
|
|
65
|
+
* Identifier field
|
|
66
|
+
*/
|
|
67
|
+
id: string;
|
|
68
|
+
/**
|
|
69
|
+
* Record creation date
|
|
70
|
+
*/
|
|
71
|
+
created_at: string;
|
|
72
|
+
/**
|
|
73
|
+
* Record update date
|
|
74
|
+
*/
|
|
75
|
+
updated_at: string;
|
|
76
|
+
/**
|
|
77
|
+
* Ordered list of full JobCode objects for each job in the path, top to bottom.
|
|
78
|
+
* Populate via ?expand=job_codes. Requires both business-structure-paths.read and
|
|
79
|
+
* job-codes.read scopes.
|
|
80
|
+
*
|
|
81
|
+
* Expandable field
|
|
82
|
+
*/
|
|
83
|
+
job_codes?: Array<JobCodesAPI.JobCode>;
|
|
84
|
+
/**
|
|
85
|
+
* Ordered list of Job code IDs from top to bottom.
|
|
86
|
+
*/
|
|
87
|
+
job_codes_id?: Array<string>;
|
|
88
|
+
/**
|
|
89
|
+
* Name of the path (e.g. 'SF Office > Coffee > Barista').
|
|
90
|
+
*/
|
|
91
|
+
name?: string;
|
|
92
|
+
parent?: unknown;
|
|
93
|
+
/**
|
|
94
|
+
* Id of the parent BusinessStructurePath. None for root path.
|
|
95
|
+
*/
|
|
96
|
+
parent_id?: string;
|
|
97
|
+
}
|
|
98
|
+
export interface BusinessStructurePathListParams {
|
|
99
|
+
cursor?: string;
|
|
100
|
+
expand?: string;
|
|
101
|
+
order_by?: string;
|
|
102
|
+
}
|
|
103
|
+
export interface BusinessStructurePathRetrieveParams {
|
|
104
|
+
expand?: string;
|
|
105
|
+
}
|
|
106
|
+
export declare namespace BusinessStructurePaths {
|
|
107
|
+
export { type BusinessStructurePathListResponse as BusinessStructurePathListResponse, type BusinessStructurePathRetrieveResponse as BusinessStructurePathRetrieveResponse, type BusinessStructurePathListResponsesPageCursorURL as BusinessStructurePathListResponsesPageCursorURL, type BusinessStructurePathListParams as BusinessStructurePathListParams, type BusinessStructurePathRetrieveParams as BusinessStructurePathRetrieveParams, };
|
|
108
|
+
}
|
|
109
|
+
//# sourceMappingURL=business-structure-paths.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"business-structure-paths.d.ts","sourceRoot":"","sources":["../src/resources/business-structure-paths.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,KAAK,WAAW,uBAAoB;AAC3C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+CAA+C,EAAE,iCAAiC,CAAC;IAQlG;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAGrD;AAED,MAAM,MAAM,+CAA+C,GACzD,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAEnD,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qCAAsC,SAAQ,mBAAmB,CAAC,IAAI;IACrF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,+CAA+C,IAAI,+CAA+C,EACvG,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.BusinessStructurePaths = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../core/pagination.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
/**
|
|
9
|
+
* Business structure used for defining hierarchy of company's org attributes
|
|
10
|
+
*/
|
|
11
|
+
class BusinessStructurePaths extends resource_1.APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* A list of business-structure-paths.
|
|
14
|
+
*
|
|
15
|
+
* - Requires: `API Tier 2`
|
|
16
|
+
* - Expandable fields: `parent`, `job_codes`
|
|
17
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
18
|
+
*/
|
|
19
|
+
list(query = {}, options) {
|
|
20
|
+
return this._client.getAPIList('/business-structure-paths/', (pagination_1.PageCursorURL), { query, ...options });
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve a specific business-structure-path
|
|
24
|
+
*/
|
|
25
|
+
retrieve(id, query = {}, options) {
|
|
26
|
+
return this._client.get((0, path_1.path) `/business-structure-paths/${id}/`, { query, ...options });
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
exports.BusinessStructurePaths = BusinessStructurePaths;
|
|
30
|
+
//# sourceMappingURL=business-structure-paths.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"business-structure-paths.js","sourceRoot":"","sources":["../src/resources/business-structure-paths.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,sBAAuB,SAAQ,sBAAW;IACrD;;;;;;OAMG;IACH,IAAI,CACF,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,4BAA4B,EAC5B,CAAA,0BAAgD,CAAA,EAChD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAgE,EAAE,EAClE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;CACF;AA7BD,wDA6BC"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { PageCursorURL } from "../core/pagination.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Business structure used for defining hierarchy of company's org attributes
|
|
7
|
+
*/
|
|
8
|
+
export class BusinessStructurePaths extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* A list of business-structure-paths.
|
|
11
|
+
*
|
|
12
|
+
* - Requires: `API Tier 2`
|
|
13
|
+
* - Expandable fields: `parent`, `job_codes`
|
|
14
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
15
|
+
*/
|
|
16
|
+
list(query = {}, options) {
|
|
17
|
+
return this._client.getAPIList('/business-structure-paths/', (PageCursorURL), { query, ...options });
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Retrieve a specific business-structure-path
|
|
21
|
+
*/
|
|
22
|
+
retrieve(id, query = {}, options) {
|
|
23
|
+
return this._client.get(path `/business-structure-paths/${id}/`, { query, ...options });
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
//# sourceMappingURL=business-structure-paths.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"business-structure-paths.mjs","sourceRoot":"","sources":["../src/resources/business-structure-paths.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,IAAI,CACF,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,4BAA4B,EAC5B,CAAA,aAAgD,CAAA,EAChD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAgE,EAAE,EAClE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,6BAA6B,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;CACF"}
|