@dsptch-work/api-client 0.25.0 → 0.27.0

package/dist/gen/sdk.gen.js

@@ -291,6 +291,27 @@ export class ApprenticeshipEmployers {
             ...options
         });
     }
+    /**
+     * Show apprenticeship employer
+     *
+     * Returns one employer roster row in a program the key's company sponsors
+     * or is enrolled in as an employer. The object matches the list, create,
+     * and update door. A missing, mismatched, or out-of-scope id reads as
+     * not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.programs.employers:read`
+     *
+     */
+    static getEmployer(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/programs/{program_id}/employers/{id}',
+            ...options
+        });
+    }
     /**
      * Update apprenticeship employer
      *
@@ -440,6 +461,48 @@ export class ApprenticeshipWageSchedulePeriods {
             }
         });
     }
+    /**
+     * Delete apprenticeship wage schedule period
+     *
+     * Deletes an unused non-opening period nested under the wage schedule in
+     * the path. Period 0 (the entry step) and a period with active apprentices
+     * are refused with a `422`. An unused later period returns `204`. Deletes
+     * are sponsor-only; an enrolled employer is `403`. A missing, out-of-scope,
+     * or mismatched schedule/period pair is `404`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.wage_schedules.periods:delete`
+     *
+     */
+    static deletePeriod(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/wage_schedules/{wage_schedule_id}/periods/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show apprenticeship wage schedule period
+     *
+     * Returns one period nested under the wage schedule in the path. The
+     * object matches the list, create, and update door. A missing, out-of-scope,
+     * or mismatched schedule/period pair is not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.wage_schedules.periods:read`
+     *
+     */
+    static getPeriod(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/wage_schedules/{wage_schedule_id}/periods/{id}',
+            ...options
+        });
+    }
     /**
      * Update apprenticeship wage schedule period
      *
@@ -2127,6 +2190,44 @@ export class CertificationPackages {
     }
 }
 export class UserCertifications {
+    /**
+     * Revoke user certification approval
+     *
+     * Revokes the approval on a certification held by a worker.
+     *
+     * **Required scope:**
+     *
+     * `certifications.user_certifications.approvals:delete`
+     *
+     */
+    static revokeUserCertificationApproval(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/certifications/user_certifications/{user_certification_id}/approval',
+            ...options
+        });
+    }
+    /**
+     * Approve user certification
+     *
+     * Records who approved a certification held by a worker and stamps when. A user key approves in its own user's name; a company key names the approver. A company key must name a visible admin, manager, or safety manager at its company. A user key needs an approving role at a company that employs the holder. The approver cannot be the holder.
+     *
+     * **Required scope:**
+     *
+     * `certifications.user_certifications.approvals:create`
+     *
+     */
+    static approveUserCertification(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/certifications/user_certifications/{user_certification_id}/approval',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List user certifications
      *
@@ -2336,8 +2437,9 @@ export class CompaniesDepartments {
      *
      * Deletes a department that has no employment assignments. A department still
      * assigned on any employment is refused with a `422` — reassign those
-     * employments first. An unused department returns `204` and is gone from a
-     * later GET.
+     * employments first. Deleting a department clears its assignment on jobs
+     * while preserving those jobs. A successful deletion returns `204` and the
+     * department is gone from a later GET.
      *
      *
      * **Required scope:**
@@ -2641,6 +2743,21 @@ export class Forms {
             ...options
         });
     }
+    /**
+     * Show form definition
+     *
+     * **Required scope:**
+     *
+     * `form_definitions:read`
+     *
+     */
+    static getFormDefinition(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/form_definitions/{id}',
+            ...options
+        });
+    }
     /**
      * List form submission versions
      *
@@ -2861,10 +2978,400 @@ export class Groups {
         });
     }
 }
+export class Jobs {
+    /**
+     * List form assignment tasks for job
+     *
+     * Returns form-completion tasks nested on the named job.
+     * `{id}` is the `Tasks::JobFormAssignmentTask` id, not the web
+     * show `Task#uid`. A missing or out-of-scope job reads as not
+     * found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.form_assignment_tasks:read`
+     *
+     */
+    static listJobFormAssignmentTasks(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/form_assignment_tasks',
+            ...options
+        });
+    }
+    /**
+     * Create form assignment task for job
+     *
+     * Creates a form-completion task on the named job. `job_id` is
+     * the path only. `form_definition_id` and
+     * `task_attributes.created_by_user_id` are required.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.form_assignment_tasks:create`
+     *
+     */
+    static createJobFormAssignmentTask(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/form_assignment_tasks',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Show form assignment task on job
+     *
+     * Returns one form-completion task on the named job. `{id}` is
+     * the `Tasks::JobFormAssignmentTask` id. A missing, misnested,
+     * or out-of-scope id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.form_assignment_tasks:read`
+     *
+     */
+    static getJobFormAssignmentTask(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/form_assignment_tasks/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update form assignment task on job
+     *
+     * Updates the existing task in place. `job_id` is the path only.
+     * Replacing `task_assignee_user_ids` does not insert join rows
+     * before authorize.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.form_assignment_tasks:update`
+     *
+     */
+    static updateJobFormAssignmentTask(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/form_assignment_tasks/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List sites for job
+     *
+     * Returns the job-site join rows on the named job. `{id}` is the
+     * join row, not the Site. A missing or out-of-scope job reads as
+     * not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.sites:read`
+     *
+     */
+    static listJobSites(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/sites',
+            ...options
+        });
+    }
+    /**
+     * Create site for job
+     *
+     * Attaches a Site to the named job. `job_id` is the path only.
+     * `site_id` is required; `feature_ids` is optional and replaced
+     * as a set. Duplicate (job, site) pairs are rejected.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.sites:create`
+     *
+     */
+    static createJobSite(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/sites',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete site on job
+     *
+     * Removes the job-site join. The Site itself is not deleted.
+     * Job-site features cascade with the join. A job may have zero
+     * sites afterward.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.sites:delete`
+     *
+     */
+    static deleteJobSite(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/sites/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show site on job
+     *
+     * Returns one job-site join on the named job. `{id}` is the join
+     * row. A missing, misnested, or out-of-scope id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.sites:read`
+     *
+     */
+    static getJobSite(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/sites/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update site on job
+     *
+     * Replaces `feature_ids` on an existing job-site join. `site_id`
+     * cannot be changed. An empty array clears every feature.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.sites:update`
+     *
+     */
+    static updateJobSite(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/sites/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List jobs
+     *
+     * **Required scope:**
+     *
+     * `jobs:read`
+     *
+     */
+    static listJobs(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs',
+            ...options
+        });
+    }
+    /**
+     * Create job
+     *
+     * **Required scope:**
+     *
+     * `jobs:create`
+     *
+     */
+    static createJob(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Show job
+     *
+     * **Required scope:**
+     *
+     * `jobs:read`
+     *
+     */
+    static getJob(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update job
+     *
+     * **Required scope:**
+     *
+     * `jobs:update`
+     *
+     */
+    static updateJob(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List positions for job
+     *
+     * **Required scope:**
+     *
+     * `jobs.positions:read`
+     *
+     */
+    static listPositions(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/positions',
+            ...options
+        });
+    }
+    /**
+     * Create position for job
+     *
+     * cash_fringe_rate_cents, hourly_rate_cents, pwa_wage_pay_rate_cents and
+     * wage_adder_rate_cents are admin only on user-scoped keys.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.positions:create`
+     *
+     */
+    static createPosition(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/positions',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete position on job
+     *
+     * Deletes a position that has no logged work and no restricting
+     * associations. A position still referenced by time entries,
+     * time-card per diems, completion positions, or aggregate logged
+     * work is refused with a `422`. An unused position returns `204`
+     * and is gone from a later GET.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.positions:delete`
+     *
+     */
+    static deletePosition(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/positions/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show position on job
+     *
+     * Returns one position on the named job. A missing, misnested, or
+     * out-of-scope id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.positions:read`
+     *
+     */
+    static getPosition(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/positions/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update position on job
+     *
+     * cash_fringe_rate_cents, hourly_rate_cents, pwa_wage_pay_rate_cents and
+     * wage_adder_rate_cents are admin only on user-scoped keys.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.positions:update`
+     *
+     */
+    static updatePosition(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/positions/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List job templates
+     *
+     * **Required scope:**
+     *
+     * `jobs.templates:read`
+     *
+     */
+    static listTemplates(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/templates',
+            ...options
+        });
+    }
+}
 export class ProductionJobScopePrices {
     /**
      * List production job scope prices
      *
+     * 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
+     * keys, held by crew on the job, receive the same rows
+     * without those two fields.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.production.job_scope_prices:read`
@@ -2914,6 +3421,14 @@ export class ProductionJobScopePrices {
     /**
      * Show production job scope price
      *
+     * 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
+     * keys, held by crew on the job, receive the price without
+     * those two fields.
+     *
+     *
      * **Required scope:**
      *
      * `jobs.production.job_scope_prices:read`
@@ -3439,102 +3954,116 @@ export class JobWageDeterminations {
         });
     }
 }
-export class Jobs {
+export class OpenApi {
     /**
-     * List jobs
+     * Show OpenAPI spec
      *
-     * **Required scope:**
+     * **No scope required:**
      *
-     * `jobs:read`
+     * Every authenticated API key may call this endpoint. It returns the machine-readable OpenAPI
+     * document that describes this API.
+     *
+     * **Stability:**
+     *
+     * The document is static between contract changes: it changes only when the API surface
+     * does — an endpoint, field, or schema added or altered — on no fixed schedule. Fetch it
+     * when your integration starts, or when you regenerate a client, rather than on a poll.
      *
      */
-    static listJobs(options) {
+    static getOpenapiDocument(options) {
         return (options?.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs',
+            url: '/api/v1/openapi',
             ...options
         });
     }
+}
+export class OversiteSiteCheckIns {
     /**
-     * Create job
-     *
-     * **Required scope:**
+     * List Site Check-ins
      *
-     * `jobs:create`
+     * Returns only the check-ins visible to the API key's company: those made by its
+     * currently-employed members, plus all of the site's check-ins when the company
+     * holds a claim on it with check-in features enabled. Other check-ins are
+     * omitted, so a visible site can return an empty list.
      *
-     */
-    static createJob(options) {
-        return (options.client ?? client).post({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs',
-            ...options,
-            headers: {
-                'Content-Type': 'application/json',
-                ...options.headers
-            }
-        });
-    }
-    /**
-     * Show job
      *
      * **Required scope:**
      *
-     * `jobs:read`
+     * `oversite.sites.check_ins:read`
      *
      */
-    static getJob(options) {
+    static listSiteCheckIns(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{id}',
+            url: '/api/v1/oversite/sites/{site_id}/check_ins',
             ...options
         });
     }
     /**
-     * Update job
+     * Show Site Check-in
+     *
+     * A check-in is visible to the API key's company when its author is a
+     * currently-employed member, or when the company holds a claim on the site
+     * with check-in features enabled; requesting one outside that visibility
+     * returns `404`.
+     *
      *
      * **Required scope:**
      *
-     * `jobs:update`
+     * `oversite.sites.check_ins:read`
      *
      */
-    static updateJob(options) {
-        return (options.client ?? client).patch({
+    static getSiteCheckIn(options) {
+        return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{id}',
-            ...options,
-            headers: {
-                'Content-Type': 'application/json',
-                ...options.headers
-            }
+            url: '/api/v1/oversite/sites/{site_id}/check_ins/{id}',
+            ...options
         });
     }
+}
+export class OversiteFeatureFormAssignmentTasks {
     /**
-     * List positions for job
+     * List form assignment tasks for feature
+     *
+     * Returns form-completion tasks nested on the named feature.
+     * `{id}` is the `Tasks::FeatureFormAssignmentTask` id, not the
+     * web show `Task#uid`. Sites and features are shared; only this
+     * company's nested tasks are listed. A missing site, a feature
+     * not on that site, or a site without a company SiteClaim with
+     * site_forms enabled, reads as not found.
+     *
      *
      * **Required scope:**
      *
-     * `jobs.positions:read`
+     * `oversite.sites.features.form_assignment_tasks:read`
      *
      */
-    static listPositions(options) {
+    static listFeatureFormAssignmentTasks(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/positions',
+            url: '/api/v1/oversite/sites/{site_id}/features/{feature_id}/form_assignment_tasks',
             ...options
         });
     }
     /**
-     * Create position for job
+     * Create form assignment task for feature
+     *
+     * Creates a form-completion task on the named feature. `site_id`
+     * and `feature_id` are the path only. `form_definition_id` and
+     * `task_attributes.created_by_user_id` are required. An empty
+     * `task_assignee_user_ids` list is valid.
+     *
      *
      * **Required scope:**
      *
-     * `jobs.positions:create`
+     * `oversite.sites.features.form_assignment_tasks:create`
      *
      */
-    static createPosition(options) {
+    static createFeatureFormAssignmentTask(options) {
         return (options.client ?? client).post({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/positions',
+            url: '/api/v1/oversite/sites/{site_id}/features/{feature_id}/form_assignment_tasks',
             ...options,
             headers: {
                 'Content-Type': 'application/json',
@@ -3543,58 +4072,44 @@ export class Jobs {
         });
     }
     /**
-     * Delete position on job
+     * Show form assignment task on feature
      *
-     * Deletes a position that has no logged work and no restricting
-     * associations. A position still referenced by time entries,
-     * time-card per diems, completion positions, or aggregate logged
-     * work is refused with a `422`. An unused position returns `204`
-     * and is gone from a later GET.
+     * Returns one form-completion task on the named feature. `{id}`
+     * is the `Tasks::FeatureFormAssignmentTask` id. A missing,
+     * misnested, or other-company id on this shared feature reads as
+     * not found.
      *
      *
      * **Required scope:**
      *
-     * `jobs.positions:delete`
+     * `oversite.sites.features.form_assignment_tasks:read`
      *
      */
-    static deletePosition(options) {
-        return (options.client ?? client).delete({
+    static getFeatureFormAssignmentTask(options) {
+        return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/positions/{id}',
+            url: '/api/v1/oversite/sites/{site_id}/features/{feature_id}/form_assignment_tasks/{id}',
             ...options
         });
     }
     /**
-     * Show position on job
-     *
-     * Returns one position on the named job. A missing, misnested, or
-     * out-of-scope id reads as not found.
-     *
-     *
-     * **Required scope:**
+     * Update form assignment task on feature
      *
-     * `jobs.positions:read`
+     * Updates the existing task in place. `site_id` and
+     * `feature_id` are the path only. Replacing
+     * `task_assignee_user_ids` does not insert join rows before
+     * authorize.
      *
-     */
-    static getPosition(options) {
-        return (options.client ?? client).get({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/positions/{id}',
-            ...options
-        });
-    }
-    /**
-     * Update position on job
      *
      * **Required scope:**
      *
-     * `jobs.positions:update`
+     * `oversite.sites.features.form_assignment_tasks:update`
      *
      */
-    static updatePosition(options) {
+    static updateFeatureFormAssignmentTask(options) {
         return (options.client ?? client).patch({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/positions/{id}',
+            url: '/api/v1/oversite/sites/{site_id}/features/{feature_id}/form_assignment_tasks/{id}',
             ...options,
             headers: {
                 'Content-Type': 'application/json',
@@ -3602,87 +4117,97 @@ export class Jobs {
             }
         });
     }
+}
+export class OversiteSiteFormAssignmentTasks {
     /**
-     * List job templates
+     * List form assignment tasks for site
+     *
+     * Returns form-completion tasks nested on the named site.
+     * `{id}` is the `Tasks::SiteFormAssignmentTask` id, not the
+     * web show `Task#uid`. Sites are shared; only this company's
+     * nested tasks are listed. A missing site, or one without a
+     * company SiteClaim with site_forms enabled, reads as not found.
+     *
      *
      * **Required scope:**
      *
-     * `jobs.templates:read`
+     * `oversite.sites.form_assignment_tasks:read`
      *
      */
-    static listTemplates(options) {
-        return (options?.client ?? client).get({
+    static listSiteFormAssignmentTasks(options) {
+        return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/templates',
+            url: '/api/v1/oversite/sites/{site_id}/form_assignment_tasks',
             ...options
         });
     }
-}
-export class OpenApi {
     /**
-     * Show OpenAPI spec
+     * Create form assignment task for site
      *
-     * **No scope required:**
+     * Creates a form-completion task on the named site. `site_id`
+     * is the path only. `form_definition_id` and
+     * `task_attributes.created_by_user_id` are required. An empty
+     * `task_assignee_user_ids` list is valid.
      *
-     * Every authenticated API key may call this endpoint. It returns the machine-readable OpenAPI
-     * document that describes this API.
      *
-     * **Stability:**
+     * **Required scope:**
      *
-     * The document is static between contract changes: it changes only when the API surface
-     * does — an endpoint, field, or schema added or altered — on no fixed schedule. Fetch it
-     * when your integration starts, or when you regenerate a client, rather than on a poll.
+     * `oversite.sites.form_assignment_tasks:create`
      *
      */
-    static getOpenapiDocument(options) {
-        return (options?.client ?? client).get({
+    static createSiteFormAssignmentTask(options) {
+        return (options.client ?? client).post({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/openapi',
-            ...options
+            url: '/api/v1/oversite/sites/{site_id}/form_assignment_tasks',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
         });
     }
-}
-export class OversiteSiteCheckIns {
     /**
-     * List Site Check-ins
+     * Show form assignment task on site
      *
-     * Returns only the check-ins visible to the API key's company: those made by its
-     * currently-employed members, plus all of the site's check-ins when the company
-     * holds a claim on it with check-in features enabled. Other check-ins are
-     * omitted, so a visible site can return an empty list.
+     * Returns one form-completion task on the named site. `{id}` is
+     * the `Tasks::SiteFormAssignmentTask` id. A missing, misnested,
+     * or other-company id on this shared site reads as not found.
      *
      *
      * **Required scope:**
      *
-     * `oversite.sites.check_ins:read`
+     * `oversite.sites.form_assignment_tasks:read`
      *
      */
-    static listSiteCheckIns(options) {
+    static getSiteFormAssignmentTask(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/oversite/sites/{site_id}/check_ins',
+            url: '/api/v1/oversite/sites/{site_id}/form_assignment_tasks/{id}',
             ...options
         });
     }
     /**
-     * Show Site Check-in
+     * Update form assignment task on site
      *
-     * A check-in is visible to the API key's company when its author is a
-     * currently-employed member, or when the company holds a claim on the site
-     * with check-in features enabled; requesting one outside that visibility
-     * returns `404`.
+     * Updates the existing task in place. `site_id` is the path
+     * only. Replacing `task_assignee_user_ids` does not insert join
+     * rows before authorize.
      *
      *
      * **Required scope:**
      *
-     * `oversite.sites.check_ins:read`
+     * `oversite.sites.form_assignment_tasks:update`
      *
      */
-    static getSiteCheckIn(options) {
-        return (options.client ?? client).get({
+    static updateSiteFormAssignmentTask(options) {
+        return (options.client ?? client).patch({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/oversite/sites/{site_id}/check_ins/{id}',
-            ...options
+            url: '/api/v1/oversite/sites/{site_id}/form_assignment_tasks/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
         });
     }
 }
@@ -4752,6 +5277,11 @@ export class PayrollRuns {
     /**
      * Create payroll run
      *
+     * Company-scoped keys and user-scoped keys belonging to company
+     * admins can create payroll runs with the same fields. Manager
+     * and technician user keys cannot create runs.
+     *
+     *
      * **Required scope:**
      *
      * `payrolls.payroll_runs:create`
@@ -4801,6 +5331,12 @@ export class PayrollRuns {
     /**
      * Update payroll run
      *
+     * Company-scoped keys and user-scoped keys belonging to company
+     * admins can update the same payroll run fields. Manager and
+     * technician user keys cannot update runs. The owning company is
+     * fixed at creation; company_id is rejected on update.
+     *
+     *
      * **Required scope:**
      *
      * `payrolls.payroll_runs:update`
@@ -5077,9 +5613,10 @@ export class People {
      *
      * Every valid-time version of one employment stint, newest first. Each
      * entry uses `people_employment_id` rather than an entry-level id and
-     * includes prior recorded corrections. Company managers may read
-     * coworker history, but direct monetary fields are limited to their
-     * own employment in versions and corrections.
+     * includes prior corrections recorded at the credential company.
+     * Company managers may read coworker history, but direct monetary
+     * fields are limited to their own employment in versions and
+     * corrections.
      *
      *
      * **Required scope:**
@@ -5633,6 +6170,119 @@ export class ProductionCompletions {
         });
     }
 }
+export class ProjectSites {
+    /**
+     * List project sites
+     *
+     * Returns the project's site assignments (`ProjectSite` joins). Path `{id}`
+     * on the member routes is the join id, not the Site id. A participating-company
+     * key may list joins on a project it can see; a user-scoped key of a
+     * participating company cannot, because web project visibility does not include
+     * participating projects.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.sites:read`
+     *
+     */
+    static listProjectSites(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/sites',
+            ...options
+        });
+    }
+    /**
+     * Create a project site
+     *
+     * Attaches a site to the project. `site_id` is required; `feature_ids` is
+     * optional and scopes which of that site's features apply. The project is
+     * taken from the path. Writes are owner-only: a participating-company key
+     * that can GET the project receives 403. Duplicate `(project, site)` pairs
+     * are 422. A site that is not public and not owned by the project's owner
+     * is 422 when visible, or 404 when the key cannot see the site.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.sites:create`
+     *
+     */
+    static createProjectSite(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/sites',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a project site
+     *
+     * Removes the project–site join. The Site itself is not destroyed. Writes
+     * are owner-only.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.sites:delete`
+     *
+     */
+    static deleteProjectSite(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/sites/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show a project site
+     *
+     * Returns one project–site join. A missing, mismatched, or out-of-scope id
+     * reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.sites:read`
+     *
+     */
+    static getProjectSite(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/sites/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update a project site
+     *
+     * Replaces `feature_ids` on the join. Send an empty array to clear features.
+     * `site_id` is create-only; naming it on PATCH is a 400. Writes are
+     * owner-only.
+     *
+     *
+     * **Required scope:**
+     *
+     * `projects.sites:update`
+     *
+     */
+    static updateProjectSite(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/projects/{project_id}/sites/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class Projects {
     /**
      * List projects
@@ -5722,9 +6372,11 @@ export class Projects {
      * 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
-     * or detaches the project, and `participating_company_ids` replaces the complete
-     * set of participating companies. Remove a participant's jobs before removing
-     * it from this set. Only the owning company may update the project.
+     * 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
+     * jobs before removing it from this set. Only the owning company may update the
+     * project.
      *
      *
      * **Required scope:**
@@ -5960,6 +6612,14 @@ export class Users {
     /**
      * List 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.
+     *
+     *
      * **Required scope:**
      *
      * `users:read`
@@ -5994,6 +6654,13 @@ 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.
+     *
+     *
      * **Required scope:**
      *
      * `users:read`
@@ -6094,6 +6761,27 @@ export class PwaTradeApprenticeScope {
             ...options
         });
     }
+    /**
+     * Show apprentice scope decision
+     *
+     * Returns one reviewed (occupation, craft) pair on this trade. The payload is
+     * the same object create, update, and destroy already serialize. A missing,
+     * mismatched, or out-of-scope id is not found. Reading follows the trade;
+     * employer enrollment is not required.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.trades.apprenticeship_occupations:read`
+     *
+     */
+    static getApprenticeshipOccupation(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/trades/{trade_id}/apprenticeship_occupations/{id}',
+            ...options
+        });
+    }
     /**
      * Flip an apprentice scope decision
      *
@@ -6355,7 +7043,8 @@ export class PriorPeriodAdjustments {
      * Permanently remove an adjustment, for undoing one recorded in error. The removed
      * adjustment is returned. Its allocation is freed back to the funding line item and
      * the time card's actuals rebuild, so the job's balance due rises by this amount.
-     * Adjustments cannot be edited — delete and re-create to change one.
+     * To change amount, job, rationale, notes, or PWA eligibility, PATCH the same
+     * resource instead.
      *
      *
      * **Required scope:**
@@ -6385,6 +7074,31 @@ export class PriorPeriodAdjustments {
             ...options
         });
     }
+    /**
+     * Update Prior Period Adjustment
+     *
+     * Change amount, job, rationale, notes, or PWA eligibility on an existing
+     * adjustment. The updated adjustment is returned and the time card's actuals
+     * rebuild. The funding line item, recording user, time card, and adjustment
+     * type cannot be changed on this path.
+     *
+     *
+     * **Required scope:**
+     *
+     * `time_cards.prior_period_adjustments:update`
+     *
+     */
+    static updatePriorPeriodAdjustment(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/time_cards/{time_card_id}/prior_period_adjustments/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class TimeCardPwaCompliance {
     /**
@@ -6485,7 +7199,8 @@ export class TimeEntries {
      * Create time entry
      *
      * Create a time entry. Required: timekeeping_time_card_id, start_time, and end_time;
-     * user_id is derived server-side from the time card. Both start_time and
+     * user_id is derived server-side from the time card, and a time card outside
+     * the key's scope is not found (404). Both start_time and
      * end_time must fall on a whole-minute boundary (nonzero seconds are
      * rejected); start_time must fall within the time card's pay period, and
      * end_time must be after start_time. Optional job_id (the worker must have a
@@ -6493,10 +7208,8 @@ export class TimeEntries {
      * company's default timecodes), state, description, hourly_rate_cents (derived
      * from the position/user default when omitted), and feature_ids. Supplying
      * feature_ids — or setting feature_allocation_acknowledged true — satisfies a
-     * job that requires a feature allocation. A user-scoped key may send
-     * hourly_rate_cents only when its user is an admin in the entry's company;
-     * any other user-scoped key that sends it, null included, is forbidden (403)
-     * and nothing is created.
+     * job that requires a feature allocation. hourly_rate_cents is admin only on
+     * user-scoped keys.
      *
      *
      * **Required scope:**
@@ -6565,16 +7278,15 @@ export class TimeEntries {
      *
      * Update an existing time entry by id; every field in the parameters is
      * optional and only supplied fields change. An entry outside the key's scope
-     * is not found (404). Authorization is re-checked after attributes are
-     * assigned, so moving the entry to a time card in another company is
-     * forbidden (403). If the change would push categorized allocation
-     * minutes past the time card's overtime eligible minutes, the request returns
+     * is not found (404). An edit the key may not make to the entry as assigned,
+     * such as a technician putting it on a job that requires clock-in, is
+     * forbidden (403).
+     * If the change would push categorized allocation minutes past the time card's
+     * overtime eligible minutes, the request returns
      * 422 unless confirm_allocation_conflict is sent true. The feature-allocation cap is
      * enforced, and because a persisted feature_ids= writes its join rows
      * immediately, a rejected save rolls them back within the enclosing
-     * transaction. A user-scoped key may send hourly_rate_cents only when its user
-     * is an admin in the entry's company; any other user-scoped key that sends
-     * it, null included, is forbidden (403) and the entry is left unchanged.
+     * transaction. hourly_rate_cents is admin only on user-scoped keys.
      *
      *
      * **Required scope:**
@@ -7037,6 +7749,27 @@ export class PaySchedules {
             ...options
         });
     }
+    /**
+     * Create pay schedule
+     *
+     * Creates the company’s only pay schedule. The effective date starts its valid-time window at midnight in the supplied timezone. Existing schedules, including future or ended schedules, return 409. Time and payroll modes inherit company defaults; pay periods are generated asynchronously.
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.pay_period_configs:create`
+     *
+     */
+    static createPayPeriodConfig(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/pay_period_configs',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * Show pay schedule
      *