@dsptch-work/api-client 0.18.0 → 0.19.0

package/dist/gen/sdk.gen.js

@@ -18,6 +18,57 @@ export class ApiKeyScopes {
         });
     }
 }
+export class ApprenticeshipAllocations {
+    /**
+     * List apprenticeship allocations
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.apprentices.allocations:read`
+     *
+     */
+    static listAllocations(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations',
+            ...options
+        });
+    }
+    /**
+     * Show apprenticeship allocation
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.apprentices.allocations:read`
+     *
+     */
+    static getAllocation(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update apprenticeship allocation effective date
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.apprentices.allocations:update`
+     *
+     */
+    static updateAllocation(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class ApprenticeshipApprentices {
     /**
      * List apprenticeship apprentices
@@ -4310,6 +4361,82 @@ export class Paystubs {
         });
     }
 }
+export class People {
+    /**
+     * List employment history
+     *
+     * 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.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments.history:read`
+     *
+     */
+    static listEmploymentHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{employment_id}/history',
+            ...options
+        });
+    }
+    /**
+     * List employment histories
+     *
+     * Employment history across all authorized stints in the credential
+     * company, including ended stints and rehired employments.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments.history:read`
+     *
+     */
+    static listEmploymentsHistory(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/history',
+            ...options
+        });
+    }
+    /**
+     * List employments
+     *
+     * Current employments in the credential company, or versions at
+     * `as_of[valid]`. A user key sees its own records unless it is a
+     * company administrator.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments:read`
+     *
+     */
+    static listEmployments(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments',
+            ...options
+        });
+    }
+    /**
+     * Get employment
+     *
+     * **Required scope:**
+     *
+     * `people.employments:read`
+     *
+     */
+    static getEmployment(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{id}',
+            ...options
+        });
+    }
+}
 export class PerDiems {
     /**
      * List per diems
@@ -4615,10 +4742,11 @@ export class Projects {
      * Create a project owned by the API key's company (owned_by_company_id is set
      * automatically from the key). Requires `name`, and `created_by_user_id` must
      * reference a member of the owning company. `budget_currency` defaults to USD;
-     * when `federal_pwa_mode` is `none`, `asset_owner` is forced to false and the
-     * federal-PWA-only fields (administrator name/email/phone, budget, and the
+     * the federal-PWA-only fields (administrator name/email/phone, budget, and the
      * prevailing-wage lock-in / beginning-of-construction / placed-in-service dates)
-     * are dropped. Returns 201 with the created project; a duplicate name within the
+     * 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. Returns 201 with the created project; a duplicate name within the
      * company, a creator outside the owning company, end_date before start_date, an
      * unknown PWA mode, an unparseable date, or a regional mode without a region each
      * return 422.
@@ -4664,9 +4792,11 @@ export class Projects {
      *
      * Update a project's attributes. `name` cannot be blanked, and
      * `created_by_user_id` is immutable — any request that sets, changes, or clears it
-     * returns 422. Switching `federal_pwa_mode` to `none` forces `asset_owner` false
-     * and drops the federal-PWA-only params (previously persisted values are left
-     * untouched); `budget_currency` defaults to USD when blank. A project owned by
+     * returns 422. The federal-PWA-only fields (administrator contact, budget, IRA
+     * dates) and `asset_owner` apply only while `federal_pwa_mode` is not `none`:
+     * switching it to `none` clears the stored values and forces `asset_owner`
+     * false, and sending one of them while federal tracking is off — even as null —
+     * returns 422. `budget_currency` defaults to USD when blank. A project owned by
      * another company, or an unknown id, returns 404.
      *
      *