@rippling/rippling-sdk 0.2.0-alpha.104 → 0.2.0-alpha.106

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 (251) hide show
  1. package/client.d.mts +12 -0
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +12 -0
  4. package/client.d.ts.map +1 -1
  5. package/client.js +12 -0
  6. package/client.js.map +1 -1
  7. package/client.mjs +12 -0
  8. package/client.mjs.map +1 -1
  9. package/lib/charts/builders.d.mts +43 -0
  10. package/lib/charts/builders.d.mts.map +1 -0
  11. package/lib/charts/builders.d.ts +43 -0
  12. package/lib/charts/builders.d.ts.map +1 -0
  13. package/lib/charts/builders.js +77 -0
  14. package/lib/charts/builders.js.map +1 -0
  15. package/lib/charts/builders.mjs +70 -0
  16. package/lib/charts/builders.mjs.map +1 -0
  17. package/lib/charts/describe.d.mts +12 -0
  18. package/lib/charts/describe.d.mts.map +1 -0
  19. package/lib/charts/describe.d.ts +12 -0
  20. package/lib/charts/describe.d.ts.map +1 -0
  21. package/lib/charts/describe.js +64 -0
  22. package/lib/charts/describe.js.map +1 -0
  23. package/lib/charts/describe.mjs +61 -0
  24. package/lib/charts/describe.mjs.map +1 -0
  25. package/lib/charts/errors.d.mts +35 -0
  26. package/lib/charts/errors.d.mts.map +1 -0
  27. package/lib/charts/errors.d.ts +35 -0
  28. package/lib/charts/errors.d.ts.map +1 -0
  29. package/lib/charts/errors.js +55 -0
  30. package/lib/charts/errors.js.map +1 -0
  31. package/lib/charts/errors.mjs +47 -0
  32. package/lib/charts/errors.mjs.map +1 -0
  33. package/lib/charts/evaluate.d.mts +16 -0
  34. package/lib/charts/evaluate.d.mts.map +1 -0
  35. package/lib/charts/evaluate.d.ts +16 -0
  36. package/lib/charts/evaluate.d.ts.map +1 -0
  37. package/lib/charts/evaluate.js +99 -0
  38. package/lib/charts/evaluate.js.map +1 -0
  39. package/lib/charts/evaluate.mjs +96 -0
  40. package/lib/charts/evaluate.mjs.map +1 -0
  41. package/lib/charts/guards.d.mts +15 -0
  42. package/lib/charts/guards.d.mts.map +1 -0
  43. package/lib/charts/guards.d.ts +15 -0
  44. package/lib/charts/guards.d.ts.map +1 -0
  45. package/lib/charts/guards.js +38 -0
  46. package/lib/charts/guards.js.map +1 -0
  47. package/lib/charts/guards.mjs +34 -0
  48. package/lib/charts/guards.mjs.map +1 -0
  49. package/lib/charts/schema.d.mts +101 -0
  50. package/lib/charts/schema.d.mts.map +1 -0
  51. package/lib/charts/schema.d.ts +101 -0
  52. package/lib/charts/schema.d.ts.map +1 -0
  53. package/lib/charts/schema.js +74 -0
  54. package/lib/charts/schema.js.map +1 -0
  55. package/lib/charts/schema.mjs +71 -0
  56. package/lib/charts/schema.mjs.map +1 -0
  57. package/lib/charts/types.d.mts +79 -0
  58. package/lib/charts/types.d.mts.map +1 -0
  59. package/lib/charts/types.d.ts +79 -0
  60. package/lib/charts/types.d.ts.map +1 -0
  61. package/lib/charts/types.js +25 -0
  62. package/lib/charts/types.js.map +1 -0
  63. package/lib/charts/types.mjs +22 -0
  64. package/lib/charts/types.mjs.map +1 -0
  65. package/lib/charts.d.mts +7 -0
  66. package/lib/charts.d.mts.map +1 -0
  67. package/lib/charts.d.ts +7 -0
  68. package/lib/charts.d.ts.map +1 -0
  69. package/lib/charts.js +32 -0
  70. package/lib/charts.js.map +1 -0
  71. package/lib/charts.mjs +7 -0
  72. package/lib/charts.mjs.map +1 -0
  73. package/lib/manifest/_existing-component-fields.d.mts.map +1 -1
  74. package/lib/manifest/_existing-component-fields.d.ts.map +1 -1
  75. package/lib/manifest/_existing-component-fields.js +2 -0
  76. package/lib/manifest/_existing-component-fields.js.map +1 -1
  77. package/lib/manifest/_existing-component-fields.mjs +2 -0
  78. package/lib/manifest/_existing-component-fields.mjs.map +1 -1
  79. package/lib/manifest/existing-manifest-context.d.mts +3 -0
  80. package/lib/manifest/existing-manifest-context.d.mts.map +1 -1
  81. package/lib/manifest/existing-manifest-context.d.ts +3 -0
  82. package/lib/manifest/existing-manifest-context.d.ts.map +1 -1
  83. package/lib/manifest/existing-manifest-context.js +14 -0
  84. package/lib/manifest/existing-manifest-context.js.map +1 -1
  85. package/lib/manifest/existing-manifest-context.mjs +14 -0
  86. package/lib/manifest/existing-manifest-context.mjs.map +1 -1
  87. package/lib/manifest/workflow/index.d.mts +4 -0
  88. package/lib/manifest/workflow/index.d.mts.map +1 -1
  89. package/lib/manifest/workflow/index.d.ts +4 -0
  90. package/lib/manifest/workflow/index.d.ts.map +1 -1
  91. package/lib/manifest/workflow/index.js +49 -0
  92. package/lib/manifest/workflow/index.js.map +1 -1
  93. package/lib/manifest/workflow/index.mjs +49 -0
  94. package/lib/manifest/workflow/index.mjs.map +1 -1
  95. package/package.json +1 -1
  96. package/resources/activity-log.d.mts +517 -0
  97. package/resources/activity-log.d.mts.map +1 -0
  98. package/resources/activity-log.d.ts +517 -0
  99. package/resources/activity-log.d.ts.map +1 -0
  100. package/resources/activity-log.js +171 -0
  101. package/resources/activity-log.js.map +1 -0
  102. package/resources/activity-log.mjs +167 -0
  103. package/resources/activity-log.mjs.map +1 -0
  104. package/resources/compensations.d.mts +1 -1
  105. package/resources/compensations.d.ts +1 -1
  106. package/resources/compensations.js +1 -1
  107. package/resources/compensations.mjs +1 -1
  108. package/resources/developer-program-application.d.mts +1 -1
  109. package/resources/developer-program-application.d.ts +1 -1
  110. package/resources/developer-program-application.js +1 -1
  111. package/resources/developer-program-application.mjs +1 -1
  112. package/resources/developer-users.d.mts +2 -1
  113. package/resources/developer-users.d.mts.map +1 -1
  114. package/resources/developer-users.d.ts +2 -1
  115. package/resources/developer-users.d.ts.map +1 -1
  116. package/resources/developer-users.js +2 -1
  117. package/resources/developer-users.js.map +1 -1
  118. package/resources/developer-users.mjs +2 -1
  119. package/resources/developer-users.mjs.map +1 -1
  120. package/resources/hire-requirements.d.mts +8 -74
  121. package/resources/hire-requirements.d.mts.map +1 -1
  122. package/resources/hire-requirements.d.ts +8 -74
  123. package/resources/hire-requirements.d.ts.map +1 -1
  124. package/resources/hire-requirements.js +3 -19
  125. package/resources/hire-requirements.js.map +1 -1
  126. package/resources/hire-requirements.mjs +3 -19
  127. package/resources/hire-requirements.mjs.map +1 -1
  128. package/resources/hires.d.mts +677 -142
  129. package/resources/hires.d.mts.map +1 -1
  130. package/resources/hires.d.ts +677 -142
  131. package/resources/hires.d.ts.map +1 -1
  132. package/resources/hires.js +3 -4
  133. package/resources/hires.js.map +1 -1
  134. package/resources/hires.mjs +3 -4
  135. package/resources/hires.mjs.map +1 -1
  136. package/resources/index.d.mts +2 -0
  137. package/resources/index.d.mts.map +1 -1
  138. package/resources/index.d.ts +2 -0
  139. package/resources/index.d.ts.map +1 -1
  140. package/resources/index.js +7 -2
  141. package/resources/index.js.map +1 -1
  142. package/resources/index.mjs +2 -0
  143. package/resources/index.mjs.map +1 -1
  144. package/resources/listing-submissions.d.mts +1 -1
  145. package/resources/listing-submissions.d.ts +1 -1
  146. package/resources/listing-submissions.js +1 -1
  147. package/resources/listing-submissions.mjs +1 -1
  148. package/resources/listing-transitions.d.mts +1 -1
  149. package/resources/listing-transitions.d.ts +1 -1
  150. package/resources/listing-transitions.js +1 -1
  151. package/resources/listing-transitions.mjs +1 -1
  152. package/resources/listing.d.mts +1 -1
  153. package/resources/listing.d.ts +1 -1
  154. package/resources/listing.js +1 -1
  155. package/resources/listing.mjs +1 -1
  156. package/resources/payroll-payment-mode-changes.d.mts +102 -0
  157. package/resources/payroll-payment-mode-changes.d.mts.map +1 -0
  158. package/resources/payroll-payment-mode-changes.d.ts +102 -0
  159. package/resources/payroll-payment-mode-changes.d.ts.map +1 -0
  160. package/resources/payroll-payment-mode-changes.js +54 -0
  161. package/resources/payroll-payment-mode-changes.js.map +1 -0
  162. package/resources/payroll-payment-mode-changes.mjs +50 -0
  163. package/resources/payroll-payment-mode-changes.mjs.map +1 -0
  164. package/resources/payroll-runs/index.d.mts +1 -0
  165. package/resources/payroll-runs/index.d.mts.map +1 -1
  166. package/resources/payroll-runs/index.d.ts +1 -0
  167. package/resources/payroll-runs/index.d.ts.map +1 -1
  168. package/resources/payroll-runs/index.js +3 -1
  169. package/resources/payroll-runs/index.js.map +1 -1
  170. package/resources/payroll-runs/index.mjs +1 -0
  171. package/resources/payroll-runs/index.mjs.map +1 -1
  172. package/resources/payroll-runs/off-cycle.d.mts +322 -0
  173. package/resources/payroll-runs/off-cycle.d.mts.map +1 -0
  174. package/resources/payroll-runs/off-cycle.d.ts +322 -0
  175. package/resources/payroll-runs/off-cycle.d.ts.map +1 -0
  176. package/resources/payroll-runs/off-cycle.js +112 -0
  177. package/resources/payroll-runs/off-cycle.js.map +1 -0
  178. package/resources/payroll-runs/off-cycle.mjs +108 -0
  179. package/resources/payroll-runs/off-cycle.mjs.map +1 -0
  180. package/resources/payroll-runs/payroll-runs.d.mts +4 -0
  181. package/resources/payroll-runs/payroll-runs.d.mts.map +1 -1
  182. package/resources/payroll-runs/payroll-runs.d.ts +4 -0
  183. package/resources/payroll-runs/payroll-runs.d.ts.map +1 -1
  184. package/resources/payroll-runs/payroll-runs.js +4 -0
  185. package/resources/payroll-runs/payroll-runs.js.map +1 -1
  186. package/resources/payroll-runs/payroll-runs.mjs +4 -0
  187. package/resources/payroll-runs/payroll-runs.mjs.map +1 -1
  188. package/resources/sandboxes.d.mts +17 -11
  189. package/resources/sandboxes.d.mts.map +1 -1
  190. package/resources/sandboxes.d.ts +17 -11
  191. package/resources/sandboxes.d.ts.map +1 -1
  192. package/resources/sandboxes.js +1 -3
  193. package/resources/sandboxes.js.map +1 -1
  194. package/resources/sandboxes.mjs +1 -3
  195. package/resources/sandboxes.mjs.map +1 -1
  196. package/resources/variable-compensation-payout-labels.d.mts +3 -2
  197. package/resources/variable-compensation-payout-labels.d.mts.map +1 -1
  198. package/resources/variable-compensation-payout-labels.d.ts +3 -2
  199. package/resources/variable-compensation-payout-labels.d.ts.map +1 -1
  200. package/resources/variable-compensation-payout-labels.js +3 -2
  201. package/resources/variable-compensation-payout-labels.js.map +1 -1
  202. package/resources/variable-compensation-payout-labels.mjs +3 -2
  203. package/resources/variable-compensation-payout-labels.mjs.map +1 -1
  204. package/resources/variable-compensation-payout-types.d.mts +2 -2
  205. package/resources/variable-compensation-payout-types.d.ts +2 -2
  206. package/resources/variable-compensation-payout-types.js +2 -2
  207. package/resources/variable-compensation-payout-types.mjs +2 -2
  208. package/resources/variable-compensation-payouts.d.mts +5 -2
  209. package/resources/variable-compensation-payouts.d.mts.map +1 -1
  210. package/resources/variable-compensation-payouts.d.ts +5 -2
  211. package/resources/variable-compensation-payouts.d.ts.map +1 -1
  212. package/resources/variable-compensation-payouts.js +5 -2
  213. package/resources/variable-compensation-payouts.js.map +1 -1
  214. package/resources/variable-compensation-payouts.mjs +5 -2
  215. package/resources/variable-compensation-payouts.mjs.map +1 -1
  216. package/src/client.ts +38 -0
  217. package/src/lib/charts/README.md +114 -0
  218. package/src/lib/charts/builders.ts +90 -0
  219. package/src/lib/charts/describe.ts +67 -0
  220. package/src/lib/charts/errors.ts +48 -0
  221. package/src/lib/charts/evaluate.ts +114 -0
  222. package/src/lib/charts/guards.ts +42 -0
  223. package/src/lib/charts/schema.ts +72 -0
  224. package/src/lib/charts/types.ts +113 -0
  225. package/src/lib/charts.ts +43 -0
  226. package/src/lib/manifest/_existing-component-fields.ts +2 -0
  227. package/src/lib/manifest/existing-manifest-context.ts +22 -0
  228. package/src/lib/manifest/workflow/index.ts +64 -0
  229. package/src/resources/activity-log.ts +645 -0
  230. package/src/resources/compensations.ts +1 -1
  231. package/src/resources/developer-program-application.ts +1 -1
  232. package/src/resources/developer-users.ts +2 -1
  233. package/src/resources/hire-requirements.ts +8 -85
  234. package/src/resources/hires.ts +866 -213
  235. package/src/resources/index.ts +13 -0
  236. package/src/resources/listing-submissions.ts +1 -1
  237. package/src/resources/listing-transitions.ts +1 -1
  238. package/src/resources/listing.ts +1 -1
  239. package/src/resources/payroll-payment-mode-changes.ts +121 -0
  240. package/src/resources/payroll-runs/index.ts +1 -0
  241. package/src/resources/payroll-runs/off-cycle.ts +372 -0
  242. package/src/resources/payroll-runs/payroll-runs.ts +10 -0
  243. package/src/resources/sandboxes.ts +17 -11
  244. package/src/resources/variable-compensation-payout-labels.ts +3 -2
  245. package/src/resources/variable-compensation-payout-types.ts +2 -2
  246. package/src/resources/variable-compensation-payouts.ts +5 -2
  247. package/src/version.ts +1 -1
  248. package/version.d.mts +1 -1
  249. package/version.d.ts +1 -1
  250. package/version.js +1 -1
  251. package/version.mjs +1 -1
