@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
@@ -28,6 +28,16 @@ export class Shiftassignments extends APIResource {
28
28
  });
29
29
  }
30
30
 
31
+ /**
32
+ * Create a new shift assignment
33
+ */
34
+ create(
35
+ body: ShiftassignmentCreateParams,
36
+ options?: RequestOptions,
37
+ ): APIPromise<ShiftassignmentCreateResponse> {
38
+ return this._client.post('/shiftassignments', { body, ...options });
39
+ }
40
+
31
41
  /**
32
42
  * Retrieve a specific shift assignment
33
43
  */
@@ -38,6 +48,17 @@ export class Shiftassignments extends APIResource {
38
48
  ): APIPromise<ShiftassignmentRetrieveResponse> {
39
49
  return this._client.get(path`/shiftassignments/${id}`, { query, ...options });
40
50
  }
51
+
52
+ /**
53
+ * Updated a specific shift assignment
54
+ */
55
+ update(
56
+ id: string,
57
+ body: ShiftassignmentUpdateParams,
58
+ options?: RequestOptions,
59
+ ): APIPromise<ShiftassignmentUpdateResponse> {
60
+ return this._client.patch(path`/shiftassignments/${id}`, { body, ...options });
61
+ }
41
62
  }
42
63
 
43
64
  export type ShiftassignmentListResponsesPageCursorURL = PageCursorURL<ShiftassignmentListResponse>;
