@rippling/rippling-sdk 0.2.0-alpha.33 → 0.2.0-alpha.34

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 (178) hide show
  1. package/client.d.mts +8 -2
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +8 -2
  4. package/client.d.ts.map +1 -1
  5. package/client.js +17 -0
  6. package/client.js.map +1 -1
  7. package/client.mjs +17 -0
  8. package/client.mjs.map +1 -1
  9. package/internal/types.d.mts +6 -6
  10. package/internal/types.d.mts.map +1 -1
  11. package/internal/types.d.ts +6 -6
  12. package/internal/types.d.ts.map +1 -1
  13. package/lib/manifest/_helpers.d.mts +91 -0
  14. package/lib/manifest/_helpers.d.mts.map +1 -0
  15. package/lib/manifest/_helpers.d.ts +91 -0
  16. package/lib/manifest/_helpers.d.ts.map +1 -0
  17. package/lib/manifest/_helpers.js +65 -0
  18. package/lib/manifest/_helpers.js.map +1 -0
  19. package/lib/manifest/_helpers.mjs +61 -0
  20. package/lib/manifest/_helpers.mjs.map +1 -0
  21. package/lib/manifest/app.d.mts +45 -0
  22. package/lib/manifest/app.d.mts.map +1 -0
  23. package/lib/manifest/app.d.ts +45 -0
  24. package/lib/manifest/app.d.ts.map +1 -0
  25. package/lib/manifest/app.js +74 -0
  26. package/lib/manifest/app.js.map +1 -0
  27. package/lib/manifest/app.mjs +70 -0
  28. package/lib/manifest/app.mjs.map +1 -0
  29. package/lib/manifest/category.d.mts +23 -0
  30. package/lib/manifest/category.d.mts.map +1 -0
  31. package/lib/manifest/category.d.ts +23 -0
  32. package/lib/manifest/category.d.ts.map +1 -0
  33. package/lib/manifest/category.js +37 -0
  34. package/lib/manifest/category.js.map +1 -0
  35. package/lib/manifest/category.mjs +33 -0
  36. package/lib/manifest/category.mjs.map +1 -0
  37. package/lib/manifest/custom-object-field-section.d.mts +21 -0
  38. package/lib/manifest/custom-object-field-section.d.mts.map +1 -0
  39. package/lib/manifest/custom-object-field-section.d.ts +21 -0
  40. package/lib/manifest/custom-object-field-section.d.ts.map +1 -0
  41. package/lib/manifest/custom-object-field-section.js +42 -0
  42. package/lib/manifest/custom-object-field-section.js.map +1 -0
  43. package/lib/manifest/custom-object-field-section.mjs +38 -0
  44. package/lib/manifest/custom-object-field-section.mjs.map +1 -0
  45. package/lib/manifest/custom-object-page-layout.d.mts +158 -0
  46. package/lib/manifest/custom-object-page-layout.d.mts.map +1 -0
  47. package/lib/manifest/custom-object-page-layout.d.ts +158 -0
  48. package/lib/manifest/custom-object-page-layout.d.ts.map +1 -0
  49. package/lib/manifest/custom-object-page-layout.js +112 -0
  50. package/lib/manifest/custom-object-page-layout.js.map +1 -0
  51. package/lib/manifest/custom-object-page-layout.mjs +108 -0
  52. package/lib/manifest/custom-object-page-layout.mjs.map +1 -0
  53. package/lib/manifest/custom-object.d.mts +52 -0
  54. package/lib/manifest/custom-object.d.mts.map +1 -0
  55. package/lib/manifest/custom-object.d.ts +52 -0
  56. package/lib/manifest/custom-object.d.ts.map +1 -0
  57. package/lib/manifest/custom-object.js +219 -0
  58. package/lib/manifest/custom-object.js.map +1 -0
  59. package/lib/manifest/custom-object.mjs +215 -0
  60. package/lib/manifest/custom-object.mjs.map +1 -0
  61. package/lib/manifest/field.d.mts +276 -0
  62. package/lib/manifest/field.d.mts.map +1 -0
  63. package/lib/manifest/field.d.ts +276 -0
  64. package/lib/manifest/field.d.ts.map +1 -0
  65. package/lib/manifest/field.js +418 -0
  66. package/lib/manifest/field.js.map +1 -0
  67. package/lib/manifest/field.mjs +395 -0
  68. package/lib/manifest/field.mjs.map +1 -0
  69. package/lib/manifest/index.d.mts +15 -0
  70. package/lib/manifest/index.d.mts.map +1 -0
  71. package/lib/manifest/index.d.ts +15 -0
  72. package/lib/manifest/index.d.ts.map +1 -0
  73. package/lib/manifest/index.js +53 -0
  74. package/lib/manifest/index.js.map +1 -0
  75. package/lib/manifest/index.mjs +18 -0
  76. package/lib/manifest/index.mjs.map +1 -0
  77. package/lib/manifest/list-view.d.mts +47 -0
  78. package/lib/manifest/list-view.d.mts.map +1 -0
  79. package/lib/manifest/list-view.d.ts +47 -0
  80. package/lib/manifest/list-view.d.ts.map +1 -0
  81. package/lib/manifest/list-view.js +73 -0
  82. package/lib/manifest/list-view.js.map +1 -0
  83. package/lib/manifest/list-view.mjs +69 -0
  84. package/lib/manifest/list-view.mjs.map +1 -0
  85. package/lib/manifest/manifest-builder.d.mts +44 -0
  86. package/lib/manifest/manifest-builder.d.mts.map +1 -0
  87. package/lib/manifest/manifest-builder.d.ts +44 -0
  88. package/lib/manifest/manifest-builder.d.ts.map +1 -0
  89. package/lib/manifest/manifest-builder.js +69 -0
  90. package/lib/manifest/manifest-builder.js.map +1 -0
  91. package/lib/manifest/manifest-builder.mjs +65 -0
  92. package/lib/manifest/manifest-builder.mjs.map +1 -0
  93. package/lib/manifest/manifest-function.d.mts +39 -0
  94. package/lib/manifest/manifest-function.d.mts.map +1 -0
  95. package/lib/manifest/manifest-function.d.ts +39 -0
  96. package/lib/manifest/manifest-function.d.ts.map +1 -0
  97. package/lib/manifest/manifest-function.js +56 -0
  98. package/lib/manifest/manifest-function.js.map +1 -0
  99. package/lib/manifest/manifest-function.mjs +52 -0
  100. package/lib/manifest/manifest-function.mjs.map +1 -0
  101. package/lib/manifest/rule.d.mts +50 -0
  102. package/lib/manifest/rule.d.mts.map +1 -0
  103. package/lib/manifest/rule.d.ts +50 -0
  104. package/lib/manifest/rule.d.ts.map +1 -0
  105. package/lib/manifest/rule.js +84 -0
  106. package/lib/manifest/rule.js.map +1 -0
  107. package/lib/manifest/rule.mjs +80 -0
  108. package/lib/manifest/rule.mjs.map +1 -0
  109. package/lib/manifest/sdui-page.d.mts +33 -0
  110. package/lib/manifest/sdui-page.d.mts.map +1 -0
  111. package/lib/manifest/sdui-page.d.ts +33 -0
  112. package/lib/manifest/sdui-page.d.ts.map +1 -0
  113. package/lib/manifest/sdui-page.js +52 -0
  114. package/lib/manifest/sdui-page.js.map +1 -0
  115. package/lib/manifest/sdui-page.mjs +48 -0
  116. package/lib/manifest/sdui-page.mjs.map +1 -0
  117. package/lib/manifest/validation.d.mts +41 -0
  118. package/lib/manifest/validation.d.mts.map +1 -0
  119. package/lib/manifest/validation.d.ts +41 -0
  120. package/lib/manifest/validation.d.ts.map +1 -0
  121. package/lib/manifest/validation.js +57 -0
  122. package/lib/manifest/validation.js.map +1 -0
  123. package/lib/manifest/validation.mjs +53 -0
  124. package/lib/manifest/validation.mjs.map +1 -0
  125. package/package.json +11 -1
  126. package/resources/draft-hires.d.mts +22 -0
  127. package/resources/draft-hires.d.mts.map +1 -1
  128. package/resources/draft-hires.d.ts +22 -0
  129. package/resources/draft-hires.d.ts.map +1 -1
  130. package/resources/earnings-inputs.d.mts +99 -1
  131. package/resources/earnings-inputs.d.mts.map +1 -1
  132. package/resources/earnings-inputs.d.ts +99 -1
  133. package/resources/earnings-inputs.d.ts.map +1 -1
  134. package/resources/earnings-inputs.js +6 -0
  135. package/resources/earnings-inputs.js.map +1 -1
  136. package/resources/earnings-inputs.mjs +6 -0
  137. package/resources/earnings-inputs.mjs.map +1 -1
  138. package/resources/files.d.mts +149 -0
  139. package/resources/files.d.mts.map +1 -0
  140. package/resources/files.d.ts +149 -0
  141. package/resources/files.d.ts.map +1 -0
  142. package/resources/files.js +25 -0
  143. package/resources/files.js.map +1 -0
  144. package/resources/files.mjs +21 -0
  145. package/resources/files.mjs.map +1 -0
  146. package/resources/index.d.mts +2 -1
  147. package/resources/index.d.mts.map +1 -1
  148. package/resources/index.d.ts +2 -1
  149. package/resources/index.d.ts.map +1 -1
  150. package/resources/index.js +4 -2
  151. package/resources/index.js.map +1 -1
  152. package/resources/index.mjs +1 -0
  153. package/resources/index.mjs.map +1 -1
  154. package/src/client.ts +29 -0
  155. package/src/internal/types.ts +6 -8
  156. package/src/lib/manifest/_helpers.ts +164 -0
  157. package/src/lib/manifest/app.ts +108 -0
  158. package/src/lib/manifest/category.ts +51 -0
  159. package/src/lib/manifest/custom-object-field-section.ts +54 -0
  160. package/src/lib/manifest/custom-object-page-layout.ts +292 -0
  161. package/src/lib/manifest/custom-object.ts +269 -0
  162. package/src/lib/manifest/field.ts +632 -0
  163. package/src/lib/manifest/index.ts +114 -0
  164. package/src/lib/manifest/list-view.ts +103 -0
  165. package/src/lib/manifest/manifest-builder.ts +97 -0
  166. package/src/lib/manifest/manifest-function.ts +81 -0
  167. package/src/lib/manifest/rule.ts +125 -0
  168. package/src/lib/manifest/sdui-page.ts +72 -0
  169. package/src/lib/manifest/validation.ts +87 -0
  170. package/src/resources/draft-hires.ts +26 -0
  171. package/src/resources/earnings-inputs.ts +127 -0
  172. package/src/resources/files.ts +186 -0
  173. package/src/resources/index.ts +3 -0
  174. package/src/version.ts +1 -1
  175. package/version.d.mts +1 -1
  176. package/version.d.ts +1 -1
  177. package/version.js +1 -1
  178. package/version.mjs +1 -1
