@dsptch-work/api-client 0.1.0 → 0.2.0

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

@@ -19,6 +19,11 @@ export type ErrorsObject = {
         message?: string;
     }>;
 };
+export type ApiKeyScopeResponseObject = {
+    resource: string;
+    action: 'read' | 'create' | 'update' | 'delete';
+    name: string;
+};
 /**
  * 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.
  */
@@ -719,9 +724,17 @@ export type TimecodeResponseObject = {
      */
     valid_from: string;
     /**
-     * ISO8601 timestamp at which this version stops being valid (bitemporal valid-time end); a far-future sentinel (year 9999) until the timecode is terminated.
+     * ISO8601 timestamp at which this version stops being valid (bitemporal valid-time end); null until the timecode is terminated.
+     */
+    valid_to: string | null;
+    /**
+     * Transaction time — when this version was recorded in DSPTCH (ISO 8601).
+     */
+    transaction_from: string;
+    /**
+     * Transaction time — when this version was superseded by a correction (ISO 8601); null while it is still the current belief.
      */
-    valid_to: string;
+    transaction_to: string | null;
     /**
      * ISO8601 timestamp when the record was created.
      */
@@ -731,6 +744,33 @@ export type TimecodeResponseObject = {
      */
     updated_at: string;
 };
+export type TimecodeHistoryVersionObject = {
+    id: string;
+    name: string;
+    description: string | null;
+    description_is_required: boolean;
+    billable: boolean;
+    overtime_eligible: boolean;
+    unpaid: boolean;
+    holiday: boolean;
+    pto: boolean;
+    safety: boolean;
+    lunch_shortcut: boolean;
+    break_shortcut: boolean;
+    pwa: boolean;
+    rest_and_recovery: boolean;
+    incentive_pay_eligible: boolean;
+    restricted_to: 'none' | 'job' | 'non_job' | 'job_with_timecode';
+    default_for_company_id: string | null;
+    valid_from: string;
+    valid_to: string | null;
+    transaction_from: string;
+    transaction_to: string | null;
+    created_at: string;
+    updated_at: string;
+    version_status: 'scheduled' | 'current' | 'historical';
+    corrections: Array<TimecodeResponseObject>;
+};
 /**
  * Request body for creating or updating a timecode; only `name` is required. On create, omitted fields take their model/DB defaults (noted per field). On update the request applies a bitemporal correction, so omitted fields keep the current version's values rather than reverting to defaults.
  */
@@ -927,6 +967,10 @@ export type AssetsProductResponseObject = {
      */
     category_id: string | null;
     attributes: AssetsAttributeValueObjects;
+    /**
+     * Images attached to the product; each carries a download url for its file.
+     */
+    images: Array<AssetsAttachmentResponseObject>;
     /**
      * When the record was created (ISO 8601).
      */
@@ -937,7 +981,7 @@ export type AssetsProductResponseObject = {
     updated_at: string;
 };
 /**
- * Create or update a catalog product. `type` (serial or bulk) is required on create and cannot be changed afterward; `performed_by_user_id` is required on create. `attribute_values` upserts the product's category-attribute values.
+ * Create a catalog product. `type` (serial or bulk) is required and immutable. `attribute_values` upserts the product's category-attribute values.
  */
 export type AssetsProductParameters = {
     /**
@@ -997,11 +1041,77 @@ export type AssetsProductParameters = {
          */
         attribute_option_id?: string | null;
     }>;
+    /**
+     * Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
+     */
+    images_attributes?: Array<AssetsAttachmentParameters>;
     /**
      * ID of the user this write is performed on behalf of, recorded for auditing. Required on create; must belong to your company.
      */
     performed_by_user_id: string;
 };
+/**
+ * Update a catalog product. All fields are optional — send only what changes. `type` is immutable and `performed_by_user_id` is create-only, so neither is accepted here. `attribute_values` upserts the product's category-attribute values.
+ */
+export type AssetsProductUpdateParameters = {
+    /**
+     * Human-readable product name.
+     */
+    name?: string;
+    /**
+     * Free-text description of the product. Write-only — accepted here but not returned in the product response.
+     */
+    description?: string | null;
+    /**
+     * ID of the category classifying this product; null when uncategorized.
+     */
+    category_id?: string | null;
+    /**
+     * Universal Product Code; unique within the company. Null when not set.
+     */
+    upc?: string | null;
+    /**
+     * Internal stock-keeping unit (SKU); unique within the company. Null when not set.
+     */
+    internal_sku?: string | null;
+    /**
+     * Default low-stock reorder threshold for this product's items, applied across sites unless a site overrides it. Null when not set.
+     */
+    default_minimum_quantity?: number | null;
+    /**
+     * Manufacturer or brand; required when model is given. Null when not set.
+     */
+    make?: string | null;
+    /**
+     * Model name or number; unique per manufacturer within the company. Null when not set.
+     */
+    model?: string | null;
+    /**
+     * Unit of measure for counting a bulk product's inventory: one of each, pair, or pack. A serial product is always counted each.
+     */
+    counted_by?: 'each' | 'pair' | 'pack';
+    /**
+     * Upserts the values of this product's category attributes, one entry per attribute. Send a blank value and null attribute_option_id to clear one.
+     */
+    attribute_values?: Array<{
+        /**
+         * ID of the attribute definition.
+         */
+        attribute_id: string;
+        /**
+         * The entered value for a non-select attribute (text, number, date, or boolean as a string); null for a select attribute or when unfilled.
+         */
+        value?: string | null;
+        /**
+         * ID of the chosen option for a select attribute; null otherwise.
+         */
+        attribute_option_id?: string | null;
+    }>;
+    /**
+     * Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
+     */
+    images_attributes?: Array<AssetsAttachmentParameters>;
+};
 /**
  * A named daily allowance (meals, lodging, travel, and the like) that a company can attach to time.
  */
@@ -1601,6 +1711,28 @@ export type PayPeriodConfigResponseObject = {
      */
     created_at: string;
 };
+export type PayPeriodConfigHistoryVersionObject = {
+    uid: string;
+    company_id: string;
+    name: string;
+    frequency: 'weekly' | 'biweekly';
+    start_day_of_week: number;
+    tz_name: string;
+    currency: string;
+    status: 'synced' | 'pending' | 'failed';
+    payroll_mode: 'none' | 'base' | 'aggregate';
+    time_mode: 'none' | 'base' | 'aggregate';
+    payroll_system: 'rippling' | 'quickbooks_online' | 'paychex' | 'gusto';
+    actuals_enabled: boolean | null;
+    requires_external_map_contributor: boolean;
+    is_paid_after_holiday: boolean;
+    is_demo: boolean | null;
+    valid_from: string;
+    valid_to: string | null;
+    created_at: string;
+    version_status: 'scheduled' | 'current' | 'historical';
+    corrections: Array<PayPeriodConfigResponseObject>;
+};
 /**
  * Create or update a holiday on a pay schedule. name, holiday_type, and month are required; mday is required for fixed holidays and wday + week for floating holidays (enforced by model validation).
  */
@@ -3367,19 +3499,6 @@ export type FormSubmissionIndexObject = {
          * When the record was last updated (ISO 8601).
          */
         updated_at?: string;
-        /**
-         * System validity window for this version of the submission (bitemporal).
-         */
-        valid_time?: {
-            /**
-             * When this version became valid (ISO 8601).
-             */
-            start?: string;
-            /**
-             * When this version stopped being valid (ISO 8601); null for the current version.
-             */
-            end?: string | null;
-        };
     }>;
 };
 /**
@@ -3433,19 +3552,6 @@ export type FormSubmissionResponseObject = {
      * When the record was last updated (ISO 8601).
      */
     updated_at: string;
