@dsptch-work/api-client 0.42.0 → 0.43.0

package/dist/gen/zod.gen.js

@@ -238,7 +238,7 @@ export const zProblem = z.object({
  *
  * **Certified Payroll Format Unavailable**
  *
- * The named job does not offer this certified payroll format. WH-347 is available only on a job that tracks federal prevailing wage. Use a job that offers the format.
+ * The named job does not offer this certified payroll format. Each format is available only on a job that tracks the matching prevailing-wage jurisdiction. Use a job that offers the format.
  *
  * ### company_not_employer
  *
@@ -5240,6 +5240,44 @@ export const zJobGoodFaithEffortExceptionUpdateParameters = z.object({
     no_availability_proof_signed_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
     performed_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional()
 });
+/**
+ * A job-scoped CA DIR eCPR XML certified-payroll export. The generation handle is polled through this same document; `file` is null until an XML or ZIP is attached. Signing fields are not published. This format has no form version.
+ */
+export const zJobCaEcprXmlExportResponseObject = z.object({
+    id: z.string(),
+    job_id: z.string(),
+    start_date: z.iso.date(),
+    end_date: z.iso.date(),
+    status: z.enum([
+        'pending',
+        'processing',
+        'signing',
+        'signed',
+        'certifying',
+        'success',
+        'failed'
+    ]),
+    file: z.object({
+        filename: z.string(),
+        content_type: z.string().nullable(),
+        byte_size: z.int(),
+        url: z.string()
+    }).nullable(),
+    invalidated_at: z.iso.datetime().nullable(),
+    invalidation_reason: z.enum([
+        'source_data_changed',
+        'source_records_deleted',
+        'ratio_status_changed'
+    ]).nullable(),
+    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.
+ */
+export const zJobCaEcprXmlExportCreateParameters = z.object({
+    start_date: z.iso.date(),
+    end_date: z.iso.date()
+});
 /**
  * A job-scoped WH-347 certified-payroll export. The generation handle is polled through this same document; `file` is null until a ZIP is attached. Signing fields are not published.
  */
@@ -5873,6 +5911,101 @@ export const zProductionJobScopePriceResponseObject = z.object({
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
+/**
+ * Add one named intention. Re-adding a retained pair preserves omitted metadata and restores its membership.
+ */
+export const zProductionPlannedFeatureTaskParameters = z.object({
+    name: z.string().optional(),
+    description: z.string().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(),
+    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(),
+    feature_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)
+});
+/**
+ * Edit only intended Task metadata, preserving every omitted field and the original creator.
+ */
+export const zProductionPlannedFeatureTaskUpdateParameters = z.object({
+    name: z.string().optional(),
+    description: z.string().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(),
+    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()
+});
+/**
+ * Set retained membership idempotently, without removing the pair, its Task or actual evidence.
+ */
+export const zProductionPlannedFeatureTaskArchiveParameters = 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()
+});
+/**
+ * One retained scope/Feature intention and its optional intended metadata. Actual Completion remains the sole production evidence.
+ */
+export const zProductionPlannedFeatureTaskResponseObject = z.object({
+    id: z.string(),
+    production_job_scope_price_id: z.string(),
+    feature_id: z.string(),
+    task_id: z.string(),
+    production_completion_id: z.string().nullable(),
+    archived_at: z.iso.datetime().nullable(),
+    name: z.string(),
+    description: z.string(),
+    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()
+});
+/**
+ * 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.
+ */
+export const zProductionDeliveryTargetParameters = z.object({
+    due_date: z.iso.date(),
+    condition_attributes: z.object({
+        requirement_kind: z.enum(['count', 'all']),
+        required_count: z.int().gte(1).nullish()
+    })
+});
+/**
+ * Change a target's date or whole-service rule. Omitted fields retain their current values, including required_count when changing modes. Send required_count null when switching count to all; send a positive count when switching all to count. The server preserves target and condition identities. Null date, condition object or requirement kind answers 422. A rejected write changes neither record.
+ */
+export const zProductionDeliveryTargetUpdateParameters = z.object({
+    due_date: z.iso.date().optional(),
+    condition_attributes: z.object({
+        requirement_kind: z.enum(['count', 'all']).optional(),
+        required_count: z.int().gte(1).nullish()
+    }).optional()
+});
+/**
+ * A scope-owned target and current assessment. No Feature identities, private counts or prices are exposed. Assessments use current named membership and effective actual work dates, rather than Task completion flags or filing times.
+ */
+export const zProductionDeliveryTargetResponseObject = z.object({
+    id: z.string(),
+    production_job_scope_price_id: z.string(),
+    due_date: z.iso.date(),
+    condition: z.object({
+        requirement_kind: z.enum(['count', 'all']),
+        required_count: z.int().nullable()
+    }),
+    assessment: z.object({
+        required_total: z.int().nullable(),
+        qualifying_count: z.int().nullable(),
+        current_achieved_count: z.int().nullable(),
+        shortfall: z.int().nullable(),
+        state: z.enum([
+            'unavailable',
+            'awaiting_named_scope',
+            'met_by_date',
+            'remaining_before_deadline',
+            'shortfall_after_deadline'
+        ])
+    }),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
 /**
  * Record a completion against a scope price. The server takes the completable subtype from the production tracking kind of the scope price's job, never from the request: a feature-tracked job records which feature was completed, and a quantity-tracked job how many units were completed. completable_attributes declares both kinds' keys; sending the other kind's key answers 422 subtype_foreign_keys with an entry pointing at it, and nothing is written.
  */
@@ -5898,6 +6031,12 @@ export const zProductionCompletionUpdateParameters = z.object({
         quantity_completed: z.int().gte(1).optional()
     }).optional()
 });
+/**
+ * Explicit retained Feature lifecycle command. Both states are idempotent; Quantity withdrawal and restoration return 422.
+ */
+export const zProductionCompletionWithdrawalParameters = z.object({
+    withdrawn: z.boolean()
+});
 /**
  * A completion recorded on a feature-tracked job — a unit of scoped work finished by a crew, identifying which feature was completed.
  */
@@ -5915,7 +6054,8 @@ export const zProductionFeatureCompletionResponseObject = z.object({
     feature_id: z.string(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime(),
-    work_date: z.iso.date()
+    work_date: z.iso.date(),
+    withdrawn_at: z.iso.datetime().nullable()
 });
 /**
  * A completion recorded on a quantity-tracked job — a unit of scoped work finished by a crew, counting how many units were completed.
@@ -5934,7 +6074,8 @@ export const zProductionQuantityCompletionResponseObject = z.object({
     quantity_completed: z.int(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime(),
-    work_date: z.iso.date()
+    work_date: z.iso.date(),
+    withdrawn_at: z.iso.datetime().nullable()
 });
 /**
  * A recorded production completion. The completable_type discriminator selects the feature-tracked or quantity-tracked representation.
@@ -6536,6 +6677,14 @@ export const zJobGoodFaithEffortExceptionsResponseObject = z.object({
     links: zLinks,
     data: z.array(zJobGoodFaithEffortExceptionResponseObject)
 });
+/**
+ * A page of a job's CA DIR eCPR XML certified-payroll exports, with pagination metadata and navigation links.
+ */
+export const zJobCaEcprXmlExportsResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zJobCaEcprXmlExportResponseObject)
+});
 /**
  * A page of a job's WH-347 certified-payroll exports, with pagination metadata and navigation links.
  */
@@ -11058,6 +11207,118 @@ export const zUpdateJobFormAssignmentTaskPath = z.object({
  * Success
  */
 export const zUpdateJobFormAssignmentTaskResponse = zJobFormAssignmentResponseObject;
+export const zListDeliveryTargetsPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string()
+});
+export const zListDeliveryTargetsQuery = z.object({
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListDeliveryTargetsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zProductionDeliveryTargetResponseObject)
+});
+export const zCreateDeliveryTargetBody = zProductionDeliveryTargetParameters;
+export const zCreateDeliveryTargetPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateDeliveryTargetResponse = zProductionDeliveryTargetResponseObject;
+export const zDeleteDeliveryTargetPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteDeliveryTargetResponse = z.void();
+export const zGetDeliveryTargetPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetDeliveryTargetResponse = zProductionDeliveryTargetResponseObject;
+export const zUpdateDeliveryTargetBody = zProductionDeliveryTargetUpdateParameters;
+export const zUpdateDeliveryTargetPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateDeliveryTargetResponse = zProductionDeliveryTargetResponseObject;
+export const zUpdateArchiveBody = zProductionPlannedFeatureTaskArchiveParameters;
+export const zUpdateArchivePath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    planned_feature_task_id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateArchiveResponse = zProductionPlannedFeatureTaskResponseObject;
+export const zListPlannedFeatureTasksPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string()
+});
+export const zListPlannedFeatureTasksQuery = 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 zListPlannedFeatureTasksResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zProductionPlannedFeatureTaskResponseObject)
+});
+export const zCreatePlannedFeatureTaskBody = zProductionPlannedFeatureTaskParameters;
+export const zCreatePlannedFeatureTaskPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreatePlannedFeatureTaskResponse = zProductionPlannedFeatureTaskResponseObject;
+export const zGetPlannedFeatureTaskPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetPlannedFeatureTaskResponse = zProductionPlannedFeatureTaskResponseObject;
+export const zUpdatePlannedFeatureTaskBody = zProductionPlannedFeatureTaskUpdateParameters;
+export const zUpdatePlannedFeatureTaskPath = z.object({
+    job_id: z.string(),
+    job_scope_price_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdatePlannedFeatureTaskResponse = zProductionPlannedFeatureTaskResponseObject;
 export const zListJobScopePricesPath = z.object({
     job_id: z.string()
 });
@@ -11161,6 +11422,37 @@ export const zUpdateGoodFaithEffortExceptionPath = z.object({
  * Success
  */
 export const zUpdateGoodFaithEffortExceptionResponse = zJobGoodFaithEffortExceptionResponseObject;
+export const zListCaEcprXmlExportsPath = z.object({
+    job_id: z.string()
+});
+export const zListCaEcprXmlExportsQuery = z.object({
+    'filter[status]': z.string().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 zListCaEcprXmlExportsResponse = zJobCaEcprXmlExportsResponseObject;
+export const zCreateCaEcprXmlExportBody = zJobCaEcprXmlExportCreateParameters;
+export const zCreateCaEcprXmlExportPath = z.object({
+    job_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateCaEcprXmlExportResponse = zJobCaEcprXmlExportResponseObject;
+export const zGetCaEcprXmlExportPath = z.object({
+    job_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetCaEcprXmlExportResponse = zJobCaEcprXmlExportResponseObject;
 export const zListWh347ExportsPath = z.object({
     job_id: z.string()
 });
@@ -12904,6 +13196,41 @@ export const zUpdatePositionFunctionPath = z.object({
  * Success
  */
 export const zUpdatePositionFunctionResponse = zPositionFunctionResponseObject;
+export const zListCompletionHistoryQuery = z.object({
+    'filter[job_id]': z.string().optional(),
+    'filter[scope_kind]': z.string().optional(),
+    'filter[feature_id]': z.string().optional(),
+    'filter[work_date][gte]': z.iso.date().optional(),
+    'filter[work_date][lte]': z.iso.date().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 zListCompletionHistoryResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zProductionCompletionResponseObject)
+});
+export const zGetCompletionHistoryPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetCompletionHistoryResponse = zProductionCompletionResponseObject;
+export const zSetCompletionWithdrawalBody = zProductionCompletionWithdrawalParameters;
+export const zSetCompletionWithdrawalPath = z.object({
+    completion_id: z.string()
+});
+/**
+ * Success
+ */
+export const zSetCompletionWithdrawalResponse = zProductionCompletionResponseObject;
 export const zListCompletionsQuery = z.object({
     'filter[job_id]': z.string().optional(),
     'filter[scope_kind]': z.string().optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsptch-work/api-client",
-  "version": "0.42.0",
+  "version": "0.43.0",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",
@@ -51,11 +51,11 @@
     "access": "public"
   },
   "dependencies": {
-    "zod": "^4.4.3"
+    "zod": "^4.6.7"
   },
   "devDependencies": {
     "@hey-api/openapi-ts": "^0.99.0",
-    "publint": "^0.3.22",
+    "publint": "^0.3.25",
     "typescript": "^6.0.3",
     "vitest": "^5.0.2"
   },