@dsptch-work/api-client 0.47.0 → 0.49.0

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

@@ -237,12 +237,6 @@ export type Problem = {
  *
  * The item cannot be unarchived while its product is still archived — an item never lives active inside an archived product. Unarchive the product instead, which restores the item along with the rest of the product's holdings.
  *
- * ### recorded_since_termination
- *
- * **Timecode Changed Since Termination**
- *
- * Cancelling this timecode's scheduled termination would silently discard changes recorded since it was terminated. Re-read the timecode and reconcile before retrying.
- *
  * ### span_beyond_timeline_end
  *
  * **Span Beyond Timeline End**
@@ -424,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' | 'pay_schedule_deletion_in_progress' | 'pay_schedule_deletion_refused' | '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';
@@ -3796,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.
  */
@@ -4058,7 +4117,7 @@ export type PwaCompanyDetailsResponseObject = {
      */
     company_id: string;
     /**
-     * California PWCR number (exactly 10 digits, or NA); null when unset.
+     * California PWCR number (exactly 10 digits); null when unset.
      */
     pwcr_number: string | null;
     /**
@@ -4155,7 +4214,7 @@ export type PwaCompanyDetailsResponseObject = {
  */
 export type PwaCompanyDetailsParameters = {
     /**
-     * California PWCR number (exactly 10 digits, or NA).
+     * California PWCR number (exactly 10 digits).
      */
     pwcr_number?: string | null;
     /**
@@ -4252,7 +4311,7 @@ export type PwaCompanyDetailsParameters = {
  */
 export type PwaCompanyDetailsUpdateParameters = {
     /**
-     * California PWCR number (exactly 10 digits, or NA).
+     * California PWCR number (exactly 10 digits).
      */
     pwcr_number?: string | null;
     /**
@@ -12190,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;
     /**
@@ -13255,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.
      */
@@ -16284,7 +16410,7 @@ export type AssetsTransactionEventResponseObject = {
         /**
          * What produced the movement: receive (a stock, unstock, or custody change), adjust (a reconciliation), or transfer (part of a stock transfer).
          */
-        kind: 'receive' | 'adjust' | 'transfer';
+        kind: 'receive' | 'adjust' | 'transfer' | 'transfer_contents';
         /**
          * Number of units moved; always positive.
          */
@@ -16831,10 +16957,6 @@ export type AssetsTransferResponseObject = {
      * ID of the destination container item; null when the destination is a site or user.
      */
     to_container_item_id: string | null;
-    /**
-     * ID of the storage location within the source site or container the stock drew from; null for an unbinned source or a user source.
-     */
-    from_assets_sub_location_id: string | null;
     /**
      * ID of the storage location within the destination site or container the stock landed in; null for an unbinned destination or a user destination.
      */
@@ -16863,6 +16985,10 @@ export type AssetsTransferResponseObject = {
          * Number of units of the item to move; greater than 0.
          */
         quantity: number;
+        /**
+         * ID of the storage location within the source site or container this line's stock drew from; null for an unbinned source or a user source.
+         */
+        from_assets_sub_location_id: string | null;
     }>;
     /**
      * When the record was created (ISO 8601).
@@ -16890,7 +17016,7 @@ export type AssetsTransferParameters = {
      */
     from_container_item_id?: string;
     /**
-     * Optional. The storage location within the source site or container the stock draws from. Omit or send null for the source's unbinned stock. A blank ID or a wrong type answers 422, a storage location outside the company that owns the API key answers 404, and one named without a source site or container, or not belonging to it, answers 422.
+     * Optional. The storage location within the source site or container every line's stock draws from, recorded on each line. Omit or send null for the source's unbinned stock. A blank ID or a wrong type answers 422, a storage location outside the company that owns the API key answers 404, and one named without a source site or container, or not belonging to it, answers 422.
      */
     from_assets_sub_location_id?: string | null;
     /**
@@ -21430,6 +21556,7 @@ export type ListTransfersData = {
          * * `pending`
          * * `in_transit`
          * * `completed`
+         * * `declined`
          * * `cancelled`
          *
          */
@@ -25089,6 +25216,10 @@ export type DeleteGroupErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Unprocessable Content (group is followed)
+     */
+    422: Problem;
 };
 export type DeleteGroupError = DeleteGroupErrors[keyof DeleteGroupErrors];
 export type DeleteGroupResponses = {
@@ -34959,6 +35090,10 @@ export type UpdateApprenticeshipOccupationErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */
@@ -36530,10 +36665,6 @@ export type CancelTimecodeScheduledTerminationErrors = {
      * Not Found
      */
     404: Problem;
-    /**
-     * Conflict
-     */
-    409: Problem;
     /**
      * Precondition Failed
      */
@@ -37375,6 +37506,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;