@dsptch-work/api-client 0.42.0 → 0.44.0

package/dist/gen/sdk.gen.js

@@ -4263,6 +4263,75 @@ 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
      *
@@ -4740,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
@@ -4907,6 +5200,11 @@ export class PwaTrades {
      * decisions carry over where the target holds none of its own, and the emptied
      * craft is deleted — all in one transaction.
      *
+     * A merge is refused (422) when the two crafts decided an occupation's apprentice
+     * scope opposite ways, in scope on one and out of scope on the other. The detail
+     * lists each clash and the employer companies of the occupation's program, whose
+     * admins and managers can change either decision or remove one. Nothing changes.
+     *
      * Use this rather than `DELETE` when the craft still groups determinations:
      * deleting one is refused precisely because it would orphan them, and merging
      * moves them first.
@@ -7872,6 +8170,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
      *
@@ -10755,9 +11122,10 @@ export class Todos {
     /**
      * List Todos
      *
-     * List your company's open work in one list: todos that are not yet completed, and failing
-     * compliance checks on a requirement your company has highlighted. Entries come back
-     * soonest-due first, with undated entries last.
+     * List your company's open work in one list: todos that are not yet completed, and
+     * compliance checks on a requirement your company has highlighted that are failing or
+     * waiting for an approval decision (`status` is `failed` or `pending`). Entries come
+     * back soonest-due first, with undated entries last.
      *
      * Read `kind` on an entry before anything else — a `todo` and a `compliance_check` are
      * different resources, with different fields and separate id spaces. Both also carry a