@dsptch-work/api-client 0.4.0 → 0.6.0

package/dist/gen/zod.gen.js

@@ -7,7 +7,8 @@ export const zProblem = z.object({
     type: z.url(),
     title: z.string(),
     status: z.int(),
-    detail: z.string()
+    detail: z.string(),
+    instance: z.url().optional()
 });
 /**
  * Error types
@@ -147,6 +148,20 @@ export const zProblem = z.object({
  *
  * Cancelling this timecode's scheduled termination would silently discard changes recorded since it was terminated. Re-read the timecode and reconcile before retrying.
  *
+ * ### version_overlap
+ *
+ * **Version Overlap**
+ *
+ * The write conflicts with what is already recorded for the resource — another version occupies the same span, or the write contradicts the resource's recorded identity. Re-read the current state and retry on top of it.
+ *
+ * ## 412
+ *
+ * ### precondition_failed
+ *
+ * **Precondition Failed**
+ *
+ * The `If-Match` validator names a version of this resource that is no longer current — the version family changed after you read it. Re-read the resource, take its fresh `ETag`, and reapply your change on top of the current state. A malformed or unrecognizable validator refuses the same way, since neither matches.
+ *
  * ## 422
  *
  * ### attachment_not_image
@@ -251,6 +266,14 @@ export const zProblem = z.object({
  *
  * The apprentice's wage schedule does not belong to the program in the URL. Use a schedule from that program.
  *
+ * ## 428
+ *
+ * ### precondition_required
+ *
+ * **Precondition Required**
+ *
+ * The write must state which version of the resource it was composed against, and no `If-Match` was sent. Read the resource, send its `ETag` back as `If-Match`, or send `If-Match: *` to write unconditionally against whatever exists.
+ *
  * ## 429
  *
  * ### too_many_requests
@@ -289,6 +312,8 @@ export const zProblemTypeCatalog = z.enum([
     'insufficient_api_key_scope',
     'not_found',
     'recorded_since_termination',
+    'version_overlap',
+    'precondition_failed',
     'attachment_not_image',
     'company_not_employer',
     'confirm_apprenticeship_conflict',
@@ -306,6 +331,7 @@ export const zProblemTypeCatalog = z.enum([
     'user_not_company_member',
     'validation_failed',
     'wage_schedule_outside_program',
+    'precondition_required',
     'too_many_requests',
     'internal_error'
 ]);
@@ -1687,6 +1713,11 @@ export const zJobParameters = z.object({
     tz_name: z.string().optional(),
     time_card_start_day: zTimeCardStartDay.optional(),
     require_clock_in: z.boolean().nullish(),
+    clock_in_requirement: z.enum([
+        'none',
+        'warning',
+        'required'
+    ]).optional(),
     send_geofence_reminders: z.boolean().nullish(),
     allow_customer_access: z.boolean().optional(),
     timekeeping_timecode_ids: z.array(z.string()).nullish(),
@@ -2834,8 +2865,8 @@ export const zUserCertificationParameters = z.object({
     certification_id: z.string(),
     received_at: z.iso.datetime(),
     file: z.object({
-        name: z.string().optional(),
-        content: z.string().optional()
+        name: z.string().max(255).regex(/^[\w\s.-]*\.[A-Za-z0-9]+$/),
+        content: z.string()
     }).nullish(),
     verified: z.boolean().nullish(),
     expiration_date: z.iso.date().nullish(),
@@ -2888,7 +2919,12 @@ export const zJobResponseObject = z.object({
     purchase_order_number: z.string().nullable(),
     time_card_start_day: zTimeCardStartDay,
     tz_name: z.string(),
-    require_clock_in: z.boolean().nullable(),
+    require_clock_in: z.boolean(),
+    clock_in_requirement: z.enum([
+        'none',
+        'warning',
+        'required'
+    ]),
     name: z.string().nullable(),
     federal_pwa_mode: z.enum([
         'all',
@@ -3778,20 +3814,13 @@ export const zAssetsVendorParameters = z.object({
     logo_signed_id: z.string().optional()
 });
 /**
- * A physical container that holds a company's assets and inventory — either a fixed, Atlas-mapped location (warehouse or yard) or a standalone mobile container (trailer, truck, van, or conex).
+ * A location that holds a company's assets and inventory — a warehouse or yard, optionally backed by a site on the Atlas map.
  */
 export const zAssetsSiteResponseObject = z.object({
     id: z.string(),
     company_id: z.string(),
     site_id: z.string().nullable(),
-    kind: z.enum([
-        'warehouse',
-        'yard',
-        'trailer',
-        'truck',
-        'van',
-        'conex'
-    ]),
+    kind: z.enum(['warehouse', 'yard']),
     name: z.string(),
     site_type: z.string().nullable(),
     created_at: z.iso.datetime(),
@@ -3799,30 +3828,21 @@ export const zAssetsSiteResponseObject = z.object({
 });
 export const zAssetsSiteParameters = z.intersection(z.union([
     z.object({
-        kind: z.enum(['warehouse', 'yard']),
-        site_id: z.string()
+        site_id: z.string().min(1)
     }),
     z.object({
-        kind: z.enum([
-            'trailer',
-            'truck',
-            'van',
-            'conex'
-        ]),
-        name: z.string()
+        name: z.string().min(1)
     })
 ]), z.object({
-    kind: z.enum([
-        'warehouse',
-        'yard',
-        'trailer',
-        'truck',
-        'van',
-        'conex'
-    ]),
+    kind: z.enum(['warehouse', 'yard']),
     site_id: z.string().nullish(),
     name: z.string().nullish()
 }));
+export const zAssetsSiteUpdateParameters = z.object({
+    kind: z.enum(['warehouse', 'yard']).optional(),
+    site_id: z.string().nullish(),
+    name: z.string().nullish()
+});
 /**
  * A company-level rule that auto-generates asset form assignments. When an item of one of its products changes custody (an assignment or unassignment), the rule creates or refreshes a form task for the chosen users, due on the configured schedule.
  */
@@ -4143,7 +4163,44 @@ export const zAssetsItemFormAssignmentParameters = z.object({
         recurrence_end_time: z.iso.datetime().nullish(),
         task_assignee_user_ids: z.array(z.string()).optional(),
         reminders_attributes: z.array(z.object({
-            offset: z.string().optional()
+            offset: z.enum([
+                'PT0S',
+                'PT-1M',
+                'PT-5M',
+                'PT-10M',
+                'PT-15M',
+                'PT-30M',
+                'PT-1H',
+                'PT-2H',
+                'P-1D',
+                'P-2D',
+                'P-3D',
+                'P-4D',
+                'P-5D',
+                'P-6D',
+                'P-1W',
+                'P-2W',
+                'P-1M',
+                'P-2M',
+                'P-3M',
+                'P-6M',
+                'P-1Y',
+                'PT5M',
+                'PT15M',
+                'PT30M',
+                'PT1H',
+                'PT6H',
+                'PT12H',
+                'P1D',
+                'P2D',
+                'P3D',
+                'P4D',
+                'P5D',
+                'P6D',
+                'P1W',
+                'P2W',
+                'P3W'
+            ])
         })).optional()
     })
 });
