@rippling/rippling-sdk 0.2.0-alpha.27 → 0.2.0-alpha.28

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 (336) hide show
  1. package/client.d.mts +2 -2
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +2 -2
  4. package/client.d.ts.map +1 -1
  5. package/client.js.map +1 -1
  6. package/client.mjs.map +1 -1
  7. package/package.json +1 -1
  8. package/resources/business-partner-groups.js +4 -4
  9. package/resources/business-partner-groups.js.map +1 -1
  10. package/resources/business-partner-groups.mjs +4 -4
  11. package/resources/business-partner-groups.mjs.map +1 -1
  12. package/resources/business-partners.js +4 -4
  13. package/resources/business-partners.js.map +1 -1
  14. package/resources/business-partners.mjs +4 -4
  15. package/resources/business-partners.mjs.map +1 -1
  16. package/resources/candidate-applications.js +1 -1
  17. package/resources/candidate-applications.js.map +1 -1
  18. package/resources/candidate-applications.mjs +1 -1
  19. package/resources/candidate-applications.mjs.map +1 -1
  20. package/resources/candidates.js +1 -1
  21. package/resources/candidates.js.map +1 -1
  22. package/resources/candidates.mjs +1 -1
  23. package/resources/candidates.mjs.map +1 -1
  24. package/resources/companies.js +1 -1
  25. package/resources/companies.js.map +1 -1
  26. package/resources/companies.mjs +1 -1
  27. package/resources/companies.mjs.map +1 -1
  28. package/resources/compensation-bands-details.js +2 -2
  29. package/resources/compensation-bands-details.js.map +1 -1
  30. package/resources/compensation-bands-details.mjs +2 -2
  31. package/resources/compensation-bands-details.mjs.map +1 -1
  32. package/resources/compensations.js +2 -2
  33. package/resources/compensations.js.map +1 -1
  34. package/resources/compensations.mjs +2 -2
  35. package/resources/compensations.mjs.map +1 -1
  36. package/resources/create-app-notification.js +1 -1
  37. package/resources/create-app-notification.js.map +1 -1
  38. package/resources/create-app-notification.mjs +1 -1
  39. package/resources/create-app-notification.mjs.map +1 -1
  40. package/resources/custom-apps.d.mts +84 -4
  41. package/resources/custom-apps.d.mts.map +1 -1
  42. package/resources/custom-apps.d.ts +84 -4
  43. package/resources/custom-apps.d.ts.map +1 -1
  44. package/resources/custom-apps.js +5 -5
  45. package/resources/custom-apps.js.map +1 -1
  46. package/resources/custom-apps.mjs +5 -5
  47. package/resources/custom-apps.mjs.map +1 -1
  48. package/resources/custom-fields.js +1 -1
  49. package/resources/custom-fields.js.map +1 -1
  50. package/resources/custom-fields.mjs +1 -1
  51. package/resources/custom-fields.mjs.map +1 -1
  52. package/resources/custom-pages.d.mts +40 -64
  53. package/resources/custom-pages.d.mts.map +1 -1
  54. package/resources/custom-pages.d.ts +40 -64
  55. package/resources/custom-pages.d.ts.map +1 -1
  56. package/resources/custom-pages.js +5 -5
  57. package/resources/custom-pages.js.map +1 -1
  58. package/resources/custom-pages.mjs +5 -5
  59. package/resources/custom-pages.mjs.map +1 -1
  60. package/resources/custom-settings.js +5 -5
  61. package/resources/custom-settings.js.map +1 -1
  62. package/resources/custom-settings.mjs +5 -5
  63. package/resources/custom-settings.mjs.map +1 -1
  64. package/resources/departments.js +4 -4
  65. package/resources/departments.js.map +1 -1
  66. package/resources/departments.mjs +4 -4
  67. package/resources/departments.mjs.map +1 -1
  68. package/resources/employment-types.js +2 -2
  69. package/resources/employment-types.js.map +1 -1
  70. package/resources/employment-types.mjs +2 -2
  71. package/resources/employment-types.mjs.map +1 -1
  72. package/resources/entitlements.js +1 -1
  73. package/resources/entitlements.js.map +1 -1
  74. package/resources/entitlements.mjs +1 -1
  75. package/resources/entitlements.mjs.map +1 -1
  76. package/resources/headcount-positions.js +2 -2
  77. package/resources/headcount-positions.js.map +1 -1
  78. package/resources/headcount-positions.mjs +2 -2
  79. package/resources/headcount-positions.mjs.map +1 -1
  80. package/resources/headcount-priorities.js +2 -2
  81. package/resources/headcount-priorities.js.map +1 -1
  82. package/resources/headcount-priorities.mjs +2 -2
  83. package/resources/headcount-priorities.mjs.map +1 -1
  84. package/resources/index.d.mts +1 -1
  85. package/resources/index.d.mts.map +1 -1
  86. package/resources/index.d.ts +1 -1
  87. package/resources/index.d.ts.map +1 -1
  88. package/resources/index.js.map +1 -1
  89. package/resources/index.mjs.map +1 -1
  90. package/resources/job-assignments.js +6 -6
  91. package/resources/job-assignments.js.map +1 -1
  92. package/resources/job-assignments.mjs +6 -6
  93. package/resources/job-assignments.mjs.map +1 -1
  94. package/resources/job-codes.js +6 -6
  95. package/resources/job-codes.js.map +1 -1
  96. package/resources/job-codes.mjs +6 -6
  97. package/resources/job-codes.mjs.map +1 -1
  98. package/resources/job-dimensions.js +5 -5
  99. package/resources/job-dimensions.js.map +1 -1
  100. package/resources/job-dimensions.mjs +5 -5
  101. package/resources/job-dimensions.mjs.map +1 -1
  102. package/resources/job-functions.js +2 -2
  103. package/resources/job-functions.js.map +1 -1
  104. package/resources/job-functions.mjs +2 -2
  105. package/resources/job-functions.mjs.map +1 -1
  106. package/resources/job-pay-rate-exceptions.js +3 -3
  107. package/resources/job-pay-rate-exceptions.js.map +1 -1
  108. package/resources/job-pay-rate-exceptions.mjs +3 -3
  109. package/resources/job-pay-rate-exceptions.mjs.map +1 -1
  110. package/resources/job-requisitions-write.js +1 -1
  111. package/resources/job-requisitions-write.js.map +1 -1
  112. package/resources/job-requisitions-write.mjs +1 -1
  113. package/resources/job-requisitions-write.mjs.map +1 -1
  114. package/resources/job-requisitions.d.mts.map +1 -1
  115. package/resources/job-requisitions.d.ts.map +1 -1
  116. package/resources/job-requisitions.js +4 -1
  117. package/resources/job-requisitions.js.map +1 -1
  118. package/resources/job-requisitions.mjs +4 -1
  119. package/resources/job-requisitions.mjs.map +1 -1
  120. package/resources/kiosk-badges.js +5 -5
  121. package/resources/kiosk-badges.js.map +1 -1
  122. package/resources/kiosk-badges.mjs +5 -5
  123. package/resources/kiosk-badges.mjs.map +1 -1
  124. package/resources/leave-accruals.js +3 -3
  125. package/resources/leave-accruals.js.map +1 -1
  126. package/resources/leave-accruals.mjs +3 -3
  127. package/resources/leave-accruals.mjs.map +1 -1
  128. package/resources/leave-balances.js +2 -2
  129. package/resources/leave-balances.js.map +1 -1
  130. package/resources/leave-balances.mjs +2 -2
  131. package/resources/leave-balances.mjs.map +1 -1
  132. package/resources/leave-requests.js +4 -4
  133. package/resources/leave-requests.js.map +1 -1
  134. package/resources/leave-requests.mjs +4 -4
  135. package/resources/leave-requests.mjs.map +1 -1
  136. package/resources/leave-types.js +2 -2
  137. package/resources/leave-types.js.map +1 -1
  138. package/resources/leave-types.mjs +2 -2
  139. package/resources/leave-types.mjs.map +1 -1
  140. package/resources/legal-entities.js +2 -2
  141. package/resources/legal-entities.js.map +1 -1
  142. package/resources/legal-entities.mjs +2 -2
  143. package/resources/legal-entities.mjs.map +1 -1
  144. package/resources/levels.js +2 -2
  145. package/resources/levels.js.map +1 -1
  146. package/resources/levels.mjs +2 -2
  147. package/resources/levels.mjs.map +1 -1
  148. package/resources/location-factors.js +2 -2
  149. package/resources/location-factors.js.map +1 -1
  150. package/resources/location-factors.mjs +2 -2
  151. package/resources/location-factors.mjs.map +1 -1
  152. package/resources/metadata/components.js +1 -1
  153. package/resources/metadata/components.js.map +1 -1
  154. package/resources/metadata/components.mjs +1 -1
  155. package/resources/metadata/components.mjs.map +1 -1
  156. package/resources/metadata/metadata.js +1 -1
  157. package/resources/metadata/metadata.js.map +1 -1
  158. package/resources/metadata/metadata.mjs +1 -1
  159. package/resources/metadata/metadata.mjs.map +1 -1
  160. package/resources/metadata/summary.js +1 -1
  161. package/resources/metadata/summary.js.map +1 -1
  162. package/resources/metadata/summary.mjs +1 -1
  163. package/resources/metadata/summary.mjs.map +1 -1
  164. package/resources/metadata/types.js +1 -1
  165. package/resources/metadata/types.js.map +1 -1
  166. package/resources/metadata/types.mjs +1 -1
  167. package/resources/metadata/types.mjs.map +1 -1
  168. package/resources/platform-capabilities.js +1 -1
  169. package/resources/platform-capabilities.js.map +1 -1
  170. package/resources/platform-capabilities.mjs +1 -1
  171. package/resources/platform-capabilities.mjs.map +1 -1
  172. package/resources/report-runs.js +2 -2
  173. package/resources/report-runs.js.map +1 -1
  174. package/resources/report-runs.mjs +2 -2
  175. package/resources/report-runs.mjs.map +1 -1
  176. package/resources/run-query.js +1 -1
  177. package/resources/run-query.js.map +1 -1
  178. package/resources/run-query.mjs +1 -1
  179. package/resources/run-query.mjs.map +1 -1
  180. package/resources/schedules.js +4 -4
  181. package/resources/schedules.js.map +1 -1
  182. package/resources/schedules.mjs +4 -4
  183. package/resources/schedules.mjs.map +1 -1
  184. package/resources/send-email.js +1 -1
  185. package/resources/send-email.js.map +1 -1
  186. package/resources/send-email.mjs +1 -1
  187. package/resources/send-email.mjs.map +1 -1
  188. package/resources/send-slack.js +1 -1
  189. package/resources/send-slack.js.map +1 -1
  190. package/resources/send-slack.mjs +1 -1
  191. package/resources/send-slack.mjs.map +1 -1
  192. package/resources/shift-assignments.js +1 -1
  193. package/resources/shift-assignments.js.map +1 -1
  194. package/resources/shift-assignments.mjs +1 -1
  195. package/resources/shift-assignments.mjs.map +1 -1
  196. package/resources/shift-inputs.js +5 -5
  197. package/resources/shift-inputs.js.map +1 -1
  198. package/resources/shift-inputs.mjs +5 -5
  199. package/resources/shift-inputs.mjs.map +1 -1
  200. package/resources/shiftassignments.js +4 -4
  201. package/resources/shiftassignments.js.map +1 -1
  202. package/resources/shiftassignments.mjs +4 -4
  203. package/resources/shiftassignments.mjs.map +1 -1
  204. package/resources/sso-me.d.mts +3 -3
  205. package/resources/sso-me.d.mts.map +1 -1
  206. package/resources/sso-me.d.ts +3 -3
  207. package/resources/sso-me.d.ts.map +1 -1
  208. package/resources/sso-me.js +2 -2
  209. package/resources/sso-me.js.map +1 -1
  210. package/resources/sso-me.mjs +2 -2
  211. package/resources/sso-me.mjs.map +1 -1
  212. package/resources/supergroups/exclusion-members.js +2 -2
  213. package/resources/supergroups/exclusion-members.js.map +1 -1
  214. package/resources/supergroups/exclusion-members.mjs +2 -2
  215. package/resources/supergroups/exclusion-members.mjs.map +1 -1
  216. package/resources/supergroups/inclusion-members.js +2 -2
  217. package/resources/supergroups/inclusion-members.js.map +1 -1
  218. package/resources/supergroups/inclusion-members.mjs +2 -2
  219. package/resources/supergroups/inclusion-members.mjs.map +1 -1
  220. package/resources/supergroups/members.d.mts.map +1 -1
  221. package/resources/supergroups/members.d.ts.map +1 -1
  222. package/resources/supergroups/members.js +1 -4
  223. package/resources/supergroups/members.js.map +1 -1
  224. package/resources/supergroups/members.mjs +1 -4
  225. package/resources/supergroups/members.mjs.map +1 -1
  226. package/resources/supergroups/supergroups.js +2 -2
  227. package/resources/supergroups/supergroups.js.map +1 -1
  228. package/resources/supergroups/supergroups.mjs +2 -2
  229. package/resources/supergroups/supergroups.mjs.map +1 -1
  230. package/resources/teams.js +2 -2
  231. package/resources/teams.js.map +1 -1
  232. package/resources/teams.mjs +2 -2
  233. package/resources/teams.mjs.map +1 -1
  234. package/resources/time-cards.js +2 -2
  235. package/resources/time-cards.js.map +1 -1
  236. package/resources/time-cards.mjs +2 -2
  237. package/resources/time-cards.mjs.map +1 -1
  238. package/resources/time-entries.js +5 -5
  239. package/resources/time-entries.js.map +1 -1
  240. package/resources/time-entries.mjs +5 -5
  241. package/resources/time-entries.mjs.map +1 -1
  242. package/resources/titles.js +5 -5
  243. package/resources/titles.js.map +1 -1
  244. package/resources/titles.mjs +5 -5
  245. package/resources/titles.mjs.map +1 -1
  246. package/resources/tracks.js +2 -2
  247. package/resources/tracks.js.map +1 -1
  248. package/resources/tracks.mjs +2 -2
  249. package/resources/tracks.mjs.map +1 -1
  250. package/resources/unassigned-shifts.js +2 -2
  251. package/resources/unassigned-shifts.js.map +1 -1
  252. package/resources/unassigned-shifts.mjs +2 -2
  253. package/resources/unassigned-shifts.mjs.map +1 -1
  254. package/resources/unassignedshifts.js +4 -4
  255. package/resources/unassignedshifts.js.map +1 -1
  256. package/resources/unassignedshifts.mjs +4 -4
  257. package/resources/unassignedshifts.mjs.map +1 -1
  258. package/resources/users.js +2 -2
  259. package/resources/users.js.map +1 -1
  260. package/resources/users.mjs +2 -2
  261. package/resources/users.mjs.map +1 -1
  262. package/resources/work-locations.js +5 -5
  263. package/resources/work-locations.js.map +1 -1
  264. package/resources/work-locations.mjs +5 -5
  265. package/resources/work-locations.mjs.map +1 -1
  266. package/resources/workers.js +2 -2
  267. package/resources/workers.js.map +1 -1
  268. package/resources/workers.mjs +2 -2
  269. package/resources/workers.mjs.map +1 -1
  270. package/src/client.ts +2 -6
  271. package/src/resources/business-partner-groups.ts +4 -4
  272. package/src/resources/business-partners.ts +4 -4
  273. package/src/resources/candidate-applications.ts +1 -1
  274. package/src/resources/candidates.ts +1 -1
  275. package/src/resources/companies.ts +1 -1
  276. package/src/resources/compensation-bands-details.ts +2 -2
  277. package/src/resources/compensations.ts +2 -2
  278. package/src/resources/create-app-notification.ts +1 -1
  279. package/src/resources/custom-apps.ts +109 -9
  280. package/src/resources/custom-fields.ts +1 -1
  281. package/src/resources/custom-pages.ts +47 -77
  282. package/src/resources/custom-settings.ts +5 -5
  283. package/src/resources/departments.ts +4 -4
  284. package/src/resources/employment-types.ts +2 -2
  285. package/src/resources/entitlements.ts +1 -1
  286. package/src/resources/headcount-positions.ts +2 -2
  287. package/src/resources/headcount-priorities.ts +2 -2
  288. package/src/resources/index.ts +1 -1
  289. package/src/resources/job-assignments.ts +6 -6
  290. package/src/resources/job-codes.ts +6 -6
  291. package/src/resources/job-dimensions.ts +5 -5
  292. package/src/resources/job-functions.ts +2 -2
  293. package/src/resources/job-pay-rate-exceptions.ts +3 -3
  294. package/src/resources/job-requisitions-write.ts +1 -1
  295. package/src/resources/job-requisitions.ts +4 -1
  296. package/src/resources/kiosk-badges.ts +5 -5
  297. package/src/resources/leave-accruals.ts +3 -3
  298. package/src/resources/leave-balances.ts +2 -2
  299. package/src/resources/leave-requests.ts +4 -4
  300. package/src/resources/leave-types.ts +2 -2
  301. package/src/resources/legal-entities.ts +2 -2
  302. package/src/resources/levels.ts +2 -2
  303. package/src/resources/location-factors.ts +2 -2
  304. package/src/resources/metadata/components.ts +1 -1
  305. package/src/resources/metadata/metadata.ts +1 -1
  306. package/src/resources/metadata/summary.ts +1 -1
  307. package/src/resources/metadata/types.ts +1 -1
  308. package/src/resources/platform-capabilities.ts +1 -1
  309. package/src/resources/report-runs.ts +2 -2
  310. package/src/resources/run-query.ts +1 -1
  311. package/src/resources/schedules.ts +4 -4
  312. package/src/resources/send-email.ts +1 -1
  313. package/src/resources/send-slack.ts +1 -1
  314. package/src/resources/shift-assignments.ts +1 -1
  315. package/src/resources/shift-inputs.ts +5 -5
  316. package/src/resources/shiftassignments.ts +4 -4
  317. package/src/resources/sso-me.ts +4 -4
  318. package/src/resources/supergroups/exclusion-members.ts +2 -2
  319. package/src/resources/supergroups/inclusion-members.ts +2 -2
  320. package/src/resources/supergroups/members.ts +5 -4
  321. package/src/resources/supergroups/supergroups.ts +2 -2
  322. package/src/resources/teams.ts +2 -2
  323. package/src/resources/time-cards.ts +2 -2
  324. package/src/resources/time-entries.ts +5 -5
  325. package/src/resources/titles.ts +5 -5
  326. package/src/resources/tracks.ts +2 -2
  327. package/src/resources/unassigned-shifts.ts +2 -2
  328. package/src/resources/unassignedshifts.ts +4 -4
  329. package/src/resources/users.ts +2 -2
  330. package/src/resources/work-locations.ts +5 -5
  331. package/src/resources/workers.ts +2 -2
  332. package/src/version.ts +1 -1
  333. package/version.d.mts +1 -1
  334. package/version.d.ts +1 -1
  335. package/version.js +1 -1
  336. package/version.mjs +1 -1
