@dsptch-work/api-client 0.4.0 → 0.6.0

package/dist/gen/types.gen.d.ts

@@ -21,6 +21,10 @@ export type Problem = {
      * A human-readable description of this occurrence. Not contractual — wording may change.
      */
     detail: string;
+    /**
+     * An opaque URN identifying this one occurrence of the failure, carrying the request's id. Quote it when correlating a failure with support or your logs.
+     */
+    instance?: string;
 };
 /**
  * Error types
@@ -160,6 +164,20 @@ export type Problem = {
  *
  * 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
@@ -264,6 +282,14 @@ export type Problem = {
  *
  * 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
@@ -281,7 +307,7 @@ export type Problem = {
  * Something failed on the server; nothing in the request needs fixing. Retry later, or report the problem if it persists.
  *
  */
-export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'insufficient_api_key_scope' | 'not_found' | 'recorded_since_termination' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'too_many_requests' | 'internal_error';
+export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'insufficient_api_key_scope' | 'not_found' | 'recorded_since_termination' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'precondition_required' | 'too_many_requests' | 'internal_error';
 export type ApiKeyScopeResponseObject = {
     resource: string;
     action: 'read' | 'create' | 'update' | 'delete';
@@ -2342,9 +2368,13 @@ export type JobResponseObject = {
      */
     tz_name: string;
     /**
-     * Whether workers must clock in to track time on this job; null when unset.
+     * Compatibility alias — true when clock_in_requirement is warning or required; always boolean.
+     */
+    require_clock_in: boolean;
+    /**
+     * Clock-in enforcement level: one of none (no guidance), warning (compliance warning on manual entries), or required (hard stop for technician web CUD and GraphQL owner CUD, including client-claimed punches, until a server-verified punch path exists; company-authed API v1 is intentionally ungated).
      */
-    require_clock_in: boolean | null;
+    clock_in_requirement: 'none' | 'warning' | 'required';
     /**
      * Human-readable job name, unique within the creating company; null when unset.
      */
@@ -2659,9 +2689,13 @@ export type JobParameters = {
     tz_name?: string;
     time_card_start_day?: TimeCardStartDay;
     /**
-     * Whether workers must clock in to track time on this job; null when unset.
+     * Compatibility alias — true ensures at least warning (never downgrades required); false or null clears to none; omit to leave unchanged. Prefer clock_in_requirement.
      */
     require_clock_in?: boolean | null;
+    /**
+     * Clock-in enforcement level: one of none (no guidance), warning (compliance warning on manual entries), or required (hard stop for technician web CUD and GraphQL owner CUD, including client-claimed punches, until a server-verified punch path exists; company-authed API v1 is intentionally ungated). Omit the field to leave the current value unchanged.
+     */
+    clock_in_requirement?: 'none' | 'warning' | 'required';
     /**
      * Whether to send geofence-based clock-in/out reminders for this job; null when unset.
      */
@@ -3070,7 +3104,7 @@ export type UserResponseObject = {
          */
         race?: Array<string> | null;
         /**
-         * Worker sex for demographic reporting: one of FEMALE, MALE, NON_BINARY, or NOT_SPECIFIED. Null when unset.
+         * Worker sex for demographic reporting: one of female, male, non_binary, or not_specified. Null when unset.
          */
         sex?: string | null;
         /**
@@ -3086,11 +3120,11 @@ export type UserResponseObject = {
          */
         drivers_license_number?: string | null;
         /**
-         * Veteran status per US Census definitions: one of PROTECTED_VETERAN, NOT_PROTECTED_VETERAN, RESERVES, GUARD, or NOT_SPECIFIED. Null when unset.
+         * Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified. Null when unset.
          */
         veteran_status?: string | null;
         /**
-         * Whether the worker is of Hispanic origin per US Census definitions: one of YES, NO, or NOT_SPECIFIED. Null when unset.
+         * Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified. Null when unset.
          */
         hispanic_origin?: string | null;
         /**
@@ -3359,7 +3393,7 @@ export type UserParameters = {
          */
         race?: Array<string> | null;
         /**
-         * Worker sex for demographic reporting: one of FEMALE, MALE, NON_BINARY, or NOT_SPECIFIED.
+         * Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
          */
         sex?: string | null;
         /**
@@ -3375,11 +3409,11 @@ export type UserParameters = {
          */
         drivers_license_number?: string | null;
         /**
-         * Veteran status per US Census definitions: one of PROTECTED_VETERAN, NOT_PROTECTED_VETERAN, RESERVES, GUARD, or NOT_SPECIFIED.
+         * Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified.
          */
         veteran_status?: string | null;
         /**
-         * Whether the worker is of Hispanic origin per US Census definitions: one of YES, NO, or NOT_SPECIFIED.
+         * Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified.
          */
         hispanic_origin?: string | null;
         /**
@@ -6832,11 +6866,11 @@ export type UserCertificationParameters = {
         /**
          * File name of the proof document, including its extension (for example "gwo-cert.pdf").
          */
-        name?: string;
+        name: string;
         /**
          * Base64-encoded contents of the proof document.
          */
-        content?: string;
+        content: string;
     } | null;
     /**
      * Whether DSPTCH has verified this held certification. Distinct from the verified flag on the certification definition itself.
@@ -7834,7 +7868,7 @@ export type AssetsVendorParameters = {
     logo_signed_id?: string;
 };
 /**
- * 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 type AssetsSiteResponseObject = {
     /**
@@ -7846,19 +7880,19 @@ export type AssetsSiteResponseObject = {
      */
     company_id: string;
     /**
-     * ID of the Atlas map site that backs this location; null for the mobile kinds (trailer, truck, van, and conex).
+     * ID of the Atlas map site that backs this location; null when the location is not on the map.
      */
     site_id: string | null;
     /**
-     * Physical container type: warehouse or yard (a fixed, Atlas-mapped location), or trailer, truck, van, or conex (a standalone mobile container).
+     * Location type: warehouse or yard.
      */
-    kind: 'warehouse' | 'yard' | 'trailer' | 'truck' | 'van' | 'conex';
+    kind: 'warehouse' | 'yard';
     /**
      * Display name for the location. Falls back to the backing Atlas site's name when not set directly, so it is always present.
      */
     name: string;
     /**
-     * Category of the backing Atlas site, taken from its site-type catalog; null for the mobile kinds. Read-only — derived from the backing site.
+     * Category of the backing Atlas site, taken from its site-type catalog; null when the location is not backed by a map site. Read-only — derived from the backing site.
      */
     site_type: string | null;
     /**
@@ -7872,36 +7906,33 @@ export type AssetsSiteResponseObject = {
 };
 export type AssetsSiteParameters = ({
     /**
-     * Physical container type: warehouse or yard (a fixed, Atlas-mapped location), or trailer, truck, van, or conex (a standalone mobile container).
-     */
-    kind: 'warehouse' | 'yard';
-    /**
-     * ID of the Atlas map site to back this location. Required for warehouse and yard; omit for the mobile kinds (trailer, truck, van, and conex), where any value sent is ignored.
+     * ID of the Atlas map site to back this location. Optional; omit for a standalone location that is not on the map.
      */
     site_id: string;
 } | {
     /**
-     * Physical container type: warehouse or yard (a fixed, Atlas-mapped location), or trailer, truck, van, or conex (a standalone mobile container).
-     */
-    kind: 'trailer' | 'truck' | 'van' | 'conex';
-    /**
-     * Display name for the location. Required for the mobile kinds; optional for warehouse and yard, which fall back to the backing Atlas site's name.
+     * Display name for the location. Required when no backing site_id is given; otherwise falls back to the backing Atlas site's name.
      */
     name: string;
 }) & {
     /**
-     * Physical container type: warehouse or yard (a fixed, Atlas-mapped location), or trailer, truck, van, or conex (a standalone mobile container).
+     * Location type: warehouse or yard.
      */
-    kind: 'warehouse' | 'yard' | 'trailer' | 'truck' | 'van' | 'conex';
+    kind: 'warehouse' | 'yard';
     /**
-     * ID of the Atlas map site to back this location. Required for warehouse and yard; omit for the mobile kinds (trailer, truck, van, and conex), where any value sent is ignored.
+     * ID of the Atlas map site to back this location. Optional; omit for a standalone location that is not on the map.
      */
     site_id?: string | null;
     /**
-     * Display name for the location. Required for the mobile kinds; optional for warehouse and yard, which fall back to the backing Atlas site's name.
+     * Display name for the location. Required when no backing site_id is given; otherwise falls back to the backing Atlas site's name.
      */
     name?: string | null;
 };
+export type AssetsSiteUpdateParameters = {
+    kind?: 'warehouse' | 'yard';
+    site_id?: string | null;
+    name?: string | null;
+};
 /**
  * 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.
  */
@@ -8300,7 +8331,7 @@ export type AssetsItemFormAssignmentParameters = {
             /**
              * ISO 8601 duration offset from the due time for the reminder (e.g. -PT1H for one hour before); must be one of the preset reminder times.
              */
-            offset?: string;
+            offset: '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';
         }>;
     };
 };
