@dsptch-work/api-client 0.27.0 → 0.29.0

package/dist/gen/sdk.gen.js

@@ -5258,6 +5258,57 @@ export class PaystubImports {
         });
     }
 }
+export class WidePaystubImports {
+    /**
+     * List Wide Paystub Imports
+     *
+     * **Required scope:**
+     *
+     * `payrolls.payroll_runs.imports.wide_paystubs:read`
+     *
+     */
+    static listWidePaystubImports(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/wide_paystubs',
+            ...options
+        });
+    }
+    /**
+     * Create Wide Paystub Import
+     *
+     * **Required scope:**
+     *
+     * `payrolls.payroll_runs.imports.wide_paystubs:create`
+     *
+     */
+    static createWidePaystubImport(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/wide_paystubs',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get Wide Paystub Import
+     *
+     * **Required scope:**
+     *
+     * `payrolls.payroll_runs.imports.wide_paystubs:read`
+     *
+     */
+    static getWidePaystubImport(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/wide_paystubs/{id}',
+            ...options
+        });
+    }
+}
 export class PayrollRuns {
     /**
      * List payroll runs

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

@@ -395,7 +395,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' | 'internal.companies' | 'internal.company_todos' | 'internal.job_todos' | 'internal.project_todos' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'users';
+    resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'compliance.checks' | 'internal.companies' | 'internal.company_todos' | 'internal.job_todos' | 'internal.project_todos' | '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' | 'users';
     /**
      * Metadata describing the file being registered, before its bytes are uploaded.
      */
@@ -5139,6 +5139,10 @@ export type FormDefinitionObject = {
      * Whether the form is always shown to users.
      */
     always_visible: boolean;
+    /**
+     * Whether the form is hidden from free-submit catalogs and available only through assignments and tasks.
+     */
+    assignment_only: boolean;
     /**
      * Whether the form collects sensitive data.
      */
@@ -6072,6 +6076,54 @@ export type PaystubImportParameters = {
      */
     file_signed_id: string;
 };
+/**
+ * One bulk upload of wide paystub amounts against a payroll run, and how it turned out.
+ */
+export type WidePaystubImportResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * The payroll run the amounts were imported against.
+     */
+    payrolls_payroll_run_id: string;
+    /**
+     * Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
+     */
+    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded' | 'withdrawn';
+    /**
+     * How many rows passed validation and were prepared for writing. On a `success` import that is also how many rows were written. On a `failed` one it is not — the import writes all of its rows in a single transaction, so a failure part-way through undoes every write already made while this count still reports every row that had been prepared.
+     */
+    processed_rows_count: number;
+    /**
+     * Every problem found after the import was accepted, oldest row first; empty when there were none, and always empty while the import is `pending`.
+     */
+    processing_errors: Array<ImportProcessingError>;
+    /**
+     * When processing finished; null while the import is still pending.
+     */
+    completed_at: string | null;
+    /**
+     * When the import was submitted.
+     */
+    created_at: string;
+    /**
+     * When the import was last modified.
+     */
+    updated_at: string;
+};
+/**
+ * Submit a spreadsheet of wide paystub amounts for a payroll run. Each row is one employee: payroll_id names them, and every other column is a pay, deduction, or contribution amount. Extra pay-element columns are accepted; they are not unknown columns. The run's pay schedule must record the contributor on the external map (`requires_external_map_contributor`) and must not be connected to a payroll provider; where a provider is configured the paystubs come from that connection and a file is refused. payroll_id must be present as a header and carry a value on every row, or the file is refused naming what is missing. Header matching ignores case and treats spaces as underscores, and column order does not matter.
+ *
+ * Because acceptance is synchronous but the write happens in the background, only one wide paystub import at a time is accepted for a payroll run: while an earlier one is still `pending` or `processing`, a second answers 409 naming `import_in_progress`, and nothing is written. Poll the earlier import until it reports, then submit again.
+ */
+export type WidePaystubImportParameters = {
+    /**
+     * A signed_id from POST /api/v1/direct_uploads identifying the uploaded spreadsheet. Register the upload naming `payrolls.payroll_runs.imports.wide_paystubs` — a signed_id issued for any other resource will not resolve here.
+     */
+    file_signed_id: string;
+};
 /**
  * One bulk upload of time entries against a pay period, and how it turned out.
  */
@@ -8644,7 +8696,7 @@ export type PaystubLineItemResponseObject = {
     updated_at: string;
 };
 /**
- * Request body for creating a paystub line item. All four fields are required.
+ * Request body for creating a paystub line item. All four fields are required. Undeclared body keys are rejected with 400; references outside the authenticated company return 404.
  */
 export type PaystubLineItemParameters = {
     /**
@@ -8660,12 +8712,12 @@ export type PaystubLineItemParameters = {
      */
     contributor: 'employee' | 'employer';
     /**
-     * ID of the external map defining which compensation element this line item represents. Required.
+     * Family ID of the external map defining which compensation element this line item represents. Must be global or belong to a pay schedule of the payroll run company; another schedule within that company is allowed. Required.
      */
     payrolls_external_map_id: string;
 };
 /**
- * Request body for updating a paystub line item. Send only the fields to change.
+ * Request body for updating a paystub line item. Send only the fields to change. Undeclared body keys are rejected with 400; newly supplied references outside the authenticated company return 404.
  */
 export type PaystubLineItemUpdateParameters = {
     /**
@@ -8681,7 +8733,7 @@ export type PaystubLineItemUpdateParameters = {
      */
     contributor?: 'employee' | 'employer';
     /**
-     * ID of the external map defining which compensation element this line item represents. Omit to leave it unchanged.
+     * Family ID of the external map defining which compensation element this line item represents. A changed reference must be global or belong to a pay schedule of the payroll run company. Omit or repeat the held ID to leave the relationship unchanged.
      */
     payrolls_external_map_id?: string;
 };
@@ -10295,6 +10347,10 @@ export type WageDeterminationResponseObject = {
      * Identifier of this determination record — permanent, because the record is an immutable DOL publication; a DOL revision arrives as a new record linked through superseded_by_wage_determination_id, not a rewrite of this one.
      */
     id: string;
+    /**
+     * Stable UUID identifying the annual general decision family, shared by every modification. A successor-year general decision has its own UID. Use id to retrieve a specific published revision.
+     */
+    uid: string;
     /**
      * DOL general decision number identifying this determination (e.g. "CA20240001"); combine with modification_number for the full versioned identifier (e.g. "CA20240001/1").
      */
@@ -13668,6 +13724,10 @@ export type ListApprenticesData = {
          *
          */
         'filter[status]'?: string;
+        /**
+         * Fuzzy-matches the enrolled worker name (trigram word-similarity). Matches the user name only — not the program, occupation, or wage-schedule name.
+         */
+        'filter[name]'?: string;
         'filter[created_at][gte]'?: string;
         'filter[created_at][lte]'?: string;
         'filter[updated_at][gte]'?: string;
@@ -18643,6 +18703,10 @@ export type ListFormSubmissionsData = {
     path?: never;
     query?: {
         'filter[form_definition_id]'?: string;
+        /**
+         * Returns only submissions for this worker.
+         */
+        'filter[user_id]'?: string;
         'filter[created_at][gte]'?: string;
         'filter[created_at][lte]'?: string;
         'filter[updated_at][gte]'?: string;
@@ -22935,6 +22999,140 @@ export type GetPaystubImportResponses = {
     200: PaystubImportResponseObject;
 };
 export type GetPaystubImportResponse = GetPaystubImportResponses[keyof GetPaystubImportResponses];
+export type ListWidePaystubImportsData = {
+    body?: never;
+    path: {
+        payroll_run_id: string;
+    };
+    query?: {
+        /**
+         * Filter by import status:
+         * * `pending`
+         * * `processing`
+         * * `processed`
+         * * `success`
+         * * `failed`
+         * * `superseded`
+         * * `withdrawn`
+         *
+         */
+        'filter[status]'?: string;
+        'filter[completed_at][gte]'?: string;
+        'filter[completed_at][lte]'?: string;
+        'filter[created_at][gte]'?: string;
+        'filter[created_at][lte]'?: string;
+        'filter[updated_at][gte]'?: string;
+        'filter[updated_at][lte]'?: 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;
+        filter?: string;
+        'filter[unexpected]'?: string;
+    };
+    url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/wide_paystubs';
+};
+export type ListWidePaystubImportsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type ListWidePaystubImportsError = ListWidePaystubImportsErrors[keyof ListWidePaystubImportsErrors];
+export type ListWidePaystubImportsResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<WidePaystubImportResponseObject>;
+    };
+};
+export type ListWidePaystubImportsResponse = ListWidePaystubImportsResponses[keyof ListWidePaystubImportsResponses];
+export type CreateWidePaystubImportData = {
+    body: WidePaystubImportParameters;
+    path: {
+        payroll_run_id: string;
+    };
+    query?: never;
+    url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/wide_paystubs';
+};
+export type CreateWidePaystubImportErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Conflict
+     */
+    409: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreateWidePaystubImportError = CreateWidePaystubImportErrors[keyof CreateWidePaystubImportErrors];
+export type CreateWidePaystubImportResponses = {
+    /**
+     * Created
+     */
+    201: WidePaystubImportResponseObject;
+};
+export type CreateWidePaystubImportResponse = CreateWidePaystubImportResponses[keyof CreateWidePaystubImportResponses];
+export type GetWidePaystubImportData = {
+    body?: never;
+    path: {
+        payroll_run_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/wide_paystubs/{id}';
+};
+export type GetWidePaystubImportErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetWidePaystubImportError = GetWidePaystubImportErrors[keyof GetWidePaystubImportErrors];
+export type GetWidePaystubImportResponses = {
+    /**
+     * Success
+     */
+    200: WidePaystubImportResponseObject;
+};
+export type GetWidePaystubImportResponse = GetWidePaystubImportResponses[keyof GetWidePaystubImportResponses];
 export type ListPayrollRunsData = {
     body?: never;
     path?: never;
@@ -23160,10 +23358,18 @@ export type CreatePaystubLineItemData = {
     url: '/api/v1/paystub_line_items';
 };
 export type CreatePaystubLineItemErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */
@@ -23247,6 +23453,10 @@ export type UpdatePaystubLineItemData = {
     url: '/api/v1/paystub_line_items/{id}';
 };
 export type UpdatePaystubLineItemErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -24163,6 +24373,10 @@ export type ListPerDiemsData = {
          * Filter by taxable status
          */
         'filter[taxable]'?: boolean;
+        /**
+         * Fuzzy-matches the per diem name (trigram word-similarity). Matches the name column only.
+         */
+        'filter[name]'?: string;
         'filter[created_at][gte]'?: string;
         'filter[created_at][lte]'?: string;
         'filter[updated_at][gte]'?: string;
@@ -24504,6 +24718,22 @@ export type ListCompletionsData = {
         'filter[scope_kind]'?: string;
         'filter[feature_id]'?: string;
         'filter[created_by_user_id]'?: string;
+        /**
+         * Feature completions on this site, or quantity completions on a job that has exactly this one site.
+         */
+        'filter[site_id]'?: string;
+        /**
+         * Completions whose crew includes this worker. Distinct from created_by_user_id (the filer).
+         */
+        'filter[crew_user_id]'?: string;
+        /**
+         * Completions whose crew includes a current member of this department.
+         */
+        'filter[crew_department_id]'?: string;
+        /**
+         * Completions whose crew includes a member of this group.
+         */
+        'filter[crew_group_id]'?: string;
         'filter[created_at][gte]'?: string;
         'filter[created_at][lte]'?: string;
         'filter[updated_at][gte]'?: string;
@@ -25522,6 +25752,18 @@ export type ListPositionsData = {
         job_id: string;
     };
     query?: {
+        /**
+         * Return positions on this job fulfilled by this user. A user with no position on the job returns an empty list.
+         */
+        'filter[fulfilled_by_user_id]'?: string;
+        /**
+         * Set to `true` to return unfilled positions (no assigned worker).
+         */
+        'filter[fulfilled_by_user_id][null]'?: boolean;
+        /**
+         * Return positions on this job with this function.
+         */
+        'filter[position_function_id]'?: string;
         'filter[created_at][gte]'?: string;
         'filter[created_at][lte]'?: string;
         'filter[updated_at][gte]'?: string;