@dsptch-work/api-client 0.52.1 → 0.53.0

package/dist/gen/sdk.gen.js

@@ -621,6 +621,103 @@ export class ApprenticeshipWageSchedules {
         });
     }
 }
+export class ApprenticeshipWorkProcessCategories {
+    /**
+     * List apprenticeship work process categories
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.occupations.work_process_categories:read`
+     *
+     */
+    static listWorkProcessCategories(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/occupations/{occupation_id}/work_process_categories',
+            ...options
+        });
+    }
+    /**
+     * Create apprenticeship work process category
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.occupations.work_process_categories:create`
+     *
+     */
+    static createWorkProcessCategory(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/occupations/{occupation_id}/work_process_categories',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete apprenticeship work process category
+     *
+     * Deletes an unused work process category nested under the occupation in the
+     * path. A category that still has allocations is refused with a `422`
+     * `destroy_restricted`. An unused category returns `204`. Deletes are
+     * sponsor-only; an enrolled employer is `403`. A missing, out-of-scope, or
+     * mismatched occupation/category pair is `404`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.occupations.work_process_categories:delete`
+     *
+     */
+    static deleteWorkProcessCategory(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/occupations/{occupation_id}/work_process_categories/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show apprenticeship work process category
+     *
+     * Returns one work process category nested under the occupation in the path.
+     * The object matches the list, create, and update door. A missing, out-of-scope,
+     * or mismatched occupation/category pair is not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.occupations.work_process_categories:read`
+     *
+     */
+    static getWorkProcessCategory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/occupations/{occupation_id}/work_process_categories/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update apprenticeship work process category
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.occupations.work_process_categories:update`
+     *
+     */
+    static updateWorkProcessCategory(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/occupations/{occupation_id}/work_process_categories/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class AssetsAttributes {
     /**
      * List Attributes
@@ -2901,6 +2998,117 @@ export class Companies {
         });
     }
 }
+export class CompanyDocuments {
+    /**
+     * List company documents
+     *
+     * Returns the key's company documents, oldest first by `created_at` then `id`.
+     * Each item is either a file or a URL, never both — `file` is null for a
+     * URL-only document.
+     *
+     *
+     * **Required scope:**
+     *
+     * `company_documents:read`
+     *
+     */
+    static listCompanyDocuments(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/company_documents',
+            ...options
+        });
+    }
+    /**
+     * Create company document
+     *
+     * Creates a company document for the key's company. Supply exactly one of
+     * `url` or `file`. `file` is a signed id from `POST /api/v1/direct_uploads`
+     * naming `company_documents`. The company is taken from the credential.
+     * Company keys must send `performed_by_user_id`; user keys act as themselves.
+     *
+     *
+     * **Required scope:**
+     *
+     * `company_documents:create`
+     *
+     */
+    static createCompanyDocument(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/company_documents',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete company document
+     *
+     * Permanently deletes the document. Succeeds with 204 and no body. A missing
+     * or out-of-scope id is 404.
+     *
+     *
+     * **Required scope:**
+     *
+     * `company_documents:delete`
+     *
+     */
+    static deleteCompanyDocument(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/company_documents/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show company document
+     *
+     * Returns one company document owned by the key's company. A missing or
+     * out-of-scope id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `company_documents:read`
+     *
+     */
+    static getCompanyDocument(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/company_documents/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update company document
+     *
+     * Updates the named document. Omitting `file` keeps the stored blob.
+     * `file: null` with a `url` switches to a URL-only document. Undeclared
+     * keys return `400`. A missing or out-of-scope id returns `404`. Company
+     * keys that send `performed_by_user_id` must name a company member (`422`
+     * otherwise) and must send it when attaching a file.
+     *
+     *
+     * **Required scope:**
+     *
+     * `company_documents:update`
+     *
+     */
+    static updateCompanyDocument(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/company_documents/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class CompetenciesAssessments {
     /**
      * List competence assessments
@@ -4623,6 +4831,77 @@ export class Jobs {
             ...options
         });
     }
+    /**
+     * List NY DOL XML exports
+     *
+     * Returns the job-scoped NY DOL XML certified-payroll exports nested on
+     * the named job. A missing or out-of-scope job reads as not found. A visible
+     * job with no exports returns an empty list. Ordered by created_at descending
+     * then id. Read-only. Poll a member GET for generation status and the file URL.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.certified_payrolls.ny_dol_xml_exports:read`
+     *
+     */
+    static listNyDolXmlExports(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/certified_payrolls/ny_dol_xml_exports',
+            ...options
+        });
+    }
+    /**
+     * Create NY DOL XML export
+     *
+     * Enqueues a job-scoped NY DOL XML certified-payroll export over
+     * `start_date`..`end_date`. Returns the pending export (201); poll the member
+     * GET for generation status and the file URL. Requires a user-scoped key. A
+     * job that does not offer NY DOL XML is 422 `certified_payroll_format_unavailable`.
+     * Failing compliance checks that block the export are 422
+     * `certified_payroll_export_blocked`.
+     * A window with no reportable pay periods is 422 `nothing_exportable`.
+     * Does not start DocuSeal signing.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.certified_payrolls.ny_dol_xml_exports:create`
+     *
+     */
+    static createNyDolXmlExport(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/certified_payrolls/ny_dol_xml_exports',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get NY DOL XML export
+     *
+     * Returns one job-scoped NY DOL XML export nested on the named job. Poll
+     * this document for generation status; `file` may be null until the file is
+     * attached, including when status is `success`.
+     * A missing, misnested, or out-of-scope id reads as not found. Read-only.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.certified_payrolls.ny_dol_xml_exports:read`
+     *
+     */
+    static getNyDolXmlExport(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/certified_payrolls/ny_dol_xml_exports/{id}',
+            ...options
+        });
+    }
     /**
      * List WH-347 exports
      *
@@ -5121,6 +5400,94 @@ export class Jobs {
             ...options
         });
     }
+    /**
+     * Create job template
+     *
+     * Creates a job template owned by the key's company. Omit `job_id` for an
+     * empty template job, or send a visible job's id to copy it through the same
+     * `Jobs::Copies::Create` path as the web. `position_option` is create-only.
+     * Company keys must send `performed_by_user_id`; user keys act as themselves.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.templates:create`
+     *
+     */
+    static createTemplate(options) {
+        return (options?.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/templates',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options?.headers
+            }
+        });
+    }
+    /**
+     * Delete job template
+     *
+     * Deletes a job template and its job when the job has no restricting
+     * activity (`204`). A job still referenced by time entries or other
+     * restricted dependents is refused with `422` `destroy_restricted`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.templates:delete`
+     *
+     */
+    static deleteTemplate(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/templates/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show job template
+     *
+     * Returns one job template of a job the key's company provides. Another
+     * company's id is indistinguishable from an unknown id and answers `404`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.templates:read`
+     *
+     */
+    static getTemplate(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/templates/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update job template
+     *
+     * Renames a job template or updates its description. `job_id`,
+     * `position_option`, and `performed_by_user_id` are create-only
+     * and answer `400`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.templates:update`
+     *
+     */
+    static updateTemplate(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/templates/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class ProductionDeliveryTargets {
     /**
@@ -6847,6 +7214,109 @@ export class OvertimeRules {
         });
     }
 }
+export class OvertimePackages {
+    /**
+     * List overtime packages
+     *
+     * List overtime packages owned by the company, ordered by id. DSPTCH-global
+     * default packages are not returned.
+     *
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages:read`
+     *
+     */
+    static listOvertimePackages(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages',
+            ...options
+        });
+    }
+    /**
+     * Create an overtime package
+     *
+     * Create a company overtime package. The company and `selectable: true` are
+     * stamped by the server. `name` and `description` are required by the model.
+     *
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages:create`
+     *
+     */
+    static createOvertimePackage(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete an overtime package
+     *
+     * Permanently remove a company overtime package. An unused package returns
+     * `204`. A package still referenced by a job or project wage determination is
+     * refused with `422` `destroy_restricted`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages:delete`
+     *
+     */
+    static deleteOvertimePackage(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{id}',
+            ...options
+        });
+    }
+    /**
+     * Get an overtime package
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages:read`
+     *
+     */
+    static getOvertimePackage(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update an overtime package
+     *
+     * Rename, re-describe, or retoggle a company overtime package as the default.
+     * Setting `default` to true demotes the previous default and migrates eligible
+     * employments onto this package.
+     *
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages:update`
+     *
+     */
+    static updateOvertimePackage(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class PayRateRules {
     /**
      * Shift pay rate rule genesis
@@ -9896,105 +10366,19 @@ export class Users {
         });
     }
     /**
-     * List scheduled compensation changes for user's employment
-     *
-     * Deprecated: use `GET /api/v1/people/employments/{employment_id}/history` instead.
-     * The successor is keyed by the employment's `id` and lists every version, newest first.
-     *
-     *
-     * **Required scope:**
-     *
-     * `users.companies.scheduled_changes:read`
-     *
-     *
-     * @deprecated
-     */
-    static listUserCompanyScheduledChanges(options) {
-        return (options.client ?? client).get({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes',
-            ...options
-        });
-    }
-    /**
-     * Create scheduled change to user's employment information
+     * Create scheduled termination to user's employment
      *
-     * Deprecated: use `POST /api/v1/people/employments/{employment_id}/scheduled_changes` instead.
+     * Deprecated: use `POST /api/v1/people/employments/{id}/scheduled_termination` instead.
      * The successor is keyed by the employment's `id` and needs `If-Match`.
      *
      *
      * **Required scope:**
      *
-     * `users.companies.scheduled_changes:create`
-     *
-     *
-     * @deprecated
-     */
-    static createUserCompanyScheduledChange(options) {
-        return (options.client ?? client).post({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes',
-            ...options,
-            headers: {
-                'Content-Type': 'application/json',
-                ...options.headers
-            }
-        });
-    }
-    /**
-     * Cancel scheduled compensation change (removes the future version from the timeline)
-     *
-     * Deprecated: use `DELETE /api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}` instead.
-     * The successor is keyed by the employment's `id` and the change's effective date, and needs `If-Match`.
-     *
-     *
-     * **Required scope:**
-     *
-     * `users.companies.scheduled_changes:delete`
-     *
-     *
-     * @deprecated
-     */
-    static cancelUserCompanyScheduledChange(options) {
-        return (options.client ?? client).delete({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes/{id}',
-            ...options
-        });
-    }
-    /**
-     * Update scheduled compensation change
-     *
-     * Deprecated: use `PATCH /api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}` instead.
-     * The successor is keyed by the employment's `id` and the change's effective date, and needs `If-Match`.
-     *
-     *
-     * **Required scope:**
-     *
-     * `users.companies.scheduled_changes:update`
+     * `users.companies.scheduled_termination:create`
      *
      *
      * @deprecated
      */
-    static updateScheduledChange(options) {
-        return (options.client ?? client).patch({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes/{id}',
-            ...options,
-            headers: {
-                'Content-Type': 'application/json',
-                ...options.headers
-            }
-        });
-    }
-    /**
-     * Create scheduled termination to user's employment
-     *
-     * **Required scope:**
-     *
-     * `users.companies.scheduled_termination:create`
-     *
-     */
     static createScheduledTermination(options) {
         return (options.client ?? client).post({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
@@ -10009,10 +10393,16 @@ export class Users {
     /**
      * Cancel scheduled termination (restores open-ended employment)
      *
+     * Deprecated: use `DELETE /api/v1/people/employments/{id}/scheduled_termination` instead.
+     * The successor is keyed by the employment's `id` and needs `If-Match`.
+     *
+     *
      * **Required scope:**
      *
      * `users.companies.scheduled_termination:delete`
      *
+     *
+     * @deprecated
      */
     static cancelUserCompanyScheduledTermination(options) {
         return (options.client ?? client).delete({
@@ -10024,10 +10414,17 @@ export class Users {
     /**
      * Create employment for existing user
      *
+     * Deprecated: use `POST /api/v1/people/employments` instead.
+     * Set custom fields with a follow-up
+     * `PATCH /api/v1/people/employments/{id}/custom_fields`.
+     *
+     *
      * **Required scope:**
      *
      * `users.companies:create`
      *
+     *
+     * @deprecated
      */
     static createCompany(options) {
         return (options.client ?? client).post({
@@ -10043,21 +10440,17 @@ export class Users {
     /**
      * Remove employment entirely (retroactive, irreversible)
      *
-     * Permanently remove every valid-time version of this person's
-     * employment at the company.
-     *
-     * Conditional: send the employment's `ETag` as `If-Match`. The
-     * person's user record names the employment as `employment_id`; read
-     * its `ETag` from `GET /api/v1/people/employments/{employment_id}/history`,
-     * or from `GET /api/v1/people/employments/{id}` while a version covers now.
-     * A key without the history scope may send `If-Match: *` instead,
-     * which removes whatever state exists.
+     * Deprecated: use `DELETE /api/v1/people/employments/{id}` instead.
+     * The successor is keyed by the employment's `id` and needs
+     * `If-Match`.
      *
      *
      * **Required scope:**
      *
      * `users.companies:delete`
      *
+     *
+     * @deprecated
      */
     static removeUserFromCompany(options) {
         return (options.client ?? client).delete({
@@ -10069,10 +10462,18 @@ export class Users {
     /**
      * Update user's employment information
      *
+     * Deprecated: use `PATCH /api/v1/people/employments/{id}` instead.
+     * Move the hire date with
+     * `PATCH /api/v1/people/employments/{id}/genesis`. Set custom
+     * fields with `PATCH /api/v1/people/employments/{id}/custom_fields`.
+     *
+     *
      * **Required scope:**
      *
      * `users.companies:update`
      *
+     *
+     * @deprecated
      */
     static updateCompany(options) {
         return (options.client ?? client).patch({
@@ -11864,6 +12265,7 @@ export class WorkTypes {
      * authenticated company: the shared global catalog (rows with no owning
      * company) plus the company's own company-specific entries. Returned
      * newest first and paginated with the `page[...]` cursor parameters.
+     * `filter[value]` fuzzy-matches on the work type name.
      *
      *
      * **Required scope:**
@@ -11878,4 +12280,91 @@ export class WorkTypes {
             ...options
         });
     }
+    /**
+     * Create work type
+     *
+     * Creates a work type owned by the key's company. The body accepts only
+     * `value`; undeclared keys (`verified`, `specific_to_site_type`,
+     * `scoped_to_company_id`) or a missing `value` return `400`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `work_types:create`
+     *
+     */
+    static createWorkType(options) {
+        return (options?.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/work_types',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options?.headers
+            }
+        });
+    }
+    /**
+     * Delete work type
+     *
+     * Deletes an unused company-owned work type (`204`). A work type still
+     * referenced by a job or per diem is refused with `422` `destroy_restricted`.
+     * Global catalog rows are readable but not deletable (`403`).
+     *
+     *
+     * **Required scope:**
+     *
+     * `work_types:delete`
+     *
+     */
+    static deleteWorkType(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/work_types/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show work type
+     *
+     * Returns one work type the key can see: a company-owned row or a shared
+     * global catalog row. Another company's id is indistinguishable from an
+     * unknown id and answers `404`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `work_types:read`
+     *
+     */
+    static getWorkType(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/work_types/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update work type
+     *
+     * Renames a company-owned work type. Global catalog rows are readable but
+     * not writable (`403`). Another company's id answers `404`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `work_types:update`
+     *
+     */
+    static updateWorkType(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/work_types/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }