@dsptch-work/api-client 0.36.0 → 0.38.0

package/dist/gen/sdk.gen.js

@@ -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
      *
@@ -4277,7 +4388,7 @@ export class ProductionJobScopePrices {
      * Scope prices on a production-tracked job. Company keys,
      * and user keys held by an administrator, manager, safety
      * manager, or field lead of the company that owns the job,
-     * receive `unit_price` and `contracted_count`. Other user
+     * receive `unit_price_cents` and `contracted_count`. Other user
      * keys, held by crew on the job, receive the same rows
      * without those two fields.
      *
@@ -4298,9 +4409,10 @@ 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 or a
-     * missing `scope_kind` or `unit_price` return `400`, and a null or wrong-typed
-     * value returns `422`, without creating a price.
+     * `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.
      *
      *
      * **Required scope:**
@@ -4340,7 +4452,7 @@ export class ProductionJobScopePrices {
      * One scope price on a production-tracked job. Company keys,
      * and user keys held by an administrator, manager, safety
      * manager, or field lead of the company that owns the job,
-     * receive `unit_price` and `contracted_count`. Other user
+     * receive `unit_price_cents` and `contracted_count`. Other user
      * keys, held by crew on the job, receive the price without
      * those two fields.
      *
@@ -4360,10 +4472,11 @@ export class ProductionJobScopePrices {
     /**
      * Update production job scope price
      *
-     * Updates only the supplied `scope_kind`, `unit_price`, `contracted_count`,
+     * Updates only the supplied `scope_kind`, `unit_price_cents`, `contracted_count`,
      * 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.
+     * keys, including the retired dollar `unit_price`, 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:**
@@ -7562,6 +7675,102 @@ export class ProjectSites {
         });
     }
 }
+export class ProjectUserVisibilities {
+    /**
+     * List project user visibilities
+     *
+     * Returns the project's user-visibility joins (`Projects::UserVisibility`).
+     * Path `{id}` on the member routes is the join id. Nested under the
+     * authorized project. Reads are owner-only: rows are listed only to the
+     * restricting owner's company key, or to a user key the owner issued to
+     * one of its admins. Any other caller that can GET the project lists
+     * nothing, the owner's own keys included while it does not restrict.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.user_visibilities:read`
+     *
+     */
+    static listUserVisibilities(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/user_visibilities',
+            ...options
+        });
+    }
+    /**
+     * Create a project user visibility
+     *
+     * Names a person on the project. `user_id` is required and must hold a
+     * manager, safety manager, or field lead role at the owner. The project
+     * is taken from the path. Duplicate `(project, user)` pairs are 422. A
+     * user the key cannot see is 404. Writes are owner-only while the owner
+     * restricts project visibility: only its company key, or a user key it
+     * issued to one of its admins, may name a person. Any other caller that
+     * can GET the project receives 403.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.user_visibilities:create`
+     *
+     */
+    static createUserVisibility(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/user_visibilities',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a project user visibility
+     *
+     * Removes this project's user-visibility join. Descendant projects' rows
+     * for the same person stay put. Writes are owner-only while the owner
+     * restricts project visibility: only its company key, or a user key it
+     * issued to one of its admins, may remove a row. For any other caller
+     * the row is 404, as an unknown id is.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.user_visibilities:delete`
+     *
+     */
+    static deleteUserVisibility(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/user_visibilities/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show a project user visibility
+     *
+     * Returns one project–user visibility join. Reads are owner-only: only the
+     * restricting owner's company key, or a user key the owner issued to one
+     * of its admins, reads a row. A missing, mismatched, or out-of-scope id,
+     * or a row the caller cannot read, is 404.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.user_visibilities:read`
+     *
+     */
+    static getUserVisibility(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/user_visibilities/{id}',
+            ...options
+        });
+    }
+}
 export class ProjectWageDeterminations {
     /**
      * Shift project wage determination genesis
@@ -7857,7 +8066,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
@@ -7911,7 +8120,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 —
@@ -8122,6 +8331,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`
@@ -8158,10 +8378,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:**
@@ -8199,11 +8420,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:**
@@ -9084,7 +9306,8 @@ export class Timecodes {
      * Create a timecode for the calling company; `name` is the only required
      * field, and omitted fields take their model/DB defaults. Its owning company
      * is set automatically from the API key, and an optional `effective_date`
-     * sets the version's `valid_from` (defaulting to the request time). A timecode
+     * (a calendar day) starts the version at 00:00 UTC that day, the same as
+     * the web; omitted, it starts at the request time. A timecode
      * marked `pwa: true` may not also be `restricted_to: non_job`.
      *
      *