@dsptch-work/api-client 0.21.0 → 0.22.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.
      */
@@ -1430,6 +1430,203 @@ 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;
+    /**
+     * 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;
+};
+/**
+ * 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;
+};
 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.
@@ -21001,6 +21198,57 @@ export type UpdatePaystubResponses = {
     200: PaystubResponseObject;
 };
 export type UpdatePaystubResponse = UpdatePaystubResponses[keyof UpdatePaystubResponses];
+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: {
@@ -21095,6 +21343,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 +21659,38 @@ 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 GetEmploymentData = {
     body?: never;
     path: {