@dsptch-work/api-client 0.38.0 → 0.40.0

package/dist/gen/sdk.gen.js

@@ -3660,6 +3660,32 @@ export class Forms {
             ...options
         });
     }
+    /**
+     * Create form submission
+     *
+     * Read GET /api/v1/form_definitions/{id} and format json using
+     * its submission_shape. Requires a user-scoped key submitting
+     * as that user. Validates structure and types without running
+     * SurveyJS required-answer rules, visibility, defaults, or expressions.
+     * Returns the same representation as show.
+     *
+     *
+     * **Required scope:**
+     *
+     * `form_submissions:create`
+     *
+     */
+    static createFormSubmission(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/form_submissions',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * Show form submission
      *
@@ -4653,6 +4679,31 @@ export class PwaTrades {
     }
 }
 export class JobWageDeterminationRateRules {
+    /**
+     * Shift job wage determination rule genesis
+     *
+     * Move the valid-time family's lower bound to the required effective_date, a calendar
+     * day in the package timezone. An earlier bound extends its first version; a later
+     * bound can remove earlier versions. The new bound must precede any standing ending.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.wage_determinations.rate_rules.genesis:update`
+     *
+     */
+    static shiftJobWageDeterminationRateRuleGenesis(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/genesis',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List rate rule version history
      *
@@ -4683,6 +4734,118 @@ export class JobWageDeterminationRateRules {
             ...options
         });
     }
