@rippling/rippling-sdk 0.2.0-alpha.23 → 0.2.0-alpha.24

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.
Files changed (216) hide show
  1. package/client.d.mts +7 -4
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +7 -4
  4. package/client.d.ts.map +1 -1
  5. package/client.js +4 -0
  6. package/client.js.map +1 -1
  7. package/client.mjs +4 -0
  8. package/client.mjs.map +1 -1
  9. package/package.json +1 -1
  10. package/resources/business-partner-groups.d.mts +1 -0
  11. package/resources/business-partner-groups.d.mts.map +1 -1
  12. package/resources/business-partner-groups.d.ts +1 -0
  13. package/resources/business-partner-groups.d.ts.map +1 -1
  14. package/resources/business-partners.d.mts +1 -0
  15. package/resources/business-partners.d.mts.map +1 -1
  16. package/resources/business-partners.d.ts +1 -0
  17. package/resources/business-partners.d.ts.map +1 -1
  18. package/resources/candidate-applications.d.mts +1 -0
  19. package/resources/candidate-applications.d.mts.map +1 -1
  20. package/resources/candidate-applications.d.ts +1 -0
  21. package/resources/candidate-applications.d.ts.map +1 -1
  22. package/resources/candidates.d.mts +1 -0
  23. package/resources/candidates.d.mts.map +1 -1
  24. package/resources/candidates.d.ts +1 -0
  25. package/resources/candidates.d.ts.map +1 -1
  26. package/resources/companies.d.mts +1 -0
  27. package/resources/companies.d.mts.map +1 -1
  28. package/resources/companies.d.ts +1 -0
  29. package/resources/companies.d.ts.map +1 -1
  30. package/resources/compensations.d.mts +1 -0
  31. package/resources/compensations.d.mts.map +1 -1
  32. package/resources/compensations.d.ts +1 -0
  33. package/resources/compensations.d.ts.map +1 -1
  34. package/resources/custom-fields.d.mts +1 -0
  35. package/resources/custom-fields.d.mts.map +1 -1
  36. package/resources/custom-fields.d.ts +1 -0
  37. package/resources/custom-fields.d.ts.map +1 -1
  38. package/resources/departments.d.mts +1 -0
  39. package/resources/departments.d.mts.map +1 -1
  40. package/resources/departments.d.ts +1 -0
  41. package/resources/departments.d.ts.map +1 -1
  42. package/resources/employment-types.d.mts +1 -0
  43. package/resources/employment-types.d.mts.map +1 -1
  44. package/resources/employment-types.d.ts +1 -0
  45. package/resources/employment-types.d.ts.map +1 -1
  46. package/resources/headcount-positions.d.mts +1 -0
  47. package/resources/headcount-positions.d.mts.map +1 -1
  48. package/resources/headcount-positions.d.ts +1 -0
  49. package/resources/headcount-positions.d.ts.map +1 -1
  50. package/resources/headcount-priorities.d.mts +1 -0
  51. package/resources/headcount-priorities.d.mts.map +1 -1
  52. package/resources/headcount-priorities.d.ts +1 -0
  53. package/resources/headcount-priorities.d.ts.map +1 -1
  54. package/resources/index.d.mts +3 -2
  55. package/resources/index.d.mts.map +1 -1
  56. package/resources/index.d.ts +3 -2
  57. package/resources/index.d.ts.map +1 -1
  58. package/resources/index.js +3 -1
  59. package/resources/index.js.map +1 -1
  60. package/resources/index.mjs +1 -0
  61. package/resources/index.mjs.map +1 -1
  62. package/resources/job-assignments.d.mts +2 -0
  63. package/resources/job-assignments.d.mts.map +1 -1
  64. package/resources/job-assignments.d.ts +2 -0
  65. package/resources/job-assignments.d.ts.map +1 -1
  66. package/resources/job-codes.d.mts +2 -0
  67. package/resources/job-codes.d.mts.map +1 -1
  68. package/resources/job-codes.d.ts +2 -0
  69. package/resources/job-codes.d.ts.map +1 -1
  70. package/resources/job-dimensions.d.mts +1 -0
  71. package/resources/job-dimensions.d.mts.map +1 -1
  72. package/resources/job-dimensions.d.ts +1 -0
  73. package/resources/job-dimensions.d.ts.map +1 -1
  74. package/resources/job-functions.d.mts +1 -0
  75. package/resources/job-functions.d.mts.map +1 -1
  76. package/resources/job-functions.d.ts +1 -0
  77. package/resources/job-functions.d.ts.map +1 -1
  78. package/resources/job-pay-rate-exceptions.d.mts +2 -0
  79. package/resources/job-pay-rate-exceptions.d.mts.map +1 -1
  80. package/resources/job-pay-rate-exceptions.d.ts +2 -0
  81. package/resources/job-pay-rate-exceptions.d.ts.map +1 -1
  82. package/resources/job-requisitions.d.mts +1 -0
  83. package/resources/job-requisitions.d.mts.map +1 -1
  84. package/resources/job-requisitions.d.ts +1 -0
  85. package/resources/job-requisitions.d.ts.map +1 -1
  86. package/resources/kiosk-badges.d.mts +1 -0
  87. package/resources/kiosk-badges.d.mts.map +1 -1
  88. package/resources/kiosk-badges.d.ts +1 -0
  89. package/resources/kiosk-badges.d.ts.map +1 -1
  90. package/resources/leave-balances.d.mts +1 -0
  91. package/resources/leave-balances.d.mts.map +1 -1
  92. package/resources/leave-balances.d.ts +1 -0
  93. package/resources/leave-balances.d.ts.map +1 -1
  94. package/resources/leave-requests.d.mts +1 -0
  95. package/resources/leave-requests.d.mts.map +1 -1
  96. package/resources/leave-requests.d.ts +1 -0
  97. package/resources/leave-requests.d.ts.map +1 -1
  98. package/resources/leave-types.d.mts +1 -0
  99. package/resources/leave-types.d.mts.map +1 -1
  100. package/resources/leave-types.d.ts +1 -0
  101. package/resources/leave-types.d.ts.map +1 -1
  102. package/resources/legal-entities.d.mts +1 -0
  103. package/resources/legal-entities.d.mts.map +1 -1
  104. package/resources/legal-entities.d.ts +1 -0
  105. package/resources/legal-entities.d.ts.map +1 -1
  106. package/resources/levels.d.mts +1 -0
  107. package/resources/levels.d.mts.map +1 -1
  108. package/resources/levels.d.ts +1 -0
  109. package/resources/levels.d.ts.map +1 -1
  110. package/resources/location-factors.d.mts +1 -0
  111. package/resources/location-factors.d.mts.map +1 -1
  112. package/resources/location-factors.d.ts +1 -0
  113. package/resources/location-factors.d.ts.map +1 -1
  114. package/resources/schedules.d.mts +110 -1
  115. package/resources/schedules.d.mts.map +1 -1
  116. package/resources/schedules.d.ts +110 -1
  117. package/resources/schedules.d.ts.map +1 -1
  118. package/resources/schedules.js +6 -0
  119. package/resources/schedules.js.map +1 -1
  120. package/resources/schedules.mjs +6 -0
  121. package/resources/schedules.mjs.map +1 -1
  122. package/resources/shift-inputs.d.mts +1 -0
  123. package/resources/shift-inputs.d.mts.map +1 -1
  124. package/resources/shift-inputs.d.ts +1 -0
  125. package/resources/shift-inputs.d.ts.map +1 -1
  126. package/resources/shiftassignments.d.mts +826 -139
  127. package/resources/shiftassignments.d.mts.map +1 -1
  128. package/resources/shiftassignments.d.ts +826 -139
  129. package/resources/shiftassignments.d.ts.map +1 -1
  130. package/resources/shiftassignments.js +12 -0
  131. package/resources/shiftassignments.js.map +1 -1
  132. package/resources/shiftassignments.mjs +12 -0
  133. package/resources/shiftassignments.mjs.map +1 -1
  134. package/resources/sso-me.d.mts +1 -0
  135. package/resources/sso-me.d.mts.map +1 -1
  136. package/resources/sso-me.d.ts +1 -0
  137. package/resources/sso-me.d.ts.map +1 -1
  138. package/resources/teams.d.mts +1 -0
  139. package/resources/teams.d.mts.map +1 -1
  140. package/resources/teams.d.ts +1 -0
  141. package/resources/teams.d.ts.map +1 -1
  142. package/resources/time-cards.d.mts +1 -0
  143. package/resources/time-cards.d.mts.map +1 -1
  144. package/resources/time-cards.d.ts +1 -0
  145. package/resources/time-cards.d.ts.map +1 -1
  146. package/resources/time-entries.d.mts +1 -0
  147. package/resources/time-entries.d.mts.map +1 -1
  148. package/resources/time-entries.d.ts +1 -0
  149. package/resources/time-entries.d.ts.map +1 -1
  150. package/resources/tracks.d.mts +1 -0
  151. package/resources/tracks.d.mts.map +1 -1
  152. package/resources/tracks.d.ts +1 -0
  153. package/resources/tracks.d.ts.map +1 -1
  154. package/resources/unassignedshifts.d.mts +535 -0
  155. package/resources/unassignedshifts.d.mts.map +1 -0
  156. package/resources/unassignedshifts.d.ts +535 -0
  157. package/resources/unassignedshifts.d.ts.map +1 -0
  158. package/resources/unassignedshifts.js +32 -0
  159. package/resources/unassignedshifts.js.map +1 -0
  160. package/resources/unassignedshifts.mjs +28 -0
  161. package/resources/unassignedshifts.mjs.map +1 -0
  162. package/resources/users.d.mts +1 -0
  163. package/resources/users.d.mts.map +1 -1
  164. package/resources/users.d.ts +1 -0
  165. package/resources/users.d.ts.map +1 -1
  166. package/resources/work-locations.d.mts +1 -0
  167. package/resources/work-locations.d.mts.map +1 -1
  168. package/resources/work-locations.d.ts +1 -0
  169. package/resources/work-locations.d.ts.map +1 -1
  170. package/resources/workers.d.mts +1 -0
  171. package/resources/workers.d.mts.map +1 -1
  172. package/resources/workers.d.ts +1 -0
  173. package/resources/workers.d.ts.map +1 -1
  174. package/src/client.ts +32 -0
  175. package/src/resources/business-partner-groups.ts +2 -0
  176. package/src/resources/business-partners.ts +2 -0
  177. package/src/resources/candidate-applications.ts +2 -0
  178. package/src/resources/candidates.ts +2 -0
  179. package/src/resources/companies.ts +2 -0
  180. package/src/resources/compensations.ts +2 -0
  181. package/src/resources/custom-fields.ts +2 -0
  182. package/src/resources/departments.ts +2 -0
  183. package/src/resources/employment-types.ts +2 -0
  184. package/src/resources/headcount-positions.ts +2 -0
  185. package/src/resources/headcount-priorities.ts +2 -0
  186. package/src/resources/index.ts +14 -0
  187. package/src/resources/job-assignments.ts +4 -0
  188. package/src/resources/job-codes.ts +4 -0
  189. package/src/resources/job-dimensions.ts +2 -0
  190. package/src/resources/job-functions.ts +2 -0
  191. package/src/resources/job-pay-rate-exceptions.ts +4 -0
  192. package/src/resources/job-requisitions.ts +2 -0
  193. package/src/resources/kiosk-badges.ts +2 -0
  194. package/src/resources/leave-balances.ts +2 -0
  195. package/src/resources/leave-requests.ts +2 -0
  196. package/src/resources/leave-types.ts +2 -0
  197. package/src/resources/legal-entities.ts +2 -0
  198. package/src/resources/levels.ts +2 -0
  199. package/src/resources/location-factors.ts +2 -0
  200. package/src/resources/schedules.ts +138 -0
  201. package/src/resources/shift-inputs.ts +2 -0
  202. package/src/resources/shiftassignments.ts +1004 -167
  203. package/src/resources/sso-me.ts +2 -0
  204. package/src/resources/teams.ts +2 -0
  205. package/src/resources/time-cards.ts +2 -0
  206. package/src/resources/time-entries.ts +2 -0
  207. package/src/resources/tracks.ts +2 -0
  208. package/src/resources/unassignedshifts.ts +664 -0
  209. package/src/resources/users.ts +2 -0
  210. package/src/resources/work-locations.ts +2 -0
  211. package/src/resources/workers.ts +2 -0
  212. package/src/version.ts +1 -1
  213. package/version.d.mts +1 -1
  214. package/version.d.ts +1 -1
  215. package/version.js +1 -1
  216. package/version.mjs +1 -1