@@ -0,0 +1,171 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ActivityLog = void 0;
5
+ const resource_1 = require("../core/resource.js");
6
+ const pagination_1 = require("../core/pagination.js");
7
+ const path_1 = require("../internal/utils/path.js");
8
+ /**
9
+ * Visible Activity Log events recorded for the company
10
+ */
11
+ class ActivityLog extends resource_1.APIResource {
12
+ /**
13
+ * Lists only Activity Log events retained from the last 90 days that are visible
14
+ * to the caller. Linked child events are omitted. An occurred_at filter before the
15
+ * retention window returns an empty page, not older history. Full admins and
16
+ * Activity Log admins see company-wide events; other admins see only events for
17
+ * app installations they fully administer. A caller with no administered app
18
+ * installation receives 403. The targets.id filter does not match GROUP or
19
+ * SPOKE_USER targets.
20
+ *
21
+ * - Requires: `Activity Log Platform API`
22
+ * - Filterable fields: `occurred_at`, `event_type`, `worker_id`, `targets.id`,
23
+ * `source_app_handle`
24
+ * - Expandable fields: `worker`
25
+ * - Sortable fields: `id`, `created_at`, `updated_at`, `occurred_at`
26
+ *
27
+ * @example HTTP
28
+ * Representative request and response shapes.
29
+ * ```
30
+ * GET /activity-log/?filter=filter&expand=expand&order_by=order_by&limit=50&cursor=cursor HTTP/1.1
31
+ * Host: rest.ripplingapis.com
32
+ * Accept: application/json
33
+ * Rippling-Api-Version: 2024-08-01
34
+ *
35
+ * HTTP/1.1 200 OK
36
+ * Content-Type: application/json
37
+ *
38
+ * {
39
+ * "__meta": {
40
+ * "redacted_fields": [
41
+ * {
42
+ * "name": "date_of_birth",
43
+ * "reason": "Insufficient entitlements"
44
+ * }
45
+ * ]
46
+ * },
47
+ * "results": [
48
+ * {
49
+ * "id": "string",
50
+ * "created_at": "string",
51
+ * "updated_at": "string",
52
+ * "occurred_at": "string",
53
+ * "event_type": "string",
54
+ * "status": "SUCCESS",
55
+ * "actor_type": "WORKER",
56
+ * "worker_id": "string",
57
+ * "worker": {
58
+ * "id": "string",
59
+ * "created_at": "string",
60
+ * "updated_at": "string",
61
+ * "user_id": "string",
62
+ * "user": {},
63
+ * "is_manager": "string",
64
+ * "manager_id": "string",
65
+ * "manager": {},
66
+ * "legal_entity_id": "string",
67
+ * "legal_entity": {},
68
+ * "country": "AF",
69
+ * "start_date": "string",
70
+ * "end_date": "string",
71
+ * "number": "string",
72
+ * "work_email": "string",
73
+ * "personal_email": "string",
74
+ * "status": "INIT",
75
+ * "location": {},
76
+ * "employment_type_id": "string",
77
+ * "employment_type": {},
78
+ * "gender": "MALE",
79
+ * "date_of_birth": "string",
80
+ * "race": "BLACK",
81
+ * "ethnicity": "HISPANIC_OR_LATINO",
82
+ * "citizenship": "AF",
83
+ * "compensation_id": "string",
84
+ * "compensation": {},
85
+ * "overtime_exemption": "EXEMPT",
86
+ * "department_id": "string",
87
+ * "department": {},
88
+ * "teams_id": [],
89
+ * "teams": [],
90
+ * "title": "string",
91
+ * "title_effective_date": "string",
92
+ * "level_id": "string",
93
+ * "level": {},
94
+ * "job_function_id": "string",
95
+ * "job_function": {},
96
+ * "termination_details": {},
97
+ * "pay_schedule_id": "string",
98
+ * "work_schedule": {},
99
+ * "compensation_grade": {},
100
+ * "original_start_date": "string",
101
+ * "custom_fields": [],
102
+ * "country_fields": {},
103
+ * "business_partners_id": [],
104
+ * "business_partners": []
105
+ * },
106
+ * "targets": [
107
+ * {}
108
+ * ],
109
+ * "source_app_handle": "string",
110
+ * "reason": {
111
+ * "code": "string",
112
+ * "message": "string"
113
+ * },
114
+ * "request_context": {
115
+ * "ip_address": "string",
116
+ * "device": "string",
117
+ * "browser": "string",
118
+ * "operating_system": "string",
119
+ * "city": "string",
120
+ * "state": "string",
121
+ * "country": "string",
122
+ * "latitude": "string",
123
+ * "longitude": "string",
124
+ * "accuracy_radius": "string"
125
+ * }
126
+ * }
127
+ * ],
128
+ * "next_link": "string"
129
+ * }
130
+ * ```
131
+ */
132
+ list(query = {}, options) {
133
+ return this._client.getAPIList('/activity-log/', (pagination_1.PageCursorURL), {
134
+ query,
135
+ ...options,
136
+ });
137
+ }
138
+ /**
139
+ * Retrieves one Activity Log event from the same 90-day visibility set as the list
140
+ * endpoint. Full admins and Activity Log admins can retrieve company-wide events;
141
+ * other admins can retrieve only events for app installations they fully
142
+ * administer. An admin with no administered app installation receives 403. An ID
143
+ * outside that visibility set, including an event for an installation the caller
144
+ * does not administer, returns 404.
145
+ *
146
+ * @example HTTP
147
+ * Representative request and response shapes.
148
+ * ```
149
+ * GET /activity-log/{id}/?expand=expand HTTP/1.1
150
+ * Host: rest.ripplingapis.com
151
+ * Accept: application/json
152
+ * Rippling-Api-Version: 2024-08-01
153
+ *
154
+ * HTTP/1.1 200 OK
155
+ * Content-Type: application/json
156
+ *
157
+ * {
158
+ * "__meta": {
159
+ * "redacted_fields": [
160
+ * {}
161
+ * ]
162
+ * }
163
+ * }
164
+ * ```
165
+ */
166
+ retrieve(id, query = {}, options) {
167
+ return this._client.get((0, path_1.path) `/activity-log/${id}/`, { query, ...options });
168
+ }
169
+ }
170
+ exports.ActivityLog = ActivityLog;
171
+ //# sourceMappingURL=activity-log.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"activity-log.js","sourceRoot":"","sources":["../src/resources/activity-log.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuHG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,0BAAsC,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,QAAQ,CACN,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AAtKD,kCAsKC"}
@@ -0,0 +1,167 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../core/resource.mjs";
3
+ import { PageCursorURL } from "../core/pagination.mjs";
4
+ import { path } from "../internal/utils/path.mjs";
5
+ /**
6
+ * Visible Activity Log events recorded for the company
7
+ */
8
+ export class ActivityLog extends APIResource {
9
+ /**
10
+ * Lists only Activity Log events retained from the last 90 days that are visible
11
+ * to the caller. Linked child events are omitted. An occurred_at filter before the
12
+ * retention window returns an empty page, not older history. Full admins and
13
+ * Activity Log admins see company-wide events; other admins see only events for
14
+ * app installations they fully administer. A caller with no administered app
15
+ * installation receives 403. The targets.id filter does not match GROUP or
16
+ * SPOKE_USER targets.
17
+ *
18
+ * - Requires: `Activity Log Platform API`
19
+ * - Filterable fields: `occurred_at`, `event_type`, `worker_id`, `targets.id`,
20
+ * `source_app_handle`
21
+ * - Expandable fields: `worker`
22
+ * - Sortable fields: `id`, `created_at`, `updated_at`, `occurred_at`
23
+ *
24
+ * @example HTTP
25
+ * Representative request and response shapes.
26
+ * ```
27
+ * GET /activity-log/?filter=filter&expand=expand&order_by=order_by&limit=50&cursor=cursor HTTP/1.1
28
+ * Host: rest.ripplingapis.com
29
+ * Accept: application/json
30
+ * Rippling-Api-Version: 2024-08-01
31
+ *
32
+ * HTTP/1.1 200 OK
33
+ * Content-Type: application/json
34
+ *
35
+ * {
36
+ * "__meta": {
37
+ * "redacted_fields": [
38
+ * {
39
+ * "name": "date_of_birth",
40
+ * "reason": "Insufficient entitlements"
41
+ * }
42
+ * ]
43
+ * },
44
+ * "results": [
45
+ * {
46
+ * "id": "string",
47
+ * "created_at": "string",
48
+ * "updated_at": "string",
49
+ * "occurred_at": "string",
50
+ * "event_type": "string",
51
+ * "status": "SUCCESS",
52
+ * "actor_type": "WORKER",
53
+ * "worker_id": "string",
54
+ * "worker": {
55
+ * "id": "string",
56
+ * "created_at": "string",
57
+ * "updated_at": "string",
58
+ * "user_id": "string",
59
+ * "user": {},
60
+ * "is_manager": "string",
61
+ * "manager_id": "string",
62
+ * "manager": {},
63
+ * "legal_entity_id": "string",
64
+ * "legal_entity": {},
65
+ * "country": "AF",
66
+ * "start_date": "string",
67
+ * "end_date": "string",
68
+ * "number": "string",
69
+ * "work_email": "string",
70
+ * "personal_email": "string",
71
+ * "status": "INIT",
72
+ * "location": {},
73
+ * "employment_type_id": "string",
74
+ * "employment_type": {},
75
+ * "gender": "MALE",
76
+ * "date_of_birth": "string",
77
+ * "race": "BLACK",
78
+ * "ethnicity": "HISPANIC_OR_LATINO",
79
+ * "citizenship": "AF",
80
+ * "compensation_id": "string",
81
+ * "compensation": {},
82
+ * "overtime_exemption": "EXEMPT",
83
+ * "department_id": "string",
84
+ * "department": {},
85
+ * "teams_id": [],
86
+ * "teams": [],
87
+ * "title": "string",
88
+ * "title_effective_date": "string",
89
+ * "level_id": "string",
90
+ * "level": {},
91
+ * "job_function_id": "string",
92
+ * "job_function": {},
93
+ * "termination_details": {},
94
+ * "pay_schedule_id": "string",
95
+ * "work_schedule": {},
96
+ * "compensation_grade": {},
97
+ * "original_start_date": "string",
98
+ * "custom_fields": [],
99
+ * "country_fields": {},
100
+ * "business_partners_id": [],
101
+ * "business_partners": []
102
+ * },
103
+ * "targets": [
104
+ * {}
105
+ * ],
106
+ * "source_app_handle": "string",
107
+ * "reason": {
108
+ * "code": "string",
109
+ * "message": "string"
110
+ * },
111
+ * "request_context": {
112
+ * "ip_address": "string",
113
+ * "device": "string",
114
+ * "browser": "string",
115
+ * "operating_system": "string",
116
+ * "city": "string",
117
+ * "state": "string",
118
+ * "country": "string",
119
+ * "latitude": "string",
120
+ * "longitude": "string",
121
+ * "accuracy_radius": "string"
122
+ * }
123
+ * }
124
+ * ],
125
+ * "next_link": "string"
126
+ * }
127
+ * ```
128
+ */
129
+ list(query = {}, options) {
130
+ return this._client.getAPIList('/activity-log/', (PageCursorURL), {
131
+ query,
132
+ ...options,
133
+ });
134
+ }
135
+ /**
136
+ * Retrieves one Activity Log event from the same 90-day visibility set as the list
137
+ * endpoint. Full admins and Activity Log admins can retrieve company-wide events;
138
+ * other admins can retrieve only events for app installations they fully
139
+ * administer. An admin with no administered app installation receives 403. An ID
140
+ * outside that visibility set, including an event for an installation the caller
141
+ * does not administer, returns 404.
142
+ *
143
+ * @example HTTP
144
+ * Representative request and response shapes.
145
+ * ```
146
+ * GET /activity-log/{id}/?expand=expand HTTP/1.1
147
+ * Host: rest.ripplingapis.com
148
+ * Accept: application/json
149
+ * Rippling-Api-Version: 2024-08-01
150
+ *
151
+ * HTTP/1.1 200 OK
152
+ * Content-Type: application/json
153
+ *
154
+ * {
155
+ * "__meta": {
156
+ * "redacted_fields": [
157
+ * {}
158
+ * ]
159
+ * }
160
+ * }
161
+ * ```
162
+ */
163
+ retrieve(id, query = {}, options) {
164
+ return this._client.get(path `/activity-log/${id}/`, { query, ...options });
165
+ }
166
+ }
167
+ //# sourceMappingURL=activity-log.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"activity-log.mjs","sourceRoot":"","sources":["../src/resources/activity-log.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuHG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,aAAsC,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,QAAQ,CACN,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}
@@ -9,7 +9,7 @@ import { RequestOptions } from "../internal/request-options.mjs";
9
9
  */
