@dsptch-work/api-client 0.11.0 → 0.13.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 +71 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +264 -1
- package/dist/gen/sdk.gen.js +433 -0
- package/dist/gen/types.gen.d.ts +1429 -109
- package/dist/gen/zod.gen.d.ts +1432 -97
- package/dist/gen/zod.gen.js +496 -7
- package/package.json +1 -1
package/dist/gen/zod.gen.js
CHANGED
|
@@ -154,6 +154,12 @@ export const zProblem = z.object({
|
|
|
154
154
|
*
|
|
155
155
|
* The resource's timeline already ends at a scheduled termination, and scheduling a second one would silently move it. Moving an end is two steps on purpose: cancel the standing termination, then schedule the one you want.
|
|
156
156
|
*
|
|
157
|
+
* ### product_archived
|
|
158
|
+
*
|
|
159
|
+
* **Product Archived**
|
|
160
|
+
*
|
|
161
|
+
* The item cannot be unarchived while its product is still archived — an item never lives active inside an archived product. Unarchive the product instead, which restores the item along with the rest of the product's holdings.
|
|
162
|
+
*
|
|
157
163
|
* ### recorded_since_termination
|
|
158
164
|
*
|
|
159
165
|
* **Timecode Changed Since Termination**
|
|
@@ -238,9 +244,9 @@ export const zProblem = z.object({
|
|
|
238
244
|
*
|
|
239
245
|
* ### invalid_signed_id
|
|
240
246
|
*
|
|
241
|
-
* **
|
|
247
|
+
* **Attachment Upload Not Found**
|
|
242
248
|
*
|
|
243
|
-
* An attachment signed id
|
|
249
|
+
* An attachment signed id names no upload this endpoint can read. A signed id is issued for one `resource` and verifies only there, so an id for a different resource is indistinguishable from one that is malformed, expired, or tampered with, and all of them answer alike. The message names the resource the upload needed; upload the file again to the direct-uploads endpoint naming it, and pass the signed id that call returns.
|
|
244
250
|
*
|
|
245
251
|
* ### non_numeric_cents
|
|
246
252
|
*
|
|
@@ -345,6 +351,7 @@ export const zProblemTypeCatalog = z.enum([
|
|
|
345
351
|
'insufficient_api_key_scope',
|
|
346
352
|
'not_found',
|
|
347
353
|
'already_terminated',
|
|
354
|
+
'product_archived',
|
|
348
355
|
'recorded_since_termination',
|
|
349
356
|
'span_beyond_timeline_end',
|
|
350
357
|
'version_overlap',
|
|
@@ -386,6 +393,14 @@ export const zApiKeyScopeResponseObject = z.object({
|
|
|
386
393
|
* Register a file for direct upload — send its metadata to receive a blob plus a one-time URL for uploading the file's bytes to storage.
|
|
387
394
|
*/
|
|
388
395
|
export const zDirectUploadParameters = z.object({
|
|
396
|
+
resource: z.enum([
|
|
397
|
+
'assets.items',
|
|
398
|
+
'assets.items.documents',
|
|
399
|
+
'assets.items.service_events',
|
|
400
|
+
'assets.products',
|
|
401
|
+
'assets.vendors',
|
|
402
|
+
'users'
|
|
403
|
+
]),
|
|
389
404
|
blob: z.object({
|
|
390
405
|
filename: z.string(),
|
|
391
406
|
byte_size: z.int(),
|
|
@@ -1001,8 +1016,7 @@ export const zTimeCardPerDiemResponseObject = z.object({
|
|
|
1001
1016
|
export const zTimeCardPerDiemParameters = z.object({
|
|
1002
1017
|
date: z.iso.date(),
|
|
1003
1018
|
approver_user_id: z.string(),
|
|
1004
|
-
per_diem_id: z.string()
|
|
1005
|
-
taxable: z.boolean().optional()
|
|
1019
|
+
per_diem_id: z.string()
|
|
1006
1020
|
});
|
|
1007
1021
|
/**
|
|
1008
1022
|
* A holiday on a pay schedule's holiday calendar — a fixed (month + day) or floating (nth weekday of a month) date that gets holiday-pay treatment when a time entry's timecode opts into holiday handling.
|
|
@@ -2692,6 +2706,66 @@ export const zComplianceCheckParameters = z.object({
|
|
|
2692
2706
|
status: z.enum(['dismissed', 'pending']).optional(),
|
|
2693
2707
|
time_due: z.iso.datetime().nullish()
|
|
2694
2708
|
});
|
|
2709
|
+
/**
|
|
2710
|
+
* One compliance requirement from the catalog. Requirements ship with the application, so the catalog reads the same for every company.
|
|
2711
|
+
*/
|
|
2712
|
+
export const zComplianceRequirementResponseObject = z.object({
|
|
2713
|
+
id: z.string(),
|
|
2714
|
+
type: z.string(),
|
|
2715
|
+
title: z.string(),
|
|
2716
|
+
description: z.string(),
|
|
2717
|
+
target: z.enum([
|
|
2718
|
+
'Company',
|
|
2719
|
+
'Job',
|
|
2720
|
+
'Project',
|
|
2721
|
+
'Timekeeping::TimeCard',
|
|
2722
|
+
'Timekeeping::PayPeriod',
|
|
2723
|
+
'User',
|
|
2724
|
+
'UserCompany'
|
|
2725
|
+
]),
|
|
2726
|
+
category: z.enum([
|
|
2727
|
+
'apprenticeship',
|
|
2728
|
+
'certified_payroll',
|
|
2729
|
+
'company',
|
|
2730
|
+
'job',
|
|
2731
|
+
'payroll',
|
|
2732
|
+
'project',
|
|
2733
|
+
'regional',
|
|
2734
|
+
'tax_credit',
|
|
2735
|
+
'timekeeping',
|
|
2736
|
+
'worker'
|
|
2737
|
+
]),
|
|
2738
|
+
phase: z.enum([
|
|
2739
|
+
'after_pay_date',
|
|
2740
|
+
'before_approval_deadline',
|
|
2741
|
+
'close_out',
|
|
2742
|
+
'maintenance',
|
|
2743
|
+
'onboarding',
|
|
2744
|
+
'setup'
|
|
2745
|
+
]),
|
|
2746
|
+
priority: z.enum([
|
|
2747
|
+
'critical',
|
|
2748
|
+
'high',
|
|
2749
|
+
'medium',
|
|
2750
|
+
'low'
|
|
2751
|
+
]).nullable(),
|
|
2752
|
+
requisite: z.enum([
|
|
2753
|
+
'apprenticeship',
|
|
2754
|
+
'best_practice',
|
|
2755
|
+
'dsptch',
|
|
2756
|
+
'federal_pwa',
|
|
2757
|
+
'ira',
|
|
2758
|
+
'ira_tax_credit',
|
|
2759
|
+
'payroll',
|
|
2760
|
+
'pwa',
|
|
2761
|
+
'regional_pwa',
|
|
2762
|
+
'timekeeping',
|
|
2763
|
+
'wh347'
|
|
2764
|
+
]).nullable(),
|
|
2765
|
+
sort_order: z.int(),
|
|
2766
|
+
created_at: z.iso.datetime(),
|
|
2767
|
+
updated_at: z.iso.datetime()
|
|
2768
|
+
});
|
|
2695
2769
|
/**
|
|
2696
2770
|
* A worker's individual payment record within a payroll run — a recorded or imported actual payment. Its money detail lives in the paystub's line items; this record carries only identifiers.
|
|
2697
2771
|
*/
|
|
@@ -2716,7 +2790,7 @@ export const zPaystubParameters = z.object({
|
|
|
2716
2790
|
check_number: z.string().nullish()
|
|
2717
2791
|
});
|
|
2718
2792
|
/**
|
|
2719
|
-
* An adjustment applied in the current pay period to correct a prior one, tied to the paystub line item it corrects.
|
|
2793
|
+
* An adjustment applied in the current pay period to correct a prior one, tied to the paystub line item it corrects.
|
|
2720
2794
|
*/
|
|
2721
2795
|
export const zPriorPeriodAdjustmentResponseObject = z.object({
|
|
2722
2796
|
id: z.string(),
|
|
@@ -2738,6 +2812,56 @@ export const zPriorPeriodAdjustmentResponseObject = z.object({
|
|
|
2738
2812
|
created_at: z.iso.datetime(),
|
|
2739
2813
|
updated_at: z.iso.datetime()
|
|
2740
2814
|
});
|
|
2815
|
+
/**
|
|
2816
|
+
* Request body for allocating part of a retroactive-pay line item to an earlier time card. The time card comes from the path; the adjustment is always a retroactive increase.
|
|
2817
|
+
*/
|
|
2818
|
+
export const zPriorPeriodAdjustmentParameters = z.object({
|
|
2819
|
+
payrolls_paystub_line_item_id: z.string(),
|
|
2820
|
+
created_by_user_id: z.string(),
|
|
2821
|
+
amount_cents: z.string(),
|
|
2822
|
+
rationale: z.enum([
|
|
2823
|
+
'hours_correction',
|
|
2824
|
+
'other',
|
|
2825
|
+
'pwa_compliance',
|
|
2826
|
+
'rate_correction'
|
|
2827
|
+
]),
|
|
2828
|
+
job_id: z.string().nullish(),
|
|
2829
|
+
notes: z.string().nullish(),
|
|
2830
|
+
pwa_compliance_eligible: z.boolean().optional()
|
|
2831
|
+
});
|
|
2832
|
+
/**
|
|
2833
|
+
* What one PWA-tracked job on a time card still owes the worker, from the materialized prevailing-wage compliance view. Read-only.
|
|
2834
|
+
*/
|
|
2835
|
+
export const zPwaComplianceResponseObject = z.object({
|
|
2836
|
+
timekeeping_time_card_id: z.string(),
|
|
2837
|
+
timekeeping_pay_period_id: z.string(),
|
|
2838
|
+
job_id: z.string(),
|
|
2839
|
+
user_id: z.string(),
|
|
2840
|
+
pwa_minutes_worked: z.int(),
|
|
2841
|
+
federal_post_interest_outstanding_cents: z.string(),
|
|
2842
|
+
regional_post_interest_outstanding_cents: z.string(),
|
|
2843
|
+
pwa_adjustments_cents: z.string(),
|
|
2844
|
+
federal_balance_due_cents: z.string(),
|
|
2845
|
+
regional_balance_due_cents: z.string(),
|
|
2846
|
+
balance_due_cents: z.string(),
|
|
2847
|
+
all_actuals_exist: z.boolean(),
|
|
2848
|
+
compliant: z.boolean()
|
|
2849
|
+
});
|
|
2850
|
+
/**
|
|
2851
|
+
* A retroactive-pay line item that can fund a prior period adjustment on the time card it was requested for. Read-only.
|
|
2852
|
+
*/
|
|
2853
|
+
export const zAdjustableLineItemResponseObject = z.object({
|
|
2854
|
+
id: z.string(),
|
|
2855
|
+
payrolls_paystub_id: z.string().nullable(),
|
|
2856
|
+
payrolls_payroll_run_id: z.string().nullable(),
|
|
2857
|
+
payrolls_external_map_id: z.string(),
|
|
2858
|
+
user_id: z.string().nullable(),
|
|
2859
|
+
amount_cents: z.string(),
|
|
2860
|
+
contributor: z.enum(['employee', 'employer']),
|
|
2861
|
+
adjustable_amount_cents: z.string(),
|
|
2862
|
+
created_at: z.iso.datetime(),
|
|
2863
|
+
updated_at: z.iso.datetime()
|
|
2864
|
+
});
|
|
2741
2865
|
/**
|
|
2742
2866
|
* What a worker was actually paid for a pay period, derived from imported paystub line items — gross and net pay, employee deductions (taxes, insurance, savings, garnishments), and employer contributions. Read-only. Every amount is a decimal string of cents.
|
|
2743
2867
|
*/
|
|
@@ -3708,6 +3832,7 @@ export const zFederalJobWageDeterminationResponseObject = z.object({
|
|
|
3708
3832
|
id: z.string(),
|
|
3709
3833
|
job_id: z.string(),
|
|
3710
3834
|
pwa_trade_id: z.string(),
|
|
3835
|
+
overtime_package_id: z.string().nullable(),
|
|
3711
3836
|
type: z.enum(['Pwa::JobWageDeterminations::Federal']),
|
|
3712
3837
|
labor_classification: z.string(),
|
|
3713
3838
|
hourly_rate_cents: z.string(),
|
|
@@ -3729,6 +3854,7 @@ export const zFederalJobWageDeterminationHistoryCorrectionObject = z.object({
|
|
|
3729
3854
|
job_wage_determination_id: z.string(),
|
|
3730
3855
|
job_id: z.string(),
|
|
3731
3856
|
pwa_trade_id: z.string(),
|
|
3857
|
+
overtime_package_id: z.string().nullable(),
|
|
3732
3858
|
type: z.enum(['Pwa::JobWageDeterminations::Federal']),
|
|
3733
3859
|
labor_classification: z.string(),
|
|
3734
3860
|
hourly_rate_cents: z.string(),
|
|
@@ -3799,6 +3925,7 @@ export const zRegionalJobWageDeterminationResponseObject = z.object({
|
|
|
3799
3925
|
id: z.string(),
|
|
3800
3926
|
job_id: z.string(),
|
|
3801
3927
|
pwa_trade_id: z.string(),
|
|
3928
|
+
overtime_package_id: z.string().nullable(),
|
|
3802
3929
|
type: z.enum(['Pwa::JobWageDeterminations::Regional']),
|
|
3803
3930
|
labor_classification: z.string(),
|
|
3804
3931
|
hourly_rate_cents: z.string(),
|
|
@@ -3821,6 +3948,7 @@ export const zRegionalJobWageDeterminationHistoryCorrectionObject = z.object({
|
|
|
3821
3948
|
job_wage_determination_id: z.string(),
|
|
3822
3949
|
job_id: z.string(),
|
|
3823
3950
|
pwa_trade_id: z.string(),
|
|
3951
|
+
overtime_package_id: z.string().nullable(),
|
|
3824
3952
|
type: z.enum(['Pwa::JobWageDeterminations::Regional']),
|
|
3825
3953
|
labor_classification: z.string(),
|
|
3826
3954
|
hourly_rate_cents: z.string(),
|
|
@@ -3840,6 +3968,7 @@ export const zFederalJobWageDeterminationHistoryVersionObject = z.object({
|
|
|
3840
3968
|
job_wage_determination_id: z.string(),
|
|
3841
3969
|
job_id: z.string(),
|
|
3842
3970
|
pwa_trade_id: z.string(),
|
|
3971
|
+
overtime_package_id: z.string().nullable(),
|
|
3843
3972
|
type: z.enum(['Pwa::JobWageDeterminations::Federal']),
|
|
3844
3973
|
labor_classification: z.string(),
|
|
3845
3974
|
hourly_rate_cents: z.string(),
|
|
@@ -3867,6 +3996,7 @@ export const zRegionalJobWageDeterminationHistoryVersionObject = z.object({
|
|
|
3867
3996
|
job_wage_determination_id: z.string(),
|
|
3868
3997
|
job_id: z.string(),
|
|
3869
3998
|
pwa_trade_id: z.string(),
|
|
3999
|
+
overtime_package_id: z.string().nullable(),
|
|
3870
4000
|
type: z.enum(['Pwa::JobWageDeterminations::Regional']),
|
|
3871
4001
|
labor_classification: z.string(),
|
|
3872
4002
|
hourly_rate_cents: z.string(),
|
|
@@ -3919,12 +4049,62 @@ export const zRegionalJobWageDeterminationParameters = z.object({
|
|
|
3919
4049
|
regional_fields: zRegionalWageDeterminationFields.optional()
|
|
3920
4050
|
});
|
|
3921
4051
|
/**
|
|
3922
|
-
* Parameters for creating a job wage determination. Provide the Federal or Regional shape; the type discriminator selects which.
|
|
4052
|
+
* Parameters for creating a job wage determination. Provide the Federal or Regional shape; the type discriminator selects which. Editing an existing determination uses the update parameters, which take an `effective_from` instead of a type.
|
|
3923
4053
|
*/
|
|
3924
4054
|
export const zJobWageDeterminationParameters = z.discriminatedUnion('type', [
|
|
3925
4055
|
zFederalJobWageDeterminationParameters.extend({ type: z.literal('Pwa::JobWageDeterminations::Federal') }),
|
|
3926
4056
|
zRegionalJobWageDeterminationParameters.extend({ type: z.literal('Pwa::JobWageDeterminations::Regional') })
|
|
3927
4057
|
]);
|
|
4058
|
+
/**
|
|
4059
|
+
* Parameters for editing a job wage determination from a point in valid time forward. The type is fixed by the determination the id names and is not sent.
|
|
4060
|
+
*/
|
|
4061
|
+
export const zJobWageDeterminationUpdateParameters = z.object({
|
|
4062
|
+
effective_from: z.iso.date().optional(),
|
|
4063
|
+
labor_classification: z.string().optional(),
|
|
4064
|
+
pwa_trade_id: z.string().optional(),
|
|
4065
|
+
hourly_rate_cents: z.string().optional(),
|
|
4066
|
+
fringe_rate_cents: z.string().optional(),
|
|
4067
|
+
class_code: z.string().nullish(),
|
|
4068
|
+
construction_category: z.enum([
|
|
4069
|
+
'building',
|
|
4070
|
+
'heavy',
|
|
4071
|
+
'highway',
|
|
4072
|
+
'residential'
|
|
4073
|
+
]).nullish(),
|
|
4074
|
+
general_wage_determination: z.string().nullish(),
|
|
4075
|
+
regional_fields: zRegionalWageDeterminationFields.optional()
|
|
4076
|
+
});
|
|
4077
|
+
/**
|
|
4078
|
+
* Parameters for an effective-dated change to a job wage determination, applying from a calendar date forward. The type is fixed by the determination the id names and is not sent.
|
|
4079
|
+
*/
|
|
4080
|
+
export const zJobWageDeterminationScheduledChangeParameters = z.object({
|
|
4081
|
+
effective_date: z.iso.date(),
|
|
4082
|
+
labor_classification: z.string().optional(),
|
|
4083
|
+
pwa_trade_id: z.string().optional(),
|
|
4084
|
+
hourly_rate_cents: z.string().optional(),
|
|
4085
|
+
fringe_rate_cents: z.string().optional(),
|
|
4086
|
+
class_code: z.string().nullish(),
|
|
4087
|
+
construction_category: z.enum([
|
|
4088
|
+
'building',
|
|
4089
|
+
'heavy',
|
|
4090
|
+
'highway',
|
|
4091
|
+
'residential'
|
|
4092
|
+
]).nullish(),
|
|
4093
|
+
general_wage_determination: z.string().nullish(),
|
|
4094
|
+
regional_fields: zRegionalWageDeterminationFields.optional()
|
|
4095
|
+
});
|
|
4096
|
+
/**
|
|
4097
|
+
* Parameters for moving where a job wage determination's timeline begins.
|
|
4098
|
+
*/
|
|
4099
|
+
export const zJobWageDeterminationGenesisParameters = z.object({
|
|
4100
|
+
effective_date: z.iso.date()
|
|
4101
|
+
});
|
|
4102
|
+
/**
|
|
4103
|
+
* Parameters for scheduling when a job wage determination stops being valid.
|
|
4104
|
+
*/
|
|
4105
|
+
export const zJobWageDeterminationScheduledTerminationParameters = z.object({
|
|
4106
|
+
effective_date: z.iso.date()
|
|
4107
|
+
});
|
|
3928
4108
|
/**
|
|
3929
4109
|
* The adjustment applied when a rule matches — an addition to the wage or fringe rate.
|
|
3930
4110
|
*/
|
|
@@ -4303,6 +4483,7 @@ export const zAssetsItemParameters = z.object({
|
|
|
4303
4483
|
assets_site_id: z.string().optional(),
|
|
4304
4484
|
user_id: z.string().optional(),
|
|
4305
4485
|
container_item_id: z.string().optional(),
|
|
4486
|
+
assets_sub_location_id: z.string().optional(),
|
|
4306
4487
|
performed_by_user_id: z.string()
|
|
4307
4488
|
});
|
|
4308
4489
|
/**
|
|
@@ -4441,12 +4622,13 @@ export const zAssetsItemFormAssignmentParameters = z.object({
|
|
|
4441
4622
|
})
|
|
4442
4623
|
});
|
|
4443
4624
|
/**
|
|
4444
|
-
* On-hand stock of an item at a site — one row per item and
|
|
4625
|
+
* On-hand stock of an item at a site — one row per item, site, and storage location. Read-only. A site with none of the item has no row at all, since a row is removed once its count reaches zero.
|
|
4445
4626
|
*/
|
|
4446
4627
|
export const zAssetsInventoryResponseObject = z.object({
|
|
4447
4628
|
id: z.string(),
|
|
4448
4629
|
assets_item_id: z.string(),
|
|
4449
4630
|
assets_site_id: z.string(),
|
|
4631
|
+
assets_sub_location_id: z.string().nullable(),
|
|
4450
4632
|
company_id: z.string(),
|
|
4451
4633
|
quantity_on_hand: z.int(),
|
|
4452
4634
|
created_at: z.iso.datetime(),
|
|
@@ -4478,6 +4660,7 @@ export const zAssetsTransactionEventResponseObject = z.object({
|
|
|
4478
4660
|
assets_site_id: z.string().nullable(),
|
|
4479
4661
|
assignee_id: z.string().nullable(),
|
|
4480
4662
|
container_item_id: z.string().nullable(),
|
|
4663
|
+
assets_sub_location_id: z.string().nullable(),
|
|
4481
4664
|
assets_transfer_id: z.string().nullable(),
|
|
4482
4665
|
performed_by_user_id: z.string(),
|
|
4483
4666
|
direction: z.enum(['inbound', 'outbound']),
|
|
@@ -4628,6 +4811,65 @@ export const zAssetsServiceScheduleTemplateParameters = z.object({
|
|
|
4628
4811
|
interval_count: z.int().gte(1),
|
|
4629
4812
|
performed_by_user_id: z.string()
|
|
4630
4813
|
});
|
|
4814
|
+
/**
|
|
4815
|
+
* A node of fixed storage structure inside a site or a container item — a zone, aisle, rack, shelf, bin, or drawer. Nodes form a tree per holder, and each carries a scannable path_code composed from its ancestors' codes.
|
|
4816
|
+
*/
|
|
4817
|
+
export const zAssetsSubLocationResponseObject = z.object({
|
|
4818
|
+
id: z.string(),
|
|
4819
|
+
company_id: z.string(),
|
|
4820
|
+
assets_site_id: z.string().nullable(),
|
|
4821
|
+
container_item_id: z.string().nullable(),
|
|
4822
|
+
parent_id: z.string().nullable(),
|
|
4823
|
+
kind: z.enum([
|
|
4824
|
+
'zone',
|
|
4825
|
+
'aisle',
|
|
4826
|
+
'rack',
|
|
4827
|
+
'shelf',
|
|
4828
|
+
'bin',
|
|
4829
|
+
'drawer'
|
|
4830
|
+
]).nullable(),
|
|
4831
|
+
name: z.string(),
|
|
4832
|
+
code: z.string(),
|
|
4833
|
+
path_code: z.string(),
|
|
4834
|
+
created_at: z.iso.datetime(),
|
|
4835
|
+
updated_at: z.iso.datetime()
|
|
4836
|
+
});
|
|
4837
|
+
/**
|
|
4838
|
+
* Create a storage location. name and code are required. A top-level node names its holder (assets_site_id or container_item_id, exactly one); a nested node names parent_id and inherits the parent's holder. The holder cannot change after creation.
|
|
4839
|
+
*/
|
|
4840
|
+
export const zAssetsSubLocationParameters = z.object({
|
|
4841
|
+
assets_site_id: z.string().optional(),
|
|
4842
|
+
container_item_id: z.string().optional(),
|
|
4843
|
+
parent_id: z.string().nullish(),
|
|
4844
|
+
kind: z.enum([
|
|
4845
|
+
'zone',
|
|
4846
|
+
'aisle',
|
|
4847
|
+
'rack',
|
|
4848
|
+
'shelf',
|
|
4849
|
+
'bin',
|
|
4850
|
+
'drawer'
|
|
4851
|
+
]).optional(),
|
|
4852
|
+
name: z.string(),
|
|
4853
|
+
code: z.string()
|
|
4854
|
+
});
|
|
4855
|
+
/**
|
|
4856
|
+
* Update a storage location. All fields are optional — send only what changes. The holder fields cannot change after creation; renaming code cascades new path codes through the node's subtree.
|
|
4857
|
+
*/
|
|
4858
|
+
export const zAssetsSubLocationUpdateParameters = z.object({
|
|
4859
|
+
assets_site_id: z.string().optional(),
|
|
4860
|
+
container_item_id: z.string().optional(),
|
|
4861
|
+
parent_id: z.string().nullish(),
|
|
4862
|
+
kind: z.enum([
|
|
4863
|
+
'zone',
|
|
4864
|
+
'aisle',
|
|
4865
|
+
'rack',
|
|
4866
|
+
'shelf',
|
|
4867
|
+
'bin',
|
|
4868
|
+
'drawer'
|
|
4869
|
+
]).optional(),
|
|
4870
|
+
name: z.string().optional(),
|
|
4871
|
+
code: z.string().optional()
|
|
4872
|
+
});
|
|
4631
4873
|
/**
|
|
4632
4874
|
* A completed movement of item stock between two holders, each a site, a user, or a container. Each line moves one item; applying the transfer records paired outbound and inbound transactions and updates the on-hand, custody, and containment counts. Transfers created through this API are always completed. One-sided moves (placing or removing an item with only one endpoint) record transactions but no transfer, and so are not represented by this resource.
|
|
4633
4875
|
*/
|
|
@@ -4646,6 +4888,8 @@ export const zAssetsTransferResponseObject = z.object({
|
|
|
4646
4888
|
to_assets_site_id: z.string().nullable(),
|
|
4647
4889
|
to_user_id: z.string().nullable(),
|
|
4648
4890
|
to_container_item_id: z.string().nullable(),
|
|
4891
|
+
from_assets_sub_location_id: z.string().nullable(),
|
|
4892
|
+
to_assets_sub_location_id: z.string().nullable(),
|
|
4649
4893
|
initiated_by_user_id: z.string(),
|
|
4650
4894
|
completed_at: z.iso.datetime().nullable(),
|
|
4651
4895
|
transfer_lines: z.array(z.object({
|
|
@@ -4666,6 +4910,8 @@ export const zAssetsTransferParameters = z.object({
|
|
|
4666
4910
|
to_assets_site_id: z.string().optional(),
|
|
4667
4911
|
to_user_id: z.string().optional(),
|
|
4668
4912
|
to_container_item_id: z.string().optional(),
|
|
4913
|
+
from_assets_sub_location_id: z.string().optional(),
|
|
4914
|
+
to_assets_sub_location_id: z.string().optional(),
|
|
4669
4915
|
performed_by_user_id: z.string(),
|
|
4670
4916
|
line_items: z.array(z.object({
|
|
4671
4917
|
assets_item_id: z.string(),
|
|
@@ -4677,6 +4923,7 @@ export const zAssetsTransferParameters = z.object({
|
|
|
4677
4923
|
*/
|
|
4678
4924
|
export const zAssetsRestockParameters = z.object({
|
|
4679
4925
|
assets_site_id: z.string(),
|
|
4926
|
+
assets_sub_location_id: z.string().optional(),
|
|
4680
4927
|
quantity: z.int().gte(1),
|
|
4681
4928
|
performed_by_user_id: z.string()
|
|
4682
4929
|
});
|
|
@@ -4685,9 +4932,16 @@ export const zAssetsRestockParameters = z.object({
|
|
|
4685
4932
|
*/
|
|
4686
4933
|
export const zAssetsAdjustmentParameters = z.object({
|
|
4687
4934
|
assets_site_id: z.string(),
|
|
4935
|
+
assets_sub_location_id: z.string().optional(),
|
|
4688
4936
|
new_quantity: z.int().gte(0),
|
|
4689
4937
|
performed_by_user_id: z.string()
|
|
4690
4938
|
});
|
|
4939
|
+
/**
|
|
4940
|
+
* Archive or unarchive a product or item. Archiving takes it out of circulation without deleting it — history is preserved and it is hidden from listings unless requested with filter[state]. Archiving a product cascades to its items; item operations apply to serial items only.
|
|
4941
|
+
*/
|
|
4942
|
+
export const zAssetsArchiveParameters = z.object({
|
|
4943
|
+
performed_by_user_id: z.string()
|
|
4944
|
+
});
|
|
4691
4945
|
/**
|
|
4692
4946
|
* Success
|
|
4693
4947
|
*/
|
|
@@ -5169,6 +5423,22 @@ export const zUpdateItemPath = z.object({
|
|
|
5169
5423
|
* Removes an image
|
|
5170
5424
|
*/
|
|
5171
5425
|
export const zUpdateItemResponse = zAssetsItemResponseObject;
|
|
5426
|
+
export const zUnarchiveItemBody = zAssetsArchiveParameters;
|
|
5427
|
+
export const zUnarchiveItemPath = z.object({
|
|
5428
|
+
item_id: z.string()
|
|
5429
|
+
});
|
|
5430
|
+
/**
|
|
5431
|
+
* Success
|
|
5432
|
+
*/
|
|
5433
|
+
export const zUnarchiveItemResponse = zAssetsItemResponseObject;
|
|
5434
|
+
export const zArchiveItemBody = zAssetsArchiveParameters;
|
|
5435
|
+
export const zArchiveItemPath = z.object({
|
|
5436
|
+
item_id: z.string()
|
|
5437
|
+
});
|
|
5438
|
+
/**
|
|
5439
|
+
* Created
|
|
5440
|
+
*/
|
|
5441
|
+
export const zArchiveItemResponse = zAssetsItemResponseObject;
|
|
5172
5442
|
export const zListServiceSchedulesPath = z.object({
|
|
5173
5443
|
item_id: z.string()
|
|
5174
5444
|
});
|
|
@@ -5433,6 +5703,22 @@ export const zUpdateProductPath = z.object({
|
|
|
5433
5703
|
* Success (upsert attribute values)
|
|
5434
5704
|
*/
|
|
5435
5705
|
export const zUpdateProductResponse = zAssetsProductResponseObject;
|
|
5706
|
+
export const zUnarchiveProductBody = zAssetsArchiveParameters;
|
|
5707
|
+
export const zUnarchiveProductPath = z.object({
|
|
5708
|
+
product_id: z.string()
|
|
5709
|
+
});
|
|
5710
|
+
/**
|
|
5711
|
+
* Success
|
|
5712
|
+
*/
|
|
5713
|
+
export const zUnarchiveProductResponse = zAssetsProductResponseObject;
|
|
5714
|
+
export const zArchiveProductBody = zAssetsArchiveParameters;
|
|
5715
|
+
export const zArchiveProductPath = z.object({
|
|
5716
|
+
product_id: z.string()
|
|
5717
|
+
});
|
|
5718
|
+
/**
|
|
5719
|
+
* Created
|
|
5720
|
+
*/
|
|
5721
|
+
export const zArchiveProductResponse = zAssetsProductResponseObject;
|
|
5436
5722
|
export const zAdjustProductInventoryBody = zAssetsAdjustmentParameters;
|
|
5437
5723
|
export const zAdjustProductInventoryPath = z.object({
|
|
5438
5724
|
product_id: z.string()
|
|
@@ -5577,6 +5863,55 @@ export const zUpdateSitePath = z.object({
|
|
|
5577
5863
|
* Success
|
|
5578
5864
|
*/
|
|
5579
5865
|
export const zUpdateSiteResponse = zAssetsSiteResponseObject;
|
|
5866
|
+
export const zListSubLocationsQuery = z.object({
|
|
5867
|
+
'filter[assets_site_id]': z.string().optional(),
|
|
5868
|
+
'filter[container_item_id]': z.string().optional(),
|
|
5869
|
+
'filter[kind]': z.string().optional(),
|
|
5870
|
+
'filter[created_at][gte]': z.iso.datetime().optional(),
|
|
5871
|
+
'filter[created_at][lte]': z.iso.datetime().optional(),
|
|
5872
|
+
'filter[updated_at][gte]': z.iso.datetime().optional(),
|
|
5873
|
+
'filter[updated_at][lte]': z.iso.datetime().optional(),
|
|
5874
|
+
filter: z.string().optional(),
|
|
5875
|
+
'filter[unexpected]': z.string().optional(),
|
|
5876
|
+
'page[cursor]': z.string().optional(),
|
|
5877
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
5878
|
+
page: z.string().optional()
|
|
5879
|
+
});
|
|
5880
|
+
/**
|
|
5881
|
+
* Success
|
|
5882
|
+
*/
|
|
5883
|
+
export const zListSubLocationsResponse = z.object({
|
|
5884
|
+
meta: zMeta,
|
|
5885
|
+
links: zLinks,
|
|
5886
|
+
data: z.array(zAssetsSubLocationResponseObject)
|
|
5887
|
+
});
|
|
5888
|
+
export const zCreateSubLocationBody = zAssetsSubLocationParameters;
|
|
5889
|
+
/**
|
|
5890
|
+
* Created
|
|
5891
|
+
*/
|
|
5892
|
+
export const zCreateSubLocationResponse = zAssetsSubLocationResponseObject;
|
|
5893
|
+
export const zDeleteSubLocationPath = z.object({
|
|
5894
|
+
id: z.string()
|
|
5895
|
+
});
|
|
5896
|
+
/**
|
|
5897
|
+
* Success
|
|
5898
|
+
*/
|
|
5899
|
+
export const zDeleteSubLocationResponse = zAssetsSubLocationResponseObject;
|
|
5900
|
+
export const zGetSubLocationPath = z.object({
|
|
5901
|
+
id: z.string()
|
|
5902
|
+
});
|
|
5903
|
+
/**
|
|
5904
|
+
* Success
|
|
5905
|
+
*/
|
|
5906
|
+
export const zGetSubLocationResponse = zAssetsSubLocationResponseObject;
|
|
5907
|
+
export const zUpdateSubLocationBody = zAssetsSubLocationUpdateParameters;
|
|
5908
|
+
export const zUpdateSubLocationPath = z.object({
|
|
5909
|
+
id: z.string()
|
|
5910
|
+
});
|
|
5911
|
+
/**
|
|
5912
|
+
* Success
|
|
5913
|
+
*/
|
|
5914
|
+
export const zUpdateSubLocationResponse = zAssetsSubLocationResponseObject;
|
|
5580
5915
|
export const zListTransfersQuery = z.object({
|
|
5581
5916
|
'filter[status]': z.string().optional(),
|
|
5582
5917
|
filter: z.string().optional(),
|
|
@@ -5952,6 +6287,28 @@ export const zUpdateCheckPath = z.object({
|
|
|
5952
6287
|
* Success
|
|
5953
6288
|
*/
|
|
5954
6289
|
export const zUpdateCheckResponse = zComplianceCheckResponseObject;
|
|
6290
|
+
export const zListRequirementsQuery = z.object({
|
|
6291
|
+
'filter[search]': z.string().optional(),
|
|
6292
|
+
'filter[type]': z.string().optional(),
|
|
6293
|
+
'filter[category]': z.string().optional(),
|
|
6294
|
+
'filter[phase]': z.string().optional(),
|
|
6295
|
+
'filter[priority]': z.string().optional(),
|
|
6296
|
+
'filter[requisite]': z.string().optional(),
|
|
6297
|
+
'filter[target]': z.string().optional(),
|
|
6298
|
+
filter: z.string().optional(),
|
|
6299
|
+
'filter[unexpected]': z.string().optional(),
|
|
6300
|
+
'page[cursor]': z.string().optional(),
|
|
6301
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
6302
|
+
page: z.string().optional()
|
|
6303
|
+
});
|
|
6304
|
+
/**
|
|
6305
|
+
* Success
|
|
6306
|
+
*/
|
|
6307
|
+
export const zListRequirementsResponse = z.object({
|
|
6308
|
+
meta: zMeta,
|
|
6309
|
+
links: zLinks,
|
|
6310
|
+
data: z.array(zComplianceRequirementResponseObject)
|
|
6311
|
+
});
|
|
5955
6312
|
export const zListCustomFieldConfigsQuery = z.object({
|
|
5956
6313
|
'page[cursor]': z.string().optional(),
|
|
5957
6314
|
'page[limit]': z.int().gte(1).optional().default(20),
|
|
@@ -6250,6 +6607,18 @@ export const zGetRateRuleQuery = z.object({
|
|
|
6250
6607
|
* Success
|
|
6251
6608
|
*/
|
|
6252
6609
|
export const zGetRateRuleResponse = zRateRuleResponseObject;
|
|
6610
|
+
export const zShiftJobWageDeterminationGenesisBody = zJobWageDeterminationGenesisParameters;
|
|
6611
|
+
export const zShiftJobWageDeterminationGenesisHeaders = z.object({
|
|
6612
|
+
'If-Match': z.string()
|
|
6613
|
+
});
|
|
6614
|
+
export const zShiftJobWageDeterminationGenesisPath = z.object({
|
|
6615
|
+
job_id: z.string(),
|
|
6616
|
+
wage_determination_id: z.string()
|
|
6617
|
+
});
|
|
6618
|
+
/**
|
|
6619
|
+
* Success
|
|
6620
|
+
*/
|
|
6621
|
+
export const zShiftJobWageDeterminationGenesisResponse = zJobWageDeterminationResponseObject;
|
|
6253
6622
|
export const zListJobWageDeterminationHistoryPath = z.object({
|
|
6254
6623
|
job_id: z.string(),
|
|
6255
6624
|
wage_determination_id: z.string()
|
|
@@ -6265,6 +6634,60 @@ export const zListJobWageDeterminationHistoryResponse = z.object({
|
|
|
6265
6634
|
links: zLinks,
|
|
6266
6635
|
data: z.array(zJobWageDeterminationHistoryVersionObject)
|
|
6267
6636
|
});
|
|
6637
|
+
export const zCancelJobWageDeterminationScheduledChangesHeaders = z.object({
|
|
6638
|
+
'If-Match': z.string()
|
|
6639
|
+
});
|
|
6640
|
+
export const zCancelJobWageDeterminationScheduledChangesPath = z.object({
|
|
6641
|
+
job_id: z.string(),
|
|
6642
|
+
wage_determination_id: z.string()
|
|
6643
|
+
});
|
|
6644
|
+
/**
|
|
6645
|
+
* Success
|
|
6646
|
+
*/
|
|
6647
|
+
export const zCancelJobWageDeterminationScheduledChangesResponse = zJobWageDeterminationResponseObject;
|
|
6648
|
+
export const zListJobWageDeterminationScheduledChangesPath = z.object({
|
|
6649
|
+
job_id: z.string(),
|
|
6650
|
+
wage_determination_id: z.string()
|
|
6651
|
+
});
|
|
6652
|
+
/**
|
|
6653
|
+
* Success with scheduled changes
|
|
6654
|
+
*/
|
|
6655
|
+
export const zListJobWageDeterminationScheduledChangesResponse = z.array(zJobWageDeterminationResponseObject);
|
|
6656
|
+
export const zScheduleJobWageDeterminationChangeBody = zJobWageDeterminationScheduledChangeParameters;
|
|
6657
|
+
export const zScheduleJobWageDeterminationChangeHeaders = z.object({
|
|
6658
|
+
'If-Match': z.string()
|
|
6659
|
+
});
|
|
6660
|
+
export const zScheduleJobWageDeterminationChangePath = z.object({
|
|
6661
|
+
job_id: z.string(),
|
|
6662
|
+
wage_determination_id: z.string()
|
|
6663
|
+
});
|
|
6664
|
+
/**
|
|
6665
|
+
* Created
|
|
6666
|
+
*/
|
|
6667
|
+
export const zScheduleJobWageDeterminationChangeResponse = zJobWageDeterminationResponseObject;
|
|
6668
|
+
export const zCancelJobWageDeterminationScheduledTerminationHeaders = z.object({
|
|
6669
|
+
'If-Match': z.string()
|
|
6670
|
+
});
|
|
6671
|
+
export const zCancelJobWageDeterminationScheduledTerminationPath = z.object({
|
|
6672
|
+
job_id: z.string(),
|
|
6673
|
+
wage_determination_id: z.string()
|
|
6674
|
+
});
|
|
6675
|
+
/**
|
|
6676
|
+
* Success
|
|
6677
|
+
*/
|
|
6678
|
+
export const zCancelJobWageDeterminationScheduledTerminationResponse = zJobWageDeterminationResponseObject;
|
|
6679
|
+
export const zScheduleJobWageDeterminationTerminationBody = zJobWageDeterminationScheduledTerminationParameters;
|
|
6680
|
+
export const zScheduleJobWageDeterminationTerminationHeaders = z.object({
|
|
6681
|
+
'If-Match': z.string()
|
|
6682
|
+
});
|
|
6683
|
+
export const zScheduleJobWageDeterminationTerminationPath = z.object({
|
|
6684
|
+
job_id: z.string(),
|
|
6685
|
+
wage_determination_id: z.string()
|
|
6686
|
+
});
|
|
6687
|
+
/**
|
|
6688
|
+
* Created
|
|
6689
|
+
*/
|
|
6690
|
+
export const zScheduleJobWageDeterminationTerminationResponse = zJobWageDeterminationResponseObject;
|
|
6268
6691
|
export const zListJobWageDeterminationsPath = z.object({
|
|
6269
6692
|
job_id: z.string()
|
|
6270
6693
|
});
|
|
@@ -6313,6 +6736,18 @@ export const zGetJobWageDeterminationQuery = z.object({
|
|
|
6313
6736
|
* Success
|
|
6314
6737
|
*/
|
|
6315
6738
|
export const zGetJobWageDeterminationResponse = zJobWageDeterminationResponseObject;
|
|
6739
|
+
export const zUpdateJobWageDeterminationBody = zJobWageDeterminationUpdateParameters;
|
|
6740
|
+
export const zUpdateJobWageDeterminationHeaders = z.object({
|
|
6741
|
+
'If-Match': z.string()
|
|
6742
|
+
});
|
|
6743
|
+
export const zUpdateJobWageDeterminationPath = z.object({
|
|
6744
|
+
job_id: z.string(),
|
|
6745
|
+
id: z.string()
|
|
6746
|
+
});
|
|
6747
|
+
/**
|
|
6748
|
+
* Success
|
|
6749
|
+
*/
|
|
6750
|
+
export const zUpdateJobWageDeterminationResponse = zJobWageDeterminationResponseObject;
|
|
6316
6751
|
export const zListJobsQuery = z.object({
|
|
6317
6752
|
'filter[updated_at][gte]': z.iso.datetime().optional(),
|
|
6318
6753
|
'filter[updated_at][lte]': z.iso.datetime().optional(),
|
|
@@ -6996,6 +7431,25 @@ export const zListTemplatesResponse = z.object({
|
|
|
6996
7431
|
links: zLinks,
|
|
6997
7432
|
data: z.array(zJobTemplateResponseObject)
|
|
6998
7433
|
});
|
|
7434
|
+
export const zListAdjustableLineItemsPath = z.object({
|
|
7435
|
+
time_card_id: z.string()
|
|
7436
|
+
});
|
|
7437
|
+
export const zListAdjustableLineItemsQuery = z.object({
|
|
7438
|
+
'filter[payrolls_paystub_id]': z.string().optional(),
|
|
7439
|
+
'page[cursor]': z.string().optional(),
|
|
7440
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
7441
|
+
page: z.string().optional(),
|
|
7442
|
+
filter: z.string().optional(),
|
|
7443
|
+
'filter[unexpected]': z.string().optional()
|
|
7444
|
+
});
|
|
7445
|
+
/**
|
|
7446
|
+
* Success
|
|
7447
|
+
*/
|
|
7448
|
+
export const zListAdjustableLineItemsResponse = z.object({
|
|
7449
|
+
meta: zMeta,
|
|
7450
|
+
links: zLinks,
|
|
7451
|
+
data: z.array(zAdjustableLineItemResponseObject)
|
|
7452
|
+
});
|
|
6999
7453
|
export const zSetTimeCardLockBody = zTimeCardLockParameters;
|
|
7000
7454
|
export const zSetTimeCardLockPath = z.object({
|
|
7001
7455
|
time_card_id: z.string()
|
|
@@ -7070,6 +7524,22 @@ export const zListPriorPeriodAdjustmentsResponse = z.object({
|
|
|
7070
7524
|
links: zLinks,
|
|
7071
7525
|
data: z.array(zPriorPeriodAdjustmentResponseObject)
|
|
7072
7526
|
});
|
|
7527
|
+
export const zCreatePriorPeriodAdjustmentBody = zPriorPeriodAdjustmentParameters;
|
|
7528
|
+
export const zCreatePriorPeriodAdjustmentPath = z.object({
|
|
7529
|
+
time_card_id: z.string()
|
|
7530
|
+
});
|
|
7531
|
+
/**
|
|
7532
|
+
* Created
|
|
7533
|
+
*/
|
|
7534
|
+
export const zCreatePriorPeriodAdjustmentResponse = zPriorPeriodAdjustmentResponseObject;
|
|
7535
|
+
export const zDeletePriorPeriodAdjustmentPath = z.object({
|
|
7536
|
+
time_card_id: z.string(),
|
|
7537
|
+
id: z.string()
|
|
7538
|
+
});
|
|
7539
|
+
/**
|
|
7540
|
+
* Success
|
|
7541
|
+
*/
|
|
7542
|
+
export const zDeletePriorPeriodAdjustmentResponse = zPriorPeriodAdjustmentResponseObject;
|
|
7073
7543
|
export const zGetPriorPeriodAdjustmentPath = z.object({
|
|
7074
7544
|
time_card_id: z.string(),
|
|
7075
7545
|
id: z.string()
|
|
@@ -7078,6 +7548,25 @@ export const zGetPriorPeriodAdjustmentPath = z.object({
|
|
|
7078
7548
|
* Success
|
|
7079
7549
|
*/
|
|
7080
7550
|
export const zGetPriorPeriodAdjustmentResponse = zPriorPeriodAdjustmentResponseObject;
|
|
7551
|
+
export const zListPwaCompliancesPath = z.object({
|
|
7552
|
+
time_card_id: z.string()
|
|
7553
|
+
});
|
|
7554
|
+
export const zListPwaCompliancesQuery = z.object({
|
|
7555
|
+
'filter[job_id]': z.string().optional(),
|
|
7556
|
+
'page[cursor]': z.string().optional(),
|
|
7557
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
7558
|
+
page: z.string().optional(),
|
|
7559
|
+
filter: z.string().optional(),
|
|
7560
|
+
'filter[unexpected]': z.string().optional()
|
|
7561
|
+
});
|
|
7562
|
+
/**
|
|
7563
|
+
* Success
|
|
7564
|
+
*/
|
|
7565
|
+
export const zListPwaCompliancesResponse = z.object({
|
|
7566
|
+
meta: zMeta,
|
|
7567
|
+
links: zLinks,
|
|
7568
|
+
data: z.array(zPwaComplianceResponseObject)
|
|
7569
|
+
});
|
|
7081
7570
|
export const zCreateWorkerTimeCardApprovalBody = zWorkerTimeCardApprovalParameters;
|
|
7082
7571
|
export const zCreateWorkerTimeCardApprovalPath = z.object({
|
|
7083
7572
|
time_card_id: z.string()
|