@dsptch-work/api-client 0.7.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 +70 -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 -87
- package/dist/gen/zod.gen.d.ts +194 -145
- package/dist/gen/zod.gen.js +73 -47
- 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';
|
|
@@ -2751,10 +2751,6 @@ export type JobParameters = {
|
|
|
2751
2751
|
*/
|
|
2752
2752
|
tz_name?: string;
|
|
2753
2753
|
time_card_start_day?: TimeCardStartDay;
|
|
2754
|
-
/**
|
|
2755
|
-
* Compatibility alias — true ensures at least warning (never downgrades required); false or null clears to none; omit to leave unchanged. Prefer clock_in_requirement.
|
|
2756
|
-
*/
|
|
2757
|
-
require_clock_in?: boolean | null;
|
|
2758
2754
|
/**
|
|
2759
2755
|
* Clock-in enforcement level: one of none (no guidance), warning (compliance warning on manual entries), or required (hard stop for technician web CUD and GraphQL owner CUD, including client-claimed punches, until a server-verified punch path exists; company-authed API v1 is intentionally ungated). Omit the field to leave the current value unchanged.
|
|
2760
2756
|
*/
|
|
@@ -3118,9 +3114,9 @@ export type UserResponseObject = {
|
|
|
3118
3114
|
*/
|
|
3119
3115
|
employment_window: {
|
|
3120
3116
|
/**
|
|
3121
|
-
* 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.
|
|
3122
3118
|
*/
|
|
3123
|
-
valid_from: string;
|
|
3119
|
+
valid_from: string | null;
|
|
3124
3120
|
/**
|
|
3125
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.
|
|
3126
3122
|
*/
|
|
@@ -4325,6 +4321,30 @@ export type UserGroupParameters = {
|
|
|
4325
4321
|
*/
|
|
4326
4322
|
user_ids: Array<string>;
|
|
4327
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
|
+
};
|
|
4328
4348
|
/**
|
|
4329
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.
|
|
4330
4350
|
*/
|
|
@@ -4434,13 +4454,9 @@ export type PayPeriodsResponseObject = {
|
|
|
4434
4454
|
*/
|
|
4435
4455
|
id?: string;
|
|
4436
4456
|
/**
|
|
4437
|
-
* ID of the
|
|
4457
|
+
* ID of the pay schedule (PayPeriodConfig) that owns this pay period, stable across all of its versions.
|
|
4438
4458
|
*/
|
|
4439
4459
|
timekeeping_pay_period_config_id?: string;
|
|
4440
|
-
/**
|
|
4441
|
-
* Stable identifier of the pay schedule across all of its versions.
|
|
4442
|
-
*/
|
|
4443
|
-
pay_period_config_uid?: string;
|
|
4444
4460
|
/**
|
|
4445
4461
|
* Calendar date (YYYY-MM-DD) that workers are paid for this period.
|
|
4446
4462
|
*/
|
|
@@ -5068,9 +5084,9 @@ export type PayrollFringeBenefitPlanResponseObject = {
|
|
|
5068
5084
|
*/
|
|
5069
5085
|
id: string;
|
|
5070
5086
|
/**
|
|
5071
|
-
*
|
|
5087
|
+
* ID of the pay schedule that owns this plan, stable across all of its versions.
|
|
5072
5088
|
*/
|
|
5073
|
-
|
|
5089
|
+
timekeeping_pay_period_config_id: string;
|
|
5074
5090
|
/**
|
|
5075
5091
|
* Human-readable name of the plan.
|
|
5076
5092
|
*/
|
|
@@ -5133,13 +5149,13 @@ export type PayrollFringeBenefitPlanResponseObject = {
|
|
|
5133
5149
|
updated_at: string;
|
|
5134
5150
|
};
|
|
5135
5151
|
/**
|
|
5136
|
-
* 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.
|
|
5137
5153
|
*/
|
|
5138
5154
|
export type PayrollFringeBenefitPlanParameters = {
|
|
5139
5155
|
/**
|
|
5140
|
-
*
|
|
5156
|
+
* ID of the pay schedule that owns the plan, stable across all of its versions. Required.
|
|
5141
5157
|
*/
|
|
5142
|
-
|
|
5158
|
+
timekeeping_pay_period_config_id: string;
|
|
5143
5159
|
/**
|
|
5144
5160
|
* Human-readable name of the plan. Required.
|
|
5145
5161
|
*/
|
|
@@ -5198,13 +5214,9 @@ export type PayrollFringeBenefitPlanParameters = {
|
|
|
5198
5214
|
*/
|
|
5199
5215
|
export type PayrollExternalMapResponseObject = {
|
|
5200
5216
|
/**
|
|
5201
|
-
*
|
|
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).
|
|
5202
5218
|
*/
|
|
5203
5219
|
id: string;
|
|
5204
|
-
/**
|
|
5205
|
-
* 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).
|
|
5206
|
-
*/
|
|
5207
|
-
bitemporal_id: string;
|
|
5208
5220
|
/**
|
|
5209
5221
|
* The external system's field name for the mapped compensation element.
|
|
5210
5222
|
*/
|
|
@@ -5222,9 +5234,9 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5222
5234
|
*/
|
|
5223
5235
|
compensation_element_category: 'tax' | 'health' | 'retirement' | 'insurance' | 'earning' | 'garnishment' | 'other';
|
|
5224
5236
|
/**
|
|
5225
|
-
*
|
|
5237
|
+
* ID of the owning pay schedule; null for a global map shared across companies.
|
|
5226
5238
|
*/
|
|
5227
|
-
|
|
5239
|
+
timekeeping_pay_period_config_id: string | null;
|
|
5228
5240
|
/**
|
|
5229
5241
|
* ID of the fringe-benefit plan this map contributes to; null when none.
|
|
5230
5242
|
*/
|
|
@@ -5246,9 +5258,9 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5246
5258
|
*/
|
|
5247
5259
|
global: boolean;
|
|
5248
5260
|
/**
|
|
5249
|
-
* 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.
|
|
5250
5262
|
*/
|
|
5251
|
-
valid_from: string;
|
|
5263
|
+
valid_from: string | null;
|
|
5252
5264
|
/**
|
|
5253
5265
|
* Valid time — when this version stops being true (ISO 8601); null while it is still current.
|
|
5254
5266
|
*/
|
|
@@ -5272,18 +5284,17 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5272
5284
|
};
|
|
5273
5285
|
export type PayrollExternalMapHistoryVersionObject = {
|
|
5274
5286
|
id: string;
|
|
5275
|
-
bitemporal_id: string;
|
|
5276
5287
|
name: string;
|
|
5277
5288
|
payrolls_compensation_element_id: string;
|
|
5278
5289
|
compensation_element_name: string;
|
|
5279
5290
|
compensation_element_category: 'tax' | 'health' | 'retirement' | 'insurance' | 'earning' | 'garnishment' | 'other';
|
|
5280
|
-
|
|
5291
|
+
timekeeping_pay_period_config_id: string | null;
|
|
5281
5292
|
payrolls_fringe_benefit_plan_id: string | null;
|
|
5282
5293
|
contributor: 'any' | 'employee' | 'employer';
|
|
5283
5294
|
annual_periods: number;
|
|
5284
5295
|
created_by_user_id: string | null;
|
|
5285
5296
|
global: boolean;
|
|
5286
|
-
valid_from: string;
|
|
5297
|
+
valid_from: string | null;
|
|
5287
5298
|
valid_to: string | null;
|
|
5288
5299
|
transaction_from: string;
|
|
5289
5300
|
transaction_to: string | null;
|
|
@@ -7331,9 +7342,9 @@ export type FederalJobWageDeterminationResponseObject = {
|
|
|
7331
7342
|
*/
|
|
7332
7343
|
general_wage_determination: string | null;
|
|
7333
7344
|
/**
|
|
7334
|
-
* 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.
|
|
7335
7346
|
*/
|
|
7336
|
-
valid_from: string;
|
|
7347
|
+
valid_from: string | null;
|
|
7337
7348
|
/**
|
|
7338
7349
|
* Valid time — when this version stopped applying (ISO 8601); null while it is still current.
|
|
7339
7350
|
*/
|
|
@@ -7389,9 +7400,9 @@ export type RegionalJobWageDeterminationResponseObject = {
|
|
|
7389
7400
|
general_wage_determination: string | null;
|
|
7390
7401
|
regional_fields: RegionalWageDeterminationFields;
|
|
7391
7402
|
/**
|
|
7392
|
-
* 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.
|
|
7393
7404
|
*/
|
|
7394
|
-
valid_from: string;
|
|
7405
|
+
valid_from: string | null;
|
|
7395
7406
|
/**
|
|
7396
7407
|
* Valid time — when this version stopped applying (ISO 8601); null while it is still current.
|
|
7397
7408
|
*/
|
|
@@ -7422,7 +7433,7 @@ export type FederalJobWageDeterminationHistoryVersionObject = {
|
|
|
7422
7433
|
class_code: string | null;
|
|
7423
7434
|
construction_category: 'building' | 'heavy' | 'highway' | 'residential';
|
|
7424
7435
|
general_wage_determination: string | null;
|
|
7425
|
-
valid_from: string;
|
|
7436
|
+
valid_from: string | null;
|
|
7426
7437
|
valid_to: string | null;
|
|
7427
7438
|
created_at: string;
|
|
7428
7439
|
updated_at: string;
|
|
@@ -7440,7 +7451,7 @@ export type RegionalJobWageDeterminationHistoryVersionObject = {
|
|
|
7440
7451
|
fringe_rate_cents: string;
|
|
7441
7452
|
general_wage_determination: string | null;
|
|
7442
7453
|
regional_fields: RegionalWageDeterminationFields;
|
|
7443
|
-
valid_from: string;
|
|
7454
|
+
valid_from: string | null;
|
|
7444
7455
|
valid_to: string | null;
|
|
7445
7456
|
created_at: string;
|
|
7446
7457
|
updated_at: string;
|
|
@@ -7684,9 +7695,9 @@ export type RateRuleResponseObject = {
|
|
|
7684
7695
|
*/
|
|
7685
7696
|
conditions: Array<RateRuleCondition>;
|
|
7686
7697
|
/**
|
|
7687
|
-
* 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.
|
|
7688
7699
|
*/
|
|
7689
|
-
valid_from: string;
|
|
7700
|
+
valid_from: string | null;
|
|
7690
7701
|
/**
|
|
7691
7702
|
* Valid time — when this version stopped applying (ISO 8601); null while it is still current.
|
|
7692
7703
|
*/
|
|
@@ -7707,7 +7718,7 @@ export type RateRuleHistoryVersionObject = {
|
|
|
7707
7718
|
pay_rates_rule_package_id: string;
|
|
7708
7719
|
effect: RateRuleEffect;
|
|
7709
7720
|
conditions: Array<RateRuleCondition>;
|
|
7710
|
-
valid_from: string;
|
|
7721
|
+
valid_from: string | null;
|
|
7711
7722
|
valid_to: string | null;
|
|
7712
7723
|
created_at: string;
|
|
7713
7724
|
updated_at: string;
|
|
@@ -13100,6 +13111,50 @@ export type ListFormDefinitionsResponses = {
|
|
|
13100
13111
|
200: FormDefinitionResponseObject;
|
|
13101
13112
|
};
|
|
13102
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];
|
|
13103
13158
|
export type ListFormSubmissionsData = {
|
|
13104
13159
|
body?: never;
|
|
13105
13160
|
path?: never;
|
|
@@ -14268,7 +14323,7 @@ export type ListExternalMapHistoryData = {
|
|
|
14268
14323
|
body?: never;
|
|
14269
14324
|
path: {
|
|
14270
14325
|
/**
|
|
14271
|
-
* The external map's version-stable identity, as returned in `
|
|
14326
|
+
* The external map's version-stable identity, as returned in `id`.
|
|
14272
14327
|
*/
|
|
14273
14328
|
external_map_id: string;
|
|
14274
14329
|
};
|
|
@@ -14318,7 +14373,7 @@ export type ListExternalMapsData = {
|
|
|
14318
14373
|
/**
|
|
14319
14374
|
* Narrow to one pay schedule
|
|
14320
14375
|
*/
|
|
14321
|
-
'filter[
|
|
14376
|
+
'filter[timekeeping_pay_period_config_id]'?: string;
|
|
14322
14377
|
/**
|
|
14323
14378
|
* true → only global maps; false → only company-owned
|
|
14324
14379
|
*/
|
|
@@ -14421,7 +14476,7 @@ export type ListFringeBenefitPlansData = {
|
|
|
14421
14476
|
/**
|
|
14422
14477
|
* Narrow to one pay schedule
|
|
14423
14478
|
*/
|
|
14424
|
-
'filter[
|
|
14479
|
+
'filter[timekeeping_pay_period_config_id]'?: string;
|
|
14425
14480
|
filter?: string;
|
|
14426
14481
|
'filter[unexpected]'?: string;
|
|
14427
14482
|
/**
|
|
@@ -14975,6 +15030,10 @@ export type DeletePaystubErrors = {
|
|
|
14975
15030
|
* Not Found
|
|
14976
15031
|
*/
|
|
14977
15032
|
404: Problem;
|
|
15033
|
+
/**
|
|
15034
|
+
* Unprocessable Content
|
|
15035
|
+
*/
|
|
15036
|
+
422: Problem;
|
|
14978
15037
|
};
|
|
14979
15038
|
export type DeletePaystubError = DeletePaystubErrors[keyof DeletePaystubErrors];
|
|
14980
15039
|
export type DeletePaystubResponses = {
|
|
@@ -17197,10 +17256,10 @@ export type CreateManagerTimeEntryApprovalResponse = CreateManagerTimeEntryAppro
|
|
|
17197
17256
|
export type ListAttestationConfigsData = {
|
|
17198
17257
|
body?: never;
|
|
17199
17258
|
path: {
|
|
17200
|
-
|
|
17259
|
+
pay_period_config_id: string;
|
|
17201
17260
|
};
|
|
17202
17261
|
query?: never;
|
|
17203
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17262
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs';
|
|
17204
17263
|
};
|
|
17205
17264
|
export type ListAttestationConfigsErrors = {
|
|
17206
17265
|
/**
|
|
@@ -17227,10 +17286,10 @@ export type ListAttestationConfigsResponse = ListAttestationConfigsResponses[key
|
|
|
17227
17286
|
export type CreateAttestationConfigData = {
|
|
17228
17287
|
body?: AttestationConfigParameters;
|
|
17229
17288
|
path: {
|
|
17230
|
-
|
|
17289
|
+
pay_period_config_id: string;
|
|
17231
17290
|
};
|
|
17232
17291
|
query?: never;
|
|
17233
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17292
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs';
|
|
17234
17293
|
};
|
|
17235
17294
|
export type CreateAttestationConfigErrors = {
|
|
17236
17295
|
/**
|
|
@@ -17257,11 +17316,11 @@ export type CreateAttestationConfigResponse = CreateAttestationConfigResponses[k
|
|
|
17257
17316
|
export type DeleteAttestationConfigData = {
|
|
17258
17317
|
body?: never;
|
|
17259
17318
|
path: {
|
|
17260
|
-
|
|
17319
|
+
pay_period_config_id: string;
|
|
17261
17320
|
id: string;
|
|
17262
17321
|
};
|
|
17263
17322
|
query?: never;
|
|
17264
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17323
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs/{id}';
|
|
17265
17324
|
};
|
|
17266
17325
|
export type DeleteAttestationConfigErrors = {
|
|
17267
17326
|
/**
|
|
@@ -17284,11 +17343,11 @@ export type DeleteAttestationConfigResponse = DeleteAttestationConfigResponses[k
|
|
|
17284
17343
|
export type GetAttestationConfigData = {
|
|
17285
17344
|
body?: never;
|
|
17286
17345
|
path: {
|
|
17287
|
-
|
|
17346
|
+
pay_period_config_id: string;
|
|
17288
17347
|
id: string;
|
|
17289
17348
|
};
|
|
17290
17349
|
query?: never;
|
|
17291
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17350
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs/{id}';
|
|
17292
17351
|
};
|
|
17293
17352
|
export type GetAttestationConfigErrors = {
|
|
17294
17353
|
/**
|
|
@@ -17312,14 +17371,14 @@ export type ListPayPeriodConfigHistoryData = {
|
|
|
17312
17371
|
body?: never;
|
|
17313
17372
|
path: {
|
|
17314
17373
|
/**
|
|
17315
|
-
* The pay schedule's version-stable identity, as returned in `
|
|
17374
|
+
* The pay schedule's version-stable identity, as returned in `id`.
|
|
17316
17375
|
*/
|
|
17317
|
-
|
|
17376
|
+
pay_period_config_id: string;
|
|
17318
17377
|
};
|
|
17319
17378
|
query?: {
|
|
17320
17379
|
'as_of[valid]'?: string;
|
|
17321
17380
|
};
|
|
17322
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17381
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/history';
|
|
17323
17382
|
};
|
|
17324
17383
|
export type ListPayPeriodConfigHistoryErrors = {
|
|
17325
17384
|
/**
|
|
@@ -17351,9 +17410,9 @@ export type ListHolidaysData = {
|
|
|
17351
17410
|
body?: never;
|
|
17352
17411
|
path: {
|
|
17353
17412
|
/**
|
|
17354
|
-
*
|
|
17413
|
+
* ID of the pay schedule
|
|
17355
17414
|
*/
|
|
17356
|
-
|
|
17415
|
+
pay_period_config_id: string;
|
|
17357
17416
|
};
|
|
17358
17417
|
query?: {
|
|
17359
17418
|
/**
|
|
@@ -17381,7 +17440,7 @@ export type ListHolidaysData = {
|
|
|
17381
17440
|
'page[limit]'?: number;
|
|
17382
17441
|
page?: string;
|
|
17383
17442
|
};
|
|
17384
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17443
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays';
|
|
17385
17444
|
};
|
|
17386
17445
|
export type ListHolidaysErrors = {
|
|
17387
17446
|
/**
|
|
@@ -17417,12 +17476,12 @@ export type CreateHolidayData = {
|
|
|
17417
17476
|
body: HolidayParameters;
|
|
17418
17477
|
path: {
|
|
17419
17478
|
/**
|
|
17420
|
-
*
|
|
17479
|
+
* ID of the pay schedule
|
|
17421
17480
|
*/
|
|
17422
|
-
|
|
17481
|
+
pay_period_config_id: string;
|
|
17423
17482
|
};
|
|
17424
17483
|
query?: never;
|
|
17425
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17484
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays';
|
|
17426
17485
|
};
|
|
17427
17486
|
export type CreateHolidayErrors = {
|
|
17428
17487
|
/**
|
|
@@ -17450,13 +17509,13 @@ export type DeleteHolidayData = {
|
|
|
17450
17509
|
body?: never;
|
|
17451
17510
|
path: {
|
|
17452
17511
|
/**
|
|
17453
|
-
*
|
|
17512
|
+
* ID of the pay schedule
|
|
17454
17513
|
*/
|
|
17455
|
-
|
|
17514
|
+
pay_period_config_id: string;
|
|
17456
17515
|
id: string;
|
|
17457
17516
|
};
|
|
17458
17517
|
query?: never;
|
|
17459
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17518
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays/{id}';
|
|
17460
17519
|
};
|
|
17461
17520
|
export type DeleteHolidayErrors = {
|
|
17462
17521
|
/**
|
|
@@ -17476,13 +17535,13 @@ export type UpdateHolidayData = {
|
|
|
17476
17535
|
body: HolidayParameters;
|
|
17477
17536
|
path: {
|
|
17478
17537
|
/**
|
|
17479
|
-
*
|
|
17538
|
+
* ID of the pay schedule
|
|
17480
17539
|
*/
|
|
17481
|
-
|
|
17540
|
+
pay_period_config_id: string;
|
|
17482
17541
|
id: string;
|
|
17483
17542
|
};
|
|
17484
17543
|
query?: never;
|
|
17485
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17544
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays/{id}';
|
|
17486
17545
|
};
|
|
17487
17546
|
export type UpdateHolidayErrors = {
|
|
17488
17547
|
/**
|
|
@@ -17556,7 +17615,7 @@ export type ListPayPeriodConfigsResponse = ListPayPeriodConfigsResponses[keyof L
|
|
|
17556
17615
|
export type GetPayPeriodConfigData = {
|
|
17557
17616
|
body?: never;
|
|
17558
17617
|
path: {
|
|
17559
|
-
|
|
17618
|
+
id: string;
|
|
17560
17619
|
};
|
|
17561
17620
|
query?: {
|
|
17562
17621
|
/**
|
|
@@ -17564,7 +17623,7 @@ export type GetPayPeriodConfigData = {
|
|
|
17564
17623
|
*/
|
|
17565
17624
|
'as_of[valid]'?: string;
|
|
17566
17625
|
};
|
|
17567
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17626
|
+
url: '/api/v1/timekeeping/pay_period_configs/{id}';
|
|
17568
17627
|
};
|
|
17569
17628
|
export type GetPayPeriodConfigErrors = {
|
|
17570
17629
|
/**
|