@dsptch-work/api-client 0.21.0 → 0.23.0

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

@@ -383,7 +383,7 @@ export type DirectUploadParameters = {
     /**
      * What the file is for, named as the endpoint that will attach it (for example `assets.vendors`). Required. It decides where the file is stored, and the signed ID this call returns is issued for that resource alone — it will not resolve at any other endpoint, so a vendor logo cannot be attached as an avatar, or an avatar as a logo.
      */
-    resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'compliance.checks' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'users';
+    resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'compliance.checks' | 'internal.company_todos' | 'internal.job_todos' | 'internal.project_todos' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'users';
     /**
      * Metadata describing the file being registered, before its bytes are uploaded.
      */
@@ -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;
 };
@@ -1430,6 +1467,258 @@ export type PeopleEmploymentResponseObject = {
      */
     updated_at: string;
 };
+/**
+ * Create a distinct employment stint for an existing user in the credential company. Only user_id and hire_date are required; omitted optional fields use the defaults or null values described below. This does not create a user, invitation, role, group, or login identity.
+ */
+export type PeopleEmploymentCreateParameters = {
+    /**
+     * ID of the existing user to employ. Required; the endpoint returns `404` when the user does not exist.
+     */
+    user_id: string;
+    /**
+     * First day of the stint, as a calendar date (`YYYY-MM-DD`). Required; interpreted at midnight in the credential company's time zone. A value carrying a time component is refused with `422` rather than truncated.
+     */
+    hire_date: string;
+    /**
+     * Whether the relationship is `EMPLOYEE` or `CONTRACTOR`. Omit to use `EMPLOYEE`; null is not accepted.
+     */
+    type?: 'EMPLOYEE' | 'CONTRACTOR';
+    /**
+     * Employment title. Omit or send null to leave it unset; blank text is stored as null.
+     */
+    title?: string | null;
+    /**
+     * ID of the user's manager. Omit or send null for no manager; a supplied ID must identify an existing user.
+     */
+    manager_user_id?: string | null;
+    /**
+     * Identifier for this worker in the company's payroll system. Omit or send null to leave it unset; blank text is stored as null.
+     */
+    payroll_id?: string | null;
+    /**
+     * Whether the employment participates in time and attendance. Omit to use true; null is not accepted.
+     */
+    enrolled_in_t_and_a?: boolean;
+    /**
+     * How the worker is paid: `hourly` or `salary`. Omit to use `hourly`; null is not accepted.
+     */
+    compensation_type?: 'hourly' | 'salary';
+    /**
+     * Base hourly pay in cents as a decimal string. Omit or send null to leave it unset.
+     */
+    hourly_rate_cents?: string | null;
+    /**
+     * Whether the employment is eligible for overtime. Omit to use true; send null to leave eligibility unset. Must be true when overtime_package_id is supplied.
+     */
+    overtime_eligible?: boolean | null;
+    /**
+     * ID of the overtime package assigned to this employment. Omit or send null for no package; a supplied ID must belong to the credential company and requires overtime_eligible to be true.
+     */
+    overtime_package_id?: string | null;
+    /**
+     * Annualized worked minutes. Omit or send null to leave it unset; otherwise must be between 0 and the number of minutes in one year.
+     */
+    worked_annual_minutes?: number | null;
+    /**
+     * Annual paid-time-off minutes. Omit or send null to leave it unset; otherwise must be between 0 and the number of minutes in one year.
+     */
+    pto_annual_minutes?: number | null;
+    /**
+     * Annual holiday minutes. Omit or send null to leave it unset; otherwise must be between 0 and the number of minutes in one year.
+     */
+    holiday_annual_minutes?: number | null;
+    /**
+     * Annual paid training minutes. Omit or send null to leave it unset; otherwise must be between 0 and the number of minutes in one year.
+     */
+    training_annual_minutes?: number | null;
+    /**
+     * Annual training amount in cents as a decimal string. Omit or send null to leave it unset.
+     */
+    training_annual_amount_cents?: string | null;
+    /**
+     * Annual employer health contribution in cents as a decimal string. Omit or send null to leave it unset.
+     */
+    employer_combined_health_amount_cents?: string | null;
+    /**
+     * Annual employer savings and retirement contribution in cents as a decimal string. Omit or send null to leave it unset.
+     */
+    employer_combined_savings_cents?: string | null;
+};
+/**
+ * Request body for creating one strictly future employment boundary. effective_date is required and is interpreted at midnight in the credential company's time zone. Send at least one value to change; omitted values carry forward from the version immediately before the new boundary.
+ */
+export type PeopleEmploymentScheduledChangeCreateParameters = {
+    /**
+     * How the employment is paid: hourly or salary. Omit to carry forward the preceding version.
+     */
+    compensation_type?: 'hourly' | 'salary';
+    /**
+     * Hourly pay in cents as a decimal string. Omit to carry forward the preceding version, or send null to clear it.
+     */
+    hourly_rate_cents?: string | null;
+    /**
+     * Whether the employment is overtime eligible. Omit to carry forward the preceding version, or send null to clear it.
+     */
+    overtime_eligible?: boolean | null;
+    /**
+     * Overtime package ID. Omit to carry forward the preceding version, or send null to clear it.
+     */
+    overtime_package_id?: string | null;
+    /**
+     * Annual worked minutes. Omit to carry forward the preceding version, or send null to clear it.
+     */
+    worked_annual_minutes?: number | null;
+    /**
+     * Annual paid-time-off minutes. Omit to carry forward the preceding version, or send null to clear it.
+     */
+    pto_annual_minutes?: number | null;
+    /**
+     * Annual holiday minutes. Omit to carry forward the preceding version, or send null to clear it.
+     */
+    holiday_annual_minutes?: number | null;
+    /**
+     * Annual training minutes. Omit to carry forward the preceding version, or send null to clear it.
+     */
+    training_annual_minutes?: number | null;
+    /**
+     * Annual training amount in cents as a decimal string. Omit to carry forward the preceding version, or send null to clear it.
+     */
+    training_annual_amount_cents?: string | null;
+    /**
+     * Annual employer health contribution in cents as a decimal string. Omit to carry forward the preceding version, or send null to clear it.
+     */
+    employer_combined_health_amount_cents?: string | null;
+    /**
+     * 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.
+     */
+    effective_date: string;
+};
+/**
+ * Request body for changing values at one exact strictly future employment boundary. Send only the fields to change; omitted values remain as recorded at that boundary. The boundary date cannot move.
+ */
+export type PeopleEmploymentScheduledChangeUpdateParameters = {
+    /**
+     * How the employment is paid: hourly or salary. Omit to preserve the value at the targeted boundary.
+     */
+    compensation_type?: 'hourly' | 'salary';
+    /**
+     * Hourly pay in cents as a decimal string. Omit to preserve the value at the targeted boundary, or send null to clear it.
+     */
+    hourly_rate_cents?: string | null;
+    /**
+     * Whether the employment is overtime eligible. Omit to preserve the value at the targeted boundary, or send null to clear it.
+     */
+    overtime_eligible?: boolean | null;
+    /**
+     * Overtime package ID. Omit to preserve the value at the targeted boundary, or send null to clear it.
+     */
+    overtime_package_id?: string | null;
+    /**
+     * Annual worked minutes. Omit to preserve the value at the targeted boundary, or send null to clear it.
+     */
+    worked_annual_minutes?: number | null;
+    /**
+     * Annual paid-time-off minutes. Omit to preserve the value at the targeted boundary, or send null to clear it.
+     */
+    pto_annual_minutes?: number | null;
+    /**
+     * Annual holiday minutes. Omit to preserve the value at the targeted boundary, or send null to clear it.
+     */
+    holiday_annual_minutes?: number | null;
+    /**
+     * Annual training minutes. Omit to preserve the value at the targeted boundary, or send null to clear it.
+     */
+    training_annual_minutes?: number | null;
+    /**
+     * Annual training amount in cents as a decimal string. Omit to preserve the value at the targeted boundary, or send null to clear it.
+     */
+    training_annual_amount_cents?: string | null;
+    /**
+     * Annual employer health contribution in cents as a decimal string. Omit to preserve the value at the targeted boundary, or send null to clear it.
+     */
+    employer_combined_health_amount_cents?: string | null;
+    /**
+     * 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.
+ */
+export type PeopleEmploymentGenesisParameters = {
+    /**
+     * The timeline's new start, as a calendar date (`YYYY-MM-DD`). Required; a value carrying a time component is refused with `422` rather than truncated. Moving it earlier extends the first version back to it. Moving it later drops every version whose coverage ended at or before it and truncates the one spanning it, so what those versions said stops being readable. Refused with `422` when the employment has no finite start or the new start would fall at or after a scheduled termination.
+     */
+    effective_date?: string;
+};
+/**
+ * Parameters for scheduling when an employment stint stops being valid.
+ */
+export type PeopleEmploymentScheduledTerminationParameters = {
+    /**
+     * The exclusive end of the employment's valid-time timeline, as a calendar date (`YYYY-MM-DD`). Required; a value carrying a time component is refused with `422` rather than truncated. Must fall after the employment's genesis. Scheduling removes versions that start on or after the new end and truncates the version spanning it. An employment holds at most one scheduled termination; cancel the standing one before scheduling another. Cancellation reopens the last surviving version and does not restore removed versions.
+     */
+    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.
@@ -3337,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';
     /**
@@ -3611,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';
     /**
@@ -5437,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.
      */
@@ -5487,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.
      */
@@ -5537,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.
      */
@@ -5587,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.
      */
@@ -12320,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: {
@@ -19607,6 +19930,7 @@ export type ListAggregateTimeImportsData = {
          * * `processed`
          * * `success`
          * * `failed`
+         * * `superseded`
          *
          */
         'filter[status]'?: string;
@@ -19735,6 +20059,7 @@ export type ListDsptchCprImportsData = {
          * * `processed`
          * * `success`
          * * `failed`
+         * * `superseded`
          *
          */
         'filter[status]'?: string;
@@ -19863,6 +20188,7 @@ export type ListTimeEntryImportsData = {
          * * `processed`
          * * `success`
          * * `failed`
+         * * `superseded`
          *
          */
         'filter[status]'?: string;
@@ -20385,6 +20711,7 @@ export type ListPaystubImportsData = {
          * * `processed`
          * * `success`
          * * `failed`
+         * * `superseded`
          *
          */
         'filter[status]'?: string;
@@ -21001,50 +21328,179 @@ export type UpdatePaystubResponses = {
     200: PaystubResponseObject;
 };
 export type UpdatePaystubResponse = UpdatePaystubResponses[keyof UpdatePaystubResponses];
-export type ListEmploymentHistoryData = {
+export type ListCustomFieldsData = {
     body?: never;
     path: {
         employment_id: string;
     };
-    query?: {
-        'as_of[valid]'?: string;
-        'as_of[transaction]'?: string;
-        /**
-         * This pagination cursor corresponds to the cursor value found in the response in
-         * `meta.page.next_cursor`.
-         */
-        'page[cursor]'?: string;
-        /**
-         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
-         */
-        'page[limit]'?: number;
-        page?: string;
-    };
-    url: '/api/v1/people/employments/{employment_id}/history';
+    query?: never;
+    url: '/api/v1/people/employments/{employment_id}/custom_fields';
 };
-export type ListEmploymentHistoryErrors = {
-    /**
-     * Bad Request
-     */
-    400: Problem;
+export type ListCustomFieldsErrors = {
     /**
      * Forbidden
      */
     403: Problem;
     /**
-     * Not Found for an unknown employment
+     * Not Found
      */
     404: Problem;
 };
-export type ListEmploymentHistoryError = ListEmploymentHistoryErrors[keyof ListEmploymentHistoryErrors];
-export type ListEmploymentHistoryResponses = {
+export type ListCustomFieldsError = ListCustomFieldsErrors[keyof ListCustomFieldsErrors];
+export type ListCustomFieldsResponses = {
     /**
      * Success
      */
     200: {
-        meta: Meta;
-        links: Links;
-        data: Array<PeopleEmploymentHistoryVersionObject>;
+        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: {
+        /**
+         * Version validator for the whole employment family, or `*` for its current state.
+         */
+        'If-Match': string;
+    };
+    path: {
+        /**
+         * The employment stint identity returned as `id`.
+         */
+        employment_id: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{employment_id}/genesis';
+};
+export type UpdateGenesisErrors = {
+    /**
+     * 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 UpdateGenesisError = UpdateGenesisErrors[keyof UpdateGenesisErrors];
+export type UpdateGenesisResponses = {
+    /**
+     * Success
+     */
+    200: PeopleEmploymentResponseObject;
+};
+export type UpdateGenesisResponse = UpdateGenesisResponses[keyof UpdateGenesisResponses];
+export type ListEmploymentHistoryData = {
+    body?: never;
+    path: {
+        employment_id: string;
+    };
+    query?: {
+        'as_of[valid]'?: string;
+        'as_of[transaction]'?: string;
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+    };
+    url: '/api/v1/people/employments/{employment_id}/history';
+};
+export type ListEmploymentHistoryErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found for an unknown employment
+     */
+    404: Problem;
+};
+export type ListEmploymentHistoryError = ListEmploymentHistoryErrors[keyof ListEmploymentHistoryErrors];
+export type ListEmploymentHistoryResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<PeopleEmploymentHistoryVersionObject>;
     };
 };
 export type ListEmploymentHistoryResponse = ListEmploymentHistoryResponses[keyof ListEmploymentHistoryResponses];
@@ -21095,6 +21551,265 @@ export type ListEmploymentsHistoryResponses = {
     };
 };
 export type ListEmploymentsHistoryResponse = ListEmploymentsHistoryResponses[keyof ListEmploymentsHistoryResponses];
+export type CreateEmploymentScheduledChangeData = {
+    body: PeopleEmploymentScheduledChangeCreateParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against.
+         */
+        'If-Match': string;
+    };
+    path: {
+        /**
+         * The employment stint identity returned as `id`.
+         */
+        employment_id: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{employment_id}/scheduled_changes';
+};
+export type CreateEmploymentScheduledChangeErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Conflict
+     */
+    409: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type CreateEmploymentScheduledChangeError = CreateEmploymentScheduledChangeErrors[keyof CreateEmploymentScheduledChangeErrors];
+export type CreateEmploymentScheduledChangeResponses = {
+    /**
+     * Created
+     */
+    201: PeopleEmploymentResponseObject;
+};
+export type CreateEmploymentScheduledChangeResponse = CreateEmploymentScheduledChangeResponses[keyof CreateEmploymentScheduledChangeResponses];
+export type DeleteEmploymentScheduledChangeData = {
+    body?: never;
+    headers: {
+        /**
+         * Version validator this write is composed against.
+         */
+        'If-Match': string;
+    };
+    path: {
+        /**
+         * The employment stint identity returned as `id`.
+         */
+        employment_id: string;
+        /**
+         * The existing strictly future boundary, as a company-local date.
+         */
+        effective_date: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}';
+};
+export type DeleteEmploymentScheduledChangeErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type DeleteEmploymentScheduledChangeError = DeleteEmploymentScheduledChangeErrors[keyof DeleteEmploymentScheduledChangeErrors];
+export type DeleteEmploymentScheduledChangeResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteEmploymentScheduledChangeResponse = DeleteEmploymentScheduledChangeResponses[keyof DeleteEmploymentScheduledChangeResponses];
+export type UpdateEmploymentScheduledChangeData = {
+    body: PeopleEmploymentScheduledChangeUpdateParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against.
+         */
+        'If-Match': string;
+    };
+    path: {
+        /**
+         * The employment stint identity returned as `id`.
+         */
+        employment_id: string;
+        /**
+         * The existing strictly future boundary, as a company-local date.
+         */
+        effective_date: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}';
+};
+export type UpdateEmploymentScheduledChangeErrors = {
+    /**
+     * 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 UpdateEmploymentScheduledChangeError = UpdateEmploymentScheduledChangeErrors[keyof UpdateEmploymentScheduledChangeErrors];
+export type UpdateEmploymentScheduledChangeResponses = {
+    /**
+     * Success
+     */
+    200: PeopleEmploymentResponseObject;
+};
+export type UpdateEmploymentScheduledChangeResponse = UpdateEmploymentScheduledChangeResponses[keyof UpdateEmploymentScheduledChangeResponses];
+export type DeleteScheduledTerminationData = {
+    body?: never;
+    headers: {
+        /**
+         * Version validator for the whole employment family, or `*` to write against its current state.
+         */
+        'If-Match': string;
+    };
+    path: {
+        /**
+         * The employment stint identity returned as `id`.
+         */
+        employment_id: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{employment_id}/scheduled_termination';
+};
+export type DeleteScheduledTerminationErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type DeleteScheduledTerminationError = DeleteScheduledTerminationErrors[keyof DeleteScheduledTerminationErrors];
+export type DeleteScheduledTerminationResponses = {
+    /**
+     * Success
+     */
+    200: PeopleEmploymentResponseObject;
+};
+export type DeleteScheduledTerminationResponse = DeleteScheduledTerminationResponses[keyof DeleteScheduledTerminationResponses];
+export type CreateEmploymentScheduledTerminationData = {
+    body: PeopleEmploymentScheduledTerminationParameters;
+    headers: {
+        /**
+         * Version validator for the whole employment family, or `*` to write against its current state.
+         */
+        'If-Match': string;
+    };
+    path: {
+        /**
+         * The employment stint identity returned as `id`.
+         */
+        employment_id: string;
+    };
+    query?: never;
+    url: '/api/v1/people/employments/{employment_id}/scheduled_termination';
+};
+export type CreateEmploymentScheduledTerminationErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Conflict
+     */
+    409: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type CreateEmploymentScheduledTerminationError = CreateEmploymentScheduledTerminationErrors[keyof CreateEmploymentScheduledTerminationErrors];
+export type CreateEmploymentScheduledTerminationResponses = {
+    /**
+     * Created
+     */
+    201: PeopleEmploymentResponseObject;
+};
+export type CreateEmploymentScheduledTerminationResponse = CreateEmploymentScheduledTerminationResponses[keyof CreateEmploymentScheduledTerminationResponses];
 export type ListEmploymentsData = {
     body?: never;
     path?: never;
@@ -21152,6 +21867,85 @@ export type ListEmploymentsResponses = {
     };
 };
 export type ListEmploymentsResponse = ListEmploymentsResponses[keyof ListEmploymentsResponses];
+export type CreateEmploymentData = {
+    body: PeopleEmploymentCreateParameters;
+    path?: never;
+    query?: never;
+    url: '/api/v1/people/employments';
+};
+export type CreateEmploymentErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreateEmploymentError = CreateEmploymentErrors[keyof CreateEmploymentErrors];
+export type CreateEmploymentResponses = {
+    /**
+     * Created
+     */
+    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: {
@@ -21186,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;