@dsptch-work/api-client 0.30.0 → 0.32.0

package/dist/gen/sdk.gen.js

@@ -2153,13 +2153,13 @@ export class CertificationPackages {
      *
      */
     static createPackage(options) {
-        return (options?.client ?? client).post({
+        return (options.client ?? client).post({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
             url: '/api/v1/certifications/packages',
             ...options,
             headers: {
                 'Content-Type': 'application/json',
-                ...options?.headers
+                ...options.headers
             }
         });
     }
@@ -2441,7 +2441,8 @@ 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.
+     * `description`; undeclared keys or a missing `name` return `400`, and a null
+     * or wrong-typed `name` returns `422`, without creating a department.
      *
      *
      * **Required scope:**
@@ -2504,10 +2505,11 @@ 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.
+     * Updates only the supplied `name` and `description`; omitted fields keep their
+     * values and a null `description` clears it. Undeclared body keys return `400`,
+     * and a null or wrong-typed `name` returns `422`, 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:**
@@ -2578,6 +2580,152 @@ export class Companies {
         });
     }
 }
+export class CompetenciesAssessments {
+    /**
+     * List competence assessments
+     *
+     * Lists assessments. competencies_standard_version_id is the revision
+     * pinned when the assessment was opened, not whichever revision is active
+     * now. outcome is null until the assessment is decided. Submit, claim,
+     * return, and decide stay on the web.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessments:read`
+     *
+     */
+    static listAssessments(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessments',
+            ...options
+        });
+    }
+    /**
+     * Show competence assessment
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessments:read`
+     *
+     */
+    static getAssessment(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessments/{id}',
+            ...options
+        });
+    }
+}
+export class CompetenciesAssessmentKeyActivities {
+    /**
+     * List assessment key activities
+     *
+     * Lists the task lines snapshotted onto an assessment. decision and
+     * qa_feedback are omitted when the caller is the candidate and the
+     * package is not yet decided.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessments.key_activities:read`
+     *
+     */
+    static listAssessmentKeyActivities(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessments/{assessment_id}/key_activities',
+            ...options
+        });
+    }
+    /**
+     * Show assessment key activity
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessments.key_activities:read`
+     *
+     */
+    static getAssessmentKeyActivity(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{id}',
+            ...options
+        });
+    }
+}
+export class CompetenciesEvidenceItems {
+    /**
+     * List competence evidence items
+     *
+     * Lists evidence on one assessment line. File bytes are not served and there is no download URL.
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessments.key_activities.evidence_items:read`
+     *
+     */
+    static listEvidenceItems(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{key_activity_id}/evidence_items',
+            ...options
+        });
+    }
+    /**
+     * Show competence evidence item
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessments.key_activities.evidence_items:read`
+     *
+     */
+    static getEvidenceItem(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{key_activity_id}/evidence_items/{id}',
+            ...options
+        });
+    }
+}
+export class CompetenciesQualifications {
+    /**
+     * List competence qualifications
+     *
+     * Lists durable standings. level_sort_order is the tier the candidate
+     * passed. The response has no level id, so a standing survives the next
+     * revision. This resource is read-only.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.qualifications:read`
+     *
+     */
+    static listQualifications(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/qualifications',
+            ...options
+        });
+    }
+    /**
+     * Show competence qualification
+     *
+     * **Required scope:**
+     *
+     * `competencies.qualifications:read`
+     *
+     */
+    static getQualification(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/qualifications/{id}',
+            ...options
+        });
+    }
+}
 export class ComplianceChecks {
     /**
      * List compliance checks
@@ -3102,6 +3250,87 @@ export class Jobs {
             }
         });
     }
+    /**
+     * List good-faith effort exceptions
+     *
+     * Returns the good-faith-effort exceptions nested on the named job. A missing
+     * or out-of-scope job reads as not found. A visible job with no exceptions,
+     * including one that does not track apprenticeship, returns an empty list.
+     * Ordered by request_start_date descending then id. Read-only.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.apprenticeship.good_faith_effort_exceptions:read`
+     *
+     */
+    static listGoodFaithEffortExceptions(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/apprenticeship/good_faith_effort_exceptions',
+            ...options
+        });
+    }
+    /**
+     * Get good-faith effort exception
+     *
+     * Returns one good-faith-effort exception nested on the named job. A missing,
+     * misnested, or out-of-scope id reads as not found. Read-only.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.apprenticeship.good_faith_effort_exceptions:read`
+     *
+     */
+    static getGoodFaithEffortException(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/apprenticeship/good_faith_effort_exceptions/{id}',
+            ...options
+        });
+    }
+    /**
+     * List cure payments
+     *
+     * Returns the PWA cure payments nested on the named job. A missing
+     * or out-of-scope job reads as not found. A visible job with no
+     * payments, including one that does not track federal PWA, returns
+     * an empty list. Ordered by paid_on_date descending, then
+     * created_at descending, then id. Read-only.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.cure_payments:read`
+     *
+     */
+    static listCurePayments(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/cure_payments',
+            ...options
+        });
+    }
+    /**
+     * Get cure payment
+     *
+     * Returns one PWA cure payment nested on the named job. A missing,
+     * misnested, or out-of-scope id reads as not found. Read-only.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.cure_payments:read`
+     *
+     */
+    static getCurePayment(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/cure_payments/{id}',
+            ...options
+        });
+    }
     /**
      * List sites for job
      *
@@ -3423,8 +3652,9 @@ 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.
+     * `unit_price`, `contracted_count`, and `unit_of_measure`. Undeclared keys or a
+     * missing `scope_kind` or `unit_price` return `400`, and a null or wrong-typed
+     * value returns `422`, without creating a price.
      *
      *
      * **Required scope:**
@@ -3485,8 +3715,9 @@ 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.
+     * and `unit_of_measure`; a null `contracted_count` clears it. Undeclared body
+     * keys return `400`, and a null or wrong-typed value elsewhere returns `422`,
+     * without changing the scope price. The job stays on the URL.
      *
      *
      * **Required scope:**
@@ -3640,6 +3871,10 @@ export class PwaTrades {
      * To move determinations between crafts, re-point each one's `pwa_trade_id`
      * rather than renaming the craft they share.
      *
+     * An omitted `name` keeps the craft's name. Undeclared body keys return `400`,
+     * and a null, blank, or wrong-typed `name` returns `422`, without renaming the
+     * craft.
+     *
      *
      * **Required scope:**
      *
@@ -6308,6 +6543,87 @@ export class ProductionCompletions {
         });
     }
 }
+export class ProjectWageDeterminationRateRules {
+    /**
+     * List project wage determination rate rule history
+     *
+     * A rule's whole valid-time sequence, newest window first and cursor-paginated.
+     * Each entry is a full rate rule carrying its own `valid_from` / `valid_to`
+     * window and a `version_status` of `scheduled`, `current` or `historical`. An
+     * entry carries the family key as `pay_rates_rule_id` and no `id` or `uid` of
+     * its own — every version shares the family key, so versions are told apart by
+     * their window coordinates.
+     *
+     * `corrections` is always empty here: a rule keeps no audit layer, so what a
+     * version replaced was not recorded. The field is still returned, because the
+     * timeline answers one shape across every temporal resource. `as_of[valid]` is
+     * rejected, since pinning a point on the valid axis would collapse the sequence
+     * this endpoint returns, and a rule records no transaction axis to read
+     * `as_of[transaction]` against.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules.history:read`
+     *
+     */
+    static listProjectWageDeterminationRateRuleHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/history',
+            ...options
+        });
+    }
+    /**
+     * List project wage determination rate rules
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules:read`
+     *
+     */
+    static listProjectWageDeterminationRateRules(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/rate_rules',
+            ...options
+        });
+    }
+    /**
+     * Create project wage determination rate rule
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules:create`
+     *
+     */
+    static createProjectWageDeterminationRateRule(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/rate_rules',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Show project wage determination rate rule
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules:read`
+     *
+     */
+    static getProjectWageDeterminationRateRule(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}',
+            ...options
+        });
+    }
+}
 export class ProjectSites {
     /**
      * List project sites
@@ -6421,6 +6737,265 @@ export class ProjectSites {
         });
     }
 }
+export class ProjectWageDeterminations {
+    /**
+     * Shift project wage determination genesis
+     *
+     * Move when a determination's timeline begins. Shifting it earlier extends
+     * the first version back; shifting it later drops the coverage before it,
+     * and what that removes stops being readable through `as_of[valid]` and
+     * `/history`.
+     *
+     * This changes *when* the determination existed rather than what it said —
+     * no version's attributes are rewritten. Moving the other end of the timeline
+     * is `scheduled_termination`, and changing a version's values is the
+     * determination update.
+     *
+     * A shift to or past a scheduled termination is refused with `422`, since it
+     * would leave no coverage at all.
+     *
+     * Conditional: send the determination's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations.genesis:update`
+     *
+     */
+    static shiftProjectWageDeterminationGenesis(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/genesis',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List project wage determination version history
+     *
+     * A determination's whole valid-time sequence, newest window first and
+     * cursor-paginated. Each entry is a full determination carrying its own
+     * `valid_from` / `valid_to` window, a `version_status` of `scheduled`,
+     * `current` or `historical`, and the `corrections` that version replaced —
+     * each itself a full determination as previously recorded, so a client
+     * that wants a field-level diff compares two of them. An entry carries
+     * the family key as `project_wage_determination_id` and no `id` or `uid` of
+     * its own — every version shares the family key, so versions are told
+     * apart by their window coordinates. `as_of[valid]` is
+     * rejected, since pinning a point on the valid axis would collapse the
+     * sequence this endpoint returns, and a determination records no
+     * transaction axis to read `as_of[transaction]` against.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations.history:read`
+     *
+     */
+    static listProjectWageDeterminationHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/history',
+            ...options
+        });
+    }
+    /**
+     * Cancel scheduled changes on project wage determination
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations.scheduled_changes:delete`
+     *
+     */
+    static cancelProjectWageDeterminationScheduledChanges(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * List scheduled changes for project wage determination
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations.scheduled_changes:read`
+     *
+     */
+    static listProjectWageDeterminationScheduledChanges(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * Schedule effective-dated change on project wage determination
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations.scheduled_changes:create`
+     *
+     */
+    static scheduleProjectWageDeterminationChange(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/scheduled_changes',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Cancel scheduled termination on project wage determination
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations.scheduled_terminations:delete`
+     *
+     */
+    static cancelProjectWageDeterminationScheduledTermination(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/scheduled_termination',
+            ...options
+        });
+    }
+    /**
+     * Schedule termination on project wage determination
+     *
+     * End a determination's valid coverage at `effective_date`: segments beyond
+     * it are dropped and one spanning it is truncated, so the determination stops
+     * being valid from that point on. Earlier versions are untouched and stay
+     * readable through `as_of[valid]` and `/history`.
+     *
+     * Moving an end is cancel-then-schedule: cancel the standing termination,
+     * then schedule the one you want.
+     *
+     * Conditional: send the determination's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations.scheduled_terminations:create`
+     *
+     */
+    static scheduleProjectWageDeterminationTermination(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/scheduled_termination',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List project wage determinations
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations:read`
+     *
+     */
+    static listProjectWageDeterminations(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations',
+            ...options
+        });
+    }
+    /**
+     * Create project wage determination
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations:create`
+     *
+     */
+    static createProjectWageDetermination(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete project wage determination
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations:delete`
+     *
+     */
+    static deleteProjectWageDetermination(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show project wage determination
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations:read`
+     *
+     */
+    static getProjectWageDetermination(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update project wage determination
+     *
+     * Edit a determination's values from `effective_from` forward: every version
+     * starting at or after that instant takes the new values, and earlier
+     * versions are untouched. Where an edit starts inside a version and changes
+     * its values, a boundary is created at `effective_from` so the change applies
+     * only from there.
+     *
+     * This rewrites what the determination said, not when it existed — moving
+     * either end of the timeline is `genesis` or `scheduled_termination`.
+     *
+     * `pwa_trade_id` is the exception: a trade regroups the whole determination
+     * at once, so it moves every version rather than applying from
+     * `effective_from`. Changes synchronize to linked job wage determinations.
+     *
+     * Conditional: send the determination's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.wage_determinations:update`
+     *
+     */
+    static updateProjectWageDetermination(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class Projects {
     /**
      * List projects
@@ -6766,6 +7341,7 @@ export class Users {
      */
     static listUsers(options) {
         return (options?.client ?? client).get({
+            querySerializer: { parameters: { 'filter[invite_status]': { array: { explode: false } } } },
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
             url: '/api/v1/users',
             ...options
@@ -7128,6 +7704,12 @@ export class TimeCards {
      */
     static listTimeCards(options) {
         return (options?.client ?? client).get({
+            querySerializer: { parameters: {
+                    'filter[employment_type]': { array: { explode: false } },
+                    'filter[compensation_type]': { array: { explode: false } },
+                    'filter[worker_approval_status]': { array: { explode: false } },
+                    'filter[manager_approval_status]': { array: { explode: false } }
+                } },
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
             url: '/api/v1/time_cards',
             ...options
@@ -7804,7 +8386,7 @@ export class AttestationConfigs {
     /**
      * Create attestation config
      *
-     * Creates a question on the addressed pay schedule. Undeclared body keys return 400 before the question is saved.
+     * Creates a question on the addressed pay schedule. Undeclared body keys or a missing `content` or `expected_response` return 400, and a null or wrong-typed value returns 422, before the question is saved.
      *
      * **Required scope:**
      *