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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (229) hide show
  1. package/LICENSE +1 -1
  2. package/client.d.mts +33 -11
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +33 -11
  5. package/client.d.ts.map +1 -1
  6. package/client.js +21 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +21 -0
  9. package/client.mjs.map +1 -1
  10. package/functions.d.mts +7 -0
  11. package/functions.d.mts.map +1 -1
  12. package/functions.d.ts +7 -0
  13. package/functions.d.ts.map +1 -1
  14. package/functions.js +13 -1
  15. package/functions.js.map +1 -1
  16. package/functions.mjs +11 -0
  17. package/functions.mjs.map +1 -1
  18. package/package.json +1 -1
  19. package/resources/compensation-bands-details.d.mts +95 -0
  20. package/resources/compensation-bands-details.d.mts.map +1 -0
  21. package/resources/compensation-bands-details.d.ts +95 -0
  22. package/resources/compensation-bands-details.d.ts.map +1 -0
  23. package/resources/compensation-bands-details.js +29 -0
  24. package/resources/compensation-bands-details.js.map +1 -0
  25. package/resources/compensation-bands-details.mjs +25 -0
  26. package/resources/compensation-bands-details.mjs.map +1 -0
  27. package/resources/custom-settings.d.mts +270 -0
  28. package/resources/custom-settings.d.mts.map +1 -0
  29. package/resources/custom-settings.d.ts +270 -0
  30. package/resources/custom-settings.d.ts.map +1 -0
  31. package/resources/custom-settings.js +51 -0
  32. package/resources/custom-settings.js.map +1 -0
  33. package/resources/custom-settings.mjs +47 -0
  34. package/resources/custom-settings.mjs.map +1 -0
  35. package/resources/departments.d.mts +37 -1
  36. package/resources/departments.d.mts.map +1 -1
  37. package/resources/departments.d.ts +37 -1
  38. package/resources/departments.d.ts.map +1 -1
  39. package/resources/departments.js +12 -0
  40. package/resources/departments.js.map +1 -1
  41. package/resources/departments.mjs +12 -0
  42. package/resources/departments.mjs.map +1 -1
  43. package/resources/draft-hires.d.mts +27 -0
  44. package/resources/draft-hires.d.mts.map +1 -1
  45. package/resources/draft-hires.d.ts +27 -0
  46. package/resources/draft-hires.d.ts.map +1 -1
  47. package/resources/functions/executions.d.mts +6 -82
  48. package/resources/functions/executions.d.mts.map +1 -1
  49. package/resources/functions/executions.d.ts +6 -82
  50. package/resources/functions/executions.d.ts.map +1 -1
  51. package/resources/functions/executions.js.map +1 -1
  52. package/resources/functions/executions.mjs.map +1 -1
  53. package/resources/functions/functions.d.mts +2 -2
  54. package/resources/functions/functions.d.mts.map +1 -1
  55. package/resources/functions/functions.d.ts +2 -2
  56. package/resources/functions/functions.d.ts.map +1 -1
  57. package/resources/functions/functions.js.map +1 -1
  58. package/resources/functions/functions.mjs.map +1 -1
  59. package/resources/functions/index.d.mts +1 -1
  60. package/resources/functions/index.d.mts.map +1 -1
  61. package/resources/functions/index.d.ts +1 -1
  62. package/resources/functions/index.d.ts.map +1 -1
  63. package/resources/functions/index.js.map +1 -1
  64. package/resources/functions/index.mjs.map +1 -1
  65. package/resources/index.d.mts +12 -5
  66. package/resources/index.d.mts.map +1 -1
  67. package/resources/index.d.ts +12 -5
  68. package/resources/index.d.ts.map +1 -1
  69. package/resources/index.js +15 -1
  70. package/resources/index.js.map +1 -1
  71. package/resources/index.mjs +7 -0
  72. package/resources/index.mjs.map +1 -1
  73. package/resources/job-assignments.d.mts +70 -6
  74. package/resources/job-assignments.d.mts.map +1 -1
  75. package/resources/job-assignments.d.ts +70 -6
  76. package/resources/job-assignments.d.ts.map +1 -1
  77. package/resources/job-assignments.js +22 -0
  78. package/resources/job-assignments.js.map +1 -1
  79. package/resources/job-assignments.mjs +22 -0
  80. package/resources/job-assignments.mjs.map +1 -1
  81. package/resources/job-codes.d.mts +47 -1
  82. package/resources/job-codes.d.mts.map +1 -1
  83. package/resources/job-codes.d.ts +47 -1
  84. package/resources/job-codes.d.ts.map +1 -1
  85. package/resources/job-dimensions.d.mts +20 -0
  86. package/resources/job-dimensions.d.mts.map +1 -1
  87. package/resources/job-dimensions.d.ts +20 -0
  88. package/resources/job-dimensions.d.ts.map +1 -1
  89. package/resources/job-requisitions-write.d.mts +257 -0
  90. package/resources/job-requisitions-write.d.mts.map +1 -0
  91. package/resources/job-requisitions-write.d.ts +257 -0
  92. package/resources/job-requisitions-write.d.ts.map +1 -0
  93. package/resources/job-requisitions-write.js +15 -0
  94. package/resources/job-requisitions-write.js.map +1 -0
  95. package/resources/job-requisitions-write.mjs +11 -0
  96. package/resources/job-requisitions-write.mjs.map +1 -0
  97. package/resources/leave-accruals.d.mts +112 -6
  98. package/resources/leave-accruals.d.mts.map +1 -1
  99. package/resources/leave-accruals.d.ts +112 -6
  100. package/resources/leave-accruals.d.ts.map +1 -1
  101. package/resources/leave-accruals.js +19 -3
  102. package/resources/leave-accruals.js.map +1 -1
  103. package/resources/leave-accruals.mjs +19 -3
  104. package/resources/leave-accruals.mjs.map +1 -1
  105. package/resources/report-runs.d.mts +149 -0
  106. package/resources/report-runs.d.mts.map +1 -0
  107. package/resources/report-runs.d.ts +149 -0
  108. package/resources/report-runs.d.ts.map +1 -0
  109. package/resources/report-runs.js +22 -0
  110. package/resources/report-runs.js.map +1 -0
  111. package/resources/report-runs.mjs +18 -0
  112. package/resources/report-runs.mjs.map +1 -0
  113. package/resources/shared.d.mts +35 -0
  114. package/resources/shared.d.mts.map +1 -1
  115. package/resources/shared.d.ts +35 -0
  116. package/resources/shared.d.ts.map +1 -1
  117. package/resources/shift-assignments.d.mts +296 -0
  118. package/resources/shift-assignments.d.mts.map +1 -0
  119. package/resources/shift-assignments.d.ts +296 -0
  120. package/resources/shift-assignments.d.ts.map +1 -0
  121. package/resources/shift-assignments.js +25 -0
  122. package/resources/shift-assignments.js.map +1 -0
  123. package/resources/shift-assignments.mjs +21 -0
  124. package/resources/shift-assignments.mjs.map +1 -0
  125. package/resources/shiftassignments.d.mts +68 -10
  126. package/resources/shiftassignments.d.mts.map +1 -1
  127. package/resources/shiftassignments.d.ts +68 -10
  128. package/resources/shiftassignments.d.ts.map +1 -1
  129. package/resources/supergroups/exclusion-members.d.mts +5 -3
  130. package/resources/supergroups/exclusion-members.d.mts.map +1 -1
  131. package/resources/supergroups/exclusion-members.d.ts +5 -3
  132. package/resources/supergroups/exclusion-members.d.ts.map +1 -1
  133. package/resources/supergroups/exclusion-members.js +1 -0
  134. package/resources/supergroups/exclusion-members.js.map +1 -1
  135. package/resources/supergroups/exclusion-members.mjs +1 -0
  136. package/resources/supergroups/exclusion-members.mjs.map +1 -1
  137. package/resources/supergroups/inclusion-members.d.mts +5 -3
  138. package/resources/supergroups/inclusion-members.d.mts.map +1 -1
  139. package/resources/supergroups/inclusion-members.d.ts +5 -3
  140. package/resources/supergroups/inclusion-members.d.ts.map +1 -1
  141. package/resources/supergroups/inclusion-members.js +1 -0
  142. package/resources/supergroups/inclusion-members.js.map +1 -1
  143. package/resources/supergroups/inclusion-members.mjs +1 -0
  144. package/resources/supergroups/inclusion-members.mjs.map +1 -1
  145. package/resources/supergroups/index.d.mts +1 -1
  146. package/resources/supergroups/index.d.mts.map +1 -1
  147. package/resources/supergroups/index.d.ts +1 -1
  148. package/resources/supergroups/index.d.ts.map +1 -1
  149. package/resources/supergroups/index.js.map +1 -1
  150. package/resources/supergroups/index.mjs.map +1 -1
  151. package/resources/supergroups/members.d.mts +8 -26
  152. package/resources/supergroups/members.d.mts.map +1 -1
  153. package/resources/supergroups/members.d.ts +8 -26
  154. package/resources/supergroups/members.d.ts.map +1 -1
  155. package/resources/supergroups/members.js +1 -0
  156. package/resources/supergroups/members.js.map +1 -1
  157. package/resources/supergroups/members.mjs +1 -0
  158. package/resources/supergroups/members.mjs.map +1 -1
  159. package/resources/supergroups/supergroups.d.mts +2 -2
  160. package/resources/supergroups/supergroups.d.mts.map +1 -1
  161. package/resources/supergroups/supergroups.d.ts +2 -2
  162. package/resources/supergroups/supergroups.d.ts.map +1 -1
  163. package/resources/supergroups/supergroups.js.map +1 -1
  164. package/resources/supergroups/supergroups.mjs.map +1 -1
  165. package/resources/titles.d.mts +126 -0
  166. package/resources/titles.d.mts.map +1 -0
  167. package/resources/titles.d.ts +126 -0
  168. package/resources/titles.d.ts.map +1 -0
  169. package/resources/titles.js +48 -0
  170. package/resources/titles.js.map +1 -0
  171. package/resources/titles.mjs +44 -0
  172. package/resources/titles.mjs.map +1 -0
  173. package/resources/unassigned-shifts.d.mts +334 -0
  174. package/resources/unassigned-shifts.d.mts.map +1 -0
  175. package/resources/unassigned-shifts.d.ts +334 -0
  176. package/resources/unassigned-shifts.d.ts.map +1 -0
  177. package/resources/unassigned-shifts.js +42 -0
  178. package/resources/unassigned-shifts.js.map +1 -0
  179. package/resources/unassigned-shifts.mjs +38 -0
  180. package/resources/unassigned-shifts.mjs.map +1 -0
  181. package/resources/unassignedshifts.d.mts +744 -32
  182. package/resources/unassignedshifts.d.mts.map +1 -1
  183. package/resources/unassignedshifts.d.ts +744 -32
  184. package/resources/unassignedshifts.d.ts.map +1 -1
  185. package/resources/unassignedshifts.js +12 -0
  186. package/resources/unassignedshifts.js.map +1 -1
  187. package/resources/unassignedshifts.mjs +12 -0
  188. package/resources/unassignedshifts.mjs.map +1 -1
  189. package/resources/work-locations.d.mts +95 -1
  190. package/resources/work-locations.d.mts.map +1 -1
  191. package/resources/work-locations.d.ts +95 -1
  192. package/resources/work-locations.d.ts.map +1 -1
  193. package/resources/work-locations.js +12 -0
  194. package/resources/work-locations.js.map +1 -1
  195. package/resources/work-locations.mjs +12 -0
  196. package/resources/work-locations.mjs.map +1 -1
  197. package/src/client.ts +157 -3
  198. package/src/functions.ts +20 -0
  199. package/src/resources/compensation-bands-details.ts +140 -0
  200. package/src/resources/custom-settings.ts +371 -0
  201. package/src/resources/departments.ts +50 -0
  202. package/src/resources/draft-hires.ts +32 -0
  203. package/src/resources/functions/executions.ts +8 -104
  204. package/src/resources/functions/functions.ts +4 -8
  205. package/src/resources/functions/index.ts +2 -4
  206. package/src/resources/index.ts +68 -2
  207. package/src/resources/job-assignments.ts +95 -6
  208. package/src/resources/job-codes.ts +56 -1
  209. package/src/resources/job-dimensions.ts +24 -0
  210. package/src/resources/job-requisitions-write.ts +327 -0
  211. package/src/resources/leave-accruals.ts +229 -12
  212. package/src/resources/report-runs.ts +186 -0
  213. package/src/resources/shared.ts +44 -0
  214. package/src/resources/shift-assignments.ts +362 -0
  215. package/src/resources/shiftassignments.ts +82 -11
  216. package/src/resources/supergroups/exclusion-members.ts +7 -4
  217. package/src/resources/supergroups/inclusion-members.ts +7 -4
  218. package/src/resources/supergroups/index.ts +1 -1
  219. package/src/resources/supergroups/members.ts +10 -36
  220. package/src/resources/supergroups/supergroups.ts +2 -7
  221. package/src/resources/titles.ts +181 -0
  222. package/src/resources/unassigned-shifts.ts +415 -0
  223. package/src/resources/unassignedshifts.ts +905 -35
  224. package/src/resources/work-locations.ts +118 -0
  225. package/src/version.ts +1 -1
  226. package/version.d.mts +1 -1
  227. package/version.d.ts +1 -1
  228. package/version.js +1 -1
  229. package/version.mjs +1 -1
