@dsptch-work/api-client 0.46.0 → 0.48.0

package/dist/gen/zod.gen.js

@@ -194,17 +194,23 @@ export const zProblem = z.object({
  *
  * The company already has a pay schedule, including one starting in the future or ending in the past. Use the existing schedule instead of creating another.
  *
- * ### product_archived
+ * ### pay_schedule_deletion_in_progress
  *
- * **Product Archived**
+ * **Pay Schedule Deletion In Progress**
  *
- * 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.
+ * A reset or deletion is already running for this pay schedule. Wait until it finishes, then retry if the schedule is still present.
+ *
+ * ### pay_schedule_deletion_refused
  *
- * ### recorded_since_termination
+ * **Pay Schedule Deletion Refused**
  *
- * **Timecode Changed Since Termination**
+ * This pay schedule cannot be deleted because it holds recorded time, payroll data, approvals, comments, exports, or payroll mappings that must be retained.
+ *
+ * ### product_archived
+ *
+ * **Product Archived**
  *
- * Cancelling this timecode's scheduled termination would silently discard changes recorded since it was terminated. Re-read the timecode and reconcile before retrying.
+ * 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.
  *
  * ### span_beyond_timeline_end
  *
@@ -415,8 +421,9 @@ export const zProblemTypeCatalog = z.enum([
     'authorization_revoked',
     'import_in_progress',
     'pay_schedule_already_exists',
+    'pay_schedule_deletion_in_progress',
+    'pay_schedule_deletion_refused',
     'product_archived',
-    'recorded_since_termination',
     'span_beyond_timeline_end',
     'version_overlap',
     'precondition_failed',
@@ -465,6 +472,7 @@ export const zDirectUploadParameters = z.object({
         'assets.items.documents',
         'assets.items.service_events',
         'assets.products',
+        'assets.products.documents',
         'assets.vendors',
         'compliance.checks',
         'form_submissions',
@@ -472,6 +480,7 @@ export const zDirectUploadParameters = z.object({
         'internal.company_todos',
         'internal.job_todos',
         'internal.project_todos',
+        'jobs',
         'jobs.documents',
         'jobs.pwa.apprenticeship.good_faith_effort_exceptions',
         'jobs.pwa.cure_payments',
@@ -1919,6 +1928,47 @@ export const zPayPeriodConfigParameters = z.object({
     approvals_deadline_clock_time: z.string().regex(/^([01][0-9]|2[0-3]):[0-5][0-9]$/),
     time_card_auto_lock_days: z.int().nullish()
 });
+/**
+ * Schedule a change to an existing pay schedule. effective_date is required; other fields are optional. tz_name, time_mode, and payroll_mode are refused.
+ */
+export const zPayPeriodConfigUpdateParameters = z.object({
+    effective_date: z.iso.date(),
+    frequency: z.enum(['weekly', 'biweekly']).optional(),
+    start_day_of_week: z.union([
+        z.literal(0),
+        z.literal(1),
+        z.literal(2),
+        z.literal(3),
+        z.literal(4),
+        z.literal(5),
+        z.literal(6)
+    ]).optional(),
+    tz_name: z.string().optional(),
+    rounding_interval: z.union([z.literal(1), z.literal(15)]).optional(),
+    payroll_system: z.enum([
+        'rippling',
+        'quickbooks_online',
+        'paychex',
+        'gusto'
+    ]).nullish(),
+    paid_after_holiday: z.boolean().optional(),
+    arrear_days: z.int().gte(0).optional(),
+    pay_run_deadline_days: z.int().gte(1).optional(),
+    pay_run_deadline_clock_time: z.string().regex(/^([01][0-9]|2[0-3]):[0-5][0-9]$/).optional(),
+    approvals_deadline_days: z.int().gte(0).optional(),
+    approvals_deadline_clock_time: z.string().regex(/^([01][0-9]|2[0-3]):[0-5][0-9]$/).optional(),
+    time_card_auto_lock_days: z.int().nullish(),
+    time_mode: z.enum([
+        'none',
+        'base',
+        'aggregate'
+    ]).optional(),
+    payroll_mode: z.enum([
+        'none',
+        'base',
+        'aggregate'
+    ]).nullish()
+});
 /**
  * A pay schedule (PayPeriodConfig) — the top-level timekeeping unit that sets a company's payroll cadence and tracking modes and generates its stream of pay periods. Reads return the version valid at the requested time; create returns the new schedule, keyed by its stable id.
  */
@@ -2554,6 +2604,7 @@ export const zPwaTradeApprenticeshipOccupationUpdateParameters = z.object({
  * Prevailing-wage / apprenticeship (PWA) compliance details for a job, used in certified-payroll reporting. Common fields are always present when this object exists; regional fields appear only when applicable to the job's region and regional PWA mode. The property is null when no PWA details have been configured; PWA tracking modes alone do not materialize it.
  */
 export const zPwaJobDetailsResponseObject = z.object({
+    lock_in_date: z.iso.date().nullable(),
     contractor_type: z.enum(['prime_contractor', 'sub_contractor']).nullable(),
     pay_full_cash_fringe_by_default: z.boolean(),
     dir_awarding_body_id: z.string().nullish(),
@@ -2569,7 +2620,15 @@ export const zPwaJobDetailsResponseObject = z.object({
     il_dol_public_body_address_id: z.string().nullish(),
     il_dol_contract_number: z.string().nullish(),
     il_shines_project_id: z.string().nullish(),
-    ny_dol_prc_number: z.string().nullish()
+    ny_dol_prc_number: z.string().nullish(),
+    effective_lock_in_date: z.iso.date().readonly().nullable(),
+    lock_in_date_doc: z.object({
+        id: z.string(),
+        filename: z.string(),
+        content_type: z.string(),
+        byte_size: z.int(),
+        url: z.string()
+    }).readonly().nullable()
 }).nullable();
 /**
  * Parameters for creating a job. Sets the job's schedule, work types, address, custom-field values, and optional Prevailing Wage / Apprenticeship (PWA) compliance. `requested_by_company_id` and `created_by_user_id` are required unless `template_id` names a template, whose copy keeps both. Undeclared body keys return 400, and a null for a field that is not nullable or a wrongly typed value returns 422 at its pointer, before any job or relationship is saved.
@@ -2577,6 +2636,8 @@ export const zPwaJobDetailsResponseObject = z.object({
 export const zJobCreateParameters = z.object({
     created_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
     template_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).nullish(),
+    lock_in_date_doc_signed_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
+    performed_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
     name: z.string().nullish(),
     description: z.string().optional(),
     requested_by_company_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
@@ -2615,6 +2676,12 @@ export const zJobCreateParameters = z.object({
         'feature',
         'quantity'
     ]).optional(),
+    work_classification: z.enum([
+        'unspecified',
+        'construction',
+        'long_term_service',
+        'one_time_service'
+    ]).optional(),
     manager_user_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
     timekeeping_timecode_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
     job_work_types_attributes: z.array(z.object({
@@ -2640,6 +2707,7 @@ export const zJobCreateParameters = z.object({
         value: z.string().nullable()
     })).optional(),
     pwa_details: z.object({
+        lock_in_date: z.iso.date().nullish(),
         contractor_type: z.enum(['prime_contractor', 'sub_contractor']).nullish(),
         pay_full_cash_fringe_by_default: z.boolean().optional(),
         dir_awarding_body_id: z.string().nullish(),
@@ -2662,6 +2730,8 @@ export const zJobCreateParameters = z.object({
  * Parameters for updating an existing job. Every field is optional; omit a field to preserve its current value. The resulting job must still satisfy schedule and PWA validation rules. Accepts every shared job field plus a directly settable status and custom-field changes. Sending `created_by_user_id` returns 400 unknown_key, including when it matches the existing creator or is null. Undeclared body keys return 400, and a null for a field that is not nullable or a wrongly typed value returns 422 at its pointer, before any job or relationship changes.
  */
 export const zJobUpdateParameters = z.object({
+    lock_in_date_doc_signed_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
+    performed_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
     name: z.string().nullish(),
     description: z.string().optional(),
     requested_by_company_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
@@ -2700,6 +2770,12 @@ export const zJobUpdateParameters = z.object({
         'feature',
         'quantity'
     ]).optional(),
+    work_classification: z.enum([
+        'unspecified',
+        'construction',
+        'long_term_service',
+        'one_time_service'
+    ]).optional(),
     manager_user_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
     timekeeping_timecode_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
     job_work_types_attributes: z.array(z.object({
@@ -2725,6 +2801,7 @@ export const zJobUpdateParameters = z.object({
         value: z.string().nullable()
     })).optional(),
     pwa_details: z.object({
+        lock_in_date: z.iso.date().nullish(),
         contractor_type: z.enum(['prime_contractor', 'sub_contractor']).nullish(),
         pay_full_cash_fringe_by_default: z.boolean().optional(),
         dir_awarding_body_id: z.string().nullish(),
@@ -6321,6 +6398,12 @@ export const zJobResponseObject = z.object({
     tracks_feature_allocations: z.boolean(),
     requires_feature_allocation: z.boolean(),
     max_one_feature_allocation: z.boolean(),
+    work_classification: z.enum([
+        'unspecified',
+        'construction',
+        'long_term_service',
+        'one_time_service'
+    ]),
     production_tracking_kind: z.enum([
         'none',
         'feature',
@@ -6778,6 +6861,36 @@ export const zLaborRateResponseObject = z.object({
     fringe_percentage_rate: z.string().nullable(),
     fringe_benefit_weekly_rate_cents: z.string().nullable(),
     fringe_benefit_monthly_rate_cents: z.string().nullable(),
+    fringe_calculation: z.object({
+        available: z.boolean(),
+        hourly_cents: z.string().nullable(),
+        reasons: z.array(z.string()),
+        component_ids: z.array(z.string())
+    }),
+    fringe_benefit_components: z.array(z.object({
+        id: z.string(),
+        position: z.int(),
+        amount_cents: z.string(),
+        period: z.enum([
+            'hour',
+            'day',
+            'week',
+            'month',
+            'year',
+            'shift'
+        ]),
+        kind: z.enum([
+            'fringe',
+            'wage_premium',
+            'unresolved'
+        ]),
+        text: z.string(),
+        attachment_status: z.enum(['rate', 'unresolved']),
+        labor_rate_id: z.string().nullable(),
+        source_sha256: z.string(),
+        start_offset: z.int(),
+        end_offset: z.int()
+    })),
     reference_item_ids: z.array(z.string()),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
@@ -8196,7 +8309,27 @@ export const zAssetsDocumentResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Attach a file to an asset item as a document. file is required and takes a signed_id from the direct-upload endpoint.
+ * A file attached to an asset product — a document such as a manual, warranty, or certificate. Uploaded through the direct-upload flow and optionally marked as a certified copy.
+ */
+export const zAssetsProductDocumentResponseObject = z.object({
+    id: z.string(),
+    assets_product_id: z.string(),
+    name: z.string(),
+    filename: z.string().nullable(),
+    description: z.string().nullable(),
+    certified: z.boolean(),
+    created_by_user_id: z.string(),
+    file: z.object({
+        filename: z.string(),
+        content_type: z.string().nullable(),
+        byte_size: z.int(),
+        url: z.string()
+    }).nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * Attach a file to an asset item or product as a document. file is required and takes a signed_id from the direct-upload endpoint.
  */
 export const zAssetsDocumentParameters = z.object({
     file: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/),
@@ -8205,7 +8338,7 @@ export const zAssetsDocumentParameters = z.object({
     performed_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)
 });
 /**
- * Update an asset-item document. All fields are optional — send only what changes. Omit file to retain the existing attachment, or supply a new signed_id to replace it. A document always holds a file, so null answers 422, as does a blank string.
+ * Update an asset item or product document. All fields are optional — send only what changes. Omit file to retain the existing attachment, or supply a new signed_id to replace it. A document always holds a file, so null answers 422, as does a blank string.
  */
 export const zAssetsDocumentUpdateParameters = z.object({
     file: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
@@ -8213,7 +8346,7 @@ export const zAssetsDocumentUpdateParameters = z.object({
     description: z.string().nullish()
 });
 /**
- * One entry in an item document's change history, recorded whenever the document is created, updated, or deleted — including when only its attached file is replaced.
+ * One entry in an asset document's change history, recorded whenever the document is created, updated, or deleted — including when only its attached file is replaced.
  */
 export const zAssetsDocumentVersionResponseObject = z.object({
     id: z.int(),
@@ -8781,6 +8914,115 @@ export const zCompetencyStandardArchiveParametersWritable = z.record(z.string(),
  * Revoke an active grant. The body takes no fields; send an empty object or no body. Revocation sets revoked_at and keeps the row; revoking it again answers 409 authorization_revoked.
  */
 export const zCompetencyAssessorAuthorizationRevocationParametersWritable = z.record(z.string(), z.never());
+/**
+ * Prevailing-wage / apprenticeship (PWA) compliance details for a job, used in certified-payroll reporting. Common fields are always present when this object exists; regional fields appear only when applicable to the job's region and regional PWA mode. The property is null when no PWA details have been configured; PWA tracking modes alone do not materialize it.
+ */
+export const zPwaJobDetailsResponseObjectWritable = z.object({
+    lock_in_date: z.iso.date().nullable(),
+    contractor_type: z.enum(['prime_contractor', 'sub_contractor']).nullable(),
+    pay_full_cash_fringe_by_default: z.boolean(),
+    dir_awarding_body_id: z.string().nullish(),
+    dir_project_id: z.string().nullish(),
+    dir_project_name: z.string().nullish(),
+    dir_contract_id: z.string().nullish(),
+    dir_project_awarding_body_name: z.string().nullish(),
+    dir_project_number: z.string().nullish(),
+    il_dol_project_id: z.string().nullish(),
+    il_dol_state_capital_funds: z.boolean().nullish(),
+    il_dol_public_body_name: z.string().nullish(),
+    il_dol_public_body_contact_id: z.string().nullish(),
+    il_dol_public_body_address_id: z.string().nullish(),
+    il_dol_contract_number: z.string().nullish(),
+    il_shines_project_id: z.string().nullish(),
+    ny_dol_prc_number: z.string().nullish()
+}).nullable();
+/**
+ * A job — the primary unit of work in DSPTCH. Workers fill its positions and track time against it; it optionally tracks Prevailing Wage / Apprenticeship (PWA) compliance and optionally belongs to a project. There is no delete endpoint — cancel or complete a job through its status instead.
+ */
+export const zJobResponseObjectWritable = z.object({
+    id: z.string(),
+    display_id: z.int(),
+    description: z.string(),
+    scheduled_time: z.string().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime(),
+    status: z.string(),
+    start_time: z.iso.date().nullable(),
+    end_time: z.iso.date().nullable(),
+    purchase_order_number: z.string().nullable(),
+    time_card_start_day: zTimeCardStartDay,
+    tz_name: z.string(),
+    require_clock_in: z.boolean(),
+    clock_in_requirement: z.enum([
+        'none',
+        'warning',
+        'required'
+    ]),
+    name: z.string().nullable(),
+    federal_pwa_mode: z.enum([
+        'all',
+        'pw_only',
+        'ap_only',
+        'none'
+    ]),
+    regional_pwa_mode: z.enum([
+        'all',
+        'pw_only',
+        'ap_only',
+        'none'
+    ]),
+    region: z.string().nullable(),
+    send_geofence_reminders: z.boolean().nullable(),
+    allow_customer_access: z.boolean(),
+    created_by_company_id: z.string(),
+    requested_by_company_id: z.string().nullable(),
+    project_id: z.string().nullable(),
+    companies_department_id: z.string().nullable(),
+    manager_users: z.array(z.object({
+        id: z.string(),
+        name: z.string()
+    })),
+    created_by_user: z.object({
+        id: z.string(),
+        name: z.string()
+    }),
+    sites: z.array(z.object({
+        name: z.string(),
+        features: z.array(z.object({
+            name: z.string()
+        }))
+    })),
+    job_address: z.object({
+        label: z.string()
+    }).nullable(),
+    positions: z.array(z.object({
+        position_function: zPositionFunction,
+        fulfilled_by_user_id: z.string().nullable()
+    })),
+    project: z.object({
+        name: z.string()
+    }).nullable(),
+    pwa_details: zPwaJobDetailsResponseObjectWritable,
+    work_types: z.array(z.object({
+        value: z.string()
+    })),
+    timekeeping_timecode_ids: z.array(z.string()),
+    tracks_feature_allocations: z.boolean(),
+    requires_feature_allocation: z.boolean(),
+    max_one_feature_allocation: z.boolean(),
+    work_classification: z.enum([
+        'unspecified',
+        'construction',
+        'long_term_service',
+        'one_time_service'
+    ]),
+    production_tracking_kind: z.enum([
+        'none',
+        'feature',
+        'quantity'
+    ]),
+    custom_fields: z.array(zCustomFieldResponseObject)
+});
 /**
  * A certification held by a worker — the record that a worker earned a certification, with its receipt date, optional expiry, and verification state.
  */
@@ -9831,6 +10073,76 @@ export const zSyncServiceScheduleTemplateResponse = z.object({
     count: z.int(),
     data: z.array(zAssetsServiceScheduleResponseObject)
 });
+export const zListProductDocumentsPath = z.object({
+    product_id: z.string()
+});
+export const zListProductDocumentsQuery = z.object({
+    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 zListProductDocumentsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zAssetsProductDocumentResponseObject)
+});
+export const zCreateProductDocumentBody = zAssetsDocumentParameters;
+export const zCreateProductDocumentPath = z.object({
+    product_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateProductDocumentResponse = zAssetsProductDocumentResponseObject;
+export const zDeleteProductDocumentPath = z.object({
+    product_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteProductDocumentResponse = z.void();
+export const zGetProductDocumentPath = z.object({
+    product_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetProductDocumentResponse = zAssetsProductDocumentResponseObject;
+export const zUpdateProductDocumentBody = zAssetsDocumentUpdateParameters;
+export const zUpdateProductDocumentPath = z.object({
+    product_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateProductDocumentResponse = zAssetsProductDocumentResponseObject;
+export const zListProductDocumentVersionsPath = z.object({
+    product_id: z.string(),
+    document_id: z.string()
+});
+export const zListProductDocumentVersionsQuery = z.object({
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListProductDocumentVersionsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zAssetsDocumentVersionResponseObject)
+});
 export const zListAssetsSitesQuery = z.object({
     'filter[created_at][gte]': z.iso.datetime().optional(),
     'filter[created_at][lte]': z.iso.datetime().optional(),
@@ -11950,6 +12262,13 @@ export const zCreateJobBody = zJobCreateParameters;
  * Created
  */
 export const zCreateJobResponse = zJobResponseObject;
+export const zDeleteJobPath = z.object({
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteJobResponse = z.void();
 export const zGetJobPath = z.object({
     id: z.string()
 });
@@ -14680,6 +14999,12 @@ export const zCreatePayPeriodConfigBody = zPayPeriodConfigParameters;
  * Created
  */
 export const zCreatePayPeriodConfigResponse = zPayPeriodConfigResponseObject;
+export const zDeletePayPeriodConfigHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zDeletePayPeriodConfigPath = z.object({
+    id: z.string()
+});
 export const zGetPayPeriodConfigPath = z.object({
     id: z.string()
 });
@@ -14690,6 +15015,17 @@ export const zGetPayPeriodConfigQuery = z.object({
  * Success
  */
 export const zGetPayPeriodConfigResponse = zPayPeriodConfigResponseObject;
+export const zUpdatePayPeriodConfigBody = zPayPeriodConfigUpdateParameters;
+export const zUpdatePayPeriodConfigHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zUpdatePayPeriodConfigPath = z.object({
+    id: z.string()
+});
+/**
+ * Accepted
+ */
+export const zUpdatePayPeriodConfigResponse = zPayPeriodConfigResponseObject;
 export const zListTimeCardActualsQuery = z.object({
     'filter[timekeeping_time_card_id]': z.string().optional(),
     'filter[created_at][gte]': z.iso.datetime().optional(),

package/package.json

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