10
10
  export declare class Compensations extends APIResource {
11
11
  /**
12
- * A list of compensations.
12
+ * Paginates through the compensation the authenticated user has access to.
13
13
  *
14
14
  * - Requires: `API Tier 1`
15
15
  * - Expandable fields: `worker`
@@ -9,7 +9,7 @@ import { RequestOptions } from "../internal/request-options.js";
9
9
  */
10
10
  export declare class Compensations extends APIResource {
11
11
  /**
12
- * A list of compensations.
12
+ * Paginates through the compensation the authenticated user has access to.
13
13
  *
14
14
  * - Requires: `API Tier 1`
15
15
  * - Expandable fields: `worker`
@@ -10,7 +10,7 @@ const path_1 = require("../internal/utils/path.js");
10
10
  */
11
11
  class Compensations extends resource_1.APIResource {
12
12
  /**
13
- * A list of compensations.
13
+ * Paginates through the compensation the authenticated user has access to.
14
14
  *
15
15
  * - Requires: `API Tier 1`
16
16
  * - Expandable fields: `worker`
@@ -7,7 +7,7 @@ import { path } from "../internal/utils/path.mjs";
7
7
  */
8
8
  export class Compensations extends APIResource {
9
9
  /**
10
- * A list of compensations.
10
+ * Paginates through the compensation the authenticated user has access to.
11
11
  *
12
12
  * - Requires: `API Tier 1`
13
13
  * - Expandable fields: `worker`
@@ -7,7 +7,7 @@ import { RequestOptions } from "../internal/request-options.mjs";
7
7
  */
8
8
  export declare class DeveloperProgramApplication extends APIResource {
9
9
  /**
10
- * A list of developer program application.
10
+ * Get the Developer Program application for the authenticated company.
11
11
  *
12
12
  * - Requires: `Developer Program`
13
13
  *
@@ -7,7 +7,7 @@ import { RequestOptions } from "../internal/request-options.js";
7
7
  */
8
8
  export declare class DeveloperProgramApplication extends APIResource {
9
9
  /**
10
- * A list of developer program application.
10
+ * Get the Developer Program application for the authenticated company.
11
11
  *
12
12
  * - Requires: `Developer Program`
13
13
  *
@@ -9,7 +9,7 @@ const pagination_1 = require("../core/pagination.js");
9
9
  */
10
10
  class DeveloperProgramApplication extends resource_1.APIResource {
11
11
  /**
12
- * A list of developer program application.
12
+ * Get the Developer Program application for the authenticated company.
13
13
  *
14
14
  * - Requires: `Developer Program`
15
15
  *
@@ -6,7 +6,7 @@ import { PageCursorURL } from "../core/pagination.mjs";
6
6
  */
7
7
  export class DeveloperProgramApplication extends APIResource {
8
8
  /**
9
- * A list of developer program application.
9
+ * Get the Developer Program application for the authenticated company.
10
10
  *
11
11
  * - Requires: `Developer Program`
12
12
  *
@@ -6,7 +6,8 @@ import { RequestOptions } from "../internal/request-options.mjs";
6
6
  */
7
7
  export declare class DeveloperUsers extends APIResource {
8
8
  /**
9
- * A list of App Shop publisher users.
9
+ * List App Shop Publishers Super Group members for the authenticated company.
10
+ * Filterable: email, role_state.
10
11
  *
11
12
  * - Requires: `Developer Program`
12
13
  * - Filterable fields: `email`, `role_state`
@@ -1 +1 @@
1
- {"version":3,"file":"developer-users.d.mts","sourceRoot":"","sources":["../src/resources/developer-users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,IAAI,CACF,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,yBAAyB,CAAC;CAMnF;AAED,MAAM,MAAM,uCAAuC,GAAG,aAAa,CAAC,yBAAyB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,YAAY,CAAC;CACtE;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
1
+ {"version":3,"file":"developer-users.d.mts","sourceRoot":"","sources":["../src/resources/developer-users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,IAAI,CACF,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,yBAAyB,CAAC;CAMnF;AAED,MAAM,MAAM,uCAAuC,GAAG,aAAa,CAAC,yBAAyB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,YAAY,CAAC;CACtE;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
@@ -6,7 +6,8 @@ import { RequestOptions } from "../internal/request-options.js";
6
6
  */
7
7
  export declare class DeveloperUsers extends APIResource {
8
8
  /**
9
- * A list of App Shop publisher users.
9
+ * List App Shop Publishers Super Group members for the authenticated company.
10
+ * Filterable: email, role_state.
10
11
  *
11
12
  * - Requires: `Developer Program`
12
13
  * - Filterable fields: `email`, `role_state`
@@ -1 +1 @@
1
- {"version":3,"file":"developer-users.d.ts","sourceRoot":"","sources":["../src/resources/developer-users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,IAAI,CACF,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,yBAAyB,CAAC;CAMnF;AAED,MAAM,MAAM,uCAAuC,GAAG,aAAa,CAAC,yBAAyB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,YAAY,CAAC;CACtE;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
1
+ {"version":3,"file":"developer-users.d.ts","sourceRoot":"","sources":["../src/resources/developer-users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,IAAI,CACF,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,yBAAyB,CAAC;CAMnF;AAED,MAAM,MAAM,uCAAuC,GAAG,aAAa,CAAC,yBAAyB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,YAAY,CAAC;CACtE;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
@@ -9,7 +9,8 @@ const pagination_1 = require("../core/pagination.js");
9
9
  */
10
10
  class DeveloperUsers extends resource_1.APIResource {
11
11
  /**
12
- * A list of App Shop publisher users.
12
+ * List App Shop Publishers Super Group members for the authenticated company.
13
+ * Filterable: email, role_state.
13
14
  *
14
15
  * - Requires: `Developer Program`
15
16
  * - Filterable fields: `email`, `role_state`
@@ -1 +1 @@
1
- {"version":3,"file":"developer-users.js","sourceRoot":"","sources":["../src/resources/developer-users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAC/C,sDAAgE;AAGhE;;GAEG;AACH,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,IAAI,CACF,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,0BAAwC,CAAA,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAjDD,wCAiDC"}
1
+ {"version":3,"file":"developer-users.js","sourceRoot":"","sources":["../src/resources/developer-users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAC/C,sDAAgE;AAGhE;;GAEG;AACH,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,IAAI,CACF,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,0BAAwC,CAAA,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAlDD,wCAkDC"}
@@ -6,7 +6,8 @@ import { PageCursorURL } from "../core/pagination.mjs";
6
6
  */
7
7
  export class DeveloperUsers extends APIResource {
8
8
  /**
9
- * A list of App Shop publisher users.
9
+ * List App Shop Publishers Super Group members for the authenticated company.
10
+ * Filterable: email, role_state.
10
11
  *
11
12
  * - Requires: `Developer Program`
12
13
  * - Filterable fields: `email`, `role_state`
@@ -1 +1 @@
1
- {"version":3,"file":"developer-users.mjs","sourceRoot":"","sources":["../src/resources/developer-users.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAGhE;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,IAAI,CACF,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,aAAwC,CAAA,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"developer-users.mjs","sourceRoot":"","sources":["../src/resources/developer-users.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAGhE;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,IAAI,CACF,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,aAAwC,CAAA,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -6,8 +6,9 @@ import { RequestOptions } from "../internal/request-options.mjs";
6
6
  */
7
7
  export declare class HireRequirements extends APIResource {
8
8
  /**
9
- * Return baseline required fields for a country and hire type. POST /hires/
10
- * remains authoritative for company-specific validation.
9
+ * Return baseline required fields for a country and hire type.
10
+ * requirements_version identifies this catalog snapshot. POST /hires/ does not
11
+ * accept it. POST /hires/ remains authoritative for company-specific validation.
11
12
  *
12
13
  * @example HTTP
13
14
  * Representative request and response shapes.
@@ -27,23 +28,6 @@ export declare class HireRequirements extends APIResource {
27
28
  * "required_groups": [
28
29
  * "string"
29
30
  * ],
30
- * "top_level_fields": [
31
- * {
32
- * "field": "string",
33
- * "type": {},
34
- * "requiredness": "string",
35
- * "required_when": {
36
- * "field": "string",
37
- * "operator": "string",
38
- * "value": {}
39
- * },
40
- * "format": "string",
41
- * "items": null,
42
- * "fields": [
43
- * "string"
44
- * ]
45
- * }
46
- * ],
47
31
  * "fields_by_group": [
48
32
  * null
49
33
  * ],
@@ -71,21 +55,18 @@ export interface HireRequirementListResponse {
71
55
  */
72
56
  fields_by_group: Array<unknown>;
73
57
  /**
74
- * Hire type used for the lookup.
58
+ * Hire type for this catalog. POST /hires/ uses the same value. An omitted POST
59
+ * value defaults to direct_hire.
75
60
  */
76
61
  hire_type: string;
77
62
  /**
78
- * Catalog groups that apply for this selector tuple.
63
+ * Groups you must send for this country.
79
64
  */
80
65
  required_groups: Array<string>;
81
66
  /**
82
67
  * Baseline requirement contract version for this selector tuple.
83
68
  */
84
69
  requirements_version: string;
85
- /**
86
- * Item-level fields such as client_request_id.
87
- */
88
- top_level_fields?: Array<HireRequirementListResponse.TopLevelField>;
89
70
  /**
90
71
  * Public field paths that are not writable for this selector tuple.
91
72
  */
@@ -95,57 +76,10 @@ export interface HireRequirementListResponse {
95
76
  */
96
77
  warnings?: Array<string>;
97
78
  }
98
- export declare namespace HireRequirementListResponse {
99
- interface TopLevelField {
100
- /**
101
- * JSON type string, or a list of allowed types for custom-field values.
102
- */
103
- type: unknown;
104
- /**
105
- * Public field name relative to its group, or omitted for array item descriptors.
106
- */
107
- field?: string;
108
- /**
109
- * Nested object fields when type is object.
110
- */
111
- fields?: Array<unknown>;
112
- /**
113
- * date means YYYY-MM-DD.
114
- */
115
- format?: string;
116
- items?: unknown;
117
- /**
118
- * Sibling-field condition when requiredness is dependent.
119
- */
120
- required_when?: TopLevelField.RequiredWhen;
121
- /**
122
- * required, optional, or dependent.
123
- */
124
- requiredness?: string;
125
- }
126
- namespace TopLevelField {
127
- /**
128
- * Sibling-field condition when requiredness is dependent.
129
- */
130
- interface RequiredWhen {
131
- /**
132
- * Sibling field in the same object that this condition inspects.
133
- */
134
- field: string;
135
- /**
136
- * equals, not_equals, present, or absent.
137
- */
138
- operator: string;
139
- /**
140
- * Comparison value for equals and not_equals. Omitted for present and absent.
141
- */
142
- value?: unknown;
143
- }
144
- }
145
- }
146
79
  export interface HireRequirementListParams {
147
80
  /**
148
- * ISO 3166-1 alpha-2 country code. First milestone supports US and CA.
81
+ * ISO 3166-1 alpha-2 country code. Direct hire is supported in AU, CA, CH, CN, DE,
82
+ * ES, FR, GB, HK, IE, IN, NL, NZ, and US.
149
83
  */
150
84
  country_code: string;
151
85
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"hire-requirements.d.mts","sourceRoot":"","sources":["../src/resources/hire-requirements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,IAAI,CAAC,KAAK,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAG1G;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC;IAEpE;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,aAAa;QAC5B;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAExB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC;QAE3C;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,CAAC,EAAE,OAAO,CAAC;SACjB;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
1
+ {"version":3,"file":"hire-requirements.d.mts","sourceRoot":"","sources":["../src/resources/hire-requirements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CAAC,KAAK,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAG1G;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}