@dsptch-work/api-client 0.20.0 → 0.22.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 +64 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +371 -16
- package/dist/gen/sdk.gen.js +546 -15
- package/dist/gen/types.gen.d.ts +2210 -736
- package/dist/gen/zod.gen.d.ts +3327 -1598
- package/dist/gen/zod.gen.js +467 -16
- package/package.json +1 -1
package/dist/gen/zod.gen.js
CHANGED
|
@@ -8,7 +8,7 @@ export const zProblem = z.object({
|
|
|
8
8
|
title: z.string(),
|
|
9
9
|
status: z.int(),
|
|
10
10
|
detail: z.string(),
|
|
11
|
-
instance: z.url()
|
|
11
|
+
instance: z.url(),
|
|
12
12
|
errors: z.array(z.object({
|
|
13
13
|
detail: z.string(),
|
|
14
14
|
pointer: z.string().optional()
|
|
@@ -418,6 +418,9 @@ export const zDirectUploadParameters = z.object({
|
|
|
418
418
|
'assets.products',
|
|
419
419
|
'assets.vendors',
|
|
420
420
|
'compliance.checks',
|
|
421
|
+
'internal.company_todos',
|
|
422
|
+
'internal.job_todos',
|
|
423
|
+
'internal.project_todos',
|
|
421
424
|
'pay_periods.imports.aggregate_times',
|
|
422
425
|
'pay_periods.imports.dsptch_cprs',
|
|
423
426
|
'pay_periods.imports.time_entries',
|
|
@@ -863,7 +866,7 @@ export const zTimecodeResponseObject = z.object({
|
|
|
863
866
|
updated_at: z.iso.datetime()
|
|
864
867
|
});
|
|
865
868
|
/**
|
|
866
|
-
* An employment stint in the credential company. Its id is stable across valid-time versions; a rehire is a separate stint with a new id. A read returns only a version covering now or as_of[valid].
|
|
869
|
+
* An employment stint in the credential company. Its id is stable across valid-time versions; a rehire is a separate stint with a new id. A read returns only a version covering now or as_of[valid]. Company keys, company administrators, and the employed person receive direct monetary fields; those fields are omitted for company managers reading coworkers.
|
|
867
870
|
*/
|
|
868
871
|
export const zPeopleEmploymentResponseObject = z.object({
|
|
869
872
|
id: z.string(),
|
|
@@ -884,16 +887,84 @@ export const zPeopleEmploymentResponseObject = z.object({
|
|
|
884
887
|
pto_annual_minutes: z.int().nullable(),
|
|
885
888
|
holiday_annual_minutes: z.int().nullable(),
|
|
886
889
|
training_annual_minutes: z.int().nullable(),
|
|
887
|
-
hourly_rate_cents: z.string().
|
|
888
|
-
training_annual_amount_cents: z.string().
|
|
889
|
-
employer_combined_health_amount_cents: z.string().
|
|
890
|
-
employer_combined_savings_cents: z.string().
|
|
890
|
+
hourly_rate_cents: z.string().nullish(),
|
|
891
|
+
training_annual_amount_cents: z.string().nullish(),
|
|
892
|
+
employer_combined_health_amount_cents: z.string().nullish(),
|
|
893
|
+
employer_combined_savings_cents: z.string().nullish(),
|
|
891
894
|
currency: z.string(),
|
|
892
895
|
valid_from: z.iso.datetime().nullable(),
|
|
893
896
|
valid_to: z.iso.datetime().nullable(),
|
|
894
897
|
created_at: z.iso.datetime(),
|
|
895
898
|
updated_at: z.iso.datetime()
|
|
896
899
|
});
|
|
900
|
+
/**
|
|
901
|
+
* Create a distinct employment stint for an existing user in the credential company. Only user_id and hire_date are required; omitted optional fields use the defaults or null values described below. This does not create a user, invitation, role, group, or login identity.
|
|
902
|
+
*/
|
|
903
|
+
export const zPeopleEmploymentCreateParameters = z.object({
|
|
904
|
+
user_id: z.string(),
|
|
905
|
+
hire_date: z.iso.date(),
|
|
906
|
+
type: z.enum(['EMPLOYEE', 'CONTRACTOR']).optional(),
|
|
907
|
+
title: z.string().nullish(),
|
|
908
|
+
manager_user_id: z.string().nullish(),
|
|
909
|
+
payroll_id: z.string().nullish(),
|
|
910
|
+
enrolled_in_t_and_a: z.boolean().optional(),
|
|
911
|
+
compensation_type: z.enum(['hourly', 'salary']).optional(),
|
|
912
|
+
hourly_rate_cents: z.string().nullish(),
|
|
913
|
+
overtime_eligible: z.boolean().nullish(),
|
|
914
|
+
overtime_package_id: z.string().nullish(),
|
|
915
|
+
worked_annual_minutes: z.int().nullish(),
|
|
916
|
+
pto_annual_minutes: z.int().nullish(),
|
|
917
|
+
holiday_annual_minutes: z.int().nullish(),
|
|
918
|
+
training_annual_minutes: z.int().nullish(),
|
|
919
|
+
training_annual_amount_cents: z.string().nullish(),
|
|
920
|
+
employer_combined_health_amount_cents: z.string().nullish(),
|
|
921
|
+
employer_combined_savings_cents: z.string().nullish()
|
|
922
|
+
});
|
|
923
|
+
/**
|
|
924
|
+
* Request body for creating one strictly future employment boundary. effective_date is required and is interpreted at midnight in the credential company's time zone. Send at least one value to change; omitted values carry forward from the version immediately before the new boundary.
|
|
925
|
+
*/
|
|
926
|
+
export const zPeopleEmploymentScheduledChangeCreateParameters = z.object({
|
|
927
|
+
compensation_type: z.enum(['hourly', 'salary']).optional(),
|
|
928
|
+
hourly_rate_cents: z.string().nullish(),
|
|
929
|
+
overtime_eligible: z.boolean().nullish(),
|
|
930
|
+
overtime_package_id: z.string().nullish(),
|
|
931
|
+
worked_annual_minutes: z.int().nullish(),
|
|
932
|
+
pto_annual_minutes: z.int().nullish(),
|
|
933
|
+
holiday_annual_minutes: z.int().nullish(),
|
|
934
|
+
training_annual_minutes: z.int().nullish(),
|
|
935
|
+
training_annual_amount_cents: z.string().nullish(),
|
|
936
|
+
employer_combined_health_amount_cents: z.string().nullish(),
|
|
937
|
+
employer_combined_savings_cents: z.string().nullish(),
|
|
938
|
+
effective_date: z.iso.date()
|
|
939
|
+
});
|
|
940
|
+
/**
|
|
941
|
+
* Request body for changing values at one exact strictly future employment boundary. Send only the fields to change; omitted values remain as recorded at that boundary. The boundary date cannot move.
|
|
942
|
+
*/
|
|
943
|
+
export const zPeopleEmploymentScheduledChangeUpdateParameters = z.object({
|
|
944
|
+
compensation_type: z.enum(['hourly', 'salary']).optional(),
|
|
945
|
+
hourly_rate_cents: z.string().nullish(),
|
|
946
|
+
overtime_eligible: z.boolean().nullish(),
|
|
947
|
+
overtime_package_id: z.string().nullish(),
|
|
948
|
+
worked_annual_minutes: z.int().nullish(),
|
|
949
|
+
pto_annual_minutes: z.int().nullish(),
|
|
950
|
+
holiday_annual_minutes: z.int().nullish(),
|
|
951
|
+
training_annual_minutes: z.int().nullish(),
|
|
952
|
+
training_annual_amount_cents: z.string().nullish(),
|
|
953
|
+
employer_combined_health_amount_cents: z.string().nullish(),
|
|
954
|
+
employer_combined_savings_cents: z.string().nullish()
|
|
955
|
+
});
|
|
956
|
+
/**
|
|
957
|
+
* Parameters for moving where an employment stint's valid-time timeline begins.
|
|
958
|
+
*/
|
|
959
|
+
export const zPeopleEmploymentGenesisParameters = z.object({
|
|
960
|
+
effective_date: z.iso.date().optional()
|
|
961
|
+
});
|
|
962
|
+
/**
|
|
963
|
+
* Parameters for scheduling when an employment stint stops being valid.
|
|
964
|
+
*/
|
|
965
|
+
export const zPeopleEmploymentScheduledTerminationParameters = z.object({
|
|
966
|
+
effective_date: z.iso.date()
|
|
967
|
+
});
|
|
897
968
|
export const zPeopleEmploymentHistoryCorrectionObject = z.object({
|
|
898
969
|
people_employment_id: z.string(),
|
|
899
970
|
user_id: z.string(),
|
|
@@ -913,10 +984,10 @@ export const zPeopleEmploymentHistoryCorrectionObject = z.object({
|
|
|
913
984
|
pto_annual_minutes: z.int().nullable(),
|
|
914
985
|
holiday_annual_minutes: z.int().nullable(),
|
|
915
986
|
training_annual_minutes: z.int().nullable(),
|
|
916
|
-
hourly_rate_cents: z.string().
|
|
917
|
-
training_annual_amount_cents: z.string().
|
|
918
|
-
employer_combined_health_amount_cents: z.string().
|
|
919
|
-
employer_combined_savings_cents: z.string().
|
|
987
|
+
hourly_rate_cents: z.string().nullish(),
|
|
988
|
+
training_annual_amount_cents: z.string().nullish(),
|
|
989
|
+
employer_combined_health_amount_cents: z.string().nullish(),
|
|
990
|
+
employer_combined_savings_cents: z.string().nullish(),
|
|
920
991
|
currency: z.string(),
|
|
921
992
|
valid_from: z.iso.datetime().nullable(),
|
|
922
993
|
valid_to: z.iso.datetime().nullable(),
|
|
@@ -942,10 +1013,10 @@ export const zPeopleEmploymentHistoryVersionObject = z.object({
|
|
|
942
1013
|
pto_annual_minutes: z.int().nullable(),
|
|
943
1014
|
holiday_annual_minutes: z.int().nullable(),
|
|
944
1015
|
training_annual_minutes: z.int().nullable(),
|
|
945
|
-
hourly_rate_cents: z.string().
|
|
946
|
-
training_annual_amount_cents: z.string().
|
|
947
|
-
employer_combined_health_amount_cents: z.string().
|
|
948
|
-
employer_combined_savings_cents: z.string().
|
|
1016
|
+
hourly_rate_cents: z.string().nullish(),
|
|
1017
|
+
training_annual_amount_cents: z.string().nullish(),
|
|
1018
|
+
employer_combined_health_amount_cents: z.string().nullish(),
|
|
1019
|
+
employer_combined_savings_cents: z.string().nullish(),
|
|
949
1020
|
currency: z.string(),
|
|
950
1021
|
valid_from: z.iso.datetime().nullable(),
|
|
951
1022
|
valid_to: z.iso.datetime().nullable(),
|
|
@@ -3059,6 +3130,7 @@ export const zProjectResponseObject = z.object({
|
|
|
3059
3130
|
owned_by_company_id: z.string(),
|
|
3060
3131
|
created_by_user_id: z.string().nullable(),
|
|
3061
3132
|
parent_id: z.string().nullable(),
|
|
3133
|
+
participating_company_ids: z.array(z.string()),
|
|
3062
3134
|
federal_pwa_mode: z.enum([
|
|
3063
3135
|
'all',
|
|
3064
3136
|
'pw_only',
|
|
@@ -3087,13 +3159,15 @@ export const zProjectResponseObject = z.object({
|
|
|
3087
3159
|
updated_at: z.iso.datetime()
|
|
3088
3160
|
});
|
|
3089
3161
|
/**
|
|
3090
|
-
* Request body for creating a project. `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body.
|
|
3162
|
+
* Request body for creating or updating a project. Only `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body. Omit relationship fields on PATCH to leave them unchanged.
|
|
3091
3163
|
*/
|
|
3092
3164
|
export const zProjectParameters = z.object({
|
|
3093
3165
|
external_id: z.string().nullish(),
|
|
3094
3166
|
name: z.string(),
|
|
3095
3167
|
description: z.string().nullish(),
|
|
3096
3168
|
created_by_user_id: z.string(),
|
|
3169
|
+
parent_id: z.string().nullish(),
|
|
3170
|
+
participating_company_ids: z.array(z.string()).optional(),
|
|
3097
3171
|
start_date: z.iso.date().nullish(),
|
|
3098
3172
|
end_date: z.iso.date().nullish(),
|
|
3099
3173
|
tz_name: z.string().nullish(),
|
|
@@ -3128,6 +3202,8 @@ export const zProjectUpdateParameters = z.object({
|
|
|
3128
3202
|
name: z.string().optional(),
|
|
3129
3203
|
description: z.string().nullish(),
|
|
3130
3204
|
created_by_user_id: z.string().nullish(),
|
|
3205
|
+
parent_id: z.string().nullish(),
|
|
3206
|
+
participating_company_ids: z.array(z.string()).optional(),
|
|
3131
3207
|
start_date: z.iso.date().nullish(),
|
|
3132
3208
|
end_date: z.iso.date().nullish(),
|
|
3133
3209
|
tz_name: z.string().nullish(),
|
|
@@ -3862,6 +3938,26 @@ export const zPaystubLineItemUpdateParameters = z.object({
|
|
|
3862
3938
|
contributor: z.enum(['employee', 'employer']).optional(),
|
|
3863
3939
|
payrolls_external_map_id: z.string().optional()
|
|
3864
3940
|
});
|
|
3941
|
+
/**
|
|
3942
|
+
* A company-owned collection of conditional wage and fringe adjustments, optionally scoped to a job.
|
|
3943
|
+
*/
|
|
3944
|
+
export const zPayRatesRulePackageResponseObject = z.object({
|
|
3945
|
+
id: z.string(),
|
|
3946
|
+
name: z.string(),
|
|
3947
|
+
description: z.string().nullable(),
|
|
3948
|
+
scoped_to_job_id: z.string().nullable(),
|
|
3949
|
+
default: z.boolean(),
|
|
3950
|
+
selectable: z.boolean(),
|
|
3951
|
+
created_at: z.iso.datetime(),
|
|
3952
|
+
updated_at: z.iso.datetime()
|
|
3953
|
+
});
|
|
3954
|
+
/**
|
|
3955
|
+
* Parameters for creating a company-wide pay-rate rule package.
|
|
3956
|
+
*/
|
|
3957
|
+
export const zPayRatesRulePackageParameters = z.object({
|
|
3958
|
+
name: z.string().min(1),
|
|
3959
|
+
description: z.string().nullish()
|
|
3960
|
+
});
|
|
3865
3961
|
/**
|
|
3866
3962
|
* Request body for creating or updating a position on a job. The job is taken from the URL path.
|
|
3867
3963
|
*/
|
|
@@ -4233,6 +4329,7 @@ export const zPositionResponseObject = z.object({
|
|
|
4233
4329
|
id: z.string(),
|
|
4234
4330
|
job_id: z.string(),
|
|
4235
4331
|
fulfilled_by_user_id: z.string().nullable(),
|
|
4332
|
+
pay_rates_rule_package_id: z.string().nullable(),
|
|
4236
4333
|
position_function: zPositionFunction,
|
|
4237
4334
|
per_diem_name: z.string().nullable(),
|
|
4238
4335
|
per_diem_currency: z.string().nullable(),
|
|
@@ -4914,6 +5011,7 @@ export const zFederalJobWageDeterminationResponseObject = z.object({
|
|
|
4914
5011
|
job_id: z.string(),
|
|
4915
5012
|
pwa_trade_id: z.string(),
|
|
4916
5013
|
overtime_package_id: z.string().nullable(),
|
|
5014
|
+
pay_rates_rule_package_id: z.string().nullable(),
|
|
4917
5015
|
type: z.enum(['Pwa::JobWageDeterminations::Federal']),
|
|
4918
5016
|
labor_classification: z.string(),
|
|
4919
5017
|
hourly_rate_cents: z.string(),
|
|
@@ -4936,6 +5034,7 @@ export const zFederalJobWageDeterminationHistoryCorrectionObject = z.object({
|
|
|
4936
5034
|
job_id: z.string(),
|
|
4937
5035
|
pwa_trade_id: z.string(),
|
|
4938
5036
|
overtime_package_id: z.string().nullable(),
|
|
5037
|
+
pay_rates_rule_package_id: z.string().nullable(),
|
|
4939
5038
|
type: z.enum(['Pwa::JobWageDeterminations::Federal']),
|
|
4940
5039
|
labor_classification: z.string(),
|
|
4941
5040
|
hourly_rate_cents: z.string(),
|
|
@@ -5007,6 +5106,7 @@ export const zRegionalJobWageDeterminationResponseObject = z.object({
|
|
|
5007
5106
|
job_id: z.string(),
|
|
5008
5107
|
pwa_trade_id: z.string(),
|
|
5009
5108
|
overtime_package_id: z.string().nullable(),
|
|
5109
|
+
pay_rates_rule_package_id: z.string().nullable(),
|
|
5010
5110
|
type: z.enum(['Pwa::JobWageDeterminations::Regional']),
|
|
5011
5111
|
labor_classification: z.string(),
|
|
5012
5112
|
hourly_rate_cents: z.string(),
|
|
@@ -5030,6 +5130,7 @@ export const zRegionalJobWageDeterminationHistoryCorrectionObject = z.object({
|
|
|
5030
5130
|
job_id: z.string(),
|
|
5031
5131
|
pwa_trade_id: z.string(),
|
|
5032
5132
|
overtime_package_id: z.string().nullable(),
|
|
5133
|
+
pay_rates_rule_package_id: z.string().nullable(),
|
|
5033
5134
|
type: z.enum(['Pwa::JobWageDeterminations::Regional']),
|
|
5034
5135
|
labor_classification: z.string(),
|
|
5035
5136
|
hourly_rate_cents: z.string(),
|
|
@@ -5050,6 +5151,7 @@ export const zFederalJobWageDeterminationHistoryVersionObject = z.object({
|
|
|
5050
5151
|
job_id: z.string(),
|
|
5051
5152
|
pwa_trade_id: z.string(),
|
|
5052
5153
|
overtime_package_id: z.string().nullable(),
|
|
5154
|
+
pay_rates_rule_package_id: z.string().nullable(),
|
|
5053
5155
|
type: z.enum(['Pwa::JobWageDeterminations::Federal']),
|
|
5054
5156
|
labor_classification: z.string(),
|
|
5055
5157
|
hourly_rate_cents: z.string(),
|
|
@@ -5078,6 +5180,7 @@ export const zRegionalJobWageDeterminationHistoryVersionObject = z.object({
|
|
|
5078
5180
|
job_id: z.string(),
|
|
5079
5181
|
pwa_trade_id: z.string(),
|
|
5080
5182
|
overtime_package_id: z.string().nullable(),
|
|
5183
|
+
pay_rates_rule_package_id: z.string().nullable(),
|
|
5081
5184
|
type: z.enum(['Pwa::JobWageDeterminations::Regional']),
|
|
5082
5185
|
labor_classification: z.string(),
|
|
5083
5186
|
hourly_rate_cents: z.string(),
|
|
@@ -5115,7 +5218,8 @@ export const zFederalJobWageDeterminationParameters = z.object({
|
|
|
5115
5218
|
'highway',
|
|
5116
5219
|
'residential'
|
|
5117
5220
|
]).nullish(),
|
|
5118
|
-
general_wage_determination: z.string().nullish()
|
|
5221
|
+
general_wage_determination: z.string().nullish(),
|
|
5222
|
+
pay_rates_rule_package_id: z.string().nullish()
|
|
5119
5223
|
});
|
|
5120
5224
|
/**
|
|
5121
5225
|
* Parameters for creating a Regional (state prevailing-wage) wage determination on a job.
|
|
@@ -5128,6 +5232,7 @@ export const zRegionalJobWageDeterminationParameters = z.object({
|
|
|
5128
5232
|
fringe_rate_cents: z.string().optional(),
|
|
5129
5233
|
general_wage_determination: z.string().nullish(),
|
|
5130
5234
|
overtime_package_id: z.string().nullish(),
|
|
5235
|
+
pay_rates_rule_package_id: z.string().nullish(),
|
|
5131
5236
|
regional_fields: zRegionalWageDeterminationFields.optional()
|
|
5132
5237
|
});
|
|
5133
5238
|
/**
|
|
@@ -5143,6 +5248,7 @@ export const zJobWageDeterminationParameters = z.discriminatedUnion('type', [
|
|
|
5143
5248
|
export const zJobWageDeterminationUpdateParameters = z.object({
|
|
5144
5249
|
effective_from: z.iso.date().optional(),
|
|
5145
5250
|
overtime_package_id: z.string().nullish(),
|
|
5251
|
+
pay_rates_rule_package_id: z.string().nullish(),
|
|
5146
5252
|
labor_classification: z.string().optional(),
|
|
5147
5253
|
pwa_trade_id: z.string().optional(),
|
|
5148
5254
|
hourly_rate_cents: z.string().optional(),
|
|
@@ -5291,6 +5397,84 @@ export const zRateRuleHistoryVersionObject = z.object({
|
|
|
5291
5397
|
]),
|
|
5292
5398
|
corrections: z.array(zRateRuleHistoryCorrectionObject)
|
|
5293
5399
|
});
|
|
5400
|
+
/**
|
|
5401
|
+
* A conditional wage or fringe adjustment owned by a pay-rate rule package, with the selected version's valid-time window.
|
|
5402
|
+
*/
|
|
5403
|
+
export const zPayRatesRuleResponseObject = z.object({
|
|
5404
|
+
id: z.string(),
|
|
5405
|
+
pay_rates_rule_package_id: z.string(),
|
|
5406
|
+
currency: z.string(),
|
|
5407
|
+
effect: zRateRuleEffect,
|
|
5408
|
+
conditions: z.array(zRateRuleCondition),
|
|
5409
|
+
valid_from: z.iso.datetime().nullable(),
|
|
5410
|
+
valid_to: z.iso.datetime().nullable(),
|
|
5411
|
+
created_at: z.iso.datetime(),
|
|
5412
|
+
updated_at: z.iso.datetime()
|
|
5413
|
+
});
|
|
5414
|
+
/**
|
|
5415
|
+
* Parameters for creating a conditional wage or fringe adjustment in a pay-rate rule package.
|
|
5416
|
+
*/
|
|
5417
|
+
export const zPayRatesRuleParameters = z.object({
|
|
5418
|
+
effect: zRateRuleEffect,
|
|
5419
|
+
conditions: z.array(zRateRuleCondition).optional(),
|
|
5420
|
+
effective_date: z.iso.date().optional()
|
|
5421
|
+
});
|
|
5422
|
+
/**
|
|
5423
|
+
* Change a rule from an effective date forward. Omitted effect or conditions keep that part of the targeted version. When the targeted recipe changes, the resulting complete recipe applies from that coordinate across later scheduled versions; an unchanged recipe does not alter later scheduled versions. An empty conditions list makes the rule unconditional. Omit effective_from to correct the selected version from its exact existing start. A rule with an unbounded lower limit requires effective_from.
|
|
5424
|
+
*/
|
|
5425
|
+
export const zPayRatesRuleUpdateParameters = z.object({
|
|
5426
|
+
effect: zRateRuleEffect.optional(),
|
|
5427
|
+
conditions: z.array(zRateRuleCondition).optional(),
|
|
5428
|
+
effective_from: z.iso.date().optional()
|
|
5429
|
+
});
|
|
5430
|
+
/**
|
|
5431
|
+
* Parameters for moving where a pay-rate rule family's valid-time timeline begins.
|
|
5432
|
+
*/
|
|
5433
|
+
export const zPayRatesRuleGenesisParameters = z.object({
|
|
5434
|
+
effective_date: z.iso.date()
|
|
5435
|
+
});
|
|
5436
|
+
/**
|
|
5437
|
+
* Parameters for scheduling when a pay-rate rule family stops being valid.
|
|
5438
|
+
*/
|
|
5439
|
+
export const zPayRatesRuleScheduledTerminationParameters = z.object({
|
|
5440
|
+
effective_date: z.iso.date()
|
|
5441
|
+
});
|
|
5442
|
+
/**
|
|
5443
|
+
* Schedule a rule recipe change from a company-local effective date.
|
|
5444
|
+
*/
|
|
5445
|
+
export const zPayRatesRuleScheduledChangeParameters = z.object({
|
|
5446
|
+
effective_date: z.iso.date(),
|
|
5447
|
+
effect: zRateRuleEffect.optional(),
|
|
5448
|
+
conditions: z.array(zRateRuleCondition).optional()
|
|
5449
|
+
});
|
|
5450
|
+
export const zPayRatesRuleHistoryCorrectionObject = z.object({
|
|
5451
|
+
pay_rates_rule_id: z.string(),
|
|
5452
|
+
pay_rates_rule_package_id: z.string(),
|
|
5453
|
+
currency: z.string(),
|
|
5454
|
+
effect: zRateRuleEffect,
|
|
5455
|
+
conditions: z.array(zRateRuleCondition),
|
|
5456
|
+
valid_from: z.iso.datetime().nullable(),
|
|
5457
|
+
valid_to: z.iso.datetime().nullable(),
|
|
5458
|
+
created_at: z.iso.datetime(),
|
|
5459
|
+
updated_at: z.iso.datetime()
|
|
5460
|
+
});
|
|
5461
|
+
export const zPayRatesRuleHistoryVersionObject = z.object({
|
|
5462
|
+
pay_rates_rule_id: z.string(),
|
|
5463
|
+
pay_rates_rule_package_id: z.string(),
|
|
5464
|
+
currency: z.string(),
|
|
5465
|
+
effect: zRateRuleEffect,
|
|
5466
|
+
conditions: z.array(zRateRuleCondition),
|
|
5467
|
+
valid_from: z.iso.datetime().nullable(),
|
|
5468
|
+
valid_to: z.iso.datetime().nullable(),
|
|
5469
|
+
created_at: z.iso.datetime(),
|
|
5470
|
+
updated_at: z.iso.datetime(),
|
|
5471
|
+
version_status: z.enum([
|
|
5472
|
+
'scheduled',
|
|
5473
|
+
'current',
|
|
5474
|
+
'historical'
|
|
5475
|
+
]),
|
|
5476
|
+
corrections: z.array(zPayRatesRuleHistoryCorrectionObject)
|
|
5477
|
+
});
|
|
5294
5478
|
/**
|
|
5295
5479
|
* An overtime rule (daily or weekly) belonging to an overtime package. It sets a pay multiplier that applies once a worked-hours threshold — and any day or date qualifier — is met. `valid_from`/`valid_to` bound the window this version is in effect.
|
|
5296
5480
|
*/
|
|
@@ -8465,6 +8649,202 @@ export const zUpdateOvertimeRulePath = z.object({
|
|
|
8465
8649
|
* Success
|
|
8466
8650
|
*/
|
|
8467
8651
|
export const zUpdateOvertimeRuleResponse = zOvertimeRuleResponseObject;
|
|
8652
|
+
export const zShiftPayRateRuleGenesisBody = zPayRatesRuleGenesisParameters;
|
|
8653
|
+
export const zShiftPayRateRuleGenesisHeaders = z.object({
|
|
8654
|
+
'If-Match': z.string()
|
|
8655
|
+
});
|
|
8656
|
+
export const zShiftPayRateRuleGenesisPath = z.object({
|
|
8657
|
+
rule_package_id: z.string(),
|
|
8658
|
+
rule_id: z.string()
|
|
8659
|
+
});
|
|
8660
|
+
/**
|
|
8661
|
+
* Success
|
|
8662
|
+
*/
|
|
8663
|
+
export const zShiftPayRateRuleGenesisResponse = zPayRatesRuleResponseObject;
|
|
8664
|
+
export const zListPayRateRuleHistoryPath = z.object({
|
|
8665
|
+
rule_package_id: z.string(),
|
|
8666
|
+
rule_id: z.string()
|
|
8667
|
+
});
|
|
8668
|
+
export const zListPayRateRuleHistoryQuery = z.object({
|
|
8669
|
+
'as_of[valid]': z.string().optional(),
|
|
8670
|
+
'as_of[transaction]': z.string().optional(),
|
|
8671
|
+
'page[cursor]': z.string().optional(),
|
|
8672
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
8673
|
+
page: z.string().optional()
|
|
8674
|
+
});
|
|
8675
|
+
/**
|
|
8676
|
+
* Success
|
|
8677
|
+
*/
|
|
8678
|
+
export const zListPayRateRuleHistoryResponse = z.object({
|
|
8679
|
+
meta: zMeta,
|
|
8680
|
+
links: zLinks,
|
|
8681
|
+
data: z.array(zPayRatesRuleHistoryVersionObject)
|
|
8682
|
+
});
|
|
8683
|
+
export const zCancelPayRateRuleScheduledChangesHeaders = z.object({
|
|
8684
|
+
'If-Match': z.string()
|
|
8685
|
+
});
|
|
8686
|
+
export const zCancelPayRateRuleScheduledChangesPath = z.object({
|
|
8687
|
+
rule_package_id: z.string(),
|
|
8688
|
+
rule_id: z.string()
|
|
8689
|
+
});
|
|
8690
|
+
/**
|
|
8691
|
+
* Success
|
|
8692
|
+
*/
|
|
8693
|
+
export const zCancelPayRateRuleScheduledChangesResponse = zPayRatesRuleResponseObject;
|
|
8694
|
+
export const zListPayRateRuleScheduledChangesPath = z.object({
|
|
8695
|
+
rule_package_id: z.string(),
|
|
8696
|
+
rule_id: z.string()
|
|
8697
|
+
});
|
|
8698
|
+
export const zListPayRateRuleScheduledChangesQuery = z.object({
|
|
8699
|
+
'as_of[valid]': z.string().optional(),
|
|
8700
|
+
'as_of[transaction]': z.string().optional(),
|
|
8701
|
+
'page[cursor]': z.string().optional(),
|
|
8702
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
8703
|
+
page: z.string().optional()
|
|
8704
|
+
});
|
|
8705
|
+
/**
|
|
8706
|
+
* Success
|
|
8707
|
+
*/
|
|
8708
|
+
export const zListPayRateRuleScheduledChangesResponse = z.object({
|
|
8709
|
+
meta: zMeta,
|
|
8710
|
+
links: zLinks,
|
|
8711
|
+
data: z.array(zPayRatesRuleHistoryVersionObject)
|
|
8712
|
+
});
|
|
8713
|
+
export const zSchedulePayRateRuleChangeBody = zPayRatesRuleScheduledChangeParameters;
|
|
8714
|
+
export const zSchedulePayRateRuleChangeHeaders = z.object({
|
|
8715
|
+
'If-Match': z.string()
|
|
8716
|
+
});
|
|
8717
|
+
export const zSchedulePayRateRuleChangePath = z.object({
|
|
8718
|
+
rule_package_id: z.string(),
|
|
8719
|
+
rule_id: z.string()
|
|
8720
|
+
});
|
|
8721
|
+
/**
|
|
8722
|
+
* Success without a new segment
|
|
8723
|
+
*/
|
|
8724
|
+
export const zSchedulePayRateRuleChangeResponse = zPayRatesRuleResponseObject;
|
|
8725
|
+
export const zCancelPayRateRuleScheduledTerminationHeaders = z.object({
|
|
8726
|
+
'If-Match': z.string()
|
|
8727
|
+
});
|
|
8728
|
+
export const zCancelPayRateRuleScheduledTerminationPath = z.object({
|
|
8729
|
+
rule_package_id: z.string(),
|
|
8730
|
+
rule_id: z.string()
|
|
8731
|
+
});
|
|
8732
|
+
/**
|
|
8733
|
+
* Success
|
|
8734
|
+
*/
|
|
8735
|
+
export const zCancelPayRateRuleScheduledTerminationResponse = zPayRatesRuleResponseObject;
|
|
8736
|
+
export const zSchedulePayRateRuleTerminationBody = zPayRatesRuleScheduledTerminationParameters;
|
|
8737
|
+
export const zSchedulePayRateRuleTerminationHeaders = z.object({
|
|
8738
|
+
'If-Match': z.string()
|
|
8739
|
+
});
|
|
8740
|
+
export const zSchedulePayRateRuleTerminationPath = z.object({
|
|
8741
|
+
rule_package_id: z.string(),
|
|
8742
|
+
rule_id: z.string()
|
|
8743
|
+
});
|
|
8744
|
+
/**
|
|
8745
|
+
* Created
|
|
8746
|
+
*/
|
|
8747
|
+
export const zSchedulePayRateRuleTerminationResponse = zPayRatesRuleResponseObject;
|
|
8748
|
+
export const zListPayRateRulesPath = z.object({
|
|
8749
|
+
rule_package_id: z.string()
|
|
8750
|
+
});
|
|
8751
|
+
export const zListPayRateRulesQuery = z.object({
|
|
8752
|
+
'as_of[valid]': z.iso.datetime().optional(),
|
|
8753
|
+
as_of: z.string().optional(),
|
|
8754
|
+
'as_of[bogus_axis]': z.string().optional(),
|
|
8755
|
+
'as_of[valid][gte]': z.string().optional(),
|
|
8756
|
+
'as_of[transaction]': z.string().optional(),
|
|
8757
|
+
filter: z.string().optional(),
|
|
8758
|
+
'filter[unexpected]': z.string().optional(),
|
|
8759
|
+
'page[cursor]': z.string().optional(),
|
|
8760
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
8761
|
+
page: z.string().optional()
|
|
8762
|
+
});
|
|
8763
|
+
/**
|
|
8764
|
+
* Success
|
|
8765
|
+
*/
|
|
8766
|
+
export const zListPayRateRulesResponse = z.object({
|
|
8767
|
+
meta: zMeta,
|
|
8768
|
+
links: zLinks,
|
|
8769
|
+
data: z.array(zPayRatesRuleResponseObject)
|
|
8770
|
+
});
|
|
8771
|
+
export const zCreatePayRateRuleBody = zPayRatesRuleParameters;
|
|
8772
|
+
export const zCreatePayRateRulePath = z.object({
|
|
8773
|
+
rule_package_id: z.string()
|
|
8774
|
+
});
|
|
8775
|
+
/**
|
|
8776
|
+
* Created
|
|
8777
|
+
*/
|
|
8778
|
+
export const zCreatePayRateRuleResponse = zPayRatesRuleResponseObject;
|
|
8779
|
+
export const zDeletePayRateRuleHeaders = z.object({
|
|
8780
|
+
'If-Match': z.string()
|
|
8781
|
+
});
|
|
8782
|
+
export const zDeletePayRateRulePath = z.object({
|
|
8783
|
+
rule_package_id: z.string(),
|
|
8784
|
+
id: z.string()
|
|
8785
|
+
});
|
|
8786
|
+
/**
|
|
8787
|
+
* Success
|
|
8788
|
+
*/
|
|
8789
|
+
export const zDeletePayRateRuleResponse = zPayRatesRuleResponseObject;
|
|
8790
|
+
export const zGetPayRateRulePath = z.object({
|
|
8791
|
+
rule_package_id: z.string(),
|
|
8792
|
+
id: z.string()
|
|
8793
|
+
});
|
|
8794
|
+
export const zGetPayRateRuleQuery = z.object({
|
|
8795
|
+
'as_of[valid]': z.iso.datetime().optional()
|
|
8796
|
+
});
|
|
8797
|
+
/**
|
|
8798
|
+
* Success
|
|
8799
|
+
*/
|
|
8800
|
+
export const zGetPayRateRuleResponse = zPayRatesRuleResponseObject;
|
|
8801
|
+
export const zUpdatePayRateRuleBody = zPayRatesRuleUpdateParameters;
|
|
8802
|
+
export const zUpdatePayRateRuleHeaders = z.object({
|
|
8803
|
+
'If-Match': z.string()
|
|
8804
|
+
});
|
|
8805
|
+
export const zUpdatePayRateRulePath = z.object({
|
|
8806
|
+
rule_package_id: z.string(),
|
|
8807
|
+
id: z.string()
|
|
8808
|
+
});
|
|
8809
|
+
/**
|
|
8810
|
+
* Success
|
|
8811
|
+
*/
|
|
8812
|
+
export const zUpdatePayRateRuleResponse = zPayRatesRuleResponseObject;
|
|
8813
|
+
export const zListPayRateRulePackagesQuery = z.object({
|
|
8814
|
+
'filter[scoped_to_job_id]': z.string().optional(),
|
|
8815
|
+
'filter[scoped_to_job_id][null]': z.boolean().optional(),
|
|
8816
|
+
'filter[default]': z.boolean().optional(),
|
|
8817
|
+
'filter[selectable]': z.boolean().optional(),
|
|
8818
|
+
'filter[created_at][gte]': z.iso.datetime().optional(),
|
|
8819
|
+
'filter[created_at][lte]': z.iso.datetime().optional(),
|
|
8820
|
+
'filter[updated_at][gte]': z.iso.datetime().optional(),
|
|
8821
|
+
'filter[updated_at][lte]': z.iso.datetime().optional(),
|
|
8822
|
+
filter: z.string().optional(),
|
|
8823
|
+
'filter[unexpected]': z.string().optional(),
|
|
8824
|
+
'page[cursor]': z.string().optional(),
|
|
8825
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
8826
|
+
page: z.string().optional()
|
|
8827
|
+
});
|
|
8828
|
+
/**
|
|
8829
|
+
* Success
|
|
8830
|
+
*/
|
|
8831
|
+
export const zListPayRateRulePackagesResponse = z.object({
|
|
8832
|
+
meta: zMeta,
|
|
8833
|
+
links: zLinks,
|
|
8834
|
+
data: z.array(zPayRatesRulePackageResponseObject)
|
|
8835
|
+
});
|
|
8836
|
+
export const zCreatePayRateRulePackageBody = zPayRatesRulePackageParameters;
|
|
8837
|
+
/**
|
|
8838
|
+
* Created
|
|
8839
|
+
*/
|
|
8840
|
+
export const zCreatePayRateRulePackageResponse = zPayRatesRulePackageResponseObject;
|
|
8841
|
+
export const zGetPayRateRulePackagePath = z.object({
|
|
8842
|
+
id: z.string()
|
|
8843
|
+
});
|
|
8844
|
+
/**
|
|
8845
|
+
* Success
|
|
8846
|
+
*/
|
|
8847
|
+
export const zGetPayRateRulePackageResponse = zPayRatesRulePackageResponseObject;
|
|
8468
8848
|
export const zListAggregateTimeImportsPath = z.object({
|
|
8469
8849
|
pay_period_id: z.string()
|
|
8470
8850
|
});
|
|
@@ -8876,6 +9256,17 @@ export const zUpdatePaystubPath = z.object({
|
|
|
8876
9256
|
* Success
|
|
8877
9257
|
*/
|
|
8878
9258
|
export const zUpdatePaystubResponse = zPaystubResponseObject;
|
|
9259
|
+
export const zUpdateGenesisBody = zPeopleEmploymentGenesisParameters;
|
|
9260
|
+
export const zUpdateGenesisHeaders = z.object({
|
|
9261
|
+
'If-Match': z.string()
|
|
9262
|
+
});
|
|
9263
|
+
export const zUpdateGenesisPath = z.object({
|
|
9264
|
+
employment_id: z.string()
|
|
9265
|
+
});
|
|
9266
|
+
/**
|
|
9267
|
+
* Success
|
|
9268
|
+
*/
|
|
9269
|
+
export const zUpdateGenesisResponse = zPeopleEmploymentResponseObject;
|
|
8879
9270
|
export const zListEmploymentHistoryPath = z.object({
|
|
8880
9271
|
employment_id: z.string()
|
|
8881
9272
|
});
|
|
@@ -8912,6 +9303,61 @@ export const zListEmploymentsHistoryResponse = z.object({
|
|
|
8912
9303
|
links: zLinks,
|
|
8913
9304
|
data: z.array(zPeopleEmploymentHistoryVersionObject)
|
|
8914
9305
|
});
|
|
9306
|
+
export const zCreateEmploymentScheduledChangeBody = zPeopleEmploymentScheduledChangeCreateParameters;
|
|
9307
|
+
export const zCreateEmploymentScheduledChangeHeaders = z.object({
|
|
9308
|
+
'If-Match': z.string()
|
|
9309
|
+
});
|
|
9310
|
+
export const zCreateEmploymentScheduledChangePath = z.object({
|
|
9311
|
+
employment_id: z.string()
|
|
9312
|
+
});
|
|
9313
|
+
/**
|
|
9314
|
+
* Created
|
|
9315
|
+
*/
|
|
9316
|
+
export const zCreateEmploymentScheduledChangeResponse = zPeopleEmploymentResponseObject;
|
|
9317
|
+
export const zDeleteEmploymentScheduledChangeHeaders = z.object({
|
|
9318
|
+
'If-Match': z.string()
|
|
9319
|
+
});
|
|
9320
|
+
export const zDeleteEmploymentScheduledChangePath = z.object({
|
|
9321
|
+
employment_id: z.string(),
|
|
9322
|
+
effective_date: z.iso.date()
|
|
9323
|
+
});
|
|
9324
|
+
/**
|
|
9325
|
+
* No Content
|
|
9326
|
+
*/
|
|
9327
|
+
export const zDeleteEmploymentScheduledChangeResponse = z.void();
|
|
9328
|
+
export const zUpdateEmploymentScheduledChangeBody = zPeopleEmploymentScheduledChangeUpdateParameters;
|
|
9329
|
+
export const zUpdateEmploymentScheduledChangeHeaders = z.object({
|
|
9330
|
+
'If-Match': z.string()
|
|
9331
|
+
});
|
|
9332
|
+
export const zUpdateEmploymentScheduledChangePath = z.object({
|
|
9333
|
+
employment_id: z.string(),
|
|
9334
|
+
effective_date: z.iso.date()
|
|
9335
|
+
});
|
|
9336
|
+
/**
|
|
9337
|
+
* Success
|
|
9338
|
+
*/
|
|
9339
|
+
export const zUpdateEmploymentScheduledChangeResponse = zPeopleEmploymentResponseObject;
|
|
9340
|
+
export const zDeleteScheduledTerminationHeaders = z.object({
|
|
9341
|
+
'If-Match': z.string()
|
|
9342
|
+
});
|
|
9343
|
+
export const zDeleteScheduledTerminationPath = z.object({
|
|
9344
|
+
employment_id: z.string()
|
|
9345
|
+
});
|
|
9346
|
+
/**
|
|
9347
|
+
* Success
|
|
9348
|
+
*/
|
|
9349
|
+
export const zDeleteScheduledTerminationResponse = zPeopleEmploymentResponseObject;
|
|
9350
|
+
export const zCreateEmploymentScheduledTerminationBody = zPeopleEmploymentScheduledTerminationParameters;
|
|
9351
|
+
export const zCreateEmploymentScheduledTerminationHeaders = z.object({
|
|
9352
|
+
'If-Match': z.string()
|
|
9353
|
+
});
|
|
9354
|
+
export const zCreateEmploymentScheduledTerminationPath = z.object({
|
|
9355
|
+
employment_id: z.string()
|
|
9356
|
+
});
|
|
9357
|
+
/**
|
|
9358
|
+
* Created
|
|
9359
|
+
*/
|
|
9360
|
+
export const zCreateEmploymentScheduledTerminationResponse = zPeopleEmploymentResponseObject;
|
|
8915
9361
|
export const zListEmploymentsQuery = z.object({
|
|
8916
9362
|
'filter[user_id]': z.string().optional(),
|
|
8917
9363
|
filter: z.string().optional(),
|
|
@@ -8933,6 +9379,11 @@ export const zListEmploymentsResponse = z.object({
|
|
|
8933
9379
|
links: zLinks,
|
|
8934
9380
|
data: z.array(zPeopleEmploymentResponseObject)
|
|
8935
9381
|
});
|
|
9382
|
+
export const zCreateEmploymentBody = zPeopleEmploymentCreateParameters;
|
|
9383
|
+
/**
|
|
9384
|
+
* Created
|
|
9385
|
+
*/
|
|
9386
|
+
export const zCreateEmploymentResponse = zPeopleEmploymentResponseObject;
|
|
8936
9387
|
export const zGetEmploymentPath = z.object({
|
|
8937
9388
|
id: z.string()
|
|
8938
9389
|
});
|