@dsptch-work/api-client 0.8.0 → 0.9.0
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/CHANGELOG.md +55 -0
- package/dist/gen/index.d.ts +1 -1
- package/dist/gen/sdk.gen.d.ts +83 -9
- package/dist/gen/sdk.gen.js +98 -18
- package/dist/gen/types.gen.d.ts +146 -83
- package/dist/gen/zod.gen.d.ts +194 -141
- package/dist/gen/zod.gen.js +73 -46
- package/package.json +1 -1
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -216,6 +216,12 @@ export type Problem = {
|
|
|
216
216
|
*
|
|
217
217
|
* A deletion is refused by the record's guards — dependent records restrict removal. The message carries the specifics; remove or reassign the dependents first.
|
|
218
218
|
*
|
|
219
|
+
* ### interval_too_wide
|
|
220
|
+
*
|
|
221
|
+
* **Interval Too Wide**
|
|
222
|
+
*
|
|
223
|
+
* A change feed was asked for a span of event time wider than one request may cover. Split it into consecutive windows no wider than the maximum stated in the feed's operation and read them in order; their pages concatenate without gaps. Both bounds are inclusive, so an event stamped exactly on a shared bound appears in both pages — deduplicate as usual.
|
|
224
|
+
*
|
|
219
225
|
* ### invalid_date
|
|
220
226
|
*
|
|
221
227
|
* **Unparseable Date Value**
|
|
@@ -226,7 +232,7 @@ export type Problem = {
|
|
|
226
232
|
*
|
|
227
233
|
* **Invalid Filter Value**
|
|
228
234
|
*
|
|
229
|
-
* A declared filter key carries a value outside its accepted set — a non-boolean on a boolean key,
|
|
235
|
+
* A declared filter key carries a value outside its accepted set — a non-boolean on a boolean key, a token outside an enum key's vocabulary, or a range whose upper bound precedes its lower bound. Send an accepted value.
|
|
230
236
|
*
|
|
231
237
|
* ### invalid_iso8601_duration
|
|
232
238
|
*
|
|
@@ -294,12 +300,6 @@ export type Problem = {
|
|
|
294
300
|
*
|
|
295
301
|
* The apprentice's wage schedule does not belong to the program in the URL. Use a schedule from that program.
|
|
296
302
|
*
|
|
297
|
-
* ### watermark_outside_retention
|
|
298
|
-
*
|
|
299
|
-
* **Watermark Outside Retention Window**
|
|
300
|
-
*
|
|
301
|
-
* A change feed was polled from a watermark older than the window it covers, so no page it could return would be complete. Resync instead: re-crawl the live index, diff it against your replica, and resume polling from the `meta.complete_through` of the first page you then read.
|
|
302
|
-
*
|
|
303
303
|
* ## 428
|
|
304
304
|
*
|
|
305
305
|
* ### precondition_required
|
|
@@ -333,7 +333,7 @@ export type Problem = {
|
|
|
333
333
|
* Another write to the same resource held it for longer than this request was willing to wait, so nothing was applied. The request itself is fine — resend it unchanged after the `Retry-After` window.
|
|
334
334
|
*
|
|
335
335
|
*/
|
|
336
|
-
export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'insufficient_api_key_scope' | 'not_found' | 'already_terminated' | 'recorded_since_termination' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | '
|
|
336
|
+
export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'insufficient_api_key_scope' | 'not_found' | 'already_terminated' | 'recorded_since_termination' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'interval_too_wide' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'precondition_required' | 'too_many_requests' | 'internal_error' | 'write_contended';
|
|
337
337
|
export type ApiKeyScopeResponseObject = {
|
|
338
338
|
resource: string;
|
|
339
339
|
action: 'read' | 'create' | 'update' | 'delete';
|
|
@@ -967,7 +967,7 @@ export type ApprenticeshipWageScheduleParameters = {
|
|
|
967
967
|
*/
|
|
968
968
|
export type TimecodeResponseObject = {
|
|
969
969
|
/**
|
|
970
|
-
*
|
|
970
|
+
* Version-stable identifier; always equal to bitemporal_id, never a per-version row id (UUID string).
|
|
971
971
|
*/
|
|
972
972
|
id: string;
|
|
973
973
|
/**
|
|
@@ -1035,9 +1035,9 @@ export type TimecodeResponseObject = {
|
|
|
1035
1035
|
*/
|
|
1036
1036
|
default_for_company_id: string | null;
|
|
1037
1037
|
/**
|
|
1038
|
-
* ISO8601 timestamp at which this version's validity window begins (bitemporal valid-time start).
|
|
1038
|
+
* ISO8601 timestamp at which this version's validity window begins (bitemporal valid-time start); never null for this resource — a lower bound is always recorded.
|
|
1039
1039
|
*/
|
|
1040
|
-
valid_from: string;
|
|
1040
|
+
valid_from: string | null;
|
|
1041
1041
|
/**
|
|
1042
1042
|
* ISO8601 timestamp at which this version stops being valid (bitemporal valid-time end); null until the timecode is terminated.
|
|
1043
1043
|
*/
|
|
@@ -1077,7 +1077,7 @@ export type TimecodeHistoryVersionObject = {
|
|
|
1077
1077
|
incentive_pay_eligible: boolean;
|
|
1078
1078
|
restricted_to: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1079
1079
|
default_for_company_id: string | null;
|
|
1080
|
-
valid_from: string;
|
|
1080
|
+
valid_from: string | null;
|
|
1081
1081
|
valid_to: string | null;
|
|
1082
1082
|
transaction_from: string;
|
|
1083
1083
|
transaction_to: string | null;
|
|
@@ -1875,9 +1875,9 @@ export type HolidayResponseObject = {
|
|
|
1875
1875
|
*/
|
|
1876
1876
|
id: string;
|
|
1877
1877
|
/**
|
|
1878
|
-
*
|
|
1878
|
+
* ID of the pay schedule (PayPeriodConfig) this holiday belongs to, stable across all of its versions.
|
|
1879
1879
|
*/
|
|
1880
|
-
|
|
1880
|
+
timekeeping_pay_period_config_id: string;
|
|
1881
1881
|
/**
|
|
1882
1882
|
* Calendar date (YYYY-MM-DD) the holiday falls on; for a fixed holiday it is set directly, for a floating holiday it is computed from month/week/wday/year.
|
|
1883
1883
|
*/
|
|
@@ -1944,9 +1944,9 @@ export type AttestationConfigResponseObject = {
|
|
|
1944
1944
|
*/
|
|
1945
1945
|
id: string;
|
|
1946
1946
|
/**
|
|
1947
|
-
*
|
|
1947
|
+
* ID of the pay schedule (PayPeriodConfig) this attestation config belongs to, stable across all of its versions.
|
|
1948
1948
|
*/
|
|
1949
|
-
|
|
1949
|
+
timekeeping_pay_period_config_id: string;
|
|
1950
1950
|
/**
|
|
1951
1951
|
* The attestation question presented to the worker when a shift ends.
|
|
1952
1952
|
*/
|
|
@@ -1990,13 +1990,13 @@ export type AttestationConfigParameters = {
|
|
|
1990
1990
|
us_state_id?: string | null;
|
|
1991
1991
|
};
|
|
1992
1992
|
/**
|
|
1993
|
-
* A pay schedule (PayPeriodConfig) — the top-level timekeeping unit that sets a company's payroll cadence and tracking modes and generates its stream of pay periods. Read-only; only the currently-valid version is returned, keyed by its stable
|
|
1993
|
+
* A pay schedule (PayPeriodConfig) — the top-level timekeeping unit that sets a company's payroll cadence and tracking modes and generates its stream of pay periods. Read-only; only the currently-valid version is returned, keyed by its stable id.
|
|
1994
1994
|
*/
|
|
1995
1995
|
export type PayPeriodConfigResponseObject = {
|
|
1996
1996
|
/**
|
|
1997
1997
|
* Stable identifier of the pay schedule across all of its versions; other resources reference this.
|
|
1998
1998
|
*/
|
|
1999
|
-
|
|
1999
|
+
id: string;
|
|
2000
2000
|
/**
|
|
2001
2001
|
* ID of the company that owns this record.
|
|
2002
2002
|
*/
|
|
@@ -2054,9 +2054,9 @@ export type PayPeriodConfigResponseObject = {
|
|
|
2054
2054
|
*/
|
|
2055
2055
|
demo: boolean | null;
|
|
2056
2056
|
/**
|
|
2057
|
-
* Start of this schedule version's validity window (ISO 8601).
|
|
2057
|
+
* Start of this schedule version's validity window (ISO 8601); null when the version has no recorded start.
|
|
2058
2058
|
*/
|
|
2059
|
-
valid_from: string;
|
|
2059
|
+
valid_from: string | null;
|
|
2060
2060
|
/**
|
|
2061
2061
|
* End of this schedule version's validity window (ISO 8601); null while the version is open-ended.
|
|
2062
2062
|
*/
|
|
@@ -2067,7 +2067,7 @@ export type PayPeriodConfigResponseObject = {
|
|
|
2067
2067
|
created_at: string;
|
|
2068
2068
|
};
|
|
2069
2069
|
export type PayPeriodConfigHistoryVersionObject = {
|
|
2070
|
-
|
|
2070
|
+
id: string;
|
|
2071
2071
|
company_id: string;
|
|
2072
2072
|
name: string;
|
|
2073
2073
|
frequency: 'weekly' | 'biweekly';
|
|
@@ -2082,7 +2082,7 @@ export type PayPeriodConfigHistoryVersionObject = {
|
|
|
2082
2082
|
requires_external_map_contributor: boolean;
|
|
2083
2083
|
paid_after_holiday: boolean;
|
|
2084
2084
|
demo: boolean | null;
|
|
2085
|
-
valid_from: string;
|
|
2085
|
+
valid_from: string | null;
|
|
2086
2086
|
valid_to: string | null;
|
|
2087
2087
|
created_at: string;
|
|
2088
2088
|
version_status: 'scheduled' | 'current' | 'historical';
|
|
@@ -3114,9 +3114,9 @@ export type UserResponseObject = {
|
|
|
3114
3114
|
*/
|
|
3115
3115
|
employment_window: {
|
|
3116
3116
|
/**
|
|
3117
|
-
* When this version of the employment took effect (ISO 8601). A value in the future means the worker is a scheduled hire who has not started.
|
|
3117
|
+
* When this version of the employment took effect (ISO 8601); null when the version has no recorded start. A value in the future means the worker is a scheduled hire who has not started.
|
|
3118
3118
|
*/
|
|
3119
|
-
valid_from: string;
|
|
3119
|
+
valid_from: string | null;
|
|
3120
3120
|
/**
|
|
3121
3121
|
* When this version of the employment stopped applying (ISO 8601); null while it is still in effect. A value in the past means this is the nearest version rather than a current one.
|
|
3122
3122
|
*/
|
|
@@ -4321,6 +4321,30 @@ export type UserGroupParameters = {
|
|
|
4321
4321
|
*/
|
|
4322
4322
|
user_ids: Array<string>;
|
|
4323
4323
|
};
|
|
4324
|
+
/**
|
|
4325
|
+
* A page of change events for form submissions, written at archival time; archiving hard-deletes the live row, so this feed is the deletion signal the main index cannot give. Visibility derives from metadata retained at archival time — a subset of the live submission index, never a superset.
|
|
4326
|
+
*/
|
|
4327
|
+
export type FormSubmissionDeltasResponse = {
|
|
4328
|
+
meta: DeltaMeta;
|
|
4329
|
+
links: Links;
|
|
4330
|
+
/**
|
|
4331
|
+
* The page of form-submission change events.
|
|
4332
|
+
*/
|
|
4333
|
+
data: Array<{
|
|
4334
|
+
/**
|
|
4335
|
+
* The change this event records: only destroy events are emitted today — creates and updates surface on the live index.
|
|
4336
|
+
*/
|
|
4337
|
+
event: 'destroy';
|
|
4338
|
+
/**
|
|
4339
|
+
* ID of the form submission this event applies to — the submission's own id, not a version-record id; for a destroy event, the id of the now-deleted submission.
|
|
4340
|
+
*/
|
|
4341
|
+
id: string;
|
|
4342
|
+
/**
|
|
4343
|
+
* When this event occurred (ISO 8601).
|
|
4344
|
+
*/
|
|
4345
|
+
timestamp: string;
|
|
4346
|
+
}>;
|
|
4347
|
+
};
|
|
4324
4348
|
/**
|
|
4325
4349
|
* A page of change events (create, update, destroy) for time entries, drawn from version history; scoped by the surviving parent time card, so a destroyed entry's history stays visible.
|
|
4326
4350
|
*/
|
|
@@ -4430,13 +4454,9 @@ export type PayPeriodsResponseObject = {
|
|
|
4430
4454
|
*/
|
|
4431
4455
|
id?: string;
|
|
4432
4456
|
/**
|
|
4433
|
-
* ID of the
|
|
4457
|
+
* ID of the pay schedule (PayPeriodConfig) that owns this pay period, stable across all of its versions.
|
|
4434
4458
|
*/
|
|
4435
4459
|
timekeeping_pay_period_config_id?: string;
|
|
4436
|
-
/**
|
|
4437
|
-
* Stable identifier of the pay schedule across all of its versions.
|
|
4438
|
-
*/
|
|
4439
|
-
pay_period_config_uid?: string;
|
|
4440
4460
|
/**
|
|
4441
4461
|
* Calendar date (YYYY-MM-DD) that workers are paid for this period.
|
|
4442
4462
|
*/
|
|
@@ -5064,9 +5084,9 @@ export type PayrollFringeBenefitPlanResponseObject = {
|
|
|
5064
5084
|
*/
|
|
5065
5085
|
id: string;
|
|
5066
5086
|
/**
|
|
5067
|
-
*
|
|
5087
|
+
* ID of the pay schedule that owns this plan, stable across all of its versions.
|
|
5068
5088
|
*/
|
|
5069
|
-
|
|
5089
|
+
timekeeping_pay_period_config_id: string;
|
|
5070
5090
|
/**
|
|
5071
5091
|
* Human-readable name of the plan.
|
|
5072
5092
|
*/
|
|
@@ -5129,13 +5149,13 @@ export type PayrollFringeBenefitPlanResponseObject = {
|
|
|
5129
5149
|
updated_at: string;
|
|
5130
5150
|
};
|
|
5131
5151
|
/**
|
|
5132
|
-
* Request body for creating or updating a fringe-benefit plan.
|
|
5152
|
+
* Request body for creating or updating a fringe-benefit plan. timekeeping_pay_period_config_id, name, plan_number, and benefit_category are required.
|
|
5133
5153
|
*/
|
|
5134
5154
|
export type PayrollFringeBenefitPlanParameters = {
|
|
5135
5155
|
/**
|
|
5136
|
-
*
|
|
5156
|
+
* ID of the pay schedule that owns the plan, stable across all of its versions. Required.
|
|
5137
5157
|
*/
|
|
5138
|
-
|
|
5158
|
+
timekeeping_pay_period_config_id: string;
|
|
5139
5159
|
/**
|
|
5140
5160
|
* Human-readable name of the plan. Required.
|
|
5141
5161
|
*/
|
|
@@ -5194,13 +5214,9 @@ export type PayrollFringeBenefitPlanParameters = {
|
|
|
5194
5214
|
*/
|
|
5195
5215
|
export type PayrollExternalMapResponseObject = {
|
|
5196
5216
|
/**
|
|
5197
|
-
*
|
|
5217
|
+
* Identity shared by every version of the map, never a per-version row id — the value other resources store to reference it (a paystub line item's payrolls_external_map_id).
|
|
5198
5218
|
*/
|
|
5199
5219
|
id: string;
|
|
5200
|
-
/**
|
|
5201
|
-
* Identity shared by every version of the map — the value other resources store to reference it (a paystub line item's payrolls_external_map_id).
|
|
5202
|
-
*/
|
|
5203
|
-
bitemporal_id: string;
|
|
5204
5220
|
/**
|
|
5205
5221
|
* The external system's field name for the mapped compensation element.
|
|
5206
5222
|
*/
|
|
@@ -5218,9 +5234,9 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5218
5234
|
*/
|
|
5219
5235
|
compensation_element_category: 'tax' | 'health' | 'retirement' | 'insurance' | 'earning' | 'garnishment' | 'other';
|
|
5220
5236
|
/**
|
|
5221
|
-
*
|
|
5237
|
+
* ID of the owning pay schedule; null for a global map shared across companies.
|
|
5222
5238
|
*/
|
|
5223
|
-
|
|
5239
|
+
timekeeping_pay_period_config_id: string | null;
|
|
5224
5240
|
/**
|
|
5225
5241
|
* ID of the fringe-benefit plan this map contributes to; null when none.
|
|
5226
5242
|
*/
|
|
@@ -5242,9 +5258,9 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5242
5258
|
*/
|
|
5243
5259
|
global: boolean;
|
|
5244
5260
|
/**
|
|
5245
|
-
* Valid time — when this version starts being true in business reality (ISO 8601).
|
|
5261
|
+
* Valid time — when this version starts being true in business reality (ISO 8601); never null for this resource — a lower bound is always recorded.
|
|
5246
5262
|
*/
|
|
5247
|
-
valid_from: string;
|
|
5263
|
+
valid_from: string | null;
|
|
5248
5264
|
/**
|
|
5249
5265
|
* Valid time — when this version stops being true (ISO 8601); null while it is still current.
|
|
5250
5266
|
*/
|
|
@@ -5268,18 +5284,17 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5268
5284
|
};
|
|
5269
5285
|
export type PayrollExternalMapHistoryVersionObject = {
|
|
5270
5286
|
id: string;
|
|
5271
|
-
bitemporal_id: string;
|
|
5272
5287
|
name: string;
|
|
5273
5288
|
payrolls_compensation_element_id: string;
|
|
5274
5289
|
compensation_element_name: string;
|
|
5275
5290
|
compensation_element_category: 'tax' | 'health' | 'retirement' | 'insurance' | 'earning' | 'garnishment' | 'other';
|
|
5276
|
-
|
|
5291
|
+
timekeeping_pay_period_config_id: string | null;
|
|
5277
5292
|
payrolls_fringe_benefit_plan_id: string | null;
|
|
5278
5293
|
contributor: 'any' | 'employee' | 'employer';
|
|
5279
5294
|
annual_periods: number;
|
|
5280
5295
|
created_by_user_id: string | null;
|
|
5281
5296
|
global: boolean;
|
|
5282
|
-
valid_from: string;
|
|
5297
|
+
valid_from: string | null;
|
|
5283
5298
|
valid_to: string | null;
|
|
5284
5299
|
transaction_from: string;
|
|
5285
5300
|
transaction_to: string | null;
|
|
@@ -7327,9 +7342,9 @@ export type FederalJobWageDeterminationResponseObject = {
|
|
|
7327
7342
|
*/
|
|
7328
7343
|
general_wage_determination: string | null;
|
|
7329
7344
|
/**
|
|
7330
|
-
* Valid time — when this version of the determination took effect (ISO 8601).
|
|
7345
|
+
* Valid time — when this version of the determination took effect (ISO 8601); null when the version has no recorded start.
|
|
7331
7346
|
*/
|
|
7332
|
-
valid_from: string;
|
|
7347
|
+
valid_from: string | null;
|
|
7333
7348
|
/**
|
|
7334
7349
|
* Valid time — when this version stopped applying (ISO 8601); null while it is still current.
|
|
7335
7350
|
*/
|
|
@@ -7385,9 +7400,9 @@ export type RegionalJobWageDeterminationResponseObject = {
|
|
|
7385
7400
|
general_wage_determination: string | null;
|
|
7386
7401
|
regional_fields: RegionalWageDeterminationFields;
|
|
7387
7402
|
/**
|
|
7388
|
-
* Valid time — when this version of the determination took effect (ISO 8601).
|
|
7403
|
+
* Valid time — when this version of the determination took effect (ISO 8601); null when the version has no recorded start.
|
|
7389
7404
|
*/
|
|
7390
|
-
valid_from: string;
|
|
7405
|
+
valid_from: string | null;
|
|
7391
7406
|
/**
|
|
7392
7407
|
* Valid time — when this version stopped applying (ISO 8601); null while it is still current.
|
|
7393
7408
|
*/
|
|
@@ -7418,7 +7433,7 @@ export type FederalJobWageDeterminationHistoryVersionObject = {
|
|
|
7418
7433
|
class_code: string | null;
|
|
7419
7434
|
construction_category: 'building' | 'heavy' | 'highway' | 'residential';
|
|
7420
7435
|
general_wage_determination: string | null;
|
|
7421
|
-
valid_from: string;
|
|
7436
|
+
valid_from: string | null;
|
|
7422
7437
|
valid_to: string | null;
|
|
7423
7438
|
created_at: string;
|
|
7424
7439
|
updated_at: string;
|
|
@@ -7436,7 +7451,7 @@ export type RegionalJobWageDeterminationHistoryVersionObject = {
|
|
|
7436
7451
|
fringe_rate_cents: string;
|
|
7437
7452
|
general_wage_determination: string | null;
|
|
7438
7453
|
regional_fields: RegionalWageDeterminationFields;
|
|
7439
|
-
valid_from: string;
|
|
7454
|
+
valid_from: string | null;
|
|
7440
7455
|
valid_to: string | null;
|
|
7441
7456
|
created_at: string;
|
|
7442
7457
|
updated_at: string;
|
|
@@ -7680,9 +7695,9 @@ export type RateRuleResponseObject = {
|
|
|
7680
7695
|
*/
|
|
7681
7696
|
conditions: Array<RateRuleCondition>;
|
|
7682
7697
|
/**
|
|
7683
|
-
* Valid time — when this version of the rule took effect (ISO 8601).
|
|
7698
|
+
* Valid time — when this version of the rule took effect (ISO 8601); null when the version has no recorded start.
|
|
7684
7699
|
*/
|
|
7685
|
-
valid_from: string;
|
|
7700
|
+
valid_from: string | null;
|
|
7686
7701
|
/**
|
|
7687
7702
|
* Valid time — when this version stopped applying (ISO 8601); null while it is still current.
|
|
7688
7703
|
*/
|
|
@@ -7703,7 +7718,7 @@ export type RateRuleHistoryVersionObject = {
|
|
|
7703
7718
|
pay_rates_rule_package_id: string;
|
|
7704
7719
|
effect: RateRuleEffect;
|
|
7705
7720
|
conditions: Array<RateRuleCondition>;
|
|
7706
|
-
valid_from: string;
|
|
7721
|
+
valid_from: string | null;
|
|
7707
7722
|
valid_to: string | null;
|
|
7708
7723
|
created_at: string;
|
|
7709
7724
|
updated_at: string;
|
|
@@ -13096,6 +13111,50 @@ export type ListFormDefinitionsResponses = {
|
|
|
13096
13111
|
200: FormDefinitionResponseObject;
|
|
13097
13112
|
};
|
|
13098
13113
|
export type ListFormDefinitionsResponse = ListFormDefinitionsResponses[keyof ListFormDefinitionsResponses];
|
|
13114
|
+
export type ListFormSubmissionDeltasData = {
|
|
13115
|
+
body?: never;
|
|
13116
|
+
path?: never;
|
|
13117
|
+
query?: {
|
|
13118
|
+
'filter[event]'?: 'create' | 'update' | 'destroy';
|
|
13119
|
+
'filter[created_at][gte]'?: string;
|
|
13120
|
+
'filter[created_at][lte]'?: string;
|
|
13121
|
+
filter?: string;
|
|
13122
|
+
'filter[unexpected]'?: string;
|
|
13123
|
+
/**
|
|
13124
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
13125
|
+
* `meta.page.next_cursor`.
|
|
13126
|
+
*/
|
|
13127
|
+
'page[cursor]'?: string;
|
|
13128
|
+
/**
|
|
13129
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
13130
|
+
*/
|
|
13131
|
+
'page[limit]'?: number;
|
|
13132
|
+
page?: string;
|
|
13133
|
+
};
|
|
13134
|
+
url: '/api/v1/form_submissions/deltas';
|
|
13135
|
+
};
|
|
13136
|
+
export type ListFormSubmissionDeltasErrors = {
|
|
13137
|
+
/**
|
|
13138
|
+
* Bad Request
|
|
13139
|
+
*/
|
|
13140
|
+
400: Problem;
|
|
13141
|
+
/**
|
|
13142
|
+
* Forbidden
|
|
13143
|
+
*/
|
|
13144
|
+
403: Problem;
|
|
13145
|
+
/**
|
|
13146
|
+
* Unprocessable Content
|
|
13147
|
+
*/
|
|
13148
|
+
422: Problem;
|
|
13149
|
+
};
|
|
13150
|
+
export type ListFormSubmissionDeltasError = ListFormSubmissionDeltasErrors[keyof ListFormSubmissionDeltasErrors];
|
|
13151
|
+
export type ListFormSubmissionDeltasResponses = {
|
|
13152
|
+
/**
|
|
13153
|
+
* Success
|
|
13154
|
+
*/
|
|
13155
|
+
200: FormSubmissionDeltasResponse;
|
|
13156
|
+
};
|
|
13157
|
+
export type ListFormSubmissionDeltasResponse = ListFormSubmissionDeltasResponses[keyof ListFormSubmissionDeltasResponses];
|
|
13099
13158
|
export type ListFormSubmissionsData = {
|
|
13100
13159
|
body?: never;
|
|
13101
13160
|
path?: never;
|
|
@@ -14264,7 +14323,7 @@ export type ListExternalMapHistoryData = {
|
|
|
14264
14323
|
body?: never;
|
|
14265
14324
|
path: {
|
|
14266
14325
|
/**
|
|
14267
|
-
* The external map's version-stable identity, as returned in `
|
|
14326
|
+
* The external map's version-stable identity, as returned in `id`.
|
|
14268
14327
|
*/
|
|
14269
14328
|
external_map_id: string;
|
|
14270
14329
|
};
|
|
@@ -14314,7 +14373,7 @@ export type ListExternalMapsData = {
|
|
|
14314
14373
|
/**
|
|
14315
14374
|
* Narrow to one pay schedule
|
|
14316
14375
|
*/
|
|
14317
|
-
'filter[
|
|
14376
|
+
'filter[timekeeping_pay_period_config_id]'?: string;
|
|
14318
14377
|
/**
|
|
14319
14378
|
* true → only global maps; false → only company-owned
|
|
14320
14379
|
*/
|
|
@@ -14417,7 +14476,7 @@ export type ListFringeBenefitPlansData = {
|
|
|
14417
14476
|
/**
|
|
14418
14477
|
* Narrow to one pay schedule
|
|
14419
14478
|
*/
|
|
14420
|
-
'filter[
|
|
14479
|
+
'filter[timekeeping_pay_period_config_id]'?: string;
|
|
14421
14480
|
filter?: string;
|
|
14422
14481
|
'filter[unexpected]'?: string;
|
|
14423
14482
|
/**
|
|
@@ -14971,6 +15030,10 @@ export type DeletePaystubErrors = {
|
|
|
14971
15030
|
* Not Found
|
|
14972
15031
|
*/
|
|
14973
15032
|
404: Problem;
|
|
15033
|
+
/**
|
|
15034
|
+
* Unprocessable Content
|
|
15035
|
+
*/
|
|
15036
|
+
422: Problem;
|
|
14974
15037
|
};
|
|
14975
15038
|
export type DeletePaystubError = DeletePaystubErrors[keyof DeletePaystubErrors];
|
|
14976
15039
|
export type DeletePaystubResponses = {
|
|
@@ -17193,10 +17256,10 @@ export type CreateManagerTimeEntryApprovalResponse = CreateManagerTimeEntryAppro
|
|
|
17193
17256
|
export type ListAttestationConfigsData = {
|
|
17194
17257
|
body?: never;
|
|
17195
17258
|
path: {
|
|
17196
|
-
|
|
17259
|
+
pay_period_config_id: string;
|
|
17197
17260
|
};
|
|
17198
17261
|
query?: never;
|
|
17199
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17262
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs';
|
|
17200
17263
|
};
|
|
17201
17264
|
export type ListAttestationConfigsErrors = {
|
|
17202
17265
|
/**
|
|
@@ -17223,10 +17286,10 @@ export type ListAttestationConfigsResponse = ListAttestationConfigsResponses[key
|
|
|
17223
17286
|
export type CreateAttestationConfigData = {
|
|
17224
17287
|
body?: AttestationConfigParameters;
|
|
17225
17288
|
path: {
|
|
17226
|
-
|
|
17289
|
+
pay_period_config_id: string;
|
|
17227
17290
|
};
|
|
17228
17291
|
query?: never;
|
|
17229
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17292
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs';
|
|
17230
17293
|
};
|
|
17231
17294
|
export type CreateAttestationConfigErrors = {
|
|
17232
17295
|
/**
|
|
@@ -17253,11 +17316,11 @@ export type CreateAttestationConfigResponse = CreateAttestationConfigResponses[k
|
|
|
17253
17316
|
export type DeleteAttestationConfigData = {
|
|
17254
17317
|
body?: never;
|
|
17255
17318
|
path: {
|
|
17256
|
-
|
|
17319
|
+
pay_period_config_id: string;
|
|
17257
17320
|
id: string;
|
|
17258
17321
|
};
|
|
17259
17322
|
query?: never;
|
|
17260
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17323
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs/{id}';
|
|
17261
17324
|
};
|
|
17262
17325
|
export type DeleteAttestationConfigErrors = {
|
|
17263
17326
|
/**
|
|
@@ -17280,11 +17343,11 @@ export type DeleteAttestationConfigResponse = DeleteAttestationConfigResponses[k
|
|
|
17280
17343
|
export type GetAttestationConfigData = {
|
|
17281
17344
|
body?: never;
|
|
17282
17345
|
path: {
|
|
17283
|
-
|
|
17346
|
+
pay_period_config_id: string;
|
|
17284
17347
|
id: string;
|
|
17285
17348
|
};
|
|
17286
17349
|
query?: never;
|
|
17287
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17350
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs/{id}';
|
|
17288
17351
|
};
|
|
17289
17352
|
export type GetAttestationConfigErrors = {
|
|
17290
17353
|
/**
|
|
@@ -17308,14 +17371,14 @@ export type ListPayPeriodConfigHistoryData = {
|
|
|
17308
17371
|
body?: never;
|
|
17309
17372
|
path: {
|
|
17310
17373
|
/**
|
|
17311
|
-
* The pay schedule's version-stable identity, as returned in `
|
|
17374
|
+
* The pay schedule's version-stable identity, as returned in `id`.
|
|
17312
17375
|
*/
|
|
17313
|
-
|
|
17376
|
+
pay_period_config_id: string;
|
|
17314
17377
|
};
|
|
17315
17378
|
query?: {
|
|
17316
17379
|
'as_of[valid]'?: string;
|
|
17317
17380
|
};
|
|
17318
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17381
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/history';
|
|
17319
17382
|
};
|
|
17320
17383
|
export type ListPayPeriodConfigHistoryErrors = {
|
|
17321
17384
|
/**
|
|
@@ -17347,9 +17410,9 @@ export type ListHolidaysData = {
|
|
|
17347
17410
|
body?: never;
|
|
17348
17411
|
path: {
|
|
17349
17412
|
/**
|
|
17350
|
-
*
|
|
17413
|
+
* ID of the pay schedule
|
|
17351
17414
|
*/
|
|
17352
|
-
|
|
17415
|
+
pay_period_config_id: string;
|
|
17353
17416
|
};
|
|
17354
17417
|
query?: {
|
|
17355
17418
|
/**
|
|
@@ -17377,7 +17440,7 @@ export type ListHolidaysData = {
|
|
|
17377
17440
|
'page[limit]'?: number;
|
|
17378
17441
|
page?: string;
|
|
17379
17442
|
};
|
|
17380
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17443
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays';
|
|
17381
17444
|
};
|
|
17382
17445
|
export type ListHolidaysErrors = {
|
|
17383
17446
|
/**
|
|
@@ -17413,12 +17476,12 @@ export type CreateHolidayData = {
|
|
|
17413
17476
|
body: HolidayParameters;
|
|
17414
17477
|
path: {
|
|
17415
17478
|
/**
|
|
17416
|
-
*
|
|
17479
|
+
* ID of the pay schedule
|
|
17417
17480
|
*/
|
|
17418
|
-
|
|
17481
|
+
pay_period_config_id: string;
|
|
17419
17482
|
};
|
|
17420
17483
|
query?: never;
|
|
17421
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17484
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays';
|
|
17422
17485
|
};
|
|
17423
17486
|
export type CreateHolidayErrors = {
|
|
17424
17487
|
/**
|
|
@@ -17446,13 +17509,13 @@ export type DeleteHolidayData = {
|
|
|
17446
17509
|
body?: never;
|
|
17447
17510
|
path: {
|
|
17448
17511
|
/**
|
|
17449
|
-
*
|
|
17512
|
+
* ID of the pay schedule
|
|
17450
17513
|
*/
|
|
17451
|
-
|
|
17514
|
+
pay_period_config_id: string;
|
|
17452
17515
|
id: string;
|
|
17453
17516
|
};
|
|
17454
17517
|
query?: never;
|
|
17455
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17518
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays/{id}';
|
|
17456
17519
|
};
|
|
17457
17520
|
export type DeleteHolidayErrors = {
|
|
17458
17521
|
/**
|
|
@@ -17472,13 +17535,13 @@ export type UpdateHolidayData = {
|
|
|
17472
17535
|
body: HolidayParameters;
|
|
17473
17536
|
path: {
|
|
17474
17537
|
/**
|
|
17475
|
-
*
|
|
17538
|
+
* ID of the pay schedule
|
|
17476
17539
|
*/
|
|
17477
|
-
|
|
17540
|
+
pay_period_config_id: string;
|
|
17478
17541
|
id: string;
|
|
17479
17542
|
};
|
|
17480
17543
|
query?: never;
|
|
17481
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17544
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays/{id}';
|
|
17482
17545
|
};
|
|
17483
17546
|
export type UpdateHolidayErrors = {
|
|
17484
17547
|
/**
|
|
@@ -17552,7 +17615,7 @@ export type ListPayPeriodConfigsResponse = ListPayPeriodConfigsResponses[keyof L
|
|
|
17552
17615
|
export type GetPayPeriodConfigData = {
|
|
17553
17616
|
body?: never;
|
|
17554
17617
|
path: {
|
|
17555
|
-
|
|
17618
|
+
id: string;
|
|
17556
17619
|
};
|
|
17557
17620
|
query?: {
|
|
17558
17621
|
/**
|
|
@@ -17560,7 +17623,7 @@ export type GetPayPeriodConfigData = {
|
|
|
17560
17623
|
*/
|
|
17561
17624
|
'as_of[valid]'?: string;
|
|
17562
17625
|
};
|
|
17563
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17626
|
+
url: '/api/v1/timekeeping/pay_period_configs/{id}';
|
|
17564
17627
|
};
|
|
17565
17628
|
export type GetPayPeriodConfigErrors = {
|
|
17566
17629
|
/**
|