-    /**
-     * System validity window for this version of the submission (bitemporal).
-     */
-    valid_time: {
-        /**
-         * When this version became valid (ISO 8601).
-         */
-        start?: string;
-        /**
-         * When this version stopped being valid (ISO 8601); null for the current version.
-         */
-        end?: string | null;
-    };
 };
 /**
  * Request body for updating a worker's employment at your company. Corrects administrative fields (employment type, title, manager, payroll id, hire date, and time-and-attendance enrollment) across the whole employment history. For time-effective pay changes, use the scheduled-changes endpoints instead.
@@ -4713,17 +4819,17 @@ export type PayrollExternalMapResponseObject = {
      */
     valid_from: string;
     /**
-     * Valid time — when this version stops being true (ISO 8601); a far-future sentinel (year 9999) while open-ended.
+     * Valid time — when this version stops being true (ISO 8601); null while it is still current.
      */
-    valid_to: string;
+    valid_to: string | null;
     /**
      * Transaction time — when this version was recorded in DSPTCH (ISO 8601).
      */
     transaction_from: string;
     /**
-     * Transaction time — when this version was superseded by a correction (ISO 8601); a far-future sentinel (year 9999) while current.
+     * Transaction time — when this version was superseded by a correction (ISO 8601); null while it is still the current belief.
      */
-    transaction_to: string;
+    transaction_to: string | null;
     /**
      * When the record was created (ISO 8601).
      */
@@ -4733,8 +4839,30 @@ export type PayrollExternalMapResponseObject = {
      */
     updated_at: string;
 };