@@ -15,10 +15,18 @@ export declare class Shiftassignments extends APIResource {
15
15
  * - Sortable fields: `id`, `created_at`, `updated_at`
16
16
  */
17
17
  list(query?: ShiftassignmentListParams | null | undefined, options?: RequestOptions): PagePromise<ShiftassignmentListResponsesPageCursorURL, ShiftassignmentListResponse>;
18
+ /**
19
+ * Create a new shift assignment
20
+ */
21
+ create(body: ShiftassignmentCreateParams, options?: RequestOptions): APIPromise<ShiftassignmentCreateResponse>;
18
22
  /**
19
23
  * Retrieve a specific shift assignment
20
24
  */
21
25
  retrieve(id: string, query?: ShiftassignmentRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ShiftassignmentRetrieveResponse>;
26
+ /**
27
+ * Updated a specific shift assignment
28
+ */
29
+ update(id: string, body: ShiftassignmentUpdateParams, options?: RequestOptions): APIPromise<ShiftassignmentUpdateResponse>;
22
30
  }
23
31
  export type ShiftassignmentListResponsesPageCursorURL = PageCursorURL<ShiftassignmentListResponse>;
24
32
  export interface ShiftassignmentListResponse {
@@ -26,10 +34,6 @@ export interface ShiftassignmentListResponse {
26
34
  * Identifier field
27
35
  */
28
36
  id: string;
29
- /**
30
- * Whether the shift assignment can be edited
31
- */
32
- can_edit: boolean;
33
37
  /**
34
38
  * Record creation date
35
39
  */
@@ -39,10 +43,26 @@ export interface ShiftassignmentListResponse {
39
43
  * be the same as the shift_data
40
44
  */
41
45
  is_published: boolean;
46
+ /**
47
+ * The ID of the schedule
48
+ */
49
+ schedule_id: string;
50
+ /**
51
+ * The data of the shift
52
+ */
53
+ shift_data: ShiftassignmentListResponse.ShiftData;
42
54
  /**
43
55
  * Record update date
44
56
  */
45
57
  updated_at: string;
58
+ /**
59
+ * The ID of the worker
60
+ */
61
+ worker_id: string;
62
+ /**
63
+ * Whether the shift assignment can be edited
64
+ */
65
+ can_edit?: boolean;
46
66
  /**
47
67
  * The published version of the shift assignment, if it exists. If filled but
48
68
  * is_published is false, the shift_data is the latest version.
@@ -54,54 +74,102 @@ export interface ShiftassignmentListResponse {
54
74
  * Expandable field
55
75
  */
56
76
  schedule?: ShiftassignmentListResponse.Schedule;
57
- /**
58
- * The ID of the schedule
59
- */
60
- schedule_id?: string;
61
- /**
62
- * The data of the shift
63
- */
64
- shift_data?: ShiftassignmentListResponse.ShiftData;
65
77
  /**
66
78
  * The worker
67
79
  *
68
80
  * Expandable field
69
81
  */
70
82
  worker?: WorkersAPI.Worker;
71
- /**
72
- * The ID of the worker
73
- */
74
- worker_id?: string;
75
83
  }
76
84
  export declare namespace ShiftassignmentListResponse {
77
85
  /**
78
- * The published version of the shift assignment, if it exists. If filled but
79
- * is_published is false, the shift_data is the latest version.
86
+ * The data of the shift
80
87
  */
81
- interface PublishedVersion {
88
+ interface ShiftData {
82
89
  /**
83
90
  * The end time of the shift
84
91
  */
85
92
  end_time: string;
93
+ /**
94
+ * The start time of the shift
95
+ */
96
+ start_time: string;
86
97
  /**
87
98
  * The breaks of the shift
88
99
  */
89
- shift_breaks: Array<PublishedVersion.ShiftBreak>;
100
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
90
101
  /**
91
102
  * The segments of the shift
92
103
  */
93
- shift_segments: Array<PublishedVersion.ShiftSegment>;
104
+ shift_segments?: Array<ShiftData.ShiftSegment>;
105
+ }
106
+ namespace ShiftData {
107
+ interface ShiftBreak {
108
+ /**
109
+ * The duration of the shift break in minutes (input only for creation)
110
+ */
111
+ duration_minutes: number;
112
+ /**
113
+ * The start time of the shift break
114
+ */
115
+ start_time: string;
116
+ /**
117
+ * The type of the shift break
118
+ */
119
+ type: 'MEAL' | 'REST';
120
+ /**
121
+ * The end time of the shift break (calculated from start_time + duration_minutes)
122
+ */
123
+ end_time?: string;
124
+ }
125
+ interface ShiftSegment {
126
+ /**
127
+ * The duration of the shift segment in minutes (input only for creation)
128
+ */
129
+ duration_minutes: number;
130
+ /**
131
+ * The start time of the shift segment
132
+ */
133
+ start_time: string;
134
+ /**
135
+ * The end time of the shift segment (calculated from start_time +
136
+ * duration_minutes)
137
+ */
138
+ end_time?: string;
139
+ /**
140
+ * The IDs of the job codes associated with the shift segment
141
+ */
142
+ job_codes_id?: Array<string>;
143
+ }
144
+ }
145
+ /**
146
+ * The published version of the shift assignment, if it exists. If filled but
147
+ * is_published is false, the shift_data is the latest version.
148
+ */
149
+ interface PublishedVersion {
150
+ /**
151
+ * The end time of the shift
152
+ */
153
+ end_time: string;
94
154
  /**
95
155
  * The start time of the shift
96
156
  */
97
157
  start_time: string;
158
+ /**
159
+ * The breaks of the shift
160
+ */
161
+ shift_breaks?: Array<PublishedVersion.ShiftBreak>;
162
+ /**
163
+ * The segments of the shift
164
+ */
165
+ shift_segments?: Array<PublishedVersion.ShiftSegment>;
98
166
  }
99
167
  namespace PublishedVersion {
100
168
  interface ShiftBreak {
101
169
  /**
102
- * The end time of the shift break
170
+ * The duration of the shift break in minutes (input only for creation)
103
171
  */
104
- end_time: string;
172
+ duration_minutes: number;
105
173
  /**
106
174
  * The start time of the shift break
107
175
  */
@@ -109,17 +177,26 @@ export declare namespace ShiftassignmentListResponse {
109
177
  /**
110
178
  * The type of the shift break
111
179
  */
112
- type: string;
180
+ type: 'MEAL' | 'REST';
181
+ /**
182
+ * The end time of the shift break (calculated from start_time + duration_minutes)
183
+ */
184
+ end_time?: string;
113
185
  }
114
186
  interface ShiftSegment {
115
187
  /**
116
- * The end time of the shift segment
188
+ * The duration of the shift segment in minutes (input only for creation)
117
189
  */
118
- end_time: string;
190
+ duration_minutes: number;
119
191
  /**
120
192
  * The start time of the shift segment
121
193
  */
122
194
  start_time: string;
195
+ /**
196
+ * The end time of the shift segment (calculated from start_time +
197
+ * duration_minutes)
198
+ */
199
+ end_time?: string;
123
200
  /**
124
201
  * The IDs of the job codes associated with the shift segment
125
202
  */
@@ -200,6 +277,60 @@ export declare namespace ShiftassignmentListResponse {
200
277
  timezone?: string;
201
278
  }
202
279
  }
280
+ }
281
+ export interface ShiftassignmentCreateResponse {
282
+ /**
283
+ * Identifier field
284
+ */
285
+ id: string;
286
+ /**
287
+ * Record creation date
288
+ */
289
+ created_at: string;
290
+ /**
291
+ * Whether the shift assignment is published. If true, the published_version will
292
+ * be the same as the shift_data
293
+ */
294
+ is_published: boolean;
295
+ /**
296
+ * The ID of the schedule
297
+ */
298
+ schedule_id: string;
299
+ /**
300
+ * The data of the shift
301
+ */
302
+ shift_data: ShiftassignmentCreateResponse.ShiftData;
303
+ /**
304
+ * Record update date
305
+ */
306
+ updated_at: string;
307
+ /**
308
+ * The ID of the worker
309
+ */
310
+ worker_id: string;
311
+ /**
312
+ * Whether the shift assignment can be edited
313
+ */
314
+ can_edit?: boolean;
315
+ /**
316
+ * The published version of the shift assignment, if it exists. If filled but
317
+ * is_published is false, the shift_data is the latest version.
318
+ */
319
+ published_version?: ShiftassignmentCreateResponse.PublishedVersion;
320
+ /**
321
+ * The schedule
322
+ *
323
+ * Expandable field
324
+ */
325
+ schedule?: ShiftassignmentCreateResponse.Schedule;
326
+ /**
327
+ * The worker
328
+ *
329
+ * Expandable field
330
+ */
331
+ worker?: WorkersAPI.Worker;
332
+ }
333
+ export declare namespace ShiftassignmentCreateResponse {
203
334
  /**
204
335
  * The data of the shift
205
336
  */
@@ -209,24 +340,24 @@ export declare namespace ShiftassignmentListResponse {
209
340
  */
210
341
  end_time: string;
211
342
  /**
212
- * The breaks of the shift
343
+ * The start time of the shift
213
344
  */
214
- shift_breaks: Array<ShiftData.ShiftBreak>;
345
+ start_time: string;
215
346
  /**
216
- * The segments of the shift
347
+ * The breaks of the shift
217
348
  */
218
- shift_segments: Array<ShiftData.ShiftSegment>;
349
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
219
350
  /**
220
- * The start time of the shift
351
+ * The segments of the shift
221
352
  */
222
- start_time: string;
353
+ shift_segments?: Array<ShiftData.ShiftSegment>;
223
354
  }
224
355
  namespace ShiftData {
225
356
  interface ShiftBreak {
226
357
  /**
227
- * The end time of the shift break
358
+ * The duration of the shift break in minutes (input only for creation)
228
359
  */
229
- end_time: string;
360
+ duration_minutes: number;
230
361
  /**
231
362
  * The start time of the shift break
232
363
  */
@@ -234,80 +365,32 @@ export declare namespace ShiftassignmentListResponse {
234
365
  /**
235
366
  * The type of the shift break
236
367
  */
237
- type: string;
368
+ type: 'MEAL' | 'REST';
369
+ /**
370
+ * The end time of the shift break (calculated from start_time + duration_minutes)
371
+ */
372
+ end_time?: string;
238
373
  }
239
374
  interface ShiftSegment {
240
375
  /**
241
- * The end time of the shift segment
376
+ * The duration of the shift segment in minutes (input only for creation)
242
377
  */
243
- end_time: string;
378
+ duration_minutes: number;
244
379
  /**
245
380
  * The start time of the shift segment
246
381
  */
247
382
  start_time: string;
383
+ /**
384
+ * The end time of the shift segment (calculated from start_time +
385
+ * duration_minutes)
386
+ */
387
+ end_time?: string;
248
388
  /**
249
389
  * The IDs of the job codes associated with the shift segment
250
390
  */
251
391
  job_codes_id?: Array<string>;
252
392
  }
253
393
  }
254
- }
255
- /**
256
- * Meta information for the response.
257
- */
258
- export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
259
- /**
260
- * Identifier field
261
- */
262
- id: string;
263
- /**
264
- * Whether the shift assignment can be edited
265
- */
266
- can_edit: boolean;
267
- /**
268
- * Record creation date
269
- */
270
- created_at: string;
271
- /**
272
- * Whether the shift assignment is published. If true, the published_version will
273
- * be the same as the shift_data
274
- */
275
- is_published: boolean;
276
- /**
277
- * Record update date
278
- */
279
- updated_at: string;
280
- /**
281
- * The published version of the shift assignment, if it exists. If filled but
282
- * is_published is false, the shift_data is the latest version.
283
- */
284
- published_version?: ShiftassignmentRetrieveResponse.PublishedVersion;
285
- /**
286
- * The schedule
287
- *
288
- * Expandable field
289
- */
290
- schedule?: ShiftassignmentRetrieveResponse.Schedule;
291
- /**
292
- * The ID of the schedule
293
- */
294
- schedule_id?: string;
295
- /**
296
- * The data of the shift
297
- */
298
- shift_data?: ShiftassignmentRetrieveResponse.ShiftData;
299
- /**
300
- * The worker
301
- *
302
- * Expandable field
303
- */
304
- worker?: WorkersAPI.Worker;
305
- /**
306
- * The ID of the worker
307
- */
308
- worker_id?: string;
309
- }
310
- export declare namespace ShiftassignmentRetrieveResponse {
311
394
  /**
312
395
  * The published version of the shift assignment, if it exists. If filled but
313
396
  * is_published is false, the shift_data is the latest version.
@@ -318,24 +401,24 @@ export declare namespace ShiftassignmentRetrieveResponse {
318
401
  */
319
402
  end_time: string;
320
403
  /**
321
- * The breaks of the shift
404
+ * The start time of the shift
322
405
  */
323
- shift_breaks: Array<PublishedVersion.ShiftBreak>;
406
+ start_time: string;
324
407
  /**
325
- * The segments of the shift
408
+ * The breaks of the shift
326
409
  */
327
- shift_segments: Array<PublishedVersion.ShiftSegment>;
410
+ shift_breaks?: Array<PublishedVersion.ShiftBreak>;
328
411
  /**
329
- * The start time of the shift
412
+ * The segments of the shift
330
413
  */
331
- start_time: string;
414
+ shift_segments?: Array<PublishedVersion.ShiftSegment>;
332
415
  }
333
416
  namespace PublishedVersion {
334
417
  interface ShiftBreak {
335
418
  /**
336
- * The end time of the shift break
419
+ * The duration of the shift break in minutes (input only for creation)
337
420
  */
338
- end_time: string;
421
+ duration_minutes: number;
339
422
  /**
340
423
  * The start time of the shift break
341
424
  */
@@ -343,17 +426,26 @@ export declare namespace ShiftassignmentRetrieveResponse {
343
426
  /**
344
427
  * The type of the shift break
345
428
  */
346
- type: string;
429
+ type: 'MEAL' | 'REST';
430
+ /**
431
+ * The end time of the shift break (calculated from start_time + duration_minutes)
432
+ */
433
+ end_time?: string;
347
434
  }
348
435
  interface ShiftSegment {
349
436
  /**
350
- * The end time of the shift segment
437
+ * The duration of the shift segment in minutes (input only for creation)
351
438
  */
352
- end_time: string;
439
+ duration_minutes: number;
353
440
  /**
354
441
  * The start time of the shift segment
355
442
  */
356
443
  start_time: string;
444
+ /**
445
+ * The end time of the shift segment (calculated from start_time +
446
+ * duration_minutes)
447
+ */
448
+ end_time?: string;
357
449
  /**
358
450
  * The IDs of the job codes associated with the shift segment
359
451
  */
@@ -434,67 +526,662 @@ export declare namespace ShiftassignmentRetrieveResponse {
434
526
  timezone?: string;
435
527
  }
436
528
  }
529
+ }
530
+ /**
531
+ * Meta information for the response.
532
+ */
533
+ export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
534
+ /**
535
+ * Identifier field
536
+ */
537
+ id: string;
538
+ /**
539
+ * Record creation date
540
+ */
541
+ created_at: string;
542
+ /**
543
+ * Whether the shift assignment is published. If true, the published_version will
544
+ * be the same as the shift_data
545
+ */
546
+ is_published: boolean;
547
+ /**
548
+ * The ID of the schedule
549
+ */
550
+ schedule_id: string;
437
551
  /**
438
552
  * The data of the shift
439
553
  */
440
- interface ShiftData {
441
- /**
442
- * The end time of the shift
443
- */
444
- end_time: string;
445
- /**
446
- * The breaks of the shift
447
- */
448
- shift_breaks: Array<ShiftData.ShiftBreak>;
449
- /**
450
- * The segments of the shift
451
- */
452
- shift_segments: Array<ShiftData.ShiftSegment>;
453
- /**
454
- * The start time of the shift
455
- */
456
- start_time: string;
457
- }
458
- namespace ShiftData {
459
- interface ShiftBreak {
460
- /**
461
- * The end time of the shift break
462
- */
463
- end_time: string;
464
- /**
465
- * The start time of the shift break
466
- */
467
- start_time: string;
468
- /**
469
- * The type of the shift break
554
+ shift_data: ShiftassignmentRetrieveResponse.ShiftData;
555
+ /**
556
+ * Record update date
557
+ */
558
+ updated_at: string;
559
+ /**
560
+ * The ID of the worker
561
+ */
562
+ worker_id: string;
563
+ /**
564
+ * Whether the shift assignment can be edited
565
+ */
566
+ can_edit?: boolean;
567
+ /**
568
+ * The published version of the shift assignment, if it exists. If filled but
569
+ * is_published is false, the shift_data is the latest version.
570
+ */
571
+ published_version?: ShiftassignmentRetrieveResponse.PublishedVersion;
572
+ /**
573
+ * The schedule
574
+ *
575
+ * Expandable field
576
+ */
577
+ schedule?: ShiftassignmentRetrieveResponse.Schedule;
578
+ /**
579
+ * The worker
580
+ *
581
+ * Expandable field
582
+ */
583
+ worker?: WorkersAPI.Worker;
584
+ }
585
+ export declare namespace ShiftassignmentRetrieveResponse {
586
+ /**
587
+ * The data of the shift
588
+ */
589
+ interface ShiftData {
590
+ /**
591
+ * The end time of the shift
592
+ */
593
+ end_time: string;
594
+ /**
595
+ * The start time of the shift
596
+ */
597
+ start_time: string;
598
+ /**
599
+ * The breaks of the shift
600
+ */
601
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
602
+ /**
603
+ * The segments of the shift
604
+ */
605
+ shift_segments?: Array<ShiftData.ShiftSegment>;
606
+ }
607
+ namespace ShiftData {
608
+ interface ShiftBreak {
609
+ /**
610
+ * The duration of the shift break in minutes (input only for creation)
611
+ */
612
+ duration_minutes: number;
613
+ /**
614
+ * The start time of the shift break
615
+ */
616
+ start_time: string;
617
+ /**
618
+ * The type of the shift break
619
+ */
620
+ type: 'MEAL' | 'REST';
621
+ /**
622
+ * The end time of the shift break (calculated from start_time + duration_minutes)
623
+ */
624
+ end_time?: string;
625
+ }
626
+ interface ShiftSegment {
627
+ /**
628
+ * The duration of the shift segment in minutes (input only for creation)
629
+ */
630
+ duration_minutes: number;
631
+ /**
632
+ * The start time of the shift segment
633
+ */
634
+ start_time: string;
635
+ /**
636
+ * The end time of the shift segment (calculated from start_time +
637
+ * duration_minutes)
638
+ */
639
+ end_time?: string;
640
+ /**
641
+ * The IDs of the job codes associated with the shift segment
642
+ */
643
+ job_codes_id?: Array<string>;
644
+ }
645
+ }
646
+ /**
647
+ * The published version of the shift assignment, if it exists. If filled but
648
+ * is_published is false, the shift_data is the latest version.
649
+ */
650
+ interface PublishedVersion {
651
+ /**
652
+ * The end time of the shift
653
+ */
654
+ end_time: string;
655
+ /**
656
+ * The start time of the shift
657
+ */
658
+ start_time: string;
659
+ /**
660
+ * The breaks of the shift
661
+ */
662
+ shift_breaks?: Array<PublishedVersion.ShiftBreak>;
663
+ /**
664
+ * The segments of the shift
665
+ */
666
+ shift_segments?: Array<PublishedVersion.ShiftSegment>;
667
+ }
668
+ namespace PublishedVersion {
669
+ interface ShiftBreak {
670
+ /**
671
+ * The duration of the shift break in minutes (input only for creation)
672
+ */
673
+ duration_minutes: number;
674
+ /**
675
+ * The start time of the shift break
676
+ */
677
+ start_time: string;
678
+ /**
679
+ * The type of the shift break
680
+ */
681
+ type: 'MEAL' | 'REST';
682
+ /**
683
+ * The end time of the shift break (calculated from start_time + duration_minutes)
684
+ */
685
+ end_time?: string;
686
+ }
687
+ interface ShiftSegment {
688
+ /**
689
+ * The duration of the shift segment in minutes (input only for creation)
690
+ */
691
+ duration_minutes: number;
692
+ /**
693
+ * The start time of the shift segment
694
+ */
695
+ start_time: string;
696
+ /**
697
+ * The end time of the shift segment (calculated from start_time +
698
+ * duration_minutes)
699
+ */
700
+ end_time?: string;
701
+ /**
702
+ * The IDs of the job codes associated with the shift segment
703
+ */
704
+ job_codes_id?: Array<string>;
705
+ }
706
+ }
707
+ /**
708
+ * The schedule
709
+ *
710
+ * Expandable field
711
+ */
712
+ interface Schedule {
713
+ /**
714
+ * Identifier field
715
+ */
716
+ id: string;
717
+ /**
718
+ * Record creation date
719
+ */
720
+ created_at: string;
721
+ /**
722
+ * Record update date
723
+ */
724
+ updated_at: string;
725
+ /**
726
+ * Whether the requesting role can edit the schedule.
727
+ */
728
+ can_edit?: boolean;
729
+ /**
730
+ * The managers of the schedule.
731
+ *
732
+ * Expandable field
733
+ */
734
+ managers?: Array<WorkersAPI.Worker>;
735
+ /**
736
+ * The IDs of the managers of the schedule.
737
+ */
738
+ managers_id?: Array<string>;
739
+ /**
740
+ * The members of the schedule.
741
+ *
742
+ * Expandable field
743
+ */
744
+ members?: Array<WorkersAPI.Worker>;
745
+ /**
746
+ * The IDs of the members of the schedule.
747
+ */
748
+ members_id?: Array<string>;
749
+ /**
750
+ * The name of the schedule.
751
+ */
752
+ name?: string;
753
+ /**
754
+ * The observers of the schedule.
755
+ *
756
+ * Expandable field
757
+ */
758
+ observers?: Array<WorkersAPI.Worker>;
759
+ /**
760
+ * The IDs of the observers of the schedule.
761
+ */
762
+ observers_id?: Array<string>;
763
+ /**
764
+ * The settings of the schedule.
765
+ */
766
+ settings?: Schedule.Settings;
767
+ }
768
+ namespace Schedule {
769
+ /**
770
+ * The settings of the schedule.
771
+ */
772
+ interface Settings {
773
+ /**
774
+ * The IANA timezone identifier for the schedule (e.g., 'America/New_York').
775
+ * Accepted values are defined by the tz database, listed here:
776
+ * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
777
+ */
778
+ timezone?: string;
779
+ }
780
+ }
781
+ }
782
+ export interface ShiftassignmentUpdateResponse {
783
+ /**
784
+ * Identifier field
785
+ */
786
+ id: string;
787
+ /**
788
+ * Record creation date
789
+ */
790
+ created_at: string;
791
+ /**
792
+ * Whether the shift assignment is published. If true, the published_version will
793
+ * be the same as the shift_data
794
+ */
795
+ is_published: boolean;
796
+ /**
797
+ * The ID of the schedule
798
+ */
799
+ schedule_id: string;
800
+ /**
801
+ * The data of the shift
802
+ */
803
+ shift_data: ShiftassignmentUpdateResponse.ShiftData;
804
+ /**
805
+ * Record update date
806
+ */
807
+ updated_at: string;
808
+ /**
809
+ * The ID of the worker
810
+ */
811
+ worker_id: string;
812
+ /**
813
+ * Whether the shift assignment can be edited
814
+ */
815
+ can_edit?: boolean;
816
+ /**
817
+ * The published version of the shift assignment, if it exists. If filled but
818
+ * is_published is false, the shift_data is the latest version.
819
+ */
820
+ published_version?: ShiftassignmentUpdateResponse.PublishedVersion;
821
+ /**
822
+ * The schedule
823
+ *
824
+ * Expandable field
825
+ */
826
+ schedule?: ShiftassignmentUpdateResponse.Schedule;
827
+ /**
828
+ * The worker
829
+ *
830
+ * Expandable field
831
+ */
832
+ worker?: WorkersAPI.Worker;
833
+ }
834
+ export declare namespace ShiftassignmentUpdateResponse {
835
+ /**
836
+ * The data of the shift
837
+ */
838
+ interface ShiftData {
839
+ /**
840
+ * The end time of the shift
841
+ */
842
+ end_time: string;
843
+ /**
844
+ * The start time of the shift
845
+ */
846
+ start_time: string;
847
+ /**
848
+ * The breaks of the shift
849
+ */
850
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
851
+ /**
852
+ * The segments of the shift
853
+ */
854
+ shift_segments?: Array<ShiftData.ShiftSegment>;
855
+ }
856
+ namespace ShiftData {
857
+ interface ShiftBreak {
858
+ /**
859
+ * The duration of the shift break in minutes (input only for creation)
860
+ */
861
+ duration_minutes: number;
862
+ /**
863
+ * The start time of the shift break
864
+ */
865
+ start_time: string;
866
+ /**
867
+ * The type of the shift break
868
+ */
869
+ type: 'MEAL' | 'REST';
870
+ /**
871
+ * The end time of the shift break (calculated from start_time + duration_minutes)
872
+ */
873
+ end_time?: string;
874
+ }
875
+ interface ShiftSegment {
876
+ /**
877
+ * The duration of the shift segment in minutes (input only for creation)
878
+ */
879
+ duration_minutes: number;
880
+ /**
881
+ * The start time of the shift segment
882
+ */
883
+ start_time: string;
884
+ /**
885
+ * The end time of the shift segment (calculated from start_time +
886
+ * duration_minutes)
887
+ */
888
+ end_time?: string;
889
+ /**
890
+ * The IDs of the job codes associated with the shift segment
891
+ */
892
+ job_codes_id?: Array<string>;
893
+ }
894
+ }
895
+ /**
896
+ * The published version of the shift assignment, if it exists. If filled but
897
+ * is_published is false, the shift_data is the latest version.
898
+ */
899
+ interface PublishedVersion {
900
+ /**
901
+ * The end time of the shift
902
+ */
903
+ end_time: string;
904
+ /**
905
+ * The start time of the shift
906
+ */
907
+ start_time: string;
908
+ /**
909
+ * The breaks of the shift
910
+ */
911
+ shift_breaks?: Array<PublishedVersion.ShiftBreak>;
912
+ /**
913
+ * The segments of the shift
914
+ */
915
+ shift_segments?: Array<PublishedVersion.ShiftSegment>;
916
+ }
917
+ namespace PublishedVersion {
918
+ interface ShiftBreak {
919
+ /**
920
+ * The duration of the shift break in minutes (input only for creation)
921
+ */
922
+ duration_minutes: number;
923
+ /**
924
+ * The start time of the shift break
925
+ */
926
+ start_time: string;
927
+ /**
928
+ * The type of the shift break
929
+ */
930
+ type: 'MEAL' | 'REST';
931
+ /**
932
+ * The end time of the shift break (calculated from start_time + duration_minutes)
470
933
  */
471
- type: string;
934
+ end_time?: string;
472
935
  }
473
936
  interface ShiftSegment {
474
937
  /**
475
- * The end time of the shift segment
938
+ * The duration of the shift segment in minutes (input only for creation)
476
939
  */
477
- end_time: string;
940
+ duration_minutes: number;
478
941
  /**
479
942
  * The start time of the shift segment
480
943
  */
481
944
  start_time: string;
945
+ /**
946
+ * The end time of the shift segment (calculated from start_time +
947
+ * duration_minutes)
948
+ */
949
+ end_time?: string;
482
950
  /**
483
951
  * The IDs of the job codes associated with the shift segment
484
952
  */
485
953
  job_codes_id?: Array<string>;
486
954
  }
487
955
  }
956
+ /**
957
+ * The schedule
958
+ *
959
+ * Expandable field
960
+ */
961
+ interface Schedule {
962
+ /**
963
+ * Identifier field
964
+ */
965
+ id: string;
966
+ /**
967
+ * Record creation date
968
+ */
969
+ created_at: string;
970
+ /**
971
+ * Record update date
972
+ */
973
+ updated_at: string;
974
+ /**
975
+ * Whether the requesting role can edit the schedule.
976
+ */
977
+ can_edit?: boolean;
978
+ /**
979
+ * The managers of the schedule.
980
+ *
981
+ * Expandable field
982
+ */
983
+ managers?: Array<WorkersAPI.Worker>;
984
+ /**
985
+ * The IDs of the managers of the schedule.
986
+ */
987
+ managers_id?: Array<string>;
988
+ /**
989
+ * The members of the schedule.
990
+ *
991
+ * Expandable field
992
+ */
993
+ members?: Array<WorkersAPI.Worker>;
994
+ /**
995
+ * The IDs of the members of the schedule.
996
+ */
997
+ members_id?: Array<string>;
998
+ /**
999
+ * The name of the schedule.
1000
+ */
1001
+ name?: string;
1002
+ /**
1003
+ * The observers of the schedule.
1004
+ *
1005
+ * Expandable field
1006
+ */
1007
+ observers?: Array<WorkersAPI.Worker>;
1008
+ /**
1009
+ * The IDs of the observers of the schedule.
1010
+ */
1011
+ observers_id?: Array<string>;
1012
+ /**
1013
+ * The settings of the schedule.
1014
+ */
1015
+ settings?: Schedule.Settings;
1016
+ }
1017
+ namespace Schedule {
1018
+ /**
1019
+ * The settings of the schedule.
1020
+ */
1021
+ interface Settings {
1022
+ /**
1023
+ * The IANA timezone identifier for the schedule (e.g., 'America/New_York').
1024
+ * Accepted values are defined by the tz database, listed here:
1025
+ * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
1026
+ */
1027
+ timezone?: string;
1028
+ }
1029
+ }
488
1030
  }
489
1031
  export interface ShiftassignmentListParams {
1032
+ cursor?: string;
490
1033
  expand?: string;
491
1034
  filter?: string;
492
1035
  order_by?: string;
493
1036
  }
1037
+ export interface ShiftassignmentCreateParams {
1038
+ /**
1039
+ * Whether the shift assignment is published. If true, the published_version will
1040
+ * be the same as the shift_data
1041
+ */
1042
+ is_published: boolean;
1043
+ /**
1044
+ * The ID of the schedule
1045
+ */
1046
+ schedule_id: string;
1047
+ /**
1048
+ * The data of the shift
1049
+ */
1050
+ shift_data: ShiftassignmentCreateParams.ShiftData;
1051
+ /**
1052
+ * The ID of the worker
1053
+ */
1054
+ worker_id: string;
1055
+ }
1056
+ export declare namespace ShiftassignmentCreateParams {
1057
+ /**
1058
+ * The data of the shift
1059
+ */
1060
+ interface ShiftData {
1061
+ /**
1062
+ * The end time of the shift
1063
+ */
1064
+ end_time: string;
1065
+ /**
1066
+ * The start time of the shift
1067
+ */
1068
+ start_time: string;
1069
+ /**
1070
+ * The breaks of the shift
1071
+ */
1072
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
1073
+ /**
1074
+ * The segments of the shift
1075
+ */
1076
+ shift_segments?: Array<ShiftData.ShiftSegment>;
1077
+ }
1078
+ namespace ShiftData {
1079
+ interface ShiftBreak {
1080
+ /**
1081
+ * The duration of the shift break in minutes (input only for creation)
1082
+ */
1083
+ duration_minutes: number;
1084
+ /**
1085
+ * The start time of the shift break
1086
+ */
1087
+ start_time: string;
1088
+ /**
1089
+ * The type of the shift break
1090
+ */
1091
+ type: 'MEAL' | 'REST';
1092
+ }
1093
+ interface ShiftSegment {
1094
+ /**
1095
+ * The duration of the shift segment in minutes (input only for creation)
1096
+ */
1097
+ duration_minutes: number;
1098
+ /**
1099
+ * The start time of the shift segment
1100
+ */
1101
+ start_time: string;
1102
+ /**
1103
+ * The IDs of the job codes associated with the shift segment
1104
+ */
1105
+ job_codes_id?: Array<string>;
1106
+ }
1107
+ }
1108
+ }
494
1109
  export interface ShiftassignmentRetrieveParams {
495
1110
  expand?: string;
496
1111
  }
1112
+ export interface ShiftassignmentUpdateParams {
1113
+ /**
1114
+ * Whether the shift assignment is published. If true, the published_version will
1115
+ * be the same as the shift_data
1116
+ */
1117
+ is_published: boolean;
1118
+ /**
1119
+ * The ID of the schedule
1120
+ */
1121
+ schedule_id: string;
1122
+ /**
1123
+ * The data of the shift
1124
+ */
1125
+ shift_data: ShiftassignmentUpdateParams.ShiftData;
1126
+ /**
1127
+ * The ID of the worker
1128
+ */
1129
+ worker_id: string;
1130
+ }
1131
+ export declare namespace ShiftassignmentUpdateParams {
1132
+ /**
1133
+ * The data of the shift
1134
+ */
1135
+ interface ShiftData {
1136
+ /**
1137
+ * The end time of the shift
1138
+ */
1139
+ end_time: string;
1140
+ /**
1141
+ * The start time of the shift
1142
+ */
1143
+ start_time: string;
1144
+ /**
1145
+ * The breaks of the shift
1146
+ */
1147
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
1148
+ /**
1149
+ * The segments of the shift
1150
+ */
1151
+ shift_segments?: Array<ShiftData.ShiftSegment>;
1152
+ }
1153
+ namespace ShiftData {
1154
+ interface ShiftBreak {
1155
+ /**
1156
+ * The duration of the shift break in minutes (input only for creation)
1157
+ */
1158
+ duration_minutes: number;
1159
+ /**
1160
+ * The start time of the shift break
1161
+ */
1162
+ start_time: string;
1163
+ /**
1164
+ * The type of the shift break
1165
+ */
1166
+ type: 'MEAL' | 'REST';
1167
+ }
1168
+ interface ShiftSegment {
1169
+ /**
1170
+ * The duration of the shift segment in minutes (input only for creation)
1171
+ */
1172
+ duration_minutes: number;
1173
+ /**
1174
+ * The start time of the shift segment
1175
+ */
1176
+ start_time: string;
1177
+ /**
1178
+ * The IDs of the job codes associated with the shift segment
1179
+ */
1180
+ job_codes_id?: Array<string>;
1181
+ }
1182
+ }
1183
+ }
497
1184
  export declare namespace Shiftassignments {
498
- export { type ShiftassignmentListResponse as ShiftassignmentListResponse, type ShiftassignmentRetrieveResponse as ShiftassignmentRetrieveResponse, type ShiftassignmentListResponsesPageCursorURL as ShiftassignmentListResponsesPageCursorURL, type ShiftassignmentListParams as ShiftassignmentListParams, type ShiftassignmentRetrieveParams as ShiftassignmentRetrieveParams, };
1185
+ export { type ShiftassignmentListResponse as ShiftassignmentListResponse, type ShiftassignmentCreateResponse as ShiftassignmentCreateResponse, type ShiftassignmentRetrieveResponse as ShiftassignmentRetrieveResponse, type ShiftassignmentUpdateResponse as ShiftassignmentUpdateResponse, type ShiftassignmentListResponsesPageCursorURL as ShiftassignmentListResponsesPageCursorURL, type ShiftassignmentListParams as ShiftassignmentListParams, type ShiftassignmentCreateParams as ShiftassignmentCreateParams, type ShiftassignmentRetrieveParams as ShiftassignmentRetrieveParams, type ShiftassignmentUpdateParams as ShiftassignmentUpdateParams, };
499
1186
  }
500
1187
  //# sourceMappingURL=shiftassignments.d.ts.map