@dsptch-work/api-client 0.35.0 → 0.37.0

package/dist/gen/sdk.gen.js

@@ -640,7 +640,7 @@ 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.
+     * Only documented body keys are accepted. An undeclared top-level key or an omitted `name` or `data_type` returns 400; a wrongly typed value, or an undeclared key inside an `options` row, returns 422 at its pointer. Nothing is written on either.
      *
      * **Required scope:**
      *
@@ -695,7 +695,7 @@ 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.
+     * Only documented body keys are accepted. An undeclared top-level key returns 400; a wrongly typed value, or an undeclared key inside an `options` row, returns 422 at its pointer. Neither changes the attribute or its options. A missing attribute or one outside the key company or user visibility returns 404.
      *
      * **Required scope:**
      *
@@ -1385,6 +1385,10 @@ export class AssetsItems {
     /**
      * Delete document
      *
+     * Permanently deletes the document (`destroy!`). Succeeds with 204 and no
+     * body. A document that belongs to another item is 404.
+     *
+     *
      * **Required scope:**
      *
      * `assets.items.documents:delete`
@@ -2618,39 +2622,39 @@ export class CompetenciesAssessments {
         });
     }
 }
-export class CompetenciesAssessmentKeyActivities {
+export class CompetenciesAssessmentCriteria {
     /**
-     * List assessment key activities
+     * List assessment criteria
      *
-     * Lists the task lines snapshotted onto an assessment. decision and
+     * Lists the criterion 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`
+     * `competencies.assessments.criteria:read`
      *
      */
-    static listAssessmentKeyActivities(options) {
+    static listAssessmentCriteria(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/competencies/assessments/{assessment_id}/key_activities',
+            url: '/api/v1/competencies/assessments/{assessment_id}/criteria',
             ...options
         });
     }
     /**
-     * Show assessment key activity
+     * Show assessment criterion
      *
      * **Required scope:**
      *
-     * `competencies.assessments.key_activities:read`
+     * `competencies.assessments.criteria:read`
      *
      */
-    static getAssessmentKeyActivity(options) {
+    static getAssessmentCriterion(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{id}',
+            url: '/api/v1/competencies/assessments/{assessment_id}/criteria/{id}',
             ...options
         });
     }
@@ -2663,13 +2667,13 @@ export class CompetenciesEvidenceItems {
      *
      * **Required scope:**
      *
-     * `competencies.assessments.key_activities.evidence_items:read`
+     * `competencies.assessments.criteria.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',
+            url: '/api/v1/competencies/assessments/{assessment_id}/criteria/{criterion_id}/evidence_items',
             ...options
         });
     }
@@ -2678,13 +2682,13 @@ export class CompetenciesEvidenceItems {
      *
      * **Required scope:**
      *
-     * `competencies.assessments.key_activities.evidence_items:read`
+     * `competencies.assessments.criteria.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}',
+            url: '/api/v1/competencies/assessments/{assessment_id}/criteria/{criterion_id}/evidence_items/{id}',
             ...options
         });
     }
