@dsptch-work/api-client 0.22.0 → 0.23.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.
@@ -609,9 +609,22 @@ export declare const zApprenticeshipAllocationResponseObject: z.ZodObject<{
609
609
  updated_at: z.ZodISODateTime;
610
610
  }, z.core.$strip>;
611
611
  /**
612
- * Correct the effective timestamp of an existing standalone allocation. Time-card-linked allocations cannot be date-corrected. A changed timestamp rebuilds progression and requests historical wage repricing in the background, including locked time cards.
612
+ * Record hours toward an apprentice's wage progression. Creation requires a user-scoped API key, since the row attributes the hours to the person who recorded them. Omit timekeeping_time_card_id for a standalone allocation entered outside the time card system, or supply it to link the allocation to one of the apprentice's own time cards; the effective timestamp then derives from the card's pay period and cannot be overridden. Recording the allocation rebuilds progression and requests wage repricing in the background.
613
+ */
614
+ export declare const zApprenticeshipAllocationCreateParameters: z.ZodObject<{
615
+ apprenticeship_work_process_category_id: z.ZodOptional<z.ZodString>;
616
+ timekeeping_time_card_id: z.ZodOptional<z.ZodString>;
617
+ minutes: z.ZodInt;
618
+ description: z.ZodOptional<z.ZodString>;
619
+ allocated_at: z.ZodOptional<z.ZodISODateTime>;
620
+ }, z.core.$strip>;
621
+ /**
622
+ * Correct an existing allocation's hours, work process category, description, or (for a standalone allocation) effective timestamp. The time card an allocation is linked to cannot be changed after creation. Any change that shifts progression rebuilds it and requests historical wage repricing in the background, including locked time cards.
613
623
  */
614
624
  export declare const zApprenticeshipAllocationUpdateParameters: z.ZodObject<{
625
+ apprenticeship_work_process_category_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
626
+ minutes: z.ZodOptional<z.ZodInt>;
627
+ description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
615
628
  allocated_at: z.ZodOptional<z.ZodISODateTime>;
616
629
  }, z.core.$strip>;
