@dsptch-work/api-client 0.23.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 +19 -0
- package/dist/gen/index.d.ts +1 -1
- package/dist/gen/sdk.gen.d.ts +43 -8
- package/dist/gen/sdk.gen.js +54 -7
- package/dist/gen/types.gen.d.ts +173 -25
- package/dist/gen/zod.gen.d.ts +80 -11
- package/dist/gen/zod.gen.js +48 -16
- package/package.json +1 -1
package/dist/gen/sdk.gen.js
CHANGED
|
@@ -2187,6 +2187,46 @@ export class CompaniesDepartments {
|
|
|
2187
2187
|
}
|
|
2188
2188
|
});
|
|
2189
2189
|
}
|
|
2190
|
+
/**
|
|
2191
|
+
* Delete department
|
|
2192
|
+
*
|
|
2193
|
+
* Deletes a department that has no employment assignments. A department still
|
|
2194
|
+
* assigned on any employment is refused with a `422` — reassign those
|
|
2195
|
+
* employments first. An unused department returns `204` and is gone from a
|
|
2196
|
+
* later GET.
|
|
2197
|
+
*
|
|
2198
|
+
*
|
|
2199
|
+
* **Required scope:**
|
|
2200
|
+
*
|
|
2201
|
+
* `companies.departments:delete`
|
|
2202
|
+
*
|
|
2203
|
+
*/
|
|
2204
|
+
static deleteDepartment(options) {
|
|
2205
|
+
return (options.client ?? client).delete({
|
|
2206
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2207
|
+
url: '/api/v1/companies/departments/{id}',
|
|
2208
|
+
...options
|
|
2209
|
+
});
|
|
2210
|
+
}
|
|
2211
|
+
/**
|
|
2212
|
+
* Show department
|
|
2213
|
+
*
|
|
2214
|
+
* Returns one department owned by the key's company. A missing or out-of-scope
|
|
2215
|
+
* id reads as not found.
|
|
2216
|
+
*
|
|
2217
|
+
*
|
|
2218
|
+
* **Required scope:**
|
|
2219
|
+
*
|
|
2220
|
+
* `companies.departments:read`
|
|
2221
|
+
*
|
|
2222
|
+
*/
|
|
2223
|
+
static getDepartment(options) {
|
|
2224
|
+
return (options.client ?? client).get({
|
|
2225
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
2226
|
+
url: '/api/v1/companies/departments/{id}',
|
|
2227
|
+
...options
|
|
2228
|
+
});
|
|
2229
|
+
}
|
|
2190
2230
|
/**
|
|
2191
2231
|
* Update department
|
|
2192
2232
|
*
|
|
@@ -4848,9 +4888,10 @@ export class People {
|
|
|
4848
4888
|
/**
|
|
4849
4889
|
* Schedule an employment change
|
|
4850
4890
|
*
|
|
4851
|
-
* Create one
|
|
4852
|
-
*
|
|
4853
|
-
*
|
|
4891
|
+
* Create one employment-version boundary. `effective_date` is interpreted at
|
|
4892
|
+
* midnight in the credential company's time zone. Today and past dates must fall
|
|
4893
|
+
* inside the family's latest version; future dates retain the existing scheduling
|
|
4894
|
+
* behavior. This operation cannot move or replace an existing boundary.
|
|
4854
4895
|
*
|
|
4855
4896
|
* Conditional: send the employment's `ETag` as `If-Match`.
|
|
4856
4897
|
*
|
|
@@ -4895,8 +4936,9 @@ export class People {
|
|
|
4895
4936
|
/**
|
|
4896
4937
|
* Edit an employment change at an exact boundary
|
|
4897
4938
|
*
|
|
4898
|
-
* Change values at the exact
|
|
4899
|
-
*
|
|
4939
|
+
* Change values at the exact boundary named by the path. A boundary at today
|
|
4940
|
+
* or an earlier date must start the family's latest version. The boundary
|
|
4941
|
+
* itself never moves; a date inside a version does not identify it.
|
|
4900
4942
|
*
|
|
4901
4943
|
* Conditional: send the employment's `ETag` as `If-Match`.
|
|
4902
4944
|
*
|
|
@@ -6202,7 +6244,10 @@ export class TimeEntries {
|
|
|
6202
6244
|
* company's default timecodes), state, description, hourly_rate_cents (derived
|
|
6203
6245
|
* from the position/user default when omitted), and feature_ids. Supplying
|
|
6204
6246
|
* feature_ids — or setting feature_allocation_acknowledged true — satisfies a
|
|
6205
|
-
* job that requires a feature allocation.
|
|
6247
|
+
* job that requires a feature allocation. A user-scoped key may send
|
|
6248
|
+
* hourly_rate_cents only when its user is an admin in the entry's company;
|
|
6249
|
+
* any other user-scoped key that sends it, null included, is forbidden (403)
|
|
6250
|
+
* and nothing is created.
|
|
6206
6251
|
*
|
|
6207
6252
|
*
|
|
6208
6253
|
* **Required scope:**
|
|
@@ -6256,7 +6301,9 @@ export class TimeEntries {
|
|
|
6256
6301
|
* 422 unless confirm_allocation_conflict is sent true. The feature-allocation cap is
|
|
6257
6302
|
* enforced, and because a persisted feature_ids= writes its join rows
|
|
6258
6303
|
* immediately, a rejected save rolls them back within the enclosing
|
|
6259
|
-
* transaction.
|
|
6304
|
+
* transaction. A user-scoped key may send hourly_rate_cents only when its user
|
|
6305
|
+
* is an admin in the entry's company; any other user-scoped key that sends
|
|
6306
|
+
* it, null included, is forbidden (403) and the entry is left unchanged.
|
|
6260
6307
|
*
|
|
6261
6308
|
*
|
|
6262
6309
|
* **Required scope:**
|
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
|
*/
|
|
@@ -1036,7 +1048,7 @@ export type ApprenticeshipProgramEmployerUpdateParameters = {
|
|
|
1036
1048
|
require_timecard_allocation?: boolean;
|
|
1037
1049
|
};
|
|
1038
1050
|
/**
|
|
1039
|
-
* 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.
|
|
1040
1052
|
*/
|
|
1041
1053
|
export type ApprenticeshipWageSchedulePeriodParameters = {
|
|
1042
1054
|
/**
|
|
@@ -1067,9 +1079,17 @@ export type ApprenticeshipWageSchedulePeriodParameters = {
|
|
|
1067
1079
|
* Wage rate for this period, in cents; denominated in the parent schedule's wage_unit. Required.
|
|
1068
1080
|
*/
|
|
1069
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;
|
|
1070
1090
|
};
|
|
1071
1091
|
/**
|
|
1072
|
-
* 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.
|
|
1073
1093
|
*/
|
|
1074
1094
|
export type ApprenticeshipWageSchedulePeriodUpdateParameters = {
|
|
1075
1095
|
/**
|
|
@@ -1100,6 +1120,14 @@ export type ApprenticeshipWageSchedulePeriodUpdateParameters = {
|
|
|
1100
1120
|
* Wage rate for this period, in cents; omit to leave it unchanged.
|
|
1101
1121
|
*/
|
|
1102
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;
|
|
1103
1131
|
};
|
|
1104
1132
|
/**
|
|
1105
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.
|
|
@@ -1129,6 +1157,10 @@ export type ApprenticeshipWageScheduleParameters = {
|
|
|
1129
1157
|
* The journeyworker wage to progress toward, in cents; denominated in journeyworker_wage_unit; optional, defaults to 0.
|
|
1130
1158
|
*/
|
|
1131
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;
|
|
1132
1164
|
/**
|
|
1133
1165
|
* Wage at the end of the progression (100% of the journeyworker wage), in cents; denominated in wage_unit; optional, defaults to 0.
|
|
1134
1166
|
*/
|
|
@@ -1169,6 +1201,14 @@ export type ApprenticeshipWageScheduleParameters = {
|
|
|
1169
1201
|
* Wage rate for this period, in cents; denominated in the parent schedule's wage_unit. Required.
|
|
1170
1202
|
*/
|
|
1171
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;
|
|
1172
1212
|
/**
|
|
1173
1213
|
* Set to true, together with the period's id, to remove that period from the schedule.
|
|
1174
1214
|
*/
|
|
@@ -1203,6 +1243,10 @@ export type ApprenticeshipWageScheduleUpdateParameters = {
|
|
|
1203
1243
|
* Journeyworker wage to progress toward, in cents; omit to leave it unchanged.
|
|
1204
1244
|
*/
|
|
1205
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;
|
|
1206
1250
|
/**
|
|
1207
1251
|
* Wage at the end of the progression, in cents; omit to leave it unchanged.
|
|
1208
1252
|
*/
|
|
@@ -1251,6 +1295,14 @@ export type ApprenticeshipWageScheduleUpdateParameters = {
|
|
|
1251
1295
|
* Wage rate for this period, in cents; omit to leave it unchanged.
|
|
1252
1296
|
*/
|
|
1253
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;
|
|
1254
1306
|
/**
|
|
1255
1307
|
* Set to true, together with the period's id, to remove that period from the schedule.
|
|
1256
1308
|
*/
|
|
@@ -1545,7 +1597,7 @@ export type PeopleEmploymentCreateParameters = {
|
|
|
1545
1597
|
employer_combined_savings_cents?: string | null;
|
|
1546
1598
|
};
|
|
1547
1599
|
/**
|
|
1548
|
-
* 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.
|
|
1549
1601
|
*/
|
|
1550
1602
|
export type PeopleEmploymentScheduledChangeCreateParameters = {
|
|
1551
1603
|
/**
|
|
@@ -1597,12 +1649,12 @@ export type PeopleEmploymentScheduledChangeCreateParameters = {
|
|
|
1597
1649
|
*/
|
|
1598
1650
|
companies_department_id?: string | null;
|
|
1599
1651
|
/**
|
|
1600
|
-
* Company-local date when the new boundary takes effect.
|
|
1652
|
+
* Company-local date when the new boundary takes effect. Today and past dates must fall inside the latest version, before termination. Required.
|
|
1601
1653
|
*/
|
|
1602
1654
|
effective_date: string;
|
|
1603
1655
|
};
|
|
1604
1656
|
/**
|
|
1605
|
-
* 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.
|
|
1606
1658
|
*/
|
|
1607
1659
|
export type PeopleEmploymentScheduledChangeUpdateParameters = {
|
|
1608
1660
|
/**
|
|
@@ -4903,7 +4955,7 @@ export type TimeEntryParameters = {
|
|
|
4903
4955
|
*/
|
|
4904
4956
|
description?: string | null;
|
|
4905
4957
|
/**
|
|
4906
|
-
* 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.
|
|
4907
4959
|
*/
|
|
4908
4960
|
hourly_rate_cents?: string | null;
|
|
4909
4961
|
/**
|
|
@@ -5726,7 +5778,7 @@ export type AggregateTimeImportResponseObject = {
|
|
|
5726
5778
|
/**
|
|
5727
5779
|
* Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
|
|
5728
5780
|
*/
|
|
5729
|
-
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded';
|
|
5781
|
+
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded' | 'withdrawn';
|
|
5730
5782
|
/**
|
|
5731
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.
|
|
5732
5784
|
*/
|
|
@@ -5776,7 +5828,7 @@ export type DsptchCprImportResponseObject = {
|
|
|
5776
5828
|
/**
|
|
5777
5829
|
* Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
|
|
5778
5830
|
*/
|
|
5779
|
-
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded';
|
|
5831
|
+
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded' | 'withdrawn';
|
|
5780
5832
|
/**
|
|
5781
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.
|
|
5782
5834
|
*/
|
|
@@ -5826,7 +5878,7 @@ export type PaystubImportResponseObject = {
|
|
|
5826
5878
|
/**
|
|
5827
5879
|
* Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
|
|
5828
5880
|
*/
|
|
5829
|
-
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded';
|
|
5881
|
+
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded' | 'withdrawn';
|
|
5830
5882
|
/**
|
|
5831
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.
|
|
5832
5884
|
*/
|
|
@@ -5876,7 +5928,7 @@ export type TimeEntryImportResponseObject = {
|
|
|
5876
5928
|
/**
|
|
5877
5929
|
* Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
|
|
5878
5930
|
*/
|
|
5879
|
-
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded';
|
|
5931
|
+
status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded' | 'withdrawn';
|
|
5880
5932
|
/**
|
|
5881
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.
|
|
5882
5934
|
*/
|
|
@@ -8963,11 +9015,11 @@ export type FormAssignmentTaskResponseObject = Array<{
|
|
|
8963
9015
|
}>;
|
|
8964
9016
|
}>;
|
|
8965
9017
|
/**
|
|
8966
|
-
* 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.
|
|
8967
9019
|
*/
|
|
8968
9020
|
export type CertificationParameters = {
|
|
8969
9021
|
/**
|
|
8970
|
-
* 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.
|
|
8971
9023
|
*/
|
|
8972
9024
|
company_id: string;
|
|
8973
9025
|
/**
|
|
@@ -8988,13 +9040,9 @@ export type CertificationParameters = {
|
|
|
8988
9040
|
duration?: string | null;
|
|
8989
9041
|
};
|
|
8990
9042
|
/**
|
|
8991
|
-
* 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.
|
|
8992
9044
|
*/
|
|
8993
9045
|
export type CertificationUpdateParameters = {
|
|
8994
|
-
/**
|
|
8995
|
-
* 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.
|
|
8996
|
-
*/
|
|
8997
|
-
company_id?: string;
|
|
8998
9046
|
/**
|
|
8999
9047
|
* Name of the certification (for example "OSHA 30" or a GWO training module). Unique within the company.
|
|
9000
9048
|
*/
|
|
@@ -9065,7 +9113,7 @@ export type CertificationPackageResponseObject = {
|
|
|
9065
9113
|
updated_at: string;
|
|
9066
9114
|
};
|
|
9067
9115
|
/**
|
|
9068
|
-
* 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.
|
|
9069
9117
|
*/
|
|
9070
9118
|
export type CertificationPackageParameters = {
|
|
9071
9119
|
/**
|
|
@@ -9077,7 +9125,7 @@ export type CertificationPackageParameters = {
|
|
|
9077
9125
|
*/
|
|
9078
9126
|
description?: string | null;
|
|
9079
9127
|
/**
|
|
9080
|
-
* 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.
|
|
9081
9129
|
*/
|
|
9082
9130
|
certification_ids?: Array<string>;
|
|
9083
9131
|
/**
|
|
@@ -9086,7 +9134,7 @@ export type CertificationPackageParameters = {
|
|
|
9086
9134
|
performed_by_user_id: string;
|
|
9087
9135
|
};
|
|
9088
9136
|
/**
|
|
9089
|
-
* 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.
|
|
9090
9138
|
*/
|
|
9091
9139
|
export type CertificationPackageUpdateParameters = {
|
|
9092
9140
|
/**
|
|
@@ -9098,7 +9146,7 @@ export type CertificationPackageUpdateParameters = {
|
|
|
9098
9146
|
*/
|
|
9099
9147
|
description?: string | null;
|
|
9100
9148
|
/**
|
|
9101
|
-
* 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.
|
|
9102
9150
|
*/
|
|
9103
9151
|
certification_ids?: Array<string>;
|
|
9104
9152
|
/**
|
|
@@ -13213,6 +13261,10 @@ export type CreatePeriodData = {
|
|
|
13213
13261
|
url: '/api/v1/apprenticeship/wage_schedules/{wage_schedule_id}/periods';
|
|
13214
13262
|
};
|
|
13215
13263
|
export type CreatePeriodErrors = {
|
|
13264
|
+
/**
|
|
13265
|
+
* Bad Request
|
|
13266
|
+
*/
|
|
13267
|
+
400: Problem;
|
|
13216
13268
|
/**
|
|
13217
13269
|
* Forbidden
|
|
13218
13270
|
*/
|
|
@@ -13240,6 +13292,10 @@ export type UpdatePeriodData = {
|
|
|
13240
13292
|
url: '/api/v1/apprenticeship/wage_schedules/{wage_schedule_id}/periods/{id}';
|
|
13241
13293
|
};
|
|
13242
13294
|
export type UpdatePeriodErrors = {
|
|
13295
|
+
/**
|
|
13296
|
+
* Bad Request
|
|
13297
|
+
*/
|
|
13298
|
+
400: Problem;
|
|
13243
13299
|
/**
|
|
13244
13300
|
* Forbidden
|
|
13245
13301
|
*/
|
|
@@ -13248,6 +13304,10 @@ export type UpdatePeriodErrors = {
|
|
|
13248
13304
|
* Not Found
|
|
13249
13305
|
*/
|
|
13250
13306
|
404: Problem;
|
|
13307
|
+
/**
|
|
13308
|
+
* Unprocessable Content
|
|
13309
|
+
*/
|
|
13310
|
+
422: Problem;
|
|
13251
13311
|
};
|
|
13252
13312
|
export type UpdatePeriodError = UpdatePeriodErrors[keyof UpdatePeriodErrors];
|
|
13253
13313
|
export type UpdatePeriodResponses = {
|
|
@@ -13321,6 +13381,10 @@ export type CreateWageScheduleData = {
|
|
|
13321
13381
|
url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules';
|
|
13322
13382
|
};
|
|
13323
13383
|
export type CreateWageScheduleErrors = {
|
|
13384
|
+
/**
|
|
13385
|
+
* Bad Request
|
|
13386
|
+
*/
|
|
13387
|
+
400: Problem;
|
|
13324
13388
|
/**
|
|
13325
13389
|
* Forbidden
|
|
13326
13390
|
*/
|
|
@@ -13348,6 +13412,10 @@ export type UpdateWageScheduleData = {
|
|
|
13348
13412
|
url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules/{id}';
|
|
13349
13413
|
};
|
|
13350
13414
|
export type UpdateWageScheduleErrors = {
|
|
13415
|
+
/**
|
|
13416
|
+
* Bad Request
|
|
13417
|
+
*/
|
|
13418
|
+
400: Problem;
|
|
13351
13419
|
/**
|
|
13352
13420
|
* Forbidden
|
|
13353
13421
|
*/
|
|
@@ -16143,13 +16211,17 @@ export type CreatePackageData = {
|
|
|
16143
16211
|
};
|
|
16144
16212
|
export type CreatePackageErrors = {
|
|
16145
16213
|
/**
|
|
16146
|
-
* Bad Request
|
|
16214
|
+
* Bad Request
|
|
16147
16215
|
*/
|
|
16148
16216
|
400: Problem;
|
|
16149
16217
|
/**
|
|
16150
16218
|
* Forbidden
|
|
16151
16219
|
*/
|
|
16152
16220
|
403: Problem;
|
|
16221
|
+
/**
|
|
16222
|
+
* Not Found
|
|
16223
|
+
*/
|
|
16224
|
+
404: Problem;
|
|
16153
16225
|
/**
|
|
16154
16226
|
* Unprocessable Content
|
|
16155
16227
|
*/
|
|
@@ -16224,6 +16296,10 @@ export type UpdatePackageData = {
|
|
|
16224
16296
|
url: '/api/v1/certifications/packages/{id}';
|
|
16225
16297
|
};
|
|
16226
16298
|
export type UpdatePackageErrors = {
|
|
16299
|
+
/**
|
|
16300
|
+
* Bad Request
|
|
16301
|
+
*/
|
|
16302
|
+
400: Problem;
|
|
16227
16303
|
/**
|
|
16228
16304
|
* Forbidden
|
|
16229
16305
|
*/
|
|
@@ -16520,6 +16596,10 @@ export type UpdateCertificationData = {
|
|
|
16520
16596
|
url: '/api/v1/certifications/{id}';
|
|
16521
16597
|
};
|
|
16522
16598
|
export type UpdateCertificationErrors = {
|
|
16599
|
+
/**
|
|
16600
|
+
* Bad Request
|
|
16601
|
+
*/
|
|
16602
|
+
400: Problem;
|
|
16523
16603
|
/**
|
|
16524
16604
|
* Forbidden
|
|
16525
16605
|
*/
|
|
@@ -16610,6 +16690,62 @@ export type CreateDepartmentResponses = {
|
|
|
16610
16690
|
201: DepartmentResponseObject;
|
|
16611
16691
|
};
|
|
16612
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];
|
|
16613
16749
|
export type UpdateDepartmentData = {
|
|
16614
16750
|
body: DepartmentUpdateParameters;
|
|
16615
16751
|
path: {
|
|
@@ -18429,6 +18565,14 @@ export type ListJobsData = {
|
|
|
18429
18565
|
* Returns jobs whose production_tracking_kind matches. One of `none`, `feature`, or `quantity`.
|
|
18430
18566
|
*/
|
|
18431
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;
|
|
18432
18576
|
/**
|
|
18433
18577
|
* This pagination cursor corresponds to the cursor value found in the response in
|
|
18434
18578
|
* `meta.page.next_cursor`.
|
|
@@ -19931,6 +20075,7 @@ export type ListAggregateTimeImportsData = {
|
|
|
19931
20075
|
* * `success`
|
|
19932
20076
|
* * `failed`
|
|
19933
20077
|
* * `superseded`
|
|
20078
|
+
* * `withdrawn`
|
|
19934
20079
|
*
|
|
19935
20080
|
*/
|
|
19936
20081
|
'filter[status]'?: string;
|
|
@@ -20060,6 +20205,7 @@ export type ListDsptchCprImportsData = {
|
|
|
20060
20205
|
* * `success`
|
|
20061
20206
|
* * `failed`
|
|
20062
20207
|
* * `superseded`
|
|
20208
|
+
* * `withdrawn`
|
|
20063
20209
|
*
|
|
20064
20210
|
*/
|
|
20065
20211
|
'filter[status]'?: string;
|
|
@@ -20189,6 +20335,7 @@ export type ListTimeEntryImportsData = {
|
|
|
20189
20335
|
* * `success`
|
|
20190
20336
|
* * `failed`
|
|
20191
20337
|
* * `superseded`
|
|
20338
|
+
* * `withdrawn`
|
|
20192
20339
|
*
|
|
20193
20340
|
*/
|
|
20194
20341
|
'filter[status]'?: string;
|
|
@@ -20712,6 +20859,7 @@ export type ListPaystubImportsData = {
|
|
|
20712
20859
|
* * `success`
|
|
20713
20860
|
* * `failed`
|
|
20714
20861
|
* * `superseded`
|
|
20862
|
+
* * `withdrawn`
|
|
20715
20863
|
*
|
|
20716
20864
|
*/
|
|
20717
20865
|
'filter[status]'?: string;
|
|
@@ -21620,7 +21768,7 @@ export type DeleteEmploymentScheduledChangeData = {
|
|
|
21620
21768
|
*/
|
|
21621
21769
|
employment_id: string;
|
|
21622
21770
|
/**
|
|
21623
|
-
* The existing
|
|
21771
|
+
* The existing exact boundary, as a company-local date.
|
|
21624
21772
|
*/
|
|
21625
21773
|
effective_date: string;
|
|
21626
21774
|
};
|
|
@@ -21667,7 +21815,7 @@ export type UpdateEmploymentScheduledChangeData = {
|
|
|
21667
21815
|
*/
|
|
21668
21816
|
employment_id: string;
|
|
21669
21817
|
/**
|
|
21670
|
-
* The existing
|
|
21818
|
+
* The existing exact boundary, as a company-local date.
|
|
21671
21819
|
*/
|
|
21672
21820
|
effective_date: string;
|
|
21673
21821
|
};
|