@dsptch-work/api-client 0.15.0 → 0.17.0

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

@@ -370,7 +370,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' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'users';
+    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';
     /**
      * Metadata describing the file being registered, before its bytes are uploaded.
      */
@@ -875,7 +875,7 @@ export type ApprenticeshipOccupationParameters = {
  */
 export type ApprenticeshipProgramEmployerParameters = {
     /**
-     * ID of the company to authorize as an employer in this program; cannot be changed once the employer has apprentices. Required.
+     * ID of the company to authorize as an employer in this program; it need not be related to the sponsor, since a group program names unaffiliated contractors. Naming a company here grants its admins and managers read access to this program, the right to enroll their own workers in it, the right to curate its trade-to-occupation scope decisions, and a passing apprenticeship-program compliance check; it grants no access to that company's own data. Cannot be changed once the employer has apprentices. Required.
      */
     company_id: string;
     /**
@@ -2821,7 +2821,7 @@ export type JobParameters = {
      */
     requested_by_company_id: string;
     /**
-     * ID of the user creating the job. Required.
+     * ID of the user creating the job. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
      */
     created_by_user_id: string;
     /**
@@ -3096,7 +3096,7 @@ export type GroupParameters = {
     name: string;
 };
 /**
- * A worker as your company sees them: the cross-company person merged with their employment record at your company (title, pay, benefits, and accruals), their roles at your company, and optional prevailing-wage compliance details. There is no delete — removing a worker terminates their employment at the company (see the user-company endpoints), which sets termination_date and drops them from the default list.
+ * A worker as your company sees them: the cross-company person merged with their employment record at your company (title, pay, benefits, and accruals), their roles at your company, and optional prevailing-wage compliance details. Your company sees everyone it employs, everyone it has granted a role, and everyone it has invited, which is the same set the web app shows. A role holder or an invitee your company does not employ has no employment record to merge, so the employment fields (employment_id through employment_window, plus manager_user_id) are null for them, no employment custom fields are published for them, and employment_state reads none. There is no delete — removing a worker terminates their employment at the company (see the user-company endpoints), which sets termination_date and drops them from the default list.
  */
 export type UserResponseObject = {
     /**
@@ -3171,10 +3171,14 @@ export type UserResponseObject = {
      * URL of the worker's LinkedIn profile. Null when unset.
      */
     linkedin_url: string | null;
+    /**
+     * Where the worker stands with your company right now, read against the employment published here: active (an employment in effect now), scheduled (an employment that has not begun), terminated (an employment that has ended, with nothing current and nothing upcoming), or none (someone your company sees without employing — a role holder or an invitee, told apart by the roles array). It is computed at read time rather than stored, so a scheduled hire turns active on its start date with no write. The same four words are filter[state] values on the list endpoint, which also accepts all.
+     */
+    employment_state: 'active' | 'scheduled' | 'terminated' | 'none';
     /**
      * Identity of the worker's employment at your company, stable across employment versions — a title change or a raise versions the employment without changing this id. It names the employment that this object's employment fields (type through employment_window, plus manager_user_id and any employment custom fields) describe: a worker rehired after an earlier stint holds a second employment with its own id, and exactly one of them is published here.
      */
-    employment_id: string;
+    employment_id: string | null;
     type: UserCompanyType;
     /**
      * Job title at your company. Null when unset.
@@ -3183,11 +3187,11 @@ export type UserResponseObject = {
     /**
      * Whether the worker is eligible for overtime pay (a prerequisite for assigning an overtime package).
      */
-    overtime_eligible: boolean;
+    overtime_eligible: boolean | null;
     /**
      * Whether the worker is enrolled in Time and Attendance and participates in time tracking.
      */
-    enrolled_in_t_and_a: boolean;
+    enrolled_in_t_and_a: boolean | null;
     /**
      * The worker's identifier in your payroll system of record. Null when unset.
      */
@@ -3195,7 +3199,7 @@ export type UserResponseObject = {
     /**
      * How the worker is paid: hourly or salary.
      */
-    compensation_type: string;
+    compensation_type: string | null;
     /**
      * Base pay rate, formatted as a currency string in the company's currency. Null when unset.
      */
@@ -3248,7 +3252,7 @@ export type UserResponseObject = {
          * When this version of the employment stopped applying (ISO 8601); null while it is still in effect. A value in the past means an ended version is being served because the worker has nothing current or scheduled.
          */
         valid_to: string | null;
-    };
+    } | null;
     /**
      * Id of the worker's manager at your company (another user). Null when none.
      */
@@ -4706,7 +4710,9 @@ export type DsptchCprImportResponseObject = {
 /**
  * Submit a certified payroll report for a pay period. The pay period's pay schedule must be in aggregate time mode; a schedule that keeps time as entries is refused. The file carries every column of the DSPTCH CPR template: the payroll, job and employee identifiers, the employer and employee pay, contribution and deduction amounts, the three wage pay rates, and one hours column per multiplier per day of the period — seven days each for a weekly schedule, fourteen for a biweekly one. All of them must be present as column headers, or the file is refused naming the ones missing. Of those, job_id, week_ending_date, employee_payroll_id, one_x_wage_pay_rate and one_five_x_wage_pay_rate must also carry a value on every row, and two_x_wage_pay_rate must whenever any 2x hours column does. federal_labor_classification and regional_labor_classification are read when present, and are needed only where a position has more than one wage determination in a jurisdiction. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
  *
- * Submitting the same work twice is refused rather than doubled: an import will not write onto a time card that already holds data, so a retry after a submission that already succeeded answers 422 naming `time_card_has_data`, and nothing is written. The guard is per time card, not per file, so a corrected file for the same worker and period is refused the same way — clear that period's data first. Because acceptance is synchronous but the write happens in the background, two submissions racing each other can both be accepted; the second one then fails on the same guard and reports it through `processing_errors`.
+ * Submitting the same work twice is refused rather than doubled: an import will not write onto a time card that already holds data, so a retry after a submission that already succeeded answers 422 naming `time_card_has_data`, and nothing is written. The guard is per time card, not per file, so a corrected file for the same worker and period is refused the same way — clear that period's data first.
+ *
+ * Because acceptance is synchronous but the write happens in the background, only one import at a time is accepted for a pay period: while an earlier one is still `pending` or `processing`, a second answers 409 naming `import_in_progress`, and nothing is written. Poll the earlier import until it reports, then submit again.
  */
 export type DsptchCprImportParameters = {
     /**
@@ -4714,6 +4720,56 @@ export type DsptchCprImportParameters = {
      */
     file_signed_id: string;
 };
+/**
+ * One bulk upload of paystub amounts against a payroll run, and how it turned out.
+ */
+export type PaystubImportResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * The payroll run the amounts were imported against.
+     */
+    payrolls_payroll_run_id: string;
+    /**
+     * Where the import has got to. `pending` until the background job starts, then `success` or `failed`.
+     */
+    status: 'pending' | 'processing' | 'processed' | 'success' | 'failed';
+    /**
+     * 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.
+     */
+    processed_rows_count: number;
+    /**
+     * Every problem found after the import was accepted, oldest row first; empty when there were none, and always empty while the import is `pending`.
+     */
+    processing_errors: Array<ImportProcessingError>;
+    /**
+     * When processing finished; null while the import is still pending.
+     */
+    completed_at: string | null;
+    /**
+     * When the import was submitted.
+     */
+    created_at: string;
+    /**
+     * When the import was last modified.
+     */
+    updated_at: string;
+};
+/**
+ * Submit a spreadsheet of paystub amounts for a payroll run. The run's pay schedule must not be connected to a payroll provider; where one is configured the paystubs come from that connection and a file is refused. Each row is one amount: payroll_id names the employee, field_name names the pay, deduction or contribution the amount belongs to, and amount carries the value. A field_name the company has not mapped before is created on first use. Schedules that do not already record the contributor on that mapping also require a contributor column of EMPLOYEE or EMPLOYER; where the mapping carries it, the column is not read and its presence is refused. All of the columns the schedule expects must be present as headers and carry a value on every row, or the file is refused naming what is missing. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
+ *
+ * Submitting the same pay twice is refused rather than doubled: an import will not write onto a time card that already carries paystub data, so a retry after a submission that already succeeded answers 422 naming `time_card_has_paystub_data`, and no line item is written. A unique index on the line items backs that guard at the database.
+ *
+ * Because acceptance is synchronous but the write happens in the background, only one import at a time is accepted for a payroll run: while an earlier one is still `pending`, a second answers 409 naming `import_in_progress`, and nothing is written. Poll the earlier import until it reports, then submit again.
+ */
+export type PaystubImportParameters = {
+    /**
+     * A signed_id from POST /api/v1/direct_uploads identifying the uploaded spreadsheet. Register the upload naming `payrolls.payroll_runs.imports.paystubs` — a signed_id issued for any other resource will not resolve here.
+     */
+    file_signed_id: string;
+};
 /**
  * One bulk upload of time entries against a pay period, and how it turned out.
  */
@@ -4753,6 +4809,8 @@ export type TimeEntryImportResponseObject = {
 };
 /**
  * Submit a spreadsheet of time entries for a pay period. All seven of payroll_id, start_time, end_time, timecode, job_id, state and description must be present as column headers, or the file is refused naming the ones missing. Of those, payroll_id, start_time, end_time, timecode and state must also carry a value on every row. features, federal_labor_classification and regional_labor_classification are read when present. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
+ *
+ * Because acceptance is synchronous but the write happens in the background, only one import at a time is accepted for a pay period: while an earlier one is still `pending` or `processing`, a second answers 409 naming `import_in_progress`, and nothing is written. Poll the earlier import until it reports, then submit again.
  */
 export type TimeEntryImportParameters = {
     /**
@@ -6118,6 +6176,103 @@ export type ComplianceCheckResponseObject = {
      * ID of the employment (user-company) this check applies to, stable across all of its versions; set only when type is "Compliances::UserCompanyCheck", else null.
      */
     employment_id: string | null;
+    /**
+     * IDs of the people assigned to the check; empty when nobody is assigned.
+     */
+    assignee_user_ids: Array<string>;
+    /**
+     * From the check's requirement.
+     */
+    title: string;
+    /**
+     * From the check's requirement.
+     */
+    description: string;
+    /**
+     * Category of the requirement: one of apprenticeship, certified_payroll, company, job, payroll, project, regional, tax_credit, timekeeping, or worker.
+     */
+    category: 'apprenticeship' | 'certified_payroll' | 'company' | 'job' | 'payroll' | 'project' | 'regional' | 'tax_credit' | 'timekeeping' | 'worker';
+    /**
+     * Point in the compliance lifecycle when the requirement applies: one of onboarding, setup, maintenance, before_approval_deadline, after_pay_date, or close_out.
+     */
+    phase: 'after_pay_date' | 'before_approval_deadline' | 'close_out' | 'maintenance' | 'onboarding' | 'setup';
+    /**
+     * Urgency of the requirement: one of critical, high, medium, or low; null when the requirement sets no priority.
+     */
+    priority: 'critical' | 'high' | 'medium' | 'low' | null;
+    /**
+     * When the check was last evaluated (ISO 8601); null when never evaluated.
+     */
+    checked_at: string | null;
+    /**
+     * When the check most recently passed (ISO 8601); null while not passed.
+     */
+    passed_at: string | null;
+    /**
+     * When the check is due (ISO 8601); null when no due date is set.
+     */
+    time_due: string | null;
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+};
+/**
+ * A single compliance check, with the documents attached to it. Same fields as compliance_check_response_object plus `documents`.
+ */
+export type ComplianceCheckDetailResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * The kind of entity this check is evaluated against; exactly one of the corresponding `*_id` fields is set.
+     */
+    type: 'Compliances::CompanyCheck' | 'Compliances::JobCheck' | 'Compliances::ProjectCheck' | 'Compliances::TimeCardCheck' | 'Compliances::PayPeriodCheck' | 'Compliances::UserCheck' | 'Compliances::UserCompanyCheck';
+    /**
+     * Lifecycle status of the check: one of passed, failed, not_applicable, dismissed, or pending; only dismissed and pending are client-settable (see compliance_check_parameters).
+     */
+    status: 'passed' | 'failed' | 'not_applicable' | 'dismissed' | 'pending';
+    /**
+     * ID of the requirement this check evaluates.
+     */
+    compliances_requirement_id: string;
+    /**
+     * ID of the company this check applies to; set only when type is "Compliances::CompanyCheck", else null.
+     */
+    company_id: string | null;
+    /**
+     * ID of the job this check applies to; set only when type is "Compliances::JobCheck", else null.
+     */
+    job_id: string | null;
+    /**
+     * ID of the project this check applies to; set only when type is "Compliances::ProjectCheck", else null.
+     */
+    project_id: string | null;
+    /**
+     * ID of the time card this check applies to; set only when type is "Compliances::TimeCardCheck", else null.
+     */
+    timekeeping_time_card_id: string | null;
+    /**
+     * ID of the pay period this check applies to; set only when type is "Compliances::PayPeriodCheck", else null.
+     */
+    timekeeping_pay_period_id: string | null;
+    /**
+     * ID of the worker this check applies to; set only when type is "Compliances::UserCheck", else null.
+     */
+    user_id: string | null;
+    /**
+     * ID of the employment (user-company) this check applies to, stable across all of its versions; set only when type is "Compliances::UserCompanyCheck", else null.
+     */
+    employment_id: string | null;
+    /**
+     * IDs of the people assigned to the check; empty when nobody is assigned.
+     */
+    assignee_user_ids: Array<string>;
     /**
      * From the check's requirement.
      */
@@ -6158,9 +6313,46 @@ export type ComplianceCheckResponseObject = {
      * When the record was last updated (ISO 8601).
      */
     updated_at: string;
+    /**
+     * Documents attached to the check; always empty when its requirement does not ask for one.
+     */
+    documents: Array<ComplianceCheckDocumentObject>;
+};
+/**
+ * A document attached to a compliance check.
+ */
+export type ComplianceCheckDocumentObject = {
+    /**
+     * ID of the document.
+     */
+    id: string;
+    /**
+     * Name of the uploaded file.
+     */
+    filename: string;
+    /**
+     * MIME type of the uploaded file; null when the upload did not declare one.
+     */
+    content_type: string | null;
+    /**
+     * Size of the uploaded file in bytes.
+     */
+    byte_size: number;
+    /**
+     * Time-limited download URL for the file.
+     */
+    url: string;
+    /**
+     * ID of the person who uploaded the document.
+     */
+    created_by_user_id: string;
+    /**
+     * When the document was uploaded (ISO 8601).
+     */
+    created_at: string;
 };
 /**
- * Update a compliance check. Both fields are optional.
+ * Update a compliance check. Every field is optional.
  */
 export type ComplianceCheckParameters = {
     /**
@@ -6171,6 +6363,70 @@ export type ComplianceCheckParameters = {
      * When the check is due (ISO 8601); send null to clear it, or omit to leave it unchanged.
      */
     time_due?: string | null;
+    /**
+     * Replaces the check's assignees: send every user id that should be assigned, or an empty array to clear them. Every id must belong to a person in your company. Omit to leave the assignees unchanged.
+     */
+    assignee_user_ids?: Array<string>;
+    /**
+     * Adds a document to the check. Upload the file to /api/v1/direct_uploads naming the `compliance.checks` resource, then send the signed id it returns. Requires a user-scoped API key, because the document records who uploaded it; a company-scoped key is refused. The check re-evaluates unless this same request also sets `status`. Refused when the check's requirement does not ask for a document.
+     */
+    file_signed_id?: string;
+};
+export type RichTextObject = {
+    text: string;
+    attachments: Array<{
+        filename: string;
+        content_type?: string | null;
+        byte_size: number;
+        url: string;
+    }>;
+};
+export type TodoInboxEntryResponseObject = ({
+    kind: 'todo';
+} & TodoInboxTodoResponseObject) | ({
+    kind: 'compliance_check';
+} & TodoInboxComplianceCheckResponseObject);
+export type TodoInboxTodoResponseObject = {
+    kind: 'todo';
+    id: string;
+    type: 'company' | 'job' | 'project';
+    company_id: string | null;
+    job_id: string | null;
+    project_id: string | null;
+    name: string;
+    created_by_user_id: string;
+    updated_by_user_id: string;
+    completed: boolean;
+    task_assignee_user_ids: Array<string>;
+    description: RichTextObject;
+    time_due: string | null;
+    created_at: string;
+    updated_at: string;
+};
+export type TodoInboxComplianceCheckResponseObject = {
+    kind: 'compliance_check';
+    id: string;
+    type: 'Compliances::CompanyCheck' | 'Compliances::JobCheck' | 'Compliances::ProjectCheck' | 'Compliances::TimeCardCheck' | 'Compliances::PayPeriodCheck' | 'Compliances::UserCheck' | 'Compliances::UserCompanyCheck';
+    status: 'passed' | 'failed' | 'not_applicable' | 'dismissed' | 'pending';
+    compliances_requirement_id: string;
+    company_id: string | null;
+    job_id: string | null;
+    project_id: string | null;
+    timekeeping_time_card_id: string | null;
+    timekeeping_pay_period_id: string | null;
+    user_id: string | null;
+    employment_id: string | null;
+    assignee_user_ids: Array<string>;
+    title: string;
+    description: string;
+    category: 'apprenticeship' | 'certified_payroll' | 'company' | 'job' | 'payroll' | 'project' | 'regional' | 'tax_credit' | 'timekeeping' | 'worker';
+    phase: 'after_pay_date' | 'before_approval_deadline' | 'close_out' | 'maintenance' | 'onboarding' | 'setup';
+    priority: 'critical' | 'high' | 'medium' | 'low' | null;
+    checked_at: string | null;
+    passed_at: string | null;
+    time_due: string | null;
+    created_at: string;
+    updated_at: string;
 };
 /**
  * One compliance requirement from the catalog. Requirements ship with the application, so the catalog reads the same for every company.
@@ -6953,18 +7209,9 @@ export type PositionParameters = {
      */
     wage_adder_rate_cents?: number | null;
     /**
-     * Wage determinations to attach, each by job_wage_determination_id (with the join record id when updating an existing attachment). Detaching is not available through this API.
+     * The complete desired set of job wage determination IDs. On PATCH, this replaces the current set; omit the field to leave assignments unchanged. Required federal and regional assignments cannot be removed from a PWA position.
      */
-    job_wage_determinations_positions_attributes?: Array<{
-        /**
-         * Unique identifier.
-         */
-        id?: number | null;
-        /**
-         * ID of the job wage determination to attach.
-         */
-        job_wage_determination_id?: string | null;
-    }>;
+    job_wage_determination_ids?: Array<string>;
     /**
      * PWA classification detail to set; skill_level sets the apprenticeship or skill classification.
      */
@@ -7555,7 +7802,7 @@ export type PositionFunction = {
  */
 export type UserRoleRequest = {
     /**
-     * ID of the user to grant the role to.
+     * ID of the user to grant the role to. Must be someone your company can already see — a worker it employs, a holder of one of its roles, or someone it has invited.
      */
     user_id?: string;
     /**
@@ -14099,6 +14346,10 @@ export type ListChecksData = {
         'filter[job_id][null]'?: boolean;
         'filter[project_id]'?: string;
         'filter[compliances_requirement_id]'?: string;
+        /**
+         * Only checks the given person is assigned to.
+         */
+        'filter[assignee_user_id]'?: string;
         'filter[time_due][gte]'?: string;
         'filter[time_due][lte]'?: string;
         filter?: string;
@@ -14165,7 +14416,7 @@ export type GetCheckResponses = {
     /**
      * Success
      */
-    200: ComplianceCheckResponseObject;
+    200: ComplianceCheckDetailResponseObject;
 };
 export type GetCheckResponse = GetCheckResponses[keyof GetCheckResponses];
 export type UpdateCheckData = {
@@ -14195,7 +14446,7 @@ export type UpdateCheckResponses = {
     /**
      * Success
      */
-    200: ComplianceCheckResponseObject;
+    200: ComplianceCheckDetailResponseObject;
 };
 export type UpdateCheckResponse = UpdateCheckResponses[keyof UpdateCheckResponses];
 export type ListRequirementsData = {
@@ -16755,6 +17006,10 @@ export type CreateDsptchCprImportErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Conflict
+     */
+    409: Problem;
     /**
      * Unprocessable Content
      */
@@ -16879,6 +17134,10 @@ export type CreateTimeEntryImportErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Conflict
+     */
+    409: Problem;
     /**
      * Unprocessable Content
      */
@@ -17309,6 +17568,134 @@ export type UpdateFringeBenefitPlanResponses = {
     200: PayrollFringeBenefitPlanResponseObject;
 };
 export type UpdateFringeBenefitPlanResponse = UpdateFringeBenefitPlanResponses[keyof UpdateFringeBenefitPlanResponses];
+export type ListPaystubImportsData = {
+    body?: never;
+    path: {
+        payroll_run_id: string;
+    };
+    query?: {
+        /**
+         * Filter by import status:
+         * * `pending`
+         * * `processing`
+         * * `processed`
+         * * `success`
+         * * `failed`
+         *
+         */
+        'filter[status]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        'filter[completed_at][gte]'?: string;
+        'filter[completed_at][lte]'?: string;
+        'filter[created_at][gte]'?: string;
+        'filter[created_at][lte]'?: string;
+        'filter[updated_at][gte]'?: string;
+        'filter[updated_at][lte]'?: 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/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs';
+};
+export type ListPaystubImportsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type ListPaystubImportsError = ListPaystubImportsErrors[keyof ListPaystubImportsErrors];
+export type ListPaystubImportsResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<PaystubImportResponseObject>;
+    };
+};
+export type ListPaystubImportsResponse = ListPaystubImportsResponses[keyof ListPaystubImportsResponses];
+export type CreatePaystubImportData = {
+    body: PaystubImportParameters;
+    path: {
+        payroll_run_id: string;
+    };
+    query?: never;
+    url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs';
+};
+export type CreatePaystubImportErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Conflict
+     */
+    409: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreatePaystubImportError = CreatePaystubImportErrors[keyof CreatePaystubImportErrors];
+export type CreatePaystubImportResponses = {
+    /**
+     * Created
+     */
+    201: PaystubImportResponseObject;
+};
+export type CreatePaystubImportResponse = CreatePaystubImportResponses[keyof CreatePaystubImportResponses];
+export type GetPaystubImportData = {
+    body?: never;
+    path: {
+        payroll_run_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs/{id}';
+};
+export type GetPaystubImportErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetPaystubImportError = GetPaystubImportErrors[keyof GetPaystubImportErrors];
+export type GetPaystubImportResponses = {
+    /**
+     * Success
+     */
+    200: PaystubImportResponseObject;
+};
+export type GetPaystubImportResponse = GetPaystubImportResponses[keyof GetPaystubImportResponses];
 export type ListPayrollRunsData = {
     body?: never;
     path?: never;
@@ -19021,6 +19408,10 @@ export type UpdatePositionErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
 };
 export type UpdatePositionError = UpdatePositionErrors[keyof UpdatePositionErrors];
 export type UpdatePositionResponses = {
@@ -19766,6 +20157,10 @@ export type DeleteTimeEntryErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */
@@ -19799,6 +20194,10 @@ export type UpdateTimeEntryErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */
@@ -20877,6 +21276,28 @@ export type GetTimeCardActualResponses = {
     200: TimeCardActualsResponseObject;
 };
 export type GetTimeCardActualResponse = GetTimeCardActualResponses[keyof GetTimeCardActualResponses];
+export type ListTodoInboxData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/todos';
+};
+export type ListTodoInboxErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+};
+export type ListTodoInboxError = ListTodoInboxErrors[keyof ListTodoInboxErrors];
+export type ListTodoInboxResponses = {
+    /**
+     * Success
+     */
+    200: {
+        data: Array<TodoInboxEntryResponseObject>;
+    };
+};
+export type ListTodoInboxResponse = ListTodoInboxResponses[keyof ListTodoInboxResponses];
 export type ListUserRolesData = {
     body?: never;
     path?: never;
@@ -21268,9 +21689,9 @@ export type ListUsersData = {
     path?: never;
     query?: {
         /**
-         * Filter users by their membership lifecycle in the company. Defaults to `active` (a currently-valid membership); `terminated` returns only users whose membership has ended; `all` returns both.
+         * Filter users by their employment lifecycle in the company, the same vocabulary `employment_state` publishes on each user. Defaults to `active` (an employment in effect now); `scheduled` returns employments that have not begun; `terminated` returns employments that have ended, with nothing current and nothing upcoming; `none` returns people your company sees without employing, which is its role holders and its invitees; `all` returns everyone your company sees.
          */
-        'filter[state]'?: 'active' | 'terminated' | 'all';
+        'filter[state]'?: 'active' | 'scheduled' | 'terminated' | 'none' | 'all';
         /**
          * This pagination cursor corresponds to the cursor value found in the response in
          * `meta.page.next_cursor`.