@dsptch-work/api-client 0.14.0 → 0.16.0

package/dist/gen/zod.gen.js

@@ -160,6 +160,12 @@ export const zProblem = z.object({
  *
  * The resource's timeline already ends at a scheduled termination, and scheduling a second one would silently move it. Moving an end is two steps on purpose: cancel the standing termination, then schedule the one you want.
  *
+ * ### import_in_progress
+ *
+ * **Import In Progress**
+ *
+ * The parent already has an import that has not reported yet. Acceptance is synchronous but the write happens in the background, so a second file would be validated against records the queued import has not written to yet and both would apply. Poll the earlier import until it reports, then submit again.
+ *
  * ### product_archived
  *
  * **Product Archived**
@@ -358,6 +364,7 @@ export const zProblemTypeCatalog = z.enum([
     'user_scoped_key_required',
     'not_found',
     'already_terminated',
+    'import_in_progress',
     'product_archived',
     'recorded_since_termination',
     'span_beyond_timeline_end',
@@ -406,7 +413,10 @@ export const zDirectUploadParameters = z.object({
         'assets.items.service_events',
         'assets.products',
         'assets.vendors',
+        'pay_periods.imports.aggregate_times',
+        'pay_periods.imports.dsptch_cprs',
         'pay_periods.imports.time_entries',
+        'payrolls.payroll_runs.imports.paystubs',
         'users'
     ]),
     blob: z.object({
@@ -1418,6 +1428,12 @@ export const zPwaTradeParameters = z.object({
 export const zPwaTradeUpdateParameters = z.object({
     name: z.string().optional()
 });
+/**
+ * Parameters for merging one PWA trade (craft) into another in the same pool.
+ */
+export const zPwaTradeMergeParameters = z.object({
+    target_trade_id: z.string()
+});
 /**
  * A reviewed apprentice-scope decision pairing a registered apprenticeship occupation with a craft (trade). The row's existence means the pair was reviewed; scope_status carries the verdict. A pair with no row is undecided and denies apprentice treatment.
  */
@@ -1443,25 +1459,25 @@ export const zPwaTradeApprenticeshipOccupationUpdateParameters = z.object({
     scope_status: z.enum(['in_scope', 'out_of_scope']).nullish()
 });
 /**
- * Prevailing-wage / apprenticeship (PWA) compliance details for a job, used in certified-payroll reporting. Fields for every supported state are always present; those outside the job's region come back null. Null on the job when it tracks no PWA compliance.
+ * Prevailing-wage / apprenticeship (PWA) compliance details for a job, used in certified-payroll reporting. Common fields are always present when this object exists; regional fields appear only when applicable to the job's region and regional PWA mode. The property is null when no PWA details have been configured; PWA tracking modes alone do not materialize it.
  */
 export const zPwaJobDetailsResponseObject = z.object({
-    dir_awarding_body_id: z.string().nullable(),
-    dir_project_id: z.string().nullable(),
-    dir_project_name: z.string().nullable(),
-    dir_contract_id: z.string().nullable(),
-    dir_project_awarding_body_name: z.string().nullable(),
-    dir_project_number: z.string().nullable(),
-    il_dol_project_id: z.string().nullable(),
-    il_dol_state_capital_funds: z.boolean().nullable(),
-    il_dol_public_body_name: z.string().nullable(),
-    il_dol_public_body_contact_id: z.string().nullable(),
-    il_dol_public_body_address_id: z.string().nullable(),
-    il_dol_contract_number: z.string().nullable(),
-    il_shines_project_id: z.string().nullable(),
-    ny_dol_prc_number: z.string().nullable(),
+    contractor_type: z.enum(['prime_contractor', 'sub_contractor']).nullable(),
     pay_full_cash_fringe_by_default: z.boolean(),
-    contractor_type: z.string().nullable()
+    dir_awarding_body_id: z.string().nullish(),
+    dir_project_id: z.string().nullish(),
+    dir_project_name: z.string().nullish(),
+    dir_contract_id: z.string().nullish(),
+    dir_project_awarding_body_name: z.string().nullish(),
+    dir_project_number: z.string().nullish(),
+    il_dol_project_id: z.string().nullish(),
+    il_dol_state_capital_funds: z.boolean().nullish(),
+    il_dol_public_body_name: z.string().nullish(),
+    il_dol_public_body_contact_id: z.string().nullish(),
+    il_dol_public_body_address_id: z.string().nullish(),
+    il_dol_contract_number: z.string().nullish(),
+    il_shines_project_id: z.string().nullish(),
+    ny_dol_prc_number: z.string().nullish()
 }).nullable();
 /**
  * A reusable job template — a saved job pattern for quickly creating new jobs with the same setup. Read-only through the API (listing only).
@@ -1937,8 +1953,8 @@ export const zJobParameters = z.object({
         value: z.string().nullish()
     })).nullish(),
     pwa_details: z.object({
-        contractor_type: z.string().nullish(),
-        pay_full_cash_fringe_by_default: z.boolean().nullish(),
+        contractor_type: z.enum(['prime_contractor', 'sub_contractor']).nullish(),
+        pay_full_cash_fringe_by_default: z.boolean().optional(),
         dir_awarding_body_id: z.string().nullish(),
         dir_project_id: z.string().nullish(),
         dir_project_name: z.string().nullish(),
@@ -1948,12 +1964,12 @@ export const zJobParameters = z.object({
         il_dol_project_id: z.string().nullish(),
         il_dol_state_capital_funds: z.boolean().nullish(),
         il_dol_public_body_name: z.string().nullish(),
-        il_dol_contract_number: z.string().nullish(),
-        il_shines_project_id: z.string().nullish(),
         il_dol_public_body_contact_id: z.string().nullish(),
         il_dol_public_body_address_id: z.string().nullish(),
+        il_dol_contract_number: z.string().nullish(),
+        il_shines_project_id: z.string().nullish(),
         ny_dol_prc_number: z.string().nullish()
-    }).nullish()
+    }).optional()
 });
 /**
  * Parameters for updating an existing job. Accepts every job_parameters field, plus a directly settable status.
@@ -1998,14 +2014,101 @@ export const zUserCompanyScheduledTerminationParameters = z.object({
     termination_date: z.string()
 });
 /**
- * One problem found while processing an accepted import.
+ * One problem found while processing an accepted import, whatever its type.
  */
-export const zTimeEntryImportProcessingError = z.object({
+export const zImportProcessingError = z.object({
     code: z.string(),
     row: z.int().nullable(),
     column: z.string().nullable(),
     context: z.record(z.string(), z.unknown())
 });
+/**
+ * One bulk upload of day-level hours against a pay period, and how it turned out.
+ */
+export const zAggregateTimeImportResponseObject = z.object({
+    id: z.string(),
+    pay_period_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 day-level hours for a pay period. The pay period's pay schedule must keep time in aggregate mode and take pay in base mode; a schedule that keeps time as entries, or that aggregates pay, is refused. The file carries employee_payroll_id, job_id and week_ending_date, the three wage pay rates one_x_wage_pay_rate, one_five_x_wage_pay_rate and two_x_wage_pay_rate, 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, employee_payroll_id, job_id and week_ending_date must also carry a value on every row; a rate left blank falls back to the one the employee's position and wage determination already carry. 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, only one import at a time is accepted for a pay period: 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 zAggregateTimeImportParameters = z.object({
+    file_signed_id: z.string()
+});
+/**
+ * One bulk upload of a certified payroll report against a pay period, and how it turned out.
+ */
+export const zDsptchCprImportResponseObject = z.object({
+    id: z.string(),
+    pay_period_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 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, 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.
  */
@@ -2020,13 +2123,15 @@ export const zTimeEntryImportResponseObject = z.object({
         'failed'
     ]),
     processed_rows_count: z.int(),
-    processing_errors: z.array(zTimeEntryImportProcessingError),
+    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 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()
@@ -7226,6 +7331,88 @@ export const zUpdateOvertimeRulePath = z.object({
  * Success
  */
 export const zUpdateOvertimeRuleResponse = zOvertimeRuleResponseObject;
+export const zListAggregateTimeImportsPath = z.object({
+    pay_period_id: z.string()
+});
+export const zListAggregateTimeImportsQuery = 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 zListAggregateTimeImportsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zAggregateTimeImportResponseObject)
+});
+export const zCreateAggregateTimeImportBody = zAggregateTimeImportParameters;
+export const zCreateAggregateTimeImportPath = z.object({
+    pay_period_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateAggregateTimeImportResponse = zAggregateTimeImportResponseObject;
+export const zGetAggregateTimeImportPath = z.object({
+    pay_period_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetAggregateTimeImportResponse = zAggregateTimeImportResponseObject;
+export const zListDsptchCprImportsPath = z.object({
+    pay_period_id: z.string()
+});
+export const zListDsptchCprImportsQuery = 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 zListDsptchCprImportsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zDsptchCprImportResponseObject)
+});
+export const zCreateDsptchCprImportBody = zDsptchCprImportParameters;
+export const zCreateDsptchCprImportPath = z.object({
+    pay_period_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateDsptchCprImportResponse = zDsptchCprImportResponseObject;
+export const zGetDsptchCprImportPath = z.object({
+    pay_period_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetDsptchCprImportResponse = zDsptchCprImportResponseObject;
 export const zListTimeEntryImportsPath = z.object({
     pay_period_id: z.string()
 });
@@ -7388,6 +7575,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(),
@@ -7779,6 +8007,14 @@ export const zUpdateApprenticeshipOccupationPath = z.object({
  * Success
  */
 export const zUpdateApprenticeshipOccupationResponse = zPwaTradeApprenticeshipOccupationResponseObject;
+export const zCreateMergeBody = zPwaTradeMergeParameters;
+export const zCreateMergePath = z.object({
+    trade_id: z.string()
+});
+/**
+ * Success
+ */
+export const zCreateMergeResponse = zPwaTradeResponseObject;
 export const zListTradesQuery = z.object({
     'filter[project_id]': z.string().optional(),
     'filter[job_id]': z.string().optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsptch-work/api-client",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",
@@ -57,7 +57,7 @@
     "@hey-api/openapi-ts": "^0.99.0",
     "publint": "^0.3.22",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.10"
+    "vitest": "^4.1.11"
   },
   "scripts": {
     "generate": "openapi-ts",