@dsptch-work/api-client 0.46.0 → 0.48.0

package/dist/gen/types.gen.d.ts

@@ -219,17 +219,23 @@ export type Problem = {
  *
  * 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.
  *
- * Cancelling this timecode's scheduled termination would silently discard changes recorded since it was terminated. Re-read the timecode and reconcile before retrying.
+ * ### 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.
  *
  * ### span_beyond_timeline_end
  *
@@ -412,7 +418,7 @@ export type Problem = {
  * Another write to the same resource held it for longer than this request was willing to wait, or collided with it, so nothing was applied. The request itself is fine — resend it unchanged after the `Retry-After` window.
  *
  */
-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' | 'forbidden_key' | 'insufficient_api_key_scope' | 'user_scoped_key_required' | 'not_found' | 'already_subscribed' | 'already_terminated' | 'authorization_revoked' | 'import_in_progress' | 'pay_schedule_already_exists' | 'product_archived' | 'recorded_since_termination' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'certified_payroll_format_unavailable' | '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' | 'not_incomplete_permanent_copy' | 'nothing_exportable' | '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' | 'database_timeout' | 'write_contended';
+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' | 'forbidden_key' | 'insufficient_api_key_scope' | 'user_scoped_key_required' | 'not_found' | 'already_subscribed' | 'already_terminated' | 'authorization_revoked' | 'import_in_progress' | 'pay_schedule_already_exists' | 'pay_schedule_deletion_in_progress' | 'pay_schedule_deletion_refused' | 'product_archived' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'certified_payroll_format_unavailable' | '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' | 'not_incomplete_permanent_copy' | 'nothing_exportable' | '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' | 'database_timeout' | 'write_contended';
 export type ApiKeyScopeResponseObject = {
     resource: string;
     action: 'read' | 'create' | 'update' | 'delete';
@@ -425,7 +431,7 @@ export type DirectUploadParameters = {
     /**
      * 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.
      */
-    resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'compliance.checks' | 'form_submissions' | 'internal.companies' | 'internal.company_todos' | 'internal.job_todos' | 'internal.project_todos' | 'jobs.documents' | 'jobs.pwa.apprenticeship.good_faith_effort_exceptions' | 'jobs.pwa.cure_payments' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'payrolls.payroll_runs.imports.wide_paystubs' | 'projects' | 'projects.documents' | 'users';
+    resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.products.documents' | 'assets.vendors' | 'compliance.checks' | 'form_submissions' | 'internal.companies' | 'internal.company_todos' | 'internal.job_todos' | 'internal.project_todos' | 'jobs' | 'jobs.documents' | 'jobs.pwa.apprenticeship.good_faith_effort_exceptions' | 'jobs.pwa.cure_payments' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'payrolls.payroll_runs.imports.wide_paystubs' | 'projects' | 'projects.documents' | 'users';
     /**
      * Metadata describing the file being registered, before its bytes are uploaded.
      */
@@ -3784,6 +3790,71 @@ export type PayPeriodConfigParameters = {
      */
     time_card_auto_lock_days?: number | null;
 };
+/**
+ * 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 type PayPeriodConfigUpdateParameters = {
+    /**
+     * Date the submitted attributes take effect (YYYY-MM-DD), at midnight in the schedule's time zone. Its weekday must match start_day_of_week; the API never snaps to another day.
+     */
+    effective_date: string;
+    /**
+     * Pay frequency: weekly (7 days) or biweekly (14 days).
+     */
+    frequency?: 'weekly' | 'biweekly';
+    /**
+     * Day the pay period begins, 0 (Sunday) through 6 (Saturday). Must match the effective date's weekday.
+     */
+    start_day_of_week?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+     * Refused. A pay schedule's time zone cannot be changed after creation.
+     */
+    tz_name?: string;
+    /**
+     * Time rounding in minutes, 1 or 15.
+     */
+    rounding_interval?: 1 | 15;
+    /**
+     * Payroll provider; send null to clear.
+     */
+    payroll_system?: 'rippling' | 'quickbooks_online' | 'paychex' | 'gusto' | null;
+    /**
+     * Move pay dates after banking holidays rather than before.
+     */
+    paid_after_holiday?: boolean;
+    /**
+     * Whole days from the pay period's end to payday; must cover both deadline intervals.
+     */
+    arrear_days?: number;
+    /**
+     * Calendar-day lead for the pay-run deadline. Send together with pay_run_deadline_clock_time.
+     */
+    pay_run_deadline_days?: number;
+    /**
+     * Pay-run deadline's local clock time (HH:MM). Send together with pay_run_deadline_days.
+     */
+    pay_run_deadline_clock_time?: string;
+    /**
+     * Whole calendar days before the pay-run deadline's date when approvals are due. Send together with approvals_deadline_clock_time.
+     */
+    approvals_deadline_days?: number;
+    /**
+     * Approvals deadline's local clock time (HH:MM). Send together with approvals_deadline_days.
+     */
+    approvals_deadline_clock_time?: string;
+    /**
+     * Signed days from the pay-run deadline until time cards lock; negative values lock earlier, 0 locks at the deadline, null disables locking.
+     */
+    time_card_auto_lock_days?: number | null;
+    /**
+     * Refused. Delete the pay schedule and create it again to change time_mode.
+     */
+    time_mode?: 'none' | 'base' | 'aggregate';
+    /**
+     * Refused. Delete the pay schedule and create it again to change payroll_mode.
+     */
+    payroll_mode?: 'none' | 'base' | 'aggregate' | null;
+};
 /**
  * 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.
  */
@@ -4921,6 +4992,10 @@ export type JobResponseObject = {
      * Whether time entries on this job are capped at one feature allocation.
      */
     max_one_feature_allocation: boolean;
+    /**
+     * Contract work classification; unspecified until confirmed. Does not change rate syncing.
+     */
+    work_classification: 'unspecified' | 'construction' | 'long_term_service' | 'one_time_service';
     /**
      * How this job records production completions: one of none (opts out), feature (per site feature, e.g. a turbine), or quantity (a unit count, e.g. modules). Locked once any completion exists.
      */
@@ -4934,6 +5009,10 @@ export type JobResponseObject = {
  * 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 type PwaJobDetailsResponseObject = {
+    /**
+     * Job contract execution date override. Null means use the project's contract date.
+     */
+    lock_in_date: string | null;
     /**
      * Role of the company on this job for PWA reporting: one of prime_contractor or sub_contractor; null when unset.
      */
@@ -4998,6 +5077,35 @@ export type PwaJobDetailsResponseObject = {
      * New York DOL prevailing-rate-case (PRC) number, a 10-digit identifier; present only for a compatible New York prevailing-wage configuration and null when applicable but unset.
      */
     ny_dol_prc_number?: string | null;
+    /**
+     * Job override, otherwise its project's contract date. Null when neither has a date.
+     */
+    readonly effective_lock_in_date: string | null;
+    /**
+     * Contract date evidence attached to these PWA details. Null when no evidence is attached.
+     */
+    readonly lock_in_date_doc: {
+        /**
+         * ID of the versioned evidence document.
+         */
+        id: string;
+        /**
+         * Original filename of the evidence.
+         */
+        filename: string;
+        /**
+         * MIME type of the evidence file.
+         */
+        content_type: string;
+        /**
+         * Evidence file size in bytes.
+         */
+        byte_size: number;
+        /**
+         * A URL to download the file.
+         */
+        url: string;
+    } | null;
 } | null;
 /**
  * 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.
@@ -5011,6 +5119,14 @@ export type JobCreateParameters = {
      * ID of a job template to copy this job from; when set, the new job is created from that template. Null or omit to start from a blank job; a blank ID or a wrong type answers 422.
      */
     template_id?: string | null;
+    /**
+     * Evidence signed ID uploaded for resource jobs. Omit to retain the file. Requires performed_by_user_id; null is refused.
+     */
+    lock_in_date_doc_signed_id?: string;
+    /**
+     * Visible user filing contract evidence. Required when lock_in_date_doc_signed_id is supplied.
+     */
+    performed_by_user_id?: string;
     /**
      * Human-readable job name, unique within the creating company; null when unset.
      */
@@ -5091,6 +5207,10 @@ export type JobCreateParameters = {
      * How this job records production completions: one of none (opts out), feature (per site feature, e.g. a turbine), or quantity (a unit count, e.g. modules). Locked once any completion exists. Omit the field to leave the current value unchanged.
      */
     production_tracking_kind?: 'none' | 'feature' | 'quantity';
+    /**
+     * Contract work classification. Defaults to unspecified; construction, long_term_service, and one_time_service identify the confirmed kind.
+     */
+    work_classification?: 'unspecified' | 'construction' | 'long_term_service' | 'one_time_service';
     /**
      * Complete desired set of unique nonblank manager user IDs. Omit to preserve the set; send an empty array to clear it. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422 before any job or relationship is saved.
      */
@@ -5182,6 +5302,10 @@ export type JobCreateParameters = {
      * Prevailing-wage / apprenticeship (PWA) compliance details to set on the job. Omit or send an empty object to make no PWA-details changes. Null or a non-object answers 422, and so does an unknown key or a wrongly typed field inside it, at its pointer. The accepted regional keys depend on the effective region and regional PWA mode.
      */
     pwa_details?: {
+        /**
+         * Job contract execution date override. Null clears the override and uses the project's contract date.
+         */
+        lock_in_date?: string | null;
         /**
          * Role of the company on this job for PWA reporting: one of prime_contractor or sub_contractor; null when unset.
          */
@@ -5252,6 +5376,14 @@ export type JobCreateParameters = {
  * 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 type JobUpdateParameters = {
+    /**
+     * Evidence signed ID uploaded for resource jobs. Omit to retain the file. Requires performed_by_user_id; null is refused.
+     */
+    lock_in_date_doc_signed_id?: string;
+    /**
+     * Visible user filing contract evidence. Required when lock_in_date_doc_signed_id is supplied.
+     */
+    performed_by_user_id?: string;
     /**
      * Human-readable job name, unique within the creating company; null when unset.
      */
@@ -5332,6 +5464,10 @@ export type JobUpdateParameters = {
      * How this job records production completions: one of none (opts out), feature (per site feature, e.g. a turbine), or quantity (a unit count, e.g. modules). Locked once any completion exists. Omit the field to leave the current value unchanged.
      */
     production_tracking_kind?: 'none' | 'feature' | 'quantity';
+    /**
+     * Contract work classification. Defaults to unspecified; construction, long_term_service, and one_time_service identify the confirmed kind.
+     */
+    work_classification?: 'unspecified' | 'construction' | 'long_term_service' | 'one_time_service';
     /**
      * Complete desired set of unique nonblank manager user IDs. Omit to preserve the set; send an empty array to clear it. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422 before any job or relationship is saved.
      */
@@ -5423,6 +5559,10 @@ export type JobUpdateParameters = {
      * Prevailing-wage / apprenticeship (PWA) compliance details to set on the job. Omit or send an empty object to make no PWA-details changes. Null or a non-object answers 422, and so does an unknown key or a wrongly typed field inside it, at its pointer. The accepted regional keys depend on the effective region and regional PWA mode.
      */
     pwa_details?: {
+        /**
+         * Job contract execution date override. Null clears the override and uses the project's contract date.
+         */
+        lock_in_date?: string | null;
         /**
          * Role of the company on this job for PWA reporting: one of prime_contractor or sub_contractor; null when unset.
          */
@@ -12109,7 +12249,7 @@ export type ProductionJobScopePriceResponseObject = {
      */
     unit_of_measure: string;
     /**
-     * Billing rate per unit in cents, as a decimal string (e.g. "120000.0" is $1,200.00 and "3.5" is $0.035); a fraction of a cent is kept exactly. Null means the current price is unknown; "0.0" is a known zero price. Present for company keys and for administrators, managers, safety managers, and field leads of the company that owns the job; omitted for other user keys.
+     * Billing rate per unit in cents, as a decimal string (e.g. "120000.0" is $1,200.00 and "3.5" is $0.035); a fraction of a cent is kept exactly. Null means the current price is unknown; "0.0" is a known zero price. Present for company keys and for administrators, managers, and safety managers of the company that owns the job; omitted for other user keys, including field leads.
      */
     unit_price_cents?: string | null;
     /**
@@ -13174,21 +13314,88 @@ export type LaborRateResponseObject = {
      */
     wage_pay_base_rate_cents: string;
     /**
-     * Hourly fringe rate, in cents as a decimal string (e.g. "1200.0" is $12.00); null when fringe is expressed as a percentage or a weekly or monthly amount instead.
+     * Hourly amount printed in the rate cell, in cents as a decimal string (e.g. "1200.0" is $12.00); null when absent. This source component may coexist with other benefits. Use fringe_calculation to determine whether a complete hourly projection is available.
      */
     fringe_rate_cents: string | null;
     /**
-     * Fringe rate as a percentage of the base wage, as a decimal string (e.g. "15.00" is 15%); null when fringe is a flat hourly amount instead.
+     * Percentage printed in the fringe cell as a decimal string (e.g. "15.00" is 15%); null when absent. It may coexist with an hourly component and requires evaluation before automatic calculation.
      */
     fringe_percentage_rate: string | null;
     /**
-     * Fringe benefit expressed as a weekly amount, in cents as a decimal string; null when fringe is expressed hourly or as a percentage instead.
+     * Weekly amount printed in the rate cell, in cents as a decimal string; null when absent. Additional prose benefits appear in fringe_benefit_components.
      */
     fringe_benefit_weekly_rate_cents: string | null;
     /**
-     * Fringe benefit expressed as a monthly amount, in cents as a decimal string; null when fringe is expressed hourly or as a percentage instead.
+     * Monthly amount printed in the rate cell, in cents as a decimal string; null when absent. Additional prose benefits appear in fringe_benefit_components.
      */
     fringe_benefit_monthly_rate_cents: string | null;
+    fringe_calculation: {
+        /**
+         * Whether all stated fringe benefits have a supported complete hourly projection.
+         */
+        available: boolean;
+        /**
+         * Complete hourly fringe in decimal cents, or null when calculation is unavailable. Never substitute a partial hourly amount or zero for null.
+         */
+        hourly_cents: string | null;
+        /**
+         * Machine-readable reasons preventing automatic calculation.
+         */
+        reasons: Array<string>;
+        /**
+         * Source evidence considered when determining calculation readiness for this classification.
+         */
+        component_ids: Array<string>;
+    };
+    /**
+     * Monetary source occurrences attached to this rate, plus unresolved occurrences from its schedule, preserved individually without adding repeated or conflicting amounts. Each occurrence states its attachment status.
+     */
+    fringe_benefit_components: Array<{
+        /**
+         * Identifier of this captured source occurrence.
+         */
+        id: string;
+        /**
+         * Zero-based printed order within the schedule.
+         */
+        position: number;
+        /**
+         * Exact stated monetary amount as decimal cents; not an hourly conversion.
+         */
+        amount_cents: string;
+        /**
+         * Period printed with the monetary amount.
+         */
+        period: 'hour' | 'day' | 'week' | 'month' | 'year' | 'shift';
+        /**
+         * Whether the clause describes a fringe contribution, a wage premium, or an unresolved monetary term.
+         */
+        kind: 'fringe' | 'wage_premium' | 'unresolved';
+        /**
+         * Verbatim surrounding source paragraph, including stated qualifications.
+         */
+        text: string;
+        /**
+         * Rate means the source establishes the attached classification; unresolved means applicability has not been established and must not be assumed schedule-wide.
+         */
+        attachment_status: 'rate' | 'unresolved';
+        /**
+         * Attached labor rate identifier, or null when applicability is unresolved.
+         */
+        labor_rate_id: string | null;
+        /**
+         * SHA256 of the normalized source document addressed by the character offsets.
+         */
+        source_sha256: string;
+        /**
+         * Inclusive character offset of the monetary occurrence within the normalized source document.
+         */
+        start_offset: number;
+        /**
+         * Exclusive character offset of the monetary occurrence within the normalized source document.
+         */
+        end_offset: number;
+    }>;
     /**
      * IDs of the reference items this rate cites, in the order their letter tokens appear in the source fringe expression.
      */
@@ -15766,11 +15973,73 @@ export type AssetsDocumentResponseObject = {
     updated_at: string;
 };
 /**
- * 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 type AssetsProductDocumentResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * ID of the asset product this document belongs to.
+     */
+    assets_product_id: string;
+    /**
+     * Read-only document label; this API does not set it, so it is always "document".
+     */
+    name: string;
+    /**
+     * The file's human-readable download name; null when not set.
+     */
+    filename: string | null;
+    /**
+     * Free-text description of the document; null when none.
+     */
+    description: string | null;
+    /**
+     * Whether the document has been marked as a certified copy.
+     */
+    certified: boolean;
+    /**
+     * ID of the user who uploaded the document.
+     */
+    created_by_user_id: string;
+    /**
+     * The attached file; null while no blob is attached.
+     */
+    file: {
+        /**
+         * Stored name of the uploaded file.
+         */
+        filename: string;
+        /**
+         * MIME type of the file; null when not recorded.
+         */
+        content_type: string | null;
+        /**
+         * Size of the file in bytes.
+         */
+        byte_size: number;
+        /**
+         * A URL to download the file.
+         */
+        url: string;
+    } | null;
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+};
+/**
+ * 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 type AssetsDocumentParameters = {
     /**
-     * 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. Null and a blank string answer 422.
+     * A signed_id from POST /api/v1/direct_uploads identifying the uploaded blob to attach. Register the upload naming this endpoint's resource (`assets.items.documents` or `assets.products.documents`) — a signed_id issued for any other resource will not resolve here. Null and a blank string answer 422.
      */
     file: string;
     /**
@@ -15787,11 +16056,11 @@ export type AssetsDocumentParameters = {
     performed_by_user_id: string;
 };
 /**
- * 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 type AssetsDocumentUpdateParameters = {
     /**
-     * A signed_id from POST /api/v1/direct_uploads identifying a replacement blob. Register the upload naming `assets.items.documents` — a signed_id issued for any other resource will not resolve here.
+     * A signed_id from POST /api/v1/direct_uploads identifying a replacement blob. Register the upload naming this endpoint's resource (`assets.items.documents` or `assets.products.documents`) — a signed_id issued for any other resource will not resolve here.
      */
     file?: string;
     /**
@@ -15804,7 +16073,7 @@ export type AssetsDocumentUpdateParameters = {
     description?: string | null;
 };
 /**
- * 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 type AssetsDocumentVersionResponseObject = {
     /**
@@ -16889,6 +17158,287 @@ export type CompetencyStandardArchiveParametersWritable = {
 export type CompetencyAssessorAuthorizationRevocationParametersWritable = {
     [key: string]: never;
 };
+/**
+ * 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 type JobResponseObjectWritable = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * User-facing sequential job number shown in the app, preserved from the job's original integer identifier.
+     */
+    display_id: number;
+    /**
+     * Free-text description of the job.
+     */
+    description: string;
+    /**
+     * The job's scheduled time window as a timestamp range; null when unscheduled. start_time and end_time name the days it spans in tz_name.
+     */
+    scheduled_time: string | null;
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+    /**
+     * Current lifecycle status: one of pending_provider, pending_schedule, pending_workers, ready, disputed, completed, or cancelled. Mostly derived from job and position state; only completed, cancelled, and disputed can be set directly.
+     */
+    status: string;
+    /**
+     * The job's first day, as a calendar date (`YYYY-MM-DD`) in tz_name; the schedule starts at the start of that day there, the same as the web. Null when unscheduled.
+     */
+    start_time: string | null;
+    /**
+     * The job's last day, as a calendar date (`YYYY-MM-DD`) in tz_name; the schedule ends at the end of that day there, the same as the web. Null when unscheduled.
+     */
+    end_time: string | null;
+    /**
+     * The job's External ID; null when unset. A new or changed value must be unique within the creating company, but jobs saved before that rule may still share one.
+     */
+    purchase_order_number: string | null;
+    time_card_start_day: TimeCardStartDay;
+    /**
+     * Time zone the job's schedule and time tracking are anchored to (e.g. US/Central).
+     */
+    tz_name: string;
+    /**
+     * Compatibility alias — true when clock_in_requirement is warning or required; always boolean.
+     */
+    require_clock_in: boolean;
+    /**
+     * Clock-in enforcement level stored on the job: one of none (no guidance), warning (manual time entries fail the clock-in compliance check), or required (a technician's own time on the job must come from clocking in on DSPTCH Mobile; the technician's own web and user-API-key time-entry writes are refused). A time entry whose time code, as of the entry's start time, is PTO, holiday, or restricted to non-job time entries is exempt at every level. Time-entry writes made with a company API key are not gated. A company-wide clock-in requirement on the time entry's company can make that entry's requirement stricter than this value.
+     */
+    clock_in_requirement: 'none' | 'warning' | 'required';
+    /**
+     * Human-readable job name, unique within the creating company; null when unset.
+     */
+    name: string | null;
+    /**
+     * Federal prevailing-wage / apprenticeship (PWA) tracking mode: one of all (both prevailing wage and apprenticeship), pw_only, ap_only, or none.
+     */
+    federal_pwa_mode: 'all' | 'pw_only' | 'ap_only' | 'none';
+    /**
+     * Regional (state) prevailing-wage / apprenticeship tracking mode: one of all (both prevailing wage and apprenticeship), pw_only, ap_only, or none.
+     */
+    regional_pwa_mode: 'all' | 'pw_only' | 'ap_only' | 'none';
+    /**
+     * Two-letter US state abbreviation for the job's operating region (e.g. CA); required when the job tracks regional prevailing wage, otherwise null.
+     */
+    region: string | null;
+    /**
+     * Whether to send geofence-based clock-in/out reminders for this job; null when unset.
+     */
+    send_geofence_reminders: boolean | null;
+    /**
+     * Whether customers granted access can view this job.
+     */
+    allow_customer_access: boolean;
+    /**
+     * ID of the company that created the job.
+     */
+    created_by_company_id: string;
+    /**
+     * ID of the company that requested the job (for example a general contractor); null when unset.
+     */
+    requested_by_company_id: string | null;
+    /**
+     * ID of the project this job belongs to; null when the job is not part of a project.
+     */
+    project_id: string | null;
+    /**
+     * ID of the provider company's department assigned to this job; null when unassigned. Retrieve department IDs from GET /api/v1/companies/departments.
+     */
+    companies_department_id: string | null;
+    /**
+     * The job's managers, each as a minimal object; empty when the job has no managers.
+     */
+    manager_users: Array<{
+        /**
+         * ID of the manager user.
+         */
+        id: string;
+        /**
+         * Name of the manager user.
+         */
+        name: string;
+    }>;
+    /**
+     * The user who created the job.
+     */
+    created_by_user: {
+        /**
+         * ID of the creating user.
+         */
+        id: string;
+        /**
+         * Name of the creating user.
+         */
+        name: string;
+    };
+    /**
+     * Sites (geofenced locations) associated with the job; empty when none.
+     */
+    sites: Array<{
+        /**
+         * Name of the site.
+         */
+        name: string;
+        /**
+         * Geofenced features within the site; empty when none.
+         */
+        features: Array<{
+            /**
+             * Name of the feature.
+             */
+            name: string;
+        }>;
+    }>;
+    /**
+     * The job's structured address; null when unset.
+     */
+    job_address: {
+        /**
+         * Human-readable one-line address label.
+         */
+        label: string;
+    } | null;
+    /**
+     * Positions on the job — the worker assignments that track time against it; empty when none.
+     */
+    positions: Array<{
+        position_function: PositionFunction;
+        /**
+         * ID of the worker assigned to the position; null when unfilled.
+         */
+        fulfilled_by_user_id: string | null;
+    }>;
+    /**
+     * The project this job belongs to; null when none.
+     */
+    project: {
+        /**
+         * Name of the project.
+         */
+        name: string;
+    } | null;
+    pwa_details: PwaJobDetailsResponseObjectWritable;
+    /**
+     * Work types (trade or scope categories) associated with the job; empty when none.
+     */
+    work_types: Array<{
+        /**
+         * The work-type name.
+         */
+        value: string;
+    }>;
+    /**
+     * IDs of the timecodes currently associated with the job; empty when none.
+     */
+    timekeeping_timecode_ids: Array<string>;
+    /**
+     * Whether the feature-allocation selector is shown for this job.
+     */
+    tracks_feature_allocations: boolean;
+    /**
+     * Whether applicable time entries on this job must carry a feature allocation.
+     */
+    requires_feature_allocation: boolean;
+    /**
+     * Whether time entries on this job are capped at one feature allocation.
+     */
+    max_one_feature_allocation: boolean;
+    /**
+     * Contract work classification; unspecified until confirmed. Does not change rate syncing.
+     */
+    work_classification: 'unspecified' | 'construction' | 'long_term_service' | 'one_time_service';
+    /**
+     * How this job records production completions: one of none (opts out), feature (per site feature, e.g. a turbine), or quantity (a unit count, e.g. modules). Locked once any completion exists.
+     */
+    production_tracking_kind: 'none' | 'feature' | 'quantity';
+    /**
+     * Custom-field values stored on the job, one row per configuration, including hidden configurations; empty when none.
+     */
+    custom_fields: Array<CustomFieldResponseObject>;
+};
+/**
+ * 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 type PwaJobDetailsResponseObjectWritable = {
+    /**
+     * Job contract execution date override. Null means use the project's contract date.
+     */
+    lock_in_date: string | null;
+    /**
+     * Role of the company on this job for PWA reporting: one of prime_contractor or sub_contractor; null when unset.
+     */
+    contractor_type: 'prime_contractor' | 'sub_contractor' | null;
+    /**
+     * Whether new positions on the job default to paying the full fringe as cash.
+     */
+    pay_full_cash_fringe_by_default: boolean;
+    /**
+     * California DIR (Department of Industrial Relations) awarding-body ID; present only for a compatible California prevailing-wage configuration and null when applicable but unset.
+     */
+    dir_awarding_body_id?: string | null;
+    /**
+     * California DIR project registration ID (an 11-digit number); present only for a compatible California prevailing-wage configuration and null when applicable but unset.
+     */
+    dir_project_id?: string | null;
+    /**
+     * California DIR project name; present only for a compatible California prevailing-wage configuration and null when applicable but unset.
+     */
+    dir_project_name?: string | null;
+    /**
+     * California DIR contract ID; present only for a compatible California prevailing-wage configuration and null when applicable but unset.
+     */
+    dir_contract_id?: string | null;
+    /**
+     * California DIR awarding-body name; present only for a compatible California prevailing-wage configuration and null when applicable but unset.
+     */
+    dir_project_awarding_body_name?: string | null;
+    /**
+     * California DIR project number; present only for a compatible California prevailing-wage configuration and null when applicable but unset.
+     */
+    dir_project_number?: string | null;
+    /**
+     * Illinois DOL (Department of Labor) project ID; present only for a compatible Illinois prevailing-wage configuration and null when applicable but unset.
+     */
+    il_dol_project_id?: string | null;
+    /**
+     * Whether the Illinois project is funded with state capital funds; present only for a compatible Illinois prevailing-wage configuration and null when applicable but unset.
+     */
+    il_dol_state_capital_funds?: boolean | null;
+    /**
+     * Illinois DOL public-body name; present only for a compatible Illinois prevailing-wage configuration and null when applicable but unset.
+     */
+    il_dol_public_body_name?: string | null;
+    /**
+     * ID of the Illinois DOL public-body contact; present only for a compatible Illinois prevailing-wage configuration and null when applicable but unset.
+     */
+    il_dol_public_body_contact_id?: string | null;
+    /**
+     * ID of the Illinois DOL public-body address; present only for a compatible Illinois prevailing-wage configuration and null when applicable but unset.
+     */
+    il_dol_public_body_address_id?: string | null;
+    /**
+     * Illinois DOL contract number; present only for a compatible Illinois prevailing-wage configuration and null when applicable but unset.
+     */
+    il_dol_contract_number?: string | null;
+    /**
+     * Illinois SHINES project ID; present only for a compatible Illinois prevailing-wage configuration and null when applicable but unset.
+     */
+    il_shines_project_id?: string | null;
+    /**
+     * New York DOL prevailing-rate-case (PRC) number, a 10-digit identifier; present only for a compatible New York prevailing-wage configuration and null when applicable but unset.
+     */
+    ny_dol_prc_number?: string | null;
+} | null;
 /**
  * A page of certifications held by your company's workers.
  */
@@ -20428,6 +20978,220 @@ export type SyncServiceScheduleTemplateResponses = {
     };
 };
 export type SyncServiceScheduleTemplateResponse = SyncServiceScheduleTemplateResponses[keyof SyncServiceScheduleTemplateResponses];
+export type ListProductDocumentsData = {
+    body?: never;
+    path: {
+        product_id: string;
+    };
+    query?: {
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * 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`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+    };
+    url: '/api/v1/assets/products/{product_id}/documents';
+};
+export type ListProductDocumentsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type ListProductDocumentsError = ListProductDocumentsErrors[keyof ListProductDocumentsErrors];
+export type ListProductDocumentsResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<AssetsProductDocumentResponseObject>;
+    };
+};
+export type ListProductDocumentsResponse = ListProductDocumentsResponses[keyof ListProductDocumentsResponses];
+export type CreateProductDocumentData = {
+    body: AssetsDocumentParameters;
+    path: {
+        product_id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/products/{product_id}/documents';
+};
+export type CreateProductDocumentErrors = {
+    /**
+     * Bad Request (missing performed_by_user_id)
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreateProductDocumentError = CreateProductDocumentErrors[keyof CreateProductDocumentErrors];
+export type CreateProductDocumentResponses = {
+    /**
+     * Created
+     */
+    201: AssetsProductDocumentResponseObject;
+};
+export type CreateProductDocumentResponse = CreateProductDocumentResponses[keyof CreateProductDocumentResponses];
+export type DeleteProductDocumentData = {
+    body?: never;
+    path: {
+        product_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/products/{product_id}/documents/{id}';
+};
+export type DeleteProductDocumentErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type DeleteProductDocumentError = DeleteProductDocumentErrors[keyof DeleteProductDocumentErrors];
+export type DeleteProductDocumentResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteProductDocumentResponse = DeleteProductDocumentResponses[keyof DeleteProductDocumentResponses];
+export type GetProductDocumentData = {
+    body?: never;
+    path: {
+        product_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/products/{product_id}/documents/{id}';
+};
+export type GetProductDocumentErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetProductDocumentError = GetProductDocumentErrors[keyof GetProductDocumentErrors];
+export type GetProductDocumentResponses = {
+    /**
+     * Success
+     */
+    200: AssetsProductDocumentResponseObject;
+};
+export type GetProductDocumentResponse = GetProductDocumentResponses[keyof GetProductDocumentResponses];
+export type UpdateProductDocumentData = {
+    body: AssetsDocumentUpdateParameters;
+    path: {
+        product_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/products/{product_id}/documents/{id}';
+};
+export type UpdateProductDocumentErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type UpdateProductDocumentError = UpdateProductDocumentErrors[keyof UpdateProductDocumentErrors];
+export type UpdateProductDocumentResponses = {
+    /**
+     * Success
+     */
+    200: AssetsProductDocumentResponseObject;
+};
+export type UpdateProductDocumentResponse = UpdateProductDocumentResponses[keyof UpdateProductDocumentResponses];
+export type ListProductDocumentVersionsData = {
+    body?: never;
+    path: {
+        product_id: string;
+        document_id: string;
+    };
+    query?: {
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * 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`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+    };
+    url: '/api/v1/assets/products/{product_id}/documents/{document_id}/versions';
+};
+export type ListProductDocumentVersionsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type ListProductDocumentVersionsError = ListProductDocumentVersionsErrors[keyof ListProductDocumentVersionsErrors];
+export type ListProductDocumentVersionsResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<AssetsDocumentVersionResponseObject>;
+    };
+};
+export type ListProductDocumentVersionsResponse = ListProductDocumentVersionsResponses[keyof ListProductDocumentVersionsResponses];
 export type ListAssetsSitesData = {
     body?: never;
     path?: never;
@@ -24451,6 +25215,10 @@ export type DeleteGroupErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Unprocessable Content (group is followed)
+     */
+    422: Problem;
 };
 export type DeleteGroupError = DeleteGroupErrors[keyof DeleteGroupErrors];
 export type DeleteGroupResponses = {
@@ -27279,6 +28047,36 @@ export type CreateJobResponses = {
     201: JobResponseObject;
 };
 export type CreateJobResponse = CreateJobResponses[keyof CreateJobResponses];
+export type DeleteJobData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/jobs/{id}';
+};
+export type DeleteJobErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type DeleteJobError = DeleteJobErrors[keyof DeleteJobErrors];
+export type DeleteJobResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteJobResponse = DeleteJobResponses[keyof DeleteJobResponses];
 export type GetJobData = {
     body?: never;
     path: {
@@ -34291,6 +35089,10 @@ export type UpdateApprenticeshipOccupationErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */
@@ -35862,10 +36664,6 @@ export type CancelTimecodeScheduledTerminationErrors = {
      * Not Found
      */
     404: Problem;
-    /**
-     * Conflict
-     */
-    409: Problem;
     /**
      * Precondition Failed
      */
@@ -36633,6 +37431,49 @@ export type CreatePayPeriodConfigResponses = {
     201: PayPeriodConfigResponseObject;
 };
 export type CreatePayPeriodConfigResponse = CreatePayPeriodConfigResponses[keyof CreatePayPeriodConfigResponses];
+export type DeletePayPeriodConfigData = {
+    body?: never;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this schedule, or `*` to write against whatever exists. See "Version validators" in the API overview.
+         */
+        'If-Match': string;
+    };
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/timekeeping/pay_period_configs/{id}';
+};
+export type DeletePayPeriodConfigErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Conflict
+     */
+    409: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type DeletePayPeriodConfigError = DeletePayPeriodConfigErrors[keyof DeletePayPeriodConfigErrors];
+export type DeletePayPeriodConfigResponses = {
+    /**
+     * Accepted
+     */
+    202: unknown;
+};
 export type GetPayPeriodConfigData = {
     body?: never;
     path: {
@@ -36664,6 +37505,54 @@ export type GetPayPeriodConfigResponses = {
     200: PayPeriodConfigResponseObject;
 };
 export type GetPayPeriodConfigResponse = GetPayPeriodConfigResponses[keyof GetPayPeriodConfigResponses];
+export type UpdatePayPeriodConfigData = {
+    body: PayPeriodConfigUpdateParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this schedule, or `*` to write against whatever exists. See "Version validators" in the API overview.
+         */
+        'If-Match': string;
+    };
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/timekeeping/pay_period_configs/{id}';
+};
+export type UpdatePayPeriodConfigErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Invalid configuration
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type UpdatePayPeriodConfigError = UpdatePayPeriodConfigErrors[keyof UpdatePayPeriodConfigErrors];
+export type UpdatePayPeriodConfigResponses = {
+    /**
+     * Accepted
+     */
+    202: PayPeriodConfigResponseObject;
+};
+export type UpdatePayPeriodConfigResponse = UpdatePayPeriodConfigResponses[keyof UpdatePayPeriodConfigResponses];
 export type ListTimeCardActualsData = {
     body?: never;
     path?: never;