@@ -118,6 +118,11 @@ export namespace DraftHireCreateParams {
118
118
  * Custom fields for the draft hire
119
119
  */
120
120
  custom_fields?: Array<DraftHire.CustomField>;
121
+
122
+ /**
123
+ * Documents to attach to this draft hire
124
+ */
125
+ documents?: Array<DraftHire.Document>;
121
126
  }
122
127
 
123
128
  export namespace DraftHire {
@@ -538,6 +543,27 @@ export namespace DraftHireCreateParams {
538
543
  */
539
544
  field_value: unknown;
540
545
  }
546
+
547
+ /**
548
+ * A document to attach to a draft hire, referencing a pre-uploaded file.
549
+ */
550
+ export interface Document {
551
+ /**
552
+ * Id of a FileUploadTracker in ACTIVE status whose file should become a document
553
+ * on the hire
554
+ */
555
+ file_id: string;
556
+
557
+ /**
558
+ * Document name. Defaults to the uploaded file name when omitted.
559
+ */
560
+ name?: string;
561
+
562
+ /**
563
+ * Signature date in YYYY-MM-DD format.
564
+ */
565
+ signature_date?: string;
566
+ }
541
567
  }
542
568
  }
543
569
 
@@ -22,6 +22,16 @@ export class EarningsInputs extends APIResource {
22
22
  return this._client.getAPIList('/earnings-inputs/', PageCursorURL<EarningsInputListResponse>, options);
23
23
  }
