@dsptch-work/api-client 0.15.0 → 0.17.0

package/dist/gen/zod.gen.js

@@ -413,9 +413,11 @@ export const zDirectUploadParameters = z.object({
         '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'
     ]),
     blob: z.object({
@@ -2072,11 +2074,42 @@ export const zDsptchCprImportResponseObject = z.object({
 /**
  * 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 const zDsptchCprImportParameters = z.object({
     file_signed_id: z.string()
 });
+/**
+ * One bulk upload of paystub amounts against a payroll run, and how it turned out.
+ */
+export const zPaystubImportResponseObject = z.object({
+    id: z.string(),
+    payrolls_payroll_run_id: z.string(),
+    status: z.enum([
+        'pending',
+        'processing',
+        'processed',
+        'success',
+        'failed'
+    ]),
+    processed_rows_count: z.int(),
+    processing_errors: z.array(zImportProcessingError),
+    completed_at: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * 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 const zPaystubImportParameters = z.object({
+    file_signed_id: z.string()
+});
 /**
  * One bulk upload of time entries against a pay period, and how it turned out.
  */
@@ -2098,6 +2131,8 @@ export const zTimeEntryImportResponseObject = z.object({
 });
 /**
  * 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 const zTimeEntryImportParameters = z.object({
     file_signed_id: z.string()
@@ -2808,6 +2843,7 @@ export const zComplianceCheckResponseObject = z.object({
     timekeeping_pay_period_id: z.string().nullable(),
     user_id: z.string().nullable(),
     employment_id: z.string().nullable(),
+    assignee_user_ids: z.array(z.string()),
     title: z.string(),
     description: z.string(),
     category: z.enum([
@@ -2843,12 +2879,187 @@ export const zComplianceCheckResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Update a compliance check. Both fields are optional.
+ * A document attached to a compliance check.
+ */
+export const zComplianceCheckDocumentObject = z.object({
+    id: z.string(),
+    filename: z.string(),
+    content_type: z.string().nullable(),
+    byte_size: z.int(),
+    url: z.string(),
+    created_by_user_id: z.string(),
+    created_at: z.iso.datetime()
+});
+/**
+ * A single compliance check, with the documents attached to it. Same fields as compliance_check_response_object plus `documents`.
+ */
+export const zComplianceCheckDetailResponseObject = z.object({
+    id: z.string(),
+    type: z.enum([
+        'Compliances::CompanyCheck',
+        'Compliances::JobCheck',
+        'Compliances::ProjectCheck',
+        'Compliances::TimeCardCheck',
+        'Compliances::PayPeriodCheck',
+        'Compliances::UserCheck',
+        'Compliances::UserCompanyCheck'
+    ]),
+    status: z.enum([
+        'passed',
+        'failed',
+        'not_applicable',
+        'dismissed',
+        'pending'
+    ]),
+    compliances_requirement_id: z.string(),
+    company_id: z.string().nullable(),
+    job_id: z.string().nullable(),
+    project_id: z.string().nullable(),
+    timekeeping_time_card_id: z.string().nullable(),
+    timekeeping_pay_period_id: z.string().nullable(),
+    user_id: z.string().nullable(),
+    employment_id: z.string().nullable(),
+    assignee_user_ids: z.array(z.string()),
+    title: z.string(),
+    description: z.string(),
+    category: z.enum([
+        'apprenticeship',
+        'certified_payroll',
+        'company',
+        'job',
+        'payroll',
+        'project',
+        'regional',
+        'tax_credit',
+        'timekeeping',
+        'worker'
+    ]),
+    phase: z.enum([
+        'after_pay_date',
+        'before_approval_deadline',
+        'close_out',
+        'maintenance',
+        'onboarding',
+        'setup'
+    ]),
+    priority: z.enum([
+        'critical',
+        'high',
+        'medium',
+        'low'
+    ]).nullable(),
+    checked_at: z.iso.datetime().nullable(),
+    passed_at: z.iso.datetime().nullable(),
+    time_due: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime(),
+    documents: z.array(zComplianceCheckDocumentObject)
+});
+/**
+ * Update a compliance check. Every field is optional.
  */
 export const zComplianceCheckParameters = z.object({
     status: z.enum(['dismissed', 'pending']).optional(),
-    time_due: z.iso.datetime().nullish()
+    time_due: z.iso.datetime().nullish(),
+    assignee_user_ids: z.array(z.string()).optional(),
+    file_signed_id: z.string().optional()
+});
+export const zRichTextObject = z.object({
+    text: z.string(),
+    attachments: z.array(z.object({
+        filename: z.string(),
+        content_type: z.string().nullish(),
+        byte_size: z.int(),
+        url: z.string()
+    }))
+});
+export const zTodoInboxTodoResponseObject = z.object({
+    kind: z.enum(['todo']),
+    id: z.string(),
+    type: z.enum([
+        'company',
+        'job',
+        'project'
+    ]),
+    company_id: z.string().nullable(),
+    job_id: z.string().nullable(),
+    project_id: z.string().nullable(),
+    name: z.string(),
+    created_by_user_id: z.string(),
+    updated_by_user_id: z.string(),
+    completed: z.boolean(),
+    task_assignee_user_ids: z.array(z.string()),
+    description: zRichTextObject,
+    time_due: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
 });
+export const zTodoInboxComplianceCheckResponseObject = z.object({
+    kind: z.enum(['compliance_check']),
+    id: z.string(),
+    type: z.enum([
+        'Compliances::CompanyCheck',
+        'Compliances::JobCheck',
+        'Compliances::ProjectCheck',
+        'Compliances::TimeCardCheck',
+        'Compliances::PayPeriodCheck',
+        'Compliances::UserCheck',
+        'Compliances::UserCompanyCheck'
+    ]),
+    status: z.enum([
+        'passed',
+        'failed',
+        'not_applicable',
+        'dismissed',
+        'pending'
+    ]),
+    compliances_requirement_id: z.string(),
+    company_id: z.string().nullable(),
+    job_id: z.string().nullable(),
+    project_id: z.string().nullable(),
+    timekeeping_time_card_id: z.string().nullable(),
+    timekeeping_pay_period_id: z.string().nullable(),
+    user_id: z.string().nullable(),
+    employment_id: z.string().nullable(),
+    assignee_user_ids: z.array(z.string()),
+    title: z.string(),
+    description: z.string(),
+    category: z.enum([
+        'apprenticeship',
+        'certified_payroll',
+        'company',
+        'job',
+        'payroll',
+        'project',
+        'regional',
+        'tax_credit',
+        'timekeeping',
+        'worker'
+    ]),
+    phase: z.enum([
+        'after_pay_date',
+        'before_approval_deadline',
+        'close_out',
+        'maintenance',
+        'onboarding',
+        'setup'
+    ]),
+    priority: z.enum([
+        'critical',
+        'high',
+        'medium',
+        'low'
+    ]).nullable(),
+    checked_at: z.iso.datetime().nullable(),
+    passed_at: z.iso.datetime().nullable(),
+    time_due: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+export const zTodoInboxEntryResponseObject = z.discriminatedUnion('kind', [
+    zTodoInboxTodoResponseObject.extend({ kind: z.literal('todo') }),
+    zTodoInboxComplianceCheckResponseObject.extend({ kind: z.literal('compliance_check') })
+]);
 /**
  * One compliance requirement from the catalog. Requirements ship with the application, so the catalog reads the same for every company.
  */
@@ -3115,10 +3326,7 @@ export const zPositionParameters = z.object({
     hourly_rate_cents: z.number().nullish(),
     pwa_wage_pay_rate_cents: z.number().nullish(),
     wage_adder_rate_cents: z.number().nullish(),
-    job_wage_determinations_positions_attributes: z.array(z.object({
-        id: z.int().nullish(),
-        job_wage_determination_id: z.string().nullish()
-    })).optional(),
+    job_wage_determination_ids: z.array(z.string()).optional(),
     pwa_details_attributes: z.object({
         skill_level: z.string().nullish()
     }).optional()
@@ -3478,7 +3686,7 @@ export const zUserRoleResponse = z.object({
  */
 export const zUserCompanyType = z.enum(['EMPLOYEE', 'CONTRACTOR']).nullable();
 /**
- * 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 const zUserResponseObject = z.object({
     id: z.string(),
@@ -3499,13 +3707,19 @@ export const zUserResponseObject = z.object({
     updated_at: z.iso.datetime(),
     winda_id: z.string().nullable(),
     linkedin_url: z.string().nullable(),
-    employment_id: z.string(),
+    employment_state: z.enum([
+        'active',
+        'scheduled',
+        'terminated',
+        'none'
+    ]),
+    employment_id: z.string().nullable(),
     type: zUserCompanyType,
     title: z.string().nullable(),
-    overtime_eligible: z.boolean(),
-    enrolled_in_t_and_a: z.boolean(),
+    overtime_eligible: z.boolean().nullable(),
+    enrolled_in_t_and_a: z.boolean().nullable(),
     payroll_id: z.string().nullable(),
-    compensation_type: z.string(),
+    compensation_type: z.string().nullable(),
     hourly_rate: z.string().nullable(),
     training_annual_amount: z.string().nullable(),
     employer_combined_health_amount: z.string().nullable(),
@@ -3519,7 +3733,7 @@ export const zUserResponseObject = z.object({
     employment_window: z.object({
         valid_from: z.iso.datetime().nullable(),
         valid_to: z.iso.datetime().nullable()
-    }),
+    }).nullable(),
     manager_user_id: z.string().nullable(),
     roles: z.array(z.string()),
     company_user_pwa_info: z.object({
@@ -6571,6 +6785,7 @@ export const zListChecksQuery = z.object({
     'filter[job_id][null]': z.boolean().optional(),
     'filter[project_id]': z.string().optional(),
     'filter[compliances_requirement_id]': z.string().optional(),
+    'filter[assignee_user_id]': z.string().optional(),
     'filter[time_due][gte]': z.iso.datetime().optional(),
     'filter[time_due][lte]': z.iso.datetime().optional(),
     filter: z.string().optional(),
@@ -6593,7 +6808,7 @@ export const zGetCheckPath = z.object({
 /**
  * Success
  */
-export const zGetCheckResponse = zComplianceCheckResponseObject;
+export const zGetCheckResponse = zComplianceCheckDetailResponseObject;
 export const zUpdateCheckBody = zComplianceCheckParameters;
 export const zUpdateCheckPath = z.object({
     id: z.string()
@@ -6601,7 +6816,7 @@ export const zUpdateCheckPath = z.object({
 /**
  * Success
  */
-export const zUpdateCheckResponse = zComplianceCheckResponseObject;
+export const zUpdateCheckResponse = zComplianceCheckDetailResponseObject;
 export const zListRequirementsQuery = z.object({
     'filter[search]': z.string().optional(),
     'filter[type]': z.string().optional(),
@@ -7541,6 +7756,47 @@ export const zUpdateFringeBenefitPlanPath = z.object({
  * Success
  */
 export const zUpdateFringeBenefitPlanResponse = zPayrollFringeBenefitPlanResponseObject;
+export const zListPaystubImportsPath = z.object({
+    payroll_run_id: z.string()
+});
+export const zListPaystubImportsQuery = z.object({
+    'filter[status]': z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional(),
+    'filter[completed_at][gte]': z.iso.datetime().optional(),
+    'filter[completed_at][lte]': z.iso.datetime().optional(),
+    'filter[created_at][gte]': z.iso.datetime().optional(),
+    'filter[created_at][lte]': z.iso.datetime().optional(),
+    'filter[updated_at][gte]': z.iso.datetime().optional(),
+    'filter[updated_at][lte]': z.iso.datetime().optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListPaystubImportsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zPaystubImportResponseObject)
+});
+export const zCreatePaystubImportBody = zPaystubImportParameters;
+export const zCreatePaystubImportPath = z.object({
+    payroll_run_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreatePaystubImportResponse = zPaystubImportResponseObject;
+export const zGetPaystubImportPath = z.object({
+    payroll_run_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetPaystubImportResponse = zPaystubImportResponseObject;
 export const zListPayrollRunsQuery = z.object({
     'filter[run_type]': z.string().optional(),
     'filter[timekeeping_pay_period_id]': z.string().optional(),
@@ -8640,6 +8896,12 @@ export const zGetTimeCardActualPath = z.object({
  * Success
  */
 export const zGetTimeCardActualResponse = zTimeCardActualsResponseObject;
+/**
+ * Success
+ */
+export const zListTodoInboxResponse = z.object({
+    data: z.array(zTodoInboxEntryResponseObject)
+});
 export const zListUserRolesQuery = z.object({
     'filter[user_id]': z.string().optional(),
     'filter[role]': z.string().optional(),
@@ -8754,7 +9016,9 @@ export const zUpdateCompanyResponse = zUserResponseObject;
 export const zListUsersQuery = z.object({
     'filter[state]': z.enum([
         'active',
+        'scheduled',
         'terminated',
+        'none',
         'all'
     ]).optional(),
     'page[cursor]': z.string().optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsptch-work/api-client",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",