@dsptch-work/api-client 0.22.0 → 0.24.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 +37 -0
- package/dist/gen/index.d.ts +1 -1
- package/dist/gen/sdk.gen.d.ts +126 -9
- package/dist/gen/sdk.gen.js +179 -8
- package/dist/gen/types.gen.d.ts +483 -29
- package/dist/gen/zod.gen.d.ts +301 -12
- package/dist/gen/zod.gen.js +143 -18
- package/package.json +1 -1
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -653,6 +653,10 @@ export type ApprenticeshipWageScheduleResponseObject = {
|
|
|
653
653
|
* ISO 4217 currency code for journeyworker_wage_cents.
|
|
654
654
|
*/
|
|
655
655
|
journeyworker_wage_currency: string;
|
|
656
|
+
/**
|
|
657
|
+
* The journeyworker fringe that percentage-listed periods are authored against, in cents as a decimal string (e.g. "2000.0" is $20.00); denominated in journeyworker_wage_currency. An authoring reference only — pricing uses the fringe on each job's wage determination. Null when unset.
|
|
658
|
+
*/
|
|
659
|
+
journeyworker_fringe_cents: string | null;
|
|
656
660
|
/**
|
|
657
661
|
* When the record was created (ISO 8601).
|
|
658
662
|
*/
|
|
@@ -663,7 +667,7 @@ export type ApprenticeshipWageScheduleResponseObject = {
|
|
|
663
667
|
updated_at: string;
|
|
664
668
|
};
|
|
665
669
|
/**
|
|
666
|
-
* One step in a wage schedule's progression — the apprentice's pay, as a percentage of the journeyworker wage, for a band of accumulated hours or a number of competencies.
|
|
670
|
+
* One step in a wage schedule's progression — the apprentice's pay, as a percentage of the journeyworker wage, for a band of accumulated hours or a number of competencies. A period may also list its apprentices' fringe, as a percentage of the charged wage determination's fringe or as a fixed hourly amount, and an in-ratio apprentice is obligated at that fringe. The listing is ignored — fringe is priced as if nothing were listed — when the apprentice is out of ratio, on a regional Illinois wage determination, or on an apprentice-basis wage determination, which carries its own apprentice fringe.
|
|
667
671
|
*/
|
|
668
672
|
export type ApprenticeshipWageSchedulePeriodResponseObject = {
|
|
669
673
|
/**
|
|
@@ -706,6 +710,14 @@ export type ApprenticeshipWageSchedulePeriodResponseObject = {
|
|
|
706
710
|
* ISO 4217 currency code for wage_cents.
|
|
707
711
|
*/
|
|
708
712
|
wage_currency: string;
|
|
713
|
+
/**
|
|
714
|
+
* Apprentice fringe as a percentage of the charged wage determination's fringe, as a decimal string (e.g. "70.0" is 70%); null when the period does not list fringe as a percentage. At most one of fringe_percent and fringe_cents is set, and when neither is, the period lists no fringe.
|
|
715
|
+
*/
|
|
716
|
+
fringe_percent: string | null;
|
|
717
|
+
/**
|
|
718
|
+
* Fixed hourly apprentice fringe, in cents as a decimal string (e.g. "450.0" is $4.50); denominated in wage_currency. Null when the period does not list a fixed fringe.
|
|
719
|
+
*/
|
|
720
|
+
fringe_cents: string | null;
|
|
709
721
|
/**
|
|
710
722
|
* When the record was created (ISO 8601).
|
|
711
723
|
*/
|
|
@@ -795,11 +807,48 @@ export type ApprenticeshipAllocationResponseObject = {
|
|
|
795
807
|
updated_at: string;
|
|
796
808
|
};
|
|
797
809
|
/**
|
|
798
|
-
*
|
|
810
|
+
* 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.
|
|
811
|
+
*/
|
|
812
|
+
export type ApprenticeshipAllocationCreateParameters = {
|
|
813
|
+
/**
|
|
814
|
+
* Work process category to categorize the allocation under; optional, omit for an uncategorized allocation.
|
|
815
|
+
*/
|
|
816
|
+
apprenticeship_work_process_category_id?: string;
|
|
817
|
+
/**
|
|
818
|
+
* Time card to link the allocation to, scoped to the apprentice's own cards; optional, omit for a standalone allocation. Cannot be changed after creation.
|
|
819
|
+
*/
|
|
820
|
+
timekeeping_time_card_id?: string;
|
|
821
|
+
/**
|
|
822
|
+
* Minutes of credited hours. Required, must be positive, and (when linked to a time card) cannot push the card's categorized total past its overtime-eligible minutes.
|
|
823
|
+
*/
|
|
824
|
+
minutes: number;
|
|
825
|
+
/**
|
|
826
|
+
* Free-text note on the allocation; optional.
|
|
827
|
+
*/
|
|
828
|
+
description?: string;
|
|
829
|
+
/**
|
|
830
|
+
* Effective timestamp for the credited hours, as ISO 8601 with an explicit UTC offset or Z. Optional for a standalone allocation, defaulting to now; must equal the linked time card's pay-period start when one is supplied. The employer-local date must be today or earlier.
|
|
831
|
+
*/
|
|
832
|
+
allocated_at?: string;
|
|
833
|
+
};
|
|
834
|
+
/**
|
|
835
|
+
* 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.
|
|
799
836
|
*/
|
|
800
837
|
export type ApprenticeshipAllocationUpdateParameters = {
|
|
801
838
|
/**
|
|
802
|
-
*
|
|
839
|
+
* Work process category to recategorize the allocation under; optional, null to make it uncategorized.
|
|
840
|
+
*/
|
|
841
|
+
apprenticeship_work_process_category_id?: string | null;
|
|
842
|
+
/**
|
|
843
|
+
* Minutes of credited hours; optional, must be positive, and (for a time-card-linked allocation) cannot push the card's categorized total past its overtime-eligible minutes.
|
|
844
|
+
*/
|
|
845
|
+
minutes?: number;
|
|
846
|
+
/**
|
|
847
|
+
* Free-text note on the allocation; optional, null to clear.
|
|
848
|
+
*/
|
|
849
|
+
description?: string | null;
|
|
850
|
+
/**
|
|
851
|
+
* Effective timestamp for the credited hours, as ISO 8601 with an explicit UTC offset or Z. Optional; omission leaves the timestamp unchanged, and null is rejected. The employer-local date must be today or earlier and may predate enrollment. Time-card-linked allocations cannot be date-corrected. An unchanged timestamp does not request repricing.
|
|
803
852
|
*/
|
|
804
853
|
allocated_at?: string;
|
|
805
854
|
};
|
|
@@ -999,7 +1048,7 @@ export type ApprenticeshipProgramEmployerUpdateParameters = {
|
|
|
999
1048
|
require_timecard_allocation?: boolean;
|
|
1000
1049
|
};
|
|
1001
1050
|
/**
|
|
1002
|
-
* Create a period on a wage schedule; the wage schedule is taken from the URL path. wage_cents
|
|
1051
|
+
* Create a period on a wage schedule; the wage schedule is taken from the URL path. wage_cents and fringe_cents are sent as integer cents.
|
|
1003
1052
|
*/
|
|
1004
1053
|
export type ApprenticeshipWageSchedulePeriodParameters = {
|
|
1005
1054
|
/**
|
|
@@ -1030,9 +1079,17 @@ export type ApprenticeshipWageSchedulePeriodParameters = {
|
|
|
1030
1079
|
* Wage rate for this period, in cents; denominated in the parent schedule's wage_unit. Required.
|
|
1031
1080
|
*/
|
|
1032
1081
|
wage_cents: number;
|
|
1082
|
+
/**
|
|
1083
|
+
* Apprentice fringe for this period, as a percentage of the fringe on the wage determination the apprentice charges (e.g. 70 for 70%); optional, omit or send null when the period does not list fringe as a percentage. A period lists fringe one way at most, so sending both fringe_percent and fringe_cents non-null is rejected with a 422.
|
|
1084
|
+
*/
|
|
1085
|
+
fringe_percent?: number | null;
|
|
1086
|
+
/**
|
|
1087
|
+
* Fixed hourly apprentice fringe for this period, in cents, in the period's wage currency; optional, omit or send null when the period does not list a fixed fringe. A period lists fringe one way at most, so sending both fringe_percent and fringe_cents non-null is rejected with a 422.
|
|
1088
|
+
*/
|
|
1089
|
+
fringe_cents?: number | null;
|
|
1033
1090
|
};
|
|
1034
1091
|
/**
|
|
1035
|
-
* Update a period on a wage schedule. Send only the fields to change; the wage schedule is taken from the URL path and wage_cents
|
|
1092
|
+
* Update a period on a wage schedule. Send only the fields to change; the wage schedule is taken from the URL path, and wage_cents and fringe_cents are sent as integer cents.
|
|
1036
1093
|
*/
|
|
1037
1094
|
export type ApprenticeshipWageSchedulePeriodUpdateParameters = {
|
|
1038
1095
|
/**
|
|
@@ -1063,6 +1120,14 @@ export type ApprenticeshipWageSchedulePeriodUpdateParameters = {
|
|
|
1063
1120
|
* Wage rate for this period, in cents; omit to leave it unchanged.
|
|
1064
1121
|
*/
|
|
1065
1122
|
wage_cents?: number;
|
|
1123
|
+
/**
|
|
1124
|
+
* Apprentice fringe for this period, as a percentage of the fringe on the wage determination the apprentice charges (e.g. 70 for 70%); omit to leave it unchanged, or send null to clear. A period lists fringe one way at most, so switching to a fixed amount sends fringe_cents with fringe_percent null; a request that leaves both set is rejected with a 422.
|
|
1125
|
+
*/
|
|
1126
|
+
fringe_percent?: number | null;
|
|
1127
|
+
/**
|
|
1128
|
+
* Fixed hourly apprentice fringe for this period, in cents; omit to leave it unchanged, or send null to clear. A period lists fringe one way at most, so switching to a percentage sends fringe_percent with fringe_cents null; a request that leaves both set is rejected with a 422.
|
|
1129
|
+
*/
|
|
1130
|
+
fringe_cents?: number | null;
|
|
1066
1131
|
};
|
|
1067
1132
|
/**
|
|
1068
1133
|
* Create a wage schedule for an occupation; the occupation is taken from the URL path. Money is sent as integer cents; periods may be created inline via periods_attributes.
|
|
@@ -1092,6 +1157,10 @@ export type ApprenticeshipWageScheduleParameters = {
|
|
|
1092
1157
|
* The journeyworker wage to progress toward, in cents; denominated in journeyworker_wage_unit; optional, defaults to 0.
|
|
1093
1158
|
*/
|
|
1094
1159
|
journeyworker_wage_cents?: number;
|
|
1160
|
+
/**
|
|
1161
|
+
* The journeyworker fringe that percentage-listed periods are authored against, in cents; an authoring reference only, never priced; optional, omit or send null to leave it unset.
|
|
1162
|
+
*/
|
|
1163
|
+
journeyworker_fringe_cents?: number | null;
|
|
1095
1164
|
/**
|
|
1096
1165
|
* Wage at the end of the progression (100% of the journeyworker wage), in cents; denominated in wage_unit; optional, defaults to 0.
|
|
1097
1166
|
*/
|
|
@@ -1132,6 +1201,14 @@ export type ApprenticeshipWageScheduleParameters = {
|
|
|
1132
1201
|
* Wage rate for this period, in cents; denominated in the parent schedule's wage_unit. Required.
|
|
1133
1202
|
*/
|
|
1134
1203
|
wage_cents: number;
|
|
1204
|
+
/**
|
|
1205
|
+
* Apprentice fringe for this period, as a percentage of the fringe on the wage determination the apprentice charges (e.g. 70 for 70%); optional, omit or send null when the period does not list fringe as a percentage. A period lists fringe one way at most, so sending both fringe_percent and fringe_cents non-null is rejected with a 422.
|
|
1206
|
+
*/
|
|
1207
|
+
fringe_percent?: number | null;
|
|
1208
|
+
/**
|
|
1209
|
+
* Fixed hourly apprentice fringe for this period, in cents, in the period's wage currency; optional, omit or send null when the period does not list a fixed fringe. A period lists fringe one way at most, so sending both fringe_percent and fringe_cents non-null is rejected with a 422.
|
|
1210
|
+
*/
|
|
1211
|
+
fringe_cents?: number | null;
|
|
1135
1212
|
/**
|
|
1136
1213
|
* Set to true, together with the period's id, to remove that period from the schedule.
|
|
1137
1214
|
*/
|
|
@@ -1166,6 +1243,10 @@ export type ApprenticeshipWageScheduleUpdateParameters = {
|
|
|
1166
1243
|
* Journeyworker wage to progress toward, in cents; omit to leave it unchanged.
|
|
1167
1244
|
*/
|
|
1168
1245
|
journeyworker_wage_cents?: number;
|
|
1246
|
+
/**
|
|
1247
|
+
* The journeyworker fringe that percentage-listed periods are authored against, in cents; an authoring reference only, never priced; omit to leave it unchanged, or send null to clear.
|
|
1248
|
+
*/
|
|
1249
|
+
journeyworker_fringe_cents?: number | null;
|
|
1169
1250
|
/**
|
|
1170
1251
|
* Wage at the end of the progression, in cents; omit to leave it unchanged.
|
|
1171
1252
|
*/
|
|
@@ -1214,6 +1295,14 @@ export type ApprenticeshipWageScheduleUpdateParameters = {
|
|
|
1214
1295
|
* Wage rate for this period, in cents; omit to leave it unchanged.
|
|
1215
1296
|
*/
|
|
1216
1297
|
wage_cents?: number;
|
|
1298
|
+
/**
|
|
1299
|
+
* Apprentice fringe for this period, as a percentage of the fringe on the wage determination the apprentice charges (e.g. 70 for 70%); omit to leave it unchanged, or send null to clear. A period lists fringe one way at most, so switching to a fixed amount sends fringe_cents with fringe_percent null; a request that leaves both set is rejected with a 422.
|
|
1300
|
+
*/
|
|
1301
|
+
fringe_percent?: number | null;
|
|
1302
|
+
/**
|
|
1303
|
+
* Fixed hourly apprentice fringe for this period, in cents; omit to leave it unchanged, or send null to clear. A period lists fringe one way at most, so switching to a percentage sends fringe_percent with fringe_cents null; a request that leaves both set is rejected with a 422.
|
|
1304
|
+
*/
|
|
1305
|
+
fringe_cents?: number | null;
|
|
1217
1306
|
/**
|
|
1218
1307
|
* Set to true, together with the period's id, to remove that period from the schedule.
|
|
1219
1308
|
*/
|
|
@@ -1508,7 +1597,7 @@ export type PeopleEmploymentCreateParameters = {
|
|
|
1508
1597
|
employer_combined_savings_cents?: string | null;
|
|
1509
1598
|
};
|
|
1510
1599
|
/**
|
|
1511
|
-
* Request body for creating one
|
|
1600
|
+
* Request body for creating one employment boundary. effective_date is required and is interpreted at midnight in the credential company's time zone. Today and past dates must fall inside the family's latest version, before its termination; future dates retain scheduling behavior. Send at least one value to change; omitted values carry forward from the version immediately before the new boundary.
|
|
1512
1601
|
*/
|
|
1513
1602
|
export type PeopleEmploymentScheduledChangeCreateParameters = {
|
|
1514
1603
|
/**
|
|
@@ -1556,12 +1645,16 @@ export type PeopleEmploymentScheduledChangeCreateParameters = {
|
|
|
1556
1645
|
*/
|
|
1557
1646
|
employer_combined_savings_cents?: string | null;
|
|
1558
1647
|
/**
|
|
1559
|
-
*
|
|
1648
|
+
* Department ID in the credential company. Omit to carry forward the preceding version, or send null to clear it. A submitted value applies to this and all later versions.
|
|
1649
|
+
*/
|
|
1650
|
+
companies_department_id?: string | null;
|
|
1651
|
+
/**
|
|
1652
|
+
* Company-local date when the new boundary takes effect. Today and past dates must fall inside the latest version, before termination. Required.
|
|
1560
1653
|
*/
|
|
1561
1654
|
effective_date: string;
|
|
1562
1655
|
};
|
|
1563
1656
|
/**
|
|
1564
|
-
* Request body for changing values at one exact
|
|
1657
|
+
* Request body for changing values at one exact employment boundary. Today and past dates must name the latest version's start; future exact boundaries remain editable. Send only the fields to change; omitted values remain as recorded at that boundary. The boundary date cannot move.
|
|
1565
1658
|
*/
|
|
1566
1659
|
export type PeopleEmploymentScheduledChangeUpdateParameters = {
|
|
1567
1660
|
/**
|
|
@@ -1608,6 +1701,10 @@ export type PeopleEmploymentScheduledChangeUpdateParameters = {
|
|
|
1608
1701
|
* Annual employer savings contribution in cents as a decimal string. Omit to preserve the value at the targeted boundary, or send null to clear it.
|
|
1609
1702
|
*/
|
|
1610
1703
|
employer_combined_savings_cents?: string | null;
|
|
1704
|
+
/**
|
|
1705
|
+
* Department ID in the credential company. Omit to preserve the value at the targeted boundary, or send null to clear it. A submitted value applies to this and all later versions.
|
|
1706
|
+
*/
|
|
1707
|
+
companies_department_id?: string | null;
|
|
1611
1708
|
};
|
|
1612
1709
|
/**
|
|
1613
1710
|
* Parameters for moving where an employment stint's valid-time timeline begins.
|
|
@@ -1627,6 +1724,53 @@ export type PeopleEmploymentScheduledTerminationParameters = {
|
|
|
1627
1724
|
*/
|
|
1628
1725
|
effective_date: string;
|
|
1629
1726
|
};
|
|
1727
|
+
/**
|
|
1728
|
+
* 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.
|
|
1729
|
+
*/
|
|
1730
|
+
export type PeopleEmploymentUpdateParameters = {
|
|
1731
|
+
/**
|
|
1732
|
+
* Whether the relationship is EMPLOYEE or CONTRACTOR. Omit to preserve the value recorded at the first boundary.
|
|
1733
|
+
*/
|
|
1734
|
+
type?: 'EMPLOYEE' | 'CONTRACTOR';
|
|
1735
|
+
/**
|
|
1736
|
+
* Employment title. Send null to clear it; omit to preserve the value recorded at the first boundary.
|
|
1737
|
+
*/
|
|
1738
|
+
title?: string | null;
|
|
1739
|
+
/**
|
|
1740
|
+
* Manager ID. Send null to clear it; omit to preserve the value recorded at the first boundary.
|
|
1741
|
+
*/
|
|
1742
|
+
manager_user_id?: string | null;
|
|
1743
|
+
/**
|
|
1744
|
+
* Payroll-system identifier. Send null to clear it; omit to preserve the value recorded at the first boundary.
|
|
1745
|
+
*/
|
|
1746
|
+
payroll_id?: string | null;
|
|
1747
|
+
/**
|
|
1748
|
+
* Whether this employment is enrolled in time and attendance. Omit to preserve the value recorded at the first boundary.
|
|
1749
|
+
*/
|
|
1750
|
+
enrolled_in_t_and_a?: boolean;
|
|
1751
|
+
};
|
|
1752
|
+
export type PeopleEmploymentCustomFieldResponseObject = {
|
|
1753
|
+
custom_field_config_id: string;
|
|
1754
|
+
value: string | null;
|
|
1755
|
+
};
|
|
1756
|
+
/**
|
|
1757
|
+
* 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.
|
|
1758
|
+
*/
|
|
1759
|
+
export type PeopleEmploymentCustomFieldsUpdateParameters = {
|
|
1760
|
+
/**
|
|
1761
|
+
* Required, nonempty list of configurations and their replacement values. Each configuration may appear only once.
|
|
1762
|
+
*/
|
|
1763
|
+
custom_fields: Array<{
|
|
1764
|
+
/**
|
|
1765
|
+
* ID of a custom-field configuration owned by the credential company and applicable to employments. A hidden configuration may be updated only when the family already stores its value.
|
|
1766
|
+
*/
|
|
1767
|
+
custom_field_config_id: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* Replacement value as text or null. Null stores a value rather than removing the row.
|
|
1770
|
+
*/
|
|
1771
|
+
value: string | null;
|
|
1772
|
+
}>;
|
|
1773
|
+
};
|
|
1630
1774
|
export type PeopleEmploymentHistoryCorrectionObject = {
|
|
1631
1775
|
/**
|
|
1632
1776
|
* Family key shared by every entry on this timeline — the same identity the member route addresses. An entry carries no identifier of its own; versions are distinguished by their window coordinates.
|
|
@@ -3534,7 +3678,7 @@ export type JobResponseObject = {
|
|
|
3534
3678
|
*/
|
|
3535
3679
|
require_clock_in: boolean;
|
|
3536
3680
|
/**
|
|
3537
|
-
* Clock-in enforcement level: one of none (no guidance), warning (
|
|
3681
|
+
* Clock-in enforcement level stored on the job: one of none (no guidance), warning (manual time entries fail the clock-in compliance check), or required (a technician's own time on the job must come from clocking in on DSPTCH Mobile; the technician's own web and user-API-key time-entry writes are refused). A time entry whose time code, as of the entry's start time, is PTO, holiday, or restricted to non-job time entries is exempt at every level. Time-entry writes made with a company API key are not gated. A company-wide clock-in requirement on the time entry's company can make that entry's requirement stricter than this value.
|
|
3538
3682
|
*/
|
|
3539
3683
|
clock_in_requirement: 'none' | 'warning' | 'required';
|
|
3540
3684
|
/**
|
|
@@ -3808,7 +3952,7 @@ export type JobParameters = {
|
|
|
3808
3952
|
tz_name?: string;
|
|
3809
3953
|
time_card_start_day?: TimeCardStartDay;
|
|
3810
3954
|
/**
|
|
3811
|
-
* Clock-in enforcement level: one of none (no guidance), warning (
|
|
3955
|
+
* Clock-in enforcement level: one of none (no guidance), warning (manual time entries fail the clock-in compliance check), or required (a technician's own time on the job must come from clocking in on DSPTCH Mobile; the technician's own web and user-API-key time-entry writes are refused). A time entry whose time code, as of the entry's start time, is PTO, holiday, or restricted to non-job time entries is exempt at every level. Time-entry writes made with a company API key are not gated. While the creating company requires clock-in company-wide, a create stores `required` whatever value is sent, and lowering an open job returns 422 with the error at `#/clock_in_requirement`. Omit the field to leave the current value unchanged.
|
|
3812
3956
|
*/
|
|
3813
3957
|
clock_in_requirement?: 'none' | 'warning' | 'required';
|
|
3814
3958
|
/**
|
|
@@ -4811,7 +4955,7 @@ export type TimeEntryParameters = {
|
|
|
4811
4955
|
*/
|
|
4812
4956
|
description?: string | null;
|
|
4813
4957
|
/**
|
|
4814
|
-
* Base hourly rate in cents, sent as a string to preserve precision; omit
|
|
4958
|
+
* Base hourly rate in cents, sent as a string to preserve precision; omit it to let the system derive the rate from the position/user default. Only a company-scoped key or a key whose user is an admin in the entry's company may send it, and null from those keys also derives the default. Any other user-scoped key must omit it; sending it, null included, is refused with 403.
|
|
4815
4959
|
*/
|
|
4816
4960
|
hourly_rate_cents?: string | null;
|
|
4817
4961
|
/**
|
|
@@ -5634,7 +5778,7 @@ export type AggregateTimeImportResponseObject = {
|
|
|
5634
5778
|
/**
|
|
5635
5779
|
* Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
|
|
5636
5780
|
*/
|
|
5637
|
-
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed';
|
|
5781
|
+
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded' | 'withdrawn';
|
|
5638
5782
|
/**
|
|
5639
5783
|
* How many rows passed validation and were prepared for writing. On a `success` import that is also how many rows were written. On a `failed` one it is not — the import writes all of its rows in a single transaction, so a failure part-way through undoes every write already made while this count still reports every row that had been prepared.
|
|
5640
5784
|
*/
|
|
@@ -5684,7 +5828,7 @@ export type DsptchCprImportResponseObject = {
|
|
|
5684
5828
|
/**
|
|
5685
5829
|
* Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
|
|
5686
5830
|
*/
|
|
5687
|
-
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed';
|
|
5831
|
+
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded' | 'withdrawn';
|
|
5688
5832
|
/**
|
|
5689
5833
|
* How many rows passed validation and were prepared for writing. On a `success` import that is also how many rows were written. On a `failed` one it is not — the import writes all of its rows in a single transaction, so a failure part-way through undoes every write already made while this count still reports every row that had been prepared.
|
|
5690
5834
|
*/
|
|
@@ -5734,7 +5878,7 @@ export type PaystubImportResponseObject = {
|
|
|
5734
5878
|
/**
|
|
5735
5879
|
* Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
|
|
5736
5880
|
*/
|
|
5737
|
-
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed';
|
|
5881
|
+
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded' | 'withdrawn';
|
|
5738
5882
|
/**
|
|
5739
5883
|
* How many rows passed validation and were prepared for writing. On a `success` import that is also how many rows were written. On a `failed` one it is not — the import writes all of its rows in a single transaction, so a failure part-way through undoes every write already made while this count still reports every row that had been prepared.
|
|
5740
5884
|
*/
|
|
@@ -5784,7 +5928,7 @@ export type TimeEntryImportResponseObject = {
|
|
|
5784
5928
|
/**
|
|
5785
5929
|
* Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
|
|
5786
5930
|
*/
|
|
5787
|
-
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed';
|
|
5931
|
+
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded' | 'withdrawn';
|
|
5788
5932
|
/**
|
|
5789
5933
|
* How many rows passed validation and were prepared for writing. On a `success` import that is also how many rows were written. On a `failed` one it is not — the import writes all of its rows in a single transaction, so a failure part-way through undoes every write already made while this count still reports every row that had been prepared.
|
|
5790
5934
|
*/
|
|
@@ -8871,11 +9015,11 @@ export type FormAssignmentTaskResponseObject = Array<{
|
|
|
8871
9015
|
}>;
|
|
8872
9016
|
}>;
|
|
8873
9017
|
/**
|
|
8874
|
-
* Request body for creating a certification — a named qualification a worker can hold. You can only manage your own company's certifications; global (platform) certifications are read-only.
|
|
9018
|
+
* Request body for creating a certification — a named qualification a worker can hold. You can only manage your own company's certifications; global (platform) certifications are read-only. Only the keys listed here are accepted — any other key is rejected with 400 unknown_key.
|
|
8875
9019
|
*/
|
|
8876
9020
|
export type CertificationParameters = {
|
|
8877
9021
|
/**
|
|
8878
|
-
* Id of the company that owns the certification. Must be the company that owns the API key; you cannot create global certifications through the API.
|
|
9022
|
+
* Id of the company that owns the certification. Must be the company that owns the API key; you cannot create global certifications through the API. Required on create and fixed from then on — an update cannot move a certification to another company.
|
|
8879
9023
|
*/
|
|
8880
9024
|
company_id: string;
|
|
8881
9025
|
/**
|
|
@@ -8896,13 +9040,9 @@ export type CertificationParameters = {
|
|
|
8896
9040
|
duration?: string | null;
|
|
8897
9041
|
};
|
|
8898
9042
|
/**
|
|
8899
|
-
* Request body for updating a certification — a named qualification a worker can hold. Include only the fields to change. You can only manage your own company's certifications; global (platform) certifications are read-only.
|
|
9043
|
+
* Request body for updating a certification — a named qualification a worker can hold. Include only the fields to change. You can only manage your own company's certifications; global (platform) certifications are read-only. company_id is absent by design — the certification's company is fixed at creation, so sending the key is rejected with 400 unknown_key, as is any other key not listed here.
|
|
8900
9044
|
*/
|
|
8901
9045
|
export type CertificationUpdateParameters = {
|
|
8902
|
-
/**
|
|
8903
|
-
* Id of the company that owns the certification. It must match the company that owns the API key; updates cannot move a certification between companies.
|
|
8904
|
-
*/
|
|
8905
|
-
company_id?: string;
|
|
8906
9046
|
/**
|
|
8907
9047
|
* Name of the certification (for example "OSHA 30" or a GWO training module). Unique within the company.
|
|
8908
9048
|
*/
|
|
@@ -8973,7 +9113,7 @@ export type CertificationPackageResponseObject = {
|
|
|
8973
9113
|
updated_at: string;
|
|
8974
9114
|
};
|
|
8975
9115
|
/**
|
|
8976
|
-
* Request body for creating a certification package — a named set of certifications a company requires together.
|
|
9116
|
+
* Request body for creating a certification package — a named set of certifications a company requires together. The package belongs to the company that owns the API key. Only the keys listed here are accepted — any other key is rejected with 400 unknown_key.
|
|
8977
9117
|
*/
|
|
8978
9118
|
export type CertificationPackageParameters = {
|
|
8979
9119
|
/**
|
|
@@ -8985,7 +9125,7 @@ export type CertificationPackageParameters = {
|
|
|
8985
9125
|
*/
|
|
8986
9126
|
description?: string | null;
|
|
8987
9127
|
/**
|
|
8988
|
-
* Ids of the certifications in the package; global and your company's own may be mixed. Providing this replaces the entire membership.
|
|
9128
|
+
* Ids of the certifications in the package; global and your company's own may be mixed. Providing this replaces the entire membership. An id that is neither a global certification nor one of your company's own answers 404, and nothing is written.
|
|
8989
9129
|
*/
|
|
8990
9130
|
certification_ids?: Array<string>;
|
|
8991
9131
|
/**
|
|
@@ -8994,7 +9134,7 @@ export type CertificationPackageParameters = {
|
|
|
8994
9134
|
performed_by_user_id: string;
|
|
8995
9135
|
};
|
|
8996
9136
|
/**
|
|
8997
|
-
* Request body for updating a certification package — a named set of certifications a company requires together. Include only the fields to change.
|
|
9137
|
+
* Request body for updating a certification package — a named set of certifications a company requires together. Include only the fields to change. Any key not listed here is rejected with 400 unknown_key.
|
|
8998
9138
|
*/
|
|
8999
9139
|
export type CertificationPackageUpdateParameters = {
|
|
9000
9140
|
/**
|
|
@@ -9006,7 +9146,7 @@ export type CertificationPackageUpdateParameters = {
|
|
|
9006
9146
|
*/
|
|
9007
9147
|
description?: string | null;
|
|
9008
9148
|
/**
|
|
9009
|
-
* Ids of the certifications in the package; global and your company's own may be mixed. Providing this replaces the entire membership.
|
|
9149
|
+
* Ids of the certifications in the package; global and your company's own may be mixed. Providing this replaces the entire membership. An id that is neither a global certification nor one of your company's own answers 404, and nothing is written.
|
|
9010
9150
|
*/
|
|
9011
9151
|
certification_ids?: Array<string>;
|
|
9012
9152
|
/**
|
|
@@ -12517,6 +12657,40 @@ export type ListAllocationsResponses = {
|
|
|
12517
12657
|
};
|
|
12518
12658
|
};
|
|
12519
12659
|
export type ListAllocationsResponse = ListAllocationsResponses[keyof ListAllocationsResponses];
|
|
12660
|
+
export type CreateAllocationData = {
|
|
12661
|
+
body: ApprenticeshipAllocationCreateParameters;
|
|
12662
|
+
path: {
|
|
12663
|
+
apprentice_id: string;
|
|
12664
|
+
};
|
|
12665
|
+
query?: never;
|
|
12666
|
+
url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations';
|
|
12667
|
+
};
|
|
12668
|
+
export type CreateAllocationErrors = {
|
|
12669
|
+
/**
|
|
12670
|
+
* Bad Request
|
|
12671
|
+
*/
|
|
12672
|
+
400: Problem;
|
|
12673
|
+
/**
|
|
12674
|
+
* Forbidden
|
|
12675
|
+
*/
|
|
12676
|
+
403: Problem;
|
|
12677
|
+
/**
|
|
12678
|
+
* Not Found
|
|
12679
|
+
*/
|
|
12680
|
+
404: Problem;
|
|
12681
|
+
/**
|
|
12682
|
+
* Unprocessable Content
|
|
12683
|
+
*/
|
|
12684
|
+
422: Problem;
|
|
12685
|
+
};
|
|
12686
|
+
export type CreateAllocationError = CreateAllocationErrors[keyof CreateAllocationErrors];
|
|
12687
|
+
export type CreateAllocationResponses = {
|
|
12688
|
+
/**
|
|
12689
|
+
* Created
|
|
12690
|
+
*/
|
|
12691
|
+
201: ApprenticeshipAllocationResponseObject;
|
|
12692
|
+
};
|
|
12693
|
+
export type CreateAllocationResponse = CreateAllocationResponses[keyof CreateAllocationResponses];
|
|
12520
12694
|
export type GetAllocationData = {
|
|
12521
12695
|
body?: never;
|
|
12522
12696
|
path: {
|
|
@@ -13087,6 +13261,10 @@ export type CreatePeriodData = {
|
|
|
13087
13261
|
url: '/api/v1/apprenticeship/wage_schedules/{wage_schedule_id}/periods';
|
|
13088
13262
|
};
|
|
13089
13263
|
export type CreatePeriodErrors = {
|
|
13264
|
+
/**
|
|
13265
|
+
* Bad Request
|
|
13266
|
+
*/
|
|
13267
|
+
400: Problem;
|
|
13090
13268
|
/**
|
|
13091
13269
|
* Forbidden
|
|
13092
13270
|
*/
|
|
@@ -13114,6 +13292,10 @@ export type UpdatePeriodData = {
|
|
|
13114
13292
|
url: '/api/v1/apprenticeship/wage_schedules/{wage_schedule_id}/periods/{id}';
|
|
13115
13293
|
};
|
|
13116
13294
|
export type UpdatePeriodErrors = {
|
|
13295
|
+
/**
|
|
13296
|
+
* Bad Request
|
|
13297
|
+
*/
|
|
13298
|
+
400: Problem;
|
|
13117
13299
|
/**
|
|
13118
13300
|
* Forbidden
|
|
13119
13301
|
*/
|
|
@@ -13122,6 +13304,10 @@ export type UpdatePeriodErrors = {
|
|
|
13122
13304
|
* Not Found
|
|
13123
13305
|
*/
|
|
13124
13306
|
404: Problem;
|
|
13307
|
+
/**
|
|
13308
|
+
* Unprocessable Content
|
|
13309
|
+
*/
|
|
13310
|
+
422: Problem;
|
|
13125
13311
|
};
|
|
13126
13312
|
export type UpdatePeriodError = UpdatePeriodErrors[keyof UpdatePeriodErrors];
|
|
13127
13313
|
export type UpdatePeriodResponses = {
|
|
@@ -13195,6 +13381,10 @@ export type CreateWageScheduleData = {
|
|
|
13195
13381
|
url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules';
|
|
13196
13382
|
};
|
|
13197
13383
|
export type CreateWageScheduleErrors = {
|
|
13384
|
+
/**
|
|
13385
|
+
* Bad Request
|
|
13386
|
+
*/
|
|
13387
|
+
400: Problem;
|
|
13198
13388
|
/**
|
|
13199
13389
|
* Forbidden
|
|
13200
13390
|
*/
|
|
@@ -13222,6 +13412,10 @@ export type UpdateWageScheduleData = {
|
|
|
13222
13412
|
url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules/{id}';
|
|
13223
13413
|
};
|
|
13224
13414
|
export type UpdateWageScheduleErrors = {
|
|
13415
|
+
/**
|
|
13416
|
+
* Bad Request
|
|
13417
|
+
*/
|
|
13418
|
+
400: Problem;
|
|
13225
13419
|
/**
|
|
13226
13420
|
* Forbidden
|
|
13227
13421
|
*/
|
|
@@ -16017,13 +16211,17 @@ export type CreatePackageData = {
|
|
|
16017
16211
|
};
|
|
16018
16212
|
export type CreatePackageErrors = {
|
|
16019
16213
|
/**
|
|
16020
|
-
* Bad Request
|
|
16214
|
+
* Bad Request
|
|
16021
16215
|
*/
|
|
16022
16216
|
400: Problem;
|
|
16023
16217
|
/**
|
|
16024
16218
|
* Forbidden
|
|
16025
16219
|
*/
|
|
16026
16220
|
403: Problem;
|
|
16221
|
+
/**
|
|
16222
|
+
* Not Found
|
|
16223
|
+
*/
|
|
16224
|
+
404: Problem;
|
|
16027
16225
|
/**
|
|
16028
16226
|
* Unprocessable Content
|
|
16029
16227
|
*/
|
|
@@ -16098,6 +16296,10 @@ export type UpdatePackageData = {
|
|
|
16098
16296
|
url: '/api/v1/certifications/packages/{id}';
|
|
16099
16297
|
};
|
|
16100
16298
|
export type UpdatePackageErrors = {
|
|
16299
|
+
/**
|
|
16300
|
+
* Bad Request
|
|
16301
|
+
*/
|
|
16302
|
+
400: Problem;
|
|
16101
16303
|
/**
|
|
16102
16304
|
* Forbidden
|
|
16103
16305
|
*/
|
|
@@ -16394,6 +16596,10 @@ export type UpdateCertificationData = {
|
|
|
16394
16596
|
url: '/api/v1/certifications/{id}';
|
|
16395
16597
|
};
|
|
16396
16598
|
export type UpdateCertificationErrors = {
|
|
16599
|
+
/**
|
|
16600
|
+
* Bad Request
|
|
16601
|
+
*/
|
|
16602
|
+
400: Problem;
|
|
16397
16603
|
/**
|
|
16398
16604
|
* Forbidden
|
|
16399
16605
|
*/
|
|
@@ -16484,6 +16690,62 @@ export type CreateDepartmentResponses = {
|
|
|
16484
16690
|
201: DepartmentResponseObject;
|
|
16485
16691
|
};
|
|
16486
16692
|
export type CreateDepartmentResponse = CreateDepartmentResponses[keyof CreateDepartmentResponses];
|
|
16693
|
+
export type DeleteDepartmentData = {
|
|
16694
|
+
body?: never;
|
|
16695
|
+
path: {
|
|
16696
|
+
id: string;
|
|
16697
|
+
};
|
|
16698
|
+
query?: never;
|
|
16699
|
+
url: '/api/v1/companies/departments/{id}';
|
|
16700
|
+
};
|
|
16701
|
+
export type DeleteDepartmentErrors = {
|
|
16702
|
+
/**
|
|
16703
|
+
* Forbidden
|
|
16704
|
+
*/
|
|
16705
|
+
403: Problem;
|
|
16706
|
+
/**
|
|
16707
|
+
* Not Found
|
|
16708
|
+
*/
|
|
16709
|
+
404: Problem;
|
|
16710
|
+
/**
|
|
16711
|
+
* Unprocessable Content
|
|
16712
|
+
*/
|
|
16713
|
+
422: Problem;
|
|
16714
|
+
};
|
|
16715
|
+
export type DeleteDepartmentError = DeleteDepartmentErrors[keyof DeleteDepartmentErrors];
|
|
16716
|
+
export type DeleteDepartmentResponses = {
|
|
16717
|
+
/**
|
|
16718
|
+
* No Content
|
|
16719
|
+
*/
|
|
16720
|
+
204: void;
|
|
16721
|
+
};
|
|
16722
|
+
export type DeleteDepartmentResponse = DeleteDepartmentResponses[keyof DeleteDepartmentResponses];
|
|
16723
|
+
export type GetDepartmentData = {
|
|
16724
|
+
body?: never;
|
|
16725
|
+
path: {
|
|
16726
|
+
id: string;
|
|
16727
|
+
};
|
|
16728
|
+
query?: never;
|
|
16729
|
+
url: '/api/v1/companies/departments/{id}';
|
|
16730
|
+
};
|
|
16731
|
+
export type GetDepartmentErrors = {
|
|
16732
|
+
/**
|
|
16733
|
+
* Forbidden
|
|
16734
|
+
*/
|
|
16735
|
+
403: Problem;
|
|
16736
|
+
/**
|
|
16737
|
+
* Not Found
|
|
16738
|
+
*/
|
|
16739
|
+
404: Problem;
|
|
16740
|
+
};
|
|
16741
|
+
export type GetDepartmentError = GetDepartmentErrors[keyof GetDepartmentErrors];
|
|
16742
|
+
export type GetDepartmentResponses = {
|
|
16743
|
+
/**
|
|
16744
|
+
* Success
|
|
16745
|
+
*/
|
|
16746
|
+
200: DepartmentResponseObject;
|
|
16747
|
+
};
|
|
16748
|
+
export type GetDepartmentResponse = GetDepartmentResponses[keyof GetDepartmentResponses];
|
|
16487
16749
|
export type UpdateDepartmentData = {
|
|
16488
16750
|
body: DepartmentUpdateParameters;
|
|
16489
16751
|
path: {
|
|
@@ -18303,6 +18565,14 @@ export type ListJobsData = {
|
|
|
18303
18565
|
* Returns jobs whose production_tracking_kind matches. One of `none`, `feature`, or `quantity`.
|
|
18304
18566
|
*/
|
|
18305
18567
|
'filter[production_tracking_kind]'?: 'none' | 'feature' | 'quantity';
|
|
18568
|
+
/**
|
|
18569
|
+
* Returns jobs whose name contains this substring (case-insensitive). Matches the name column only — not display ID, company, or site names.
|
|
18570
|
+
*/
|
|
18571
|
+
'filter[name]'?: string;
|
|
18572
|
+
/**
|
|
18573
|
+
* Returns jobs whose purchase order number contains this substring (case-insensitive).
|
|
18574
|
+
*/
|
|
18575
|
+
'filter[purchase_order_number]'?: string;
|
|
18306
18576
|
/**
|
|
18307
18577
|
* This pagination cursor corresponds to the cursor value found in the response in
|
|
18308
18578
|
* `meta.page.next_cursor`.
|
|
@@ -19804,6 +20074,8 @@ export type ListAggregateTimeImportsData = {
|
|
|
19804
20074
|
* * `processed`
|
|
19805
20075
|
* * `success`
|
|
19806
20076
|
* * `failed`
|
|
20077
|
+
* * `superseded`
|
|
20078
|
+
* * `withdrawn`
|
|
19807
20079
|
*
|
|
19808
20080
|
*/
|
|
19809
20081
|
'filter[status]'?: string;
|
|
@@ -19932,6 +20204,8 @@ export type ListDsptchCprImportsData = {
|
|
|
19932
20204
|
* * `processed`
|
|
19933
20205
|
* * `success`
|
|
19934
20206
|
* * `failed`
|
|
20207
|
+
* * `superseded`
|
|
20208
|
+
* * `withdrawn`
|
|
19935
20209
|
*
|
|
19936
20210
|
*/
|
|
19937
20211
|
'filter[status]'?: string;
|
|
@@ -20060,6 +20334,8 @@ export type ListTimeEntryImportsData = {
|
|
|
20060
20334
|
* * `processed`
|
|
20061
20335
|
* * `success`
|
|
20062
20336
|
* * `failed`
|
|
20337
|
+
* * `superseded`
|
|
20338
|
+
* * `withdrawn`
|
|
20063
20339
|
*
|
|
20064
20340
|
*/
|
|
20065
20341
|
'filter[status]'?: string;
|
|
@@ -20582,6 +20858,8 @@ export type ListPaystubImportsData = {
|
|
|
20582
20858
|
* * `processed`
|
|
20583
20859
|
* * `success`
|
|
20584
20860
|
* * `failed`
|
|
20861
|
+
* * `superseded`
|
|
20862
|
+
* * `withdrawn`
|
|
20585
20863
|
*
|
|
20586
20864
|
*/
|
|
20587
20865
|
'filter[status]'?: string;
|
|
@@ -21198,6 +21476,84 @@ export type UpdatePaystubResponses = {
|
|
|
21198
21476
|
200: PaystubResponseObject;
|
|
21199
21477
|
};
|
|
21200
21478
|
export type UpdatePaystubResponse = UpdatePaystubResponses[keyof UpdatePaystubResponses];
|
|
21479
|
+
export type ListCustomFieldsData = {
|
|
21480
|
+
body?: never;
|
|
21481
|
+
path: {
|
|
21482
|
+
employment_id: string;
|
|
21483
|
+
};
|
|
21484
|
+
query?: never;
|
|
21485
|
+
url: '/api/v1/people/employments/{employment_id}/custom_fields';
|
|
21486
|
+
};
|
|
21487
|
+
export type ListCustomFieldsErrors = {
|
|
21488
|
+
/**
|
|
21489
|
+
* Forbidden
|
|
21490
|
+
*/
|
|
21491
|
+
403: Problem;
|
|
21492
|
+
/**
|
|
21493
|
+
* Not Found
|
|
21494
|
+
*/
|
|
21495
|
+
404: Problem;
|
|
21496
|
+
};
|
|
21497
|
+
export type ListCustomFieldsError = ListCustomFieldsErrors[keyof ListCustomFieldsErrors];
|
|
21498
|
+
export type ListCustomFieldsResponses = {
|
|
21499
|
+
/**
|
|
21500
|
+
* Success
|
|
21501
|
+
*/
|
|
21502
|
+
200: {
|
|
21503
|
+
data: Array<PeopleEmploymentCustomFieldResponseObject>;
|
|
21504
|
+
};
|
|
21505
|
+
};
|
|
21506
|
+
export type ListCustomFieldsResponse = ListCustomFieldsResponses[keyof ListCustomFieldsResponses];
|
|
21507
|
+
export type UpdateCustomFieldData = {
|
|
21508
|
+
body: PeopleEmploymentCustomFieldsUpdateParameters;
|
|
21509
|
+
headers: {
|
|
21510
|
+
/**
|
|
21511
|
+
* Version validator this write is composed against.
|
|
21512
|
+
*/
|
|
21513
|
+
'If-Match': string;
|
|
21514
|
+
};
|
|
21515
|
+
path: {
|
|
21516
|
+
employment_id: string;
|
|
21517
|
+
};
|
|
21518
|
+
query?: never;
|
|
21519
|
+
url: '/api/v1/people/employments/{employment_id}/custom_fields';
|
|
21520
|
+
};
|
|
21521
|
+
export type UpdateCustomFieldErrors = {
|
|
21522
|
+
/**
|
|
21523
|
+
* Bad Request
|
|
21524
|
+
*/
|
|
21525
|
+
400: Problem;
|
|
21526
|
+
/**
|
|
21527
|
+
* Forbidden
|
|
21528
|
+
*/
|
|
21529
|
+
403: Problem;
|
|
21530
|
+
/**
|
|
21531
|
+
* Not Found
|
|
21532
|
+
*/
|
|
21533
|
+
404: Problem;
|
|
21534
|
+
/**
|
|
21535
|
+
* Precondition Failed
|
|
21536
|
+
*/
|
|
21537
|
+
412: Problem;
|
|
21538
|
+
/**
|
|
21539
|
+
* Unprocessable Content
|
|
21540
|
+
*/
|
|
21541
|
+
422: Problem;
|
|
21542
|
+
/**
|
|
21543
|
+
* Precondition Required
|
|
21544
|
+
*/
|
|
21545
|
+
428: Problem;
|
|
21546
|
+
};
|
|
21547
|
+
export type UpdateCustomFieldError = UpdateCustomFieldErrors[keyof UpdateCustomFieldErrors];
|
|
21548
|
+
export type UpdateCustomFieldResponses = {
|
|
21549
|
+
/**
|
|
21550
|
+
* Success
|
|
21551
|
+
*/
|
|
21552
|
+
200: {
|
|
21553
|
+
data: Array<PeopleEmploymentCustomFieldResponseObject>;
|
|
21554
|
+
};
|
|
21555
|
+
};
|
|
21556
|
+
export type UpdateCustomFieldResponse = UpdateCustomFieldResponses[keyof UpdateCustomFieldResponses];
|
|
21201
21557
|
export type UpdateGenesisData = {
|
|
21202
21558
|
body: PeopleEmploymentGenesisParameters;
|
|
21203
21559
|
headers: {
|
|
@@ -21412,7 +21768,7 @@ export type DeleteEmploymentScheduledChangeData = {
|
|
|
21412
21768
|
*/
|
|
21413
21769
|
employment_id: string;
|
|
21414
21770
|
/**
|
|
21415
|
-
* The existing
|
|
21771
|
+
* The existing exact boundary, as a company-local date.
|
|
21416
21772
|
*/
|
|
21417
21773
|
effective_date: string;
|
|
21418
21774
|
};
|
|
@@ -21459,7 +21815,7 @@ export type UpdateEmploymentScheduledChangeData = {
|
|
|
21459
21815
|
*/
|
|
21460
21816
|
employment_id: string;
|
|
21461
21817
|
/**
|
|
21462
|
-
* The existing
|
|
21818
|
+
* The existing exact boundary, as a company-local date.
|
|
21463
21819
|
*/
|
|
21464
21820
|
effective_date: string;
|
|
21465
21821
|
};
|
|
@@ -21691,6 +22047,53 @@ export type CreateEmploymentResponses = {
|
|
|
21691
22047
|
201: PeopleEmploymentResponseObject;
|
|
21692
22048
|
};
|
|
21693
22049
|
export type CreateEmploymentResponse = CreateEmploymentResponses[keyof CreateEmploymentResponses];
|
|
22050
|
+
export type DeleteEmploymentData = {
|
|
22051
|
+
body?: never;
|
|
22052
|
+
headers: {
|
|
22053
|
+
/**
|
|
22054
|
+
* Version validator for the whole employment family, or `*` to remove its current state.
|
|
22055
|
+
*/
|
|
22056
|
+
'If-Match': string;
|
|
22057
|
+
};
|
|
22058
|
+
path: {
|
|
22059
|
+
/**
|
|
22060
|
+
* The employment stint identity returned as `id`.
|
|
22061
|
+
*/
|
|
22062
|
+
id: string;
|
|
22063
|
+
};
|
|
22064
|
+
query?: never;
|
|
22065
|
+
url: '/api/v1/people/employments/{id}';
|
|
22066
|
+
};
|
|
22067
|
+
export type DeleteEmploymentErrors = {
|
|
22068
|
+
/**
|
|
22069
|
+
* Forbidden
|
|
22070
|
+
*/
|
|
22071
|
+
403: Problem;
|
|
22072
|
+
/**
|
|
22073
|
+
* Not Found
|
|
22074
|
+
*/
|
|
22075
|
+
404: Problem;
|
|
22076
|
+
/**
|
|
22077
|
+
* Precondition Failed
|
|
22078
|
+
*/
|
|
22079
|
+
412: Problem;
|
|
22080
|
+
/**
|
|
22081
|
+
* Unprocessable Content
|
|
22082
|
+
*/
|
|
22083
|
+
422: Problem;
|
|
22084
|
+
/**
|
|
22085
|
+
* Precondition Required
|
|
22086
|
+
*/
|
|
22087
|
+
428: Problem;
|
|
22088
|
+
};
|
|
22089
|
+
export type DeleteEmploymentError = DeleteEmploymentErrors[keyof DeleteEmploymentErrors];
|
|
22090
|
+
export type DeleteEmploymentResponses = {
|
|
22091
|
+
/**
|
|
22092
|
+
* Success
|
|
22093
|
+
*/
|
|
22094
|
+
200: PeopleEmploymentResponseObject;
|
|
22095
|
+
};
|
|
22096
|
+
export type DeleteEmploymentResponse = DeleteEmploymentResponses[keyof DeleteEmploymentResponses];
|
|
21694
22097
|
export type GetEmploymentData = {
|
|
21695
22098
|
body?: never;
|
|
21696
22099
|
path: {
|
|
@@ -21725,6 +22128,57 @@ export type GetEmploymentResponses = {
|
|
|
21725
22128
|
200: PeopleEmploymentResponseObject;
|
|
21726
22129
|
};
|
|
21727
22130
|
export type GetEmploymentResponse = GetEmploymentResponses[keyof GetEmploymentResponses];
|
|
22131
|
+
export type UpdateEmploymentData = {
|
|
22132
|
+
body: PeopleEmploymentUpdateParameters;
|
|
22133
|
+
headers: {
|
|
22134
|
+
/**
|
|
22135
|
+
* Version validator for the whole employment family, or `*` for its current state.
|
|
22136
|
+
*/
|
|
22137
|
+
'If-Match': string;
|
|
22138
|
+
};
|
|
22139
|
+
path: {
|
|
22140
|
+
/**
|
|
22141
|
+
* The employment stint identity returned as `id`.
|
|
22142
|
+
*/
|
|
22143
|
+
id: string;
|
|
22144
|
+
};
|
|
22145
|
+
query?: never;
|
|
22146
|
+
url: '/api/v1/people/employments/{id}';
|
|
22147
|
+
};
|
|
22148
|
+
export type UpdateEmploymentErrors = {
|
|
22149
|
+
/**
|
|
22150
|
+
* Bad Request
|
|
22151
|
+
*/
|
|
22152
|
+
400: Problem;
|
|
22153
|
+
/**
|
|
22154
|
+
* Forbidden
|
|
22155
|
+
*/
|
|
22156
|
+
403: Problem;
|
|
22157
|
+
/**
|
|
22158
|
+
* Not Found
|
|
22159
|
+
*/
|
|
22160
|
+
404: Problem;
|
|
22161
|
+
/**
|
|
22162
|
+
* Precondition Failed
|
|
22163
|
+
*/
|
|
22164
|
+
412: Problem;
|
|
22165
|
+
/**
|
|
22166
|
+
* Unprocessable Content
|
|
22167
|
+
*/
|
|
22168
|
+
422: Problem;
|
|
22169
|
+
/**
|
|
22170
|
+
* Precondition Required
|
|
22171
|
+
*/
|
|
22172
|
+
428: Problem;
|
|
22173
|
+
};
|
|
22174
|
+
export type UpdateEmploymentError = UpdateEmploymentErrors[keyof UpdateEmploymentErrors];
|
|
22175
|
+
export type UpdateEmploymentResponses = {
|
|
22176
|
+
/**
|
|
22177
|
+
* Success
|
|
22178
|
+
*/
|
|
22179
|
+
200: PeopleEmploymentResponseObject;
|
|
22180
|
+
};
|
|
22181
|
+
export type UpdateEmploymentResponse = UpdateEmploymentResponses[keyof UpdateEmploymentResponses];
|
|
21728
22182
|
export type ListPerDiemsData = {
|
|
21729
22183
|
body?: never;
|
|
21730
22184
|
path?: never;
|