@dsptch-work/api-client 0.11.0 → 0.12.0

package/dist/gen/zod.gen.js

@@ -154,6 +154,12 @@ export const zProblem = z.object({
  *
  * 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.
  *
+ * ### product_archived
+ *
+ * **Product Archived**
+ *
+ * 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.
+ *
  * ### recorded_since_termination
  *
  * **Timecode Changed Since Termination**
@@ -238,9 +244,9 @@ export const zProblem = z.object({
  *
  * ### invalid_signed_id
  *
- * **Invalid Attachment Signed Id**
+ * **Attachment Upload Not Found**
  *
- * An attachment signed id — an avatar's, a logo's — is not a string or fails signature verification. Obtain a fresh signed id from the direct-uploads endpoint and retry.
+ * 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.
  *
  * ### non_numeric_cents
  *
@@ -345,6 +351,7 @@ export const zProblemTypeCatalog = z.enum([
     'insufficient_api_key_scope',
     'not_found',
     'already_terminated',
+    'product_archived',
     'recorded_since_termination',
     'span_beyond_timeline_end',
     'version_overlap',
@@ -386,6 +393,14 @@ export const zApiKeyScopeResponseObject = z.object({
  * 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.
  */
 export const zDirectUploadParameters = z.object({
+    resource: z.enum([
+        'assets.items',
+        'assets.items.documents',
+        'assets.items.service_events',
+        'assets.products',
+        'assets.vendors',
+        'users'
+    ]),
     blob: z.object({
         filename: z.string(),
         byte_size: z.int(),
@@ -1001,8 +1016,7 @@ export const zTimeCardPerDiemResponseObject = z.object({
 export const zTimeCardPerDiemParameters = z.object({
     date: z.iso.date(),
     approver_user_id: z.string(),
-    per_diem_id: z.string(),
-    taxable: z.boolean().optional()
+    per_diem_id: z.string()
 });
 /**
  * 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.
@@ -3708,6 +3722,7 @@ export const zFederalJobWageDeterminationResponseObject = z.object({
     id: z.string(),
     job_id: z.string(),
     pwa_trade_id: z.string(),
+    overtime_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Federal']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -3729,6 +3744,7 @@ export const zFederalJobWageDeterminationHistoryCorrectionObject = z.object({
     job_wage_determination_id: z.string(),
     job_id: z.string(),
     pwa_trade_id: z.string(),
+    overtime_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Federal']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -3799,6 +3815,7 @@ export const zRegionalJobWageDeterminationResponseObject = z.object({
     id: z.string(),
     job_id: z.string(),
     pwa_trade_id: z.string(),
+    overtime_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Regional']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -3821,6 +3838,7 @@ export const zRegionalJobWageDeterminationHistoryCorrectionObject = z.object({
     job_wage_determination_id: z.string(),
     job_id: z.string(),
     pwa_trade_id: z.string(),
+    overtime_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Regional']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -3840,6 +3858,7 @@ export const zFederalJobWageDeterminationHistoryVersionObject = z.object({
     job_wage_determination_id: z.string(),
     job_id: z.string(),
     pwa_trade_id: z.string(),
+    overtime_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Federal']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -3867,6 +3886,7 @@ export const zRegionalJobWageDeterminationHistoryVersionObject = z.object({
     job_wage_determination_id: z.string(),
     job_id: z.string(),
     pwa_trade_id: z.string(),
+    overtime_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Regional']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -3919,12 +3939,62 @@ export const zRegionalJobWageDeterminationParameters = z.object({
     regional_fields: zRegionalWageDeterminationFields.optional()
 });
 /**
- * Parameters for creating a job wage determination. Provide the Federal or Regional shape; the type discriminator selects which. There is no update endpoint.
+ * 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.
  */
 export const zJobWageDeterminationParameters = z.discriminatedUnion('type', [
     zFederalJobWageDeterminationParameters.extend({ type: z.literal('Pwa::JobWageDeterminations::Federal') }),
     zRegionalJobWageDeterminationParameters.extend({ type: z.literal('Pwa::JobWageDeterminations::Regional') })
 ]);
+/**
+ * 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.
+ */
+export const zJobWageDeterminationUpdateParameters = z.object({
+    effective_from: z.iso.date().optional(),
+    labor_classification: z.string().optional(),
+    pwa_trade_id: z.string().optional(),
+    hourly_rate_cents: z.string().optional(),
+    fringe_rate_cents: z.string().optional(),
+    class_code: z.string().nullish(),
+    construction_category: z.enum([
+        'building',
+        'heavy',
+        'highway',
+        'residential'
+    ]).nullish(),
+    general_wage_determination: z.string().nullish(),
+    regional_fields: zRegionalWageDeterminationFields.optional()
+});
+/**
+ * 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.
+ */
+export const zJobWageDeterminationScheduledChangeParameters = z.object({
+    effective_date: z.iso.date(),
+    labor_classification: z.string().optional(),
+    pwa_trade_id: z.string().optional(),
+    hourly_rate_cents: z.string().optional(),
+    fringe_rate_cents: z.string().optional(),
+    class_code: z.string().nullish(),
+    construction_category: z.enum([
+        'building',
+        'heavy',
+        'highway',
+        'residential'
+    ]).nullish(),
+    general_wage_determination: z.string().nullish(),
+    regional_fields: zRegionalWageDeterminationFields.optional()
+});
+/**
+ * Parameters for moving where a job wage determination's timeline begins.
+ */
+export const zJobWageDeterminationGenesisParameters = z.object({
+    effective_date: z.iso.date()
+});
+/**
+ * Parameters for scheduling when a job wage determination stops being valid.
+ */
+export const zJobWageDeterminationScheduledTerminationParameters = z.object({
+    effective_date: z.iso.date()
+});
 /**
  * The adjustment applied when a rule matches — an addition to the wage or fringe rate.
  */
@@ -4303,6 +4373,7 @@ export const zAssetsItemParameters = z.object({
     assets_site_id: z.string().optional(),
     user_id: z.string().optional(),
     container_item_id: z.string().optional(),
+    assets_sub_location_id: z.string().optional(),
     performed_by_user_id: z.string()
 });
 /**
@@ -4441,12 +4512,13 @@ export const zAssetsItemFormAssignmentParameters = z.object({
     })
 });
 /**
- * On-hand stock of an item at a site — one row per item and site. Read-only. A site with none of the item has no row at all, since a row is removed once its count reaches zero.
+ * 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.
  */
 export const zAssetsInventoryResponseObject = z.object({
     id: z.string(),
     assets_item_id: z.string(),
     assets_site_id: z.string(),
+    assets_sub_location_id: z.string().nullable(),
     company_id: z.string(),
     quantity_on_hand: z.int(),
     created_at: z.iso.datetime(),
@@ -4478,6 +4550,7 @@ export const zAssetsTransactionEventResponseObject = z.object({
         assets_site_id: z.string().nullable(),
         assignee_id: z.string().nullable(),
         container_item_id: z.string().nullable(),
+        assets_sub_location_id: z.string().nullable(),
         assets_transfer_id: z.string().nullable(),
         performed_by_user_id: z.string(),
         direction: z.enum(['inbound', 'outbound']),
@@ -4628,6 +4701,65 @@ export const zAssetsServiceScheduleTemplateParameters = z.object({
     interval_count: z.int().gte(1),
     performed_by_user_id: z.string()
 });
+/**
+ * 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.
+ */
+export const zAssetsSubLocationResponseObject = z.object({
+    id: z.string(),
+    company_id: z.string(),
+    assets_site_id: z.string().nullable(),
+    container_item_id: z.string().nullable(),
+    parent_id: z.string().nullable(),
+    kind: z.enum([
+        'zone',
+        'aisle',
+        'rack',
+        'shelf',
+        'bin',
+        'drawer'
+    ]).nullable(),
+    name: z.string(),
+    code: z.string(),
+    path_code: z.string(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * 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.
+ */
+export const zAssetsSubLocationParameters = z.object({
+    assets_site_id: z.string().optional(),
+    container_item_id: z.string().optional(),
+    parent_id: z.string().nullish(),
+    kind: z.enum([
+        'zone',
+        'aisle',
+        'rack',
+        'shelf',
+        'bin',
+        'drawer'
+    ]).optional(),
+    name: z.string(),
+    code: z.string()
+});
+/**
+ * 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.
+ */
+export const zAssetsSubLocationUpdateParameters = z.object({
+    assets_site_id: z.string().optional(),
+    container_item_id: z.string().optional(),
+    parent_id: z.string().nullish(),
+    kind: z.enum([
+        'zone',
+        'aisle',
+        'rack',
+        'shelf',
+        'bin',
+        'drawer'
+    ]).optional(),
+    name: z.string().optional(),
+    code: z.string().optional()
+});
 /**
  * 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.
  */
@@ -4646,6 +4778,8 @@ export const zAssetsTransferResponseObject = z.object({
     to_assets_site_id: z.string().nullable(),
     to_user_id: z.string().nullable(),
     to_container_item_id: z.string().nullable(),
+    from_assets_sub_location_id: z.string().nullable(),
+    to_assets_sub_location_id: z.string().nullable(),
     initiated_by_user_id: z.string(),
     completed_at: z.iso.datetime().nullable(),
     transfer_lines: z.array(z.object({
@@ -4666,6 +4800,8 @@ export const zAssetsTransferParameters = z.object({
     to_assets_site_id: z.string().optional(),
     to_user_id: z.string().optional(),
     to_container_item_id: z.string().optional(),
+    from_assets_sub_location_id: z.string().optional(),
+    to_assets_sub_location_id: z.string().optional(),
     performed_by_user_id: z.string(),
     line_items: z.array(z.object({
         assets_item_id: z.string(),
@@ -4677,6 +4813,7 @@ export const zAssetsTransferParameters = z.object({
  */
 export const zAssetsRestockParameters = z.object({
     assets_site_id: z.string(),
+    assets_sub_location_id: z.string().optional(),
     quantity: z.int().gte(1),
     performed_by_user_id: z.string()
 });
@@ -4685,9 +4822,16 @@ export const zAssetsRestockParameters = z.object({
  */
 export const zAssetsAdjustmentParameters = z.object({
     assets_site_id: z.string(),
+    assets_sub_location_id: z.string().optional(),
     new_quantity: z.int().gte(0),
     performed_by_user_id: z.string()
 });
+/**
+ * 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.
+ */
+export const zAssetsArchiveParameters = z.object({
+    performed_by_user_id: z.string()
+});
 /**
  * Success
  */
@@ -5169,6 +5313,22 @@ export const zUpdateItemPath = z.object({
  * Removes an image
  */
 export const zUpdateItemResponse = zAssetsItemResponseObject;
+export const zUnarchiveItemBody = zAssetsArchiveParameters;
+export const zUnarchiveItemPath = z.object({
+    item_id: z.string()
+});
+/**
+ * Success
+ */
+export const zUnarchiveItemResponse = zAssetsItemResponseObject;
+export const zArchiveItemBody = zAssetsArchiveParameters;
+export const zArchiveItemPath = z.object({
+    item_id: z.string()
+});
+/**
+ * Created
+ */
+export const zArchiveItemResponse = zAssetsItemResponseObject;
 export const zListServiceSchedulesPath = z.object({
     item_id: z.string()
 });
@@ -5433,6 +5593,22 @@ export const zUpdateProductPath = z.object({
  * Success (upsert attribute values)
  */
 export const zUpdateProductResponse = zAssetsProductResponseObject;
+export const zUnarchiveProductBody = zAssetsArchiveParameters;
+export const zUnarchiveProductPath = z.object({
+    product_id: z.string()
+});
+/**
+ * Success
+ */
+export const zUnarchiveProductResponse = zAssetsProductResponseObject;
+export const zArchiveProductBody = zAssetsArchiveParameters;
+export const zArchiveProductPath = z.object({
+    product_id: z.string()
+});
+/**
+ * Created
+ */
+export const zArchiveProductResponse = zAssetsProductResponseObject;
 export const zAdjustProductInventoryBody = zAssetsAdjustmentParameters;
 export const zAdjustProductInventoryPath = z.object({
     product_id: z.string()
@@ -5577,6 +5753,55 @@ export const zUpdateSitePath = z.object({
  * Success
  */
 export const zUpdateSiteResponse = zAssetsSiteResponseObject;
+export const zListSubLocationsQuery = z.object({
+    'filter[assets_site_id]': z.string().optional(),
+    'filter[container_item_id]': z.string().optional(),
+    'filter[kind]': z.string().optional(),
+    'filter[created_at][gte]': z.iso.datetime().optional(),
+    'filter[created_at][lte]': z.iso.datetime().optional(),
+    'filter[updated_at][gte]': z.iso.datetime().optional(),
+    'filter[updated_at][lte]': z.iso.datetime().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListSubLocationsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zAssetsSubLocationResponseObject)
+});
+export const zCreateSubLocationBody = zAssetsSubLocationParameters;
+/**
+ * Created
+ */
+export const zCreateSubLocationResponse = zAssetsSubLocationResponseObject;
+export const zDeleteSubLocationPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zDeleteSubLocationResponse = zAssetsSubLocationResponseObject;
+export const zGetSubLocationPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetSubLocationResponse = zAssetsSubLocationResponseObject;
+export const zUpdateSubLocationBody = zAssetsSubLocationUpdateParameters;
+export const zUpdateSubLocationPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateSubLocationResponse = zAssetsSubLocationResponseObject;
 export const zListTransfersQuery = z.object({
     'filter[status]': z.string().optional(),
     filter: z.string().optional(),
@@ -6250,6 +6475,18 @@ export const zGetRateRuleQuery = z.object({
  * Success
  */
 export const zGetRateRuleResponse = zRateRuleResponseObject;
+export const zShiftJobWageDeterminationGenesisBody = zJobWageDeterminationGenesisParameters;
+export const zShiftJobWageDeterminationGenesisHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zShiftJobWageDeterminationGenesisPath = z.object({
+    job_id: z.string(),
+    wage_determination_id: z.string()
+});
+/**
+ * Success
+ */
+export const zShiftJobWageDeterminationGenesisResponse = zJobWageDeterminationResponseObject;
 export const zListJobWageDeterminationHistoryPath = z.object({
     job_id: z.string(),
     wage_determination_id: z.string()
@@ -6265,6 +6502,60 @@ export const zListJobWageDeterminationHistoryResponse = z.object({
     links: zLinks,
     data: z.array(zJobWageDeterminationHistoryVersionObject)
 });
+export const zCancelJobWageDeterminationScheduledChangesHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zCancelJobWageDeterminationScheduledChangesPath = z.object({
+    job_id: z.string(),
+    wage_determination_id: z.string()
+});
+/**
+ * Success
+ */
+export const zCancelJobWageDeterminationScheduledChangesResponse = zJobWageDeterminationResponseObject;
+export const zListJobWageDeterminationScheduledChangesPath = z.object({
+    job_id: z.string(),
+    wage_determination_id: z.string()
+});
+/**
+ * Success with scheduled changes
+ */
+export const zListJobWageDeterminationScheduledChangesResponse = z.array(zJobWageDeterminationResponseObject);
+export const zScheduleJobWageDeterminationChangeBody = zJobWageDeterminationScheduledChangeParameters;
+export const zScheduleJobWageDeterminationChangeHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zScheduleJobWageDeterminationChangePath = z.object({
+    job_id: z.string(),
+    wage_determination_id: z.string()
+});
+/**
+ * Created
+ */
+export const zScheduleJobWageDeterminationChangeResponse = zJobWageDeterminationResponseObject;
+export const zCancelJobWageDeterminationScheduledTerminationHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zCancelJobWageDeterminationScheduledTerminationPath = z.object({
+    job_id: z.string(),
+    wage_determination_id: z.string()
+});
+/**
+ * Success
+ */
+export const zCancelJobWageDeterminationScheduledTerminationResponse = zJobWageDeterminationResponseObject;
+export const zScheduleJobWageDeterminationTerminationBody = zJobWageDeterminationScheduledTerminationParameters;
+export const zScheduleJobWageDeterminationTerminationHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zScheduleJobWageDeterminationTerminationPath = z.object({
+    job_id: z.string(),
+    wage_determination_id: z.string()
+});
+/**
+ * Created
+ */
+export const zScheduleJobWageDeterminationTerminationResponse = zJobWageDeterminationResponseObject;
 export const zListJobWageDeterminationsPath = z.object({
     job_id: z.string()
 });
@@ -6313,6 +6604,18 @@ export const zGetJobWageDeterminationQuery = z.object({
  * Success
  */
 export const zGetJobWageDeterminationResponse = zJobWageDeterminationResponseObject;
+export const zUpdateJobWageDeterminationBody = zJobWageDeterminationUpdateParameters;
+export const zUpdateJobWageDeterminationHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zUpdateJobWageDeterminationPath = z.object({
+    job_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateJobWageDeterminationResponse = zJobWageDeterminationResponseObject;
 export const zListJobsQuery = z.object({
     'filter[updated_at][gte]': z.iso.datetime().optional(),
     'filter[updated_at][lte]': z.iso.datetime().optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsptch-work/api-client",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",