@dsptch-work/api-client 0.38.0 → 0.39.0

package/dist/gen/zod.gen.js

@@ -262,7 +262,7 @@ export const zProblem = z.object({
  *
  * **Unparseable Date Value**
  *
- * A date-time value cannot be parsed, falls outside the storable range, or has no UTC offset where one is required. Format values as ISO 8601 (for example `2026-08-05` or `2026-08-05T14:30`); a time entry's `start_time` and `end_time`, a timestamp filter bound, and an `as_of[]` coordinate need an offset (for example `2026-08-05T14:30:00-04:00` or `2026-08-05T18:30:00Z`).
+ * A date or date-time value cannot be parsed, names a day that does not exist, falls outside the storable range, or has no UTC offset where one is required. Send a day as `2026-08-05` and an instant with its offset (`2026-08-05T14:30:00-04:00` or `2026-08-05T18:30:00Z`). The times of time entries and apprenticeship allocations, a compliance check's due time, a timecode correction's bounds, timestamp filter bounds, and `as_of[]` coordinates need the offset; a time sent without one is refused with the value to send.
  *
  * ### invalid_filter_value
  *
@@ -930,7 +930,7 @@ export const zApprenticeshipAllocationCreateParameters = z.object({
     apprenticeship_work_process_category_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).nullish(),
     minutes: z.int(),
     description: z.string().nullish(),
-    allocated_at: z.string().optional()
+    allocated_at: z.iso.datetime().optional()
 });
 /**
  * Correct an existing allocation's hours, work process category, description, or (for a standalone allocation) effective timestamp. The time card an allocation is linked to cannot be changed after creation. Any change that shifts progression rebuilds it and requests historical wage repricing in the background, including locked time cards.
@@ -939,7 +939,7 @@ export const zApprenticeshipAllocationUpdateParameters = z.object({
     apprenticeship_work_process_category_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).nullish(),
     minutes: z.int().optional(),
     description: z.string().nullish(),
-    allocated_at: z.string().optional()
+    allocated_at: z.iso.datetime().optional()
 });
 /**
  * Enroll a user as an apprentice under an employer in a program; the employing program-employer record is derived from the enrolling company and the program in the URL path. Apprentices cannot be updated through the API, only created. Omitting a required field answers 400; a null for a non-nullable field, a blank ID, a wrong JSON type, an unlisted status, or a date that is not a YYYY-MM-DD calendar date answers 422.
@@ -1095,7 +1095,7 @@ export const zApprenticeshipWageScheduleParameters = z.object({
     journeyworker_fringe_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
     end_wage_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).optional(),
     periods_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         period_number: z.int().gte(0).optional(),
         min_minutes: z.int().gte(0).nullish(),
         max_minutes: z.int().gte(0).nullish(),
@@ -1142,7 +1142,7 @@ export const zApprenticeshipWageScheduleUpdateParameters = z.object({
     journeyworker_fringe_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
     end_wage_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).optional(),
     periods_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         period_number: z.int().gte(0).optional(),
         min_minutes: z.int().gte(0).nullish(),
         max_minutes: z.int().gte(0).nullish(),
@@ -1554,7 +1554,7 @@ export const zAssetsProductParameters = z.object({
         assets_attribute_option_id: z.string().nullish()
     })).optional(),
     images_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         file: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         _destroy: z.boolean().optional()
     })).optional(),
@@ -1585,7 +1585,7 @@ export const zAssetsProductUpdateParameters = z.object({
         assets_attribute_option_id: z.string().nullish()
     })).optional(),
     images_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         file: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         _destroy: z.boolean().optional()
     })).optional()
@@ -1678,7 +1678,7 @@ export const zAssetsAttributeParameters = z.object({
         'select'
     ]),
     options: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         value: z.string().optional(),
         position: z.int().optional(),
         _destroy: z.boolean().optional()
@@ -1697,7 +1697,7 @@ export const zAssetsAttributeUpdateParameters = z.object({
         'select'
     ]).optional(),
     options: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         value: z.string().optional(),
         position: z.int().optional(),
         _destroy: z.boolean().optional()
@@ -1729,7 +1729,7 @@ export const zAssetsCategoryParameters = z.object({
     name: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/),
     parent_id: z.string().nullish(),
     category_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         assets_attribute_id: z.string().optional(),
         fillable_on: z.enum(['product', 'item']).optional(),
         required: z.boolean().optional(),
@@ -1744,7 +1744,7 @@ export const zAssetsCategoryUpdateParameters = z.object({
     name: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
     parent_id: z.string().nullish(),
     category_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         assets_attribute_id: z.string().optional(),
         fillable_on: z.enum(['product', 'item']).optional(),
         required: z.boolean().optional(),
@@ -1786,8 +1786,8 @@ export const zTimeCardPerDiemResponseObject = z.object({
     date: z.iso.date(),
     approver_user_id: z.string(),
     per_diem_id: z.string().nullable(),
-    per_diem_rate_cents: z.string().nullable(),
-    per_diem_currency: z.string().nullable(),
+    per_diem_rate_cents: z.string().nullish(),
+    per_diem_currency: z.string().nullish(),
     taxable: z.boolean(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
@@ -2416,8 +2416,8 @@ export const zJobCreateParameters = z.object({
         'none'
     ]).optional(),
     region: z.string().nullish(),
-    start_time: z.string().nullish(),
-    end_time: z.string().nullish(),
+    start_time: z.iso.date().nullish(),
+    end_time: z.iso.date().nullish(),
     tz_name: z.string().optional(),
     time_card_start_day: z.int().gte(0).lte(6).optional(),
     clock_in_requirement: z.enum([
@@ -2501,8 +2501,8 @@ export const zJobUpdateParameters = z.object({
         'none'
     ]).optional(),
     region: z.string().nullish(),
-    start_time: z.string().nullish(),
-    end_time: z.string().nullish(),
+    start_time: z.iso.date().nullish(),
+    end_time: z.iso.date().nullish(),
     tz_name: z.string().optional(),
     time_card_start_day: z.int().gte(0).lte(6).optional(),
     clock_in_requirement: z.enum([
@@ -2863,7 +2863,7 @@ export const zFormDefinitionObject = z.object({
     created_at: z.iso.datetime()
 });
 /**
- * A single form submission — a user's completed SurveyJS form with the resolved answers (the fuller show representation). Read-only; submissions are created in the app.
+ * A single form submission with resolved answers, returned by both show and create.
  */
 export const zFormSubmissionResponseObject = z.object({
     id: z.string(),
@@ -2880,6 +2880,15 @@ export const zFormSubmissionResponseObject = z.object({
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
+/**
+ * Create a submission using supported keys from the form definition's submission_shape. Requires a user-scoped API key.
+ */
+export const zFormSubmissionCreateParameters = z.object({
+    form_definition_id: z.string(),
+    user_id: z.string(),
+    json: z.record(z.string(), z.unknown()),
+    timezone: z.string().optional()
+});
 /**
  * Request body for updating a worker's employment at your company. Corrects administrative fields (employment type, title, manager, payroll id, hire date, and time-and-attendance enrollment) across the whole employment history, and changes the custom-field values it lists. For time-effective pay changes, use the scheduled-changes endpoints instead. A value of the wrong JSON type, a null for a field that is not nullable, or a value outside a listed set answers 422 at its pointer, and nothing is written.
  */
@@ -3389,10 +3398,10 @@ export const zTimeCardResponseObject = z.object({
         1.5: z.number(),
         2: z.number()
     }),
-    pay_cents: z.string(),
-    base_wage_pay_cents: z.string(),
-    one_five_x_adder_cents: z.string(),
-    two_x_adder_cents: z.string(),
+    pay_cents: z.string().optional(),
+    base_wage_pay_cents: z.string().optional(),
+    one_five_x_adder_cents: z.string().optional(),
+    two_x_adder_cents: z.string().optional(),
     region_ids: z.array(z.string())
 });
 /**
@@ -3425,10 +3434,10 @@ export const zJobTimeCardDayResponseObject = z.object({
         1.5: z.number(),
         2: z.number()
     }),
-    pay_cents: z.string(),
-    base_wage_pay_cents: z.string(),
-    one_five_x_adder_cents: z.string(),
-    two_x_adder_cents: z.string(),
+    pay_cents: z.string().optional(),
+    base_wage_pay_cents: z.string().optional(),
+    one_five_x_adder_cents: z.string().optional(),
+    two_x_adder_cents: z.string().optional(),
     region_ids: z.array(z.string()),
     cumulative_minutes_worked: z.int(),
     weekly_cumulative_minutes_worked: z.int(),
@@ -3470,14 +3479,14 @@ export const zJobTimeCardDayResponseObject = z.object({
         1.5: z.number(),
         2: z.number()
     }),
-    cumulative_pay_cents: z.string(),
-    weekly_cumulative_pay_cents: z.string(),
-    cumulative_base_wage_pay_cents: z.string(),
-    weekly_cumulative_base_wage_pay_cents: z.string(),
-    cumulative_one_five_x_adder_cents: z.string(),
-    weekly_cumulative_one_five_x_adder_cents: z.string(),
-    cumulative_two_x_adder_cents: z.string(),
-    weekly_cumulative_two_x_adder_cents: z.string(),
+    cumulative_pay_cents: z.string().optional(),
+    weekly_cumulative_pay_cents: z.string().optional(),
+    cumulative_base_wage_pay_cents: z.string().optional(),
+    weekly_cumulative_base_wage_pay_cents: z.string().optional(),
+    cumulative_one_five_x_adder_cents: z.string().optional(),
+    weekly_cumulative_one_five_x_adder_cents: z.string().optional(),
+    cumulative_two_x_adder_cents: z.string().optional(),
+    weekly_cumulative_two_x_adder_cents: z.string().optional(),
     cumulative_region_ids: z.array(z.string()),
     weekly_cumulative_region_ids: z.array(z.string()),
     created_at: z.iso.datetime(),
@@ -4392,7 +4401,7 @@ export const zComplianceCheckDetailResponseObject = z.object({
  */
 export const zComplianceCheckParameters = z.object({
     status: z.enum(['dismissed', 'pending']).optional(),
-    time_due: z.iso.date().nullish(),
+    time_due: z.iso.datetime().nullish(),
     assignee_user_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
     file_signed_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional()
 });
@@ -5689,8 +5698,8 @@ export const zJobResponseObject = z.object({
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime(),
     status: z.string(),
-    start_time: z.string().nullable(),
-    end_time: z.string().nullable(),
+    start_time: z.iso.date().nullable(),
+    end_time: z.iso.date().nullable(),
     purchase_order_number: z.string().nullable(),
     time_card_start_day: zTimeCardStartDay,
     tz_name: z.string(),
@@ -5988,7 +5997,7 @@ export const zFormDefinitionResponseObject = z.object({
     data: z.array(zFormDefinitionObject)
 });
 /**
- * A page of form submissions — the lighter list representation. A submission is a user's completed form; submissions are created in the app, so this API is read-only.
+ * A page of form submissions — the lighter list representation. A submission is a user's completed form, created in the app or through the API.
  */
 export const zFormSubmissionIndexObject = z.object({
     meta: zMeta,
@@ -7354,7 +7363,7 @@ export const zAssetsItemParameters = z.object({
         assets_attribute_option_id: z.string().nullish()
     })).optional(),
     images_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         file: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         _destroy: z.boolean().optional()
     })).optional(),
@@ -7383,7 +7392,7 @@ export const zAssetsItemUpdateParameters = z.object({
         assets_attribute_option_id: z.string().nullish()
     })).optional(),
     images_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         file: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         _destroy: z.boolean().optional()
     })).optional(),