617
630
  /**
@@ -950,6 +963,7 @@ export declare const zPeopleEmploymentScheduledChangeCreateParameters: z.ZodObje
950
963
  training_annual_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
951
964
  employer_combined_health_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
952
965
  employer_combined_savings_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
966
+ companies_department_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
953
967
  effective_date: z.ZodISODate;
954
968
  }, z.core.$strip>;
955
969
  /**
@@ -970,6 +984,7 @@ export declare const zPeopleEmploymentScheduledChangeUpdateParameters: z.ZodObje
970
984
  training_annual_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
971
985
  employer_combined_health_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
972
986
  employer_combined_savings_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
987
+ companies_department_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
973
988
  }, z.core.$strip>;
974
989
  /**
975
990
  * Parameters for moving where an employment stint's valid-time timeline begins.
@@ -983,6 +998,32 @@ export declare const zPeopleEmploymentGenesisParameters: z.ZodObject<{
983
998
  export declare const zPeopleEmploymentScheduledTerminationParameters: z.ZodObject<{
984
999
  effective_date: z.ZodISODate;
985
1000
  }, z.core.$strip>;
1001
+ /**
1002
+ * Request body for correcting an employment stint's operational details from its first recorded boundary forward. Send only the fields to change. A submitted value that already applies at the first boundary is a no-op, even when a later version differs.
1003
+ */
1004
+ export declare const zPeopleEmploymentUpdateParameters: z.ZodObject<{
1005
+ type: z.ZodOptional<z.ZodEnum<{
1006
+ EMPLOYEE: "EMPLOYEE";
1007
+ CONTRACTOR: "CONTRACTOR";
1008
+ }>>;
1009
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1010
+ manager_user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1011
+ payroll_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1012
+ enrolled_in_t_and_a: z.ZodOptional<z.ZodBoolean>;
1013
+ }, z.core.$strip>;
1014
+ export declare const zPeopleEmploymentCustomFieldResponseObject: z.ZodObject<{
1015
+ custom_field_config_id: z.ZodString;
1016
+ value: z.ZodNullable<z.ZodString>;
1017
+ }, z.core.$strip>;
1018
+ /**
1019
+ * Update stored custom-field values for one employment family in a single batch. The batch must contain at least one row. Omitted configurations keep their values, and an explicit null is stored.
1020
+ */
1021
+ export declare const zPeopleEmploymentCustomFieldsUpdateParameters: z.ZodObject<{
1022
+ custom_fields: z.ZodArray<z.ZodObject<{
1023
+ custom_field_config_id: z.ZodString;
1024
+ value: z.ZodNullable<z.ZodString>;
1025
+ }, z.core.$strip>>;
1026
+ }, z.core.$strip>;
986
1027
  export declare const zPeopleEmploymentHistoryCorrectionObject: z.ZodObject<{
987
1028
  people_employment_id: z.ZodString;
988
1029
  user_id: z.ZodString;
@@ -2926,6 +2967,7 @@ export declare const zAggregateTimeImportResponseObject: z.ZodObject<{
2926
2967
  success: "success";
2927
2968
  processing: "processing";
2928
2969
  processed: "processed";
2970
+ superseded: "superseded";
2929
2971
  }>;
2930
2972
  processed_rows_count: z.ZodInt;
2931
2973
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -2960,6 +3002,7 @@ export declare const zDsptchCprImportResponseObject: z.ZodObject<{
2960
3002
  success: "success";
2961
3003
  processing: "processing";
2962
3004
  processed: "processed";
3005
+ superseded: "superseded";
2963
3006
  }>;
2964
3007
  processed_rows_count: z.ZodInt;
2965
3008
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -2994,6 +3037,7 @@ export declare const zPaystubImportResponseObject: z.ZodObject<{
2994
3037
  success: "success";
2995
3038
  processing: "processing";
2996
3039
  processed: "processed";
3040
+ superseded: "superseded";
2997
3041
  }>;
2998
3042
  processed_rows_count: z.ZodInt;
2999
3043
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -3028,6 +3072,7 @@ export declare const zTimeEntryImportResponseObject: z.ZodObject<{
3028
3072
  success: "success";
3029
3073
  processing: "processing";
3030
3074
  processed: "processed";
3075
+ superseded: "superseded";
3031
3076
  }>;
3032
3077
  processed_rows_count: z.ZodInt;
3033
3078
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -8807,6 +8852,33 @@ export declare const zListAllocationsResponse: z.ZodObject<{
8807
8852
  updated_at: z.ZodISODateTime;
8808
8853
  }, z.core.$strip>>;
8809
8854
  }, z.core.$strip>;