24
24
 
25
+ /**
26
+ * Create a new earnings-input
27
+ */
28
+ create(
29
+ body: EarningsInputCreateParams | null | undefined = {},
30
+ options?: RequestOptions,
31
+ ): APIPromise<EarningsInputCreateResponse> {
32
+ return this._client.post('/earnings-inputs/', { body, ...options });
33
+ }
34
+
25
35
  /**
26
36
  * Delete a earnings-input
27
37
  */
@@ -98,9 +108,126 @@ export interface EarningsInputListResponse {
98
108
  worker_id?: string;
99
109
  }
100
110
 
111
+ /**
112
+ * V2 DTO representing an external earnings input record.
113
+ *
114
+ * Used by:
115
+ * - GET /earnings-inputs/ (list)
116
+ */
117
+ export interface EarningsInputCreateResponse {
118
+ /**
119
+ * Unique identifier for the earnings input.
120
+ */
121
+ id?: string;
122
+
123
+ /**
124
+ * Earning amount as a string-encoded decimal.
125
+ */
126
+ amount?: string;
127
+
128
+ /**
129
+ * How the earning is assigned (e.g. BY_PAY_PERIOD).
130
+ */
131
+ assignment_type?: string;
132
+
133
+ /**
134
+ * Code identifying the earning type (e.g. regular_salary).
135
+ */
136
+ earning_code?: string;
137
+
138
+ /**
139
+ * External reference identifier for this earning.
140
+ */
141
+ external_id?: string;
142
+
143
+ /**
144
+ * Hours associated with this earning as a string-encoded decimal.
145
+ */
146
+ hours?: string;
147
+
148
+ /**
149
+ * The pay period basis date for this earning.
150
+ */
151
+ pay_period_basis_date?: string;
152
+
153
+ /**
154
+ * Identifier of the payroll run this earning is assigned to, if any.
155
+ */
156
+ run_id?: string;
157
+
158
+ /**
159
+ * Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED).
160
+ */
161
+ status?: string;
162
+
163
+ /**
164
+ * Time tracking labels associated with this earning.
165
+ */
166
+ time_labels?: Array<string>;
167
+
168
+ /**
169
+ * Identifier of the worker (role ID).
170
+ */
171
+ worker_id?: string;
172
+ }
173
+
174
+ export interface EarningsInputCreateParams {
175
+ /**
176
+ * Earning amount as a string-encoded decimal.
177
+ */
178
+ amount?: string;
179
+
180
+ /**
181
+ * How the earning is assigned (e.g. BY_PAY_PERIOD).
182
+ */
183
+ assignment_type?: string;
184
+
185
+ /**
186
+ * Code identifying the earning type (e.g. regular_salary).
187
+ */
188
+ earning_code?: string;
189
+
190
+ /**
191
+ * External reference identifier for this earning.
192
+ */
193
+ external_id?: string;
194
+
195
+ /**
196
+ * Hours associated with this earning as a string-encoded decimal.
197
+ */
198
+ hours?: string;
199
+
200
+ /**
201
+ * The pay period basis date for this earning.
202
+ */
203
+ pay_period_basis_date?: string;
204
+
205
+ /**
206
+ * Identifier of the payroll run this earning is assigned to, if any.
207
+ */
208
+ run_id?: string;
209
+
210
+ /**
211
+ * Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED).
212
+ */
213
+ status?: string;
214
+
215
+ /**
216
+ * Time tracking labels associated with this earning.
217
+ */
218
+ time_labels?: Array<string>;
219
+
220
+ /**
221
+ * Identifier of the worker (role ID).
222
+ */
223
+ worker_id?: string;
224
+ }
225
+
101
226
  export declare namespace EarningsInputs {
102
227
  export {
103
228
  type EarningsInputListResponse as EarningsInputListResponse,
229
+ type EarningsInputCreateResponse as EarningsInputCreateResponse,
104
230
  type EarningsInputListResponsesPageCursorURL as EarningsInputListResponsesPageCursorURL,
231
+ type EarningsInputCreateParams as EarningsInputCreateParams,
105
232
  };
106
233
  }
