@dsptch-work/api-client 0.27.0 → 0.29.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 +27 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +30 -1
- package/dist/gen/sdk.gen.js +51 -0
- package/dist/gen/types.gen.d.ts +247 -5
- package/dist/gen/zod.gen.d.ts +174 -2
- package/dist/gen/zod.gen.js +85 -2
- package/package.json +2 -2
package/dist/gen/zod.gen.d.ts
CHANGED
|
@@ -439,6 +439,7 @@ export declare const zDirectUploadParameters: z.ZodObject<{
|
|
|
439
439
|
"pay_periods.imports.dsptch_cprs": "pay_periods.imports.dsptch_cprs";
|
|
440
440
|
"pay_periods.imports.time_entries": "pay_periods.imports.time_entries";
|
|
441
441
|
"payrolls.payroll_runs.imports.paystubs": "payrolls.payroll_runs.imports.paystubs";
|
|
442
|
+
"payrolls.payroll_runs.imports.wide_paystubs": "payrolls.payroll_runs.imports.wide_paystubs";
|
|
442
443
|
users: "users";
|
|
443
444
|
}>;
|
|
444
445
|
blob: z.ZodObject<{
|
|
@@ -2394,6 +2395,7 @@ export declare const zFormDefinitionObject: z.ZodObject<{
|
|
|
2394
2395
|
title_keys: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
2395
2396
|
editable: z.ZodBoolean;
|
|
2396
2397
|
always_visible: z.ZodBoolean;
|
|
2398
|
+
assignment_only: z.ZodBoolean;
|
|
2397
2399
|
sensitive_form: z.ZodBoolean;
|
|
2398
2400
|
allow_carry_forward: z.ZodBoolean;
|
|
2399
2401
|
current_revision: z.ZodNullable<z.ZodInt>;
|
|
@@ -3134,6 +3136,40 @@ export declare const zPaystubImportResponseObject: z.ZodObject<{
|
|
|
3134
3136
|
export declare const zPaystubImportParameters: z.ZodObject<{
|
|
3135
3137
|
file_signed_id: z.ZodString;
|
|
3136
3138
|
}, z.core.$strip>;
|
|
3139
|
+
/**
|
|
3140
|
+
* One bulk upload of wide paystub amounts against a payroll run, and how it turned out.
|
|
3141
|
+
*/
|
|
3142
|
+
export declare const zWidePaystubImportResponseObject: z.ZodObject<{
|
|
3143
|
+
id: z.ZodString;
|
|
3144
|
+
payrolls_payroll_run_id: z.ZodString;
|
|
3145
|
+
status: z.ZodEnum<{
|
|
3146
|
+
pending: "pending";
|
|
3147
|
+
failed: "failed";
|
|
3148
|
+
success: "success";
|
|
3149
|
+
processing: "processing";
|
|
3150
|
+
processed: "processed";
|
|
3151
|
+
superseded: "superseded";
|
|
3152
|
+
withdrawn: "withdrawn";
|
|
3153
|
+
}>;
|
|
3154
|
+
processed_rows_count: z.ZodInt;
|
|
3155
|
+
processing_errors: z.ZodArray<z.ZodObject<{
|
|
3156
|
+
code: z.ZodString;
|
|
3157
|
+
row: z.ZodNullable<z.ZodInt>;
|
|
3158
|
+
column: z.ZodNullable<z.ZodString>;
|
|
3159
|
+
context: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
3160
|
+
}, z.core.$strip>>;
|
|
3161
|
+
completed_at: z.ZodNullable<z.ZodISODateTime>;
|
|
3162
|
+
created_at: z.ZodISODateTime;
|
|
3163
|
+
updated_at: z.ZodISODateTime;
|
|
3164
|
+
}, z.core.$strip>;
|
|
3165
|
+
/**
|
|
3166
|
+
* Submit a spreadsheet of wide paystub amounts for a payroll run. Each row is one employee: payroll_id names them, and every other column is a pay, deduction, or contribution amount. Extra pay-element columns are accepted; they are not unknown columns. The run's pay schedule must record the contributor on the external map (`requires_external_map_contributor`) and must not be connected to a payroll provider; where a provider is configured the paystubs come from that connection and a file is refused. payroll_id must be present as a header and carry a value on every row, or the file is refused naming what is missing. Header matching ignores case and treats spaces as underscores, and column order does not matter.
|
|
3167
|
+
*
|
|
3168
|
+
* Because acceptance is synchronous but the write happens in the background, only one wide paystub import at a time is accepted for a payroll run: while an earlier one is still `pending` or `processing`, a second answers 409 naming `import_in_progress`, and nothing is written. Poll the earlier import until it reports, then submit again.
|
|
3169
|
+
*/
|
|
3170
|
+
export declare const zWidePaystubImportParameters: z.ZodObject<{
|
|
3171
|
+
file_signed_id: z.ZodString;
|
|
3172
|
+
}, z.core.$strip>;
|
|
3137
3173
|
/**
|
|
3138
3174
|
* One bulk upload of time entries against a pay period, and how it turned out.
|
|
3139
3175
|
*/
|
|
@@ -4625,7 +4661,7 @@ export declare const zPaystubLineItemResponseObject: z.ZodObject<{
|
|
|
4625
4661
|
updated_at: z.ZodISODateTime;
|
|
4626
4662
|
}, z.core.$strip>;
|
|
4627
4663
|
/**
|
|
4628
|
-
* Request body for creating a paystub line item. All four fields are required.
|
|
4664
|
+
* Request body for creating a paystub line item. All four fields are required. Undeclared body keys are rejected with 400; references outside the authenticated company return 404.
|
|
4629
4665
|
*/
|
|
4630
4666
|
export declare const zPaystubLineItemParameters: z.ZodObject<{
|
|
4631
4667
|
payrolls_paystub_id: z.ZodString;
|
|
@@ -4637,7 +4673,7 @@ export declare const zPaystubLineItemParameters: z.ZodObject<{
|
|
|
4637
4673
|
payrolls_external_map_id: z.ZodString;
|
|
4638
4674
|
}, z.core.$strip>;
|
|
4639
4675
|
/**
|
|
4640
|
-
* Request body for updating a paystub line item. Send only the fields to change.
|
|
4676
|
+
* Request body for updating a paystub line item. Send only the fields to change. Undeclared body keys are rejected with 400; newly supplied references outside the authenticated company return 404.
|
|
4641
4677
|
*/
|
|
4642
4678
|
export declare const zPaystubLineItemUpdateParameters: z.ZodObject<{
|
|
4643
4679
|
payrolls_paystub_id: z.ZodOptional<z.ZodString>;
|
|
@@ -6109,6 +6145,7 @@ export declare const zFormDefinitionResponseObject: z.ZodObject<{
|
|
|
6109
6145
|
title_keys: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
6110
6146
|
editable: z.ZodBoolean;
|
|
6111
6147
|
always_visible: z.ZodBoolean;
|
|
6148
|
+
assignment_only: z.ZodBoolean;
|
|
6112
6149
|
sensitive_form: z.ZodBoolean;
|
|
6113
6150
|
allow_carry_forward: z.ZodBoolean;
|
|
6114
6151
|
current_revision: z.ZodNullable<z.ZodInt>;
|
|
@@ -6648,6 +6685,7 @@ export declare const zDateTimeFilter: z.ZodNullable<z.ZodObject<{
|
|
|
6648
6685
|
*/
|
|
6649
6686
|
export declare const zWageDeterminationResponseObject: z.ZodObject<{
|
|
6650
6687
|
id: z.ZodString;
|
|
6688
|
+
uid: z.ZodUUID;
|
|
6651
6689
|
general_decision_number: z.ZodString;
|
|
6652
6690
|
modification_number: z.ZodInt;
|
|
6653
6691
|
superseded_by_wage_determination_id: z.ZodNullable<z.ZodString>;
|
|
@@ -6675,6 +6713,7 @@ export declare const zWageDeterminationsResponseObject: z.ZodObject<{
|
|
|
6675
6713
|
}, z.core.$strip>;
|
|
6676
6714
|
data: z.ZodArray<z.ZodObject<{
|
|
6677
6715
|
id: z.ZodString;
|
|
6716
|
+
uid: z.ZodUUID;
|
|
6678
6717
|
general_decision_number: z.ZodString;
|
|
6679
6718
|
modification_number: z.ZodInt;
|
|
6680
6719
|
superseded_by_wage_determination_id: z.ZodNullable<z.ZodString>;
|
|
@@ -9659,6 +9698,7 @@ export declare const zListApprenticesPath: z.ZodObject<{
|
|
|
9659
9698
|
export declare const zListApprenticesQuery: z.ZodObject<{
|
|
9660
9699
|
'filter[user_id]': z.ZodOptional<z.ZodString>;
|
|
9661
9700
|
'filter[status]': z.ZodOptional<z.ZodString>;
|
|
9701
|
+
'filter[name]': z.ZodOptional<z.ZodString>;
|
|
9662
9702
|
'filter[created_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
9663
9703
|
'filter[created_at][lte]': z.ZodOptional<z.ZodISODateTime>;
|
|
9664
9704
|
'filter[updated_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
@@ -15740,6 +15780,7 @@ export declare const zCreateDirectUploadBody: z.ZodObject<{
|
|
|
15740
15780
|
"pay_periods.imports.dsptch_cprs": "pay_periods.imports.dsptch_cprs";
|
|
15741
15781
|
"pay_periods.imports.time_entries": "pay_periods.imports.time_entries";
|
|
15742
15782
|
"payrolls.payroll_runs.imports.paystubs": "payrolls.payroll_runs.imports.paystubs";
|
|
15783
|
+
"payrolls.payroll_runs.imports.wide_paystubs": "payrolls.payroll_runs.imports.wide_paystubs";
|
|
15743
15784
|
users: "users";
|
|
15744
15785
|
}>;
|
|
15745
15786
|
blob: z.ZodObject<{
|
|
@@ -15812,6 +15853,7 @@ export declare const zListFormDefinitionsResponse: z.ZodObject<{
|
|
|
15812
15853
|
title_keys: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
15813
15854
|
editable: z.ZodBoolean;
|
|
15814
15855
|
always_visible: z.ZodBoolean;
|
|
15856
|
+
assignment_only: z.ZodBoolean;
|
|
15815
15857
|
sensitive_form: z.ZodBoolean;
|
|
15816
15858
|
allow_carry_forward: z.ZodBoolean;
|
|
15817
15859
|
current_revision: z.ZodNullable<z.ZodInt>;
|
|
@@ -15835,6 +15877,7 @@ export declare const zGetFormDefinitionResponse: z.ZodObject<{
|
|
|
15835
15877
|
title_keys: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
15836
15878
|
editable: z.ZodBoolean;
|
|
15837
15879
|
always_visible: z.ZodBoolean;
|
|
15880
|
+
assignment_only: z.ZodBoolean;
|
|
15838
15881
|
sensitive_form: z.ZodBoolean;
|
|
15839
15882
|
allow_carry_forward: z.ZodBoolean;
|
|
15840
15883
|
current_revision: z.ZodNullable<z.ZodInt>;
|
|
@@ -15881,6 +15924,7 @@ export declare const zListFormSubmissionDeltasResponse: z.ZodObject<{
|
|
|
15881
15924
|
}, z.core.$strip>;
|
|
15882
15925
|
export declare const zListFormSubmissionsQuery: z.ZodObject<{
|
|
15883
15926
|
'filter[form_definition_id]': z.ZodOptional<z.ZodString>;
|
|
15927
|
+
'filter[user_id]': z.ZodOptional<z.ZodString>;
|
|
15884
15928
|
'filter[created_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
15885
15929
|
'filter[created_at][lte]': z.ZodOptional<z.ZodISODateTime>;
|
|
15886
15930
|
'filter[updated_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
@@ -21527,6 +21571,124 @@ export declare const zGetPaystubImportResponse: z.ZodObject<{
|
|
|
21527
21571
|
created_at: z.ZodISODateTime;
|
|
21528
21572
|
updated_at: z.ZodISODateTime;
|
|
21529
21573
|
}, z.core.$strip>;
|
|
21574
|
+
export declare const zListWidePaystubImportsPath: z.ZodObject<{
|
|
21575
|
+
payroll_run_id: z.ZodString;
|
|
21576
|
+
}, z.core.$strip>;
|
|
21577
|
+
export declare const zListWidePaystubImportsQuery: z.ZodObject<{
|
|
21578
|
+
'filter[status]': z.ZodOptional<z.ZodString>;
|
|
21579
|
+
'filter[completed_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
21580
|
+
'filter[completed_at][lte]': z.ZodOptional<z.ZodISODateTime>;
|
|
21581
|
+
'filter[created_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
21582
|
+
'filter[created_at][lte]': z.ZodOptional<z.ZodISODateTime>;
|
|
21583
|
+
'filter[updated_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
21584
|
+
'filter[updated_at][lte]': z.ZodOptional<z.ZodISODateTime>;
|
|
21585
|
+
'page[cursor]': z.ZodOptional<z.ZodString>;
|
|
21586
|
+
'page[limit]': z.ZodDefault<z.ZodOptional<z.ZodInt>>;
|
|
21587
|
+
page: z.ZodOptional<z.ZodString>;
|
|
21588
|
+
filter: z.ZodOptional<z.ZodString>;
|
|
21589
|
+
'filter[unexpected]': z.ZodOptional<z.ZodString>;
|
|
21590
|
+
}, z.core.$strip>;
|
|
21591
|
+
/**
|
|
21592
|
+
* Success
|
|
21593
|
+
*/
|
|
21594
|
+
export declare const zListWidePaystubImportsResponse: z.ZodObject<{
|
|
21595
|
+
meta: z.ZodObject<{
|
|
21596
|
+
page: z.ZodObject<{
|
|
21597
|
+
next_cursor: z.ZodNullable<z.ZodString>;
|
|
21598
|
+
current_cursor: z.ZodNullable<z.ZodString>;
|
|
21599
|
+
}, z.core.$strip>;
|
|
21600
|
+
}, z.core.$strip>;
|
|
21601
|
+
links: z.ZodObject<{
|
|
21602
|
+
self: z.ZodString;
|
|
21603
|
+
first: z.ZodNullable<z.ZodString>;
|
|
21604
|
+
next: z.ZodNullable<z.ZodString>;
|
|
21605
|
+
}, z.core.$strip>;
|
|
21606
|
+
data: z.ZodArray<z.ZodObject<{
|
|
21607
|
+
id: z.ZodString;
|
|
21608
|
+
payrolls_payroll_run_id: z.ZodString;
|
|
21609
|
+
status: z.ZodEnum<{
|
|
21610
|
+
pending: "pending";
|
|
21611
|
+
failed: "failed";
|
|
21612
|
+
success: "success";
|
|
21613
|
+
processing: "processing";
|
|
21614
|
+
processed: "processed";
|
|
21615
|
+
superseded: "superseded";
|
|
21616
|
+
withdrawn: "withdrawn";
|
|
21617
|
+
}>;
|
|
21618
|
+
processed_rows_count: z.ZodInt;
|
|
21619
|
+
processing_errors: z.ZodArray<z.ZodObject<{
|
|
21620
|
+
code: z.ZodString;
|
|
21621
|
+
row: z.ZodNullable<z.ZodInt>;
|
|
21622
|
+
column: z.ZodNullable<z.ZodString>;
|
|
21623
|
+
context: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
21624
|
+
}, z.core.$strip>>;
|
|
21625
|
+
completed_at: z.ZodNullable<z.ZodISODateTime>;
|
|
21626
|
+
created_at: z.ZodISODateTime;
|
|
21627
|
+
updated_at: z.ZodISODateTime;
|
|
21628
|
+
}, z.core.$strip>>;
|
|
21629
|
+
}, z.core.$strip>;
|
|
21630
|
+
export declare const zCreateWidePaystubImportBody: z.ZodObject<{
|
|
21631
|
+
file_signed_id: z.ZodString;
|
|
21632
|
+
}, z.core.$strip>;
|
|
21633
|
+
export declare const zCreateWidePaystubImportPath: z.ZodObject<{
|
|
21634
|
+
payroll_run_id: z.ZodString;
|
|
21635
|
+
}, z.core.$strip>;
|
|
21636
|
+
/**
|
|
21637
|
+
* Created
|
|
21638
|
+
*/
|
|
21639
|
+
export declare const zCreateWidePaystubImportResponse: z.ZodObject<{
|
|
21640
|
+
id: z.ZodString;
|
|
21641
|
+
payrolls_payroll_run_id: z.ZodString;
|
|
21642
|
+
status: z.ZodEnum<{
|
|
21643
|
+
pending: "pending";
|
|
21644
|
+
failed: "failed";
|
|
21645
|
+
success: "success";
|
|
21646
|
+
processing: "processing";
|
|
21647
|
+
processed: "processed";
|
|
21648
|
+
superseded: "superseded";
|
|
21649
|
+
withdrawn: "withdrawn";
|
|
21650
|
+
}>;
|
|
21651
|
+
processed_rows_count: z.ZodInt;
|
|
21652
|
+
processing_errors: z.ZodArray<z.ZodObject<{
|
|
21653
|
+
code: z.ZodString;
|
|
21654
|
+
row: z.ZodNullable<z.ZodInt>;
|
|
21655
|
+
column: z.ZodNullable<z.ZodString>;
|
|
21656
|
+
context: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
21657
|
+
}, z.core.$strip>>;
|
|
21658
|
+
completed_at: z.ZodNullable<z.ZodISODateTime>;
|
|
21659
|
+
created_at: z.ZodISODateTime;
|
|
21660
|
+
updated_at: z.ZodISODateTime;
|
|
21661
|
+
}, z.core.$strip>;
|
|
21662
|
+
export declare const zGetWidePaystubImportPath: z.ZodObject<{
|
|
21663
|
+
payroll_run_id: z.ZodString;
|
|
21664
|
+
id: z.ZodString;
|
|
21665
|
+
}, z.core.$strip>;
|
|
21666
|
+
/**
|
|
21667
|
+
* Success
|
|
21668
|
+
*/
|
|
21669
|
+
export declare const zGetWidePaystubImportResponse: z.ZodObject<{
|
|
21670
|
+
id: z.ZodString;
|
|
21671
|
+
payrolls_payroll_run_id: z.ZodString;
|
|
21672
|
+
status: z.ZodEnum<{
|
|
21673
|
+
pending: "pending";
|
|
21674
|
+
failed: "failed";
|
|
21675
|
+
success: "success";
|
|
21676
|
+
processing: "processing";
|
|
21677
|
+
processed: "processed";
|
|
21678
|
+
superseded: "superseded";
|
|
21679
|
+
withdrawn: "withdrawn";
|
|
21680
|
+
}>;
|
|
21681
|
+
processed_rows_count: z.ZodInt;
|
|
21682
|
+
processing_errors: z.ZodArray<z.ZodObject<{
|
|
21683
|
+
code: z.ZodString;
|
|
21684
|
+
row: z.ZodNullable<z.ZodInt>;
|
|
21685
|
+
column: z.ZodNullable<z.ZodString>;
|
|
21686
|
+
context: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
21687
|
+
}, z.core.$strip>>;
|
|
21688
|
+
completed_at: z.ZodNullable<z.ZodISODateTime>;
|
|
21689
|
+
created_at: z.ZodISODateTime;
|
|
21690
|
+
updated_at: z.ZodISODateTime;
|
|
21691
|
+
}, z.core.$strip>;
|
|
21530
21692
|
export declare const zListPayrollRunsQuery: z.ZodObject<{
|
|
21531
21693
|
'filter[run_type]': z.ZodOptional<z.ZodString>;
|
|
21532
21694
|
'filter[timekeeping_pay_period_id]': z.ZodOptional<z.ZodString>;
|
|
@@ -22802,6 +22964,7 @@ export declare const zUpdateEmploymentResponse: z.ZodObject<{
|
|
|
22802
22964
|
export declare const zListPerDiemsQuery: z.ZodObject<{
|
|
22803
22965
|
'filter[default]': z.ZodOptional<z.ZodBoolean>;
|
|
22804
22966
|
'filter[taxable]': z.ZodOptional<z.ZodBoolean>;
|
|
22967
|
+
'filter[name]': z.ZodOptional<z.ZodString>;
|
|
22805
22968
|
'filter[created_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
22806
22969
|
'filter[created_at][lte]': z.ZodOptional<z.ZodISODateTime>;
|
|
22807
22970
|
'filter[updated_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
@@ -23041,6 +23204,10 @@ export declare const zListCompletionsQuery: z.ZodObject<{
|
|
|
23041
23204
|
'filter[scope_kind]': z.ZodOptional<z.ZodString>;
|
|
23042
23205
|
'filter[feature_id]': z.ZodOptional<z.ZodString>;
|
|
23043
23206
|
'filter[created_by_user_id]': z.ZodOptional<z.ZodString>;
|
|
23207
|
+
'filter[site_id]': z.ZodOptional<z.ZodString>;
|
|
23208
|
+
'filter[crew_user_id]': z.ZodOptional<z.ZodString>;
|
|
23209
|
+
'filter[crew_department_id]': z.ZodOptional<z.ZodString>;
|
|
23210
|
+
'filter[crew_group_id]': z.ZodOptional<z.ZodString>;
|
|
23044
23211
|
'filter[created_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
23045
23212
|
'filter[created_at][lte]': z.ZodOptional<z.ZodISODateTime>;
|
|
23046
23213
|
'filter[updated_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
@@ -24361,6 +24528,9 @@ export declare const zListPositionsPath: z.ZodObject<{
|
|
|
24361
24528
|
job_id: z.ZodString;
|
|
24362
24529
|
}, z.core.$strip>;
|
|
24363
24530
|
export declare const zListPositionsQuery: z.ZodObject<{
|
|
24531
|
+
'filter[fulfilled_by_user_id]': z.ZodOptional<z.ZodString>;
|
|
24532
|
+
'filter[fulfilled_by_user_id][null]': z.ZodOptional<z.ZodBoolean>;
|
|
24533
|
+
'filter[position_function_id]': z.ZodOptional<z.ZodString>;
|
|
24364
24534
|
'filter[created_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
24365
24535
|
'filter[created_at][lte]': z.ZodOptional<z.ZodISODateTime>;
|
|
24366
24536
|
'filter[updated_at][gte]': z.ZodOptional<z.ZodISODateTime>;
|
|
@@ -29105,6 +29275,7 @@ export declare const zListWageDeterminationsResponse: z.ZodObject<{
|
|
|
29105
29275
|
}, z.core.$strip>;
|
|
29106
29276
|
data: z.ZodArray<z.ZodObject<{
|
|
29107
29277
|
id: z.ZodString;
|
|
29278
|
+
uid: z.ZodUUID;
|
|
29108
29279
|
general_decision_number: z.ZodString;
|
|
29109
29280
|
modification_number: z.ZodInt;
|
|
29110
29281
|
superseded_by_wage_determination_id: z.ZodNullable<z.ZodString>;
|
|
@@ -29124,6 +29295,7 @@ export declare const zGetWageDeterminationPath: z.ZodObject<{
|
|
|
29124
29295
|
*/
|
|
29125
29296
|
export declare const zGetWageDeterminationResponse: z.ZodObject<{
|
|
29126
29297
|
id: z.ZodString;
|
|
29298
|
+
uid: z.ZodUUID;
|
|
29127
29299
|
general_decision_number: z.ZodString;
|
|
29128
29300
|
modification_number: z.ZodInt;
|
|
29129
29301
|
superseded_by_wage_determination_id: z.ZodNullable<z.ZodString>;
|
package/dist/gen/zod.gen.js
CHANGED
|
@@ -440,6 +440,7 @@ export const zDirectUploadParameters = z.object({
|
|
|
440
440
|
'pay_periods.imports.dsptch_cprs',
|
|
441
441
|
'pay_periods.imports.time_entries',
|
|
442
442
|
'payrolls.payroll_runs.imports.paystubs',
|
|
443
|
+
'payrolls.payroll_runs.imports.wide_paystubs',
|
|
443
444
|
'users'
|
|
444
445
|
]),
|
|
445
446
|
blob: z.object({
|
|
@@ -2198,6 +2199,7 @@ export const zFormDefinitionObject = z.object({
|
|
|
2198
2199
|
title_keys: z.array(z.string()).nullable(),
|
|
2199
2200
|
editable: z.boolean(),
|
|
2200
2201
|
always_visible: z.boolean(),
|
|
2202
|
+
assignment_only: z.boolean(),
|
|
2201
2203
|
sensitive_form: z.boolean(),
|
|
2202
2204
|
allow_carry_forward: z.boolean(),
|
|
2203
2205
|
current_revision: z.int().nullable(),
|
|
@@ -2753,6 +2755,35 @@ export const zPaystubImportResponseObject = z.object({
|
|
|
2753
2755
|
export const zPaystubImportParameters = z.object({
|
|
2754
2756
|
file_signed_id: z.string()
|
|
2755
2757
|
});
|
|
2758
|
+
/**
|
|
2759
|
+
* One bulk upload of wide paystub amounts against a payroll run, and how it turned out.
|
|
2760
|
+
*/
|
|
2761
|
+
export const zWidePaystubImportResponseObject = z.object({
|
|
2762
|
+
id: z.string(),
|
|
2763
|
+
payrolls_payroll_run_id: z.string(),
|
|
2764
|
+
status: z.enum([
|
|
2765
|
+
'pending',
|
|
2766
|
+
'processing',
|
|
2767
|
+
'processed',
|
|
2768
|
+
'success',
|
|
2769
|
+
'failed',
|
|
2770
|
+
'superseded',
|
|
2771
|
+
'withdrawn'
|
|
2772
|
+
]),
|
|
2773
|
+
processed_rows_count: z.int(),
|
|
2774
|
+
processing_errors: z.array(zImportProcessingError),
|
|
2775
|
+
completed_at: z.iso.datetime().nullable(),
|
|
2776
|
+
created_at: z.iso.datetime(),
|
|
2777
|
+
updated_at: z.iso.datetime()
|
|
2778
|
+
});
|
|
2779
|
+
/**
|
|
2780
|
+
* Submit a spreadsheet of wide paystub amounts for a payroll run. Each row is one employee: payroll_id names them, and every other column is a pay, deduction, or contribution amount. Extra pay-element columns are accepted; they are not unknown columns. The run's pay schedule must record the contributor on the external map (`requires_external_map_contributor`) and must not be connected to a payroll provider; where a provider is configured the paystubs come from that connection and a file is refused. payroll_id must be present as a header and carry a value on every row, or the file is refused naming what is missing. Header matching ignores case and treats spaces as underscores, and column order does not matter.
|
|
2781
|
+
*
|
|
2782
|
+
* Because acceptance is synchronous but the write happens in the background, only one wide paystub import at a time is accepted for a payroll run: while an earlier one is still `pending` or `processing`, a second answers 409 naming `import_in_progress`, and nothing is written. Poll the earlier import until it reports, then submit again.
|
|
2783
|
+
*/
|
|
2784
|
+
export const zWidePaystubImportParameters = z.object({
|
|
2785
|
+
file_signed_id: z.string()
|
|
2786
|
+
});
|
|
2756
2787
|
/**
|
|
2757
2788
|
* One bulk upload of time entries against a pay period, and how it turned out.
|
|
2758
2789
|
*/
|
|
@@ -4088,7 +4119,7 @@ export const zPaystubLineItemResponseObject = z.object({
|
|
|
4088
4119
|
updated_at: z.iso.datetime()
|
|
4089
4120
|
});
|
|
4090
4121
|
/**
|
|
4091
|
-
* Request body for creating a paystub line item. All four fields are required.
|
|
4122
|
+
* Request body for creating a paystub line item. All four fields are required. Undeclared body keys are rejected with 400; references outside the authenticated company return 404.
|
|
4092
4123
|
*/
|
|
4093
4124
|
export const zPaystubLineItemParameters = z.object({
|
|
4094
4125
|
payrolls_paystub_id: z.string(),
|
|
@@ -4097,7 +4128,7 @@ export const zPaystubLineItemParameters = z.object({
|
|
|
4097
4128
|
payrolls_external_map_id: z.string()
|
|
4098
4129
|
});
|
|
4099
4130
|
/**
|
|
4100
|
-
* Request body for updating a paystub line item. Send only the fields to change.
|
|
4131
|
+
* Request body for updating a paystub line item. Send only the fields to change. Undeclared body keys are rejected with 400; newly supplied references outside the authenticated company return 404.
|
|
4101
4132
|
*/
|
|
4102
4133
|
export const zPaystubLineItemUpdateParameters = z.object({
|
|
4103
4134
|
payrolls_paystub_id: z.string().optional(),
|
|
@@ -5535,6 +5566,7 @@ export const zDateTimeFilter = z.object({
|
|
|
5535
5566
|
*/
|
|
5536
5567
|
export const zWageDeterminationResponseObject = z.object({
|
|
5537
5568
|
id: z.string(),
|
|
5569
|
+
uid: z.uuid(),
|
|
5538
5570
|
general_decision_number: z.string(),
|
|
5539
5571
|
modification_number: z.int(),
|
|
5540
5572
|
superseded_by_wage_determination_id: z.string().nullable(),
|
|
@@ -7347,6 +7379,7 @@ export const zListApprenticesPath = z.object({
|
|
|
7347
7379
|
export const zListApprenticesQuery = z.object({
|
|
7348
7380
|
'filter[user_id]': z.string().optional(),
|
|
7349
7381
|
'filter[status]': z.string().optional(),
|
|
7382
|
+
'filter[name]': z.string().optional(),
|
|
7350
7383
|
'filter[created_at][gte]': z.iso.datetime().optional(),
|
|
7351
7384
|
'filter[created_at][lte]': z.iso.datetime().optional(),
|
|
7352
7385
|
'filter[updated_at][gte]': z.iso.datetime().optional(),
|
|
@@ -8899,6 +8932,7 @@ export const zListFormSubmissionDeltasQuery = z.object({
|
|
|
8899
8932
|
export const zListFormSubmissionDeltasResponse = zFormSubmissionDeltasResponse;
|
|
8900
8933
|
export const zListFormSubmissionsQuery = z.object({
|
|
8901
8934
|
'filter[form_definition_id]': z.string().optional(),
|
|
8935
|
+
'filter[user_id]': z.string().optional(),
|
|
8902
8936
|
'filter[created_at][gte]': z.iso.datetime().optional(),
|
|
8903
8937
|
'filter[created_at][lte]': z.iso.datetime().optional(),
|
|
8904
8938
|
'filter[updated_at][gte]': z.iso.datetime().optional(),
|
|
@@ -10170,6 +10204,47 @@ export const zGetPaystubImportPath = z.object({
|
|
|
10170
10204
|
* Success
|
|
10171
10205
|
*/
|
|
10172
10206
|
export const zGetPaystubImportResponse = zPaystubImportResponseObject;
|
|
10207
|
+
export const zListWidePaystubImportsPath = z.object({
|
|
10208
|
+
payroll_run_id: z.string()
|
|
10209
|
+
});
|
|
10210
|
+
export const zListWidePaystubImportsQuery = z.object({
|
|
10211
|
+
'filter[status]': z.string().optional(),
|
|
10212
|
+
'filter[completed_at][gte]': z.iso.datetime().optional(),
|
|
10213
|
+
'filter[completed_at][lte]': z.iso.datetime().optional(),
|
|
10214
|
+
'filter[created_at][gte]': z.iso.datetime().optional(),
|
|
10215
|
+
'filter[created_at][lte]': z.iso.datetime().optional(),
|
|
10216
|
+
'filter[updated_at][gte]': z.iso.datetime().optional(),
|
|
10217
|
+
'filter[updated_at][lte]': z.iso.datetime().optional(),
|
|
10218
|
+
'page[cursor]': z.string().optional(),
|
|
10219
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
10220
|
+
page: z.string().optional(),
|
|
10221
|
+
filter: z.string().optional(),
|
|
10222
|
+
'filter[unexpected]': z.string().optional()
|
|
10223
|
+
});
|
|
10224
|
+
/**
|
|
10225
|
+
* Success
|
|
10226
|
+
*/
|
|
10227
|
+
export const zListWidePaystubImportsResponse = z.object({
|
|
10228
|
+
meta: zMeta,
|
|
10229
|
+
links: zLinks,
|
|
10230
|
+
data: z.array(zWidePaystubImportResponseObject)
|
|
10231
|
+
});
|
|
10232
|
+
export const zCreateWidePaystubImportBody = zWidePaystubImportParameters;
|
|
10233
|
+
export const zCreateWidePaystubImportPath = z.object({
|
|
10234
|
+
payroll_run_id: z.string()
|
|
10235
|
+
});
|
|
10236
|
+
/**
|
|
10237
|
+
* Created
|
|
10238
|
+
*/
|
|
10239
|
+
export const zCreateWidePaystubImportResponse = zWidePaystubImportResponseObject;
|
|
10240
|
+
export const zGetWidePaystubImportPath = z.object({
|
|
10241
|
+
payroll_run_id: z.string(),
|
|
10242
|
+
id: z.string()
|
|
10243
|
+
});
|
|
10244
|
+
/**
|
|
10245
|
+
* Success
|
|
10246
|
+
*/
|
|
10247
|
+
export const zGetWidePaystubImportResponse = zWidePaystubImportResponseObject;
|
|
10173
10248
|
export const zListPayrollRunsQuery = z.object({
|
|
10174
10249
|
'filter[run_type]': z.string().optional(),
|
|
10175
10250
|
'filter[timekeeping_pay_period_id]': z.string().optional(),
|
|
@@ -10480,6 +10555,7 @@ export const zUpdateEmploymentResponse = zPeopleEmploymentResponseObject;
|
|
|
10480
10555
|
export const zListPerDiemsQuery = z.object({
|
|
10481
10556
|
'filter[default]': z.boolean().optional(),
|
|
10482
10557
|
'filter[taxable]': z.boolean().optional(),
|
|
10558
|
+
'filter[name]': z.string().optional(),
|
|
10483
10559
|
'filter[created_at][gte]': z.iso.datetime().optional(),
|
|
10484
10560
|
'filter[created_at][lte]': z.iso.datetime().optional(),
|
|
10485
10561
|
'filter[updated_at][gte]': z.iso.datetime().optional(),
|
|
@@ -10575,6 +10651,10 @@ export const zListCompletionsQuery = z.object({
|
|
|
10575
10651
|
'filter[scope_kind]': z.string().optional(),
|
|
10576
10652
|
'filter[feature_id]': z.string().optional(),
|
|
10577
10653
|
'filter[created_by_user_id]': z.string().optional(),
|
|
10654
|
+
'filter[site_id]': z.string().optional(),
|
|
10655
|
+
'filter[crew_user_id]': z.string().optional(),
|
|
10656
|
+
'filter[crew_department_id]': z.string().optional(),
|
|
10657
|
+
'filter[crew_group_id]': z.string().optional(),
|
|
10578
10658
|
'filter[created_at][gte]': z.iso.datetime().optional(),
|
|
10579
10659
|
'filter[created_at][lte]': z.iso.datetime().optional(),
|
|
10580
10660
|
'filter[updated_at][gte]': z.iso.datetime().optional(),
|
|
@@ -10930,6 +11010,9 @@ export const zListPositionsPath = z.object({
|
|
|
10930
11010
|
job_id: z.string()
|
|
10931
11011
|
});
|
|
10932
11012
|
export const zListPositionsQuery = z.object({
|
|
11013
|
+
'filter[fulfilled_by_user_id]': z.string().optional(),
|
|
11014
|
+
'filter[fulfilled_by_user_id][null]': z.boolean().optional(),
|
|
11015
|
+
'filter[position_function_id]': z.string().optional(),
|
|
10933
11016
|
'filter[created_at][gte]': z.iso.datetime().optional(),
|
|
10934
11017
|
'filter[created_at][lte]': z.iso.datetime().optional(),
|
|
10935
11018
|
'filter[updated_at][gte]': z.iso.datetime().optional(),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dsptch-work/api-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.29.0",
|
|
4
4
|
"description": "Generated TypeScript client for the DSPTCH REST API.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"dsptch",
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
"@hey-api/openapi-ts": "^0.99.0",
|
|
58
58
|
"publint": "^0.3.22",
|
|
59
59
|
"typescript": "^6.0.3",
|
|
60
|
-
"vitest": "^
|
|
60
|
+
"vitest": "^5.0.2"
|
|
61
61
|
},
|
|
62
62
|
"scripts": {
|
|
63
63
|
"generate": "openapi-ts",
|