@dsptch-work/api-client 0.50.0 → 0.51.1

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

@@ -265,6 +265,12 @@ export type Problem = {
  *
  * The upload behind an image attachment's signed id is not an image content type. Upload an image file.
  *
+ * ### certified_payroll_export_blocked
+ *
+ * **Certified Payroll Export Blocked**
+ *
+ * Failing compliance checks block this certified payroll export: a job-level check on the named job, or a time-card check on a worker the export would include. These are the same checks that disable Export in the web app. Resolve the failing checks, then retry.
+ *
  * ### certified_payroll_format_unavailable
  *
  * **Certified Payroll Format Unavailable**
@@ -418,7 +424,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' | '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_export_blocked' | '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';
@@ -3955,6 +3961,9 @@ export type PayPeriodConfigHistoryCorrectionObject = {
     start_day_of_week: number;
     tz_name: string;
     currency: string;
+    /**
+     * New schedules return pending while pay periods are generated. Synced means pay periods were generated for the requested versions and time card synchronization was successfully requested; asynchronous time card jobs may still be queued. Poll until synced or failed. Failed means generation or the synchronization request failed.
+     */
     status: 'synced' | 'pending' | 'failed';
     payroll_mode: 'none' | 'base' | 'aggregate' | null;
     time_mode: 'none' | 'base' | 'aggregate';
@@ -3981,6 +3990,9 @@ export type PayPeriodConfigHistoryVersionObject = {
     start_day_of_week: number;
     tz_name: string;
     currency: string;
+    /**
+     * New schedules return pending while pay periods are generated. Synced means pay periods were generated for the requested versions and time card synchronization was successfully requested; asynchronous time card jobs may still be queued. Poll until synced or failed. Failed means generation or the synchronization request failed.
+     */
     status: 'synced' | 'pending' | 'failed';
     payroll_mode: 'none' | 'base' | 'aggregate' | null;
     time_mode: 'none' | 'base' | 'aggregate';
@@ -7522,7 +7534,7 @@ export type DsptchCprImportResponseObject = {
     updated_at: string;
 };
 /**
- * Submit a certified payroll report for a pay period. The pay period's pay schedule must be in aggregate time mode; a schedule that keeps time as entries is refused. The file carries every column of the DSPTCH CPR template: the payroll, job and employee identifiers, the employer and employee pay, contribution and deduction amounts, the three wage pay rates, and one hours column per multiplier per day of the period — seven days each for a weekly schedule, fourteen for a biweekly one. All of them must be present as column headers, or the file is refused naming the ones missing. Of those, job_id, week_ending_date, employee_payroll_id, one_x_wage_pay_rate and one_five_x_wage_pay_rate must also carry a value on every row, and two_x_wage_pay_rate must whenever any 2x hours column does. federal_labor_classification and regional_labor_classification are read when present, and are needed only where a position has more than one wage determination in a jurisdiction. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
+ * Submit a certified payroll report for a pay period. The pay period's pay schedule must be in aggregate time mode; a schedule that keeps time as entries is refused. The file carries every column of the DSPTCH CPR template: the payroll, job and employee identifiers, the employer and employee pay, contribution and deduction amounts, the three wage pay rates, and one hours column per multiplier per day of the period — seven days each for a weekly schedule, fourteen for a biweekly one. All of them must be present as column headers, or the file is refused naming the ones missing. Of those, job_id, week_ending_date, employee_payroll_id, one_x_wage_pay_rate and one_five_x_wage_pay_rate must also carry a value on every row, and two_x_wage_pay_rate must whenever any 2x hours column does. On a job that tracks prevailing wage, each rate must also be more than 0 when the row has hours at its multiplier: a row that prices such hours at 0 or below answers 422 naming `non_positive_rate_for_prevailing_wage_hours`, and nothing is written. federal_labor_classification and regional_labor_classification are read when present, and are needed only where a position has more than one wage determination in a jurisdiction. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
  *
  * Submitting the same work twice is refused rather than doubled: an import will not write onto a time card that already holds data, so a retry after a submission that already succeeded answers 422 naming `time_card_has_data`, and nothing is written. The guard is per time card, not per file, so a corrected file for the same worker and period is refused the same way — clear that period's data first.
  *
@@ -11305,7 +11317,7 @@ export type JobCaEcprXmlExportsResponseObject = {
     data: Array<JobCaEcprXmlExportResponseObject>;
 };
 /**
- * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. A window with no reportable pay periods answers 422 nothing_exportable.
+ * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. Failing compliance checks that block the export answer 422 certified_payroll_export_blocked. A window with no reportable pay periods answers 422 nothing_exportable.
  */
 export type JobCaEcprXmlExportCreateParameters = {
     /**
@@ -17045,7 +17057,7 @@ export type AssetsSubLocationUpdateParameters = {
     code?: string;
 };
 /**
- * A completed movement of item stock between two holders, each a site, a user, or a container. Each line moves one item; applying the transfer records paired outbound and inbound transactions and updates the on-hand, custody, and containment counts. Transfers created through this API are always completed. One-sided moves (placing or removing an item with only one endpoint) record transactions but no transfer, and so are not represented by this resource.
+ * A movement of item stock between two holders, each a site, a user, or a container. Each line names one item. A completed transfer has applied paired outbound and inbound transactions and updated on-hand, custody, and containment counts. A pending transfer has not moved stock; it waits to be accepted, declined, or cancelled. One-sided moves (placing or removing an item with only one endpoint) record transactions but no transfer, and so are not represented by this resource.
  */
 export type AssetsTransferResponseObject = {
     /**
@@ -17057,9 +17069,9 @@ export type AssetsTransferResponseObject = {
      */
     company_id: string;
     /**
-     * Lifecycle state of the transfer: one of pending, in_transit, completed, or cancelled. Transfers created through this API are always completed.
+     * Lifecycle state of the transfer. The published values are the model's status keys, including declined.
      */
-    status: 'pending' | 'in_transit' | 'completed' | 'cancelled';
+    status: 'pending' | 'in_transit' | 'completed' | 'declined' | 'cancelled';
     /**
      * ID of the source site; null when the source is a user or container.
      */
@@ -17093,9 +17105,17 @@ export type AssetsTransferResponseObject = {
      */
     initiated_by_user_id: string;
     /**
-     * When the transfer was applied (ISO 8601); null for a transfer that is not yet completed.
+     * ID of the user who completed, declined, or cancelled the transfer; null while it is unresolved.
+     */
+    resolved_by_user_id: string | null;
+    /**
+     * When the transfer was applied (ISO 8601); null unless status is completed. Same instant as resolved_at when completed.
      */
     completed_at: string | null;
+    /**
+     * When the transfer was completed, declined, or cancelled (ISO 8601); null while it is unresolved.
+     */
+    resolved_at: string | null;
     /**
      * The item movements in this transfer, one entry per item.
      */
@@ -17127,7 +17147,7 @@ export type AssetsTransferResponseObject = {
     updated_at: string;
 };
 /**
- * Move item stock. Each endpoint is a site, a user, or a container — give at most one per side; more than one on a side, or no endpoint at all, answers 422. With both a source and a destination this is a two-sided transfer (returns the created transfer, 201). With a single open end it is a one-sided move — placing an unplaced item (destination only) or removing it from its holder (source only) — which records transactions but no transfer and returns 204. Moves are applied immediately, so the source must hold enough of each item.
+ * Move item stock. Each endpoint is a site, a user, or a container — give at most one per side; more than one on a side, or no endpoint at all, answers 422. With both a source and a destination this is a two-sided transfer (returns the created transfer, 201). Omit status or send completed to apply it immediately; send pending to persist without moving stock. A pending create requires both endpoints (one endpoint answers 422). With a single open end and completed (or omitted) status it is a one-sided move — placing an unplaced item (destination only) or removing it from its holder (source only) — which records transactions but no transfer and returns 204. A completed create applies immediately, so the source must hold enough of each item.
  */
 export type AssetsTransferParameters = {
     /**
@@ -17166,6 +17186,10 @@ export type AssetsTransferParameters = {
      * ID of the user this move is performed on behalf of, recorded as its initiator. Omission answers 400; supplied null, a blank ID, or a wrong type answers 422. A user outside the company that owns the API key answers 422.
      */
     performed_by_user_id: string;
+    /**
+     * Optional. pending persists the transfer without moving stock. completed (the default when omitted) applies the move immediately. A pending create requires both a source and a destination; one endpoint answers 422. Any other value answers 422.
+     */
+    status?: 'pending' | 'completed';
     /**
      * The items and quantities to move, as a list of row objects; at least one is required. Omission answers 400, and null, an empty list, or a value that is not a list answers 422. A row missing a field answers 400 naming it, and an unknown or wrongly typed row field answers 422 at that row.
      */
@@ -17180,6 +17204,83 @@ export type AssetsTransferParameters = {
         quantity: number;
     }>;
 };
+/**
+ * Answer a transfer — decline, cancel, or reopen it. The named filer is recorded on the step. An optional note is the step comment.
+ */
+export type AssetsTransferCommandParameters = {
+    /**
+     * ID of the user this answer is performed on behalf of, recorded on the step. Omission answers 400; supplied null, a blank ID, or a wrong type answers 422. A user outside the company that owns the API key answers 422.
+     */
+    performed_by_user_id: string;
+    /**
+     * Optional comment recorded with the step. Omit to leave the step without a comment.
+     */
+    note?: string;
+};
+/**
+ * Accept a pending transfer and move its stock. The named filer is recorded on the step. An optional note is the step comment. Optional placements put individual lines away at the destination; a line without a placement lands in the destination holder's own bucket.
+ */
+export type AssetsTransferAcceptanceParameters = {
+    /**
+     * ID of the user this acceptance is performed on behalf of, recorded on the step. Omission answers 400; supplied null, a blank ID, or a wrong type answers 422. A user outside the company that owns the API key answers 422.
+     */
+    performed_by_user_id: string;
+    /**
+     * Optional comment recorded with the step. Omit to leave the step without a comment.
+     */
+    note?: string;
+    /**
+     * Optional list of per-line put-aways at the destination. Omit or send an empty list to land every line in the destination holder's own bucket. A placement that names a line not on the transfer answers 422.
+     */
+    placements?: Array<{
+        /**
+         * ID of the transfer line to put away. A blank ID or a wrong type answers 422 at its row.
+         */
+        line_id: string;
+        /**
+         * Optional. ID of a container at the destination to put this line into. Omit or send null for the destination holder's own bucket. A blank ID or a wrong type answers 422 at its row.
+         */
+        container_id?: string | null;
+        /**
+         * Optional. ID of a storage location at the destination (or inside the named container) to put this line into. Omit or send null for the holder's or container's unbinned bucket. A blank ID or a wrong type answers 422 at its row.
+         */
+        sub_location_id?: string | null;
+    }>;
+};
+/**
+ * Add a line to a pending transfer. The item is identified the same way create's line_items are, under this transfer's source holder. Stock stays with the sender until the transfer is accepted. A resolved transfer answers 422.
+ */
+export type AssetsTransferLineParameters = {
+    /**
+     * ID of the asset item to add. A blank ID or a wrong type answers 422, and an item outside the company that owns the API key answers 404. The source holder must currently hold the item, or the matching bucket answers 404.
+     */
+    assets_item_id: string;
+    /**
+     * Number of units of the item to add, as an integer of 1 or more. Any other value, a fraction or a numeric string included, answers 422.
+     */
+    quantity: number;
+    /**
+     * Optional. The storage location within the source site or container this line's 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 against a user source answers 422.
+     */
+    from_assets_sub_location_id?: string | null;
+    /**
+     * Optional. The storage location within the destination site or container this line will land in when accepted. Omit to leave the line in the destination holder's own bucket. Send null for the same. A blank ID or a wrong type answers 422, and a storage location outside the company that owns the API key answers 404.
+     */
+    to_assets_sub_location_id?: string | null;
+};
+/**
+ * Change a pending transfer line's quantity and/or destination storage location. A resolved transfer answers 422. A line that is not on this transfer answers 404.
+ */
+export type AssetsTransferLineUpdateParameters = {
+    /**
+     * Optional. The new quantity, as an integer of 1 or more. Any other value, a fraction or a numeric string included, answers 422.
+     */
+    quantity?: number;
+    /**
+     * Optional. The storage location within the destination site or container this line will land in when accepted. Send null to land it in the destination holder's own bucket. A blank ID or a wrong type answers 422, and a storage location outside the company that owns the API key answers 404.
+     */
+    to_assets_sub_location_id?: string | null;
+};
 /**
  * Add stock of a bulk product to a holder — a site, a user's custody, or a container — recording a receive transaction. Name the holder with exactly one of assets_site_id, user_id, or container_item_id; several answer 422 at each named key, and none answers 422. Bulk products only.
  */
@@ -21795,6 +21896,206 @@ export type GetTransferResponses = {
     200: AssetsTransferResponseObject;
 };
 export type GetTransferResponse = GetTransferResponses[keyof GetTransferResponses];
+export type AcceptTransferData = {
+    body: AssetsTransferAcceptanceParameters;
+    path: {
+        transfer_id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/transfers/{transfer_id}/acceptance';
+};
+export type AcceptTransferErrors = {
+    /**
+     * Bad Request (missing performed_by_user_id)
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type AcceptTransferError = AcceptTransferErrors[keyof AcceptTransferErrors];
+export type AcceptTransferResponses = {
+    /**
+     * Created
+     */
+    201: AssetsTransferResponseObject;
+};
+export type AcceptTransferResponse = AcceptTransferResponses[keyof AcceptTransferResponses];
+export type DeclineTransferData = {
+    body: AssetsTransferCommandParameters;
+    path: {
+        transfer_id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/transfers/{transfer_id}/decline';
+};
+export type DeclineTransferErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+};
+export type DeclineTransferError = DeclineTransferErrors[keyof DeclineTransferErrors];
+export type DeclineTransferResponses = {
+    /**
+     * Created
+     */
+    201: AssetsTransferResponseObject;
+};
+export type DeclineTransferResponse = DeclineTransferResponses[keyof DeclineTransferResponses];
+export type CancelTransferData = {
+    body: AssetsTransferCommandParameters;
+    path: {
+        transfer_id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/transfers/{transfer_id}/cancellation';
+};
+export type CancelTransferErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+};
+export type CancelTransferError = CancelTransferErrors[keyof CancelTransferErrors];
+export type CancelTransferResponses = {
+    /**
+     * Created
+     */
+    201: AssetsTransferResponseObject;
+};
+export type CancelTransferResponse = CancelTransferResponses[keyof CancelTransferResponses];
+export type ReopenTransferData = {
+    body: AssetsTransferCommandParameters;
+    path: {
+        transfer_id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/transfers/{transfer_id}/reopening';
+};
+export type ReopenTransferErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type ReopenTransferError = ReopenTransferErrors[keyof ReopenTransferErrors];
+export type ReopenTransferResponses = {
+    /**
+     * Created
+     */
+    201: AssetsTransferResponseObject;
+};
+export type ReopenTransferResponse = ReopenTransferResponses[keyof ReopenTransferResponses];
+export type CreateTransferLineData = {
+    body: AssetsTransferLineParameters;
+    path: {
+        transfer_id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/transfers/{transfer_id}/lines';
+};
+export type CreateTransferLineErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreateTransferLineError = CreateTransferLineErrors[keyof CreateTransferLineErrors];
+export type CreateTransferLineResponses = {
+    /**
+     * Created
+     */
+    201: AssetsTransferResponseObject;
+};
+export type CreateTransferLineResponse = CreateTransferLineResponses[keyof CreateTransferLineResponses];
+export type DeleteTransferLineData = {
+    body?: never;
+    path: {
+        transfer_id: string;
+        line_id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/transfers/{transfer_id}/lines/{line_id}';
+};
+export type DeleteTransferLineErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type DeleteTransferLineError = DeleteTransferLineErrors[keyof DeleteTransferLineErrors];
+export type DeleteTransferLineResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteTransferLineResponse = DeleteTransferLineResponses[keyof DeleteTransferLineResponses];
+export type UpdateTransferLineData = {
+    body: AssetsTransferLineUpdateParameters;
+    path: {
+        transfer_id: string;
+        line_id: string;
+    };
+    query?: never;
+    url: '/api/v1/assets/transfers/{transfer_id}/lines/{line_id}';
+};
+export type UpdateTransferLineErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type UpdateTransferLineError = UpdateTransferLineErrors[keyof UpdateTransferLineErrors];
+export type UpdateTransferLineResponses = {
+    /**
+     * Success
+     */
+    200: AssetsTransferResponseObject;
+};
+export type UpdateTransferLineResponse = UpdateTransferLineResponses[keyof UpdateTransferLineResponses];
 export type ListVendorsData = {
     body?: never;
     path?: never;