@@ -11494,7 +11525,7 @@ export type CreateSiteErrors = {
      */
     403: Problem;
     /**
-     * Unprocessable Content (site-backed kind missing site)
+     * Unprocessable Content (no backing site and no name)
      */
     422: Problem;
 };
@@ -11555,7 +11586,7 @@ export type GetAssetsSiteResponses = {
 };
 export type GetAssetsSiteResponse = GetAssetsSiteResponses[keyof GetAssetsSiteResponses];
 export type UpdateSiteData = {
-    body: AssetsSiteParameters;
+    body: AssetsSiteUpdateParameters;
     path: {
         id: string;
     };
@@ -13774,6 +13805,12 @@ export type CreateWageDeterminationResponses = {
 export type CreateWageDeterminationResponse = CreateWageDeterminationResponses[keyof CreateWageDeterminationResponses];
 export type DeleteWageDeterminationData = {
     body?: never;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this wage determination, or `*` to write against whatever exists. See "Version validators" in the API overview.
+         */
+        'If-Match': string;
+    };
     path: {
         job_id: string;
         uid: string;
@@ -13790,10 +13827,18 @@ export type DeleteWageDeterminationErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
     /**
      * Unprocessable Content
      */
     422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
 };
 export type DeleteWageDeterminationError = DeleteWageDeterminationErrors[keyof DeleteWageDeterminationErrors];
 export type DeleteWageDeterminationResponses = {
@@ -15612,6 +15657,10 @@ export type CreateCompanyUserDetailData = {
     url: '/api/v1/pwa/company_user_details';
 };
 export type CreateCompanyUserDetailErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -15749,11 +15798,11 @@ export type CreateFormAssignmentTaskData = {
             created_by_user_id: string;
             time_due?: string;
             tz_name?: string;
-            frequency?: string;
+            frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY';
             recurrence_end_time?: string;
             task_assignee_user_ids?: Array<string>;
             reminders_attributes?: Array<{
-                offset?: string;
+                offset: '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';
             }>;
         };
     };
@@ -16539,6 +16588,12 @@ export type ListTimecodeHistoryResponses = {
 export type ListTimecodeHistoryResponse = ListTimecodeHistoryResponses[keyof ListTimecodeHistoryResponses];
 export type CancelTimecodeScheduledChangesData = {
     body?: never;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this timecode, or `*` to write against whatever exists. See "Version validators" in the API overview.
+         */
+        'If-Match': string;
+    };
     path: {
         timecode_id: string;
     };
@@ -16554,10 +16609,18 @@ export type CancelTimecodeScheduledChangesErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
     /**
      * Unprocessable Content
      */
     422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
 };
 export type CancelTimecodeScheduledChangesError = CancelTimecodeScheduledChangesErrors[keyof CancelTimecodeScheduledChangesErrors];
 export type CancelTimecodeScheduledChangesResponses = {
@@ -16595,6 +16658,12 @@ export type ListTimecodeScheduledChangesResponses = {
 export type ListTimecodeScheduledChangesResponse = ListTimecodeScheduledChangesResponses[keyof ListTimecodeScheduledChangesResponses];
 export type ScheduleTimecodeChangeData = {
     body: TimecodeScheduledChangeParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this timecode, or `*` to write against whatever exists. See "Version validators" in the API overview.
+         */
+        'If-Match': string;
+    };
     path: {
         timecode_id: string;
     };
@@ -16614,10 +16683,18 @@ export type ScheduleTimecodeChangeErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
     /**
      * Unprocessable Content
      */
     422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
 };
 export type ScheduleTimecodeChangeError = ScheduleTimecodeChangeErrors[keyof ScheduleTimecodeChangeErrors];
 export type ScheduleTimecodeChangeResponses = {
@@ -16629,6 +16706,12 @@ export type ScheduleTimecodeChangeResponses = {
 export type ScheduleTimecodeChangeResponse = ScheduleTimecodeChangeResponses[keyof ScheduleTimecodeChangeResponses];
 export type CancelTimecodeScheduledTerminationData = {
     body?: never;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this timecode, or `*` to write against whatever exists. See "Version validators" in the API overview.
+         */
+        'If-Match': string;
+    };
     path: {
         timecode_id: string;
     };
@@ -16648,10 +16731,18 @@ export type CancelTimecodeScheduledTerminationErrors = {
      * Conflict
      */
     409: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
     /**
      * Unprocessable Content
      */
     422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
 };
 export type CancelTimecodeScheduledTerminationError = CancelTimecodeScheduledTerminationErrors[keyof CancelTimecodeScheduledTerminationErrors];
 export type CancelTimecodeScheduledTerminationResponses = {
@@ -16785,6 +16876,12 @@ export type GetTimecodeResponses = {
 export type GetTimecodeResponse = GetTimecodeResponses[keyof GetTimecodeResponses];
 export type UpdateTimecodeData = {
     body: TimecodeParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this timecode, or `*` to write against whatever exists. See "Version validators" in the API overview.
+         */
+        'If-Match': string;
+    };
     path: {
         /**
          * Unique identifier of the timecode.
@@ -16799,10 +16896,18 @@ export type UpdateTimecodeErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
     /**
      * Unprocessable Content
      */
     422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
 };
 export type UpdateTimecodeError = UpdateTimecodeErrors[keyof UpdateTimecodeErrors];
 export type UpdateTimecodeResponses = {
@@ -17673,6 +17778,10 @@ export type CancelUserCompanyScheduledTerminationErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
 };
 export type CancelUserCompanyScheduledTerminationError = CancelUserCompanyScheduledTerminationErrors[keyof CancelUserCompanyScheduledTerminationErrors];
 export type CancelUserCompanyScheduledTerminationResponses = {