@@ -0,0 +1,186 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../core/resource';
4
+ import * as BusinessPartnersAPI from './business-partners';
5
+ import { APIPromise } from '../core/api-promise';
6
+ import { RequestOptions } from '../internal/request-options';
7
+ import { path } from '../internal/utils/path';
8
+
9
+ /**
10
+ * Generate presigned URLs to upload files to Rippling storage
11
+ */
12
+ export class Files extends APIResource {
13
+ /**
14
+ * Retrieve a specific file
15
+ */
16
+ retrieve(id: string, options?: RequestOptions): APIPromise<FileRetrieveResponse> {
17
+ return this._client.get(path`/files/${id}/`, options);
18
+ }
19
+
20
+ /**
21
+ * Create a new file
22
+ */
23
+ create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileCreateResponse> {
24
+ return this._client.post('/files/', { body, ...options });
25
+ }
26
+ }
27
+
28
+ /**
29
+ * Meta information for the response.
30
+ */
31
+ export interface FileRetrieveResponse extends BusinessPartnersAPI.Meta {
32
+ /**
33
+ * Opaque identifier for this file
34
+ */
35
+ id: string;
36
+
37
+ /**
38
+ * Lifecycle status: awaiting_upload | uploaded | active | infected
39
+ */
40
+ status: string;
41
+
42
+ /**
43
+ * MIME type supplied by the client at create time
44
+ */
45
+ content_type?: string;
46
+
47
+ /**
48
+ * Human-readable label for the file
49
+ */
50
+ display_name?: string;
51
+
52
+ /**
53
+ * Required form fields to include in the multipart POST to S3 alongside the file
54
+ * binary
55
+ */
56
+ upload_fields?: unknown;
57
+
58
+ /**
59
+ * S3 endpoint URL — POST your multipart form here to upload the file. Present only
60
+ * in the create response.
61
+ */
62
+ upload_url?: string;
63
+
64
+ /**
65
+ * URLs for accessing the uploaded file after a successful upload
66
+ */
67
+ url_data?: FileRetrieveResponse.URLData;
68
+ }
69
+
70
+ export namespace FileRetrieveResponse {
71
+ /**
72
+ * URLs for accessing the uploaded file after a successful upload
73
+ */
74
+ export interface URLData {
75
+ /**
76
+ * CDN URL for previewing the uploaded file after upload completes
77
+ */
78
+ preview_url?: string;
79
+
80
+ /**
81
+ * S3 URL where the file is accessible after upload
82
+ */
83
+ s3_url?: string;
84
+ }
85
+ }
86
+
87
+ /**
88
+ * Response DTO for `POST /files/` and `GET /files/{id}`.
89
+ */
90
+ export interface FileCreateResponse {
91
+ /**
92
+ * Opaque identifier for this file
93
+ */
94
+ id: string;
95
+
96
+ /**
97
+ * Lifecycle status: awaiting_upload | uploaded | active | infected
98
+ */
99
+ status: string;
100
+
101
+ /**
102
+ * MIME type supplied by the client at create time
103
+ */
104
+ content_type?: string;
105
+
106
+ /**
107
+ * Human-readable label for the file
108
+ */
109
+ display_name?: string;
110
+
111
+ /**
112
+ * Required form fields to include in the multipart POST to S3 alongside the file
113
+ * binary
114
+ */
115
+ upload_fields?: unknown;
116
+
117
+ /**
118
+ * S3 endpoint URL — POST your multipart form here to upload the file. Present only
119
+ * in the create response.
120
+ */
121
+ upload_url?: string;
122
+
123
+ /**
124
+ * URLs for accessing the uploaded file after a successful upload
125
+ */
126
+ url_data?: FileCreateResponse.URLData;
127
+ }
128
+
129
+ export namespace FileCreateResponse {
130
+ /**
131
+ * URLs for accessing the uploaded file after a successful upload
132
+ */
133
+ export interface URLData {
134
+ /**
135
+ * CDN URL for previewing the uploaded file after upload completes
136
+ */
137
+ preview_url?: string;
138
+
139
+ /**
140
+ * S3 URL where the file is accessible after upload
141
+ */
142
+ s3_url?: string;
143
+ }
144
+ }
145
+
146
+ export interface FileCreateParams {
147
+ /**
148
+ * Lifecycle status: awaiting_upload | uploaded | active | infected
149
+ */
150
+ status: string;
151
+
152
+ /**
153
+ * MIME type supplied by the client at create time
154
+ */
155
+ content_type?: string;
156
+
157
+ /**
158
+ * Human-readable label for the file
159
+ */
160
+ display_name?: string;
161
+
162
+ /**
163
+ * Required form fields to include in the multipart POST to S3 alongside the file
164
+ * binary
165
+ */
166
+ upload_fields?: unknown;
167
+
168
+ /**
169
+ * S3 endpoint URL — POST your multipart form here to upload the file. Present only
170
+ * in the create response.
171
+ */
172
+ upload_url?: string;
173
+
174
+ /**
175
+ * URLs for accessing the uploaded file after a successful upload
176
+ */
177
+ url_data?: unknown;
178
+ }
179
+
180
+ export declare namespace Files {
181
+ export {
182
+ type FileRetrieveResponse as FileRetrieveResponse,
183
+ type FileCreateResponse as FileCreateResponse,
184
+ type FileCreateParams as FileCreateParams,
185
+ };
186
+ }
@@ -112,6 +112,8 @@ export {
112
112
  export {
113
113
  EarningsInputs,
114
114
  type EarningsInputListResponse,
115
+ type EarningsInputCreateResponse,
116
+ type EarningsInputCreateParams,
115
117
  type EarningsInputListResponsesPageCursorURL,
116
118
  } from './earnings-inputs';
117
119
  export {
@@ -126,6 +128,7 @@ export {
126
128
  type EntitlementListResponse,
127
129
  type EntitlementListResponsesPageCursorURL,
128
130
  } from './entitlements';
131
+ export { Files, type FileRetrieveResponse, type FileCreateResponse, type FileCreateParams } from './files';
129
132
  export {
130
133
  Functions,
131
134
  type Function,
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.2.0-alpha.33'; // x-release-please-version
1
+ export const VERSION = '0.2.0-alpha.34'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.2.0-alpha.33";
1
+ export declare const VERSION = "0.2.0-alpha.34";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.2.0-alpha.33";
1
+ export declare const VERSION = "0.2.0-alpha.34";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.2.0-alpha.33'; // x-release-please-version
4
+ exports.VERSION = '0.2.0-alpha.34'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.2.0-alpha.33'; // x-release-please-version
1
+ export const VERSION = '0.2.0-alpha.34'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map