@@ -3807,6 +3811,113 @@ export class Groups {
     }
 }
 export class Jobs {
+    /**
+     * List documents for job
+     *
+     * Returns documents on the named job, including PWA documentation
+     * the caller may see. `{id}` is the job document. A missing or
+     * out-of-scope job reads as not found. Admin-only documents are
+     * omitted when the key cannot see job financials.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.documents:read`
+     *
+     */
+    static listJobDocuments(options) {
+        return (options.client ?? client).get({
+            querySerializer: { parameters: { 'filter[type]': { array: { explode: false } } } },
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/documents',
+            ...options
+        });
+    }
+    /**
+     * Create document for job
+     *
+     * Creates a document on the named job. `job_id` is the path only.
+     * Supply exactly one of `url` or `file`. `PWA_DOCUMENTATION` is
+     * persisted as admin-only.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.documents:create`
+     *
+     */
+    static createJobDocument(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/documents',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete document on job
+     *
+     * Removes the job document. A missing or misnested id reads as
+     * not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.documents:delete`
+     *
+     */
+    static deleteJobDocument(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/documents/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show document on job
+     *
+     * Returns one document on the named job. A missing, misnested, or
+     * unauthorized admin-only id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.documents:read`
+     *
+     */
+    static getJobDocument(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/documents/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update document on job
+     *
+     * Updates a document on the named job. Omit a field to preserve
+     * it. The document must remain exactly one of `url` or `file`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.documents:update`
+     *
+     */
+    static updateJobDocument(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/documents/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List form assignment tasks for job
      *
@@ -5987,6 +6098,21 @@ export class PayPeriods {
             ...options
         });
     }
+    /**
+     * Show pay period
+     *
+     * **Required scope:**
+     *
+     * `pay_periods:read`
+     *
+     */
+    static getPayPeriod(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay_periods/{id}',
+            ...options
+        });
+    }
 }
 export class CompensationElements {
     /**
@@ -7225,6 +7351,134 @@ export class ProductionCompletions {
         });
     }
 }
+export class ProjectDocuments {
+    /**
+     * List versions
+     *
+     * Lists PaperTrail versions for the document, oldest first by `created_at`
+     * then `id`. This is transaction-time audit history, not a temporal
+     * `/history` lens: there is no `If-Match` and no valid-time window.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.documents.versions:read`
+     *
+     */
+    static listProjectDocumentVersions(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/documents/{document_id}/versions',
+            ...options
+        });
+    }
+    /**
+     * List documents
+     *
+     * Returns the project's documents (`VDocument` rows whose `name` is
+     * `"document"`), oldest first by `created_at` then `id`. Nested under the
+     * authorized project: an unknown or out-of-scope `project_id` is 404.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.documents:read`
+     *
+     */
+    static listProjectDocuments(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/documents',
+            ...options
+        });
+    }
+    /**
+     * Create document
+     *
+     * Attaches a file to the authorized project. `file` is a signed id from
+     * `POST /api/v1/direct_uploads` naming `projects.documents`. The project is
+     * taken from the path and the creator from `performed_by_user_id`. `name` is
+     * not writable.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.documents:create`
+     *
+     */
+    static createProjectDocument(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/documents',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete document
+     *
+     * Permanently deletes the document (`destroy!`). Succeeds with 204 and no
+     * body. A document that belongs to another project is 404.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.documents:delete`
+     *
+     */
+    static deleteProjectDocument(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/documents/{id}',
+            ...options
+        });
+    }
+    /**
+     * Get document
+     *
+     * Returns one project document. A document that belongs to another project
+     * is 404, even when that other project is visible to the key.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.documents:read`
+     *
+     */
+    static getProjectDocument(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/documents/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update document
+     *
+     * Updates filename, description, and/or the attached file. `name` is
+     * read-only (`attr_readonly`); sending it is 400 as an undeclared key.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.documents:update`
+     *
+     */
+    static updateProjectDocument(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/documents/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class ProjectWageDeterminationRateRules {
     /**
      * List project wage determination rate rule history
@@ -7714,7 +7968,7 @@ export class Projects {
      * Create a project owned by the API key's company (owned_by_company_id is set
      * automatically from the key). Requires `name`, and `created_by_user_id` must
      * reference a member of the owning company. `budget_currency` defaults to USD;
-     * the federal-PWA-only fields (administrator name/email/phone, budget, and the
+     * the federal-PWA-only fields (administrator name/email/phone, `budget_cents`, and the
      * prevailing-wage lock-in / beginning-of-construction / placed-in-service dates)
      * and `asset_owner` apply only while `federal_pwa_mode` is not `none`, so sending
      * one of them on a project that tracks no federal PWA — even as null — returns
@@ -7768,7 +8022,7 @@ export class Projects {
      *
      * Update a project's attributes. `name` cannot be blanked, and
      * `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
+     * even when the value is unchanged. Omit it on PATCH. The federal-PWA-only fields (administrator contact, `budget_cents`, 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 —
@@ -7979,6 +8233,17 @@ export class Users {
     /**
      * Remove employment entirely (retroactive, irreversible)
      *
+     * Permanently remove every valid-time version of this person's
+     * employment at the company.
+     *
+     * Conditional: send the employment's `ETag` as `If-Match`. The
+     * person's user record names the employment as `employment_id`; read
+     * its `ETag` from `GET /api/v1/people/employments/{employment_id}/history`,
+     * or from `GET /api/v1/people/employments/{id}` while a version covers now.
+     * A key without the history scope may send `If-Match: *` instead,
+     * which removes whatever state exists.
+     *
+     *
      * **Required scope:**
      *
      * `users.companies:delete`
@@ -7987,7 +8252,7 @@ export class Users {
     static removeUserFromCompany(options) {
         return (options.client ?? client).delete({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/users/{user_id}/companies/{company_id}',
+            url: '/api/v1/users/{user_id}/companies/{id}',
             ...options
         });
     }
@@ -8002,7 +8267,7 @@ export class Users {
     static updateCompany(options) {
         return (options.client ?? client).patch({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/users/{user_id}/companies/{company_id}',
+            url: '/api/v1/users/{user_id}/companies/{id}',
             ...options,
             headers: {
                 'Content-Type': 'application/json',
@@ -8015,10 +8280,11 @@ export class Users {
      *
      * Workers the credential company sees: people it employs, has
      * granted a role, or has invited. Direct monetary employment
-     * fields (`hourly_rate`, `training_annual_amount`,
-     * `employer_combined_health_amount`, `employer_combined_savings`)
-     * are present for company keys, company administrators, and the
-     * employed person, and omitted for other user keys.
+     * fields (`hourly_rate_cents`, `training_annual_amount_cents`,
+     * `employer_combined_health_amount_cents`,
+     * `employer_combined_savings_cents`) are present for company
+     * keys, company administrators, and the employed person, and
+     * omitted for other user keys.
      *
      *
      * **Required scope:**
@@ -8056,11 +8322,12 @@ export class Users {
     /**
      * Show user
      *
-     * Direct monetary employment fields (`hourly_rate`,
-     * `training_annual_amount`, `employer_combined_health_amount`,
-     * `employer_combined_savings`) are present for company keys,
-     * company administrators, and the employed person, and omitted
-     * for other user keys.
+     * Direct monetary employment fields (`hourly_rate_cents`,
+     * `training_annual_amount_cents`,
+     * `employer_combined_health_amount_cents`,
+     * `employer_combined_savings_cents`) are present for company
+     * keys, company administrators, and the employed person, and
+     * omitted for other user keys.
      *
      *
      * **Required scope:**