@dsptch-work/api-client 0.11.0 → 0.12.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 +54 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +198 -1
- package/dist/gen/sdk.gen.js +333 -0
- package/dist/gen/types.gen.d.ts +912 -27
- package/dist/gen/zod.gen.d.ts +1154 -176
- package/dist/gen/zod.gen.js +309 -6
- package/package.json +1 -1
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -170,6 +170,12 @@ export type Problem = {
|
|
|
170
170
|
*
|
|
171
171
|
* The resource's timeline already ends at a scheduled termination, and scheduling a second one would silently move it. Moving an end is two steps on purpose: cancel the standing termination, then schedule the one you want.
|
|
172
172
|
*
|
|
173
|
+
* ### product_archived
|
|
174
|
+
*
|
|
175
|
+
* **Product Archived**
|
|
176
|
+
*
|
|
177
|
+
* The item cannot be unarchived while its product is still archived — an item never lives active inside an archived product. Unarchive the product instead, which restores the item along with the rest of the product's holdings.
|
|
178
|
+
*
|
|
173
179
|
* ### recorded_since_termination
|
|
174
180
|
*
|
|
175
181
|
* **Timecode Changed Since Termination**
|
|
@@ -254,9 +260,9 @@ export type Problem = {
|
|
|
254
260
|
*
|
|
255
261
|
* ### invalid_signed_id
|
|
256
262
|
*
|
|
257
|
-
* **
|
|
263
|
+
* **Attachment Upload Not Found**
|
|
258
264
|
*
|
|
259
|
-
* An attachment signed id
|
|
265
|
+
* An attachment signed id names no upload this endpoint can read. A signed id is issued for one `resource` and verifies only there, so an id for a different resource is indistinguishable from one that is malformed, expired, or tampered with, and all of them answer alike. The message names the resource the upload needed; upload the file again to the direct-uploads endpoint naming it, and pass the signed id that call returns.
|
|
260
266
|
*
|
|
261
267
|
* ### non_numeric_cents
|
|
262
268
|
*
|
|
@@ -339,7 +345,7 @@ export type Problem = {
|
|
|
339
345
|
* Another write to the same resource held it for longer than this request was willing to wait, so nothing was applied. The request itself is fine — resend it unchanged after the `Retry-After` window.
|
|
340
346
|
*
|
|
341
347
|
*/
|
|
342
|
-
export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'malformed_body' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'insufficient_api_key_scope' | 'not_found' | 'already_terminated' | 'recorded_since_termination' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'interval_too_wide' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'precondition_required' | 'too_many_requests' | 'internal_error' | 'write_contended';
|
|
348
|
+
export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'malformed_body' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'insufficient_api_key_scope' | 'not_found' | 'already_terminated' | 'product_archived' | 'recorded_since_termination' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'interval_too_wide' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'precondition_required' | 'too_many_requests' | 'internal_error' | 'write_contended';
|
|
343
349
|
export type ApiKeyScopeResponseObject = {
|
|
344
350
|
resource: string;
|
|
345
351
|
action: 'read' | 'create' | 'update' | 'delete';
|
|
@@ -349,6 +355,10 @@ export type ApiKeyScopeResponseObject = {
|
|
|
349
355
|
* Register a file for direct upload — send its metadata to receive a blob plus a one-time URL for uploading the file's bytes to storage.
|
|
350
356
|
*/
|
|
351
357
|
export type DirectUploadParameters = {
|
|
358
|
+
/**
|
|
359
|
+
* What the file is for, named as the endpoint that will attach it (for example `assets.vendors`). Required. It decides where the file is stored, and the signed ID this call returns is issued for that resource alone — it will not resolve at any other endpoint, so a vendor logo cannot be attached as an avatar, or an avatar as a logo.
|
|
360
|
+
*/
|
|
361
|
+
resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'users';
|
|
352
362
|
/**
|
|
353
363
|
* Metadata describing the file being registered, before its bytes are uploaded.
|
|
354
364
|
*/
|
|
@@ -424,7 +434,7 @@ export type DirectUploadResponseObject = {
|
|
|
424
434
|
*/
|
|
425
435
|
attachable_sgid: string;
|
|
426
436
|
/**
|
|
427
|
-
* Opaque signed reference to this blob
|
|
437
|
+
* Opaque signed reference to this blob. Pass it to the endpoint for the resource this upload named, in that endpoint's signed-ID property — `file` for an attachment or a document, `avatar_signed_id` for a user, `logo_signed_id` for a vendor — to attach the uploaded file to a record. No endpoint reads a property literally named signed_id. Expires one week after it is issued — register the file again to get a fresh one.
|
|
428
438
|
*/
|
|
429
439
|
signed_id: string;
|
|
430
440
|
/**
|
|
@@ -1905,10 +1915,6 @@ export type TimeCardPerDiemParameters = {
|
|
|
1905
1915
|
* ID of the catalog per diem to record; its rate, currency, and taxable flag are copied onto the entry. Required.
|
|
1906
1916
|
*/
|
|
1907
1917
|
per_diem_id: string;
|
|
1908
|
-
/**
|
|
1909
|
-
* Accepted but ignored — the taxable flag is derived from the referenced catalog per diem.
|
|
1910
|
-
*/
|
|
1911
|
-
taxable?: boolean;
|
|
1912
1918
|
};
|
|
1913
1919
|
/**
|
|
1914
1920
|
* A holiday on a pay schedule's holiday calendar — a fixed (month + day) or floating (nth weekday of a month) date that gets holiday-pay treatment when a time entry's timecode opts into holiday handling.
|
|
@@ -7349,6 +7355,10 @@ export type FederalJobWageDeterminationResponseObject = {
|
|
|
7349
7355
|
* UUID of the craft grouping (trade) this determination pools into for apprenticeship-ratio tracking; obtain one from the job or project PWA trades endpoint before assigning it here.
|
|
7350
7356
|
*/
|
|
7351
7357
|
pwa_trade_id: string;
|
|
7358
|
+
/**
|
|
7359
|
+
* ID of the overtime package whose rules apply to this determination, or null when none is set.
|
|
7360
|
+
*/
|
|
7361
|
+
overtime_package_id: string | null;
|
|
7352
7362
|
/**
|
|
7353
7363
|
* Determination type — the Federal or Regional subtype (an STI class name). Federal carries a DOL class code and construction category; Regional carries the nested regional_fields object.
|
|
7354
7364
|
*/
|
|
@@ -7410,6 +7420,10 @@ export type RegionalJobWageDeterminationResponseObject = {
|
|
|
7410
7420
|
* UUID of the craft grouping (trade) this determination pools into for apprenticeship-ratio tracking; obtain one from the job or project PWA trades endpoint before assigning it here.
|
|
7411
7421
|
*/
|
|
7412
7422
|
pwa_trade_id: string;
|
|
7423
|
+
/**
|
|
7424
|
+
* ID of the overtime package whose rules apply to this determination, or null when none is set.
|
|
7425
|
+
*/
|
|
7426
|
+
overtime_package_id: string | null;
|
|
7413
7427
|
/**
|
|
7414
7428
|
* Determination type — the Federal or Regional subtype (an STI class name). Federal carries a DOL class code and construction category; Regional carries the nested regional_fields object.
|
|
7415
7429
|
*/
|
|
@@ -7460,6 +7474,7 @@ export type FederalJobWageDeterminationHistoryVersionObject = {
|
|
|
7460
7474
|
job_wage_determination_id: string;
|
|
7461
7475
|
job_id: string;
|
|
7462
7476
|
pwa_trade_id: string;
|
|
7477
|
+
overtime_package_id: string | null;
|
|
7463
7478
|
type: 'Pwa::JobWageDeterminations::Federal';
|
|
7464
7479
|
labor_classification: string;
|
|
7465
7480
|
hourly_rate_cents: string;
|
|
@@ -7481,6 +7496,7 @@ export type RegionalJobWageDeterminationHistoryVersionObject = {
|
|
|
7481
7496
|
job_wage_determination_id: string;
|
|
7482
7497
|
job_id: string;
|
|
7483
7498
|
pwa_trade_id: string;
|
|
7499
|
+
overtime_package_id: string | null;
|
|
7484
7500
|
type: 'Pwa::JobWageDeterminations::Regional';
|
|
7485
7501
|
labor_classification: string;
|
|
7486
7502
|
hourly_rate_cents: string;
|
|
@@ -7506,6 +7522,7 @@ export type FederalJobWageDeterminationHistoryCorrectionObject = {
|
|
|
7506
7522
|
job_wage_determination_id: string;
|
|
7507
7523
|
job_id: string;
|
|
7508
7524
|
pwa_trade_id: string;
|
|
7525
|
+
overtime_package_id: string | null;
|
|
7509
7526
|
type: 'Pwa::JobWageDeterminations::Federal';
|
|
7510
7527
|
labor_classification: string;
|
|
7511
7528
|
hourly_rate_cents: string;
|
|
@@ -7525,6 +7542,7 @@ export type RegionalJobWageDeterminationHistoryCorrectionObject = {
|
|
|
7525
7542
|
job_wage_determination_id: string;
|
|
7526
7543
|
job_id: string;
|
|
7527
7544
|
pwa_trade_id: string;
|
|
7545
|
+
overtime_package_id: string | null;
|
|
7528
7546
|
type: 'Pwa::JobWageDeterminations::Regional';
|
|
7529
7547
|
labor_classification: string;
|
|
7530
7548
|
hourly_rate_cents: string;
|
|
@@ -7612,7 +7630,7 @@ export type RegionalWageDeterminationFieldsResponse = {
|
|
|
7612
7630
|
[key: string]: string | null;
|
|
7613
7631
|
};
|
|
7614
7632
|
/**
|
|
7615
|
-
* Parameters for creating a job wage determination. Provide the Federal or Regional shape; the type discriminator selects which.
|
|
7633
|
+
* Parameters for creating a job wage determination. Provide the Federal or Regional shape; the type discriminator selects which. Editing an existing determination uses the update parameters, which take an `effective_from` instead of a type.
|
|
7616
7634
|
*/
|
|
7617
7635
|
export type JobWageDeterminationParameters = ({
|
|
7618
7636
|
type: 'Pwa::JobWageDeterminations::Federal';
|
|
@@ -7686,6 +7704,100 @@ export type RegionalJobWageDeterminationParameters = {
|
|
|
7686
7704
|
general_wage_determination?: string | null;
|
|
7687
7705
|
regional_fields?: RegionalWageDeterminationFields;
|
|
7688
7706
|
};
|
|
7707
|
+
/**
|
|
7708
|
+
* Parameters for editing a job wage determination from a point in valid time forward. The type is fixed by the determination the id names and is not sent.
|
|
7709
|
+
*/
|
|
7710
|
+
export type JobWageDeterminationUpdateParameters = {
|
|
7711
|
+
/**
|
|
7712
|
+
* Where the edit starts applying, as a calendar date (`YYYY-MM-DD`); a value carrying a time component is refused with `422` rather than truncated. Every version from this date forward takes the new values; earlier versions are untouched. Optional; defaults to the start of the version valid now, which corrects that version in place.
|
|
7713
|
+
*/
|
|
7714
|
+
effective_from?: string;
|
|
7715
|
+
/**
|
|
7716
|
+
* Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
|
|
7717
|
+
*/
|
|
7718
|
+
labor_classification?: string;
|
|
7719
|
+
/**
|
|
7720
|
+
* UUID of the craft grouping (trade) this determination pools into for apprenticeship-ratio tracking; obtain one from the job or project PWA trades endpoint before assigning it here.
|
|
7721
|
+
*/
|
|
7722
|
+
pwa_trade_id?: string;
|
|
7723
|
+
/**
|
|
7724
|
+
* Base hourly wage rate, in cents as a decimal string (e.g. "5380.0" is $53.80).
|
|
7725
|
+
*/
|
|
7726
|
+
hourly_rate_cents?: string;
|
|
7727
|
+
/**
|
|
7728
|
+
* Hourly fringe rate, in cents as a decimal string (e.g. "1200.0" is $12.00).
|
|
7729
|
+
*/
|
|
7730
|
+
fringe_rate_cents?: string;
|
|
7731
|
+
/**
|
|
7732
|
+
* The DOL wage-classification code identifying this classification within its general decision (e.g. "LABO0324-014"); null when not recorded.
|
|
7733
|
+
*/
|
|
7734
|
+
class_code?: string | null;
|
|
7735
|
+
/**
|
|
7736
|
+
* Broad DOL construction category — one of building, heavy, highway, or residential; null when not recorded.
|
|
7737
|
+
*/
|
|
7738
|
+
construction_category?: 'building' | 'heavy' | 'highway' | 'residential' | null;
|
|
7739
|
+
/**
|
|
7740
|
+
* The DOL general wage determination the rates are drawn from — the general decision number plus its revision (e.g. "CA20230001/5"); null when not recorded.
|
|
7741
|
+
*/
|
|
7742
|
+
general_wage_determination?: string | null;
|
|
7743
|
+
regional_fields?: RegionalWageDeterminationFields;
|
|
7744
|
+
};
|
|
7745
|
+
/**
|
|
7746
|
+
* Parameters for an effective-dated change to a job wage determination, applying from a calendar date forward. The type is fixed by the determination the id names and is not sent.
|
|
7747
|
+
*/
|
|
7748
|
+
export type JobWageDeterminationScheduledChangeParameters = {
|
|
7749
|
+
/**
|
|
7750
|
+
* Where the change starts applying, as a calendar date (`YYYY-MM-DD`); a value carrying a time component is refused with `422` rather than truncated. A boundary is created at that date when needed, and the new values apply from there forward, carrying through every later version already scheduled. Past, current, and future dates are all accepted, so long as the date falls on or after the determination's timeline begins and before any scheduled termination. A date already reached reconciles derived pay data immediately; a date still ahead reconciles at that date.
|
|
7751
|
+
*/
|
|
7752
|
+
effective_date: string;
|
|
7753
|
+
/**
|
|
7754
|
+
* Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
|
|
7755
|
+
*/
|
|
7756
|
+
labor_classification?: string;
|
|
7757
|
+
/**
|
|
7758
|
+
* UUID of the craft grouping (trade) this determination pools into for apprenticeship-ratio tracking; obtain one from the job or project PWA trades endpoint before assigning it here.
|
|
7759
|
+
*/
|
|
7760
|
+
pwa_trade_id?: string;
|
|
7761
|
+
/**
|
|
7762
|
+
* Base hourly wage rate, in cents as a decimal string (e.g. "5380.0" is $53.80).
|
|
7763
|
+
*/
|
|
7764
|
+
hourly_rate_cents?: string;
|
|
7765
|
+
/**
|
|
7766
|
+
* Hourly fringe rate, in cents as a decimal string (e.g. "1200.0" is $12.00).
|
|
7767
|
+
*/
|
|
7768
|
+
fringe_rate_cents?: string;
|
|
7769
|
+
/**
|
|
7770
|
+
* The DOL wage-classification code identifying this classification within its general decision (e.g. "LABO0324-014"); null when not recorded.
|
|
7771
|
+
*/
|
|
7772
|
+
class_code?: string | null;
|
|
7773
|
+
/**
|
|
7774
|
+
* Broad DOL construction category — one of building, heavy, highway, or residential; null when not recorded.
|
|
7775
|
+
*/
|
|
7776
|
+
construction_category?: 'building' | 'heavy' | 'highway' | 'residential' | null;
|
|
7777
|
+
/**
|
|
7778
|
+
* The DOL general wage determination the rates are drawn from — the general decision number plus its revision (e.g. "CA20230001/5"); null when not recorded.
|
|
7779
|
+
*/
|
|
7780
|
+
general_wage_determination?: string | null;
|
|
7781
|
+
regional_fields?: RegionalWageDeterminationFields;
|
|
7782
|
+
};
|
|
7783
|
+
/**
|
|
7784
|
+
* Parameters for moving where a job wage determination's timeline begins.
|
|
7785
|
+
*/
|
|
7786
|
+
export type JobWageDeterminationGenesisParameters = {
|
|
7787
|
+
/**
|
|
7788
|
+
* The timeline's new start, as a calendar date (`YYYY-MM-DD`); a value carrying a time component is refused with `422` rather than truncated. Moving it earlier extends the first version back to it. Moving it later drops every version whose coverage ended at or before it and truncates the one spanning it, so what those versions said stops being readable. Refused with `422` when the new start would fall at or after a scheduled termination.
|
|
7789
|
+
*/
|
|
7790
|
+
effective_date: string;
|
|
7791
|
+
};
|
|
7792
|
+
/**
|
|
7793
|
+
* Parameters for scheduling when a job wage determination stops being valid.
|
|
7794
|
+
*/
|
|
7795
|
+
export type JobWageDeterminationScheduledTerminationParameters = {
|
|
7796
|
+
/**
|
|
7797
|
+
* When the determination stops being valid, as a calendar date (`YYYY-MM-DD`); a value carrying a time component is refused with `422` rather than truncated. Segments beyond it are dropped and one spanning it is truncated. Must fall after the determination's genesis and on or before its current end. A determination holds at most one scheduled termination; cancel the standing one before scheduling another.
|
|
7798
|
+
*/
|
|
7799
|
+
effective_date: string;
|
|
7800
|
+
};
|
|
7689
7801
|
/**
|
|
7690
7802
|
* The adjustment applied when a rule matches — an addition to the wage or fringe rate.
|
|
7691
7803
|
*/
|
|
@@ -8042,6 +8154,10 @@ export type AssetsItemParameters = {
|
|
|
8042
8154
|
* Optional, create only. Place the new item inside this container item. Mutually exclusive with assets_site_id and user_id.
|
|
8043
8155
|
*/
|
|
8044
8156
|
container_item_id?: string;
|
|
8157
|
+
/**
|
|
8158
|
+
* Optional, create only. The storage location within the placement site or container the item lands in; must belong to that holder. Omit for an unbinned placement. Ignored for a user assignment.
|
|
8159
|
+
*/
|
|
8160
|
+
assets_sub_location_id?: string;
|
|
8045
8161
|
/**
|
|
8046
8162
|
* ID of the user this write is performed on behalf of — recorded as the item's creator or updater and attributed to any placement. Required; must belong to your company.
|
|
8047
8163
|
*/
|
|
@@ -8324,7 +8440,7 @@ export type AssetsAttachmentParameters = {
|
|
|
8324
8440
|
*/
|
|
8325
8441
|
id?: string;
|
|
8326
8442
|
/**
|
|
8327
|
-
* A signed_id from POST /api/v1/direct_uploads identifying the uploaded blob to attach.
|
|
8443
|
+
* A signed_id from POST /api/v1/direct_uploads identifying the uploaded blob to attach. Register the upload naming the resource of the endpoint you are calling — `assets.items` for item images, `assets.products` for product images, `assets.items.service_events` for service event attachments — because a signed_id issued for any other resource will not resolve here.
|
|
8328
8444
|
*/
|
|
8329
8445
|
file?: string;
|
|
8330
8446
|
/**
|
|
@@ -8399,7 +8515,7 @@ export type AssetsDocumentResponseObject = {
|
|
|
8399
8515
|
*/
|
|
8400
8516
|
export type AssetsDocumentParameters = {
|
|
8401
8517
|
/**
|
|
8402
|
-
* A signed_id from POST /api/v1/direct_uploads identifying the uploaded blob to attach.
|
|
8518
|
+
* A signed_id from POST /api/v1/direct_uploads identifying the uploaded blob to attach. Register the upload naming `assets.items.documents` — a signed_id issued for any other resource will not resolve here.
|
|
8403
8519
|
*/
|
|
8404
8520
|
file: string;
|
|
8405
8521
|
/**
|
|
@@ -8558,7 +8674,7 @@ export type AssetsItemFormAssignmentParameters = {
|
|
|
8558
8674
|
};
|
|
8559
8675
|
};
|
|
8560
8676
|
/**
|
|
8561
|
-
* On-hand stock of an item at a site — one row per item and
|
|
8677
|
+
* On-hand stock of an item at a site — one row per item, site, and storage location. Read-only. A site with none of the item has no row at all, since a row is removed once its count reaches zero.
|
|
8562
8678
|
*/
|
|
8563
8679
|
export type AssetsInventoryResponseObject = {
|
|
8564
8680
|
/**
|
|
@@ -8573,6 +8689,10 @@ export type AssetsInventoryResponseObject = {
|
|
|
8573
8689
|
* ID of the site holding the stock.
|
|
8574
8690
|
*/
|
|
8575
8691
|
assets_site_id: string;
|
|
8692
|
+
/**
|
|
8693
|
+
* ID of the storage location within the site this row's stock sits in; null for the site's unbinned stock. Each storage location keeps its own row.
|
|
8694
|
+
*/
|
|
8695
|
+
assets_sub_location_id: string | null;
|
|
8576
8696
|
/**
|
|
8577
8697
|
* ID of the company that owns this record.
|
|
8578
8698
|
*/
|
|
@@ -8675,6 +8795,10 @@ export type AssetsTransactionEventResponseObject = {
|
|
|
8675
8795
|
* ID of the container item the movement was into or out of; null when the endpoint was a site or user.
|
|
8676
8796
|
*/
|
|
8677
8797
|
container_item_id: string | null;
|
|
8798
|
+
/**
|
|
8799
|
+
* ID of the storage location within the site or container the movement touched; null for an unbinned movement or a custody change.
|
|
8800
|
+
*/
|
|
8801
|
+
assets_sub_location_id: string | null;
|
|
8678
8802
|
/**
|
|
8679
8803
|
* ID of the transfer that produced this transaction; null unless kind is transfer.
|
|
8680
8804
|
*/
|
|
@@ -8989,6 +9113,113 @@ export type AssetsServiceScheduleTemplateParameters = {
|
|
|
8989
9113
|
*/
|
|
8990
9114
|
performed_by_user_id: string;
|
|
8991
9115
|
};
|
|
9116
|
+
/**
|
|
9117
|
+
* A node of fixed storage structure inside a site or a container item — a zone, aisle, rack, shelf, bin, or drawer. Nodes form a tree per holder, and each carries a scannable path_code composed from its ancestors' codes.
|
|
9118
|
+
*/
|
|
9119
|
+
export type AssetsSubLocationResponseObject = {
|
|
9120
|
+
/**
|
|
9121
|
+
* Unique identifier.
|
|
9122
|
+
*/
|
|
9123
|
+
id: string;
|
|
9124
|
+
/**
|
|
9125
|
+
* ID of the company that owns this record.
|
|
9126
|
+
*/
|
|
9127
|
+
company_id: string;
|
|
9128
|
+
/**
|
|
9129
|
+
* ID of the site this location belongs to; null when it belongs to a container item. Exactly one of the two is set, inherited from the parent for nested nodes.
|
|
9130
|
+
*/
|
|
9131
|
+
assets_site_id: string | null;
|
|
9132
|
+
/**
|
|
9133
|
+
* ID of the container item this location belongs to; null when it belongs to a site. Exactly one of the two is set, inherited from the parent for nested nodes.
|
|
9134
|
+
*/
|
|
9135
|
+
container_item_id: string | null;
|
|
9136
|
+
/**
|
|
9137
|
+
* ID of the enclosing location; null for a top-level node of its holder.
|
|
9138
|
+
*/
|
|
9139
|
+
parent_id: string | null;
|
|
9140
|
+
/**
|
|
9141
|
+
* Advisory level label for the node: zone, aisle, rack, shelf, bin, or drawer. Drives display icons only; any nesting order is allowed.
|
|
9142
|
+
*/
|
|
9143
|
+
kind: 'zone' | 'aisle' | 'rack' | 'shelf' | 'bin' | 'drawer' | null;
|
|
9144
|
+
/**
|
|
9145
|
+
* Display name for the location, unique among its siblings (for example "Aisle A").
|
|
9146
|
+
*/
|
|
9147
|
+
name: string;
|
|
9148
|
+
/**
|
|
9149
|
+
* This node's own segment of the path code (for example "A" or "01"); unique among its siblings and free of the "-" separator.
|
|
9150
|
+
*/
|
|
9151
|
+
code: string;
|
|
9152
|
+
/**
|
|
9153
|
+
* The scannable full code — the node's ancestors' codes and its own, joined by "-" (for example "A-01-03"). Recomputed through the subtree when a code changes; unique within the holder.
|
|
9154
|
+
*/
|
|
9155
|
+
path_code: string;
|
|
9156
|
+
/**
|
|
9157
|
+
* When the record was created (ISO 8601).
|
|
9158
|
+
*/
|
|
9159
|
+
created_at: string;
|
|
9160
|
+
/**
|
|
9161
|
+
* When the record was last updated (ISO 8601).
|
|
9162
|
+
*/
|
|
9163
|
+
updated_at: string;
|
|
9164
|
+
};
|
|
9165
|
+
/**
|
|
9166
|
+
* Create a storage location. name and code are required. A top-level node names its holder (assets_site_id or container_item_id, exactly one); a nested node names parent_id and inherits the parent's holder. The holder cannot change after creation.
|
|
9167
|
+
*/
|
|
9168
|
+
export type AssetsSubLocationParameters = {
|
|
9169
|
+
/**
|
|
9170
|
+
* ID of the site the location belongs to. Top-level nodes only — exactly one of assets_site_id or container_item_id; nested nodes inherit the parent's holder.
|
|
9171
|
+
*/
|
|
9172
|
+
assets_site_id?: string;
|
|
9173
|
+
/**
|
|
9174
|
+
* ID of the container item the location belongs to. Top-level nodes only — exactly one of assets_site_id or container_item_id; the container's product must be flagged as a container.
|
|
9175
|
+
*/
|
|
9176
|
+
container_item_id?: string;
|
|
9177
|
+
/**
|
|
9178
|
+
* ID of the enclosing location for a nested node; omit for a top-level node.
|
|
9179
|
+
*/
|
|
9180
|
+
parent_id?: string | null;
|
|
9181
|
+
/**
|
|
9182
|
+
* Advisory level label for the node: zone, aisle, rack, shelf, bin, or drawer.
|
|
9183
|
+
*/
|
|
9184
|
+
kind?: 'zone' | 'aisle' | 'rack' | 'shelf' | 'bin' | 'drawer';
|
|
9185
|
+
/**
|
|
9186
|
+
* Display name for the location, unique among its siblings.
|
|
9187
|
+
*/
|
|
9188
|
+
name: string;
|
|
9189
|
+
/**
|
|
9190
|
+
* This node's own path-code segment; unique among its siblings and free of the "-" separator.
|
|
9191
|
+
*/
|
|
9192
|
+
code: string;
|
|
9193
|
+
};
|
|
9194
|
+
/**
|
|
9195
|
+
* Update a storage location. All fields are optional — send only what changes. The holder fields cannot change after creation; renaming code cascades new path codes through the node's subtree.
|
|
9196
|
+
*/
|
|
9197
|
+
export type AssetsSubLocationUpdateParameters = {
|
|
9198
|
+
/**
|
|
9199
|
+
* ID of the site the location belongs to. Top-level nodes only — exactly one of assets_site_id or container_item_id; nested nodes inherit the parent's holder.
|
|
9200
|
+
*/
|
|
9201
|
+
assets_site_id?: string;
|
|
9202
|
+
/**
|
|
9203
|
+
* ID of the container item the location belongs to. Top-level nodes only — exactly one of assets_site_id or container_item_id; the container's product must be flagged as a container.
|
|
9204
|
+
*/
|
|
9205
|
+
container_item_id?: string;
|
|
9206
|
+
/**
|
|
9207
|
+
* ID of the enclosing location for a nested node; omit for a top-level node.
|
|
9208
|
+
*/
|
|
9209
|
+
parent_id?: string | null;
|
|
9210
|
+
/**
|
|
9211
|
+
* Advisory level label for the node: zone, aisle, rack, shelf, bin, or drawer.
|
|
9212
|
+
*/
|
|
9213
|
+
kind?: 'zone' | 'aisle' | 'rack' | 'shelf' | 'bin' | 'drawer';
|
|
9214
|
+
/**
|
|
9215
|
+
* Display name for the location, unique among its siblings.
|
|
9216
|
+
*/
|
|
9217
|
+
name?: string;
|
|
9218
|
+
/**
|
|
9219
|
+
* This node's own path-code segment; unique among its siblings and free of the "-" separator.
|
|
9220
|
+
*/
|
|
9221
|
+
code?: string;
|
|
9222
|
+
};
|
|
8992
9223
|
/**
|
|
8993
9224
|
* A completed movement of item stock between two holders, each a site, a user, or a container. Each line moves one item; applying the transfer records paired outbound and inbound transactions and updates the on-hand, custody, and containment counts. Transfers created through this API are always completed. One-sided moves (placing or removing an item with only one endpoint) record transactions but no transfer, and so are not represented by this resource.
|
|
8994
9225
|
*/
|
|
@@ -9029,6 +9260,14 @@ export type AssetsTransferResponseObject = {
|
|
|
9029
9260
|
* ID of the destination container item; null when the destination is a site or user.
|
|
9030
9261
|
*/
|
|
9031
9262
|
to_container_item_id: string | null;
|
|
9263
|
+
/**
|
|
9264
|
+
* ID of the storage location within the source site or container the stock drew from; null for an unbinned source or a user source.
|
|
9265
|
+
*/
|
|
9266
|
+
from_assets_sub_location_id: string | null;
|
|
9267
|
+
/**
|
|
9268
|
+
* ID of the storage location within the destination site or container the stock landed in; null for an unbinned destination or a user destination.
|
|
9269
|
+
*/
|
|
9270
|
+
to_assets_sub_location_id: string | null;
|
|
9032
9271
|
/**
|
|
9033
9272
|
* ID of the user the transfer was performed on behalf of.
|
|
9034
9273
|
*/
|
|
@@ -9091,6 +9330,14 @@ export type AssetsTransferParameters = {
|
|
|
9091
9330
|
* ID of the destination container item. At most one destination endpoint (site, user, or container).
|
|
9092
9331
|
*/
|
|
9093
9332
|
to_container_item_id?: string;
|
|
9333
|
+
/**
|
|
9334
|
+
* Optional. The storage location within the source site or container the stock draws from; must belong to that endpoint. Omit for the source's unbinned stock.
|
|
9335
|
+
*/
|
|
9336
|
+
from_assets_sub_location_id?: string;
|
|
9337
|
+
/**
|
|
9338
|
+
* Optional. The storage location within the destination site or container the stock lands in; must belong to that endpoint. Omit for an unbinned destination.
|
|
9339
|
+
*/
|
|
9340
|
+
to_assets_sub_location_id?: string;
|
|
9094
9341
|
/**
|
|
9095
9342
|
* ID of the user this move is performed on behalf of, recorded as its initiator. Required; must belong to your company.
|
|
9096
9343
|
*/
|
|
@@ -9117,6 +9364,10 @@ export type AssetsRestockParameters = {
|
|
|
9117
9364
|
* ID of the site to add the stock to.
|
|
9118
9365
|
*/
|
|
9119
9366
|
assets_site_id: string;
|
|
9367
|
+
/**
|
|
9368
|
+
* Optional. The site's storage location the stock lands in; must belong to the site. Omit for the site's unbinned stock.
|
|
9369
|
+
*/
|
|
9370
|
+
assets_sub_location_id?: string;
|
|
9120
9371
|
/**
|
|
9121
9372
|
* Number of units to add; greater than 0.
|
|
9122
9373
|
*/
|
|
@@ -9134,6 +9385,10 @@ export type AssetsAdjustmentParameters = {
|
|
|
9134
9385
|
* ID of the site whose on-hand count is being set.
|
|
9135
9386
|
*/
|
|
9136
9387
|
assets_site_id: string;
|
|
9388
|
+
/**
|
|
9389
|
+
* Optional. The site's storage location whose count is being set; must belong to the site. Omit to set the site's unbinned count.
|
|
9390
|
+
*/
|
|
9391
|
+
assets_sub_location_id?: string;
|
|
9137
9392
|
/**
|
|
9138
9393
|
* The corrected on-hand count for the site; 0 or greater. The difference from the current count is recorded as the adjustment.
|
|
9139
9394
|
*/
|
|
@@ -9143,6 +9398,15 @@ export type AssetsAdjustmentParameters = {
|
|
|
9143
9398
|
*/
|
|
9144
9399
|
performed_by_user_id: string;
|
|
9145
9400
|
};
|
|
9401
|
+
/**
|
|
9402
|
+
* Archive or unarchive a product or item. Archiving takes it out of circulation without deleting it — history is preserved and it is hidden from listings unless requested with filter[state]. Archiving a product cascades to its items; item operations apply to serial items only.
|
|
9403
|
+
*/
|
|
9404
|
+
export type AssetsArchiveParameters = {
|
|
9405
|
+
/**
|
|
9406
|
+
* ID of the user this archive or unarchive is performed on behalf of, recorded for auditing. Required; must belong to your company.
|
|
9407
|
+
*/
|
|
9408
|
+
performed_by_user_id: string;
|
|
9409
|
+
};
|
|
9146
9410
|
export type ListApiKeyScopesData = {
|
|
9147
9411
|
body?: never;
|
|
9148
9412
|
path?: never;
|
|
@@ -10539,6 +10803,10 @@ export type CreateItemErrors = {
|
|
|
10539
10803
|
* Forbidden
|
|
10540
10804
|
*/
|
|
10541
10805
|
403: Problem;
|
|
10806
|
+
/**
|
|
10807
|
+
* Not Found
|
|
10808
|
+
*/
|
|
10809
|
+
404: Problem;
|
|
10542
10810
|
/**
|
|
10543
10811
|
* Unprocessable Content (conflicting placement)
|
|
10544
10812
|
*/
|
|
@@ -10618,6 +10886,62 @@ export type UpdateItemResponses = {
|
|
|
10618
10886
|
200: AssetsItemResponseObject;
|
|
10619
10887
|
};
|
|
10620
10888
|
export type UpdateItemResponse = UpdateItemResponses[keyof UpdateItemResponses];
|
|
10889
|
+
export type UnarchiveItemData = {
|
|
10890
|
+
body: AssetsArchiveParameters;
|
|
10891
|
+
path: {
|
|
10892
|
+
item_id: string;
|
|
10893
|
+
};
|
|
10894
|
+
query?: never;
|
|
10895
|
+
url: '/api/v1/assets/items/{item_id}/archive';
|
|
10896
|
+
};
|
|
10897
|
+
export type UnarchiveItemErrors = {
|
|
10898
|
+
/**
|
|
10899
|
+
* Bad Request (missing performed_by_user_id)
|
|
10900
|
+
*/
|
|
10901
|
+
400: Problem;
|
|
10902
|
+
/**
|
|
10903
|
+
* Forbidden
|
|
10904
|
+
*/
|
|
10905
|
+
403: Problem;
|
|
10906
|
+
/**
|
|
10907
|
+
* Conflict
|
|
10908
|
+
*/
|
|
10909
|
+
409: Problem;
|
|
10910
|
+
};
|
|
10911
|
+
export type UnarchiveItemError = UnarchiveItemErrors[keyof UnarchiveItemErrors];
|
|
10912
|
+
export type UnarchiveItemResponses = {
|
|
10913
|
+
/**
|
|
10914
|
+
* Success
|
|
10915
|
+
*/
|
|
10916
|
+
200: AssetsItemResponseObject;
|
|
10917
|
+
};
|
|
10918
|
+
export type UnarchiveItemResponse = UnarchiveItemResponses[keyof UnarchiveItemResponses];
|
|
10919
|
+
export type ArchiveItemData = {
|
|
10920
|
+
body: AssetsArchiveParameters;
|
|
10921
|
+
path: {
|
|
10922
|
+
item_id: string;
|
|
10923
|
+
};
|
|
10924
|
+
query?: never;
|
|
10925
|
+
url: '/api/v1/assets/items/{item_id}/archive';
|
|
10926
|
+
};
|
|
10927
|
+
export type ArchiveItemErrors = {
|
|
10928
|
+
/**
|
|
10929
|
+
* Bad Request (missing performed_by_user_id)
|
|
10930
|
+
*/
|
|
10931
|
+
400: Problem;
|
|
10932
|
+
/**
|
|
10933
|
+
* Forbidden
|
|
10934
|
+
*/
|
|
10935
|
+
403: Problem;
|
|
10936
|
+
};
|
|
10937
|
+
export type ArchiveItemError = ArchiveItemErrors[keyof ArchiveItemErrors];
|
|
10938
|
+
export type ArchiveItemResponses = {
|
|
10939
|
+
/**
|
|
10940
|
+
* Created
|
|
10941
|
+
*/
|
|
10942
|
+
201: AssetsItemResponseObject;
|
|
10943
|
+
};
|
|
10944
|
+
export type ArchiveItemResponse = ArchiveItemResponses[keyof ArchiveItemResponses];
|
|
10621
10945
|
export type ListServiceSchedulesData = {
|
|
10622
10946
|
body?: never;
|
|
10623
10947
|
path: {
|
|
@@ -11388,44 +11712,104 @@ export type UpdateProductResponses = {
|
|
|
11388
11712
|
200: AssetsProductResponseObject;
|
|
11389
11713
|
};
|
|
11390
11714
|
export type UpdateProductResponse = UpdateProductResponses[keyof UpdateProductResponses];
|
|
11391
|
-
export type
|
|
11392
|
-
body:
|
|
11715
|
+
export type UnarchiveProductData = {
|
|
11716
|
+
body: AssetsArchiveParameters;
|
|
11393
11717
|
path: {
|
|
11394
11718
|
product_id: string;
|
|
11395
11719
|
};
|
|
11396
11720
|
query?: never;
|
|
11397
|
-
url: '/api/v1/assets/products/{product_id}/
|
|
11721
|
+
url: '/api/v1/assets/products/{product_id}/archive';
|
|
11398
11722
|
};
|
|
11399
|
-
export type
|
|
11723
|
+
export type UnarchiveProductErrors = {
|
|
11724
|
+
/**
|
|
11725
|
+
* Bad Request (missing performed_by_user_id)
|
|
11726
|
+
*/
|
|
11727
|
+
400: Problem;
|
|
11400
11728
|
/**
|
|
11401
11729
|
* Forbidden
|
|
11402
11730
|
*/
|
|
11403
11731
|
403: Problem;
|
|
11404
11732
|
};
|
|
11405
|
-
export type
|
|
11406
|
-
export type
|
|
11733
|
+
export type UnarchiveProductError = UnarchiveProductErrors[keyof UnarchiveProductErrors];
|
|
11734
|
+
export type UnarchiveProductResponses = {
|
|
11407
11735
|
/**
|
|
11408
|
-
*
|
|
11736
|
+
* Success
|
|
11409
11737
|
*/
|
|
11410
|
-
|
|
11738
|
+
200: AssetsProductResponseObject;
|
|
11411
11739
|
};
|
|
11412
|
-
export type
|
|
11413
|
-
export type
|
|
11414
|
-
body:
|
|
11740
|
+
export type UnarchiveProductResponse = UnarchiveProductResponses[keyof UnarchiveProductResponses];
|
|
11741
|
+
export type ArchiveProductData = {
|
|
11742
|
+
body: AssetsArchiveParameters;
|
|
11415
11743
|
path: {
|
|
11416
11744
|
product_id: string;
|
|
11417
11745
|
};
|
|
11418
11746
|
query?: never;
|
|
11419
|
-
url: '/api/v1/assets/products/{product_id}/
|
|
11747
|
+
url: '/api/v1/assets/products/{product_id}/archive';
|
|
11420
11748
|
};
|
|
11421
|
-
export type
|
|
11749
|
+
export type ArchiveProductErrors = {
|
|
11750
|
+
/**
|
|
11751
|
+
* Bad Request (missing performed_by_user_id)
|
|
11752
|
+
*/
|
|
11753
|
+
400: Problem;
|
|
11422
11754
|
/**
|
|
11423
11755
|
* Forbidden
|
|
11424
11756
|
*/
|
|
11425
11757
|
403: Problem;
|
|
11426
11758
|
};
|
|
11427
|
-
export type
|
|
11428
|
-
export type
|
|
11759
|
+
export type ArchiveProductError = ArchiveProductErrors[keyof ArchiveProductErrors];
|
|
11760
|
+
export type ArchiveProductResponses = {
|
|
11761
|
+
/**
|
|
11762
|
+
* Created
|
|
11763
|
+
*/
|
|
11764
|
+
201: AssetsProductResponseObject;
|
|
11765
|
+
};
|
|
11766
|
+
export type ArchiveProductResponse = ArchiveProductResponses[keyof ArchiveProductResponses];
|
|
11767
|
+
export type AdjustProductInventoryData = {
|
|
11768
|
+
body: AssetsAdjustmentParameters;
|
|
11769
|
+
path: {
|
|
11770
|
+
product_id: string;
|
|
11771
|
+
};
|
|
11772
|
+
query?: never;
|
|
11773
|
+
url: '/api/v1/assets/products/{product_id}/adjustments';
|
|
11774
|
+
};
|
|
11775
|
+
export type AdjustProductInventoryErrors = {
|
|
11776
|
+
/**
|
|
11777
|
+
* Forbidden
|
|
11778
|
+
*/
|
|
11779
|
+
403: Problem;
|
|
11780
|
+
/**
|
|
11781
|
+
* Not Found
|
|
11782
|
+
*/
|
|
11783
|
+
404: Problem;
|
|
11784
|
+
};
|
|
11785
|
+
export type AdjustProductInventoryError = AdjustProductInventoryErrors[keyof AdjustProductInventoryErrors];
|
|
11786
|
+
export type AdjustProductInventoryResponses = {
|
|
11787
|
+
/**
|
|
11788
|
+
* Created
|
|
11789
|
+
*/
|
|
11790
|
+
201: AssetsProductResponseObject;
|
|
11791
|
+
};
|
|
11792
|
+
export type AdjustProductInventoryResponse = AdjustProductInventoryResponses[keyof AdjustProductInventoryResponses];
|
|
11793
|
+
export type RestockProductData = {
|
|
11794
|
+
body: AssetsRestockParameters;
|
|
11795
|
+
path: {
|
|
11796
|
+
product_id: string;
|
|
11797
|
+
};
|
|
11798
|
+
query?: never;
|
|
11799
|
+
url: '/api/v1/assets/products/{product_id}/restocks';
|
|
11800
|
+
};
|
|
11801
|
+
export type RestockProductErrors = {
|
|
11802
|
+
/**
|
|
11803
|
+
* Forbidden
|
|
11804
|
+
*/
|
|
11805
|
+
403: Problem;
|
|
11806
|
+
/**
|
|
11807
|
+
* Not Found
|
|
11808
|
+
*/
|
|
11809
|
+
404: Problem;
|
|
11810
|
+
};
|
|
11811
|
+
export type RestockProductError = RestockProductErrors[keyof RestockProductErrors];
|
|
11812
|
+
export type RestockProductResponses = {
|
|
11429
11813
|
/**
|
|
11430
11814
|
* Created
|
|
11431
11815
|
*/
|
|
@@ -11792,6 +12176,178 @@ export type UpdateSiteResponses = {
|
|
|
11792
12176
|
200: AssetsSiteResponseObject;
|
|
11793
12177
|
};
|
|
11794
12178
|
export type UpdateSiteResponse = UpdateSiteResponses[keyof UpdateSiteResponses];
|
|
12179
|
+
export type ListSubLocationsData = {
|
|
12180
|
+
body?: never;
|
|
12181
|
+
path?: never;
|
|
12182
|
+
query?: {
|
|
12183
|
+
'filter[assets_site_id]'?: string;
|
|
12184
|
+
'filter[container_item_id]'?: string;
|
|
12185
|
+
/**
|
|
12186
|
+
* :
|
|
12187
|
+
* * `zone`
|
|
12188
|
+
* * `aisle`
|
|
12189
|
+
* * `rack`
|
|
12190
|
+
* * `shelf`
|
|
12191
|
+
* * `bin`
|
|
12192
|
+
* * `drawer`
|
|
12193
|
+
*
|
|
12194
|
+
*/
|
|
12195
|
+
'filter[kind]'?: string;
|
|
12196
|
+
'filter[created_at][gte]'?: string;
|
|
12197
|
+
'filter[created_at][lte]'?: string;
|
|
12198
|
+
'filter[updated_at][gte]'?: string;
|
|
12199
|
+
'filter[updated_at][lte]'?: string;
|
|
12200
|
+
filter?: string;
|
|
12201
|
+
'filter[unexpected]'?: string;
|
|
12202
|
+
/**
|
|
12203
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
12204
|
+
* `meta.page.next_cursor`.
|
|
12205
|
+
*/
|
|
12206
|
+
'page[cursor]'?: string;
|
|
12207
|
+
/**
|
|
12208
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
12209
|
+
*/
|
|
12210
|
+
'page[limit]'?: number;
|
|
12211
|
+
page?: string;
|
|
12212
|
+
};
|
|
12213
|
+
url: '/api/v1/assets/sub_locations';
|
|
12214
|
+
};
|
|
12215
|
+
export type ListSubLocationsErrors = {
|
|
12216
|
+
/**
|
|
12217
|
+
* Bad Request
|
|
12218
|
+
*/
|
|
12219
|
+
400: Problem;
|
|
12220
|
+
/**
|
|
12221
|
+
* Forbidden
|
|
12222
|
+
*/
|
|
12223
|
+
403: Problem;
|
|
12224
|
+
/**
|
|
12225
|
+
* Unprocessable Content
|
|
12226
|
+
*/
|
|
12227
|
+
422: Problem;
|
|
12228
|
+
};
|
|
12229
|
+
export type ListSubLocationsError = ListSubLocationsErrors[keyof ListSubLocationsErrors];
|
|
12230
|
+
export type ListSubLocationsResponses = {
|
|
12231
|
+
/**
|
|
12232
|
+
* Success
|
|
12233
|
+
*/
|
|
12234
|
+
200: {
|
|
12235
|
+
meta: Meta;
|
|
12236
|
+
links: Links;
|
|
12237
|
+
data: Array<AssetsSubLocationResponseObject>;
|
|
12238
|
+
};
|
|
12239
|
+
};
|
|
12240
|
+
export type ListSubLocationsResponse = ListSubLocationsResponses[keyof ListSubLocationsResponses];
|
|
12241
|
+
export type CreateSubLocationData = {
|
|
12242
|
+
body?: AssetsSubLocationParameters;
|
|
12243
|
+
path?: never;
|
|
12244
|
+
query?: never;
|
|
12245
|
+
url: '/api/v1/assets/sub_locations';
|
|
12246
|
+
};
|
|
12247
|
+
export type CreateSubLocationErrors = {
|
|
12248
|
+
/**
|
|
12249
|
+
* Forbidden
|
|
12250
|
+
*/
|
|
12251
|
+
403: Problem;
|
|
12252
|
+
/**
|
|
12253
|
+
* Unprocessable Content
|
|
12254
|
+
*/
|
|
12255
|
+
422: Problem;
|
|
12256
|
+
};
|
|
12257
|
+
export type CreateSubLocationError = CreateSubLocationErrors[keyof CreateSubLocationErrors];
|
|
12258
|
+
export type CreateSubLocationResponses = {
|
|
12259
|
+
/**
|
|
12260
|
+
* Created
|
|
12261
|
+
*/
|
|
12262
|
+
201: AssetsSubLocationResponseObject;
|
|
12263
|
+
};
|
|
12264
|
+
export type CreateSubLocationResponse = CreateSubLocationResponses[keyof CreateSubLocationResponses];
|
|
12265
|
+
export type DeleteSubLocationData = {
|
|
12266
|
+
body?: never;
|
|
12267
|
+
path: {
|
|
12268
|
+
id: string;
|
|
12269
|
+
};
|
|
12270
|
+
query?: never;
|
|
12271
|
+
url: '/api/v1/assets/sub_locations/{id}';
|
|
12272
|
+
};
|
|
12273
|
+
export type DeleteSubLocationErrors = {
|
|
12274
|
+
/**
|
|
12275
|
+
* Forbidden
|
|
12276
|
+
*/
|
|
12277
|
+
403: Problem;
|
|
12278
|
+
/**
|
|
12279
|
+
* Not Found
|
|
12280
|
+
*/
|
|
12281
|
+
404: Problem;
|
|
12282
|
+
/**
|
|
12283
|
+
* Unprocessable Content
|
|
12284
|
+
*/
|
|
12285
|
+
422: Problem;
|
|
12286
|
+
};
|
|
12287
|
+
export type DeleteSubLocationError = DeleteSubLocationErrors[keyof DeleteSubLocationErrors];
|
|
12288
|
+
export type DeleteSubLocationResponses = {
|
|
12289
|
+
/**
|
|
12290
|
+
* Success
|
|
12291
|
+
*/
|
|
12292
|
+
200: AssetsSubLocationResponseObject;
|
|
12293
|
+
};
|
|
12294
|
+
export type DeleteSubLocationResponse = DeleteSubLocationResponses[keyof DeleteSubLocationResponses];
|
|
12295
|
+
export type GetSubLocationData = {
|
|
12296
|
+
body?: never;
|
|
12297
|
+
path: {
|
|
12298
|
+
id: string;
|
|
12299
|
+
};
|
|
12300
|
+
query?: never;
|
|
12301
|
+
url: '/api/v1/assets/sub_locations/{id}';
|
|
12302
|
+
};
|
|
12303
|
+
export type GetSubLocationErrors = {
|
|
12304
|
+
/**
|
|
12305
|
+
* Forbidden
|
|
12306
|
+
*/
|
|
12307
|
+
403: Problem;
|
|
12308
|
+
/**
|
|
12309
|
+
* Not Found
|
|
12310
|
+
*/
|
|
12311
|
+
404: Problem;
|
|
12312
|
+
};
|
|
12313
|
+
export type GetSubLocationError = GetSubLocationErrors[keyof GetSubLocationErrors];
|
|
12314
|
+
export type GetSubLocationResponses = {
|
|
12315
|
+
/**
|
|
12316
|
+
* Success
|
|
12317
|
+
*/
|
|
12318
|
+
200: AssetsSubLocationResponseObject;
|
|
12319
|
+
};
|
|
12320
|
+
export type GetSubLocationResponse = GetSubLocationResponses[keyof GetSubLocationResponses];
|
|
12321
|
+
export type UpdateSubLocationData = {
|
|
12322
|
+
body?: AssetsSubLocationUpdateParameters;
|
|
12323
|
+
path: {
|
|
12324
|
+
id: string;
|
|
12325
|
+
};
|
|
12326
|
+
query?: never;
|
|
12327
|
+
url: '/api/v1/assets/sub_locations/{id}';
|
|
12328
|
+
};
|
|
12329
|
+
export type UpdateSubLocationErrors = {
|
|
12330
|
+
/**
|
|
12331
|
+
* Forbidden
|
|
12332
|
+
*/
|
|
12333
|
+
403: Problem;
|
|
12334
|
+
/**
|
|
12335
|
+
* Not Found
|
|
12336
|
+
*/
|
|
12337
|
+
404: Problem;
|
|
12338
|
+
/**
|
|
12339
|
+
* Unprocessable Content
|
|
12340
|
+
*/
|
|
12341
|
+
422: Problem;
|
|
12342
|
+
};
|
|
12343
|
+
export type UpdateSubLocationError = UpdateSubLocationErrors[keyof UpdateSubLocationErrors];
|
|
12344
|
+
export type UpdateSubLocationResponses = {
|
|
12345
|
+
/**
|
|
12346
|
+
* Success
|
|
12347
|
+
*/
|
|
12348
|
+
200: AssetsSubLocationResponseObject;
|
|
12349
|
+
};
|
|
12350
|
+
export type UpdateSubLocationResponse = UpdateSubLocationResponses[keyof UpdateSubLocationResponses];
|
|
11795
12351
|
export type ListTransfersData = {
|
|
11796
12352
|
body?: never;
|
|
11797
12353
|
path?: never;
|
|
@@ -13160,6 +13716,10 @@ export type CreateDirectUploadErrors = {
|
|
|
13160
13716
|
* Forbidden
|
|
13161
13717
|
*/
|
|
13162
13718
|
403: Problem;
|
|
13719
|
+
/**
|
|
13720
|
+
* Unprocessable Content
|
|
13721
|
+
*/
|
|
13722
|
+
422: Problem;
|
|
13163
13723
|
};
|
|
13164
13724
|
export type CreateDirectUploadError = CreateDirectUploadErrors[keyof CreateDirectUploadErrors];
|
|
13165
13725
|
export type CreateDirectUploadResponses = {
|
|
@@ -13927,6 +14487,59 @@ export type GetRateRuleResponses = {
|
|
|
13927
14487
|
200: RateRuleResponseObject;
|
|
13928
14488
|
};
|
|
13929
14489
|
export type GetRateRuleResponse = GetRateRuleResponses[keyof GetRateRuleResponses];
|
|
14490
|
+
export type ShiftJobWageDeterminationGenesisData = {
|
|
14491
|
+
body: JobWageDeterminationGenesisParameters;
|
|
14492
|
+
headers: {
|
|
14493
|
+
/**
|
|
14494
|
+
* Version validator this write is composed against — the `ETag` from a read of this determination, or `*` to write against whatever exists. See "Version validators" in the API overview.
|
|
14495
|
+
*/
|
|
14496
|
+
'If-Match': string;
|
|
14497
|
+
};
|
|
14498
|
+
path: {
|
|
14499
|
+
job_id: string;
|
|
14500
|
+
wage_determination_id: string;
|
|
14501
|
+
};
|
|
14502
|
+
query?: never;
|
|
14503
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/genesis';
|
|
14504
|
+
};
|
|
14505
|
+
export type ShiftJobWageDeterminationGenesisErrors = {
|
|
14506
|
+
/**
|
|
14507
|
+
* Bad Request (missing effective_date)
|
|
14508
|
+
*/
|
|
14509
|
+
400: Problem;
|
|
14510
|
+
/**
|
|
14511
|
+
* Forbidden
|
|
14512
|
+
*/
|
|
14513
|
+
403: Problem;
|
|
14514
|
+
/**
|
|
14515
|
+
* Not Found
|
|
14516
|
+
*/
|
|
14517
|
+
404: Problem;
|
|
14518
|
+
/**
|
|
14519
|
+
* Conflict
|
|
14520
|
+
*/
|
|
14521
|
+
409: Problem;
|
|
14522
|
+
/**
|
|
14523
|
+
* Precondition Failed
|
|
14524
|
+
*/
|
|
14525
|
+
412: Problem;
|
|
14526
|
+
/**
|
|
14527
|
+
* Unprocessable Content
|
|
14528
|
+
*/
|
|
14529
|
+
422: Problem;
|
|
14530
|
+
/**
|
|
14531
|
+
* Precondition Required
|
|
14532
|
+
*/
|
|
14533
|
+
428: Problem;
|
|
14534
|
+
};
|
|
14535
|
+
export type ShiftJobWageDeterminationGenesisError = ShiftJobWageDeterminationGenesisErrors[keyof ShiftJobWageDeterminationGenesisErrors];
|
|
14536
|
+
export type ShiftJobWageDeterminationGenesisResponses = {
|
|
14537
|
+
/**
|
|
14538
|
+
* Success
|
|
14539
|
+
*/
|
|
14540
|
+
200: JobWageDeterminationResponseObject;
|
|
14541
|
+
};
|
|
14542
|
+
export type ShiftJobWageDeterminationGenesisResponse = ShiftJobWageDeterminationGenesisResponses[keyof ShiftJobWageDeterminationGenesisResponses];
|
|
13930
14543
|
export type ListJobWageDeterminationHistoryData = {
|
|
13931
14544
|
body?: never;
|
|
13932
14545
|
path: {
|
|
@@ -13967,6 +14580,229 @@ export type ListJobWageDeterminationHistoryResponses = {
|
|
|
13967
14580
|
};
|
|
13968
14581
|
};
|
|
13969
14582
|
export type ListJobWageDeterminationHistoryResponse = ListJobWageDeterminationHistoryResponses[keyof ListJobWageDeterminationHistoryResponses];
|
|
14583
|
+
export type CancelJobWageDeterminationScheduledChangesData = {
|
|
14584
|
+
body?: never;
|
|
14585
|
+
headers: {
|
|
14586
|
+
/**
|
|
14587
|
+
* Version validator this write is composed against — the `ETag` from a read of this determination, or `*` to write against whatever exists. See "Version validators" in the API overview.
|
|
14588
|
+
*/
|
|
14589
|
+
'If-Match': string;
|
|
14590
|
+
};
|
|
14591
|
+
path: {
|
|
14592
|
+
job_id: string;
|
|
14593
|
+
wage_determination_id: string;
|
|
14594
|
+
};
|
|
14595
|
+
query?: never;
|
|
14596
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_changes';
|
|
14597
|
+
};
|
|
14598
|
+
export type CancelJobWageDeterminationScheduledChangesErrors = {
|
|
14599
|
+
/**
|
|
14600
|
+
* Forbidden
|
|
14601
|
+
*/
|
|
14602
|
+
403: Problem;
|
|
14603
|
+
/**
|
|
14604
|
+
* Not Found
|
|
14605
|
+
*/
|
|
14606
|
+
404: Problem;
|
|
14607
|
+
/**
|
|
14608
|
+
* Precondition Failed
|
|
14609
|
+
*/
|
|
14610
|
+
412: Problem;
|
|
14611
|
+
/**
|
|
14612
|
+
* Unprocessable Content
|
|
14613
|
+
*/
|
|
14614
|
+
422: Problem;
|
|
14615
|
+
/**
|
|
14616
|
+
* Precondition Required
|
|
14617
|
+
*/
|
|
14618
|
+
428: Problem;
|
|
14619
|
+
};
|
|
14620
|
+
export type CancelJobWageDeterminationScheduledChangesError = CancelJobWageDeterminationScheduledChangesErrors[keyof CancelJobWageDeterminationScheduledChangesErrors];
|
|
14621
|
+
export type CancelJobWageDeterminationScheduledChangesResponses = {
|
|
14622
|
+
/**
|
|
14623
|
+
* Success
|
|
14624
|
+
*/
|
|
14625
|
+
200: JobWageDeterminationResponseObject;
|
|
14626
|
+
};
|
|
14627
|
+
export type CancelJobWageDeterminationScheduledChangesResponse = CancelJobWageDeterminationScheduledChangesResponses[keyof CancelJobWageDeterminationScheduledChangesResponses];
|
|
14628
|
+
export type ListJobWageDeterminationScheduledChangesData = {
|
|
14629
|
+
body?: never;
|
|
14630
|
+
path: {
|
|
14631
|
+
job_id: string;
|
|
14632
|
+
wage_determination_id: string;
|
|
14633
|
+
};
|
|
14634
|
+
query?: never;
|
|
14635
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_changes';
|
|
14636
|
+
};
|
|
14637
|
+
export type ListJobWageDeterminationScheduledChangesErrors = {
|
|
14638
|
+
/**
|
|
14639
|
+
* Forbidden
|
|
14640
|
+
*/
|
|
14641
|
+
403: Problem;
|
|
14642
|
+
/**
|
|
14643
|
+
* Not Found
|
|
14644
|
+
*/
|
|
14645
|
+
404: Problem;
|
|
14646
|
+
};
|
|
14647
|
+
export type ListJobWageDeterminationScheduledChangesError = ListJobWageDeterminationScheduledChangesErrors[keyof ListJobWageDeterminationScheduledChangesErrors];
|
|
14648
|
+
export type ListJobWageDeterminationScheduledChangesResponses = {
|
|
14649
|
+
/**
|
|
14650
|
+
* Success with scheduled changes
|
|
14651
|
+
*/
|
|
14652
|
+
200: Array<JobWageDeterminationResponseObject>;
|
|
14653
|
+
};
|
|
14654
|
+
export type ListJobWageDeterminationScheduledChangesResponse = ListJobWageDeterminationScheduledChangesResponses[keyof ListJobWageDeterminationScheduledChangesResponses];
|
|
14655
|
+
export type ScheduleJobWageDeterminationChangeData = {
|
|
14656
|
+
body: JobWageDeterminationScheduledChangeParameters;
|
|
14657
|
+
headers: {
|
|
14658
|
+
/**
|
|
14659
|
+
* Version validator this write is composed against — the `ETag` from a read of this determination, or `*` to write against whatever exists. See "Version validators" in the API overview.
|
|
14660
|
+
*/
|
|
14661
|
+
'If-Match': string;
|
|
14662
|
+
};
|
|
14663
|
+
path: {
|
|
14664
|
+
job_id: string;
|
|
14665
|
+
wage_determination_id: string;
|
|
14666
|
+
};
|
|
14667
|
+
query?: never;
|
|
14668
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_changes';
|
|
14669
|
+
};
|
|
14670
|
+
export type ScheduleJobWageDeterminationChangeErrors = {
|
|
14671
|
+
/**
|
|
14672
|
+
* Bad Request (missing effective_date)
|
|
14673
|
+
*/
|
|
14674
|
+
400: Problem;
|
|
14675
|
+
/**
|
|
14676
|
+
* Forbidden
|
|
14677
|
+
*/
|
|
14678
|
+
403: Problem;
|
|
14679
|
+
/**
|
|
14680
|
+
* Not Found
|
|
14681
|
+
*/
|
|
14682
|
+
404: Problem;
|
|
14683
|
+
/**
|
|
14684
|
+
* Conflict
|
|
14685
|
+
*/
|
|
14686
|
+
409: Problem;
|
|
14687
|
+
/**
|
|
14688
|
+
* Precondition Failed
|
|
14689
|
+
*/
|
|
14690
|
+
412: Problem;
|
|
14691
|
+
/**
|
|
14692
|
+
* Unprocessable Content
|
|
14693
|
+
*/
|
|
14694
|
+
422: Problem;
|
|
14695
|
+
/**
|
|
14696
|
+
* Precondition Required
|
|
14697
|
+
*/
|
|
14698
|
+
428: Problem;
|
|
14699
|
+
};
|
|
14700
|
+
export type ScheduleJobWageDeterminationChangeError = ScheduleJobWageDeterminationChangeErrors[keyof ScheduleJobWageDeterminationChangeErrors];
|
|
14701
|
+
export type ScheduleJobWageDeterminationChangeResponses = {
|
|
14702
|
+
/**
|
|
14703
|
+
* Created
|
|
14704
|
+
*/
|
|
14705
|
+
201: JobWageDeterminationResponseObject;
|
|
14706
|
+
};
|
|
14707
|
+
export type ScheduleJobWageDeterminationChangeResponse = ScheduleJobWageDeterminationChangeResponses[keyof ScheduleJobWageDeterminationChangeResponses];
|
|
14708
|
+
export type CancelJobWageDeterminationScheduledTerminationData = {
|
|
14709
|
+
body?: never;
|
|
14710
|
+
headers: {
|
|
14711
|
+
/**
|
|
14712
|
+
* Version validator this write is composed against — the `ETag` from a read of this determination, or `*` to write against whatever exists. See "Version validators" in the API overview.
|
|
14713
|
+
*/
|
|
14714
|
+
'If-Match': string;
|
|
14715
|
+
};
|
|
14716
|
+
path: {
|
|
14717
|
+
job_id: string;
|
|
14718
|
+
wage_determination_id: string;
|
|
14719
|
+
};
|
|
14720
|
+
query?: never;
|
|
14721
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_termination';
|
|
14722
|
+
};
|
|
14723
|
+
export type CancelJobWageDeterminationScheduledTerminationErrors = {
|
|
14724
|
+
/**
|
|
14725
|
+
* Forbidden
|
|
14726
|
+
*/
|
|
14727
|
+
403: Problem;
|
|
14728
|
+
/**
|
|
14729
|
+
* Not Found
|
|
14730
|
+
*/
|
|
14731
|
+
404: Problem;
|
|
14732
|
+
/**
|
|
14733
|
+
* Precondition Failed
|
|
14734
|
+
*/
|
|
14735
|
+
412: Problem;
|
|
14736
|
+
/**
|
|
14737
|
+
* Unprocessable Content
|
|
14738
|
+
*/
|
|
14739
|
+
422: Problem;
|
|
14740
|
+
/**
|
|
14741
|
+
* Precondition Required
|
|
14742
|
+
*/
|
|
14743
|
+
428: Problem;
|
|
14744
|
+
};
|
|
14745
|
+
export type CancelJobWageDeterminationScheduledTerminationError = CancelJobWageDeterminationScheduledTerminationErrors[keyof CancelJobWageDeterminationScheduledTerminationErrors];
|
|
14746
|
+
export type CancelJobWageDeterminationScheduledTerminationResponses = {
|
|
14747
|
+
/**
|
|
14748
|
+
* Success
|
|
14749
|
+
*/
|
|
14750
|
+
200: JobWageDeterminationResponseObject;
|
|
14751
|
+
};
|
|
14752
|
+
export type CancelJobWageDeterminationScheduledTerminationResponse = CancelJobWageDeterminationScheduledTerminationResponses[keyof CancelJobWageDeterminationScheduledTerminationResponses];
|
|
14753
|
+
export type ScheduleJobWageDeterminationTerminationData = {
|
|
14754
|
+
body: JobWageDeterminationScheduledTerminationParameters;
|
|
14755
|
+
headers: {
|
|
14756
|
+
/**
|
|
14757
|
+
* Version validator this write is composed against — the `ETag` from a read of this determination, or `*` to write against whatever exists. See "Version validators" in the API overview.
|
|
14758
|
+
*/
|
|
14759
|
+
'If-Match': string;
|
|
14760
|
+
};
|
|
14761
|
+
path: {
|
|
14762
|
+
job_id: string;
|
|
14763
|
+
wage_determination_id: string;
|
|
14764
|
+
};
|
|
14765
|
+
query?: never;
|
|
14766
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_termination';
|
|
14767
|
+
};
|
|
14768
|
+
export type ScheduleJobWageDeterminationTerminationErrors = {
|
|
14769
|
+
/**
|
|
14770
|
+
* Bad Request (missing effective_date)
|
|
14771
|
+
*/
|
|
14772
|
+
400: Problem;
|
|
14773
|
+
/**
|
|
14774
|
+
* Forbidden
|
|
14775
|
+
*/
|
|
14776
|
+
403: Problem;
|
|
14777
|
+
/**
|
|
14778
|
+
* Not Found
|
|
14779
|
+
*/
|
|
14780
|
+
404: Problem;
|
|
14781
|
+
/**
|
|
14782
|
+
* Conflict
|
|
14783
|
+
*/
|
|
14784
|
+
409: Problem;
|
|
14785
|
+
/**
|
|
14786
|
+
* Precondition Failed
|
|
14787
|
+
*/
|
|
14788
|
+
412: Problem;
|
|
14789
|
+
/**
|
|
14790
|
+
* Unprocessable Content
|
|
14791
|
+
*/
|
|
14792
|
+
422: Problem;
|
|
14793
|
+
/**
|
|
14794
|
+
* Precondition Required
|
|
14795
|
+
*/
|
|
14796
|
+
428: Problem;
|
|
14797
|
+
};
|
|
14798
|
+
export type ScheduleJobWageDeterminationTerminationError = ScheduleJobWageDeterminationTerminationErrors[keyof ScheduleJobWageDeterminationTerminationErrors];
|
|
14799
|
+
export type ScheduleJobWageDeterminationTerminationResponses = {
|
|
14800
|
+
/**
|
|
14801
|
+
* Created
|
|
14802
|
+
*/
|
|
14803
|
+
201: JobWageDeterminationResponseObject;
|
|
14804
|
+
};
|
|
14805
|
+
export type ScheduleJobWageDeterminationTerminationResponse = ScheduleJobWageDeterminationTerminationResponses[keyof ScheduleJobWageDeterminationTerminationResponses];
|
|
13970
14806
|
export type ListJobWageDeterminationsData = {
|
|
13971
14807
|
body?: never;
|
|
13972
14808
|
path: {
|
|
@@ -14113,6 +14949,55 @@ export type GetJobWageDeterminationResponses = {
|
|
|
14113
14949
|
200: JobWageDeterminationResponseObject;
|
|
14114
14950
|
};
|
|
14115
14951
|
export type GetJobWageDeterminationResponse = GetJobWageDeterminationResponses[keyof GetJobWageDeterminationResponses];
|
|
14952
|
+
export type UpdateJobWageDeterminationData = {
|
|
14953
|
+
body: JobWageDeterminationUpdateParameters;
|
|
14954
|
+
headers: {
|
|
14955
|
+
/**
|
|
14956
|
+
* Version validator this write is composed against — the `ETag` from a read of this wage determination, or `*` to write against whatever exists. See "Version validators" in the API overview.
|
|
14957
|
+
*/
|
|
14958
|
+
'If-Match': string;
|
|
14959
|
+
};
|
|
14960
|
+
path: {
|
|
14961
|
+
job_id: string;
|
|
14962
|
+
id: string;
|
|
14963
|
+
};
|
|
14964
|
+
query?: never;
|
|
14965
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{id}';
|
|
14966
|
+
};
|
|
14967
|
+
export type UpdateJobWageDeterminationErrors = {
|
|
14968
|
+
/**
|
|
14969
|
+
* Forbidden
|
|
14970
|
+
*/
|
|
14971
|
+
403: Problem;
|
|
14972
|
+
/**
|
|
14973
|
+
* Not Found
|
|
14974
|
+
*/
|
|
14975
|
+
404: Problem;
|
|
14976
|
+
/**
|
|
14977
|
+
* Conflict
|
|
14978
|
+
*/
|
|
14979
|
+
409: Problem;
|
|
14980
|
+
/**
|
|
14981
|
+
* Precondition Failed
|
|
14982
|
+
*/
|
|
14983
|
+
412: Problem;
|
|
14984
|
+
/**
|
|
14985
|
+
* Unprocessable Content
|
|
14986
|
+
*/
|
|
14987
|
+
422: Problem;
|
|
14988
|
+
/**
|
|
14989
|
+
* Precondition Required
|
|
14990
|
+
*/
|
|
14991
|
+
428: Problem;
|
|
14992
|
+
};
|
|
14993
|
+
export type UpdateJobWageDeterminationError = UpdateJobWageDeterminationErrors[keyof UpdateJobWageDeterminationErrors];
|
|
14994
|
+
export type UpdateJobWageDeterminationResponses = {
|
|
14995
|
+
/**
|
|
14996
|
+
* Success
|
|
14997
|
+
*/
|
|
14998
|
+
200: JobWageDeterminationResponseObject;
|
|
14999
|
+
};
|
|
15000
|
+
export type UpdateJobWageDeterminationResponse = UpdateJobWageDeterminationResponses[keyof UpdateJobWageDeterminationResponses];
|
|
14116
15001
|
export type ListJobsData = {
|
|
14117
15002
|
body?: never;
|
|
14118
15003
|
path?: never;
|