@@ -48,11 +69,6 @@ export interface ShiftassignmentListResponse {
48
69
  */
49
70
  id: string;
50
71
 
51
- /**
52
- * Whether the shift assignment can be edited
53
- */
54
- can_edit: boolean;
55
-
56
72
  /**
57
73
  * Record creation date
58
74
  */
@@ -64,11 +80,31 @@ export interface ShiftassignmentListResponse {
64
80
  */
65
81
  is_published: boolean;
66
82
 
83
+ /**
84
+ * The ID of the schedule
85
+ */
86
+ schedule_id: string;
87
+
88
+ /**
89
+ * The data of the shift
90
+ */
91
+ shift_data: ShiftassignmentListResponse.ShiftData;
92
+
67
93
  /**
68
94
  * Record update date
69
95
  */
70
96
  updated_at: string;
71
97
 
98
+ /**
99
+ * The ID of the worker
100
+ */
101
+ worker_id: string;
102
+
103
+ /**
104
+ * Whether the shift assignment can be edited
105
+ */
106
+ can_edit?: boolean;
107
+
72
108
  /**
73
109
  * The published version of the shift assignment, if it exists. If filled but
74
110
  * is_published is false, the shift_data is the latest version.
@@ -82,62 +118,119 @@ export interface ShiftassignmentListResponse {
82
118
  */
83
119
  schedule?: ShiftassignmentListResponse.Schedule;
84
120
 
85
- /**
86
- * The ID of the schedule
87
- */
88
- schedule_id?: string;
89
-
90
- /**
91
- * The data of the shift
92
- */
93
- shift_data?: ShiftassignmentListResponse.ShiftData;
94
-
95
121
  /**
96
122
  * The worker
97
123
  *
98
124
  * Expandable field
99
125
  */
100
126
  worker?: WorkersAPI.Worker;
101
-
102
- /**
103
- * The ID of the worker
104
- */
105
- worker_id?: string;
106
127
  }
107
128
 
108
129
  export namespace ShiftassignmentListResponse {
109
130
  /**
110
- * The published version of the shift assignment, if it exists. If filled but
111
- * is_published is false, the shift_data is the latest version.
131
+ * The data of the shift
112
132
  */
113
- export interface PublishedVersion {
133
+ export interface ShiftData {
114
134
  /**
115
135
  * The end time of the shift
116
136
  */
117
137
  end_time: string;
118
138
 
139
+ /**
140
+ * The start time of the shift
141
+ */
142
+ start_time: string;
143
+
119
144
  /**
120
145
  * The breaks of the shift
121
146
  */
122
- shift_breaks: Array<PublishedVersion.ShiftBreak>;
147
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
123
148
 
124
149
  /**
125
150
  * The segments of the shift
126
151
  */
127
- shift_segments: Array<PublishedVersion.ShiftSegment>;
152
+ shift_segments?: Array<ShiftData.ShiftSegment>;
153
+ }
154
+
155
+ export namespace ShiftData {
156
+ export interface ShiftBreak {
157
+ /**
158
+ * The duration of the shift break in minutes (input only for creation)
159
+ */
160
+ duration_minutes: number;
161
+
162
+ /**
163
+ * The start time of the shift break
164
+ */
165
+ start_time: string;
166
+
167
+ /**
168
+ * The type of the shift break
169
+ */
170
+ type: 'MEAL' | 'REST';
171
+
172
+ /**
173
+ * The end time of the shift break (calculated from start_time + duration_minutes)
174
+ */
175
+ end_time?: string;
176
+ }
177
+
178
+ export interface ShiftSegment {
179
+ /**
180
+ * The duration of the shift segment in minutes (input only for creation)
181
+ */
182
+ duration_minutes: number;
183
+
184
+ /**
185
+ * The start time of the shift segment
186
+ */
187
+ start_time: string;
188
+
189
+ /**
190
+ * The end time of the shift segment (calculated from start_time +
191
+ * duration_minutes)
192
+ */
193
+ end_time?: string;
194
+
195
+ /**
196
+ * The IDs of the job codes associated with the shift segment
197
+ */
198
+ job_codes_id?: Array<string>;
199
+ }
200
+ }
201
+
202
+ /**
203
+ * The published version of the shift assignment, if it exists. If filled but
204
+ * is_published is false, the shift_data is the latest version.
205
+ */
206
+ export interface PublishedVersion {
207
+ /**
208
+ * The end time of the shift
209
+ */
210
+ end_time: string;
128
211
 
129
212
  /**
130
213
  * The start time of the shift
131
214
  */
132
215
  start_time: string;
216
+
217
+ /**
218
+ * The breaks of the shift
219
+ */
220
+ shift_breaks?: Array<PublishedVersion.ShiftBreak>;
221
+
222
+ /**
223
+ * The segments of the shift
224
+ */
225
+ shift_segments?: Array<PublishedVersion.ShiftSegment>;
133
226
  }
134
227
 
135
228
  export namespace PublishedVersion {
136
229
  export interface ShiftBreak {
137
230
  /**
138
- * The end time of the shift break
231
+ * The duration of the shift break in minutes (input only for creation)
139
232
  */
140
- end_time: string;
233
+ duration_minutes: number;
141
234
 
142
235
  /**
143
236
  * The start time of the shift break
@@ -147,20 +240,31 @@ export namespace ShiftassignmentListResponse {
147
240
  /**
148
241
  * The type of the shift break
149
242
  */
150
- type: string;
243
+ type: 'MEAL' | 'REST';
244
+
245
+ /**
246
+ * The end time of the shift break (calculated from start_time + duration_minutes)
247
+ */
248
+ end_time?: string;
151
249
  }
152
250
 
153
251
  export interface ShiftSegment {
154
252
  /**
155
- * The end time of the shift segment
253
+ * The duration of the shift segment in minutes (input only for creation)
156
254
  */
157
- end_time: string;
255
+ duration_minutes: number;
158
256
 
159
257
  /**
160
258
  * The start time of the shift segment
161
259
  */
162
260
  start_time: string;
163
261
 
262
+ /**
263
+ * The end time of the shift segment (calculated from start_time +
264
+ * duration_minutes)
265
+ */
266
+ end_time?: string;
267
+
164
268
  /**
165
269
  * The IDs of the job codes associated with the shift segment
166
270
  */
@@ -254,83 +358,14 @@ export namespace ShiftassignmentListResponse {
254
358
  timezone?: string;
255
359
  }
256
360
  }
257
-
258
- /**
259
- * The data of the shift
260
- */
261
- export interface ShiftData {
262
- /**
263
- * The end time of the shift
264
- */
265
- end_time: string;
266
-
267
- /**
268
- * The breaks of the shift
269
- */
270
- shift_breaks: Array<ShiftData.ShiftBreak>;
271
-
272
- /**
273
- * The segments of the shift
274
- */
275
- shift_segments: Array<ShiftData.ShiftSegment>;
276
-
277
- /**
278
- * The start time of the shift
279
- */
280
- start_time: string;
281
- }
282
-
283
- export namespace ShiftData {
284
- export interface ShiftBreak {
285
- /**
286
- * The end time of the shift break
287
- */
288
- end_time: string;
289
-
290
- /**
291
- * The start time of the shift break
292
- */
293
- start_time: string;
294
-
295
- /**
296
- * The type of the shift break
297
- */
298
- type: string;
299
- }
300
-
301
- export interface ShiftSegment {
302
- /**
303
- * The end time of the shift segment
304
- */
305
- end_time: string;
306
-
307
- /**
308
- * The start time of the shift segment
309
- */
310
- start_time: string;
311
-
312
- /**
313
- * The IDs of the job codes associated with the shift segment
314
- */
315
- job_codes_id?: Array<string>;
316
- }
317
- }
318
361
  }
319
362
 
320
- /**
321
- * Meta information for the response.
322
- */
323
- export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
363
+ export interface ShiftassignmentCreateResponse {
324
364
  /**
325
365
  * Identifier field
326
366
  */
327
367
  id: string;
328
368
 
329
- /**
330
- * Whether the shift assignment can be edited
331
- */
332
- can_edit: boolean;
333
-
334
369
  /**
335
370
  * Record creation date
336
371
  */
@@ -342,33 +377,43 @@ export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Met
342
377
  */
343
378
  is_published: boolean;
344
379
 
380
+ /**
381
+ * The ID of the schedule
382
+ */
383
+ schedule_id: string;
384
+
385
+ /**
386
+ * The data of the shift
387
+ */
388
+ shift_data: ShiftassignmentCreateResponse.ShiftData;
389
+
345
390
  /**
346
391
  * Record update date
347
392
  */
348
393
  updated_at: string;
349
394
 
350
395
  /**
351
- * The published version of the shift assignment, if it exists. If filled but
352
- * is_published is false, the shift_data is the latest version.
396
+ * The ID of the worker
353
397
  */
354
- published_version?: ShiftassignmentRetrieveResponse.PublishedVersion;
398
+ worker_id: string;
355
399
 
356
400
  /**
357
- * The schedule
358
- *
359
- * Expandable field
401
+ * Whether the shift assignment can be edited
360
402
  */
361
- schedule?: ShiftassignmentRetrieveResponse.Schedule;
403
+ can_edit?: boolean;
362
404
 
363
405
  /**
364
- * The ID of the schedule
406
+ * The published version of the shift assignment, if it exists. If filled but
407
+ * is_published is false, the shift_data is the latest version.
365
408
  */
366
- schedule_id?: string;
409
+ published_version?: ShiftassignmentCreateResponse.PublishedVersion;
367
410
 
368
411
  /**
369
- * The data of the shift
412
+ * The schedule
413
+ *
414
+ * Expandable field
370
415
  */
371
- shift_data?: ShiftassignmentRetrieveResponse.ShiftData;
416
+ schedule?: ShiftassignmentCreateResponse.Schedule;
372
417
 
373
418
  /**
374
419
  * The worker
@@ -376,46 +421,40 @@ export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Met
376
421
  * Expandable field
377
422
  */
378
423
  worker?: WorkersAPI.Worker;
379
-
380
- /**
381
- * The ID of the worker
382
- */
383
- worker_id?: string;
384
424
  }
385
425
 
386
- export namespace ShiftassignmentRetrieveResponse {
426
+ export namespace ShiftassignmentCreateResponse {
387
427
  /**
388
- * The published version of the shift assignment, if it exists. If filled but
389
- * is_published is false, the shift_data is the latest version.
428
+ * The data of the shift
390
429
  */
391
- export interface PublishedVersion {
430
+ export interface ShiftData {
392
431
  /**
393
432
  * The end time of the shift
394
433
  */
395
434
  end_time: string;
396
435
 
397
436
  /**
398
- * The breaks of the shift
437
+ * The start time of the shift
399
438
  */
400
- shift_breaks: Array<PublishedVersion.ShiftBreak>;
439
+ start_time: string;
401
440
 
402
441
  /**
403
- * The segments of the shift
442
+ * The breaks of the shift
404
443
  */
405
- shift_segments: Array<PublishedVersion.ShiftSegment>;
444
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
406
445
 
407
446
  /**
408
- * The start time of the shift
447
+ * The segments of the shift
409
448
  */
410
- start_time: string;
449
+ shift_segments?: Array<ShiftData.ShiftSegment>;
411
450
  }
412
451
 
413
- export namespace PublishedVersion {
452
+ export namespace ShiftData {
414
453
  export interface ShiftBreak {
415
454
  /**
416
- * The end time of the shift break
455
+ * The duration of the shift break in minutes (input only for creation)
417
456
  */
418
- end_time: string;
457
+ duration_minutes: number;
419
458
 
420
459
  /**
421
460
  * The start time of the shift break
@@ -425,20 +464,31 @@ export namespace ShiftassignmentRetrieveResponse {
425
464
  /**
426
465
  * The type of the shift break
427
466
  */
428
- type: string;
467
+ type: 'MEAL' | 'REST';
468
+
469
+ /**
470
+ * The end time of the shift break (calculated from start_time + duration_minutes)
471
+ */
472
+ end_time?: string;
429
473
  }
430
474
 
431
475
  export interface ShiftSegment {
432
476
  /**
433
- * The end time of the shift segment
477
+ * The duration of the shift segment in minutes (input only for creation)
434
478
  */
435
- end_time: string;
479
+ duration_minutes: number;
436
480
 
437
481
  /**
438
482
  * The start time of the shift segment
439
483
  */
440
484
  start_time: string;
441
485
 
486
+ /**
487
+ * The end time of the shift segment (calculated from start_time +
488
+ * duration_minutes)
489
+ */
490
+ end_time?: string;
491
+
442
492
  /**
443
493
  * The IDs of the job codes associated with the shift segment
444
494
  */
@@ -447,37 +497,707 @@ export namespace ShiftassignmentRetrieveResponse {
447
497
  }
448
498
 
449
499
  /**
450
- * The schedule
451
- *
452
- * Expandable field
500
+ * The published version of the shift assignment, if it exists. If filled but
501
+ * is_published is false, the shift_data is the latest version.
453
502
  */
454
- export interface Schedule {
455
- /**
456
- * Identifier field
457
- */
458
- id: string;
459
-
503
+ export interface PublishedVersion {
460
504
  /**
461
- * Record creation date
505
+ * The end time of the shift
462
506
  */
463
- created_at: string;
507
+ end_time: string;
464
508
 
465
509
  /**
466
- * Record update date
510
+ * The start time of the shift
467
511
  */
468
- updated_at: string;
512
+ start_time: string;
469
513
 
470
514
  /**
471
- * Whether the requesting role can edit the schedule.
515
+ * The breaks of the shift
472
516
  */
473
- can_edit?: boolean;
517
+ shift_breaks?: Array<PublishedVersion.ShiftBreak>;
474
518
 
475
519
  /**
476
- * The managers of the schedule.
477
- *
478
- * Expandable field
520
+ * The segments of the shift
479
521
  */
480
- managers?: Array<WorkersAPI.Worker>;
522
+ shift_segments?: Array<PublishedVersion.ShiftSegment>;
523
+ }
524
+
525
+ export namespace PublishedVersion {
526
+ export interface ShiftBreak {
527
+ /**
528
+ * The duration of the shift break in minutes (input only for creation)
529
+ */
530
+ duration_minutes: number;
531
+
532
+ /**
533
+ * The start time of the shift break
534
+ */
535
+ start_time: string;
536
+
537
+ /**
538
+ * The type of the shift break
539
+ */
540
+ type: 'MEAL' | 'REST';
541
+
542
+ /**
543
+ * The end time of the shift break (calculated from start_time + duration_minutes)
544
+ */
545
+ end_time?: string;
546
+ }
547
+
548
+ export interface ShiftSegment {
549
+ /**
550
+ * The duration of the shift segment in minutes (input only for creation)
551
+ */
552
+ duration_minutes: number;
553
+
554
+ /**
555
+ * The start time of the shift segment
556
+ */
557
+ start_time: string;
558
+
559
+ /**
560
+ * The end time of the shift segment (calculated from start_time +
561
+ * duration_minutes)
562
+ */
563
+ end_time?: string;
564
+
565
+ /**
566
+ * The IDs of the job codes associated with the shift segment
567
+ */
568
+ job_codes_id?: Array<string>;
569
+ }
570
+ }
571
+
572
+ /**
573
+ * The schedule
574
+ *
575
+ * Expandable field
576
+ */
577
+ export interface Schedule {
578
+ /**
579
+ * Identifier field
580
+ */
581
+ id: string;
582
+
583
+ /**
584
+ * Record creation date
585
+ */
586
+ created_at: string;
587
+
588
+ /**
589
+ * Record update date
590
+ */
591
+ updated_at: string;
592
+
593
+ /**
594
+ * Whether the requesting role can edit the schedule.
595
+ */
596
+ can_edit?: boolean;
597
+
598
+ /**
599
+ * The managers of the schedule.
600
+ *
601
+ * Expandable field
602
+ */
603
+ managers?: Array<WorkersAPI.Worker>;
604
+
605
+ /**
606
+ * The IDs of the managers of the schedule.
607
+ */
608
+ managers_id?: Array<string>;
609
+
610
+ /**
611
+ * The members of the schedule.
612
+ *
613
+ * Expandable field
614
+ */
615
+ members?: Array<WorkersAPI.Worker>;
616
+
617
+ /**
618
+ * The IDs of the members of the schedule.
619
+ */
620
+ members_id?: Array<string>;
621
+
622
+ /**
623
+ * The name of the schedule.
624
+ */
625
+ name?: string;
626
+
627
+ /**
628
+ * The observers of the schedule.
629
+ *
630
+ * Expandable field
631
+ */
632
+ observers?: Array<WorkersAPI.Worker>;
633
+
634
+ /**
635
+ * The IDs of the observers of the schedule.
636
+ */
637
+ observers_id?: Array<string>;
638
+
639
+ /**
640
+ * The settings of the schedule.
641
+ */
642
+ settings?: Schedule.Settings;
643
+ }
644
+
645
+ export namespace Schedule {
646
+ /**
647
+ * The settings of the schedule.
648
+ */
649
+ export interface Settings {
650
+ /**
651
+ * The IANA timezone identifier for the schedule (e.g., 'America/New_York').
652
+ * Accepted values are defined by the tz database, listed here:
653
+ * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
654
+ */
655
+ timezone?: string;
656
+ }
657
+ }
658
+ }
659
+
660
+ /**
661
+ * Meta information for the response.
662
+ */
663
+ export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
664
+ /**
665
+ * Identifier field
666
+ */
667
+ id: string;
668
+
669
+ /**
670
+ * Record creation date
671
+ */
672
+ created_at: string;
673
+
674
+ /**
675
+ * Whether the shift assignment is published. If true, the published_version will
676
+ * be the same as the shift_data
677
+ */
678
+ is_published: boolean;
679
+
680
+ /**
681
+ * The ID of the schedule
682
+ */
683
+ schedule_id: string;
684
+
685
+ /**
686
+ * The data of the shift
687
+ */
688
+ shift_data: ShiftassignmentRetrieveResponse.ShiftData;
689
+
690
+ /**
691
+ * Record update date
692
+ */
693
+ updated_at: string;
694
+
695
+ /**
696
+ * The ID of the worker
697
+ */
698
+ worker_id: string;
699
+
700
+ /**
701
+ * Whether the shift assignment can be edited
702
+ */
703
+ can_edit?: boolean;
704
+
705
+ /**
706
+ * The published version of the shift assignment, if it exists. If filled but
707
+ * is_published is false, the shift_data is the latest version.
708
+ */
709
+ published_version?: ShiftassignmentRetrieveResponse.PublishedVersion;
710
+
711
+ /**
712
+ * The schedule
713
+ *
714
+ * Expandable field
715
+ */
716
+ schedule?: ShiftassignmentRetrieveResponse.Schedule;
717
+
718
+ /**
719
+ * The worker
720
+ *
721
+ * Expandable field
722
+ */
723
+ worker?: WorkersAPI.Worker;
724
+ }
725
+
726
+ export namespace ShiftassignmentRetrieveResponse {
727
+ /**
728
+ * The data of the shift
729
+ */
730
+ export interface ShiftData {
731
+ /**
732
+ * The end time of the shift
733
+ */
734
+ end_time: string;
735
+
736
+ /**
737
+ * The start time of the shift
738
+ */
739
+ start_time: string;
740
+
741
+ /**
742
+ * The breaks of the shift
743
+ */
744
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
745
+
746
+ /**
747
+ * The segments of the shift
748
+ */
749
+ shift_segments?: Array<ShiftData.ShiftSegment>;
750
+ }
751
+
752
+ export namespace ShiftData {
753
+ export interface ShiftBreak {
754
+ /**
755
+ * The duration of the shift break in minutes (input only for creation)
756
+ */
757
+ duration_minutes: number;
758
+
759
+ /**
760
+ * The start time of the shift break
761
+ */
762
+ start_time: string;
763
+
764
+ /**
765
+ * The type of the shift break
766
+ */
767
+ type: 'MEAL' | 'REST';
768
+
769
+ /**
770
+ * The end time of the shift break (calculated from start_time + duration_minutes)
771
+ */
772
+ end_time?: string;
773
+ }
774
+
775
+ export interface ShiftSegment {
776
+ /**
777
+ * The duration of the shift segment in minutes (input only for creation)
778
+ */
779
+ duration_minutes: number;
780
+
781
+ /**
782
+ * The start time of the shift segment
783
+ */
784
+ start_time: string;
785
+
786
+ /**
787
+ * The end time of the shift segment (calculated from start_time +
788
+ * duration_minutes)
789
+ */
790
+ end_time?: string;
791
+
792
+ /**
793
+ * The IDs of the job codes associated with the shift segment
794
+ */
795
+ job_codes_id?: Array<string>;
796
+ }
797
+ }
798
+
799
+ /**
800
+ * The published version of the shift assignment, if it exists. If filled but
801
+ * is_published is false, the shift_data is the latest version.
802
+ */
803
+ export interface PublishedVersion {
804
+ /**
805
+ * The end time of the shift
806
+ */
807
+ end_time: string;
808
+
809
+ /**
810
+ * The start time of the shift
811
+ */
812
+ start_time: string;
813
+
814
+ /**
815
+ * The breaks of the shift
816
+ */
817
+ shift_breaks?: Array<PublishedVersion.ShiftBreak>;
818
+
819
+ /**
820
+ * The segments of the shift
821
+ */
822
+ shift_segments?: Array<PublishedVersion.ShiftSegment>;
823
+ }
824
+
825
+ export namespace PublishedVersion {
826
+ export interface ShiftBreak {
827
+ /**
828
+ * The duration of the shift break in minutes (input only for creation)
829
+ */
830
+ duration_minutes: number;
831
+
832
+ /**
833
+ * The start time of the shift break
834
+ */
835
+ start_time: string;
836
+
837
+ /**
838
+ * The type of the shift break
839
+ */
840
+ type: 'MEAL' | 'REST';
841
+
842
+ /**
843
+ * The end time of the shift break (calculated from start_time + duration_minutes)
844
+ */
845
+ end_time?: string;
846
+ }
847
+
848
+ export interface ShiftSegment {
849
+ /**
850
+ * The duration of the shift segment in minutes (input only for creation)
851
+ */
852
+ duration_minutes: number;
853
+
854
+ /**
855
+ * The start time of the shift segment
856
+ */
857
+ start_time: string;
858
+
859
+ /**
860
+ * The end time of the shift segment (calculated from start_time +
861
+ * duration_minutes)
862
+ */
863
+ end_time?: string;
864
+
865
+ /**
866
+ * The IDs of the job codes associated with the shift segment
867
+ */
868
+ job_codes_id?: Array<string>;
869
+ }
870
+ }
871
+
872
+ /**
873
+ * The schedule
874
+ *
875
+ * Expandable field
876
+ */
877
+ export interface Schedule {
878
+ /**
879
+ * Identifier field
880
+ */
881
+ id: string;
882
+
883
+ /**
884
+ * Record creation date
885
+ */
886
+ created_at: string;
887
+
888
+ /**
889
+ * Record update date
890
+ */
891
+ updated_at: string;
892
+
893
+ /**
894
+ * Whether the requesting role can edit the schedule.
895
+ */
896
+ can_edit?: boolean;
897
+
898
+ /**
899
+ * The managers of the schedule.
900
+ *
901
+ * Expandable field
902
+ */
903
+ managers?: Array<WorkersAPI.Worker>;
904
+
905
+ /**
906
+ * The IDs of the managers of the schedule.
907
+ */
908
+ managers_id?: Array<string>;
909
+
910
+ /**
911
+ * The members of the schedule.
912
+ *
913
+ * Expandable field
914
+ */
915
+ members?: Array<WorkersAPI.Worker>;
916
+
917
+ /**
918
+ * The IDs of the members of the schedule.
919
+ */
920
+ members_id?: Array<string>;
921
+
922
+ /**
923
+ * The name of the schedule.
924
+ */
925
+ name?: string;
926
+
927
+ /**
928
+ * The observers of the schedule.
929
+ *
930
+ * Expandable field
931
+ */
932
+ observers?: Array<WorkersAPI.Worker>;
933
+
934
+ /**
935
+ * The IDs of the observers of the schedule.
936
+ */
937
+ observers_id?: Array<string>;
938
+
939
+ /**
940
+ * The settings of the schedule.
941
+ */
942
+ settings?: Schedule.Settings;
943
+ }
944
+
945
+ export namespace Schedule {
946
+ /**
947
+ * The settings of the schedule.
948
+ */
949
+ export interface Settings {
950
+ /**
951
+ * The IANA timezone identifier for the schedule (e.g., 'America/New_York').
952
+ * Accepted values are defined by the tz database, listed here:
953
+ * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
954
+ */
955
+ timezone?: string;
956
+ }
957
+ }
958
+ }
959
+
960
+ export interface ShiftassignmentUpdateResponse {
961
+ /**
962
+ * Identifier field
963
+ */
964
+ id: string;
965
+
966
+ /**
967
+ * Record creation date
968
+ */
969
+ created_at: string;
970
+
971
+ /**
972
+ * Whether the shift assignment is published. If true, the published_version will
973
+ * be the same as the shift_data
974
+ */
975
+ is_published: boolean;
976
+
977
+ /**
978
+ * The ID of the schedule
979
+ */
980
+ schedule_id: string;
981
+
982
+ /**
983
+ * The data of the shift
984
+ */
985
+ shift_data: ShiftassignmentUpdateResponse.ShiftData;
986
+
987
+ /**
988
+ * Record update date
989
+ */
990
+ updated_at: string;
991
+
992
+ /**
993
+ * The ID of the worker
994
+ */
995
+ worker_id: string;
996
+
997
+ /**
998
+ * Whether the shift assignment can be edited
999
+ */
1000
+ can_edit?: boolean;
1001
+
1002
+ /**
1003
+ * The published version of the shift assignment, if it exists. If filled but
1004
+ * is_published is false, the shift_data is the latest version.
1005
+ */
1006
+ published_version?: ShiftassignmentUpdateResponse.PublishedVersion;
1007
+
1008
+ /**
1009
+ * The schedule
1010
+ *
1011
+ * Expandable field
1012
+ */
1013
+ schedule?: ShiftassignmentUpdateResponse.Schedule;
1014
+
1015
+ /**
1016
+ * The worker
1017
+ *
1018
+ * Expandable field
1019
+ */
1020
+ worker?: WorkersAPI.Worker;
1021
+ }
1022
+
1023
+ export namespace ShiftassignmentUpdateResponse {
1024
+ /**
1025
+ * The data of the shift
1026
+ */
1027
+ export interface ShiftData {
1028
+ /**
1029
+ * The end time of the shift
1030
+ */
1031
+ end_time: string;
1032
+
1033
+ /**
1034
+ * The start time of the shift
1035
+ */
1036
+ start_time: string;
1037
+
1038
+ /**
1039
+ * The breaks of the shift
1040
+ */
1041
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
1042
+
1043
+ /**
1044
+ * The segments of the shift
1045
+ */
1046
+ shift_segments?: Array<ShiftData.ShiftSegment>;
1047
+ }
1048
+
1049
+ export namespace ShiftData {
1050
+ export interface ShiftBreak {
1051
+ /**
1052
+ * The duration of the shift break in minutes (input only for creation)
1053
+ */
1054
+ duration_minutes: number;
1055
+
1056
+ /**
1057
+ * The start time of the shift break
1058
+ */
1059
+ start_time: string;
1060
+
1061
+ /**
1062
+ * The type of the shift break
1063
+ */
1064
+ type: 'MEAL' | 'REST';
1065
+
1066
+ /**
1067
+ * The end time of the shift break (calculated from start_time + duration_minutes)
1068
+ */
1069
+ end_time?: string;
1070
+ }
1071
+
1072
+ export interface ShiftSegment {
1073
+ /**
1074
+ * The duration of the shift segment in minutes (input only for creation)
1075
+ */
1076
+ duration_minutes: number;
1077
+
1078
+ /**
1079
+ * The start time of the shift segment
1080
+ */
1081
+ start_time: string;
1082
+
1083
+ /**
1084
+ * The end time of the shift segment (calculated from start_time +
1085
+ * duration_minutes)
1086
+ */
1087
+ end_time?: string;
1088
+
1089
+ /**
1090
+ * The IDs of the job codes associated with the shift segment
1091
+ */
1092
+ job_codes_id?: Array<string>;
1093
+ }
1094
+ }
1095
+
1096
+ /**
1097
+ * The published version of the shift assignment, if it exists. If filled but
1098
+ * is_published is false, the shift_data is the latest version.
1099
+ */
1100
+ export interface PublishedVersion {
1101
+ /**
1102
+ * The end time of the shift
1103
+ */
1104
+ end_time: string;
1105
+
1106
+ /**
1107
+ * The start time of the shift
1108
+ */
1109
+ start_time: string;
1110
+
1111
+ /**
1112
+ * The breaks of the shift
1113
+ */
1114
+ shift_breaks?: Array<PublishedVersion.ShiftBreak>;
1115
+
1116
+ /**
1117
+ * The segments of the shift
1118
+ */
1119
+ shift_segments?: Array<PublishedVersion.ShiftSegment>;
1120
+ }
1121
+
1122
+ export namespace PublishedVersion {
1123
+ export interface ShiftBreak {
1124
+ /**
1125
+ * The duration of the shift break in minutes (input only for creation)
1126
+ */
1127
+ duration_minutes: number;
1128
+
1129
+ /**
1130
+ * The start time of the shift break
1131
+ */
1132
+ start_time: string;
1133
+
1134
+ /**
1135
+ * The type of the shift break
1136
+ */
1137
+ type: 'MEAL' | 'REST';
1138
+
1139
+ /**
1140
+ * The end time of the shift break (calculated from start_time + duration_minutes)
1141
+ */
1142
+ end_time?: string;
1143
+ }
1144
+
1145
+ export interface ShiftSegment {
1146
+ /**
1147
+ * The duration of the shift segment in minutes (input only for creation)
1148
+ */
1149
+ duration_minutes: number;
1150
+
1151
+ /**
1152
+ * The start time of the shift segment
1153
+ */
1154
+ start_time: string;
1155
+
1156
+ /**
1157
+ * The end time of the shift segment (calculated from start_time +
1158
+ * duration_minutes)
1159
+ */
1160
+ end_time?: string;
1161
+
1162
+ /**
1163
+ * The IDs of the job codes associated with the shift segment
1164
+ */
1165
+ job_codes_id?: Array<string>;
1166
+ }
1167
+ }
1168
+
1169
+ /**
1170
+ * The schedule
1171
+ *
1172
+ * Expandable field
1173
+ */
1174
+ export interface Schedule {
1175
+ /**
1176
+ * Identifier field
1177
+ */
1178
+ id: string;
1179
+
1180
+ /**
1181
+ * Record creation date
1182
+ */
1183
+ created_at: string;
1184
+
1185
+ /**
1186
+ * Record update date
1187
+ */
1188
+ updated_at: string;
1189
+
1190
+ /**
1191
+ * Whether the requesting role can edit the schedule.
1192
+ */
1193
+ can_edit?: boolean;
1194
+
1195
+ /**
1196
+ * The managers of the schedule.
1197
+ *
1198
+ * Expandable field
1199
+ */
1200
+ managers?: Array<WorkersAPI.Worker>;
481
1201
 
482
1202
  /**
483
1203
  * The IDs of the managers of the schedule.
@@ -532,7 +1252,42 @@ export namespace ShiftassignmentRetrieveResponse {
532
1252
  timezone?: string;
533
1253
  }
534
1254
  }
1255
+ }
1256
+
1257
+ export interface ShiftassignmentListParams {
1258
+ cursor?: string;
1259
+
1260
+ expand?: string;
1261
+
1262
+ filter?: string;
1263
+
1264
+ order_by?: string;
1265
+ }
1266
+
1267
+ export interface ShiftassignmentCreateParams {
1268
+ /**
1269
+ * Whether the shift assignment is published. If true, the published_version will
1270
+ * be the same as the shift_data
1271
+ */
1272
+ is_published: boolean;
1273
+
1274
+ /**
1275
+ * The ID of the schedule
1276
+ */
1277
+ schedule_id: string;
1278
+
1279
+ /**
1280
+ * The data of the shift
1281
+ */
1282
+ shift_data: ShiftassignmentCreateParams.ShiftData;
1283
+
1284
+ /**
1285
+ * The ID of the worker
1286
+ */
1287
+ worker_id: string;
1288
+ }
535
1289
 
1290
+ export namespace ShiftassignmentCreateParams {
536
1291
  /**
537
1292
  * The data of the shift
538
1293
  */
@@ -543,27 +1298,27 @@ export namespace ShiftassignmentRetrieveResponse {
543
1298
  end_time: string;
544
1299
 
545
1300
  /**
546
- * The breaks of the shift
1301
+ * The start time of the shift
547
1302
  */
548
- shift_breaks: Array<ShiftData.ShiftBreak>;
1303
+ start_time: string;
549
1304
 
550
1305
  /**
551
- * The segments of the shift
1306
+ * The breaks of the shift
552
1307
  */
553
- shift_segments: Array<ShiftData.ShiftSegment>;
1308
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
554
1309
 
555
1310
  /**
556
- * The start time of the shift
1311
+ * The segments of the shift
557
1312
  */
558
- start_time: string;
1313
+ shift_segments?: Array<ShiftData.ShiftSegment>;
559
1314
  }
560
1315
 
561
1316
  export namespace ShiftData {
562
1317
  export interface ShiftBreak {
563
1318
  /**
564
- * The end time of the shift break
1319
+ * The duration of the shift break in minutes (input only for creation)
565
1320
  */
566
- end_time: string;
1321
+ duration_minutes: number;
567
1322
 
568
1323
  /**
569
1324
  * The start time of the shift break
@@ -573,14 +1328,14 @@ export namespace ShiftassignmentRetrieveResponse {
573
1328
  /**
574
1329
  * The type of the shift break
575
1330
  */
576
- type: string;
1331
+ type: 'MEAL' | 'REST';
577
1332
  }
578
1333
 
579
1334
  export interface ShiftSegment {
580
1335
  /**
581
- * The end time of the shift segment
1336
+ * The duration of the shift segment in minutes (input only for creation)
582
1337
  */
583
- end_time: string;
1338
+ duration_minutes: number;
584
1339
 
585
1340
  /**
586
1341
  * The start time of the shift segment
@@ -595,24 +1350,106 @@ export namespace ShiftassignmentRetrieveResponse {
595
1350
  }
596
1351
  }
597
1352
 
598
- export interface ShiftassignmentListParams {
1353
+ export interface ShiftassignmentRetrieveParams {
599
1354
  expand?: string;
1355
+ }
600
1356
 
601
- filter?: string;
1357
+ export interface ShiftassignmentUpdateParams {
1358
+ /**
1359
+ * Whether the shift assignment is published. If true, the published_version will
1360
+ * be the same as the shift_data
1361
+ */
1362
+ is_published: boolean;
602
1363
 
603
- order_by?: string;
1364
+ /**
1365
+ * The ID of the schedule
1366
+ */
1367
+ schedule_id: string;
1368
+
1369
+ /**
1370
+ * The data of the shift
1371
+ */
1372
+ shift_data: ShiftassignmentUpdateParams.ShiftData;
1373
+
1374
+ /**
1375
+ * The ID of the worker
1376
+ */
1377
+ worker_id: string;
604
1378
  }
605
1379
 
606
- export interface ShiftassignmentRetrieveParams {
607
- expand?: string;
1380
+ export namespace ShiftassignmentUpdateParams {
1381
+ /**
1382
+ * The data of the shift
1383
+ */
1384
+ export interface ShiftData {
1385
+ /**
1386
+ * The end time of the shift
1387
+ */
1388
+ end_time: string;
1389
+
1390
+ /**
1391
+ * The start time of the shift
1392
+ */
1393
+ start_time: string;
1394
+
1395
+ /**
1396
+ * The breaks of the shift
1397
+ */
1398
+ shift_breaks?: Array<ShiftData.ShiftBreak>;
1399
+
1400
+ /**
1401
+ * The segments of the shift
1402
+ */
1403
+ shift_segments?: Array<ShiftData.ShiftSegment>;
1404
+ }
1405
+
1406
+ export namespace ShiftData {
1407
+ export interface ShiftBreak {
1408
+ /**
1409
+ * The duration of the shift break in minutes (input only for creation)
1410
+ */
1411
+ duration_minutes: number;
1412
+
1413
+ /**
1414
+ * The start time of the shift break
1415
+ */
1416
+ start_time: string;
1417
+
1418
+ /**
1419
+ * The type of the shift break
1420
+ */
1421
+ type: 'MEAL' | 'REST';
1422
+ }
1423
+
1424
+ export interface ShiftSegment {
1425
+ /**
1426
+ * The duration of the shift segment in minutes (input only for creation)
1427
+ */
1428
+ duration_minutes: number;
1429
+
1430
+ /**
1431
+ * The start time of the shift segment
1432
+ */
1433
+ start_time: string;
1434
+
1435
+ /**
1436
+ * The IDs of the job codes associated with the shift segment
1437
+ */
1438
+ job_codes_id?: Array<string>;
1439
+ }
1440
+ }
608
1441
  }
609
1442
 
610
1443
  export declare namespace Shiftassignments {
611
1444
  export {
612
1445
  type ShiftassignmentListResponse as ShiftassignmentListResponse,
1446
+ type ShiftassignmentCreateResponse as ShiftassignmentCreateResponse,
613
1447
  type ShiftassignmentRetrieveResponse as ShiftassignmentRetrieveResponse,
1448
+ type ShiftassignmentUpdateResponse as ShiftassignmentUpdateResponse,
614
1449
  type ShiftassignmentListResponsesPageCursorURL as ShiftassignmentListResponsesPageCursorURL,
615
1450
  type ShiftassignmentListParams as ShiftassignmentListParams,
1451
+ type ShiftassignmentCreateParams as ShiftassignmentCreateParams,
616
1452
  type ShiftassignmentRetrieveParams as ShiftassignmentRetrieveParams,
1453
+ type ShiftassignmentUpdateParams as ShiftassignmentUpdateParams,
617
1454
  };
618
1455
  }