@dsptch-work/api-client 0.22.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,56 @@ 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
      *
@@ -4940,6 +5009,32 @@ export class People {
             }
         });
     }
+    /**
+     * 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
      *
@@ -4960,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 {
     /**

package/dist/gen/types.gen.d.ts

@@ -795,11 +795,48 @@ export type ApprenticeshipAllocationResponseObject = {
     updated_at: string;
 };
 /**
- * Correct the effective timestamp of an existing standalone allocation. Time-card-linked allocations cannot be date-corrected. A changed timestamp rebuilds progression and requests historical wage repricing in the background, including locked time cards.
+ * Record hours toward an apprentice's wage progression. Creation requires a user-scoped API key, since the row attributes the hours to the person who recorded them. Omit timekeeping_time_card_id for a standalone allocation entered outside the time card system, or supply it to link the allocation to one of the apprentice's own time cards; the effective timestamp then derives from the card's pay period and cannot be overridden. Recording the allocation rebuilds progression and requests wage repricing in the background.
+ */
+export type ApprenticeshipAllocationCreateParameters = {
+    /**
+     * Work process category to categorize the allocation under; optional, omit for an uncategorized allocation.
+     */
+    apprenticeship_work_process_category_id?: string;
+    /**
+     * Time card to link the allocation to, scoped to the apprentice's own cards; optional, omit for a standalone allocation. Cannot be changed after creation.
+     */
+    timekeeping_time_card_id?: string;
+    /**
+     * Minutes of credited hours. Required, must be positive, and (when linked to a time card) cannot push the card's categorized total past its overtime-eligible minutes.
+     */
+    minutes: number;
+    /**
+     * Free-text note on the allocation; optional.
+     */
+    description?: string;
+    /**
+     * Effective timestamp for the credited hours, as ISO 8601 with an explicit UTC offset or Z. Optional for a standalone allocation, defaulting to now; must equal the linked time card's pay-period start when one is supplied. The employer-local date must be today or earlier.
+     */
+    allocated_at?: string;
+};
+/**
+ * Correct an existing allocation's hours, work process category, description, or (for a standalone allocation) effective timestamp. The time card an allocation is linked to cannot be changed after creation. Any change that shifts progression rebuilds it and requests historical wage repricing in the background, including locked time cards.
  */
 export type ApprenticeshipAllocationUpdateParameters = {
     /**
-     * Effective timestamp for the credited hours, as ISO 8601 with an explicit UTC offset or Z. Optional; omission leaves the timestamp unchanged, and null is rejected. The employer-local date must be today or earlier and may predate enrollment. An unchanged timestamp does not request repricing.
+     * Work process category to recategorize the allocation under; optional, null to make it uncategorized.
+     */
+    apprenticeship_work_process_category_id?: string | null;
+    /**
+     * Minutes of credited hours; optional, must be positive, and (for a time-card-linked allocation) cannot push the card's categorized total past its overtime-eligible minutes.
+     */
+    minutes?: number;
+    /**
+     * Free-text note on the allocation; optional, null to clear.
+     */
+    description?: string | null;
+    /**
+     * Effective timestamp for the credited hours, as ISO 8601 with an explicit UTC offset or Z. Optional; omission leaves the timestamp unchanged, and null is rejected. The employer-local date must be today or earlier and may predate enrollment. Time-card-linked allocations cannot be date-corrected. An unchanged timestamp does not request repricing.
      */
     allocated_at?: string;
 };
