@rippling/rippling-sdk 0.2.0-alpha.36 → 0.2.0-alpha.38
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.
- package/client.d.mts +7 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +7 -1
- package/client.d.ts.map +1 -1
- package/client.js +7 -1
- package/client.js.map +1 -1
- package/client.mjs +7 -1
- package/client.mjs.map +1 -1
- package/examples/manifest/dental-practice-management/dental-practice-management.ts +21 -34
- package/examples/manifest/gym-membership-management/gym-membership-management.ts +27 -38
- package/examples/manifest/gym-membership-management/manifest.json +1 -1
- package/examples/sdui/sdui-crud-todo/sdui-crud-todo.ts +3 -3
- package/examples/sdui/sdui-showcase/sdui-showcase.ts +6 -11
- package/examples/sdui/sdui-tab-multi-view/sdui-tab-multi-view.ts +14 -24
- package/examples/sdui/vote/vote.ts +7 -11
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +2 -0
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +2 -0
- package/internal/utils/log.mjs.map +1 -1
- package/lib/manifest/category.d.mts +4 -2
- package/lib/manifest/category.d.mts.map +1 -1
- package/lib/manifest/category.d.ts +4 -2
- package/lib/manifest/category.d.ts.map +1 -1
- package/lib/manifest/category.js +2 -2
- package/lib/manifest/category.js.map +1 -1
- package/lib/manifest/category.mjs +2 -2
- package/lib/manifest/category.mjs.map +1 -1
- package/lib/manifest/custom-object-field-section.d.mts +4 -0
- package/lib/manifest/custom-object-field-section.d.mts.map +1 -1
- package/lib/manifest/custom-object-field-section.d.ts +4 -0
- package/lib/manifest/custom-object-field-section.d.ts.map +1 -1
- package/lib/manifest/custom-object-field-section.js +6 -0
- package/lib/manifest/custom-object-field-section.js.map +1 -1
- package/lib/manifest/custom-object-field-section.mjs +6 -0
- package/lib/manifest/custom-object-field-section.mjs.map +1 -1
- package/lib/manifest/custom-object-page-layout.d.mts +23 -13
- package/lib/manifest/custom-object-page-layout.d.mts.map +1 -1
- package/lib/manifest/custom-object-page-layout.d.ts +23 -13
- package/lib/manifest/custom-object-page-layout.d.ts.map +1 -1
- package/lib/manifest/custom-object-page-layout.js +122 -9
- package/lib/manifest/custom-object-page-layout.js.map +1 -1
- package/lib/manifest/custom-object-page-layout.mjs +122 -9
- package/lib/manifest/custom-object-page-layout.mjs.map +1 -1
- package/lib/manifest/custom-object.d.mts +30 -1
- package/lib/manifest/custom-object.d.mts.map +1 -1
- package/lib/manifest/custom-object.d.ts +30 -1
- package/lib/manifest/custom-object.d.ts.map +1 -1
- package/lib/manifest/custom-object.js +15 -1
- package/lib/manifest/custom-object.js.map +1 -1
- package/lib/manifest/custom-object.mjs +15 -1
- package/lib/manifest/custom-object.mjs.map +1 -1
- package/lib/manifest/field.d.mts +25 -3
- package/lib/manifest/field.d.mts.map +1 -1
- package/lib/manifest/field.d.ts +25 -3
- package/lib/manifest/field.d.ts.map +1 -1
- package/lib/manifest/field.js +28 -2
- package/lib/manifest/field.js.map +1 -1
- package/lib/manifest/field.mjs +28 -2
- package/lib/manifest/field.mjs.map +1 -1
- package/lib/manifest/index.d.mts +1 -1
- package/lib/manifest/index.d.mts.map +1 -1
- package/lib/manifest/index.d.ts +1 -1
- package/lib/manifest/index.d.ts.map +1 -1
- package/lib/manifest/index.js.map +1 -1
- package/lib/manifest/index.mjs.map +1 -1
- package/lib/manifest/manifest-builder.d.mts +1 -1
- package/lib/manifest/manifest-builder.d.ts +1 -1
- package/lib/manifest/manifest-builder.js +1 -1
- package/lib/manifest/manifest-builder.mjs +1 -1
- package/lib/manifest/manifest-function.d.mts +8 -2
- package/lib/manifest/manifest-function.d.mts.map +1 -1
- package/lib/manifest/manifest-function.d.ts +8 -2
- package/lib/manifest/manifest-function.d.ts.map +1 -1
- package/lib/manifest/manifest-function.js +8 -2
- package/lib/manifest/manifest-function.js.map +1 -1
- package/lib/manifest/manifest-function.mjs +8 -2
- package/lib/manifest/manifest-function.mjs.map +1 -1
- package/lib/sdui/actions.d.mts.map +1 -1
- package/lib/sdui/actions.d.ts.map +1 -1
- package/lib/sdui/actions.js +23 -13
- package/lib/sdui/actions.js.map +1 -1
- package/lib/sdui/actions.mjs +23 -13
- package/lib/sdui/actions.mjs.map +1 -1
- package/lib/sdui/component.d.mts +28 -11
- package/lib/sdui/component.d.mts.map +1 -1
- package/lib/sdui/component.d.ts +28 -11
- package/lib/sdui/component.d.ts.map +1 -1
- package/lib/sdui/component.js +69 -36
- package/lib/sdui/component.js.map +1 -1
- package/lib/sdui/component.mjs +69 -36
- package/lib/sdui/component.mjs.map +1 -1
- package/lib/sdui/components.d.mts +1141 -132
- package/lib/sdui/components.d.mts.map +1 -1
- package/lib/sdui/components.d.ts +1141 -132
- package/lib/sdui/components.d.ts.map +1 -1
- package/lib/sdui/components.js +834 -206
- package/lib/sdui/components.js.map +1 -1
- package/lib/sdui/components.mjs +830 -203
- package/lib/sdui/components.mjs.map +1 -1
- package/lib/sdui/directives.d.mts.map +1 -1
- package/lib/sdui/directives.d.ts.map +1 -1
- package/lib/sdui/directives.js +4 -1
- package/lib/sdui/directives.js.map +1 -1
- package/lib/sdui/directives.mjs +4 -1
- package/lib/sdui/directives.mjs.map +1 -1
- package/lib/sdui/index.d.mts +314 -261
- package/lib/sdui/index.d.mts.map +1 -1
- package/lib/sdui/index.d.ts +314 -261
- package/lib/sdui/index.d.ts.map +1 -1
- package/lib/sdui/index.js +255 -204
- package/lib/sdui/index.js.map +1 -1
- package/lib/sdui/index.mjs +128 -103
- package/lib/sdui/index.mjs.map +1 -1
- package/lib/sdui/propTypes.d.mts +6330 -0
- package/lib/sdui/propTypes.d.mts.map +1 -0
- package/lib/sdui/propTypes.d.ts +6330 -0
- package/lib/sdui/propTypes.d.ts.map +1 -0
- package/lib/sdui/propTypes.js +14 -0
- package/lib/sdui/propTypes.js.map +1 -0
- package/lib/sdui/propTypes.mjs +13 -0
- package/lib/sdui/propTypes.mjs.map +1 -0
- package/lib/sdui/render.d.mts +1 -1
- package/lib/sdui/render.d.mts.map +1 -1
- package/lib/sdui/render.d.ts +1 -1
- package/lib/sdui/render.d.ts.map +1 -1
- package/lib/sdui/render.js +11 -3
- package/lib/sdui/render.js.map +1 -1
- package/lib/sdui/render.mjs +11 -3
- package/lib/sdui/render.mjs.map +1 -1
- package/lib/sdui/state.d.mts.map +1 -1
- package/lib/sdui/state.d.ts.map +1 -1
- package/lib/sdui/state.js +3 -1
- package/lib/sdui/state.js.map +1 -1
- package/lib/sdui/state.mjs +3 -1
- package/lib/sdui/state.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/company-legal-entities.d.mts +180 -0
- package/resources/company-legal-entities.d.mts.map +1 -0
- package/resources/company-legal-entities.d.ts +180 -0
- package/resources/company-legal-entities.d.ts.map +1 -0
- package/resources/company-legal-entities.js +30 -0
- package/resources/company-legal-entities.js.map +1 -0
- package/resources/company-legal-entities.mjs +26 -0
- package/resources/company-legal-entities.mjs.map +1 -0
- package/resources/earning-types.d.mts +1 -6
- package/resources/earning-types.d.mts.map +1 -1
- package/resources/earning-types.d.ts +1 -6
- package/resources/earning-types.d.ts.map +1 -1
- package/resources/earning-types.js +1 -1
- package/resources/earning-types.mjs +1 -1
- package/resources/earnings-inputs.d.mts +1 -1
- package/resources/earnings-inputs.d.ts +1 -1
- package/resources/earnings-inputs.js +1 -1
- package/resources/earnings-inputs.mjs +1 -1
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -1
- package/resources/index.mjs.map +1 -1
- package/resources/legal-entities.d.mts +1 -1
- package/resources/legal-entities.d.mts.map +1 -1
- package/resources/legal-entities.d.ts +1 -1
- package/resources/legal-entities.d.ts.map +1 -1
- package/resources/payroll-runs/index.d.mts +3 -0
- package/resources/payroll-runs/index.d.mts.map +1 -0
- package/resources/payroll-runs/index.d.ts +3 -0
- package/resources/payroll-runs/index.d.ts.map +1 -0
- package/resources/payroll-runs/index.js +9 -0
- package/resources/payroll-runs/index.js.map +1 -0
- package/resources/payroll-runs/index.mjs +4 -0
- package/resources/payroll-runs/index.mjs.map +1 -0
- package/resources/payroll-runs/payroll-runs.d.mts +199 -0
- package/resources/payroll-runs/payroll-runs.d.mts.map +1 -0
- package/resources/payroll-runs/payroll-runs.d.ts +199 -0
- package/resources/payroll-runs/payroll-runs.d.ts.map +1 -0
- package/resources/payroll-runs/payroll-runs.js +40 -0
- package/resources/payroll-runs/payroll-runs.js.map +1 -0
- package/resources/payroll-runs/payroll-runs.mjs +35 -0
- package/resources/payroll-runs/payroll-runs.mjs.map +1 -0
- package/resources/payroll-runs/worker-payroll-records.d.mts +200 -0
- package/resources/payroll-runs/worker-payroll-records.d.mts.map +1 -0
- package/resources/payroll-runs/worker-payroll-records.d.ts +200 -0
- package/resources/payroll-runs/worker-payroll-records.d.ts.map +1 -0
- package/resources/payroll-runs/worker-payroll-records.js +23 -0
- package/resources/payroll-runs/worker-payroll-records.js.map +1 -0
- package/resources/payroll-runs/worker-payroll-records.mjs +19 -0
- package/resources/payroll-runs/worker-payroll-records.mjs.map +1 -0
- package/resources/payroll-runs.d.mts +1 -194
- package/resources/payroll-runs.d.mts.map +1 -1
- package/resources/payroll-runs.d.ts +1 -194
- package/resources/payroll-runs.d.ts.map +1 -1
- package/resources/payroll-runs.js +2 -28
- package/resources/payroll-runs.js.map +1 -1
- package/resources/payroll-runs.mjs +1 -26
- package/resources/payroll-runs.mjs.map +1 -1
- package/src/client.ts +27 -7
- package/src/internal/utils/log.ts +2 -0
- package/src/lib/manifest/category.ts +7 -5
- package/src/lib/manifest/custom-object-field-section.ts +7 -0
- package/src/lib/manifest/custom-object-page-layout.ts +225 -18
- package/src/lib/manifest/custom-object.ts +30 -1
- package/src/lib/manifest/field.ts +29 -3
- package/src/lib/manifest/index.ts +2 -0
- package/src/lib/manifest/manifest-builder.ts +1 -1
- package/src/lib/manifest/manifest-function.ts +8 -2
- package/src/lib/sdui/actions.ts +23 -10
- package/src/lib/sdui/component.ts +84 -44
- package/src/lib/sdui/components.ts +1627 -212
- package/src/lib/sdui/directives.ts +4 -1
- package/src/lib/sdui/index.ts +565 -200
- package/src/lib/sdui/propTypes.ts +8470 -0
- package/src/lib/sdui/render.ts +13 -5
- package/src/lib/sdui/state.ts +8 -2
- package/src/resources/company-legal-entities.ts +237 -0
- package/src/resources/earning-types.ts +1 -7
- package/src/resources/earnings-inputs.ts +1 -1
- package/src/resources/index.ts +8 -1
- package/src/resources/legal-entities.ts +1 -1
- package/src/resources/payroll-runs/index.ts +15 -0
- package/src/resources/payroll-runs/payroll-runs.ts +270 -0
- package/src/resources/payroll-runs/worker-payroll-records.ts +255 -0
- package/src/resources/payroll-runs.ts +1 -249
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,195 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
import * as BusinessPartnersAPI from "./business-partners.mjs";
|
|
3
|
-
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
|
-
import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
|
|
5
|
-
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
|
-
/**
|
|
7
|
-
* Payroll runs for the company
|
|
8
|
-
*/
|
|
9
|
-
export declare class PayrollRuns extends APIResource {
|
|
10
|
-
/**
|
|
11
|
-
* A list of payroll-runs.
|
|
12
|
-
*
|
|
13
|
-
* - Requires: `Payroll API`
|
|
14
|
-
* - Sortable fields: `check_date`
|
|
15
|
-
*/
|
|
16
|
-
list(query?: PayrollRunListParams | null | undefined, options?: RequestOptions): PagePromise<PayrollRunListResponsesPageCursorURL, PayrollRunListResponse>;
|
|
17
|
-
/**
|
|
18
|
-
* Retrieve a specific payroll-run
|
|
19
|
-
*/
|
|
20
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<PayrollRunRetrieveResponse>;
|
|
21
|
-
}
|
|
22
|
-
export type PayrollRunListResponsesPageCursorURL = PageCursorURL<PayrollRunListResponse>;
|
|
23
|
-
/**
|
|
24
|
-
* V2 DTO representing a single payroll run.
|
|
25
|
-
*
|
|
26
|
-
* Used by:
|
|
27
|
-
* - GET /payroll-runs/ (list)
|
|
28
|
-
* - GET /payroll-runs/{id} (retrieve)
|
|
29
|
-
*/
|
|
30
|
-
export interface PayrollRunListResponse {
|
|
31
|
-
/**
|
|
32
|
-
* Unique identifier for the payroll run.
|
|
33
|
-
*/
|
|
34
|
-
id?: string;
|
|
35
|
-
/**
|
|
36
|
-
* Deadline for approving the payroll run.
|
|
37
|
-
*/
|
|
38
|
-
approval_deadline?: string;
|
|
39
|
-
/**
|
|
40
|
-
* Timestamp when the run was approved.
|
|
41
|
-
*/
|
|
42
|
-
approved_at?: string;
|
|
43
|
-
/**
|
|
44
|
-
* Date the paycheck is issued.
|
|
45
|
-
*/
|
|
46
|
-
check_date?: string;
|
|
47
|
-
/**
|
|
48
|
-
* Identifier linking this payroll run to the company's legal entity in the HRIS
|
|
49
|
-
* system.
|
|
50
|
-
*/
|
|
51
|
-
company_entity_id?: string;
|
|
52
|
-
/**
|
|
53
|
-
* ISO country code where the payroll run applies.
|
|
54
|
-
*/
|
|
55
|
-
country_code?: string;
|
|
56
|
-
/**
|
|
57
|
-
* Date funds are debited from the company's account.
|
|
58
|
-
*/
|
|
59
|
-
debit_date?: string;
|
|
60
|
-
/**
|
|
61
|
-
* Deadline after which the run is locked for changes.
|
|
62
|
-
*/
|
|
63
|
-
lock_deadline?: string;
|
|
64
|
-
/**
|
|
65
|
-
* Timestamp when the run was marked as paid.
|
|
66
|
-
*/
|
|
67
|
-
paid_at?: string;
|
|
68
|
-
/**
|
|
69
|
-
* Pay period details for this run.
|
|
70
|
-
*/
|
|
71
|
-
pay_period?: PayrollRunListResponse.PayPeriod;
|
|
72
|
-
/**
|
|
73
|
-
* Payment method used (e.g. WIRE, ACH).
|
|
74
|
-
*/
|
|
75
|
-
payment_type?: string;
|
|
76
|
-
/**
|
|
77
|
-
* Current state of the run (e.g. DRAFT, PAID, APPROVED).
|
|
78
|
-
*/
|
|
79
|
-
run_state?: string;
|
|
80
|
-
/**
|
|
81
|
-
* Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
|
|
82
|
-
*/
|
|
83
|
-
run_type?: string;
|
|
84
|
-
/**
|
|
85
|
-
* Human-readable title of the payroll run.
|
|
86
|
-
*/
|
|
87
|
-
title?: string;
|
|
88
|
-
}
|
|
89
|
-
export declare namespace PayrollRunListResponse {
|
|
90
|
-
/**
|
|
91
|
-
* Pay period details for this run.
|
|
92
|
-
*/
|
|
93
|
-
interface PayPeriod {
|
|
94
|
-
/**
|
|
95
|
-
* End date of the pay period.
|
|
96
|
-
*/
|
|
97
|
-
end_date?: string;
|
|
98
|
-
/**
|
|
99
|
-
* Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
|
|
100
|
-
*/
|
|
101
|
-
pay_frequency?: string;
|
|
102
|
-
/**
|
|
103
|
-
* Start date of the pay period.
|
|
104
|
-
*/
|
|
105
|
-
start_date?: string;
|
|
106
|
-
}
|
|
107
|
-
}
|
|
108
|
-
/**
|
|
109
|
-
* Meta information for the response.
|
|
110
|
-
*/
|
|
111
|
-
export interface PayrollRunRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
112
|
-
/**
|
|
113
|
-
* Unique identifier for the payroll run.
|
|
114
|
-
*/
|
|
115
|
-
id?: string;
|
|
116
|
-
/**
|
|
117
|
-
* Deadline for approving the payroll run.
|
|
118
|
-
*/
|
|
119
|
-
approval_deadline?: string;
|
|
120
|
-
/**
|
|
121
|
-
* Timestamp when the run was approved.
|
|
122
|
-
*/
|
|
123
|
-
approved_at?: string;
|
|
124
|
-
/**
|
|
125
|
-
* Date the paycheck is issued.
|
|
126
|
-
*/
|
|
127
|
-
check_date?: string;
|
|
128
|
-
/**
|
|
129
|
-
* Identifier linking this payroll run to the company's legal entity in the HRIS
|
|
130
|
-
* system.
|
|
131
|
-
*/
|
|
132
|
-
company_entity_id?: string;
|
|
133
|
-
/**
|
|
134
|
-
* ISO country code where the payroll run applies.
|
|
135
|
-
*/
|
|
136
|
-
country_code?: string;
|
|
137
|
-
/**
|
|
138
|
-
* Date funds are debited from the company's account.
|
|
139
|
-
*/
|
|
140
|
-
debit_date?: string;
|
|
141
|
-
/**
|
|
142
|
-
* Deadline after which the run is locked for changes.
|
|
143
|
-
*/
|
|
144
|
-
lock_deadline?: string;
|
|
145
|
-
/**
|
|
146
|
-
* Timestamp when the run was marked as paid.
|
|
147
|
-
*/
|
|
148
|
-
paid_at?: string;
|
|
149
|
-
/**
|
|
150
|
-
* Pay period details for this run.
|
|
151
|
-
*/
|
|
152
|
-
pay_period?: PayrollRunRetrieveResponse.PayPeriod;
|
|
153
|
-
/**
|
|
154
|
-
* Payment method used (e.g. WIRE, ACH).
|
|
155
|
-
*/
|
|
156
|
-
payment_type?: string;
|
|
157
|
-
/**
|
|
158
|
-
* Current state of the run (e.g. DRAFT, PAID, APPROVED).
|
|
159
|
-
*/
|
|
160
|
-
run_state?: string;
|
|
161
|
-
/**
|
|
162
|
-
* Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
|
|
163
|
-
*/
|
|
164
|
-
run_type?: string;
|
|
165
|
-
/**
|
|
166
|
-
* Human-readable title of the payroll run.
|
|
167
|
-
*/
|
|
168
|
-
title?: string;
|
|
169
|
-
}
|
|
170
|
-
export declare namespace PayrollRunRetrieveResponse {
|
|
171
|
-
/**
|
|
172
|
-
* Pay period details for this run.
|
|
173
|
-
*/
|
|
174
|
-
interface PayPeriod {
|
|
175
|
-
/**
|
|
176
|
-
* End date of the pay period.
|
|
177
|
-
*/
|
|
178
|
-
end_date?: string;
|
|
179
|
-
/**
|
|
180
|
-
* Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
|
|
181
|
-
*/
|
|
182
|
-
pay_frequency?: string;
|
|
183
|
-
/**
|
|
184
|
-
* Start date of the pay period.
|
|
185
|
-
*/
|
|
186
|
-
start_date?: string;
|
|
187
|
-
}
|
|
188
|
-
}
|
|
189
|
-
export interface PayrollRunListParams {
|
|
190
|
-
order_by?: string;
|
|
191
|
-
}
|
|
192
|
-
export declare namespace PayrollRuns {
|
|
193
|
-
export { type PayrollRunListResponse as PayrollRunListResponse, type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse, type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL, type PayrollRunListParams as PayrollRunListParams, };
|
|
194
|
-
}
|
|
1
|
+
export * from "./payroll-runs/index.mjs";
|
|
195
2
|
//# sourceMappingURL=payroll-runs.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payroll-runs.d.mts","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"payroll-runs.d.mts","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":""}
|
|
@@ -1,195 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
import * as BusinessPartnersAPI from "./business-partners.js";
|
|
3
|
-
import { APIPromise } from "../core/api-promise.js";
|
|
4
|
-
import { PageCursorURL, PagePromise } from "../core/pagination.js";
|
|
5
|
-
import { RequestOptions } from "../internal/request-options.js";
|
|
6
|
-
/**
|
|
7
|
-
* Payroll runs for the company
|
|
8
|
-
*/
|
|
9
|
-
export declare class PayrollRuns extends APIResource {
|
|
10
|
-
/**
|
|
11
|
-
* A list of payroll-runs.
|
|
12
|
-
*
|
|
13
|
-
* - Requires: `Payroll API`
|
|
14
|
-
* - Sortable fields: `check_date`
|
|
15
|
-
*/
|
|
16
|
-
list(query?: PayrollRunListParams | null | undefined, options?: RequestOptions): PagePromise<PayrollRunListResponsesPageCursorURL, PayrollRunListResponse>;
|
|
17
|
-
/**
|
|
18
|
-
* Retrieve a specific payroll-run
|
|
19
|
-
*/
|
|
20
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<PayrollRunRetrieveResponse>;
|
|
21
|
-
}
|
|
22
|
-
export type PayrollRunListResponsesPageCursorURL = PageCursorURL<PayrollRunListResponse>;
|
|
23
|
-
/**
|
|
24
|
-
* V2 DTO representing a single payroll run.
|
|
25
|
-
*
|
|
26
|
-
* Used by:
|
|
27
|
-
* - GET /payroll-runs/ (list)
|
|
28
|
-
* - GET /payroll-runs/{id} (retrieve)
|
|
29
|
-
*/
|
|
30
|
-
export interface PayrollRunListResponse {
|
|
31
|
-
/**
|
|
32
|
-
* Unique identifier for the payroll run.
|
|
33
|
-
*/
|
|
34
|
-
id?: string;
|
|
35
|
-
/**
|
|
36
|
-
* Deadline for approving the payroll run.
|
|
37
|
-
*/
|
|
38
|
-
approval_deadline?: string;
|
|
39
|
-
/**
|
|
40
|
-
* Timestamp when the run was approved.
|
|
41
|
-
*/
|
|
42
|
-
approved_at?: string;
|
|
43
|
-
/**
|
|
44
|
-
* Date the paycheck is issued.
|
|
45
|
-
*/
|
|
46
|
-
check_date?: string;
|
|
47
|
-
/**
|
|
48
|
-
* Identifier linking this payroll run to the company's legal entity in the HRIS
|
|
49
|
-
* system.
|
|
50
|
-
*/
|
|
51
|
-
company_entity_id?: string;
|
|
52
|
-
/**
|
|
53
|
-
* ISO country code where the payroll run applies.
|
|
54
|
-
*/
|
|
55
|
-
country_code?: string;
|
|
56
|
-
/**
|
|
57
|
-
* Date funds are debited from the company's account.
|
|
58
|
-
*/
|
|
59
|
-
debit_date?: string;
|
|
60
|
-
/**
|
|
61
|
-
* Deadline after which the run is locked for changes.
|
|
62
|
-
*/
|
|
63
|
-
lock_deadline?: string;
|
|
64
|
-
/**
|
|
65
|
-
* Timestamp when the run was marked as paid.
|
|
66
|
-
*/
|
|
67
|
-
paid_at?: string;
|
|
68
|
-
/**
|
|
69
|
-
* Pay period details for this run.
|
|
70
|
-
*/
|
|
71
|
-
pay_period?: PayrollRunListResponse.PayPeriod;
|
|
72
|
-
/**
|
|
73
|
-
* Payment method used (e.g. WIRE, ACH).
|
|
74
|
-
*/
|
|
75
|
-
payment_type?: string;
|
|
76
|
-
/**
|
|
77
|
-
* Current state of the run (e.g. DRAFT, PAID, APPROVED).
|
|
78
|
-
*/
|
|
79
|
-
run_state?: string;
|
|
80
|
-
/**
|
|
81
|
-
* Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
|
|
82
|
-
*/
|
|
83
|
-
run_type?: string;
|
|
84
|
-
/**
|
|
85
|
-
* Human-readable title of the payroll run.
|
|
86
|
-
*/
|
|
87
|
-
title?: string;
|
|
88
|
-
}
|
|
89
|
-
export declare namespace PayrollRunListResponse {
|
|
90
|
-
/**
|
|
91
|
-
* Pay period details for this run.
|
|
92
|
-
*/
|
|
93
|
-
interface PayPeriod {
|
|
94
|
-
/**
|
|
95
|
-
* End date of the pay period.
|
|
96
|
-
*/
|
|
97
|
-
end_date?: string;
|
|
98
|
-
/**
|
|
99
|
-
* Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
|
|
100
|
-
*/
|
|
101
|
-
pay_frequency?: string;
|
|
102
|
-
/**
|
|
103
|
-
* Start date of the pay period.
|
|
104
|
-
*/
|
|
105
|
-
start_date?: string;
|
|
106
|
-
}
|
|
107
|
-
}
|
|
108
|
-
/**
|
|
109
|
-
* Meta information for the response.
|
|
110
|
-
*/
|
|
111
|
-
export interface PayrollRunRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
112
|
-
/**
|
|
113
|
-
* Unique identifier for the payroll run.
|
|
114
|
-
*/
|
|
115
|
-
id?: string;
|
|
116
|
-
/**
|
|
117
|
-
* Deadline for approving the payroll run.
|
|
118
|
-
*/
|
|
119
|
-
approval_deadline?: string;
|
|
120
|
-
/**
|
|
121
|
-
* Timestamp when the run was approved.
|
|
122
|
-
*/
|
|
123
|
-
approved_at?: string;
|
|
124
|
-
/**
|
|
125
|
-
* Date the paycheck is issued.
|
|
126
|
-
*/
|
|
127
|
-
check_date?: string;
|
|
128
|
-
/**
|
|
129
|
-
* Identifier linking this payroll run to the company's legal entity in the HRIS
|
|
130
|
-
* system.
|
|
131
|
-
*/
|
|
132
|
-
company_entity_id?: string;
|
|
133
|
-
/**
|
|
134
|
-
* ISO country code where the payroll run applies.
|
|
135
|
-
*/
|
|
136
|
-
country_code?: string;
|
|
137
|
-
/**
|
|
138
|
-
* Date funds are debited from the company's account.
|
|
139
|
-
*/
|
|
140
|
-
debit_date?: string;
|
|
141
|
-
/**
|
|
142
|
-
* Deadline after which the run is locked for changes.
|
|
143
|
-
*/
|
|
144
|
-
lock_deadline?: string;
|
|
145
|
-
/**
|
|
146
|
-
* Timestamp when the run was marked as paid.
|
|
147
|
-
*/
|
|
148
|
-
paid_at?: string;
|
|
149
|
-
/**
|
|
150
|
-
* Pay period details for this run.
|
|
151
|
-
*/
|
|
152
|
-
pay_period?: PayrollRunRetrieveResponse.PayPeriod;
|
|
153
|
-
/**
|
|
154
|
-
* Payment method used (e.g. WIRE, ACH).
|
|
155
|
-
*/
|
|
156
|
-
payment_type?: string;
|
|
157
|
-
/**
|
|
158
|
-
* Current state of the run (e.g. DRAFT, PAID, APPROVED).
|
|
159
|
-
*/
|
|
160
|
-
run_state?: string;
|
|
161
|
-
/**
|
|
162
|
-
* Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
|
|
163
|
-
*/
|
|
164
|
-
run_type?: string;
|
|
165
|
-
/**
|
|
166
|
-
* Human-readable title of the payroll run.
|
|
167
|
-
*/
|
|
168
|
-
title?: string;
|
|
169
|
-
}
|
|
170
|
-
export declare namespace PayrollRunRetrieveResponse {
|
|
171
|
-
/**
|
|
172
|
-
* Pay period details for this run.
|
|
173
|
-
*/
|
|
174
|
-
interface PayPeriod {
|
|
175
|
-
/**
|
|
176
|
-
* End date of the pay period.
|
|
177
|
-
*/
|
|
178
|
-
end_date?: string;
|
|
179
|
-
/**
|
|
180
|
-
* Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
|
|
181
|
-
*/
|
|
182
|
-
pay_frequency?: string;
|
|
183
|
-
/**
|
|
184
|
-
* Start date of the pay period.
|
|
185
|
-
*/
|
|
186
|
-
start_date?: string;
|
|
187
|
-
}
|
|
188
|
-
}
|
|
189
|
-
export interface PayrollRunListParams {
|
|
190
|
-
order_by?: string;
|
|
191
|
-
}
|
|
192
|
-
export declare namespace PayrollRuns {
|
|
193
|
-
export { type PayrollRunListResponse as PayrollRunListResponse, type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse, type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL, type PayrollRunListParams as PayrollRunListParams, };
|
|
194
|
-
}
|
|
1
|
+
export * from "./payroll-runs/index.js";
|
|
195
2
|
//# sourceMappingURL=payroll-runs.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payroll-runs.d.ts","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"payroll-runs.d.ts","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":""}
|
|
@@ -1,32 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
const pagination_1 = require("../core/pagination.js");
|
|
7
|
-
const path_1 = require("../internal/utils/path.js");
|
|
8
|
-
/**
|
|
9
|
-
* Payroll runs for the company
|
|
10
|
-
*/
|
|
11
|
-
class PayrollRuns extends resource_1.APIResource {
|
|
12
|
-
/**
|
|
13
|
-
* A list of payroll-runs.
|
|
14
|
-
*
|
|
15
|
-
* - Requires: `Payroll API`
|
|
16
|
-
* - Sortable fields: `check_date`
|
|
17
|
-
*/
|
|
18
|
-
list(query = {}, options) {
|
|
19
|
-
return this._client.getAPIList('/payroll-runs/', (pagination_1.PageCursorURL), {
|
|
20
|
-
query,
|
|
21
|
-
...options,
|
|
22
|
-
});
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* Retrieve a specific payroll-run
|
|
26
|
-
*/
|
|
27
|
-
retrieve(id, options) {
|
|
28
|
-
return this._client.get((0, path_1.path) `/payroll-runs/${id}/`, options);
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
exports.PayrollRuns = PayrollRuns;
|
|
4
|
+
const tslib_1 = require("../internal/tslib.js");
|
|
5
|
+
tslib_1.__exportStar(require("./payroll-runs/index.js"), exports);
|
|
32
6
|
//# sourceMappingURL=payroll-runs.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payroll-runs.js","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"payroll-runs.js","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kEAAqC"}
|
|
@@ -1,28 +1,3 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
|
|
3
|
-
import { PageCursorURL } from "../core/pagination.mjs";
|
|
4
|
-
import { path } from "../internal/utils/path.mjs";
|
|
5
|
-
/**
|
|
6
|
-
* Payroll runs for the company
|
|
7
|
-
*/
|
|
8
|
-
export class PayrollRuns extends APIResource {
|
|
9
|
-
/**
|
|
10
|
-
* A list of payroll-runs.
|
|
11
|
-
*
|
|
12
|
-
* - Requires: `Payroll API`
|
|
13
|
-
* - Sortable fields: `check_date`
|
|
14
|
-
*/
|
|
15
|
-
list(query = {}, options) {
|
|
16
|
-
return this._client.getAPIList('/payroll-runs/', (PageCursorURL), {
|
|
17
|
-
query,
|
|
18
|
-
...options,
|
|
19
|
-
});
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
* Retrieve a specific payroll-run
|
|
23
|
-
*/
|
|
24
|
-
retrieve(id, options) {
|
|
25
|
-
return this._client.get(path `/payroll-runs/${id}/`, options);
|
|
26
|
-
}
|
|
27
|
-
}
|
|
2
|
+
export * from "./payroll-runs/index.mjs";
|
|
28
3
|
//# sourceMappingURL=payroll-runs.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payroll-runs.mjs","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":"AAAA,sFAAsF
|
|
1
|
+
{"version":3,"file":"payroll-runs.mjs","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
|
package/src/client.ts
CHANGED
|
@@ -51,6 +51,13 @@ import {
|
|
|
51
51
|
Candidates,
|
|
52
52
|
} from './resources/candidates';
|
|
53
53
|
import { Companies, CompaniesPageCursorURL, Company, CompanyListParams } from './resources/companies';
|
|
54
|
+
import {
|
|
55
|
+
CompanyLegalEntities,
|
|
56
|
+
CompanyLegalEntityListParams,
|
|
57
|
+
CompanyLegalEntityListResponse,
|
|
58
|
+
CompanyLegalEntityListResponsesPageCursorURL,
|
|
59
|
+
CompanyLegalEntityRetrieveResponse,
|
|
60
|
+
} from './resources/company-legal-entities';
|
|
54
61
|
import {
|
|
55
62
|
CompanyLegalEntityWorkerListParams,
|
|
56
63
|
CompanyLegalEntityWorkerListResponse,
|
|
@@ -305,13 +312,6 @@ import {
|
|
|
305
312
|
ObjectCategoryCreateParams,
|
|
306
313
|
ObjectCategoryUpdateParams,
|
|
307
314
|
} from './resources/object-categories';
|
|
308
|
-
import {
|
|
309
|
-
PayrollRunListParams,
|
|
310
|
-
PayrollRunListResponse,
|
|
311
|
-
PayrollRunListResponsesPageCursorURL,
|
|
312
|
-
PayrollRunRetrieveResponse,
|
|
313
|
-
PayrollRuns,
|
|
314
|
-
} from './resources/payroll-runs';
|
|
315
315
|
import {
|
|
316
316
|
PlatformCapabilities,
|
|
317
317
|
PlatformCapabilityListResponse,
|
|
@@ -478,6 +478,13 @@ import {
|
|
|
478
478
|
MetadataListResponse,
|
|
479
479
|
MetadataListResponsesPageCursorURL,
|
|
480
480
|
} from './resources/metadata/metadata';
|
|
481
|
+
import {
|
|
482
|
+
PayrollRunListParams,
|
|
483
|
+
PayrollRunListResponse,
|
|
484
|
+
PayrollRunListResponsesPageCursorURL,
|
|
485
|
+
PayrollRunRetrieveResponse,
|
|
486
|
+
PayrollRuns,
|
|
487
|
+
} from './resources/payroll-runs/payroll-runs';
|
|
481
488
|
import { ReportRetrieveResponse, Reports } from './resources/reports/reports';
|
|
482
489
|
import {
|
|
483
490
|
Supergroup,
|
|
@@ -1351,6 +1358,10 @@ export class RipplingSDK {
|
|
|
1351
1358
|
* An application by a candidate to a specific job requisition
|
|
1352
1359
|
*/
|
|
1353
1360
|
candidateApplications: API.CandidateApplications = new API.CandidateApplications(this);
|
|
1361
|
+
/**
|
|
1362
|
+
* Legal entities registered by the company
|
|
1363
|
+
*/
|
|
1364
|
+
companyLegalEntities: API.CompanyLegalEntities = new API.CompanyLegalEntities(this);
|
|
1354
1365
|
/**
|
|
1355
1366
|
* Workers who work or have worked at the company
|
|
1356
1367
|
*/
|
|
@@ -1492,6 +1503,7 @@ RipplingSDK.JobAssignments = JobAssignments;
|
|
|
1492
1503
|
RipplingSDK.JobPayRateExceptions = JobPayRateExceptions;
|
|
1493
1504
|
RipplingSDK.Candidates = Candidates;
|
|
1494
1505
|
RipplingSDK.CandidateApplications = CandidateApplications;
|
|
1506
|
+
RipplingSDK.CompanyLegalEntities = CompanyLegalEntities;
|
|
1495
1507
|
RipplingSDK.CompanyLegalEntityWorkers = CompanyLegalEntityWorkers;
|
|
1496
1508
|
RipplingSDK.CompensationBandsDetails = CompensationBandsDetails;
|
|
1497
1509
|
RipplingSDK.CustomApps = CustomApps;
|
|
@@ -1835,6 +1847,14 @@ export declare namespace RipplingSDK {
|
|
|
1835
1847
|
type CandidateApplicationListParams as CandidateApplicationListParams,
|
|
1836
1848
|
};
|
|
1837
1849
|
|
|
1850
|
+
export {
|
|
1851
|
+
CompanyLegalEntities as CompanyLegalEntities,
|
|
1852
|
+
type CompanyLegalEntityListResponse as CompanyLegalEntityListResponse,
|
|
1853
|
+
type CompanyLegalEntityRetrieveResponse as CompanyLegalEntityRetrieveResponse,
|
|
1854
|
+
type CompanyLegalEntityListResponsesPageCursorURL as CompanyLegalEntityListResponsesPageCursorURL,
|
|
1855
|
+
type CompanyLegalEntityListParams as CompanyLegalEntityListParams,
|
|
1856
|
+
};
|
|
1857
|
+
|
|
1838
1858
|
export {
|
|
1839
1859
|
CompanyLegalEntityWorkers as CompanyLegalEntityWorkers,
|
|
1840
1860
|
type CompanyLegalEntityWorkerListResponse as CompanyLegalEntityWorkerListResponse,
|
|
@@ -107,6 +107,8 @@ export const formatRequestDetails = (details: {
|
|
|
107
107
|
name,
|
|
108
108
|
(
|
|
109
109
|
name.toLowerCase() === 'authorization' ||
|
|
110
|
+
name.toLowerCase() === 'api-key' ||
|
|
111
|
+
name.toLowerCase() === 'x-api-key' ||
|
|
110
112
|
name.toLowerCase() === 'cookie' ||
|
|
111
113
|
name.toLowerCase() === 'set-cookie'
|
|
112
114
|
) ?
|
|
@@ -19,9 +19,11 @@ export interface CategoryProps {
|
|
|
19
19
|
/**
|
|
20
20
|
* Human-readable description of what this category groups.
|
|
21
21
|
*
|
|
22
|
-
*
|
|
22
|
+
* Required. The backend (`CustomCategoryConfig.description: str`) requires the
|
|
23
|
+
* key to be present and rejects `null`. Pass an empty string only if you truly
|
|
24
|
+
* have no meaningful copy.
|
|
23
25
|
*/
|
|
24
|
-
description
|
|
26
|
+
description: string;
|
|
25
27
|
}
|
|
26
28
|
|
|
27
29
|
/**
|
|
@@ -57,7 +59,7 @@ export interface CategoryProps {
|
|
|
57
59
|
export class Category {
|
|
58
60
|
private readonly _apiName: string;
|
|
59
61
|
private readonly _name: string;
|
|
60
|
-
private readonly _description: string
|
|
62
|
+
private readonly _description: string;
|
|
61
63
|
|
|
62
64
|
/**
|
|
63
65
|
* @param scope - The manifest to register this category with.
|
|
@@ -66,7 +68,7 @@ export class Category {
|
|
|
66
68
|
constructor(scope: ManifestScope, props: CategoryProps) {
|
|
67
69
|
this._apiName = props.apiName;
|
|
68
70
|
this._name = props.name;
|
|
69
|
-
this._description = props.description
|
|
71
|
+
this._description = props.description;
|
|
70
72
|
scope._register(this);
|
|
71
73
|
}
|
|
72
74
|
|
|
@@ -94,7 +96,7 @@ export class Category {
|
|
|
94
96
|
type: 'CUSTOM_CATEGORY',
|
|
95
97
|
api_name: this._apiName,
|
|
96
98
|
name: this._name,
|
|
97
|
-
description: this._description
|
|
99
|
+
description: this._description,
|
|
98
100
|
};
|
|
99
101
|
}
|
|
100
102
|
}
|
|
@@ -70,6 +70,13 @@ export class CustomObjectFieldSection {
|
|
|
70
70
|
return this._sectionId;
|
|
71
71
|
}
|
|
72
72
|
|
|
73
|
+
/**
|
|
74
|
+
* Returns the display name of this field section.
|
|
75
|
+
*/
|
|
76
|
+
getName(): string {
|
|
77
|
+
return this._name;
|
|
78
|
+
}
|
|
79
|
+
|
|
73
80
|
/**
|
|
74
81
|
* Returns the api_name of the custom object this section belongs to.
|
|
75
82
|
*/
|