@dsptch-work/api-client 0.41.0 → 0.43.0

package/dist/gen/sdk.gen.js

@@ -1314,6 +1314,29 @@ export class AssetsItems {
             }
         });
     }
+    /**
+     * Delete form assignment
+     *
+     * Ends the open incomplete permanent copy of this nested
+     * form-completion task, the same mutation as the web unassign
+     * control. Recurrence stays on PATCH. A copy that is not an
+     * incomplete permanent copy is refused with
+     * `not_incomplete_permanent_copy`. A missing, misnested, or
+     * out-of-scope id reads as not found. Returns `204`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `assets.items.form_assignment_tasks:delete`
+     *
+     */
+    static deleteFormAssignmentTask(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/items/{item_id}/form_assignment_tasks/{id}',
+            ...options
+        });
+    }
     /**
      * Show form assignment
      *
@@ -2119,6 +2142,11 @@ export class Billing {
     /**
      * List PWA user counts
      *
+     * Lists each month's PWA head count per billable unit: a project, or a
+     * job outside any project. Rows run newest month first, then projects by
+     * name, then jobs outside any project by name.
+     *
+     *
      * **Required scope:**
      *
      * `billing.pwa_user_counts_by_project_by_months:read`
@@ -4052,6 +4080,29 @@ export class Jobs {
             }
         });
     }
+    /**
+     * Delete form assignment task on job
+     *
+     * Ends the open incomplete permanent copy of this nested
+     * form-completion task, the same mutation as the web unassign
+     * control. Recurrence stays on PATCH. A copy that is not an
+     * incomplete permanent copy is refused with
+     * `not_incomplete_permanent_copy`. A missing, misnested, or
+     * out-of-scope id reads as not found. Returns `204`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.form_assignment_tasks:delete`
+     *
+     */
+    static deleteJobFormAssignmentTask(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/form_assignment_tasks/{id}',
+            ...options
+        });
+    }
     /**
      * Show form assignment task on job
      *
@@ -4212,6 +4263,144 @@ export class Jobs {
             }
         });
     }
+    /**
+     * List CA eCPR XML exports
+     *
+     * Returns the job-scoped CA DIR eCPR 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.ca_ecpr_xml_exports:read`
+     *
+     */
+    static listCaEcprXmlExports(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/certified_payrolls/ca_ecpr_xml_exports',
+            ...options
+        });
+    }
+    /**
+     * Create CA eCPR XML export
+     *
+     * Enqueues a job-scoped CA DIR eCPR 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 CA eCPR is 422 `certified_payroll_format_unavailable`.
+     * A window with no reportable pay periods is 422 `nothing_exportable`.
+     * Does not start DocuSeal signing.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.certified_payrolls.ca_ecpr_xml_exports:create`
+     *
+     */
+    static createCaEcprXmlExport(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/certified_payrolls/ca_ecpr_xml_exports',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get CA eCPR XML export
+     *
+     * Returns one job-scoped CA DIR eCPR 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.ca_ecpr_xml_exports:read`
+     *
+     */
+    static getCaEcprXmlExport(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/certified_payrolls/ca_ecpr_xml_exports/{id}',
+            ...options
+        });
+    }
+    /**
+     * List WH-347 exports
+     *
+     * Returns the job-scoped WH-347 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.wh347_exports:read`
+     *
+     */
+    static listWh347Exports(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/certified_payrolls/wh347_exports',
+            ...options
+        });
+    }
+    /**
+     * Create WH-347 export
+     *
+     * Enqueues a job-scoped WH-347 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 WH-347 is 422 `certified_payroll_format_unavailable`.
+     * A window with no reportable pay periods is 422 `nothing_exportable`.
+     * Does not start DocuSeal signing.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.certified_payrolls.wh347_exports:create`
+     *
+     */
+    static createWh347Export(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/certified_payrolls/wh347_exports',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get WH-347 export
+     *
+     * Returns one job-scoped WH-347 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.wh347_exports:read`
+     *
+     */
+    static getWh347Export(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/certified_payrolls/wh347_exports/{id}',
+            ...options
+        });
+    }
     /**
      * List cure payments
      *
@@ -4620,6 +4809,230 @@ export class Jobs {
         });
     }
 }
+export class ProductionDeliveryTargets {
+    /**
+     * List delivery targets
+     *
+     * Lists the scope's targets in due-date, then ID order. Each target
+     * is assessed against the whole current named scope and effective
+     * completion evidence; pagination limits targets, never evidence.
+     * Missing named membership or evidence visibility makes the
+     * assessment unavailable while preserving explicit target facts.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.delivery_targets:read`
+     *
+     */
+    static listDeliveryTargets(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/delivery_targets',
+            ...options
+        });
+    }
+    /**
+     * Create delivery target
+     *
+     * Creates one scope-owned target with a server-selected whole-service
+     * condition. Accepts a Job-local due_date and condition_attributes
+     * containing requirement_kind (count or all) and required_count.
+     * Count requires a positive integer; all requires no count. Only
+     * Feature-tracked Jobs admit targets. Company keys need no human
+     * attribution field; user keys use the authenticated user for audit.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.delivery_targets:create`
+     *
+     */
+    static createDeliveryTarget(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/delivery_targets',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete delivery target
+     *
+     * Removes an erroneous target and its owned condition. Returns 204
+     * with no response body. Current named work, Tasks, completions and
+     * other targets remain. A later GET of the removed target is 404.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.delivery_targets:delete`
+     *
+     */
+    static deleteDeliveryTarget(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/delivery_targets/{id}',
+            ...options
+        });
+    }
+    /**
+     * Get delivery target
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.delivery_targets:read`
+     *
+     */
+    static getDeliveryTarget(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/delivery_targets/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update delivery target
+     *
+     * Changes only submitted date and condition fields. Omissions keep
+     * locked current values, including required_count when the mode
+     * changes. Switch count to all with required_count null, or all to
+     * count with a positive N. The resulting whole rule must be valid.
+     * Target and condition identities are preserved; neither can be moved.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.delivery_targets:update`
+     *
+     */
+    static updateDeliveryTarget(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/delivery_targets/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
+export class ProductionPlannedFeatureTasks {
+    /**
+     * Set planned Feature archive state
+     *
+     * Set archived to true to remove current named membership,
+     * or false to restore the same pair. Actual reports are retained.
+     * This is an idempotent desired-state operation. Company keys
+     * name a responsible company-member human on every call.
+     * User keys act only as their authenticated user. Wrong Job
+     * kind or ineligible restoration returns 422 from domain validity.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.job_scope_prices.planned_feature_tasks.archives:update`
+     *
+     */
+    static updateArchive(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/planned_feature_tasks/{planned_feature_task_id}/archive',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List planned Feature work
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.job_scope_prices.planned_feature_tasks:read`
+     *
+     */
+    static listPlannedFeatureTasks(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/planned_feature_tasks',
+            ...options
+        });
+    }
+    /**
+     * Add planned Feature work
+     *
+     * Adds or restores the retained scope/Feature pair. Omitted
+     * metadata remains unchanged on re-add. Company keys must
+     * name performed_by_user_id on every write (400 if absent,
+     * 422 if invalid or outside the company). User keys use only
+     * their authenticated user; another person's UUID is 403.
+     * Optional intended people never become actual crew.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.job_scope_prices.planned_feature_tasks:create`
+     *
+     */
+    static createPlannedFeatureTask(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/planned_feature_tasks',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get planned Feature work
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.job_scope_prices.planned_feature_tasks:read`
+     *
+     */
+    static getPlannedFeatureTask(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/planned_feature_tasks/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update planned Feature metadata
+     *
+     * Edits intended metadata, never actual work facts. Company
+     * keys name a responsible company member on every write.
+     * User keys may omit the actor or supply their own UUID;
+     * a different UUID is forbidden. Omitted fields are preserved,
+     * nullable fields may be cleared, and [] clears intended people.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.production.job_scope_prices.planned_feature_tasks:update`
+     *
+     */
+    static updatePlannedFeatureTask(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{job_scope_price_id}/planned_feature_tasks/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class ProductionJobScopePrices {
     /**
      * List production job scope prices
@@ -4629,7 +5042,8 @@ export class ProductionJobScopePrices {
      * manager, or field lead of the company that owns the job,
      * receive `unit_price_cents` and `contracted_count`. Other user
      * keys, held by crew on the job, receive the same rows
-     * without those two fields.
+     * without those two fields. A present `unit_price_cents` is an
+     * exact decimal string, or null when the current price is unknown.
      *
      *
      * **Required scope:**
@@ -4649,9 +5063,10 @@ export class ProductionJobScopePrices {
      *
      * Creates a scope price on the URL's job. The body accepts only `scope_kind`,
      * `unit_price_cents`, `contracted_count`, and `unit_of_measure`. Undeclared keys,
-     * including the retired dollar `unit_price`, or a missing `scope_kind` or
-     * `unit_price_cents` return `400`, and a null or wrong-typed value returns `422`,
-     * without creating a price.
+     * including the retired dollar `unit_price`, or a missing `scope_kind` return
+     * `400`. Omit `unit_price_cents` or send null for an unknown price; "0" is a
+     * known zero. Supplied nonnull prices must be nonnegative decimal strings;
+     * blank, numeric, negative, or wrong-typed prices return `422` without a write.
      *
      *
      * **Required scope:**
@@ -4693,7 +5108,8 @@ export class ProductionJobScopePrices {
      * manager, or field lead of the company that owns the job,
      * receive `unit_price_cents` and `contracted_count`. Other user
      * keys, held by crew on the job, receive the price without
-     * those two fields.
+     * those two fields. A present `unit_price_cents` is an exact
+     * decimal string, or null when the current price is unknown.
      *
      *
      * **Required scope:**
@@ -4712,9 +5128,11 @@ export class ProductionJobScopePrices {
      * Update production job scope price
      *
      * Updates only the supplied `scope_kind`, `unit_price_cents`, `contracted_count`,
-     * and `unit_of_measure`; a null `contracted_count` clears it. Undeclared body
-     * keys, including the retired dollar `unit_price`, return `400`, and a null or
-     * wrong-typed value elsewhere returns `422`, without changing the scope price.
+     * and `unit_of_measure`. Omission preserves the stored value; null
+     * `unit_price_cents` clears the price to unknown, and null `contracted_count`
+     * clears the target. Undeclared keys, including the retired dollar `unit_price`,
+     * return `400`. Invalid supplied values return `422` without changing the scope
+     * price. Prices remain nonnegative decimal strings; "0" is a known zero.
      * The job stays on the URL.
      *
      *
@@ -5572,6 +5990,30 @@ export class OversiteFeatureFormAssignmentTasks {
             }
         });
     }
+    /**
+     * Delete form assignment task on feature
+     *
+     * Ends the open incomplete permanent copy of this nested
+     * form-completion task, the same mutation as the web unassign
+     * control. Recurrence stays on PATCH. A copy that is not an
+     * incomplete permanent copy is refused with
+     * `not_incomplete_permanent_copy`. A missing, misnested, or
+     * other-company id on this shared feature reads as not found.
+     * Returns `204`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `oversite.sites.features.form_assignment_tasks:delete`
+     *
+     */
+    static deleteFeatureFormAssignmentTask(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/oversite/sites/{site_id}/features/{feature_id}/form_assignment_tasks/{id}',
+            ...options
+        });
+    }
     /**
      * Show form assignment task on feature
      *
@@ -5667,6 +6109,30 @@ export class OversiteSiteFormAssignmentTasks {
             }
         });
     }
+    /**
+     * Delete form assignment task on site
+     *
+     * Ends the open incomplete permanent copy of this nested
+     * form-completion task, the same mutation as the web unassign
+     * control. Recurrence stays on PATCH. A copy that is not an
+     * incomplete permanent copy is refused with
+     * `not_incomplete_permanent_copy`. A missing, misnested, or
+     * other-company id on this shared site reads as not found.
+     * Returns `204`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `oversite.sites.form_assignment_tasks:delete`
+     *
+     */
+    static deleteSiteFormAssignmentTask(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/oversite/sites/{site_id}/form_assignment_tasks/{id}',
+            ...options
+        });
+    }
     /**
      * Show form assignment task on site
      *
@@ -7508,8 +7974,10 @@ export class PerDiems {
      * List per diems
      *
      * List the per diems configured for the company — the named daily allowances
-     * (meals, lodging, travel) available to attach to workers' time. Returned newest
-     * first; narrow the results with the `filter[...]` query parameters.
+     * (meals, lodging, travel) available to attach to workers' time. Returned oldest
+     * first; narrow the results with the `filter[...]` query parameters. Company keys
+     * and the user keys of company admins and managers can list the catalog; other
+     * user keys are refused with `403`.
      *
      *
      * **Required scope:**
@@ -7571,7 +8039,9 @@ export class PerDiems {
     /**
      * Show per diem
      *
-     * Fetch a single per diem by id.
+     * Fetch a single per diem by id. Company keys and the user keys of company
+     * admins and managers can read it; other user keys are refused with `403`.
+     *
      *
      * **Required scope:**
      *
@@ -7695,6 +8165,75 @@ export class PositionFunctions {
     }
 }
 export class ProductionCompletions {
+    /**
+     * List retained completion states
+     *
+     * Lists all authorized retained Completion records: active and withdrawn Feature
+     * claims and current Quantity records. Each identity occurs once with its current
+     * corrected facts. This is not a PaperTrail version or audit-event feed.
+     * Ordinary completion reads remain effective-only. Malformed work-date bounds
+     * return 422 invalid_date; inverted ranges return 422 invalid_filter_value.
+     *
+     *
+     * **Required scope:**
+     *
+     * `production.completions.history:read`
+     *
+     */
+    static listCompletionHistory(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/production/completions/history',
+            ...options
+        });
+    }
+    /**
+     * Get retained completion state
+     *
+     * Returns one authorized retained Completion with its current corrected facts.
+     * The same lookup remains available after withdrawal or restoration;
+     * it does not return prior versions.
+     *
+     *
+     * **Required scope:**
+     *
+     * `production.completions.history:read`
+     *
+     */
+    static getCompletionHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/production/completions/history/{id}',
+            ...options
+        });
+    }
+    /**
+     * Set completion withdrawal state
+     *
+     * Set withdrawn to true to withdraw a Feature claim, or false to restore its
+     * retained ID. Both commands are idempotent. Restoration returns 422 if another
+     * effective claim already records the same Feature and scope. Quantity
+     * completions do not support either command. No reason or responsible-person
+     * body field is required. The audit actor is the authenticating user,
+     * or null for a company key.
+     *
+     *
+     * **Required scope:**
+     *
+     * `production.completions.withdrawals:update`
+     *
+     */
+    static setCompletionWithdrawal(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/production/completions/{completion_id}/withdrawal',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List production completions
      *
@@ -9749,8 +10288,9 @@ export class TimeEntries {
      * company's default timecodes), state, description, hourly_rate_cents (derived
      * from the position/user default when omitted), and feature_ids. Supplying
      * feature_ids — or setting feature_allocation_acknowledged true — satisfies a
-     * job that requires a feature allocation. hourly_rate_cents is admin only on
-     * user-scoped keys.
+     * job that requires a feature allocation. The optional overtime premium cents inputs
+     * set the complete tier premiums, additional to base hourly pay. Financial
+     * rate inputs are admin only on user-scoped keys.
      *
      *
      * **Required scope:**
@@ -9827,7 +10367,8 @@ export class TimeEntries {
      * 422 unless confirm_allocation_conflict is sent true. The feature-allocation cap is
      * enforced, and because a persisted feature_ids= writes its join rows
      * immediately, a rejected save rolls them back within the enclosing
-     * transaction. hourly_rate_cents is admin only on user-scoped keys.
+     * transaction. Omitted overtime premium cents inputs keep their saved values; null
+     * resets a tier to automatic. Financial rate inputs are admin only on user-scoped keys.
      *
      *
      * **Required scope:**