@@ -5295,7 +5352,7 @@ export const zGetAssetsSitePath = z.object({
  * Success
  */
 export const zGetAssetsSiteResponse = zAssetsSiteResponseObject;
-export const zUpdateSiteBody = zAssetsSiteParameters;
+export const zUpdateSiteBody = zAssetsSiteUpdateParameters;
 export const zUpdateSitePath = z.object({
     id: z.string()
 });
@@ -5999,6 +6056,9 @@ export const zCreateWageDeterminationPath = z.object({
  * Created
  */
 export const zCreateWageDeterminationResponse = zJobWageDeterminationResponseObject;
+export const zDeleteWageDeterminationHeaders = z.object({
+    'If-Match': z.string()
+});
 export const zDeleteWageDeterminationPath = z.object({
     job_id: z.string(),
     uid: z.string()
@@ -6596,11 +6656,56 @@ export const zCreateFormAssignmentTaskBody = z.object({
         created_by_user_id: z.string(),
         time_due: z.string().optional(),
         tz_name: z.string().optional(),
-        frequency: z.string().optional(),
+        frequency: z.enum([
+            'DAILY',
+            'WORKDAILY',
+            'WORKDAILYSIX',
+            'WEEKLY',
+            'BIWEEKLY',
+            'MONTHLY',
+            'QUARTERLY'
+        ]).optional(),
         recurrence_end_time: z.string().optional(),
         task_assignee_user_ids: z.array(z.string()).optional(),
         reminders_attributes: z.array(z.object({
-            offset: z.string().optional()
+            offset: z.enum([
+                'PT0S',
+                'PT-1M',
+                'PT-5M',
+                'PT-10M',
+                'PT-15M',
+                'PT-30M',
+                'PT-1H',
+                'PT-2H',
+                'P-1D',
+                'P-2D',
+                'P-3D',
+                'P-4D',
+                'P-5D',
+                'P-6D',
+                'P-1W',
+                'P-2W',
+                'P-1M',
+                'P-2M',
+                'P-3M',
+                'P-6M',
+                'P-1Y',
+                'PT5M',
+                'PT15M',
+                'PT30M',
+                'PT1H',
+                'PT6H',
+                'PT12H',
+                'P1D',
+                'P2D',
+                'P3D',
+                'P4D',
+                'P5D',
+                'P6D',
+                'P1W',
+                'P2W',
+                'P3W'
+            ])
         })).optional()
     })
 });
@@ -6844,6 +6949,9 @@ export const zListTimecodeHistoryResponse = z.object({
     links: zLinks.optional(),
     data: z.array(zTimecodeHistoryVersionObject).optional()
 });
+export const zCancelTimecodeScheduledChangesHeaders = z.object({
+    'If-Match': z.string()
+});
 export const zCancelTimecodeScheduledChangesPath = z.object({
     timecode_id: z.string()
 });
@@ -6859,6 +6967,9 @@ export const zListTimecodeScheduledChangesPath = z.object({
  */
 export const zListTimecodeScheduledChangesResponse = z.array(zTimecodeResponseObject);
 export const zScheduleTimecodeChangeBody = zTimecodeScheduledChangeParameters;
+export const zScheduleTimecodeChangeHeaders = z.object({
+    'If-Match': z.string()
+});
 export const zScheduleTimecodeChangePath = z.object({
     timecode_id: z.string()
 });
@@ -6866,6 +6977,9 @@ export const zScheduleTimecodeChangePath = z.object({
  * Created
  */
 export const zScheduleTimecodeChangeResponse = zTimecodeResponseObject;
+export const zCancelTimecodeScheduledTerminationHeaders = z.object({
+    'If-Match': z.string()
+});
 export const zCancelTimecodeScheduledTerminationPath = z.object({
     timecode_id: z.string()
 });
@@ -6914,6 +7028,9 @@ export const zGetTimecodeQuery = z.object({
  */
 export const zGetTimecodeResponse = zTimecodeResponseObject;
 export const zUpdateTimecodeBody = zTimecodeParameters;
+export const zUpdateTimecodeHeaders = z.object({
+    'If-Match': z.string()
+});
 export const zUpdateTimecodePath = z.object({
     id: z.string()
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsptch-work/api-client",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",
@@ -61,9 +61,12 @@
   },
   "scripts": {
     "generate": "openapi-ts",
+    "prebuild": "node ../../bin/generate-api-clients.mjs --only public",
     "build": "tsc -p tsconfig.build.json",
+    "pretypecheck": "node ../../bin/generate-api-clients.mjs --only public",
     "typecheck": "tsc --noEmit",
     "lint:package": "publint",
+    "pretest": "node ../../bin/generate-api-clients.mjs --only public",
     "test": "vitest run",
     "test:watch": "vitest"
   },