@@ -15,7 +15,7 @@ export class CustomPages extends APIResource {
15
15
  * - Requires: `API Tier 1`
16
16
  */
17
17
  list(options?: RequestOptions): PagePromise<CustomPageListResponsesPageCursorURL, CustomPageListResponse> {
18
- return this._client.getAPIList('/custom-pages', PageCursorURL<CustomPageListResponse>, options);
18
+ return this._client.getAPIList('/custom-pages/', PageCursorURL<CustomPageListResponse>, options);
19
19
  }
20
20
 
21
21
  /**
@@ -25,14 +25,14 @@ export class CustomPages extends APIResource {
25
25
  body: CustomPageCreateParams | null | undefined = {},
26
26
  options?: RequestOptions,
27
27
  ): APIPromise<CustomPageCreateResponse> {
28
- return this._client.post('/custom-pages', { body, ...options });
28
+ return this._client.post('/custom-pages/', { body, ...options });
29
29
  }
30
30
 
31
31
  /**
32
32
  * Retrieve a specific CustomPage
33
33
  */
34
34
  retrieve(id: string, options?: RequestOptions): APIPromise<CustomPageRetrieveResponse> {
35
- return this._client.get(path`/custom-pages/${id}`, options);
35
+ return this._client.get(path`/custom-pages/${id}/`, options);
36
36
  }
37
37
 
38
38
  /**
@@ -43,14 +43,14 @@ export class CustomPages extends APIResource {
43
43
  body: CustomPageUpdateParams | null | undefined = {},
44
44
  options?: RequestOptions,
45
45
  ): APIPromise<CustomPageUpdateResponse> {
46
- return this._client.patch(path`/custom-pages/${id}`, { body, ...options });
46
+ return this._client.patch(path`/custom-pages/${id}/`, { body, ...options });
47
47
  }
48
48
 
49
49
  /**
50
50
  * Delete a CustomPage
51
51
  */
52
52
  delete(id: string, options?: RequestOptions): APIPromise<void> {
53
- return this._client.delete(path`/custom-pages/${id}`, {
53
+ return this._client.delete(path`/custom-pages/${id}/`, {
54
54
  ...options,
55
55
  headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
56
56
  });
@@ -66,29 +66,19 @@ export interface CustomPageListResponse {
66
66
  id?: string;
67
67
 
68
68
  /**
69
- * Canvas actions
70
- */
71
- actions?: Array<unknown>;
72
-
73
- /**
74
- * Canvas actions (v2)
75
- */
76
- canvas_actions?: Array<unknown>;
77
-
78
- /**
79
- * The canvas component tree
69
+ * Record creation date
80
70
  */
81
- components?: Array<unknown>;
71
+ created_at?: string;
82
72
 
83
73
  /**
84
- * Record creation date
74
+ * The ID of the role that created the page
85
75
  */
86
- created_at?: string;
76
+ created_by?: string;
87
77
 
88
78
  /**
89
- * Media assets
79
+ * The ID of the Rippling Function that renders this page
90
80
  */
91
- media?: unknown;
81
+ function_id?: string;
92
82
 
93
83
  /**
94
84
  * The display name of the custom page
@@ -101,9 +91,9 @@ export interface CustomPageListResponse {
101
91
  updated_at?: string;
102
92
 
103
93
  /**
104
- * Canvas variables
94
+ * The ID of the role that last modified the page
105
95
  */
106
- variables?: Array<unknown>;
96
+ updated_by?: string;
107
97
  }
108
98
 
109
99
  export interface CustomPageCreateResponse {
@@ -113,29 +103,19 @@ export interface CustomPageCreateResponse {
113
103
  id?: string;
114
104
 
115
105
  /**
116
- * Canvas actions
117
- */
118
- actions?: Array<unknown>;
119
-
120
- /**
121
- * Canvas actions (v2)
106
+ * Record creation date
122
107
  */
123
- canvas_actions?: Array<unknown>;
108
+ created_at?: string;
124
109
 
125
110
  /**
126
- * The canvas component tree
111
+ * The ID of the role that created the page
127
112
  */
128
- components?: Array<unknown>;
113
+ created_by?: string;
129
114
 
130
115
  /**
131
- * Record creation date
116
+ * The ID of the Rippling Function that renders this page
132
117
  */
133
- created_at?: string;
134
-
135
- /**
136
- * Media assets
137
- */
138
- media?: unknown;
118
+ function_id?: string;
139
119
 
140
120
  /**
141
121
  * The display name of the custom page
@@ -148,9 +128,9 @@ export interface CustomPageCreateResponse {
148
128
  updated_at?: string;
149
129
 
150
130
  /**
151
- * Canvas variables
131
+ * The ID of the role that last modified the page
152
132
  */
153
- variables?: Array<unknown>;
133
+ updated_by?: string;
154
134
  }
155
135
 
156
136
  /**
@@ -163,29 +143,19 @@ export interface CustomPageRetrieveResponse extends BusinessPartnersAPI.Meta {
163
143
  id?: string;
164
144
 
165
145
  /**
166
- * Canvas actions
167
- */
168
- actions?: Array<unknown>;
169
-
170
- /**
171
- * Canvas actions (v2)
172
- */
173
- canvas_actions?: Array<unknown>;
174
-
175
- /**
176
- * The canvas component tree
146
+ * Record creation date
177
147
  */
178
- components?: Array<unknown>;
148
+ created_at?: string;
179
149
 
180
150
  /**
181
- * Record creation date
151
+ * The ID of the role that created the page
182
152
  */
183
- created_at?: string;
153
+ created_by?: string;
184
154
 
185
155
  /**
186
- * Media assets
156
+ * The ID of the Rippling Function that renders this page
187
157
  */
188
- media?: unknown;
158
+ function_id?: string;
189
159
 
190
160
  /**
191
161
  * The display name of the custom page
@@ -198,9 +168,9 @@ export interface CustomPageRetrieveResponse extends BusinessPartnersAPI.Meta {
198
168
  updated_at?: string;
199
169
 
200
170
  /**
201
- * Canvas variables
171
+ * The ID of the role that last modified the page
202
172
  */
203
- variables?: Array<unknown>;
173
+ updated_by?: string;
204
174
  }
205
175
 
206
176
  export interface CustomPageUpdateResponse {
@@ -210,29 +180,19 @@ export interface CustomPageUpdateResponse {
210
180
  id?: string;
211
181
 
212
182
  /**
213
- * Canvas actions
214
- */
215
- actions?: Array<unknown>;
216
-
217
- /**
218
- * Canvas actions (v2)
219
- */
220
- canvas_actions?: Array<unknown>;
221
-
222
- /**
223
- * The canvas component tree
183
+ * Record creation date
224
184
  */
225
- components?: Array<unknown>;
185
+ created_at?: string;
226
186
 
227
187
  /**
228
- * Record creation date
188
+ * The ID of the role that created the page
229
189
  */
230
- created_at?: string;
190
+ created_by?: string;
231
191
 
232
192
  /**
233
- * Media assets
193
+ * The ID of the Rippling Function that renders this page
234
194
  */
235
- media?: unknown;
195
+ function_id?: string;
236
196
 
237
197
  /**
238
198
  * The display name of the custom page
@@ -245,12 +205,17 @@ export interface CustomPageUpdateResponse {
245
205
  updated_at?: string;
246
206
 
247
207
  /**
248
- * Canvas variables
208
+ * The ID of the role that last modified the page
249
209
  */
250
- variables?: Array<unknown>;
210
+ updated_by?: string;
251
211
  }
252
212
 
253
213
  export interface CustomPageCreateParams {
214
+ /**
215
+ * The ID of the Rippling Function that renders this page
216
+ */
217
+ function_id?: string;
218
+
254
219
  /**
255
220
  * The display name of the custom page
256
221
  */
@@ -258,6 +223,11 @@ export interface CustomPageCreateParams {
258
223
  }
259
224
 
260
225
  export interface CustomPageUpdateParams {
226
+ /**
227
+ * The ID of the Rippling Function that renders this page
228
+ */
229
+ function_id?: string;
230
+
261
231
  /**
262
232
  * The display name of the custom page
263
233
  */
@@ -19,7 +19,7 @@ export class CustomSettings extends APIResource {
19
19
  query: CustomSettingListParams | null | undefined = {},
20
20
  options?: RequestOptions,
21
21
  ): PagePromise<CustomSettingListResponsesPageCursorURL, CustomSettingListResponse> {
22
- return this._client.getAPIList('/custom-settings', PageCursorURL<CustomSettingListResponse>, {
22
+ return this._client.getAPIList('/custom-settings/', PageCursorURL<CustomSettingListResponse>, {
23
23
  query,
24
24
  ...options,
25
25
  });
@@ -32,14 +32,14 @@ export class CustomSettings extends APIResource {
32
32
  body: CustomSettingCreateParams | null | undefined = {},
33
33
  options?: RequestOptions,
34
34
  ): APIPromise<CustomSettingCreateResponse> {
35
- return this._client.post('/custom-settings', { body, ...options });
35
+ return this._client.post('/custom-settings/', { body, ...options });
36
36
  }
37
37
 
38
38
  /**
39
39
  * Retrieve a specific Setting
40
40
  */
41
41
  retrieve(id: string, options?: RequestOptions): APIPromise<CustomSettingRetrieveResponse> {
42
- return this._client.get(path`/custom-settings/${id}`, options);
42
+ return this._client.get(path`/custom-settings/${id}/`, options);
43
43
  }
44
44
 
45
45
  /**
@@ -50,14 +50,14 @@ export class CustomSettings extends APIResource {
50
50
  body: CustomSettingUpdateParams | null | undefined = {},
51
51
  options?: RequestOptions,
52
52
  ): APIPromise<CustomSettingUpdateResponse> {
53
- return this._client.patch(path`/custom-settings/${id}`, { body, ...options });
53
+ return this._client.patch(path`/custom-settings/${id}/`, { body, ...options });
54
54
  }
55
55
 
56
56
  /**
57
57
  * Delete a Setting
58
58
  */
59
59
  delete(id: string, options?: RequestOptions): APIPromise<void> {
60
- return this._client.delete(path`/custom-settings/${id}`, {
60
+ return this._client.delete(path`/custom-settings/${id}/`, {
61
61
  ...options,
62
62
  headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
63
63
  });
@@ -22,14 +22,14 @@ export class Departments extends APIResource {
22
22
  query: DepartmentListParams | null | undefined = {},
23
23
  options?: RequestOptions,
24
24
  ): PagePromise<DepartmentsPageCursorURL, Department> {
25
- return this._client.getAPIList('/departments', PageCursorURL<Department>, { query, ...options });
25
+ return this._client.getAPIList('/departments/', PageCursorURL<Department>, { query, ...options });
26
26
  }
27
27
 
28
28
  /**
29
29
  * Create a new department
30
30
  */
31
31
  create(body: DepartmentCreateParams, options?: RequestOptions): APIPromise<Department> {
32
- return this._client.post('/departments', { body, ...options });
32
+ return this._client.post('/departments/', { body, ...options });
33
33
  }
34
34
 
35
35
  /**
@@ -40,14 +40,14 @@ export class Departments extends APIResource {
40
40
  query: DepartmentRetrieveParams | null | undefined = {},
41
41
  options?: RequestOptions,
42
42
  ): APIPromise<DepartmentRetrieveResponse> {
43
- return this._client.get(path`/departments/${id}`, { query, ...options });
43
+ return this._client.get(path`/departments/${id}/`, { query, ...options });
44
44
  }
45
45
 
46
46
  /**
47
47
  * Updated a specific department
48
48
  */
49
49
  update(id: string, body: DepartmentUpdateParams, options?: RequestOptions): APIPromise<Department> {
50
- return this._client.patch(path`/departments/${id}`, { body, ...options });
50
+ return this._client.patch(path`/departments/${id}/`, { body, ...options });
51
51
  }
52
52
  }
53
53
 
@@ -21,7 +21,7 @@ export class EmploymentTypes extends APIResource {
21
21
  query: EmploymentTypeListParams | null | undefined = {},
22
22
  options?: RequestOptions,
23
23
  ): PagePromise<CompanyEmploymentTypesPageCursorURL, CompanyEmploymentType> {
24
- return this._client.getAPIList('/employment-types', PageCursorURL<CompanyEmploymentType>, {
24
+ return this._client.getAPIList('/employment-types/', PageCursorURL<CompanyEmploymentType>, {
25
25
  query,
26
26
  ...options,
27
27
  });
@@ -31,7 +31,7 @@ export class EmploymentTypes extends APIResource {
31
31
  * Retrieve a specific employment type
32
32
  */
33
33
  retrieve(id: string, options?: RequestOptions): APIPromise<EmploymentTypeRetrieveResponse> {
34
- return this._client.get(path`/employment-types/${id}`, options);
34
+ return this._client.get(path`/employment-types/${id}/`, options);
35
35
  }
36
36
  }
37
37
 
@@ -16,7 +16,7 @@ export class Entitlements extends APIResource {
16
16
  list(
17
17
  options?: RequestOptions,
18
18
  ): PagePromise<EntitlementListResponsesPageCursorURL, EntitlementListResponse> {
19
- return this._client.getAPIList('/entitlements', PageCursorURL<EntitlementListResponse>, options);
19
+ return this._client.getAPIList('/entitlements/', PageCursorURL<EntitlementListResponse>, options);
20
20
  }
21
21
  }
22
22
 
@@ -40,7 +40,7 @@ export class HeadcountPositions extends APIResource {
40
40
  query: HeadcountPositionListParams | null | undefined = {},
41
41
  options?: RequestOptions,
42
42
  ): PagePromise<HeadcountPositionListResponsesPageCursorURL, HeadcountPositionListResponse> {
43
- return this._client.getAPIList('/headcount-positions', PageCursorURL<HeadcountPositionListResponse>, {
43
+ return this._client.getAPIList('/headcount-positions/', PageCursorURL<HeadcountPositionListResponse>, {
44
44
  query,
45
45
  ...options,
46
46
  });
@@ -54,7 +54,7 @@ export class HeadcountPositions extends APIResource {
54
54
  query: HeadcountPositionRetrieveParams | null | undefined = {},
55
55
  options?: RequestOptions,
56
56
  ): APIPromise<HeadcountPositionRetrieveResponse> {
57
- return this._client.get(path`/headcount-positions/${id}`, { query, ...options });
57
+ return this._client.get(path`/headcount-positions/${id}/`, { query, ...options });
58
58
  }
59
59
  }
60
60
 
@@ -21,7 +21,7 @@ export class HeadcountPriorities extends APIResource {
21
21
  query: HeadcountPriorityListParams | null | undefined = {},
22
22
  options?: RequestOptions,
23
23
  ): PagePromise<HeadcountPriorityListResponsesPageCursorURL, HeadcountPriorityListResponse> {
24
- return this._client.getAPIList('/headcount-priorities', PageCursorURL<HeadcountPriorityListResponse>, {
24
+ return this._client.getAPIList('/headcount-priorities/', PageCursorURL<HeadcountPriorityListResponse>, {
25
25
  query,
26
26
  ...options,
27
27
  });
@@ -31,7 +31,7 @@ export class HeadcountPriorities extends APIResource {
31
31
  * Retrieve a specific headcount priority
32
32
  */
33
33
  retrieve(id: string, options?: RequestOptions): APIPromise<HeadcountPriorityRetrieveResponse> {
34
- return this._client.get(path`/headcount-priorities/${id}`, options);
34
+ return this._client.get(path`/headcount-priorities/${id}/`, options);
35
35
  }
36
36
  }
37
37
 
@@ -305,7 +305,7 @@ export {
305
305
  type ReportRunCreateParams,
306
306
  } from './report-runs';
307
307
  export { RunQuery, type RunQueryCreateResponse, type RunQueryCreateParams } from './run-query';
308
- export { SSOMeResource, type SSOMe, type SSOMeRetrieveParams } from './sso-me';
308
+ export { SSOMeResource, type SSOMe, type SSOMeListParams } from './sso-me';
309
309
  export {
310
310
  Schedules,
311
311
  type ScheduleListResponse,
@@ -27,14 +27,14 @@ export class JobAssignments extends APIResource {
27
27
  query: JobAssignmentListParams | null | undefined = {},
28
28
  options?: RequestOptions,
29
29
  ): PagePromise<JobAssignmentsPageCursorURL, JobAssignment> {
30
- return this._client.getAPIList('/job-assignments', PageCursorURL<JobAssignment>, { query, ...options });
30
+ return this._client.getAPIList('/job-assignments/', PageCursorURL<JobAssignment>, { query, ...options });
31
31
  }
32
32
 
33
33
  /**
34
34
  * Create a new job assignment
35
35
  */
36
36
  create(body: JobAssignmentCreateParams, options?: RequestOptions): APIPromise<JobAssignment> {
37
- return this._client.post('/job-assignments', { body, ...options });
37
+ return this._client.post('/job-assignments/', { body, ...options });
38
38
  }
39
39
 
40
40
  /**
@@ -45,21 +45,21 @@ export class JobAssignments extends APIResource {
45
45
  query: JobAssignmentRetrieveParams | null | undefined = {},
46
46
  options?: RequestOptions,
47
47
  ): APIPromise<JobAssignmentRetrieveResponse> {
48
- return this._client.get(path`/job-assignments/${id}`, { query, ...options });
48
+ return this._client.get(path`/job-assignments/${id}/`, { query, ...options });
49
49
  }
50
50
 
51
51
  /**
52
52
  * Updated a specific job assignment
53
53
  */
54
54
  update(id: string, body: JobAssignmentUpdateParams, options?: RequestOptions): APIPromise<JobAssignment> {
55
- return this._client.patch(path`/job-assignments/${id}`, { body, ...options });
55
+ return this._client.patch(path`/job-assignments/${id}/`, { body, ...options });
56
56
  }
57
57
 
58
58
  /**
59
59
  * Delete a job assignment
60
60
  */
61
61
  delete(id: string, options?: RequestOptions): APIPromise<void> {
62
- return this._client.delete(path`/job-assignments/${id}`, {
62
+ return this._client.delete(path`/job-assignments/${id}/`, {
63
63
  ...options,
64
64
  headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
65
65
  });
@@ -78,7 +78,7 @@ export class JobAssignments extends APIResource {
78
78
  options?: RequestOptions,
79
79
  ): PagePromise<AttributeChangeDetailsPageCursorURL, AttributeChangeDetails> {
80
80
  return this._client.getAPIList(
81
- path`/job-assignments/${jobAssignmentID}/change-log`,
81
+ path`/job-assignments/${jobAssignmentID}/change-log/`,
82
82
  PageCursorURL<AttributeChangeDetails>,
83
83
  { query, ...options },
84
84
  );
@@ -32,14 +32,14 @@ export class JobCodes extends APIResource {
32
32
  query: JobCodeListParams | null | undefined = {},
33
33
  options?: RequestOptions,
34
34
  ): PagePromise<JobCodesPageCursorURL, JobCode> {
35
- return this._client.getAPIList('/job-codes', PageCursorURL<JobCode>, { query, ...options });
35
+ return this._client.getAPIList('/job-codes/', PageCursorURL<JobCode>, { query, ...options });
36
36
  }
37
37
 
38
38
  /**
39
39
  * Create a new job code
40
40
  */
41
41
  create(body: JobCodeCreateParams, options?: RequestOptions): APIPromise<JobCode> {
42
- return this._client.post('/job-codes', { body, ...options });
42
+ return this._client.post('/job-codes/', { body, ...options });
43
43
  }
44
44
 
45
45
  /**
@@ -50,21 +50,21 @@ export class JobCodes extends APIResource {
50
50
  query: JobCodeRetrieveParams | null | undefined = {},
51
51
  options?: RequestOptions,
52
52
  ): APIPromise<JobCodeRetrieveResponse> {
53
- return this._client.get(path`/job-codes/${id}`, { query, ...options });
53
+ return this._client.get(path`/job-codes/${id}/`, { query, ...options });
54
54
  }
55
55
 
56
56
  /**
57
57
  * Updated a specific job code
58
58
  */
59
59
  update(id: string, body: JobCodeUpdateParams, options?: RequestOptions): APIPromise<JobCode> {
60
- return this._client.patch(path`/job-codes/${id}`, { body, ...options });
60
+ return this._client.patch(path`/job-codes/${id}/`, { body, ...options });
61
61
  }
62
62
 
63
63
  /**
64
64
  * Delete a job code
65
65
  */
66
66
  delete(id: string, options?: RequestOptions): APIPromise<void> {
67
- return this._client.delete(path`/job-codes/${id}`, {
67
+ return this._client.delete(path`/job-codes/${id}/`, {
68
68
  ...options,
69
69
  headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
70
70
  });
@@ -83,7 +83,7 @@ export class JobCodes extends APIResource {
83
83
  options?: RequestOptions,
84
84
  ): PagePromise<AttributeChangeDetailsPageCursorURL, JobAssignmentsAPI.AttributeChangeDetails> {
85
85
  return this._client.getAPIList(
86
- path`/job-codes/${jobCodeID}/change-log`,
86
+ path`/job-codes/${jobCodeID}/change-log/`,
87
87
  PageCursorURL<JobAssignmentsAPI.AttributeChangeDetails>,
88
88
  { query, ...options },
89
89
  );
@@ -23,35 +23,35 @@ export class JobDimensions extends APIResource {
23
23
  query: JobDimensionListParams | null | undefined = {},
24
24
  options?: RequestOptions,
25
25
  ): PagePromise<JobDimensionsPageCursorURL, JobDimension> {
26
- return this._client.getAPIList('/job-dimensions', PageCursorURL<JobDimension>, { query, ...options });
26
+ return this._client.getAPIList('/job-dimensions/', PageCursorURL<JobDimension>, { query, ...options });
27
27
  }
28
28
 
29
29
  /**
30
30
  * Create a new job dimension
31
31
  */
32
32
  create(body: JobDimensionCreateParams, options?: RequestOptions): APIPromise<JobDimension> {
33
- return this._client.post('/job-dimensions', { body, ...options });
33
+ return this._client.post('/job-dimensions/', { body, ...options });
34
34
  }
35
35
 
36
36
  /**
37
37
  * Retrieve a specific job dimension
38
38
  */
39
39
  retrieve(id: string, options?: RequestOptions): APIPromise<JobDimensionRetrieveResponse> {
40
- return this._client.get(path`/job-dimensions/${id}`, options);
40
+ return this._client.get(path`/job-dimensions/${id}/`, options);
41
41
  }
42
42
 
43
43
  /**
44
44
  * Updated a specific job dimension
45
45
  */
46
46
  update(id: string, body: JobDimensionUpdateParams, options?: RequestOptions): APIPromise<JobDimension> {
47
- return this._client.patch(path`/job-dimensions/${id}`, { body, ...options });
47
+ return this._client.patch(path`/job-dimensions/${id}/`, { body, ...options });
48
48
  }
49
49
 
50
50
  /**
51
51
  * Delete a job dimension
52
52
  */
53
53
  delete(id: string, options?: RequestOptions): APIPromise<void> {
54
- return this._client.delete(path`/job-dimensions/${id}`, {
54
+ return this._client.delete(path`/job-dimensions/${id}/`, {
55
55
  ...options,
56
56
  headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
57
57
  });
@@ -21,7 +21,7 @@ export class JobFunctions extends APIResource {
21
21
  query: JobFunctionListParams | null | undefined = {},
22
22
  options?: RequestOptions,
23
23
  ): PagePromise<JobFunctionListResponsesPageCursorURL, JobFunctionListResponse> {
24
- return this._client.getAPIList('/job-functions', PageCursorURL<JobFunctionListResponse>, {
24
+ return this._client.getAPIList('/job-functions/', PageCursorURL<JobFunctionListResponse>, {
25
25
  query,
26
26
  ...options,
27
27
  });
@@ -31,7 +31,7 @@ export class JobFunctions extends APIResource {
31
31
  * Retrieve a specific job function
32
32
  */
33
33
  retrieve(id: string, options?: RequestOptions): APIPromise<JobFunctionRetrieveResponse> {
34
- return this._client.get(path`/job-functions/${id}`, options);
34
+ return this._client.get(path`/job-functions/${id}/`, options);
35
35
  }
36
36
  }
37
37
 
@@ -26,7 +26,7 @@ export class JobPayRateExceptions extends APIResource {
26
26
  query: JobPayRateExceptionListParams | null | undefined = {},
27
27
  options?: RequestOptions,
28
28
  ): PagePromise<JobPayRateExceptionsPageCursorURL, JobPayRateException> {
29
- return this._client.getAPIList('/job-pay-rate-exceptions', PageCursorURL<JobPayRateException>, {
29
+ return this._client.getAPIList('/job-pay-rate-exceptions/', PageCursorURL<JobPayRateException>, {
30
30
  query,
31
31
  ...options,
32
32
  });
@@ -40,7 +40,7 @@ export class JobPayRateExceptions extends APIResource {
40
40
  query: JobPayRateExceptionRetrieveParams | null | undefined = {},
41
41
  options?: RequestOptions,
42
42
  ): APIPromise<JobPayRateExceptionRetrieveResponse> {
43
- return this._client.get(path`/job-pay-rate-exceptions/${id}`, { query, ...options });
43
+ return this._client.get(path`/job-pay-rate-exceptions/${id}/`, { query, ...options });
44
44
  }
45
45
 
46
46
  /**
@@ -56,7 +56,7 @@ export class JobPayRateExceptions extends APIResource {
56
56
  options?: RequestOptions,
57
57
  ): PagePromise<AttributeChangeDetailsPageCursorURL, JobAssignmentsAPI.AttributeChangeDetails> {
58
58
  return this._client.getAPIList(
59
- path`/job-pay-rate-exceptions/${jobPayRateExceptionID}/change-log`,
59
+ path`/job-pay-rate-exceptions/${jobPayRateExceptionID}/change-log/`,
60
60
  PageCursorURL<JobAssignmentsAPI.AttributeChangeDetails>,
61
61
  { query, ...options },
62
62
  );
@@ -15,7 +15,7 @@ export class JobRequisitionsWrite extends APIResource {
15
15
  body: JobRequisitionsWriteCreateParams,
16
16
  options?: RequestOptions,
17
17
  ): APIPromise<JobRequisitionsWriteCreateResponse> {
18
- return this._client.post('/job-requisitions-write', { body, ...options });
18
+ return this._client.post('/job-requisitions-write/', { body, ...options });
19
19
  }
20
20
  }
21
21
 
@@ -18,7 +18,10 @@ export class JobRequisitions extends APIResource {
18
18
  query: JobRequisitionListParams | null | undefined = {},
19
19
  options?: RequestOptions,
20
20
  ): PagePromise<JobRequisitionsPageCursorURL, JobRequisition> {
21
- return this._client.getAPIList('/job-requisitions', PageCursorURL<JobRequisition>, { query, ...options });
21
+ return this._client.getAPIList('/job-requisitions/', PageCursorURL<JobRequisition>, {
22
+ query,
23
+ ...options,
24
+ });
22
25
  }
23
26
  }
24
27
 
@@ -25,7 +25,7 @@ export class KioskBadges extends APIResource {
25
25
  query: KioskBadgeListParams | null | undefined = {},
26
26
  options?: RequestOptions,
27
27
  ): PagePromise<KioskBadgeListResponsesPageCursorURL, KioskBadgeListResponse> {
28
- return this._client.getAPIList('/kiosk-badges', PageCursorURL<KioskBadgeListResponse>, {
28
+ return this._client.getAPIList('/kiosk-badges/', PageCursorURL<KioskBadgeListResponse>, {
29
29
  query,
30
30
  ...options,
31
31
  });
@@ -35,7 +35,7 @@ export class KioskBadges extends APIResource {
35
35
  * Create a new kiosk badge
36
36
  */
37
37
  create(body: KioskBadgeCreateParams, options?: RequestOptions): APIPromise<KioskBadgeCreateResponse> {
38
- return this._client.post('/kiosk-badges', { body, ...options });
38
+ return this._client.post('/kiosk-badges/', { body, ...options });
39
39
  }
40
40
 
41
41
  /**
@@ -46,7 +46,7 @@ export class KioskBadges extends APIResource {
46
46
  query: KioskBadgeRetrieveParams | null | undefined = {},
47
47
  options?: RequestOptions,
48
48
  ): APIPromise<KioskBadgeRetrieveResponse> {
49
- return this._client.get(path`/kiosk-badges/${id}`, { query, ...options });
49
+ return this._client.get(path`/kiosk-badges/${id}/`, { query, ...options });
50
50
  }
51
51
 
52
52
  /**
@@ -57,14 +57,14 @@ export class KioskBadges extends APIResource {
57
57
  body: KioskBadgeUpdateParams,
58
58
  options?: RequestOptions,
59
59
  ): APIPromise<KioskBadgeUpdateResponse> {
60
- return this._client.patch(path`/kiosk-badges/${id}`, { body, ...options });
60
+ return this._client.patch(path`/kiosk-badges/${id}/`, { body, ...options });
61
61
  }
62
62
 
63
63
  /**
64
64
  * Delete a kiosk badge
65
65
  */
66
66
  delete(id: string, options?: RequestOptions): APIPromise<void> {
67
- return this._client.delete(path`/kiosk-badges/${id}`, {
67
+ return this._client.delete(path`/kiosk-badges/${id}/`, {
68
68
  ...options,
69
69
  headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
70
70
  });