8855
+ export declare const zCreateAllocationBody: z.ZodObject<{
8856
+ apprenticeship_work_process_category_id: z.ZodOptional<z.ZodString>;
8857
+ timekeeping_time_card_id: z.ZodOptional<z.ZodString>;
8858
+ minutes: z.ZodInt;
8859
+ description: z.ZodOptional<z.ZodString>;
8860
+ allocated_at: z.ZodOptional<z.ZodISODateTime>;
8861
+ }, z.core.$strip>;
8862
+ export declare const zCreateAllocationPath: z.ZodObject<{
8863
+ apprentice_id: z.ZodString;
8864
+ }, z.core.$strip>;
8865
+ /**
8866
+ * Created
8867
+ */
8868
+ export declare const zCreateAllocationResponse: z.ZodObject<{
8869
+ id: z.ZodString;
8870
+ apprenticeship_apprentice_id: z.ZodString;
8871
+ apprenticeship_work_process_category_id: z.ZodNullable<z.ZodString>;
8872
+ allocated_by_user_id: z.ZodString;
8873
+ timekeeping_time_card_id: z.ZodNullable<z.ZodString>;
8874
+ minutes: z.ZodInt;
8875
+ description: z.ZodNullable<z.ZodString>;
8876
+ allocated_at: z.ZodISODateTime;
8877
+ cumulative_minutes: z.ZodInt;
8878
+ apprenticeship_wage_schedule_period_id: z.ZodString;
8879
+ created_at: z.ZodISODateTime;
8880
+ updated_at: z.ZodISODateTime;
8881
+ }, z.core.$strip>;
8810
8882
  export declare const zGetAllocationPath: z.ZodObject<{
8811
8883
  apprentice_id: z.ZodString;
8812
8884
  id: z.ZodString;
@@ -8829,6 +8901,9 @@ export declare const zGetAllocationResponse: z.ZodObject<{
8829
8901
  updated_at: z.ZodISODateTime;
8830
8902
  }, z.core.$strip>;
8831
8903
  export declare const zUpdateAllocationBody: z.ZodObject<{
8904
+ apprenticeship_work_process_category_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
8905
+ minutes: z.ZodOptional<z.ZodInt>;
8906
+ description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
8832
8907
  allocated_at: z.ZodOptional<z.ZodISODateTime>;
8833
8908
  }, z.core.$strip>;
8834
8909
  export declare const zUpdateAllocationPath: z.ZodObject<{
@@ -18505,6 +18580,7 @@ export declare const zListAggregateTimeImportsResponse: z.ZodObject<{
18505
18580
  success: "success";
18506
18581
  processing: "processing";
18507
18582
  processed: "processed";
18583
+ superseded: "superseded";
18508
18584
  }>;
18509
18585
  processed_rows_count: z.ZodInt;
18510
18586
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -18536,6 +18612,7 @@ export declare const zCreateAggregateTimeImportResponse: z.ZodObject<{
18536
18612
  success: "success";
18537
18613
  processing: "processing";
18538
18614
  processed: "processed";
18615
+ superseded: "superseded";
18539
18616
  }>;
18540
18617
  processed_rows_count: z.ZodInt;
18541
18618
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -18564,6 +18641,7 @@ export declare const zGetAggregateTimeImportResponse: z.ZodObject<{
18564
18641
  success: "success";
18565
18642
  processing: "processing";
18566
18643
  processed: "processed";
18644
+ superseded: "superseded";
18567
18645
  }>;
18568
18646
  processed_rows_count: z.ZodInt;
18569
18647
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -18617,6 +18695,7 @@ export declare const zListDsptchCprImportsResponse: z.ZodObject<{
18617
18695
  success: "success";
18618
18696
  processing: "processing";
18619
18697
  processed: "processed";
18698
+ superseded: "superseded";
18620
18699
  }>;
18621
18700
  processed_rows_count: z.ZodInt;
18622
18701
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -18648,6 +18727,7 @@ export declare const zCreateDsptchCprImportResponse: z.ZodObject<{
18648
18727
  success: "success";
18649
18728
  processing: "processing";
18650
18729
  processed: "processed";
18730
+ superseded: "superseded";
18651
18731
  }>;
18652
18732
  processed_rows_count: z.ZodInt;
18653
18733
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -18676,6 +18756,7 @@ export declare const zGetDsptchCprImportResponse: z.ZodObject<{
18676
18756
  success: "success";
18677
18757
  processing: "processing";
18678
18758
  processed: "processed";
18759
+ superseded: "superseded";
18679
18760
  }>;
18680
18761
  processed_rows_count: z.ZodInt;
18681
18762
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -18729,6 +18810,7 @@ export declare const zListTimeEntryImportsResponse: z.ZodObject<{
18729
18810
  success: "success";
18730
18811
  processing: "processing";
18731
18812
  processed: "processed";
18813
+ superseded: "superseded";
18732
18814
  }>;
18733
18815
  processed_rows_count: z.ZodInt;
18734
18816
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -18760,6 +18842,7 @@ export declare const zCreateTimeEntryImportResponse: z.ZodObject<{
18760
18842
  success: "success";
18761
18843
  processing: "processing";
18762
18844
  processed: "processed";
18845
+ superseded: "superseded";
18763
18846
  }>;
18764
18847
  processed_rows_count: z.ZodInt;
18765
18848
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -18788,6 +18871,7 @@ export declare const zGetTimeEntryImportResponse: z.ZodObject<{
18788
18871
  success: "success";
18789
18872
  processing: "processing";
18790
18873
  processed: "processed";
18874
+ superseded: "superseded";
18791
18875
  }>;
18792
18876
  processed_rows_count: z.ZodInt;
18793
18877
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -19397,6 +19481,7 @@ export declare const zListPaystubImportsResponse: z.ZodObject<{
19397
19481
  success: "success";
19398
19482
  processing: "processing";
19399
19483
  processed: "processed";
19484
+ superseded: "superseded";
19400
19485
  }>;
19401
19486
  processed_rows_count: z.ZodInt;
19402
19487
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -19428,6 +19513,7 @@ export declare const zCreatePaystubImportResponse: z.ZodObject<{
19428
19513
  success: "success";
19429
19514
  processing: "processing";
19430
19515
  processed: "processed";
19516
+ superseded: "superseded";
19431
19517
  }>;
19432
19518
  processed_rows_count: z.ZodInt;
19433
19519
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -19456,6 +19542,7 @@ export declare const zGetPaystubImportResponse: z.ZodObject<{
19456
19542
  success: "success";
19457
19543
  processing: "processing";
19458
19544
  processed: "processed";
19545
+ superseded: "superseded";
19459
19546
  }>;
19460
19547
  processed_rows_count: z.ZodInt;
19461
19548
  processing_errors: z.ZodArray<z.ZodObject<{
@@ -19963,6 +20050,39 @@ export declare const zUpdatePaystubResponse: z.ZodObject<{
19963
20050
  created_at: z.ZodISODateTime;
19964
20051
  updated_at: z.ZodISODateTime;
19965
20052
  }, z.core.$strip>;
20053
+ export declare const zListCustomFieldsPath: z.ZodObject<{
20054
+ employment_id: z.ZodString;
20055
+ }, z.core.$strip>;
20056
+ /**
20057
+ * Success
20058
+ */
20059
+ export declare const zListCustomFieldsResponse: z.ZodObject<{
20060
+ data: z.ZodArray<z.ZodObject<{
20061
+ custom_field_config_id: z.ZodString;
20062
+ value: z.ZodNullable<z.ZodString>;
20063
+ }, z.core.$strip>>;
20064
+ }, z.core.$strip>;
20065
+ export declare const zUpdateCustomFieldBody: z.ZodObject<{
20066
+ custom_fields: z.ZodArray<z.ZodObject<{
20067
+ custom_field_config_id: z.ZodString;
20068
+ value: z.ZodNullable<z.ZodString>;
20069
+ }, z.core.$strip>>;
20070
+ }, z.core.$strip>;
20071
+ export declare const zUpdateCustomFieldHeaders: z.ZodObject<{
20072
+ 'If-Match': z.ZodString;
20073
+ }, z.core.$strip>;
20074
+ export declare const zUpdateCustomFieldPath: z.ZodObject<{
20075
+ employment_id: z.ZodString;
20076
+ }, z.core.$strip>;
20077
+ /**
20078
+ * Success
20079
+ */
20080
+ export declare const zUpdateCustomFieldResponse: z.ZodObject<{
20081
+ data: z.ZodArray<z.ZodObject<{
20082
+ custom_field_config_id: z.ZodString;
20083
+ value: z.ZodNullable<z.ZodString>;
20084
+ }, z.core.$strip>>;
20085
+ }, z.core.$strip>;
19966
20086
  export declare const zUpdateGenesisBody: z.ZodObject<{
19967
20087
  effective_date: z.ZodOptional<z.ZodISODate>;
19968
20088
  }, z.core.$strip>;
@@ -20227,6 +20347,7 @@ export declare const zCreateEmploymentScheduledChangeBody: z.ZodObject<{
20227
20347
  training_annual_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20228
20348
  employer_combined_health_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20229
20349
  employer_combined_savings_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20350
+ companies_department_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20230
20351
  effective_date: z.ZodISODate;
20231
20352
  }, z.core.$strip>;
20232
20353
  export declare const zCreateEmploymentScheduledChangeHeaders: z.ZodObject<{
@@ -20299,6 +20420,7 @@ export declare const zUpdateEmploymentScheduledChangeBody: z.ZodObject<{
20299
20420
  training_annual_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20300
20421
  employer_combined_health_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20301
20422
  employer_combined_savings_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20423
+ companies_department_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20302
20424
  }, z.core.$strip>;
20303
20425
  export declare const zUpdateEmploymentScheduledChangeHeaders: z.ZodObject<{
20304
20426
  'If-Match': z.ZodString;
@@ -20564,6 +20686,50 @@ export declare const zCreateEmploymentResponse: z.ZodObject<{
20564
20686
  created_at: z.ZodISODateTime;
20565
20687
  updated_at: z.ZodISODateTime;
20566
20688
  }, z.core.$strip>;
20689
+ export declare const zDeleteEmploymentHeaders: z.ZodObject<{
20690
+ 'If-Match': z.ZodString;
20691
+ }, z.core.$strip>;
20692
+ export declare const zDeleteEmploymentPath: z.ZodObject<{
20693
+ id: z.ZodString;
20694
+ }, z.core.$strip>;
20695
+ /**
20696
+ * Success
20697
+ */
20698
+ export declare const zDeleteEmploymentResponse: z.ZodObject<{
20699
+ id: z.ZodString;
20700
+ user_id: z.ZodString;
20701
+ company_id: z.ZodString;
20702
+ type: z.ZodEnum<{
20703
+ EMPLOYEE: "EMPLOYEE";
20704
+ CONTRACTOR: "CONTRACTOR";
20705
+ }>;
20706
+ title: z.ZodNullable<z.ZodString>;
20707
+ compensation_type: z.ZodEnum<{
20708
+ hourly: "hourly";
20709
+ salary: "salary";
20710
+ }>;
20711
+ payroll_id: z.ZodNullable<z.ZodString>;
20712
+ manager_user_id: z.ZodNullable<z.ZodString>;
20713
+ companies_department_id: z.ZodNullable<z.ZodString>;
20714
+ enrolled_in_t_and_a: z.ZodBoolean;
20715
+ overtime_eligible: z.ZodNullable<z.ZodBoolean>;
20716
+ overtime_package_id: z.ZodNullable<z.ZodString>;
20717
+ pay_rates_rule_package_id: z.ZodNullable<z.ZodString>;
20718
+ pay_rates_package_id: z.ZodNullable<z.ZodString>;
20719
+ worked_annual_minutes: z.ZodNullable<z.ZodInt>;
20720
+ pto_annual_minutes: z.ZodNullable<z.ZodInt>;
20721
+ holiday_annual_minutes: z.ZodNullable<z.ZodInt>;
20722
+ training_annual_minutes: z.ZodNullable<z.ZodInt>;
20723
+ hourly_rate_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20724
+ training_annual_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20725
+ employer_combined_health_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20726
+ employer_combined_savings_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20727
+ currency: z.ZodString;
20728
+ valid_from: z.ZodNullable<z.ZodISODateTime>;
20729
+ valid_to: z.ZodNullable<z.ZodISODateTime>;
20730
+ created_at: z.ZodISODateTime;
20731
+ updated_at: z.ZodISODateTime;
20732
+ }, z.core.$strip>;
20567
20733
  export declare const zGetEmploymentPath: z.ZodObject<{
20568
20734
  id: z.ZodString;
20569
20735
  }, z.core.$strip>;
@@ -20608,6 +20774,60 @@ export declare const zGetEmploymentResponse: z.ZodObject<{
20608
20774
  created_at: z.ZodISODateTime;
20609
20775
  updated_at: z.ZodISODateTime;
20610
20776
  }, z.core.$strip>;
20777
+ export declare const zUpdateEmploymentBody: z.ZodObject<{
20778
+ type: z.ZodOptional<z.ZodEnum<{
20779
+ EMPLOYEE: "EMPLOYEE";
20780
+ CONTRACTOR: "CONTRACTOR";
20781
+ }>>;
20782
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20783
+ manager_user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20784
+ payroll_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20785
+ enrolled_in_t_and_a: z.ZodOptional<z.ZodBoolean>;
20786
+ }, z.core.$strip>;
20787
+ export declare const zUpdateEmploymentHeaders: z.ZodObject<{
20788
+ 'If-Match': z.ZodString;
20789
+ }, z.core.$strip>;
20790
+ export declare const zUpdateEmploymentPath: z.ZodObject<{
20791
+ id: z.ZodString;
20792
+ }, z.core.$strip>;
20793
+ /**
20794
+ * Success
20795
+ */
20796
+ export declare const zUpdateEmploymentResponse: z.ZodObject<{
20797
+ id: z.ZodString;
20798
+ user_id: z.ZodString;
20799
+ company_id: z.ZodString;
20800
+ type: z.ZodEnum<{
20801
+ EMPLOYEE: "EMPLOYEE";
20802
+ CONTRACTOR: "CONTRACTOR";
20803
+ }>;
20804
+ title: z.ZodNullable<z.ZodString>;
20805
+ compensation_type: z.ZodEnum<{
20806
+ hourly: "hourly";
20807
+ salary: "salary";
20808
+ }>;
20809
+ payroll_id: z.ZodNullable<z.ZodString>;
20810
+ manager_user_id: z.ZodNullable<z.ZodString>;
20811
+ companies_department_id: z.ZodNullable<z.ZodString>;
20812
+ enrolled_in_t_and_a: z.ZodBoolean;
20813
+ overtime_eligible: z.ZodNullable<z.ZodBoolean>;
20814
+ overtime_package_id: z.ZodNullable<z.ZodString>;
20815
+ pay_rates_rule_package_id: z.ZodNullable<z.ZodString>;
20816
+ pay_rates_package_id: z.ZodNullable<z.ZodString>;
20817
+ worked_annual_minutes: z.ZodNullable<z.ZodInt>;
20818
+ pto_annual_minutes: z.ZodNullable<z.ZodInt>;
20819
+ holiday_annual_minutes: z.ZodNullable<z.ZodInt>;
20820
+ training_annual_minutes: z.ZodNullable<z.ZodInt>;
20821
+ hourly_rate_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20822
+ training_annual_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20823
+ employer_combined_health_amount_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20824
+ employer_combined_savings_cents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20825
+ currency: z.ZodString;
20826
+ valid_from: z.ZodNullable<z.ZodISODateTime>;
20827
+ valid_to: z.ZodNullable<z.ZodISODateTime>;
20828
+ created_at: z.ZodISODateTime;
20829
+ updated_at: z.ZodISODateTime;
20830
+ }, z.core.$strip>;
20611
20831
  export declare const zListPerDiemsQuery: z.ZodObject<{
20612
20832
  'filter[default]': z.ZodOptional<z.ZodBoolean>;
20613
20833
  'filter[taxable]': z.ZodOptional<z.ZodBoolean>;
@@ -607,9 +607,22 @@ export const zApprenticeshipAllocationResponseObject = z.object({
607
607
  updated_at: z.iso.datetime()
608
608
  });
609
609
  /**
610
- * Correct the effective timestamp of an existing standalone allocation. Time-card-linked allocations cannot be date-corrected. A changed timestamp rebuilds progression and requests historical wage repricing in the background, including locked time cards.
610
+ * Record hours toward an apprentice's wage progression. Creation requires a user-scoped API key, since the row attributes the hours to the person who recorded them. Omit timekeeping_time_card_id for a standalone allocation entered outside the time card system, or supply it to link the allocation to one of the apprentice's own time cards; the effective timestamp then derives from the card's pay period and cannot be overridden. Recording the allocation rebuilds progression and requests wage repricing in the background.
611
+ */
612
+ export const zApprenticeshipAllocationCreateParameters = z.object({
613
+ apprenticeship_work_process_category_id: z.string().optional(),
614
+ timekeeping_time_card_id: z.string().optional(),
615
+ minutes: z.int(),
616
+ description: z.string().optional(),
617
+ allocated_at: z.iso.datetime().optional()
618
+ });
619
+ /**
620
+ * Correct an existing allocation's hours, work process category, description, or (for a standalone allocation) effective timestamp. The time card an allocation is linked to cannot be changed after creation. Any change that shifts progression rebuilds it and requests historical wage repricing in the background, including locked time cards.
611
621
  */
612
622
  export const zApprenticeshipAllocationUpdateParameters = z.object({
623
+ apprenticeship_work_process_category_id: z.string().nullish(),
624
+ minutes: z.int().optional(),
625
+ description: z.string().nullish(),
613
626
  allocated_at: z.iso.datetime().optional()
614
627
  });
615
628
  /**
@@ -935,6 +948,7 @@ export const zPeopleEmploymentScheduledChangeCreateParameters = z.object({
935
948
  training_annual_amount_cents: z.string().nullish(),
936
949
  employer_combined_health_amount_cents: z.string().nullish(),
937
950
  employer_combined_savings_cents: z.string().nullish(),
951
+ companies_department_id: z.string().nullish(),
938
952
  effective_date: z.iso.date()
939
953
  });
940
954
  /**
@@ -951,7 +965,8 @@ export const zPeopleEmploymentScheduledChangeUpdateParameters = z.object({
951
965
  training_annual_minutes: z.int().nullish(),
952
966
  training_annual_amount_cents: z.string().nullish(),
953
967
  employer_combined_health_amount_cents: z.string().nullish(),
954
- employer_combined_savings_cents: z.string().nullish()
968
+ employer_combined_savings_cents: z.string().nullish(),
969
+ companies_department_id: z.string().nullish()
955
970
  });
956
971
  /**
957
972
  * Parameters for moving where an employment stint's valid-time timeline begins.
@@ -965,6 +980,29 @@ export const zPeopleEmploymentGenesisParameters = z.object({
965
980
  export const zPeopleEmploymentScheduledTerminationParameters = z.object({
966
981
  effective_date: z.iso.date()
967
982
  });
983
+ /**
984
+ * Request body for correcting an employment stint's operational details from its first recorded boundary forward. Send only the fields to change. A submitted value that already applies at the first boundary is a no-op, even when a later version differs.
985
+ */
986
+ export const zPeopleEmploymentUpdateParameters = z.object({
987
+ type: z.enum(['EMPLOYEE', 'CONTRACTOR']).optional(),
988
+ title: z.string().nullish(),
989
+ manager_user_id: z.string().nullish(),
990
+ payroll_id: z.string().nullish(),
991
+ enrolled_in_t_and_a: z.boolean().optional()
992
+ });
993
+ export const zPeopleEmploymentCustomFieldResponseObject = z.object({
994
+ custom_field_config_id: z.string(),
995
+ value: z.string().nullable()
996
+ });
997
+ /**
998
+ * Update stored custom-field values for one employment family in a single batch. The batch must contain at least one row. Omitted configurations keep their values, and an explicit null is stored.
999
+ */
1000
+ export const zPeopleEmploymentCustomFieldsUpdateParameters = z.object({
1001
+ custom_fields: z.array(z.object({
1002
+ custom_field_config_id: z.string(),
1003
+ value: z.string().nullable()
1004
+ })).min(1)
1005
+ });
968
1006
  export const zPeopleEmploymentHistoryCorrectionObject = z.object({
969
1007
  people_employment_id: z.string(),
970
1008
  user_id: z.string(),
@@ -2545,7 +2583,8 @@ export const zAggregateTimeImportResponseObject = z.object({
2545
2583
  'processing',
2546
2584
  'processed',
2547
2585
  'success',
2548
- 'failed'
2586
+ 'failed',
2587
+ 'superseded'
2549
2588
  ]),
2550
2589
  processed_rows_count: z.int(),
2551
2590
  processing_errors: z.array(zImportProcessingError),
@@ -2574,7 +2613,8 @@ export const zDsptchCprImportResponseObject = z.object({
2574
2613
  'processing',
2575
2614
  'processed',
2576
2615
  'success',
2577
- 'failed'
2616
+ 'failed',
2617
+ 'superseded'
2578
2618
  ]),
2579
2619
  processed_rows_count: z.int(),
2580
2620
  processing_errors: z.array(zImportProcessingError),
@@ -2603,7 +2643,8 @@ export const zPaystubImportResponseObject = z.object({
2603
2643
  'processing',
2604
2644
  'processed',
2605
2645
  'success',
2606
- 'failed'
2646
+ 'failed',
2647
+ 'superseded'
2607
2648
  ]),
2608
2649
  processed_rows_count: z.int(),
2609
2650
  processing_errors: z.array(zImportProcessingError),
@@ -2632,7 +2673,8 @@ export const zTimeEntryImportResponseObject = z.object({
2632
2673
  'processing',
2633
2674
  'processed',
2634
2675
  'success',
2635
- 'failed'
2676
+ 'failed',
2677
+ 'superseded'
2636
2678
  ]),
2637
2679
  processed_rows_count: z.int(),
2638
2680
  processing_errors: z.array(zImportProcessingError),
@@ -6592,6 +6634,14 @@ export const zListAllocationsResponse = z.object({
6592
6634
  links: zLinks,
6593
6635
  data: z.array(zApprenticeshipAllocationResponseObject)
6594
6636
  });
6637
+ export const zCreateAllocationBody = zApprenticeshipAllocationCreateParameters;
6638
+ export const zCreateAllocationPath = z.object({
6639
+ apprentice_id: z.string()
6640
+ });
6641
+ /**
6642
+ * Created
6643
+ */
6644
+ export const zCreateAllocationResponse = zApprenticeshipAllocationResponseObject;
6595
6645
  export const zGetAllocationPath = z.object({
6596
6646
  apprentice_id: z.string(),
6597
6647
  id: z.string()
@@ -9256,6 +9306,28 @@ export const zUpdatePaystubPath = z.object({
9256
9306
  * Success
9257
9307
  */
9258
9308
  export const zUpdatePaystubResponse = zPaystubResponseObject;
9309
+ export const zListCustomFieldsPath = z.object({
9310
+ employment_id: z.string()
9311
+ });
9312
+ /**
9313
+ * Success
9314
+ */
9315
+ export const zListCustomFieldsResponse = z.object({
9316
+ data: z.array(zPeopleEmploymentCustomFieldResponseObject)
9317
+ });
9318
+ export const zUpdateCustomFieldBody = zPeopleEmploymentCustomFieldsUpdateParameters;
9319
+ export const zUpdateCustomFieldHeaders = z.object({
9320
+ 'If-Match': z.string()
9321
+ });
9322
+ export const zUpdateCustomFieldPath = z.object({
9323
+ employment_id: z.string()
9324
+ });
9325
+ /**
9326
+ * Success
9327
+ */
9328
+ export const zUpdateCustomFieldResponse = z.object({
9329
+ data: z.array(zPeopleEmploymentCustomFieldResponseObject)
9330
+ });
9259
9331
  export const zUpdateGenesisBody = zPeopleEmploymentGenesisParameters;
9260
9332
  export const zUpdateGenesisHeaders = z.object({
9261
9333
  'If-Match': z.string()
@@ -9384,6 +9456,16 @@ export const zCreateEmploymentBody = zPeopleEmploymentCreateParameters;
9384
9456
  * Created
9385
9457
  */
9386
9458
  export const zCreateEmploymentResponse = zPeopleEmploymentResponseObject;
9459
+ export const zDeleteEmploymentHeaders = z.object({
9460
+ 'If-Match': z.string()
9461
+ });
9462
+ export const zDeleteEmploymentPath = z.object({
9463
+ id: z.string()
9464
+ });
9465
+ /**
9466
+ * Success
9467
+ */
9468
+ export const zDeleteEmploymentResponse = zPeopleEmploymentResponseObject;
9387
9469
  export const zGetEmploymentPath = z.object({
9388
9470
  id: z.string()
9389
9471
  });
@@ -9394,6 +9476,17 @@ export const zGetEmploymentQuery = z.object({
9394
9476
  * Success
9395
9477
  */
9396
9478
  export const zGetEmploymentResponse = zPeopleEmploymentResponseObject;
9479
+ export const zUpdateEmploymentBody = zPeopleEmploymentUpdateParameters;
9480
+ export const zUpdateEmploymentHeaders = z.object({
9481
+ 'If-Match': z.string()
9482
+ });
9483
+ export const zUpdateEmploymentPath = z.object({
9484
+ id: z.string()
9485
+ });
9486
+ /**
9487
+ * Success
9488
+ */
9489
+ export const zUpdateEmploymentResponse = zPeopleEmploymentResponseObject;
9397
9490
  export const zListPerDiemsQuery = z.object({
9398
9491
  'filter[default]': z.boolean().optional(),
9399
9492
  'filter[taxable]': z.boolean().optional(),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dsptch-work/api-client",
3
- "version": "0.22.0",
3
+ "version": "0.23.0",
4
4
  "description": "Generated TypeScript client for the DSPTCH REST API.",
5
5
  "keywords": [
6
6
  "dsptch",