@dsptch-work/api-client 0.21.0 → 0.23.0

package/dist/gen/sdk.gen.js

@@ -34,6 +34,25 @@ export class ApprenticeshipAllocations {
             ...options
         });
     }
+    /**
+     * Create apprenticeship allocation
+     *
+     * **Required scope:**
+     *
+     * `apprenticeship.apprentices.allocations:create`
+     *
+     */
+    static createAllocation(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * Show apprenticeship allocation
      *
@@ -50,7 +69,7 @@ export class ApprenticeshipAllocations {
         });
     }
     /**
-     * Update apprenticeship allocation effective date
+     * Update apprenticeship allocation
      *
      * **Required scope:**
      *
@@ -4700,6 +4719,89 @@ export class Paystubs {
     }
 }
 export class People {
+    /**
+     * List employment custom fields
+     *
+     * Stored custom-field values on one employment family, independent
+     * of its valid-time versions. A null is a stored value. Hidden
+     * configurations with stored values remain readable, as in the
+     * employment details UI. Join `custom_field_config_id` to
+     * `GET /api/v1/custom_field_configs` for names and definitions;
+     * that endpoint requires its own scope and includes hidden configs.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments.custom_fields:read`
+     *
+     */
+    static listCustomFields(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{employment_id}/custom_fields',
+            ...options
+        });
+    }
+    /**
+     * Update employment custom fields
+     *
+     * Update several stored values on one employment family in one
+     * transaction. Each row names a company-owned employment config by
+     * ID; omitted configs remain unchanged and an explicit null stores
+     * a null value. A hidden config may update a value already attached
+     * to the family, but cannot attach a new one. Values must be strings
+     * or null. Send the family's current ETag as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments.custom_fields:update`
+     *
+     */
+    static updateCustomField(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{employment_id}/custom_fields',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Correct employment hire-date boundary
+     *
+     * Correct where one employment stint's valid-time timeline begins.
+     * Moving the date earlier extends the first version; moving it later
+     * removes older versions or coverage before the new date. This is a
+     * valid-time correction and does not preserve removed versions as
+     * bitemporal history.
+     *
+     * Employments with no recorded hire-date boundary cannot use this
+     * endpoint because employment reconciliation requires a finite start.
+     * Read the employment again after a successful correction; the response
+     * carries the family's new `ETag`.
+     *
+     * Conditional: send the employment's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments.genesis:update`
+     *
+     */
+    static updateGenesis(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{employment_id}/genesis',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List employment history
      *
@@ -4743,6 +4845,123 @@ export class People {
             ...options
         });
     }
+    /**
+     * 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.
+     *
+     * Conditional: send the employment's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments.scheduled_changes:create`
+     *
+     */
+    static createEmploymentScheduledChange(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{employment_id}/scheduled_changes',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Cancel one employment change at an exact boundary
+     *
+     * Cancel only the exact strictly future boundary named by the path. Its preceding
+     * version expands across the removed interval; any later boundary remains in place.
+     *
+     * Conditional: send the employment's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments.scheduled_changes:delete`
+     *
+     */
+    static deleteEmploymentScheduledChange(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}',
+            ...options
+        });
+    }
+    /**
+     * 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.
+     *
+     * Conditional: send the employment's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments.scheduled_changes:update`
+     *
+     */
+    static updateEmploymentScheduledChange(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Cancel a scheduled employment termination
+     *
+     * **Required scope:**
+     *
+     * `people.employments.scheduled_terminations:delete`
+     *
+     */
+    static deleteScheduledTermination(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{employment_id}/scheduled_termination',
+            ...options
+        });
+    }
+    /**
+     * Schedule an employment termination
+     *
+     * Close this employment stint's timeline at `effective_date`. The employment remains
+     * readable in history strictly before that date, but stops applying at company-local
+     * midnight starting that date. This does not delete the employment family; family
+     * deletion is a separate operation.
+     *
+     * A family with a termination already standing returns `409`. To move its end, cancel it
+     * with `DELETE` and then make a new `POST` with the replacement date.
+     * A termination at or before the employment's genesis is refused with `422`.
+     * Conditional: send the employment's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments.scheduled_terminations:create`
+     *
+     */
+    static createEmploymentScheduledTermination(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{employment_id}/scheduled_termination',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List employments
      *
@@ -4764,6 +4983,58 @@ export class People {
             ...options
         });
     }
+    /**
+     * Create employment
+     *
+     * Create a new employment stint for an existing user in the
+     * credential company. `hire_date` is interpreted at midnight in
+     * the company time zone. A rehire creates a distinct stint; an
+     * overlapping stint is rejected. This operation creates no user,
+     * invitation, role, group, or login identity.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments:create`
+     *
+     */
+    static createEmployment(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Remove employment family
+     *
+     * Permanently remove every valid-time version in this employment
+     * stint. This deletes the stint's family-owned records, such as its
+     * custom fields, while preserving the person, company-level PWA
+     * details, and different employment stints.
+     *
+     * This is distinct from scheduling a termination. Conditional: send
+     * the employment's `ETag` as `If-Match`. Employment families without
+     * a start boundary are refused because the derived-data reconciliation
+     * needs that earliest affected instant.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments:delete`
+     *
+     */
+    static deleteEmployment(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{id}',
+            ...options
+        });
+    }
     /**
      * Get employment
      *
@@ -4784,6 +5055,35 @@ export class People {
             ...options
         });
     }
+    /**
+     * Update employment details
+     *
+     * Update one employment stint's direct details from its first
+     * recorded boundary forward. Values that differ there propagate
+     * through every later version in the family. Values already true at
+     * that boundary are a no-op, even when a later version differs.
+     * Schedule compensation and PWA changes through their dedicated
+     * temporal endpoints.
+     *
+     * Conditional: send the employment's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `people.employments:update`
+     *
+     */
+    static updateEmployment(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/people/employments/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class PerDiems {
     /**