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

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