+export type PayrollExternalMapHistoryVersionObject = {
+    id: string;
+    bitemporal_id: string;
+    name: string;
+    compensation_element_id: string;
+    compensation_element_name: string;
+    compensation_element_category: 'tax' | 'health' | 'retirement' | 'insurance' | 'earning' | 'garnishment' | 'other';
+    pay_period_config_uid: string | null;
+    fringe_benefit_plan_id: string | null;
+    contributor: 'any' | 'employee' | 'employer';
+    annual_periods: number;
+    created_by_user_id: string | null;
+    global: boolean;
+    valid_from: string;
+    valid_to: string | null;
+    transaction_from: string;
+    transaction_to: string | null;
+    created_at: string;
+    updated_at: string;
+    version_status: 'scheduled' | 'current' | 'historical';
+    corrections: Array<PayrollExternalMapResponseObject>;
+};
 /**
- * A payroll run — a record of one payroll-processing event as it occurred in the external payroll system (not a run initiated by DSPTCH). Paystubs belong to a run.
+ * A payroll run — a record of one payroll-processing event, synced from an external payroll system or reported to DSPTCH (never a run DSPTCH itself initiates). Paystubs belong to a run.
  */
 export type PayrollRunResponseObject = {
     /**
@@ -4758,7 +4886,7 @@ export type PayrollRunResponseObject = {
      */
     run_type: 'CORRECTION' | 'ON_CYCLE' | 'OFF_CYCLE' | 'RECONCILIATION' | 'SIGN_ON_BONUS' | 'TERMINATION';
     /**
-     * Date the external provider processed the payroll (YYYY-MM-DD).
+     * Check date of the run (YYYY-MM-DD): the pay period's pay date for an on-cycle run, the provider's check date for a credential-sourced run, or the payment date the reporting company supplied for a self-reported run.
      */
     run_date: string;
     /**
@@ -4795,7 +4923,7 @@ export type PayrollRunParameters = {
      */
     run_type: 'CORRECTION' | 'ON_CYCLE' | 'OFF_CYCLE' | 'RECONCILIATION' | 'SIGN_ON_BONUS' | 'TERMINATION';
     /**
-     * Date the payroll was processed (YYYY-MM-DD). Required.
+     * Check date of the run (YYYY-MM-DD). Required. For a self-reported run (off-cycle with no credential_id), at most 3 days after the current date — later dates fail validation.
      */
     run_date: string;
     /**
@@ -5185,9 +5313,9 @@ export type ComplianceCheckResponseObject = {
      */
     type: 'Compliances::CompanyCheck' | 'Compliances::JobCheck' | 'Compliances::ProjectCheck' | 'Compliances::TimeCardCheck' | 'Compliances::PayPeriodCheck' | 'Compliances::UserCheck' | 'Compliances::UserCompanyCheck';
     /**
-     * Lifecycle status of the check: one of passed, failed, not_applicable, dismissed, pending, or error; only dismissed and pending are client-settable (see compliance_check_parameters).
+     * Lifecycle status of the check: one of passed, failed, not_applicable, dismissed, or pending; only dismissed and pending are client-settable (see compliance_check_parameters).
      */
-    status: 'passed' | 'failed' | 'not_applicable' | 'dismissed' | 'pending' | 'error';
+    status: 'passed' | 'failed' | 'not_applicable' | 'dismissed' | 'pending';
     /**
      * ID of the requirement this check evaluates.
      */
@@ -6698,6 +6826,10 @@ export type FederalJobWageDeterminationResponseObject = {
      * ID of the job this wage determination applies to.
      */
     job_id: string;
+    /**
+     * UUID of the craft grouping (trade) this determination pools into for apprenticeship-ratio tracking; obtain one from the job or project PWA trades endpoint before assigning it here.
+     */
+    trade_id: string;
     /**
      * Determination type — the Federal or Regional subtype (an STI class name). Federal carries a DOL class code and construction category; Regional carries the nested regional_fields object.
      */
@@ -6726,7 +6858,14 @@ export type FederalJobWageDeterminationResponseObject = {
      * The DOL general wage determination the rates are drawn from — the general decision number plus its revision (e.g. "CA20230001/5"); null when not recorded.
      */
     general_wage_determination: string | null;
-    valid_time: WageDeterminationValidTime;
+    /**
+     * Valid time — when this version of the determination took effect (ISO 8601).
+     */
+    valid_from: string;
+    /**
+     * Valid time — when this version stopped applying (ISO 8601); null while it is still current.
+     */
+    valid_to: string | null;
     /**
      * When the record was created (ISO 8601).
      */
@@ -6752,6 +6891,10 @@ export type RegionalJobWageDeterminationResponseObject = {
      * ID of the job this wage determination applies to.
      */
     job_id: string;
+    /**
+     * UUID of the craft grouping (trade) this determination pools into for apprenticeship-ratio tracking; obtain one from the job or project PWA trades endpoint before assigning it here.
+     */
+    trade_id: string;
     /**
      * Determination type — the Federal or Regional subtype (an STI class name). Federal carries a DOL class code and construction category; Regional carries the nested regional_fields object.
      */
@@ -6773,7 +6916,14 @@ export type RegionalJobWageDeterminationResponseObject = {
      */
     general_wage_determination: string | null;
     regional_fields: RegionalWageDeterminationFields;
-    valid_time: WageDeterminationValidTime;
+    /**
+     * Valid time — when this version of the determination took effect (ISO 8601).
+     */
+    valid_from: string;
+    /**
+     * Valid time — when this version stopped applying (ISO 8601); null while it is still current.
+     */
+    valid_to: string | null;
     /**
      * When the record was created (ISO 8601).
      */
@@ -6783,18 +6933,47 @@ export type RegionalJobWageDeterminationResponseObject = {
      */
     updated_at: string;
 };
-/**
- * The time range over which this version of the wage determination is in effect. Half-open, so a null end means it is still current.
- */
-export type WageDeterminationValidTime = {
-    /**
-     * When this version took effect (ISO 8601).
-     */
-    start: string;
-    /**
-     * When this version stopped applying (ISO 8601); null while it is still current.
-     */
-    end: string | null;
+export type JobWageDeterminationHistoryVersionObject = ({
+    type: 'Pwa::JobWageDeterminations::Federal';
+} & FederalJobWageDeterminationHistoryVersionObject) | ({
+    type: 'Pwa::JobWageDeterminations::Regional';
+} & RegionalJobWageDeterminationHistoryVersionObject);
+export type FederalJobWageDeterminationHistoryVersionObject = {
+    id: string;
+    uid: string;
+    job_id: string;
+    trade_id: string;
+    type: 'Pwa::JobWageDeterminations::Federal';
+    labor_classification: string;
+    hourly_rate_cents: string;
+    fringe_rate_cents: string;
+    class_code: string | null;
+    construction_category: 'building' | 'heavy' | 'highway' | 'residential';
+    general_wage_determination: string | null;
+    valid_from: string;
+    valid_to: string | null;
+    created_at: string;
+    updated_at: string;
+    version_status: 'scheduled' | 'current' | 'historical';
+    corrections: Array<JobWageDeterminationResponseObject>;
+};
+export type RegionalJobWageDeterminationHistoryVersionObject = {
+    id: string;
+    uid: string;
+    job_id: string;
+    trade_id: string;
+    type: 'Pwa::JobWageDeterminations::Regional';
+    labor_classification: string;
+    hourly_rate_cents: string;
+    fringe_rate_cents: string;
+    general_wage_determination: string | null;
+    regional_fields: RegionalWageDeterminationFields;
+    valid_from: string;
+    valid_to: string | null;
+    created_at: string;
+    updated_at: string;
+    version_status: 'scheduled' | 'current' | 'historical';
+    corrections: Array<JobWageDeterminationResponseObject>;
 };
 /**
  * State-specific rate fields for a Regional determination, as decimal-string money in cents
@@ -6837,6 +7016,10 @@ export type FederalJobWageDeterminationParameters = {
      * Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
      */
     labor_classification: string;
+    /**
+     * UUID of the craft grouping (trade) this determination pools into for apprenticeship-ratio tracking; obtain one from the job or project PWA trades endpoint before assigning it here.
+     */
+    trade_id: string;
     /**
      * Base hourly wage rate, in cents as a decimal string (e.g. "5380.0" is $53.80).
      */
@@ -6870,6 +7053,10 @@ export type RegionalJobWageDeterminationParameters = {
      * Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
      */
     labor_classification: string;
+    /**
+     * UUID of the craft grouping (trade) this determination pools into for apprenticeship-ratio tracking; obtain one from the job or project PWA trades endpoint before assigning it here.
+     */
+    trade_id: string;
     /**
      * Base hourly wage rate, in cents as a decimal string (e.g. "5380.0" is $53.80).
      */
@@ -7000,7 +7187,7 @@ export type RateRuleCondition = ({
     type: 'overtime_multiplier';
 } & RateRuleOvertimeMultiplierCondition);
 /**
- * A conditional rate-modification rule on a job wage determination — it adds wage or fringe cents when its conditions match. `valid_time` is the temporal window over which this version of the rule is in effect.
+ * A conditional rate-modification rule on a job wage determination — it adds wage or fringe cents when its conditions match. `valid_from` and `valid_to` bound the window over which this version of the rule is in effect.
  */
 export type RateRuleResponseObject = {
     /**
@@ -7024,7 +7211,14 @@ export type RateRuleResponseObject = {
      * The rule's match conditions, at most one per category (time, day-selection, apprentice, overtime). An empty list means the rule always applies.
      */
     conditions: Array<RateRuleCondition>;
-    valid_time: WageDeterminationValidTime;
+    /**
+     * Valid time — when this version of the rule took effect (ISO 8601).
+     */
+    valid_from: string;
+    /**
+     * Valid time — when this version stopped applying (ISO 8601); null while it is still current.
+     */
+    valid_to: string | null;
     /**
      * When the record was created (ISO 8601).
      */
@@ -7034,6 +7228,20 @@ export type RateRuleResponseObject = {
      */
     updated_at: string;
 };
+export type RateRuleHistoryVersionObject = {
+    id: string;
+    uid: string;
+    job_wage_determination_id: string;
+    pay_rates_rule_package_id: string;
+    effect: RateRuleEffect;
+    conditions: Array<RateRuleCondition>;
+    valid_from: string;
+    valid_to: string | null;
+    created_at: string;
+    updated_at: string;
+    version_status: 'scheduled' | 'current' | 'historical';
+    corrections: Array<RateRuleResponseObject>;
+};
 /**
  * Create a rate rule on a job wage determination. `effect` is required. `conditions` is optional — an omitted or empty list makes the rule always apply. `effective_date` (YYYY-MM-DD) sets when the rule takes effect; it defaults to today and cannot predate the earliest applicable wage determination.
  */
@@ -7104,6 +7312,10 @@ export type AssetsItemResponseObject = {
      * URL to this item in an external system.
      */
     external_system_url: string | null;
+    /**
+     * Images attached to the item; each carries a download url for its file.
+     */
+    images: Array<AssetsAttachmentResponseObject>;
     /**
      * When the record was created (ISO 8601).
      */
@@ -7153,6 +7365,10 @@ export type AssetsItemParameters = {
      * URL to this item in an external system.
      */
     external_system_url?: string;
+    /**
+     * Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
+     */
+    images_attributes?: Array<AssetsAttachmentParameters>;
     /**
      * Optional, create only. Stock the new item at this site, recording a receive transaction. Mutually exclusive with user_id.
      */
@@ -7182,6 +7398,10 @@ export type AssetsVendorResponseObject = {
      * ID of the company that owns this record.
      */
     company_id: string;
+    /**
+     * URL of the vendor's logo image; null when no logo is attached.
+     */
+    logo_url: string | null;
     /**
      * When the record was created (ISO 8601).
      */
@@ -7199,6 +7419,10 @@ export type AssetsVendorParameters = {
      * The vendor's name; unique within the company (case-insensitive).
      */
     name: string;
+    /**
+     * A signed_id from POST /api/v1/direct_uploads for a logo image to attach to the vendor.
+     */
+    logo_signed_id?: string;
 };
 /**
  * A physical container that holds a company's assets and inventory — either a fixed, Atlas-mapped location (warehouse or yard) or a standalone mobile container (trailer, truck, van, or conex).
@@ -7383,13 +7607,68 @@ export type AssetsFormAssignmentTriggerParameters = {
      */
     day_of_month_due?: number | null;
     /**
-     * IDs of the users the generated form is assigned to. Used only when assign_to is custom; cleared for the other modes.
+     * IDs of the users the generated form is assigned to. Used only when assign_to is custom; cleared for the other modes.
+     */
+    assigned_user_ids?: Array<string>;
+    /**
+     * IDs of the products this rule applies to; the rule fires for items of these products.
+     */
+    product_ids?: Array<string>;
+};
+/**
+ * A file attached to an asset — an item or product image, or a service-event attachment. Uploaded through the direct-upload flow; the response carries a URL to download it.
+ */
+export type AssetsAttachmentResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    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;
+};
+/**
+ * One attachment in a nested collection. Send file with a signed_id to add one; send id (with _destroy) to remove an existing one.
+ */
+export type AssetsAttachmentParameters = {
+    /**
+     * ID of an existing attachment to remove; omit to add a new one.
+     */
+    id?: string;
+    /**
+     * A signed_id from POST /api/v1/direct_uploads identifying the uploaded blob to attach.
      */
-    assigned_user_ids?: Array<string>;
+    file?: string;
     /**
-     * IDs of the products this rule applies to; the rule fires for items of these products.
+     * Set true to remove the attachment named by id.
      */
-    product_ids?: Array<string>;
+    _destroy?: boolean;
 };
 /**
  * A file attached to an asset item — a document such as a manual, warranty, or certificate. Uploaded through the direct-upload flow and optionally marked as a certified copy.
@@ -7427,10 +7706,6 @@ export type AssetsDocumentResponseObject = {
      * The attached file; null while no blob is attached.
      */
     file: {
-        /**
-         * Signed identifier of the stored file blob.
-         */
-        signed_id: string;
         /**
          * Stored name of the uploaded file.
          */
@@ -7443,6 +7718,10 @@ export type AssetsDocumentResponseObject = {
          * 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).
@@ -7936,6 +8215,10 @@ export type AssetsServiceEventFullResponseObject = {
      * When the service was performed (ISO 8601), at company-local midnight of the service date.
      */
     performed_at: string;
+    /**
+     * Document attachments recorded with the service; each carries a download url for its file.
+     */
+    attachments: Array<AssetsAttachmentResponseObject>;
     /**
      * When the record was created (ISO 8601).
      */
@@ -7946,13 +8229,13 @@ export type AssetsServiceEventFullResponseObject = {
     updated_at: string;
 };
 /**
- * Record a service on an item. kind, performed_on, and performed_by_user_id are required. Link a schedule with assets_service_schedule_id to satisfy it — the schedule then dictates the kind — or omit it for an ad-hoc service or a repair.
+ * Record a service on an item. performed_on and performed_by_user_id are required. When a schedule is linked with assets_service_schedule_id, the schedule dictates the kind; otherwise provide kind for the ad-hoc service or repair.
  */
 export type AssetsServiceEventParameters = {
     /**
      * The kind of service performed: one of calibration, maintenance, or repair. Ignored when assets_service_schedule_id is set — the schedule dictates the kind.
      */
-    kind: 'calibration' | 'maintenance' | 'repair';
+    kind?: 'calibration' | 'maintenance' | 'repair';
     /**
      * Free-text notes on the service; null when none.
      */
@@ -7970,22 +8253,9 @@ export type AssetsServiceEventParameters = {
      */
     performed_by_user_id: string;
     /**
-     * Document attachments for the service. On update, include id to keep an existing one or set _destroy to remove it; omit id to add a new one.
+     * Document attachments for the service. On update, set _destroy with an id to remove an existing one; omit id to add a new one.
      */
-    attachments_attributes?: Array<{
-        /**
-         * ID of an existing attachment to update or remove; omit to add a new one.
-         */
-        id?: string;
-        /**
-         * A signed_id from POST /api/v1/direct_uploads for the attached file.
-         */
-        file?: string;
-        /**
-         * Set true to remove this attachment.
-         */
-        _destroy?: boolean;
-    }>;
+    attachments_attributes?: Array<AssetsAttachmentParameters>;
 };
 /**
  * A product-level service cadence that seeds and syncs the matching schedules on that product's items. Changing its defining fields (name, kind, interval) reconciles linked item schedules in the background.
@@ -8200,6 +8470,21 @@ export type AssetsRetirementParameters = {
      */
     performed_by_user_id: string;
 };
+export type ListApiKeyScopesData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/api_key/scopes';
+};
+export type ListApiKeyScopesResponses = {
+    /**
+     * Success
+     */
+    200: {
+        data?: Array<ApiKeyScopeResponseObject>;
+    };
+};
+export type ListApiKeyScopesResponse = ListApiKeyScopesResponses[keyof ListApiKeyScopesResponses];
 export type ListApprenticesData = {
     body?: never;
     path: {
@@ -9561,7 +9846,7 @@ export type CreateItemErrors = {
 export type CreateItemError = CreateItemErrors[keyof CreateItemErrors];
 export type CreateItemResponses = {
     /**
-     * Created with placement at site
+     * Created with an image
      */
     201: AssetsItemResponseObject;
 };
@@ -9627,7 +9912,7 @@ export type UpdateItemErrors = {
 export type UpdateItemError = UpdateItemErrors[keyof UpdateItemErrors];
 export type UpdateItemResponses = {
     /**
-     * Success
+     * Removes an image
      */
     200: AssetsItemResponseObject;
 };
@@ -10347,7 +10632,7 @@ export type CreateProductErrors = {
 export type CreateProductError = CreateProductErrors[keyof CreateProductErrors];
 export type CreateProductResponses = {
     /**
-     * Created (with category and attribute values)
+     * Created (with an image)
      */
     201: AssetsProductResponseObject;
 };
@@ -10405,7 +10690,7 @@ export type GetProductResponses = {
 };
 export type GetProductResponse = GetProductResponses[keyof GetProductResponses];
 export type UpdateProductData = {
-    body: AssetsProductParameters;
+    body: AssetsProductUpdateParameters;
     path: {
         id: string;
     };
@@ -10885,6 +11170,10 @@ export type CreateTransferData = {
     url: '/api/v1/assets/transfers';
 };
 export type CreateTransferErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorsObject;
     /**
      * Forbidden
      */
@@ -10980,11 +11269,15 @@ export type CreateVendorErrors = {
      * Forbidden
      */
     403: ErrorsObject;
+    /**
+     * Unprocessable Content (non-image logo)
+     */
+    422: ErrorsObject;
 };
 export type CreateVendorError = CreateVendorErrors[keyof CreateVendorErrors];
 export type CreateVendorResponses = {
     /**
-     * Created
+     * Created with a logo
      */
     201: AssetsVendorResponseObject;
 };
@@ -11050,7 +11343,7 @@ export type UpdateVendorErrors = {
 export type UpdateVendorError = UpdateVendorErrors[keyof UpdateVendorErrors];
 export type UpdateVendorResponses = {
     /**
-     * Success
+     * Updated with a logo
      */
     200: AssetsVendorResponseObject;
 };
@@ -11881,7 +12174,7 @@ export type ListChecksData = {
         /**
          * Filter by check status
          */
-        'filter[status]'?: 'passed' | 'failed' | 'not_applicable' | 'dismissed' | 'pending' | 'error';
+        'filter[status]'?: 'passed' | 'failed' | 'not_applicable' | 'dismissed' | 'pending';
         /**
          * Filter by check target type
          */
@@ -12726,11 +13019,52 @@ export type CreateJobTradeResponses = {
     201: PwaTradeResponseObject;
 };
 export type CreateJobTradeResponse = CreateJobTradeResponses[keyof CreateJobTradeResponses];
+export type ListRateRuleHistoryData = {
+    body?: never;
+    path: {
+        job_id: string;
+        wage_determination_uid: string;
+        /**
+         * The rule's version-stable identity, as returned in `uid`.
+         */
+        rate_rule_uid: string;
+    };
+    query?: {
+        'as_of[valid]'?: string;
+    };
+    url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/rate_rules/{rate_rule_uid}/history';
+};
+export type ListRateRuleHistoryErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorsObject;
+    /**
+     * Forbidden
+     */
+    403: ErrorsObject;
+    /**
+     * Not Found
+     */
+    404: ErrorsObject;
+};
+export type ListRateRuleHistoryError = ListRateRuleHistoryErrors[keyof ListRateRuleHistoryErrors];
+export type ListRateRuleHistoryResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta?: Meta;
+        links?: Links;
+        data?: Array<RateRuleHistoryVersionObject>;
+    };
+};
+export type ListRateRuleHistoryResponse = ListRateRuleHistoryResponses[keyof ListRateRuleHistoryResponses];
 export type ListRateRulesData = {
     body?: never;
     path: {
         job_id: string;
-        wage_determination_id: string;
+        wage_determination_uid: string;
     };
     query?: {
         /**
@@ -12742,7 +13076,7 @@ export type ListRateRulesData = {
         'as_of[valid][gte]'?: string;
         'as_of[transaction]'?: string;
     };
-    url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules';
+    url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/rate_rules';
 };
 export type ListRateRulesErrors = {
     /**
@@ -12774,10 +13108,10 @@ export type CreateRateRuleData = {
     body: RateRuleParameters;
     path: {
         job_id: string;
-        wage_determination_id: string;
+        wage_determination_uid: string;
     };
     query?: never;
-    url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules';
+    url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/rate_rules';
 };
 export type CreateRateRuleErrors = {
     /**
@@ -12801,11 +13135,16 @@ export type GetRateRuleData = {
     body?: never;
     path: {
         job_id: string;
-        wage_determination_id: string;
-        id: string;
+        wage_determination_uid: string;
+        uid: string;
     };
-    query?: never;
-    url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}';
+    query?: {
+        /**
+         * Read the version valid at this point in time. Defaults to now.
+         */
+        'as_of[valid]'?: string;
+    };
+    url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/rate_rules/{uid}';
 };
 export type GetRateRuleErrors = {
     /**
@@ -12825,6 +13164,46 @@ export type GetRateRuleResponses = {
     200: RateRuleResponseObject;
 };
 export type GetRateRuleResponse = GetRateRuleResponses[keyof GetRateRuleResponses];
+export type ListJobWageDeterminationHistoryData = {
+    body?: never;
+    path: {
+        job_id: string;
+        /**
+         * The determination's version-stable identity, as returned in `uid`.
+         */
+        wage_determination_uid: string;
+    };
+    query?: {
+        'as_of[valid]'?: string;
+    };
+    url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/history';
+};
+export type ListJobWageDeterminationHistoryErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorsObject;
+    /**
+     * Forbidden
+     */
+    403: ErrorsObject;
+    /**
+     * Not Found
+     */
+    404: ErrorsObject;
+};
+export type ListJobWageDeterminationHistoryError = ListJobWageDeterminationHistoryErrors[keyof ListJobWageDeterminationHistoryErrors];
+export type ListJobWageDeterminationHistoryResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta?: Meta;
+        links?: Links;
+        data?: Array<JobWageDeterminationHistoryVersionObject>;
+    };
+};
+export type ListJobWageDeterminationHistoryResponse = ListJobWageDeterminationHistoryResponses[keyof ListJobWageDeterminationHistoryResponses];
 export type ListJobWageDeterminationsData = {
     body?: never;
     path: {
@@ -12898,10 +13277,10 @@ export type DeleteWageDeterminationData = {
     body?: never;
     path: {
         job_id: string;
-        id: string;
+        uid: string;
     };
     query?: never;
-    url: '/api/v1/jobs/{job_id}/wage_determinations/{id}';
+    url: '/api/v1/jobs/{job_id}/wage_determinations/{uid}';
 };
 export type DeleteWageDeterminationErrors = {
     /**
@@ -12929,10 +13308,15 @@ export type GetJobWageDeterminationData = {
     body?: never;
     path: {
         job_id: string;
-        id: string;
+        uid: string;
     };
-    query?: never;
-    url: '/api/v1/jobs/{job_id}/wage_determinations/{id}';
+    query?: {
+        /**
+         * Read the version valid at this point in time. Defaults to now.
+         */
+        'as_of[valid]'?: string;
+    };
+    url: '/api/v1/jobs/{job_id}/wage_determinations/{uid}';
 };
 export type GetJobWageDeterminationErrors = {
     /**
@@ -13189,6 +13573,49 @@ export type GetCompensationElementResponses = {
     200: CompensationElementResponseObject;
 };
 export type GetCompensationElementResponse = GetCompensationElementResponses[keyof GetCompensationElementResponses];
+export type ListExternalMapHistoryData = {
+    body?: never;
+    path: {
+        /**
+         * The external map's version-stable identity, as returned in `bitemporal_id`.
+         */
+        external_map_id: string;
+    };
+    query?: {
+        /**
+         * Read the timeline as it was recorded at this moment. Defaults to now.
+         */
+        'as_of[transaction]'?: string;
+        'as_of[valid]'?: string;
+    };
+    url: '/api/v1/payrolls/external_maps/{external_map_id}/history';
+};
+export type ListExternalMapHistoryErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorsObject;
+    /**
+     * Forbidden
+     */
+    403: ErrorsObject;
+    /**
+     * Not Found
+     */
+    404: ErrorsObject;
+};
+export type ListExternalMapHistoryError = ListExternalMapHistoryErrors[keyof ListExternalMapHistoryErrors];
+export type ListExternalMapHistoryResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta?: Meta;
+        links?: Links;
+        data?: Array<PayrollExternalMapHistoryVersionObject>;
+    };
+};
+export type ListExternalMapHistoryResponse = ListExternalMapHistoryResponses[keyof ListExternalMapHistoryResponses];
 export type ListExternalMapsData = {
     body?: never;
     path?: never;
@@ -13262,7 +13689,16 @@ export type GetExternalMapData = {
     path: {
         id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Read the version valid at this point in time. Defaults to now.
+         */
+        'as_of[valid]'?: string;
+        /**
+         * Read the version as it was recorded at this point in transaction time. Defaults to now.
+         */
+        'as_of[transaction]'?: string;
+    };
     url: '/api/v1/payrolls/external_maps/{id}';
 };
 export type GetExternalMapErrors = {
@@ -15471,6 +15907,49 @@ export type UpdateTimeEntryResponses = {
     200: TimeEntryResponseObject;
 };
 export type UpdateTimeEntryResponse = UpdateTimeEntryResponses[keyof UpdateTimeEntryResponses];
+export type ListTimecodeHistoryData = {
+    body?: never;
+    path: {
+        /**
+         * The timecode's version-stable identity, as returned in `id`.
+         */
+        timecode_id: string;
+    };
+    query?: {
+        /**
+         * Read the timeline as it was recorded at this moment. Defaults to now.
+         */
+        'as_of[transaction]'?: string;
+        'as_of[valid]'?: string;
+    };
+    url: '/api/v1/timecodes/{timecode_id}/history';
+};
+export type ListTimecodeHistoryErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorsObject;
+    /**
+     * Forbidden
+     */
+    403: ErrorsObject;
+    /**
+     * Not Found
+     */
+    404: ErrorsObject;
+};
+export type ListTimecodeHistoryError = ListTimecodeHistoryErrors[keyof ListTimecodeHistoryErrors];
+export type ListTimecodeHistoryResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta?: Meta;
+        links?: Links;
+        data?: Array<TimecodeHistoryVersionObject>;
+    };
+};
+export type ListTimecodeHistoryResponse = ListTimecodeHistoryResponses[keyof ListTimecodeHistoryResponses];
 export type CancelTimecodeScheduledChangesData = {
     body?: never;
     path: {
@@ -15708,7 +16187,16 @@ export type GetTimecodeData = {
          */
         id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Read the version valid at this point in time. Defaults to now.
+         */
+        'as_of[valid]'?: string;
+        /**
+         * Read the version as it was recorded at this point in transaction time. Defaults to now.
+         */
+        'as_of[transaction]'?: string;
+    };
     url: '/api/v1/timecodes/{id}';
 };
 export type GetTimecodeErrors = {
@@ -15982,6 +16470,45 @@ export type GetAttestationConfigResponses = {
     200: AttestationConfigResponseObject;
 };
 export type GetAttestationConfigResponse = GetAttestationConfigResponses[keyof GetAttestationConfigResponses];
+export type ListPayPeriodConfigHistoryData = {
+    body?: never;
+    path: {
+        /**
+         * The pay schedule's version-stable identity, as returned in `uid`.
+         */
+        pay_period_config_uid: string;
+    };
+    query?: {
+        'as_of[valid]'?: string;
+    };
+    url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/history';
+};
+export type ListPayPeriodConfigHistoryErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorsObject;
+    /**
+     * Forbidden
+     */
+    403: ErrorsObject;
+    /**
+     * Not Found
+     */
+    404: ErrorsObject;
+};
+export type ListPayPeriodConfigHistoryError = ListPayPeriodConfigHistoryErrors[keyof ListPayPeriodConfigHistoryErrors];
+export type ListPayPeriodConfigHistoryResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta?: Meta;
+        links?: Links;
+        data?: Array<PayPeriodConfigHistoryVersionObject>;
+    };
+};
+export type ListPayPeriodConfigHistoryResponse = ListPayPeriodConfigHistoryResponses[keyof ListPayPeriodConfigHistoryResponses];
 export type ListHolidaysData = {
     body?: never;
     path: {
@@ -16193,7 +16720,12 @@ export type GetPayPeriodConfigData = {
     path: {
         uid: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Read the version valid at this point in time. Defaults to now.
+         */
+        'as_of[valid]'?: string;
+    };
     url: '/api/v1/timekeeping/pay_period_configs/{uid}';
 };
 export type GetPayPeriodConfigErrors = {