@@ -7598,7 +7607,7 @@ export const zAssetsItemResponseObject = z.object({
     type: z.enum(['serial', 'bulk']),
     serial_number: z.string().nullable(),
     status: z.enum(['available', 'assigned']).nullable(),
-    purchase_date: z.iso.datetime().nullable(),
+    purchase_date: z.iso.date().nullable(),
     purchase_price_cents: z.string().nullable(),
     currency: z.string().nullable(),
     external_id: z.string().nullable(),
@@ -7995,7 +8004,7 @@ export const zAssetsServiceEventParameters = z.object({
     performed_on: z.iso.date(),
     assets_service_schedule_id: z.string().nullish(),
     attachments_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         file: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         _destroy: z.boolean().optional()
     })).optional(),
@@ -8014,7 +8023,7 @@ export const zAssetsServiceEventUpdateParameters = z.object({
     performed_on: z.iso.date().optional(),
     assets_service_schedule_id: z.string().nullish(),
     attachments_attributes: z.array(z.object({
-        id: z.string().optional(),
+        id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         file: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
         _destroy: z.boolean().optional()
     })).optional(),
@@ -10382,6 +10391,11 @@ export const zListFormSubmissionsQuery = z.object({
  * Success
  */
 export const zListFormSubmissionsResponse = zFormSubmissionIndexObject;
+export const zCreateFormSubmissionBody = zFormSubmissionCreateParameters;
+/**
+ * Created
+ */
+export const zCreateFormSubmissionResponse = zFormSubmissionResponseObject;
 export const zGetFormSubmissionPath = z.object({
     id: z.string()
 });

package/package.json

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