@@ -1555,6 +1592,10 @@ export type PeopleEmploymentScheduledChangeCreateParameters = {
      * Annual employer savings contribution in cents as a decimal string. Omit to carry forward the preceding version, or send null to clear it.
      */
     employer_combined_savings_cents?: string | null;
+    /**
+     * Department ID in the credential company. Omit to carry forward the preceding version, or send null to clear it. A submitted value applies to this and all later versions.
+     */
+    companies_department_id?: string | null;
     /**
      * Company-local date when the new boundary takes effect. Must be strictly in the future. Required.
      */
@@ -1608,6 +1649,10 @@ export type PeopleEmploymentScheduledChangeUpdateParameters = {
      * Annual employer savings contribution in cents as a decimal string. Omit to preserve the value at the targeted boundary, or send null to clear it.
      */
     employer_combined_savings_cents?: string | null;
+    /**
+     * Department ID in the credential company. Omit to preserve the value at the targeted boundary, or send null to clear it. A submitted value applies to this and all later versions.
+     */
+    companies_department_id?: string | null;
 };
 /**
  * Parameters for moving where an employment stint's valid-time timeline begins.
@@ -1627,6 +1672,53 @@ export type PeopleEmploymentScheduledTerminationParameters = {
      */
     effective_date: string;
 };
