@dsptch-work/api-client 0.40.0 → 0.41.0

package/dist/gen/sdk.gen.js

@@ -3669,6 +3669,23 @@ export class Forms {
      * SurveyJS required-answer rules, visibility, defaults, or expressions.
      * Returns the same representation as show.
      *
+     * File and signature answers take signed IDs, never file contents.
+     * Upload each file first: call POST /api/v1/direct_uploads with
+     * resource form_submissions, PUT the bytes to the returned
+     * direct_upload.url with its headers, then send the returned
+     * signed_id here within a week.
+     *
+     * - A file answer is an array holding one signed ID per file. Each
+     * file is attached to the submission, and the response returns a
+     * download URL in its place. An image file may hold at most 10 MiB.
+     * - A signature answer is one signed ID, and its image is stored in
+     * the answer as a data URL. It must be a PNG or JPEG image, declared
+     * as image/png or image/jpeg to match its bytes or as
+     * application/octet-stream, hold at most 256 KiB, and span at most
+     * 2,000 pixels on either side. A submission's signature answers may
+     * hold at most 2 MiB together, and an upload counts once for each
+     * answer naming it.
+     *
      *
      * **Required scope:**
      *
@@ -3686,6 +3703,27 @@ export class Forms {
             }
         });
     }
+    /**
+     * Delete form submission
+     *
+     * Deletes a submission that is not used as competency evidence.
+     * Competency-evidence restriction is refused with `422`
+     * `destroy_restricted`. Form-assignment rows that pointed at the
+     * submission are nullified. Attachments are kept. Returns `204`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `form_submissions:delete`
+     *
+     */
+    static deleteFormSubmission(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/form_submissions/{id}',
+            ...options
+        });
+    }
     /**
      * Show form submission
      *
@@ -3701,6 +3739,31 @@ export class Forms {
             ...options
         });
     }
+    /**
+     * Update form submission
+     *
+     * Updates timezone and json on an existing submission. json is the
+     * stored SurveyJS tree, including file-answer objects; file content
+     * is rewritten through the same writer the web uses. form_definition_id
+     * and user_id cannot change. Returns the same representation as show.
+     *
+     *
+     * **Required scope:**
+     *
+     * `form_submissions:update`
+     *
+     */
+    static updateFormSubmission(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/form_submissions/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class Groups {
     /**
@@ -4039,7 +4102,8 @@ export class Jobs {
      * 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.
+     * Ordered by request_start_date descending then id. Proof document slots are
+     * always present as `null` or a document object.
      *
      *
      * **Required scope:**
@@ -4054,11 +4118,61 @@ export class Jobs {
             ...options
         });
     }
+    /**
+     * Create good-faith effort exception
+     *
+     * Creates a good-faith-effort exception on the named job. `job_id` is the path
+     * only. Scalar fields match GET; send minutes, not the web form's
+     * `hours_per_apprentice`. Proof files attach through
+     * `request_letter_signed_id`, `submission_proof_signed_id`,
+     * `response_letter_signed_id`, and `no_availability_proof_signed_id` minted by
+     * `POST /api/v1/direct_uploads` naming
+     * `jobs.pwa.apprenticeship.good_faith_effort_exceptions`; when any of those
+     * keys is present, `performed_by_user_id` is required. Model validations are
+     * the 422 source. A missing or out-of-scope job reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.apprenticeship.good_faith_effort_exceptions:create`
+     *
+     */
+    static createGoodFaithEffortException(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/apprenticeship/good_faith_effort_exceptions',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete good-faith effort exception
+     *
+     * Removes the good-faith-effort exception nested on the named job. A missing,
+     * misnested, or out-of-scope id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.apprenticeship.good_faith_effort_exceptions:delete`
+     *
+     */
+    static deleteGoodFaithEffortException(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/apprenticeship/good_faith_effort_exceptions/{id}',
+            ...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.
+     * misnested, or out-of-scope id reads as not found. Proof document slots are
+     * always present as `null` or a document object.
      *
      *
      * **Required scope:**
@@ -4073,6 +4187,31 @@ export class Jobs {
             ...options
         });
     }
+    /**
+     * Update good-faith effort exception
+     *
+     * Updates a good-faith-effort exception nested on the named job. Omit a field
+     * to preserve it. Omit a proof signed-id key to keep the stored file; replacing
+     * a populated slot keeps the original creator. A missing, misnested, or
+     * out-of-scope id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.apprenticeship.good_faith_effort_exceptions:update`
+     *
+     */
+    static updateGoodFaithEffortException(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/apprenticeship/good_faith_effort_exceptions/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List cure payments
      *
@@ -4080,7 +4219,7 @@ export class Jobs {
      * 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.
+     * created_at descending, then id.
      *
      *
      * **Required scope:**
@@ -4095,11 +4234,58 @@ export class Jobs {
             ...options
         });
     }
+    /**
+     * Create a cure payment
+     *
+     * Creates a PWA cure payment on the named job. `job_id` comes from the
+     * path. `type`, `amount_cents`, the three dates, and `performed_by_user_id`
+     * are required. `type` is the stored STI class name and is create-only.
+     * The attestation file attaches through `attestation_signed_id` minted by
+     * `POST /api/v1/direct_uploads` naming `jobs.pwa.cure_payments`. A missing
+     * or out-of-scope job or filer reads as not found. Model validations
+     * return 422. Undeclared body keys return 400.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.cure_payments:create`
+     *
+     */
+    static createCurePayment(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/cure_payments',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a cure payment
+     *
+     * Removes the PWA cure payment nested on the named job. A missing or
+     * misnested id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.cure_payments:delete`
+     *
+     */
+    static deleteCurePayment(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/cure_payments/{id}',
+            ...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.
+     * misnested, or out-of-scope id reads as not found.
      *
      *
      * **Required scope:**
@@ -4114,6 +4300,33 @@ export class Jobs {
             ...options
         });
     }
+    /**
+     * Update a cure payment
+     *
+     * Updates a PWA cure payment nested on the named job. Omit a field to
+     * preserve it. `type` is create-only; sending it returns 400. Omit
+     * `attestation_signed_id` to keep the stored file; send it with
+     * `performed_by_user_id` to create or replace the attestation. Replacing
+     * a populated slot keeps the original document id and creator. A missing
+     * or misnested id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.cure_payments:update`
+     *
+     */
+    static updateCurePayment(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/pwa/cure_payments/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List sites for job
      *
@@ -5220,6 +5433,7 @@ export class JobWageDeterminations {
      * at once, so it moves every version rather than applying from
      * `effective_from`. A determination cascaded from a project mirrors that
      * project's determination and cannot be edited here — change it on the project.
+     * Re-pointing a journeyworker-basis determination also moves the apprentice determinations that follow it.
      *
      * Conditional: send the determination's `ETag` as `If-Match`.
      *
@@ -8416,6 +8630,7 @@ export class ProjectWageDeterminations {
      * `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.
+     * Re-pointing a journeyworker-basis determination also moves the apprentice determinations that follow it.
      *
      * Conditional: send the determination's `ETag` as `If-Match`.
      *
@@ -8472,14 +8687,17 @@ export class Projects {
      * 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
-     * 422. `parent_id` may name a project visible to the API key's policy,
-     * `participating_company_ids` is the complete set of participating companies,
-     * and `manager_user_ids` is the complete set of project managers (each a
-     * manager of the owning company). Remove a participant's jobs before removing
-     * it from this set. Returns 201 with the project; unknown or inaccessible
-     * parent, company, or manager user IDs return 404, and invalid attributes or
-     * relationships return 422. Undeclared body keys return 400 before any project
-     * or relationship is saved.
+     * 422. IRA evidence files attach through `lock_in_date_doc_signed_id`,
+     * `beginning_of_construction_doc_signed_id`, and `placed_in_service_doc_signed_id`
+     * minted by `POST /api/v1/direct_uploads` naming `projects`; when any of those
+     * keys is present, `performed_by_user_id` is required. `parent_id` may name a
+     * project visible to the API key's policy, `participating_company_ids` is the
+     * complete set of participating companies, and `manager_user_ids` is the complete
+     * set of project managers (each a manager of the owning company). Remove a
+     * participant's jobs before removing it from this set. Returns 201 with the
+     * project; unknown or inaccessible parent, company, manager, or filer user IDs
+     * return 404, and invalid attributes or relationships return 422. Undeclared
+     * body keys return 400 before any project or relationship is saved.
      *
      *
      * **Required scope:**
@@ -8528,7 +8746,12 @@ export class Projects {
      * 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 —
-     * returns 422. `budget_currency` defaults to USD when blank. `parent_id` moves
+     * returns 422. IRA evidence files attach through `lock_in_date_doc_signed_id`,
+     * `beginning_of_construction_doc_signed_id`, and `placed_in_service_doc_signed_id`
+     * minted by `POST /api/v1/direct_uploads` naming `projects`; omit a key to keep
+     * the stored file, and send `performed_by_user_id` when any signed id is present.
+     * Replacing a populated slot keeps the original `created_by_user_id`.
+     * `budget_currency` defaults to USD when blank. `parent_id` moves
      * or detaches the project; a project whose parent no longer lists its owner
      * still accepts updates that keep that parent. `participating_company_ids`
      * replaces the complete set of participating companies. `manager_user_ids`
@@ -8723,10 +8946,16 @@ export class Users {
     /**
      * List scheduled compensation changes for user's employment
      *
+     * Deprecated: use `GET /api/v1/people/employments/{employment_id}/history` instead.
+     * The successor is keyed by the employment's `id` and lists every version, newest first.
+     *
+     *
      * **Required scope:**
      *
      * `users.companies.scheduled_changes:read`
      *
+     *
+     * @deprecated
      */
     static listUserCompanyScheduledChanges(options) {
         return (options.client ?? client).get({
@@ -8738,10 +8967,16 @@ export class Users {
     /**
      * Create scheduled change to user's employment information
      *
+     * Deprecated: use `POST /api/v1/people/employments/{employment_id}/scheduled_changes` instead.
+     * The successor is keyed by the employment's `id` and needs `If-Match`.
+     *
+     *
      * **Required scope:**
      *
      * `users.companies.scheduled_changes:create`
      *
+     *
+     * @deprecated
      */
     static createUserCompanyScheduledChange(options) {
         return (options.client ?? client).post({
@@ -8757,10 +8992,16 @@ export class Users {
     /**
      * Cancel scheduled compensation change (removes the future version from the timeline)
      *
+     * Deprecated: use `DELETE /api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}` instead.
+     * The successor is keyed by the employment's `id` and the change's effective date, and needs `If-Match`.
+     *
+     *
      * **Required scope:**
      *
      * `users.companies.scheduled_changes:delete`
      *
+     *
+     * @deprecated
      */
     static cancelUserCompanyScheduledChange(options) {
         return (options.client ?? client).delete({
@@ -8772,10 +9013,16 @@ export class Users {
     /**
      * Update scheduled compensation change
      *
+     * Deprecated: use `PATCH /api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}` instead.
+     * The successor is keyed by the employment's `id` and the change's effective date, and needs `If-Match`.
+     *
+     *
      * **Required scope:**
      *
      * `users.companies.scheduled_changes:update`
      *
+     *
+     * @deprecated
      */
     static updateScheduledChange(options) {
         return (options.client ?? client).patch({
@@ -10209,6 +10456,32 @@ export class TimeOffRequests {
             ...options
         });
     }
+    /**
+     * Create time off request
+     *
+     * Create a time-off request for a worker. Name the worker and the filer.
+     * When they are the same person the request is born pending; otherwise it
+     * is born approved with the filer stamped as reviewer and an Absence is
+     * built in the background. Instants are the beginning of the first day and
+     * the end of the last day in the pay-schedule timezone.
+     *
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.time_off_requests:create`
+     *
+     */
+    static createTimeOffRequest(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/time_off_requests',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * Show time off request
      *
@@ -10228,6 +10501,30 @@ export class TimeOffRequests {
             ...options
         });
     }
+    /**
+     * Review time off request
+     *
+     * Approve, deny, or cancel a pending time-off request. The named filer is
+     * the reviewer: only the worker may cancel, and nobody may approve or deny
+     * their own row. Approving enqueues the Absence build.
+     *
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.time_off_requests.reviews:create`
+     *
+     */
+    static createReview(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/time_off_requests/{time_off_request_id}/reviews',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class TimeSessions {
     /**