@dsptch-work/api-client 0.51.0 → 0.52.0

package/dist/gen/zod.gen.js

@@ -234,12 +234,24 @@ export const zProblem = z.object({
  *
  * ## 422
  *
+ * ### aggregate_time_mode_required
+ *
+ * **Aggregate Time Mode Required**
+ *
+ * Writing a job time card day is only supported when that day's pay schedule keeps time in aggregate mode. A day on a base-mode schedule cannot be written this way; record that time through time entries instead.
+ *
  * ### attachment_not_image
  *
  * **Attachment Not An Image**
  *
  * The upload behind an image attachment's signed id is not an image content type. Upload an image file.
  *
+ * ### certified_payroll_export_blocked
+ *
+ * **Certified Payroll Export Blocked**
+ *
+ * Failing compliance checks block this certified payroll export: a job-level check on the named job, or a time-card check on a worker the export would include. These are the same checks that disable Export in the web app. Resolve the failing checks, then retry.
+ *
  * ### certified_payroll_format_unavailable
  *
  * **Certified Payroll Format Unavailable**
@@ -427,7 +439,9 @@ export const zProblemTypeCatalog = z.enum([
     'span_beyond_timeline_end',
     'version_overlap',
     'precondition_failed',
+    'aggregate_time_mode_required',
     'attachment_not_image',
+    'certified_payroll_export_blocked',
     'certified_payroll_format_unavailable',
     'company_not_employer',
     'confirm_apprenticeship_conflict',
@@ -633,6 +647,7 @@ export const zCompetencyCriterionResponseObject = z.object({
     number: z.string().nullable(),
     body: z.string().nullable(),
     evidence_note: z.string().nullable(),
+    allow_not_applicable: z.boolean(),
     assessment_methods: z.array(z.enum([
         'direct_observation',
         'simulation',
@@ -653,6 +668,7 @@ export const zCompetencyCriterionParameters = z.object({
     number: z.string().nullish(),
     body: z.string().nullish(),
     evidence_note: z.string().nullish(),
+    allow_not_applicable: z.boolean().optional(),
     assessment_methods: z.array(z.enum([
         'direct_observation',
         'simulation',
@@ -3540,7 +3556,7 @@ export const zDsptchCprImportResponseObject = z.object({
     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.
+ * 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. On a job that tracks prevailing wage, each rate must also be more than 0 when the row has hours at its multiplier: a row that prices such hours at 0 or below answers 422 naming `non_positive_rate_for_prevailing_wage_hours`, and nothing is written. 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.
  *
@@ -3773,6 +3789,19 @@ export const zJobTimeCardDayResponseObject = z.object({
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
+/**
+ * Partial update of an aggregate-mode job time card day. Send only the fields to change; omitted fields keep their current values. Minutes are integer minutes, not GUI hours. Derived totals such as minutes_worked and cumulatives are not writable.
+ */
+export const zJobTimeCardDayUpdateParameters = z.object({
+    overtime_minutes_worked: z.object({
+        1: z.int().gte(0),
+        1.5: z.int().gte(0),
+        2: z.int().gte(0)
+    }).optional(),
+    pay_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).optional(),
+    one_five_x_adder_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).optional(),
+    two_x_adder_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).optional()
+});
 /**
  * A single approval event on a time card. Manager and worker approvals are both recorded here; which role filed it is conveyed by the endpoint, not the payload.
  */
@@ -5392,7 +5421,7 @@ export const zJobCaEcprXmlExportResponseObject = z.object({
     created_at: z.iso.datetime()
 });
 /**
- * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. A window with no reportable pay periods answers 422 nothing_exportable.
+ * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. Failing compliance checks that block the export answer 422 certified_payroll_export_blocked. A window with no reportable pay periods answers 422 nothing_exportable.
  */
 export const zJobCaEcprXmlExportCreateParameters = z.object({
     start_date: z.iso.date(),
@@ -6034,6 +6063,7 @@ export const zProductionJobScopePriceResponseObject = z.object({
 export const zProductionPlannedFeatureTaskParameters = z.object({
     name: z.string().optional(),
     description: z.string().nullish(),
+    planned_start_date: z.iso.date().nullish(),
     time_due: z.iso.datetime().nullish(),
     tz_name: z.string().optional(),
     task_assignee_user_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
@@ -6046,6 +6076,7 @@ export const zProductionPlannedFeatureTaskParameters = z.object({
 export const zProductionPlannedFeatureTaskUpdateParameters = z.object({
     name: z.string().optional(),
     description: z.string().nullish(),
+    planned_start_date: z.iso.date().nullish(),
     time_due: z.iso.datetime().nullish(),
     tz_name: z.string().optional(),
     task_assignee_user_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
@@ -6070,12 +6101,68 @@ export const zProductionPlannedFeatureTaskResponseObject = z.object({
     archived_at: z.iso.datetime().nullable(),
     name: z.string(),
     description: z.string(),
+    planned_start_date: z.iso.date().nullable(),
     time_due: z.iso.datetime().nullable(),
     tz_name: z.string(),
     task_assignee_user_ids: z.array(z.string()),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
+/**
+ * Optional phase planning and explicit retained work facts, independently of whole-service completion.
+ */
+export const zProductionPhaseParameters = z.object({
+    name: z.string(),
+    description: z.string().nullish(),
+    planned_start_date: z.iso.date().nullish(),
+    time_due: z.iso.datetime().nullish(),
+    tz_name: z.string().optional(),
+    performed_by_user_id: z.string().max(36).regex(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/).optional()
+});
+/**
+ * Optional phase planning and explicit retained work facts, independently of whole-service completion.
+ */
+export const zProductionPhaseUpdateParameters = z.object({
+    name: z.string().optional(),
+    description: z.string().nullish(),
+    planned_start_date: z.iso.date().nullish(),
+    time_due: z.iso.datetime().nullish(),
+    tz_name: z.string().optional(),
+    performed_by_user_id: z.string().max(36).regex(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/).optional()
+});
+/**
+ * Optional phase planning and explicit retained work facts, independently of whole-service completion.
+ */
+export const zProductionPhaseArchiveParameters = z.object({
+    archived: z.boolean(),
+    performed_by_user_id: z.string().max(36).regex(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/).optional()
+});
+/**
+ * Optional phase planning and explicit retained work facts, independently of whole-service completion.
+ */
+export const zProductionPhaseResponseObject = z.object({
+    id: z.string(),
+    production_planned_feature_task_id: z.string(),
+    production_job_scope_price_id: z.string(),
+    task_id: z.string(),
+    name: z.string(),
+    description: z.string(),
+    planned_start_date: z.iso.date().nullable(),
+    time_due: z.iso.datetime().nullable(),
+    tz_name: z.string(),
+    actual_start_date: z.iso.date().nullable(),
+    archived_at: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime(),
+    completion: z.object({
+        id: z.string(),
+        work_date: z.iso.date(),
+        notes: z.string().nullable(),
+        created_by_user_id: z.string(),
+        position_ids: z.array(z.string()),
+        withdrawn_at: z.iso.datetime().nullable()
+    }).nullable()
+});
 /**
  * Create a dated commitment on a Feature-tracked Job scope. The date and condition object are required; condition.requirement_kind is required. Omission answers 400. The server chooses and owns the condition type and identity. A Quantity-tracked scope answers 422. No performed_by_user_id is required or accepted; audit records the authenticated user, or null for a company key.
  */
@@ -11727,6 +11814,69 @@ export const zUpdateArchivePath = z.object({
  * Success
  */
 export const zUpdateArchiveResponse = zProductionPlannedFeatureTaskResponseObject;
+export const zListPhasesPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    planned_feature_task_id: z.string()
+});
+export const zListPhasesQuery = z.object({
+    'filter[archived]': z.boolean().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListPhasesResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zProductionPhaseResponseObject)
+});
+export const zCreatePhaseBody = zProductionPhaseParameters;
+export const zCreatePhasePath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    planned_feature_task_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreatePhaseResponse = zProductionPhaseResponseObject;
+export const zGetPhasePath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    planned_feature_task_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetPhaseResponse = zProductionPhaseResponseObject;
+export const zUpdatePhaseBody = zProductionPhaseUpdateParameters;
+export const zUpdatePhasePath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    planned_feature_task_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdatePhaseResponse = zProductionPhaseResponseObject;
+export const zSetPhaseArchiveBody = zProductionPhaseArchiveParameters;
+export const zSetPhaseArchivePath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    planned_feature_task_id: z.string(),
+    phase_id: z.string()
+});
+/**
+ * Success
+ */
+export const zSetPhaseArchiveResponse = zProductionPhaseResponseObject;
 export const zListPlannedFeatureTasksPath = z.object({
     job_id: z.string(),
     job_scope_price_id: z.string()
@@ -15001,6 +15151,14 @@ export const zGetJobTimeCardDayPath = z.object({
  * Success
  */
 export const zGetJobTimeCardDayResponse = zJobTimeCardDayResponseObject;
+export const zUpdateJobTimeCardDayBody = zJobTimeCardDayUpdateParameters;
+export const zUpdateJobTimeCardDayPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateJobTimeCardDayResponse = zJobTimeCardDayResponseObject;
 export const zCreateManagerTimeEntryApprovalBody = zManagerTimeEntryApprovalParameters;
 export const zCreateManagerTimeEntryApprovalPath = z.object({
     time_entry_id: z.string()

package/package.json

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