@@ -33,6 +33,14 @@ export {
33
33
  type CandidateListResponsesPageCursorURL,
34
34
  } from './candidates';
35
35
  export { Companies, type Company, type CompanyListParams, type CompaniesPageCursorURL } from './companies';
36
+ export {
37
+ CompensationBandsDetails,
38
+ type CompensationBandsDetailListResponse,
39
+ type CompensationBandsDetailRetrieveResponse,
40
+ type CompensationBandsDetailListParams,
41
+ type CompensationBandsDetailRetrieveParams,
42
+ type CompensationBandsDetailListResponsesPageCursorURL,
43
+ } from './compensation-bands-details';
36
44
  export {
37
45
  Compensations,
38
46
  type Compensation,
@@ -54,12 +62,25 @@ export {
54
62
  type CustomObjectUpdateParams,
55
63
  type CustomObjectsPageCursorURL,
56
64
  } from './custom-objects/custom-objects';
65
+ export {
66
+ CustomSettings,
67
+ type CustomSettingListResponse,
68
+ type CustomSettingCreateResponse,
69
+ type CustomSettingRetrieveResponse,
70
+ type CustomSettingUpdateResponse,
71
+ type CustomSettingListParams,
72
+ type CustomSettingCreateParams,
73
+ type CustomSettingUpdateParams,
74
+ type CustomSettingListResponsesPageCursorURL,
75
+ } from './custom-settings';
57
76
  export {
58
77
  Departments,
59
78
  type Department,
60
79
  type DepartmentRetrieveResponse,
61
80
  type DepartmentListParams,
81
+ type DepartmentCreateParams,
62
82
  type DepartmentRetrieveParams,
83
+ type DepartmentUpdateParams,
63
84
  type DepartmentsPageCursorURL,
64
85
  } from './departments';
65
86
  export { DraftHires, type DraftHireCreateResponse, type DraftHireCreateParams } from './draft-hires';
@@ -105,7 +126,9 @@ export {
105
126
  type JobAssignment,
106
127
  type JobAssignmentRetrieveResponse,
107
128
  type JobAssignmentListParams,
129
+ type JobAssignmentCreateParams,
108
130
  type JobAssignmentRetrieveParams,
131
+ type JobAssignmentUpdateParams,
109
132
  type JobAssignmentListChangeLogParams,
110
133
  type AttributeChangeDetailsPageCursorURL,
111
134
  type JobAssignmentsPageCursorURL,
@@ -154,6 +177,11 @@ export {
154
177
  type JobRequisitionListParams,
155
178
  type JobRequisitionsPageCursorURL,
156
179
  } from './job-requisitions';
180
+ export {
181
+ JobRequisitionsWrite,
182
+ type JobRequisitionsWriteCreateResponse,
183
+ type JobRequisitionsWriteCreateParams,
184
+ } from './job-requisitions-write';
157
185
  export {
158
186
  KioskBadges,
159
187
  type TimeKioskBadge,
@@ -169,10 +197,13 @@ export {
169
197
  } from './kiosk-badges';
170
198
  export {
171
199
  LeaveAccruals,
172
- type LeaveAccrualRetrieveResponse,
200
+ type LeaveAccrualListResponse,
173
201
  type LeaveAccrualCreateResponse,
174
- type LeaveAccrualRetrieveParams,
202
+ type LeaveAccrualRetrieveResponse,
203
+ type LeaveAccrualListParams,
175
204
  type LeaveAccrualCreateParams,
205
+ type LeaveAccrualRetrieveParams,
206
+ type LeaveAccrualListResponsesPageCursorURL,
176
207
  } from './leave-accruals';
177
208
  export {
178
209
  LeaveBalances,
@@ -232,6 +263,12 @@ export {
232
263
  type ObjectCategoryUpdateParams,
233
264
  type ObjectCategoriesPageCursorURL,
234
265
  } from './object-categories';
266
+ export {
267
+ ReportRuns,
268
+ type ReportRunCreateResponse,
269
+ type ReportRunRetrieveResponse,
270
+ type ReportRunCreateParams,
271
+ } from './report-runs';
235
272
  export { SSOMeResource, type SSOMe, type SSOMeRetrieveParams } from './sso-me';
236
273
  export {
237
274
  Schedules,
@@ -245,6 +282,11 @@ export {
245
282
  type ScheduleUpdateParams,
246
283
  type ScheduleListResponsesPageCursorURL,
247
284
  } from './schedules';
285
+ export {
286
+ ShiftAssignments,
287
+ type ShiftAssignmentUpdateCustomfieldsResponse,
288
+ type ShiftAssignmentUpdateCustomfieldsParams,
289
+ } from './shift-assignments';
248
290
  export {
249
291
  ShiftInputs,
250
292
  type ShiftInput,
@@ -307,6 +349,17 @@ export {
307
349
  type TimeEntryUpdateParams,
308
350
  type TimeEntryListResponsesPageCursorURL,
309
351
  } from './time-entries';
352
+ export {
353
+ Titles,
354
+ type TitleListResponse,
355
+ type TitleCreateResponse,
356
+ type TitleRetrieveResponse,
357
+ type TitleUpdateResponse,
358
+ type TitleListParams,
359
+ type TitleCreateParams,
360
+ type TitleUpdateParams,
361
+ type TitleListResponsesPageCursorURL,
362
+ } from './titles';
310
363
  export {
311
364
  Tracks,
312
365
  type Track,
@@ -314,12 +367,23 @@ export {
314
367
  type TrackListParams,
315
368
  type TracksPageCursorURL,
316
369
  } from './tracks';
370
+ export {
371
+ UnassignedShifts,
372
+ type UnassignedShiftUpdateCustomfieldsResponse,
373
+ type UnassignedShiftAssignResponse,
374
+ type UnassignedShiftUpdateCustomfieldsParams,
375
+ type UnassignedShiftAssignParams,
376
+ } from './unassigned-shifts';
317
377
  export {
318
378
  Unassignedshifts,
319
379
  type UnassignedshiftListResponse,
380
+ type UnassignedshiftCreateResponse,
320
381
  type UnassignedshiftRetrieveResponse,
382
+ type UnassignedshiftUpdateResponse,
321
383
  type UnassignedshiftListParams,
384
+ type UnassignedshiftCreateParams,
322
385
  type UnassignedshiftRetrieveParams,
386
+ type UnassignedshiftUpdateParams,
323
387
  type UnassignedshiftListResponsesPageCursorURL,
324
388
  } from './unassignedshifts';
325
389
  export {
@@ -334,6 +398,8 @@ export {
334
398
  type WorkLocation,
335
399
  type WorkLocationRetrieveResponse,
336
400
  type WorkLocationListParams,
401
+ type WorkLocationCreateParams,
402
+ type WorkLocationUpdateParams,
337
403
  type WorkLocationsPageCursorURL,
338
404
  } from './work-locations';
339
405
  export {
@@ -7,6 +7,7 @@ import * as JobPayRateExceptionsAPI from './job-pay-rate-exceptions';
7
7
  import * as WorkersAPI from './workers';
8
8
  import { APIPromise } from '../core/api-promise';
9
9
  import { PageCursorURL, PagePromise } from '../core/pagination';
10
+ import { buildHeaders } from '../internal/headers';
10
11
  import { RequestOptions } from '../internal/request-options';
11
12
  import { path } from '../internal/utils/path';
12
13
 
@@ -26,6 +27,13 @@ export class JobAssignments extends APIResource {
26
27
  return this._client.getAPIList('/job-assignments', PageCursorURL<JobAssignment>, { query, ...options });
27
28
  }
28
29
 
30
+ /**
31
+ * Create a new job assignment
32
+ */
33
+ create(body: JobAssignmentCreateParams, options?: RequestOptions): APIPromise<JobAssignment> {
34
+ return this._client.post('/job-assignments', { body, ...options });
35
+ }
36
+
29
37
  /**
30
38
  * Retrieve a specific job assignment
31
39
  */
@@ -37,6 +45,23 @@ export class JobAssignments extends APIResource {
37
45
  return this._client.get(path`/job-assignments/${id}`, { query, ...options });
38
46
  }
39
47
 
48
+ /**
49
+ * Updated a specific job assignment
50
+ */
51
+ update(id: string, body: JobAssignmentUpdateParams, options?: RequestOptions): APIPromise<JobAssignment> {
52
+ return this._client.patch(path`/job-assignments/${id}`, { body, ...options });
53
+ }
54
+
55
+ /**
56
+ * Delete a job assignment
57
+ */
58
+ delete(id: string, options?: RequestOptions): APIPromise<void> {
59
+ return this._client.delete(path`/job-assignments/${id}`, {
60
+ ...options,
61
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
62
+ });
63
+ }
64
+
40
65
  /**
41
66
  * A List of attribute change logs
42
67
  *
@@ -140,12 +165,6 @@ export interface JobAssignment {
140
165
  */
141
166
  job_code_id: string;
142
167
 
143
- /**
144
- * The pay rate for job assigned to worker. This can be different from the job's
145
- * standard pay rate and can be overriden for a worker.
146
- */
147
- job_pay_rate: number;
148
-
149
168
  /**
150
169
  * Record update date
151
170
  */
@@ -168,6 +187,12 @@ export interface JobAssignment {
168
187
  */
169
188
  job_code?: JobCodesAPI.JobCode;
170
189
 
190
+ /**
191
+ * The pay rate for job assigned to worker. This can be different from the job's
192
+ * standard pay rate and can be overriden for a worker.
193
+ */
194
+ job_pay_rate?: number;
195
+
171
196
  /**
172
197
  * Pay rate exceptions applicable for the worker based on certain exception
173
198
  * dimension values.
@@ -205,10 +230,72 @@ export interface JobAssignmentListParams {
205
230
  order_by?: string;
206
231
  }
207
232
 
233
+ export interface JobAssignmentCreateParams {
234
+ /**
235
+ * Identifier of job that is assigned to worker
236
+ */
237
+ job_code_id: string;
238
+
239
+ /**
240
+ * Identifier of worker to whom job is assigned.
241
+ */
242
+ worker_id: string;
243
+
244
+ /**
245
+ * The pay rate for job assigned to worker. This can be different from the job's
246
+ * standard pay rate and can be overriden for a worker.
247
+ */
248
+ job_pay_rate?: number;
249
+
250
+ /**
251
+ * Reason for setting, updating, or resetting the pay rate for the job assigned to
252
+ * the worker.
253
+ */
254
+ job_pay_rate_change_reason?: string;
255
+
256
+ /**
257
+ * Date and time the pay rate becomes effective (ISO 8601 format
258
+ * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
259
+ * current time in UTC if not provided.
260
+ */
261
+ job_pay_rate_effective_from?: string;
262
+ }
263
+
208
264
  export interface JobAssignmentRetrieveParams {
209
265
  expand?: string;
210
266
  }
211
267
 
268
+ export interface JobAssignmentUpdateParams {
269
+ /**
270
+ * Identifier of job that is assigned to worker
271
+ */
272
+ job_code_id: string;
273
+
274
+ /**
275
+ * Identifier of worker to whom job is assigned.
276
+ */
277
+ worker_id: string;
278
+
279
+ /**
280
+ * The pay rate for job assigned to worker. This can be different from the job's
281
+ * standard pay rate and can be overriden for a worker.
282
+ */
283
+ job_pay_rate?: number;
284
+
285
+ /**
286
+ * Reason for setting, updating, or resetting the pay rate for the job assigned to
287
+ * the worker.
288
+ */
289
+ job_pay_rate_change_reason?: string;
290
+
291
+ /**
292
+ * Date and time the pay rate becomes effective (ISO 8601 format
293
+ * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
294
+ * current time in UTC if not provided.
295
+ */
296
+ job_pay_rate_effective_from?: string;
297
+ }
298
+
212
299
  export interface JobAssignmentListChangeLogParams {
213
300
  cursor?: string;
214
301
 
@@ -225,7 +312,9 @@ export declare namespace JobAssignments {
225
312
  type JobAssignmentsPageCursorURL as JobAssignmentsPageCursorURL,
226
313
  type AttributeChangeDetailsPageCursorURL as AttributeChangeDetailsPageCursorURL,
227
314
  type JobAssignmentListParams as JobAssignmentListParams,
315
+ type JobAssignmentCreateParams as JobAssignmentCreateParams,
228
316
  type JobAssignmentRetrieveParams as JobAssignmentRetrieveParams,
317
+ type JobAssignmentUpdateParams as JobAssignmentUpdateParams,
229
318
  type JobAssignmentListChangeLogParams as JobAssignmentListChangeLogParams,
230
319
  };
231
320
  }
@@ -152,7 +152,8 @@ export interface JobCode {
152
152
  job_dimension?: JobDimensionsAPI.JobDimension;
153
153
 
154
154
  /**
155
- * The pay rate for job, if job code is associated with pay rate.
155
+ * The pay rate for this job code. Only applicable if the associated job dimension
156
+ * includes the 'PAY_RATE' organizational attribute.
156
157
  */
157
158
  pay_rate?: number;
158
159
 
@@ -217,6 +218,24 @@ export interface JobCodeRequest {
217
218
  * The unique identifier of the job code in an outside system.
218
219
  */
219
220
  external_id?: string;
221
+
222
+ /**
223
+ * The pay rate for this job code. Only applicable if the associated job dimension
224
+ * includes the 'PAY_RATE' organizational attribute.
225
+ */
226
+ pay_rate?: number;
227
+
228
+ /**
229
+ * Reason for setting, updating, or resetting the pay rate on this job code.
230
+ */
231
+ pay_rate_change_reason?: string;
232
+
233
+ /**
234
+ * Date and time the pay rate becomes effective (ISO 8601 format
235
+ * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
236
+ * current time in UTC if not provided.
237
+ */
238
+ pay_rate_effective_from?: string;
220
239
  }
221
240
 
222
241
  export namespace JobCodeRequest {
@@ -309,6 +328,24 @@ export interface JobCodeCreateParams {
309
328
  * The unique identifier of the job code in an outside system.
310
329
  */
311
330
  external_id?: string;
331
+
332
+ /**
333
+ * The pay rate for this job code. Only applicable if the associated job dimension
334
+ * includes the 'PAY_RATE' organizational attribute.
335
+ */
336
+ pay_rate?: number;
337
+
338
+ /**
339
+ * Reason for setting, updating, or resetting the pay rate on this job code.
340
+ */
341
+ pay_rate_change_reason?: string;
342
+
343
+ /**
344
+ * Date and time the pay rate becomes effective (ISO 8601 format
345
+ * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
346
+ * current time in UTC if not provided.
347
+ */
348
+ pay_rate_effective_from?: string;
312
349
  }
313
350
 
314
351
  export namespace JobCodeCreateParams {
@@ -390,6 +427,24 @@ export interface JobCodeUpdateParams {
390
427
  * The unique identifier of the job code in an outside system.
391
428
  */
392
429
  external_id?: string;
430
+
431
+ /**
432
+ * The pay rate for this job code. Only applicable if the associated job dimension
433
+ * includes the 'PAY_RATE' organizational attribute.
434
+ */
435
+ pay_rate?: number;
436
+
437
+ /**
438
+ * Reason for setting, updating, or resetting the pay rate on this job code.
439
+ */
440
+ pay_rate_change_reason?: string;
441
+
442
+ /**
443
+ * Date and time the pay rate becomes effective (ISO 8601 format
444
+ * YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to
445
+ * current time in UTC if not provided.
446
+ */
447
+ pay_rate_effective_from?: string;
393
448
  }
394
449
 
395
450
  export namespace JobCodeUpdateParams {
@@ -94,6 +94,12 @@ export interface JobDimension {
94
94
  */
95
95
  includes_custom_location?: boolean;
96
96
 
97
+ /**
98
+ * Organizational attributes associated with the job dimension. Only 'PAY_RATE' can
99
+ * be set or modified using POST or PATCH requests.
100
+ */
101
+ org_attribute_associations?: Array<'DEPARTMENT' | 'WORK_LOCATION' | 'PAY_RATE' | 'ENTITY'>;
102
+
97
103
  /**
98
104
  * The roster type of the dimension. PER_DIMENSION means that there is a group on
99
105
  * the dimension level and employees within that group have access to all job codes
@@ -119,6 +125,12 @@ export interface JobDimensionRequest {
119
125
  */
120
126
  includes_custom_location?: boolean;
121
127
 
128
+ /**
129
+ * Organizational attributes associated with the job dimension. Only 'PAY_RATE' can
130
+ * be set or modified using POST or PATCH requests.
131
+ */
132
+ org_attribute_associations?: Array<'DEPARTMENT' | 'WORK_LOCATION' | 'PAY_RATE' | 'ENTITY'>;
133
+
122
134
  /**
123
135
  * The roster type of the dimension. PER_DIMENSION means that there is a group on
124
136
  * the dimension level and employees within that group have access to all job codes
@@ -157,6 +169,12 @@ export interface JobDimensionCreateParams {
157
169
  */
158
170
  includes_custom_location?: boolean;
159
171
 
172
+ /**
173
+ * Organizational attributes associated with the job dimension. Only 'PAY_RATE' can
174
+ * be set or modified using POST or PATCH requests.
175
+ */
176
+ org_attribute_associations?: Array<'DEPARTMENT' | 'WORK_LOCATION' | 'PAY_RATE' | 'ENTITY'>;
177
+
160
178
  /**
161
179
  * The roster type of the dimension. PER_DIMENSION means that there is a group on
162
180
  * the dimension level and employees within that group have access to all job codes
@@ -182,6 +200,12 @@ export interface JobDimensionUpdateParams {
182
200
  */
183
201
  includes_custom_location?: boolean;
184
202
 
203
+ /**
204
+ * Organizational attributes associated with the job dimension. Only 'PAY_RATE' can
205
+ * be set or modified using POST or PATCH requests.
206
+ */
207
+ org_attribute_associations?: Array<'DEPARTMENT' | 'WORK_LOCATION' | 'PAY_RATE' | 'ENTITY'>;
208
+
185
209
  /**
186
210
  * The roster type of the dimension. PER_DIMENSION means that there is a group on
187
211
  * the dimension level and employees within that group have access to all job codes