+/**
+ * Request body for correcting an employment stint's operational details from its first recorded boundary forward. Send only the fields to change. A submitted value that already applies at the first boundary is a no-op, even when a later version differs.
+ */
+export type PeopleEmploymentUpdateParameters = {
+    /**
+     * Whether the relationship is EMPLOYEE or CONTRACTOR. Omit to preserve the value recorded at the first boundary.
+     */
+    type?: 'EMPLOYEE' | 'CONTRACTOR';
+    /**
+     * Employment title. Send null to clear it; omit to preserve the value recorded at the first boundary.
+     */
+    title?: string | null;
+    /**
+     * Manager ID. Send null to clear it; omit to preserve the value recorded at the first boundary.
+     */
+    manager_user_id?: string | null;
+    /**
+     * Payroll-system identifier. Send null to clear it; omit to preserve the value recorded at the first boundary.
+     */
+    payroll_id?: string | null;
+    /**
+     * Whether this employment is enrolled in time and attendance. Omit to preserve the value recorded at the first boundary.
+     */
+    enrolled_in_t_and_a?: boolean;
+};
+export type PeopleEmploymentCustomFieldResponseObject = {
+    custom_field_config_id: string;
+    value: string | null;
+};
+/**
+ * Update stored custom-field values for one employment family in a single batch. The batch must contain at least one row. Omitted configurations keep their values, and an explicit null is stored.
+ */
+export type PeopleEmploymentCustomFieldsUpdateParameters = {
+    /**
+     * Required, nonempty list of configurations and their replacement values. Each configuration may appear only once.
+     */
+    custom_fields: Array<{
+        /**
+         * ID of a custom-field configuration owned by the credential company and applicable to employments. A hidden configuration may be updated only when the family already stores its value.
+         */
+        custom_field_config_id: string;
+        /**
+         * Replacement value as text or null. Null stores a value rather than removing the row.
+         */
+        value: string | null;
+    }>;
+};
 export type PeopleEmploymentHistoryCorrectionObject = {
     /**
      * Family key shared by every entry on this timeline — the same identity the member route addresses. An entry carries no identifier of its own; versions are distinguished by their window coordinates.
@@ -3534,7 +3626,7 @@ export type JobResponseObject = {
      */
     require_clock_in: boolean;
     /**
-     * Clock-in enforcement level: one of none (no guidance), warning (compliance warning on manual entries), or required (hard stop for technician web CUD and GraphQL owner CUD, including client-claimed punches, until a server-verified punch path exists; company-authed API v1 is intentionally ungated).
+     * Clock-in enforcement level stored on the job: one of none (no guidance), warning (manual time entries fail the clock-in compliance check), or required (a technician's own time on the job must come from clocking in on DSPTCH Mobile; the technician's own web and user-API-key time-entry writes are refused). A time entry whose time code, as of the entry's start time, is PTO, holiday, or restricted to non-job time entries is exempt at every level. Time-entry writes made with a company API key are not gated. A company-wide clock-in requirement on the time entry's company can make that entry's requirement stricter than this value.
      */
     clock_in_requirement: 'none' | 'warning' | 'required';
     /**
@@ -3808,7 +3900,7 @@ export type JobParameters = {
     tz_name?: string;
     time_card_start_day?: TimeCardStartDay;
     /**
-     * Clock-in enforcement level: one of none (no guidance), warning (compliance warning on manual entries), or required (hard stop for technician web CUD and GraphQL owner CUD, including client-claimed punches, until a server-verified punch path exists; company-authed API v1 is intentionally ungated). Omit the field to leave the current value unchanged.
+     * Clock-in enforcement level: one of none (no guidance), warning (manual time entries fail the clock-in compliance check), or required (a technician's own time on the job must come from clocking in on DSPTCH Mobile; the technician's own web and user-API-key time-entry writes are refused). A time entry whose time code, as of the entry's start time, is PTO, holiday, or restricted to non-job time entries is exempt at every level. Time-entry writes made with a company API key are not gated. While the creating company requires clock-in company-wide, a create stores `required` whatever value is sent, and lowering an open job returns 422 with the error at `#/clock_in_requirement`. Omit the field to leave the current value unchanged.
      */
     clock_in_requirement?: 'none' | 'warning' | 'required';
     /**
@@ -5634,7 +5726,7 @@ export type AggregateTimeImportResponseObject = {
     /**
      * Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
      */
-    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed';
+    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded';
     /**
      * How many rows passed validation and were prepared for writing. On a `success` import that is also how many rows were written. On a `failed` one it is not — the import writes all of its rows in a single transaction, so a failure part-way through undoes every write already made while this count still reports every row that had been prepared.
      */
@@ -5684,7 +5776,7 @@ export type DsptchCprImportResponseObject = {
     /**
      * Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
      */
-    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed';
+    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded';
     /**
      * How many rows passed validation and were prepared for writing. On a `success` import that is also how many rows were written. On a `failed` one it is not — the import writes all of its rows in a single transaction, so a failure part-way through undoes every write already made while this count still reports every row that had been prepared.
      */
@@ -5734,7 +5826,7 @@ export type PaystubImportResponseObject = {
     /**
      * Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
      */
-    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed';
+    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded';
     /**
      * How many rows passed validation and were prepared for writing. On a `success` import that is also how many rows were written. On a `failed` one it is not — the import writes all of its rows in a single transaction, so a failure part-way through undoes every write already made while this count still reports every row that had been prepared.
      */
@@ -5784,7 +5876,7 @@ export type TimeEntryImportResponseObject = {
     /**
      * Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
      */
-    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed';
+    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed' | 'superseded';
     /**
      * How many rows passed validation and were prepared for writing. On a `success` import that is also how many rows were written. On a `failed` one it is not — the import writes all of its rows in a single transaction, so a failure part-way through undoes every write already made while this count still reports every row that had been prepared.
      */
@@ -12517,6 +12609,40 @@ export type ListAllocationsResponses = {
     };
 };
 export type ListAllocationsResponse = ListAllocationsResponses[keyof ListAllocationsResponses];
+export type CreateAllocationData = {
+    body: ApprenticeshipAllocationCreateParameters;
+    path: {
+        apprentice_id: string;
+    };
+    query?: never;
+    url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations';
+};
+export type CreateAllocationErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreateAllocationError = CreateAllocationErrors[keyof CreateAllocationErrors];
+export type CreateAllocationResponses = {
+    /**
+     * Created
+     */
+    201: ApprenticeshipAllocationResponseObject;
+};
+export type CreateAllocationResponse = CreateAllocationResponses[keyof CreateAllocationResponses];
 export type GetAllocationData = {
     body?: never;
     path: {
@@ -19804,6 +19930,7 @@ export type ListAggregateTimeImportsData = {
          * * `processed`
          * * `success`
          * * `failed`
+         * * `superseded`
          *
          */
         'filter[status]'?: string;
@@ -19932,6 +20059,7 @@ export type ListDsptchCprImportsData = {
          * * `processed`
          * * `success`
          * * `failed`
+         * * `superseded`
          *
          */
         'filter[status]'?: string;
@@ -20060,6 +20188,7 @@ export type ListTimeEntryImportsData = {
          * * `processed`
          * * `success`
          * * `failed`
+         * * `superseded`
          *
          */
         'filter[status]'?: string;
@@ -20582,6 +20711,7 @@ export type ListPaystubImportsData = {
          * * `processed`
          * * `success`
          * * `failed`
+         * * `superseded`
          *
          */
         'filter[status]'?: string;
@@ -21198,6 +21328,84 @@ export type UpdatePaystubResponses = {
     200: PaystubResponseObject;
 };
 export type UpdatePaystubResponse = UpdatePaystubResponses[keyof UpdatePaystubResponses];
+export type ListCustomFieldsData = {
+    body?: never;
+    path: {
+        employment_id: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{employment_id}/custom_fields';
+};
+export type ListCustomFieldsErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type ListCustomFieldsError = ListCustomFieldsErrors[keyof ListCustomFieldsErrors];
+export type ListCustomFieldsResponses = {
+    /**
+     * Success
+     */
+    200: {
+        data: Array<PeopleEmploymentCustomFieldResponseObject>;
+    };
+};
+export type ListCustomFieldsResponse = ListCustomFieldsResponses[keyof ListCustomFieldsResponses];
+export type UpdateCustomFieldData = {
+    body: PeopleEmploymentCustomFieldsUpdateParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against.
+         */
+        'If-Match': string;
+    };
+    path: {
+        employment_id: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{employment_id}/custom_fields';
+};
+export type UpdateCustomFieldErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type UpdateCustomFieldError = UpdateCustomFieldErrors[keyof UpdateCustomFieldErrors];
+export type UpdateCustomFieldResponses = {
+    /**
+     * Success
+     */
+    200: {
+        data: Array<PeopleEmploymentCustomFieldResponseObject>;
+    };
+};
+export type UpdateCustomFieldResponse = UpdateCustomFieldResponses[keyof UpdateCustomFieldResponses];
 export type UpdateGenesisData = {
     body: PeopleEmploymentGenesisParameters;
     headers: {
@@ -21691,6 +21899,53 @@ export type CreateEmploymentResponses = {
     201: PeopleEmploymentResponseObject;
 };
 export type CreateEmploymentResponse = CreateEmploymentResponses[keyof CreateEmploymentResponses];
+export type DeleteEmploymentData = {
+    body?: never;
+    headers: {
+        /**
+         * Version validator for the whole employment family, or `*` to remove its current state.
+         */
+        'If-Match': string;
+    };
+    path: {
+        /**
+         * The employment stint identity returned as `id`.
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{id}';
+};
+export type DeleteEmploymentErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type DeleteEmploymentError = DeleteEmploymentErrors[keyof DeleteEmploymentErrors];
+export type DeleteEmploymentResponses = {
+    /**
+     * Success
+     */
+    200: PeopleEmploymentResponseObject;
+};
+export type DeleteEmploymentResponse = DeleteEmploymentResponses[keyof DeleteEmploymentResponses];
 export type GetEmploymentData = {
     body?: never;
     path: {
@@ -21725,6 +21980,57 @@ export type GetEmploymentResponses = {
     200: PeopleEmploymentResponseObject;
 };
 export type GetEmploymentResponse = GetEmploymentResponses[keyof GetEmploymentResponses];
+export type UpdateEmploymentData = {
+    body: PeopleEmploymentUpdateParameters;
+    headers: {
+        /**
+         * Version validator for the whole employment family, or `*` for its current state.
+         */
+        'If-Match': string;
+    };
+    path: {
+        /**
+         * The employment stint identity returned as `id`.
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{id}';
+};
+export type UpdateEmploymentErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type UpdateEmploymentError = UpdateEmploymentErrors[keyof UpdateEmploymentErrors];
+export type UpdateEmploymentResponses = {
+    /**
+     * Success
+     */
+    200: PeopleEmploymentResponseObject;
+};
+export type UpdateEmploymentResponse = UpdateEmploymentResponses[keyof UpdateEmploymentResponses];
 export type ListPerDiemsData = {
     body?: never;
     path?: never;