@dsptch-work/api-client 0.32.0 → 0.34.0

package/dist/gen/sdk.gen.js

@@ -2689,6 +2689,414 @@ export class CompetenciesEvidenceItems {
         });
     }
 }
+export class CompetenciesAssessorAuthorizations {
+    /**
+     * List assessor authorizations
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessor_authorizations:read`
+     *
+     */
+    static listAssessorAuthorizations(options) {
+        return (options?.client ?? client).get({
+            querySerializer: { parameters: { 'filter[kind]': { array: { explode: false } } } },
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessor_authorizations',
+            ...options
+        });
+    }
+    /**
+     * Create assessor authorization
+     *
+     * Grants an assessor role for one standard. A user key grants as its user. A company key
+     * names an admin or safety manager in granted_by_user_id.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessor_authorizations:create`
+     *
+     */
+    static createAssessorAuthorization(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessor_authorizations',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Show assessor authorization
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessor_authorizations:read`
+     *
+     */
+    static getAssessorAuthorization(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessor_authorizations/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update assessor authorization
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessor_authorizations:update`
+     *
+     */
+    static updateAssessorAuthorization(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessor_authorizations/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Revoke assessor authorization
+     *
+     * **Required scope:**
+     *
+     * `competencies.assessor_authorizations.revocations:create`
+     *
+     */
+    static revokeAssessorAuthorization(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/assessor_authorizations/{assessor_authorization_id}/revocation',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
+export class CompetenciesLevels {
+    /**
+     * List competence levels
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels:read`
+     *
+     */
+    static listLevels(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels',
+            ...options
+        });
+    }
+    /**
+     * Create competence level
+     *
+     * Appends a level to a draft revision. sort_order is server-assigned, starting at 0.
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels:create`
+     *
+     */
+    static createLevel(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete competence level
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels:delete`
+     *
+     */
+    static deleteLevel(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show competence level
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels:read`
+     *
+     */
+    static getLevel(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update competence level
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels:update`
+     *
+     */
+    static updateLevel(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Move competence level
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.moves:create`
+     *
+     */
+    static moveCompetencyLevel(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/move',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
+export class CompetenciesKeyActivities {
+    /**
+     * List competence key activities
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities:read`
+     *
+     */
+    static listKeyActivities(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities',
+            ...options
+        });
+    }
+    /**
+     * Create competence key activity
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities:create`
+     *
+     */
+    static createKeyActivity(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete competence key activity
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities:delete`
+     *
+     */
+    static deleteKeyActivity(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show competence key activity
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities:read`
+     *
+     */
+    static getKeyActivity(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update competence key activity
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities:update`
+     *
+     */
+    static updateKeyActivity(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Move competence key activity
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities.moves:create`
+     *
+     */
+    static moveCompetencyKeyActivity(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/move',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
+export class CompetenciesCriteria {
+    /**
+     * List competence criteria
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities.criteria:read`
+     *
+     */
+    static listCriteria(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria',
+            ...options
+        });
+    }
+    /**
+     * Create competence criterion
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities.criteria:create`
+     *
+     */
+    static createCriterion(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete competence criterion
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities.criteria:delete`
+     *
+     */
+    static deleteCriterion(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show competence criterion
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities.criteria:read`
+     *
+     */
+    static getCriterion(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update competence criterion
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities.criteria:update`
+     *
+     */
+    static updateCriterion(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Move competence criterion
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.levels.key_activities.criteria.moves:create`
+     *
+     */
+    static moveCompetencyCriterion(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{criterion_id}/move',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class CompetenciesQualifications {
     /**
      * List competence qualifications
@@ -2726,6 +3134,244 @@ export class CompetenciesQualifications {
         });
     }
 }
+export class CompetenciesStandards {
+    /**
+     * List competence standards
+     *
+     * Lists competence standards for the key's company, including drafts and
+     * archived standards. current_version_id and draft_version_id point at named
+     * revisions, not a valid-time slice.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards:read`
+     *
+     */
+    static listStandards(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards',
+            ...options
+        });
+    }
+    /**
+     * Create competence standard
+     *
+     * Creates a standard and opens revision 1 as a draft. The revision number
+     * is server-assigned.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards:create`
+     *
+     */
+    static createStandard(options) {
+        return (options?.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options?.headers
+            }
+        });
+    }
+    /**
+     * Show competence standard
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards:read`
+     *
+     */
+    static getStandard(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update competence standard
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards:update`
+     *
+     */
+    static updateStandard(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Unarchive competence standard
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.archives:delete`
+     *
+     */
+    static unarchiveCompetencyStandard(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/archive',
+            ...options
+        });
+    }
+    /**
+     * Archive competence standard
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.archives:create`
+     *
+     */
+    static archiveCompetencyStandard(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/archive',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
+export class CompetenciesStandardVersions {
+    /**
+     * List competence standard revisions
+     *
+     * Lists named revisions of one standard, newest revision first. These rows
+     * are Competencies::StandardVersion records. They are not a temporal history,
+     * and this path does not accept as_of.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions:read`
+     *
+     */
+    static listCompetencyStandardVersions(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions',
+            ...options
+        });
+    }
+    /**
+     * Cut competence standard revision
+     *
+     * Copies the active revision's level, key-activity, and criterion tree into
+     * the next draft. The controlled PDF is not copied.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions:create`
+     *
+     */
+    static createCompetencyStandardVersion(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete competence standard revision
+     *
+     * Deletes a draft revision. Deleting the standard's only revision deletes
+     * the standard. Published revisions are refused.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions:delete`
+     *
+     */
+    static deleteCompetencyStandardVersion(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show competence standard revision
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions:read`
+     *
+     */
+    static getCompetencyStandardVersion(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update competence standard revision
+     *
+     * Updates change notes on a draft revision. Published revisions are refused.
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions:update`
+     *
+     */
+    static updateCompetencyStandardVersion(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Promote competence standard revision
+     *
+     * Publishes a draft revision, stamps the approver, and supersedes the previous active
+     * revision. A user key promotes as its user. A company key names an admin or safety
+     * manager in approved_by_user_id. Promoting the active revision returns it with its
+     * approval unchanged. A superseded revision cannot be promoted.
+     *
+     *
+     * **Required scope:**
+     *
+     * `competencies.standards.versions.promotions:create`
+     *
+     */
+    static promoteCompetencyStandardVersion(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/promotion',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class ComplianceChecks {
     /**
      * List compliance checks
@@ -3927,6 +4573,11 @@ export class JobWageDeterminationRateRules {
     /**
      * List rate rules
      *
+     * The determination family remains addressable before its start
+     * and after its end. The rule temporal lens still controls
+     * returned versions.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.pwa.wage_determinations.rate_rules:read`
@@ -3942,6 +4593,14 @@ export class JobWageDeterminationRateRules {
     /**
      * Create rate rule
      *
+     * Requires a user-scoped API key; company keys without a user
+     * receive 403 user_scoped_key_required.
+     *
+     * Unknown fields return 400. Malformed conditions or nonnumeric
+     * cents return 422. Concurrent writes to the determination
+     * family can return retryable 503 without creating a rule or package.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.pwa.wage_determinations.rate_rules:create`
@@ -3978,6 +4637,9 @@ export class JobWageDeterminations {
     /**
      * Shift job wage determination genesis
      *
+     * Requires a user-scoped API key; company keys without a user
+     * receive 403 user_scoped_key_required.
+     *
      * 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
@@ -4042,6 +4704,10 @@ export class JobWageDeterminations {
     /**
      * Cancel scheduled changes on job wage determination
      *
+     * Requires a user-scoped API key; company keys without a user
+     * receive 403 user_scoped_key_required.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.wage_determinations.scheduled_changes:delete`
@@ -4072,6 +4738,10 @@ export class JobWageDeterminations {
     /**
      * Schedule effective-dated change on job wage determination
      *
+     * Requires a user-scoped API key; company keys without a user
+     * receive 403 user_scoped_key_required.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.wage_determinations.scheduled_changes:create`
@@ -4151,6 +4821,10 @@ export class JobWageDeterminations {
     /**
      * Create job wage determination
      *
+     * Requires a user-scoped API key; company keys without a user
+     * receive 403 user_scoped_key_required.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.wage_determinations:create`
@@ -4170,6 +4844,10 @@ export class JobWageDeterminations {
     /**
      * Delete job wage determination
      *
+     * Requires a user-scoped API key; company keys without a user
+     * receive 403 user_scoped_key_required.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.wage_determinations:delete`
@@ -4200,6 +4878,9 @@ export class JobWageDeterminations {
     /**
      * Update job wage determination
      *
+     * Requires a user-scoped API key; company keys without a user
+     * receive 403 user_scoped_key_required.
+     *
      * 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
@@ -6874,6 +7555,11 @@ export class ProjectWageDeterminations {
      * being valid from that point on. Earlier versions are untouched and stay
      * readable through `as_of[valid]` and `/history`.
      *
+     * Copies on jobs starting on or after the end are removed. A copy still in
+     * use (assigned positions, apprenticeship determinations or referenced
+     * work) refuses the end with a 422 `validation_failed` problem carrying the
+     * copy's own reason, and both timelines stay unchanged.
+     *
      * Moving an end is cancel-then-schedule: cancel the standing termination,
      * then schedule the one you want.
      *