@dsptch-work/api-client 0.23.0 → 0.25.0

package/dist/gen/sdk.gen.js

@@ -53,6 +53,27 @@ export class ApprenticeshipAllocations {
             }
         });
     }
+    /**
+     * Delete apprenticeship allocation
+     *
+     * Deletes an allocation nested under the apprentice in the path. Success is
+     * `204` and a later GET of the same id is not found. A missing, out-of-scope,
+     * or mismatched apprentice/allocation pair is `404`. Company-scoped keys may
+     * delete; unlike create, this operation does not require a user-scoped key.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.apprentices.allocations:delete`
+     *
+     */
+    static deleteAllocation(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations/{id}',
+            ...options
+        });
+    }
     /**
      * Show apprenticeship allocation
      *
@@ -159,6 +180,47 @@ export class ApprenticeshipOccupations {
             }
         });
     }
+    /**
+     * Delete apprenticeship occupation
+     *
+     * Deletes an unused occupation. An occupation that still has work-process
+     * categories, wage schedules, or trade apprenticeship links is refused
+     * with a `422` — remove those dependents first. An unused occupation
+     * returns `204` and is gone from a later GET.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.programs.occupations:delete`
+     *
+     */
+    static deleteOccupation(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/programs/{program_id}/occupations/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show apprenticeship occupation
+     *
+     * Returns one occupation in a program the key's company sponsors or is
+     * enrolled in as an employer. A missing, mismatched, or out-of-scope id
+     * reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.programs.occupations:read`
+     *
+     */
+    static getOccupation(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/programs/{program_id}/occupations/{id}',
+            ...options
+        });
+    }
     /**
      * Update apprenticeship occupation
      *
@@ -284,6 +346,45 @@ export class ApprenticeshipPrograms {
             }
         });
     }
+    /**
+     * Delete apprenticeship program
+     *
+     * Deletes an unused program. A program that still has occupations is refused
+     * with a `422` — remove those occupations first. An unused program returns
+     * `204` and is gone from a later GET.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.programs:delete`
+     *
+     */
+    static deleteProgram(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/programs/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show apprenticeship program
+     *
+     * Returns one program the key's company sponsors or is enrolled in as an
+     * employer. A missing or out-of-scope id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.programs:read`
+     *
+     */
+    static getProgram(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/programs/{id}',
+            ...options
+        });
+    }
     /**
      * Update apprenticeship program
      *
@@ -394,6 +495,49 @@ export class ApprenticeshipWageSchedules {
             }
         });
     }
+    /**
+     * Delete apprenticeship wage schedule
+     *
+     * Deletes an unused wage schedule nested under the occupation in the path.
+     * A schedule that still has apprentices is refused with a `422`. An unused
+     * schedule returns `204`. Deletes are sponsor-only; an enrolled employer is
+     * `403`. A missing, out-of-scope, or mismatched occupation/schedule pair is
+     * `404`. Periods on the schedule are removed with it.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.occupations.wage_schedules:delete`
+     *
+     */
+    static deleteWageSchedule(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show apprenticeship wage schedule
+     *
+     * Returns one wage schedule nested under the occupation in the path. The
+     * object matches the list, create, and update door. A missing, out-of-scope,
+     * or mismatched occupation/schedule pair is not found. Nested periods are a
+     * separate resource.
+     *
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.occupations.wage_schedules:read`
+     *
+     */
+    static getWageSchedule(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules/{id}',
+            ...options
+        });
+    }
     /**
      * Update apprenticeship wage schedule
      *
@@ -2187,6 +2331,46 @@ export class CompaniesDepartments {
             }
         });
     }
+    /**
+     * Delete department
+     *
+     * 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.
+     *
+     *
+     * **Required scope:**
+     *
+     * `companies.departments:delete`
+     *
+     */
+    static deleteDepartment(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/companies/departments/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show department
+     *
+     * Returns one department owned by the key's company. A missing or out-of-scope
+     * id reads as not found.
+     *
+     *
+     * **Required scope:**
+     *
+     * `companies.departments:read`
+     *
+     */
+    static getDepartment(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/companies/departments/{id}',
+            ...options
+        });
+    }
     /**
      * Update department
      *
@@ -3358,6 +3542,47 @@ export class Jobs {
             }
         });
     }
+    /**
+     * 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
      *
@@ -4045,6 +4270,27 @@ export class PayRateRulePackages {
             }
         });
     }
+    /**
+     * Delete a pay rate rule package
+     *
+     * Permanently remove a pay rate rule package. An unused package (no rules,
+     * positions, job or project wage determinations, or employments) returns
+     * `204` and is gone from a later GET. A package still referenced is refused
+     * with `422` `destroy_restricted`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages:delete`
+     *
+     */
+    static deletePayRateRulePackage(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{id}',
+            ...options
+        });
+    }
     /**
      * Get a pay rate rule package
      *
@@ -4060,6 +4306,30 @@ export class PayRateRulePackages {
             ...options
         });
     }
+    /**
+     * Update a pay rate rule package
+     *
+     * Rename or re-describe a pay rate rule package. Only supplied fields change.
+     * `default`, `selectable`, and `scoped_to_job_id` are not writable — those
+     * remain the values set at create (or by the web door).
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages:update`
+     *
+     */
+    static updatePayRateRulePackage(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class AggregateTimeImports {
     /**
@@ -4848,9 +5118,10 @@ export class People {
     /**
      * Schedule an employment change
      *
-     * Create one strictly future employment-version boundary. `effective_date` is
-     * interpreted at midnight in the credential company's time zone. This operation
-     * cannot move or replace an existing boundary.
+     * Create one employment-version boundary. `effective_date` is interpreted at
+     * midnight in the credential company's time zone. Today and past dates must fall
+     * inside the family's latest version; future dates retain the existing scheduling
+     * behavior. This operation cannot move or replace an existing boundary.
      *
      * Conditional: send the employment's `ETag` as `If-Match`.
      *
@@ -4895,8 +5166,9 @@ export class People {
     /**
      * Edit an employment change at an exact boundary
      *
-     * Change values at the exact strictly future boundary named by the path. The
-     * boundary itself never moves; a date inside a version does not identify it.
+     * Change values at the exact boundary named by the path. A boundary at today
+     * or an earlier date must start the family's latest version. The boundary
+     * itself never moves; a date inside a version does not identify it.
      *
      * Conditional: send the employment's `ETag` as `If-Match`.
      *
@@ -5492,6 +5764,25 @@ export class Users {
             }
         });
     }
+    /**
+     * Delete PWA company user details
+     *
+     * Deletes the PWA company-user 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_user_details:delete`
+     *
+     */
+    static deleteCompanyUserDetail(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/company_user_details/{id}',
+            ...options
+        });
+    }
     /**
      * Update PWA company user details
      *
@@ -6202,7 +6493,10 @@ 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.
+     * 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.
      *
      *
      * **Required scope:**
@@ -6244,6 +6538,28 @@ export class TimeEntries {
             ...options
         });
     }
+    /**
+     * Show time entry
+     *
+     * Fetch one time entry by id. The response is the same object the list,
+     * create, and update doors serialize. An entry outside the key's read
+     * scope is not found (404), including a colleague's entry for a
+     * technician or field-lead key — even when that entry is writable via
+     * PATCH.
+     *
+     *
+     * **Required scope:**
+     *
+     * `time_entries:read`
+     *
+     */
+    static getTimeEntry(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/time_entries/{id}',
+            ...options
+        });
+    }
     /**
      * Update time entry
      *
@@ -6256,7 +6572,9 @@ export class TimeEntries {
      * 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.
+     * 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.
      *
      *
      * **Required scope:**