+    /**
+     * Cancel job wage determination rule scheduled changes
+     *
+     * Cancel every version after the baseline selected now, preserving and extending
+     * that baseline through the removed coverage. A wholly future family's first version
+     * remains its baseline. Returns nothing_to_cancel when there is no later version.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.wage_determinations.rate_rules.scheduled_changes:delete`
+     *
+     */
+    static cancelJobWageDeterminationRateRuleScheduledChanges(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * List job wage determination rule scheduled changes
+     *
+     * List every version after the baseline selected now, oldest boundary first. This
+     * paginated timeline is the exact cancellation set. A wholly future family's first
+     * version remains its baseline. Entries carry pay_rates_rule_id and empty corrections.
+     * The operation rejects as_of coordinates because it ranges over the valid-time axis.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.wage_determinations.rate_rules.scheduled_changes:read`
+     *
+     */
+    static listJobWageDeterminationRateRuleScheduledChanges(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * Schedule job wage determination rule change
+     *
+     * Apply a recipe from the required effective_date forward, at midnight in the
+     * package timezone. Each omitted recipe half carries from the version containing that
+     * date. Returns 201 for a newly added segment or 200 when editing an existing segment.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.wage_determinations.rate_rules.scheduled_changes:create`
+     *
+     */
+    static scheduleJobWageDeterminationRateRuleChange(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/scheduled_changes',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Cancel job wage determination rule termination
+     *
+     * Remove the family's standing finite upper bound and restore open-ended coverage.
+     * Returns nothing_to_cancel when the family has no ending.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.wage_determinations.rate_rules.scheduled_terminations:delete`
+     *
+     */
+    static cancelJobWageDeterminationRateRuleScheduledTermination(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/scheduled_termination',
+            ...options
+        });
+    }
+    /**
+     * Schedule job wage determination rule termination
+     *
+     * End the family's valid-time coverage at the required effective_date, a calendar
+     * day in the package timezone. The date must follow genesis; an existing ending must
+     * be canceled first. Earlier versions remain in history.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.wage_determinations.rate_rules.scheduled_terminations:create`
+     *
+     */
+    static scheduleJobWageDeterminationRateRuleTermination(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/scheduled_termination',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List rate rules
      *
@@ -4706,8 +4869,11 @@ export class JobWageDeterminationRateRules {
     /**
      * Create rate rule
      *
-     * Requires a user-scoped API key; company keys without a user
-     * receive 403 user_scoped_key_required.
+     * User keys follow the determination's editing permissions;
+     * managers may author its own hidden rate rules. Company keys
+     * act for their company without requiring a human user.
+     * A job determination synced from a project is read-only here;
+     * manage its rules on the source project instead (422).
      *
      * Unknown top-level fields and missing recipe fields return 400.
      * Malformed recipe values or keys and nonnumeric cents return
@@ -4731,6 +4897,27 @@ export class JobWageDeterminationRateRules {
             }
         });
     }
+    /**
+     * Delete job wage determination rate rule family
+     *
+     * Erase the rule's entire valid-time family, including historical and scheduled
+     * versions. Use a scheduled termination to end coverage while preserving history.
+     * This response has no family validator because the family no longer exists.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.wage_determinations.rate_rules:delete`
+     *
+     */
+    static deleteJobWageDeterminationRateRule(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}',
+            ...options
+        });
+    }
     /**
      * Show rate rule
      *
@@ -4746,6 +4933,31 @@ export class JobWageDeterminationRateRules {
             ...options
         });
     }
+    /**
+     * Update job wage determination rate rule
+     *
+     * Update the recipe from effective_from forward, defaulting to the selected
+     * version's start. Omitted halves carry from the version containing that date.
+     * A beginless version requires effective_from. Dates use the package timezone.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.wage_determinations.rate_rules:update`
+     *
+     */
+    static updateJobWageDeterminationRateRule(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class JobWageDeterminations {
     /**
@@ -7482,6 +7694,31 @@ export class ProjectDocuments {
     }
 }
 export class ProjectWageDeterminationRateRules {
+    /**
+     * Shift project wage determination rule genesis
+     *
+     * Move the valid-time family's lower bound to the required effective_date, a calendar
+     * day in the package timezone. An earlier bound extends its first version; a later
+     * bound can remove earlier versions. The new bound must precede any standing ending.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules.genesis:update`
+     *
+     */
+    static shiftProjectWageDeterminationRateRuleGenesis(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/genesis',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List project wage determination rate rule history
      *
@@ -7512,6 +7749,118 @@ export class ProjectWageDeterminationRateRules {
             ...options
         });
     }
+    /**
+     * Cancel project wage determination rule scheduled changes
+     *
+     * Cancel every version after the baseline selected now, preserving and extending
+     * that baseline through the removed coverage. A wholly future family's first version
+     * remains its baseline. Returns nothing_to_cancel when there is no later version.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules.scheduled_changes:delete`
+     *
+     */
+    static cancelProjectWageDeterminationRateRuleScheduledChanges(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * List project wage determination rule scheduled changes
+     *
+     * List every version after the baseline selected now, oldest boundary first. This
+     * paginated timeline is the exact cancellation set. A wholly future family's first
+     * version remains its baseline. Entries carry pay_rates_rule_id and empty corrections.
+     * The operation rejects as_of coordinates because it ranges over the valid-time axis.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules.scheduled_changes:read`
+     *
+     */
+    static listProjectWageDeterminationRateRuleScheduledChanges(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}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * Schedule project wage determination rule change
+     *
+     * Apply a recipe from the required effective_date forward, at midnight in the
+     * package timezone. Each omitted recipe half carries from the version containing that
+     * date. Returns 201 for a newly added segment or 200 when editing an existing segment.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules.scheduled_changes:create`
+     *
+     */
+    static scheduleProjectWageDeterminationRateRuleChange(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/{rate_rule_id}/scheduled_changes',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Cancel project wage determination rule termination
+     *
+     * Remove the family's standing finite upper bound and restore open-ended coverage.
+     * Returns nothing_to_cancel when the family has no ending.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules.scheduled_terminations:delete`
+     *
+     */
+    static cancelProjectWageDeterminationRateRuleScheduledTermination(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/scheduled_termination',
+            ...options
+        });
+    }
+    /**
+     * Schedule project wage determination rule termination
+     *
+     * End the family's valid-time coverage at the required effective_date, a calendar
+     * day in the package timezone. The date must follow genesis; an existing ending must
+     * be canceled first. Earlier versions remain in history.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules.scheduled_terminations:create`
+     *
+     */
+    static scheduleProjectWageDeterminationRateRuleTermination(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/{rate_rule_id}/scheduled_termination',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List project wage determination rate rules
      *
@@ -7530,6 +7879,13 @@ export class ProjectWageDeterminationRateRules {
     /**
      * Create project wage determination rate rule
      *
+     * User keys follow the determination's editing permissions;
+     * managers may author its own hidden rate rules. Company keys
+     * act for their company without requiring a human user.
+     * The first rule creates and attaches a hidden package atomically;
+     * invalid rules leave no package or attachment behind.
+     *
+     *
      * **Required scope:**
      *
      * `projects.pwa.wage_determinations.rate_rules:create`
@@ -7546,6 +7902,27 @@ export class ProjectWageDeterminationRateRules {
             }
         });
     }
+    /**
+     * Delete project wage determination rate rule family
+     *
+     * Erase the rule's entire valid-time family, including historical and scheduled
+     * versions. Use a scheduled termination to end coverage while preserving history.
+     * This response has no family validator because the family no longer exists.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules:delete`
+     *
+     */
+    static deleteProjectWageDeterminationRateRule(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}',
+            ...options
+        });
+    }
     /**
      * Show project wage determination rate rule
      *
@@ -7561,6 +7938,31 @@ export class ProjectWageDeterminationRateRules {
             ...options
         });
     }
+    /**
+     * Update project wage determination rate rule
+     *
+     * Update the recipe from effective_from forward, defaulting to the selected
+     * version's start. Omitted halves carry from the version containing that date.
+     * A beginless version requires effective_from. Dates use the package timezone.
+     * Conditional: send the rule family's ETag as If-Match. Changes affect PWA obligations.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.pwa.wage_determinations.rate_rules:update`
+     *
+     */
+    static updateProjectWageDeterminationRateRule(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class ProjectSites {
     /**
@@ -8070,12 +8472,14 @@ 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, and
-     * `participating_company_ids` is the complete set of participating companies.
-     * Remove a participant's jobs before removing it from this set. Returns 201
-     * with the project; unknown or inaccessible parent or
-     * company IDs return 404, and invalid attributes or relationships return 422.
-     * Undeclared body keys return 400 before any project or relationship is saved.
+     * 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.
      *
      *
      * **Required scope:**
@@ -8127,7 +8531,9 @@ export class Projects {
      * returns 422. `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. Remove a participant's
+     * replaces the complete set of participating companies. `manager_user_ids`
+     * replaces the complete set of project managers; omit the key to keep the
+     * stored set, or send an empty array to clear it. Remove a participant's
      * jobs before removing it from this set. Only the owning company may update the
      * project. Undeclared body keys return 400 before any project or relationship changes.
      *
@@ -8149,6 +8555,113 @@ export class Projects {
         });
     }
 }
+export class PwaCompanyDetails {
+    /**
+     * List PWA company details
+     *
+     * Lists PWA contractor details for the key's company. A company has at most
+     * one row; an empty list means none exists yet, not that the company is
+     * missing. Ordered by `created_at`, `id` and keyset-paginated.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.company_details:read`
+     *
+     */
+    static listCompanyDetails(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/company_details',
+            ...options
+        });
+    }
+    /**
+     * Create PWA company details
+     *
+     * Creates PWA contractor details for the key's company. The company is
+     * taken from the API key; `company_id` in the body is refused. A second
+     * create for the same company is `422` `taken`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.company_details:create`
+     *
+     */
+    static createCompanyDetail(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/company_details',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete PWA company details
+     *
+     * Deletes the PWA contractor-details row. A missing or out-of-scope id
+     * reads as not found. Delete removes the row; it does not archive.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.company_details:delete`
+     *
+     */
+    static deleteCompanyDetail(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/company_details/{id}',
+            ...options
+        });
+    }
+    /**
+     * Get PWA company details
+     *
+     * Returns one PWA contractor-details row owned by the key's company. A
+     * missing or out-of-scope id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.company_details:read`
+     *
+     */
+    static getCompanyDetail(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/company_details/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update PWA company details
+     *
+     * Updates PWA contractor details owned by the key's company. `company_id`
+     * is create-only and refused on PATCH.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.company_details:update`
+     *
+     */
+    static updateCompanyDetail(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/company_details/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class Users {
     /**
      * Create PWA company user details
@@ -9460,7 +9973,7 @@ export class AttestationConfigs {
     /**
      * Delete attestation config
      *
-     * Retires a question on the addressed pay schedule at its current pay period end. Repeated retirement preserves the earliest cutoff. A question from another pay schedule returns 404.
+     * Retires a question on the addressed pay schedule at its current pay period end, or immediately when no pay period is in progress. Repeated retirement preserves the earliest cutoff. A question from another pay schedule returns 404.
      *
      * **Required scope:**
      *