@dsptch-work/api-client 0.28.0 → 0.30.0

package/dist/gen/sdk.gen.js

@@ -640,6 +640,8 @@ export class AssetsAttributes {
     /**
      * Create Attribute
      *
+     * Only documented body keys are accepted, including inside `options`. An undeclared key returns 400 before any attribute or option is written.
+     *
      * **Required scope:**
      *
      * `assets.attributes:create`
@@ -659,6 +661,8 @@ export class AssetsAttributes {
     /**
      * Delete Attribute
      *
+     * A missing attribute or one outside the key company or user visibility returns 404.
+     *
      * **Required scope:**
      *
      * `assets.attributes:delete`
@@ -674,6 +678,8 @@ export class AssetsAttributes {
     /**
      * Get Attribute
      *
+     * A missing attribute or one outside the key company or user visibility returns 404.
+     *
      * **Required scope:**
      *
      * `assets.attributes:read`
@@ -689,6 +695,8 @@ export class AssetsAttributes {
     /**
      * Update Attribute
      *
+     * Only documented body keys are accepted, including inside `options`. An undeclared key returns 400 without changing the attribute or its options. A missing attribute or one outside the key company or user visibility returns 404.
+     *
      * **Required scope:**
      *
      * `assets.attributes:update`
@@ -725,6 +733,8 @@ export class AssetsCategories {
     /**
      * Create Category
      *
+     * Only documented body keys are accepted, including inside `category_attributes`. An undeclared key returns 400 before any category or assignment is written.
+     *
      * **Required scope:**
      *
      * `assets.categories:create`
@@ -774,6 +784,8 @@ export class AssetsCategories {
     /**
      * Update Category
      *
+     * Only documented body keys are accepted, including inside `category_attributes`. An undeclared key returns 400 before any category or assignment is written.
+     *
      * **Required scope:**
      *
      * `assets.categories:update`
@@ -874,6 +886,8 @@ export class AssetsFormAssignmentTriggers {
     /**
      * Create Form Assignment Trigger
      *
+     * New form, assignee, and product references must be visible to the API key in its company. Refused writes preserve the trigger and its associations.
+     *
      * **Required scope:**
      *
      * `assets.form_assignment_triggers:create`
@@ -923,6 +937,8 @@ export class AssetsFormAssignmentTriggers {
     /**
      * Update Form Assignment Trigger
      *
+     * New form, assignee, and product references must be visible to the API key in its company. Refused writes preserve the trigger and its associations.
+     *
      * **Required scope:**
      *
      * `assets.form_assignment_triggers:update`
@@ -1195,6 +1211,8 @@ export class AssetsItems {
     /**
      * Create service event
      *
+     * Undeclared JSON-body keys, including keys within attachments_attributes, return 400 unknown_key before any service-event or attachment changes are saved.
+     *
      * **Required scope:**
      *
      * `assets.items.service_events:create`
@@ -1244,6 +1262,8 @@ export class AssetsItems {
     /**
      * Update service event
      *
+     * Undeclared JSON-body keys, including keys within attachments_attributes, return 400 unknown_key before any service-event or attachment changes are saved.
+     *
      * **Required scope:**
      *
      * `assets.items.service_events:update`
@@ -1728,6 +1748,8 @@ export class AssetsSites {
     /**
      * Create Site
      *
+     * Only `site_id`, `kind`, and `name` are writable. An undeclared key returns 400 before any site is written.
+     *
      * **Required scope:**
      *
      * `assets.sites:create`
@@ -1777,6 +1799,8 @@ export class AssetsSites {
     /**
      * Update Site
      *
+     * Only `site_id`, `kind`, and `name` are writable. An undeclared key returns 400 before any site is written.
+     *
      * **Required scope:**
      *
      * `assets.sites:update`
@@ -2416,6 +2440,10 @@ export class CompaniesDepartments {
     /**
      * Create department
      *
+     * Creates a department in the key's company. The body accepts only `name` and
+     * `description`; undeclared keys return `400` without creating a department.
+     *
+     *
      * **Required scope:**
      *
      * `companies.departments:create`
@@ -2476,6 +2504,12 @@ export class CompaniesDepartments {
     /**
      * Update department
      *
+     * Updates only the supplied `name` and `description`. Undeclared body keys
+     * return `400` without changing the department. A missing or out-of-scope id
+     * returns `404`, matching GET and DELETE. A visible department still requires
+     * write authorization.
+     *
+     *
      * **Required scope:**
      *
      * `companies.departments:update`
@@ -3184,6 +3218,7 @@ export class Jobs {
      */
     static listJobs(options) {
         return (options?.client ?? client).get({
+            querySerializer: { parameters: { 'filter[federal_pwa_mode]': { array: { explode: false } }, 'filter[regional_pwa_mode]': { array: { explode: false } } } },
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
             url: '/api/v1/jobs',
             ...options
@@ -3387,6 +3422,11 @@ export class ProductionJobScopePrices {
     /**
      * Create production job scope price
      *
+     * Creates a scope price on the URL's job. The body accepts only `scope_kind`,
+     * `unit_price`, `contracted_count`, and `unit_of_measure`. Undeclared keys return
+     * `400` without creating a price.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.production.job_scope_prices:create`
@@ -3444,6 +3484,11 @@ export class ProductionJobScopePrices {
     /**
      * Update production job scope price
      *
+     * Updates only the supplied `scope_kind`, `unit_price`, `contracted_count`,
+     * and `unit_of_measure`. Undeclared body keys return `400` without changing
+     * the scope price. The job stays on the URL.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.production.job_scope_prices:update`
@@ -5160,6 +5205,11 @@ export class FringeBenefitPlans {
     /**
      * Delete fringe benefit plan
      *
+     * A missing record or a record outside the key's company
+     * visibility returns 404. User-scoped keys also require user
+     * visibility. A forbidden action on a visible record returns 403.
+     *
+     *
      * **Required scope:**
      *
      * `payrolls.fringe_benefit_plans:delete`
@@ -5175,6 +5225,11 @@ export class FringeBenefitPlans {
     /**
      * Show fringe benefit plan
      *
+     * A missing record or a record outside the key's company
+     * visibility returns 404. User-scoped keys also require user
+     * visibility. A forbidden action on a visible record returns 403.
+     *
+     *
      * **Required scope:**
      *
      * `payrolls.fringe_benefit_plans:read`
@@ -5258,6 +5313,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
@@ -5301,6 +5407,11 @@ export class PayrollRuns {
     /**
      * Delete payroll run
      *
+     * A missing record or a record outside the key's company
+     * visibility returns 404. User-scoped keys also require user
+     * visibility. A forbidden action on a visible record returns 403.
+     *
+     *
      * **Required scope:**
      *
      * `payrolls.payroll_runs:delete`
@@ -5316,6 +5427,11 @@ export class PayrollRuns {
     /**
      * Show payroll run
      *
+     * A missing record or a record outside the key's company
+     * visibility returns 404. User-scoped keys also require user
+     * visibility. A forbidden action on a visible record returns 403.
+     *
+     *
      * **Required scope:**
      *
      * `payrolls.payroll_runs:read`
@@ -5335,6 +5451,8 @@ export class PayrollRuns {
      * admins can update the same payroll run fields. Manager and
      * technician user keys cannot update runs. The owning company is
      * fixed at creation; company_id is rejected on update.
+     * A missing run or a run outside the key's company and user
+     * visibility returns 404, including manager and technician keys.
      *
      *
      * **Required scope:**
@@ -5392,6 +5510,11 @@ export class PaystubLineItems {
     /**
      * Delete paystub line item
      *
+     * A missing record or a record outside the key's company
+     * visibility returns 404. User-scoped keys also require user
+     * visibility. A forbidden action on a visible record returns 403.
+     *
+     *
      * **Required scope:**
      *
      * `paystub_line_items:delete`
@@ -5407,6 +5530,11 @@ export class PaystubLineItems {
     /**
      * Show paystub line item
      *
+     * A missing record or a record outside the key's company
+     * visibility returns 404. User-scoped keys also require user
+     * visibility. A forbidden action on a visible record returns 403.
+     *
+     *
      * **Required scope:**
      *
      * `paystub_line_items:read`
@@ -5477,6 +5605,11 @@ export class Paystubs {
     /**
      * Delete paystub
      *
+     * A missing record or a record outside the key's company
+     * visibility returns 404. User-scoped keys also require user
+     * visibility. A forbidden action on a visible record returns 403.
+     *
+     *
      * **Required scope:**
      *
      * `paystubs:delete`
@@ -5492,6 +5625,11 @@ export class Paystubs {
     /**
      * Show paystub
      *
+     * A missing record or a record outside the key's company
+     * visibility returns 404. User-scoped keys also require user
+     * visibility. A forbidden action on a visible record returns 403.
+     *
+     *
      * **Required scope:**
      *
      * `paystubs:read`
@@ -6323,6 +6461,7 @@ export class Projects {
      * Remove a participant's jobs before removing it from this set. Returns 201
      * with the project; unknown or inaccessible parent or
      * company IDs return 404, and invalid attributes or relationships return 422.
+     * Undeclared body keys return 400 before any project or relationship is saved.
      *
      *
      * **Required scope:**
@@ -6366,8 +6505,8 @@ export class Projects {
      * Update project
      *
      * Update a project's attributes. `name` cannot be blanked, and
-     * `created_by_user_id` is immutable — any request that sets, changes, or clears it
-     * returns 422. The federal-PWA-only fields (administrator contact, budget, IRA
+     * `created_by_user_id` is create-only — any update that includes it returns 400,
+     * even when the value is unchanged. Omit it on PATCH. The federal-PWA-only fields (administrator contact, budget, IRA
      * dates) and `asset_owner` apply only while `federal_pwa_mode` is not `none`:
      * switching it to `none` clears the stored values and forces `asset_owner`
      * false, and sending one of them while federal tracking is off — even as null —
@@ -6376,7 +6515,7 @@ export class Projects {
      * still accepts updates that keep that parent. `participating_company_ids`
      * replaces the complete set of participating companies. Remove a participant's
      * jobs before removing it from this set. Only the owning company may update the
-     * project.
+     * project. Undeclared body keys return 400 before any project or relationship changes.
      *
      *
      * **Required scope:**
@@ -6811,6 +6950,14 @@ export class Tasks {
     /**
      * Create form assignment task
      *
+     * Creates a shared form assignment, or one assignment per user
+     * when `spread_assignees` is true. Supplied
+     * `task_attributes.task_assignee_user_ids` must be an array of
+     * strings; null, scalars, and non-string members return 422.
+     * Omitted or empty assignees fail ordinary task validation;
+     * spread creation returns an empty array without creating tasks.
+     *
+     *
      * **Required scope:**
      *
      * `tasks.form_assignment_tasks:create`
@@ -7657,6 +7804,8 @@ export class AttestationConfigs {
     /**
      * Create attestation config
      *
+     * Creates a question on the addressed pay schedule. Undeclared body keys return 400 before the question is saved.
+     *
      * **Required scope:**
      *
      * `timekeeping.pay_period_configs.attestation_configs:create`
@@ -7676,6 +7825,8 @@ export class AttestationConfigs {
     /**
      * Delete attestation config
      *
+     * Retires a question on the addressed pay schedule at its current pay period end. Repeated retirement preserves the earliest cutoff. A question from another pay schedule returns 404.
+     *
      * **Required scope:**
      *
      * `timekeeping.pay_period_configs.attestation_configs:delete`
@@ -7888,6 +8039,48 @@ export class TimeCardActuals {
         });
     }
 }
+export class TimeOffRequests {
+    /**
+     * List time off requests
+     *
+     * List the company's time-off requests (R&R, PTO, and the other absence
+     * types). Results are ordered by created_at descending then id and
+     * cursor-paginated. Narrow with filter[user_id] and filter[status]; omitted
+     * keys do not change the list. Combined filters AND.
+     *
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.time_off_requests:read`
+     *
+     */
+    static listTimeOffRequests(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/time_off_requests',
+            ...options
+        });
+    }
+    /**
+     * Show time off request
+     *
+     * Fetch one time-off request by id. A missing or other-company id reads as
+     * not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.time_off_requests:read`
+     *
+     */
+    static getTimeOffRequest(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/time_off_requests/{id}',
+            ...options
+        });
+    }
+}
 export class TimeSessions {
     /**
      * List time sessions