@dsptch-work/api-client 0.38.0 → 0.39.0

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

@@ -287,7 +287,7 @@ export type Problem = {
  *
  * **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
  *
@@ -1479,7 +1479,7 @@ export type ApprenticeshipAllocationCreateParameters = {
      */
     description?: string | null;
     /**
-     * Effective timestamp for the credited hours, as ISO 8601 with an explicit UTC offset or Z. Optional for a standalone allocation, defaulting to now, and null is rejected; must equal the linked time card's pay-period start when one is supplied. The employer-local date must be today or earlier.
+     * Effective timestamp for the credited hours, as a date-time with a UTC offset (`Z` or `-04:00`). Optional for a standalone allocation, defaulting to now; must equal the linked time card's pay-period start when one is supplied. The employer-local date must be today or earlier. A time without an offset answers 422 invalid_date at its pointer, showing the time fixed with the offset of the employer's time zone and in UTC. Null or a non-string answers 422 at its pointer; a string that does not parse as a date and time answers 422 invalid_date.
      */
     allocated_at?: string;
 };
@@ -1500,7 +1500,7 @@ export type ApprenticeshipAllocationUpdateParameters = {
      */
     description?: string | null;
     /**
-     * Effective timestamp for the credited hours, as ISO 8601 with an explicit UTC offset or Z. Optional; omission leaves the timestamp unchanged, and null is rejected. The employer-local date must be today or earlier and may predate enrollment. Time-card-linked allocations cannot be date-corrected. An unchanged timestamp does not request repricing.
+     * Effective timestamp for the credited hours, as a date-time with a UTC offset (`Z` or `-04:00`). Optional; omission leaves the timestamp unchanged. The employer-local date must be today or earlier and may predate enrollment. Time-card-linked allocations cannot be date-corrected. An unchanged timestamp does not request repricing. A time without an offset answers 422 invalid_date at its pointer, showing the time fixed with the offset of the employer's time zone and in UTC. Null or a non-string answers 422 at its pointer; a string that does not parse as a date and time answers 422 invalid_date.
      */
     allocated_at?: string;
 };
@@ -1862,7 +1862,7 @@ export type ApprenticeshipWageScheduleParameters = {
          */
         fringe_cents?: string | null;
         /**
-         * Set to true, together with the period's id, to remove that period from the schedule.
+         * Set to true, together with the period's id, to remove that period from the schedule. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -1948,7 +1948,7 @@ export type ApprenticeshipWageScheduleUpdateParameters = {
          */
         fringe_cents?: string | null;
         /**
-         * Set to true, together with the period's id, to remove that period from the schedule.
+         * Set to true, together with the period's id, to remove that period from the schedule. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -2908,7 +2908,7 @@ export type AssetsProductParameters = {
          */
         file?: string;
         /**
-         * Set true to remove the attachment named by id.
+         * Set true to remove the attachment named by id. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -2995,7 +2995,7 @@ export type AssetsProductUpdateParameters = {
          */
         file?: string;
         /**
-         * Set true to remove the attachment named by id.
+         * Set true to remove the attachment named by id. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -3227,7 +3227,7 @@ export type AssetsAttributeParameters = {
          */
         position?: number;
         /**
-         * Set true to remove this entry.
+         * Set true to remove this entry. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -3261,7 +3261,7 @@ export type AssetsAttributeUpdateParameters = {
          */
         position?: number;
         /**
-         * Set true to remove this entry.
+         * Set true to remove this entry. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -3361,7 +3361,7 @@ export type AssetsCategoryParameters = {
          */
         position?: number;
         /**
-         * Set true to remove this entry.
+         * Set true to remove this entry. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -3403,7 +3403,7 @@ export type AssetsCategoryUpdateParameters = {
          */
         position?: number;
         /**
-         * Set true to remove this entry.
+         * Set true to remove this entry. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -3488,13 +3488,13 @@ export type TimeCardPerDiemResponseObject = {
      */
     per_diem_id: string | null;
     /**
-     * Allowance amount in integer cents, as a string; snapshotted from the catalog per diem when saved (0 when none). Null when unset.
+     * Allowance amount in integer cents, as a string; snapshotted from the catalog per diem when saved (0 when none). Null when unset. Omitted when the caller may see the time card but not its money.
      */
-    per_diem_rate_cents: string | null;
+    per_diem_rate_cents?: string | null;
     /**
-     * ISO 4217 currency code for the rate; snapshotted from the catalog per diem. Null when unset.
+     * ISO 4217 currency code for the rate; snapshotted from the catalog per diem. Null when unset. Omitted when the caller may see the time card but not its money.
      */
-    per_diem_currency: string | null;
+    per_diem_currency?: string | null;
     /**
      * Whether the allowance is treated as taxable income; snapshotted from the catalog per diem.
      */
@@ -4368,7 +4368,7 @@ export type JobResponseObject = {
      */
     description: string;
     /**
-     * The job's scheduled time window as a timestamp range; null when unscheduled. Its bounds are also exposed individually as start_time and end_time.
+     * The job's scheduled time window as a timestamp range; null when unscheduled. start_time and end_time name the days it spans in tz_name.
      */
     scheduled_time: string | null;
     /**
@@ -4384,11 +4384,11 @@ export type JobResponseObject = {
      */
     status: string;
     /**
-     * Start of the job's scheduled window (ISO 8601), the lower bound of scheduled_time; null when unscheduled.
+     * The job's first day, as a calendar date (`YYYY-MM-DD`) in tz_name; the schedule starts at the start of that day there, the same as the web. Null when unscheduled.
      */
     start_time: string | null;
     /**
-     * End of the job's scheduled window (ISO 8601), the upper bound of scheduled_time; null when unscheduled.
+     * The job's last day, as a calendar date (`YYYY-MM-DD`) in tz_name; the schedule ends at the end of that day there, the same as the web. Null when unscheduled.
      */
     end_time: string | null;
     /**
@@ -4673,11 +4673,11 @@ export type JobCreateParameters = {
      */
     region?: string | null;
     /**
-     * Start of the job's scheduled window (ISO 8601); the date is anchored to the start of that day in tz_name. Null to leave the job unscheduled; any other non-string, false included, answers 422.
+     * The job's first day, as a calendar date (`YYYY-MM-DD`) in tz_name, stored as the start of that day there, the same as the web. Null to leave the job unscheduled. A date-time answers 422 naming the day to send; a blank, any other non-date, or a non-string answers 422.
      */
     start_time?: string | null;
     /**
-     * End of the job's scheduled window (ISO 8601); the date is anchored to the start of that day in tz_name. Null to leave the job unscheduled; any other non-string, false included, answers 422.
+     * The job's last day, as a calendar date (`YYYY-MM-DD`) in tz_name, stored as the end of that day there, the same as the web. Null to leave the job unscheduled. A date-time answers 422 naming the day to send; a blank, any other non-date, or a non-string answers 422.
      */
     end_time?: string | null;
     /**
@@ -4914,11 +4914,11 @@ export type JobUpdateParameters = {
      */
     region?: string | null;
     /**
-     * Start of the job's scheduled window (ISO 8601); the date is anchored to the start of that day in tz_name. Null to leave the job unscheduled; any other non-string, false included, answers 422.
+     * The job's first day, as a calendar date (`YYYY-MM-DD`) in tz_name, stored as the start of that day there, the same as the web. Null to leave the job unscheduled. A date-time answers 422 naming the day to send; a blank, any other non-date, or a non-string answers 422.
      */
     start_time?: string | null;
     /**
-     * End of the job's scheduled window (ISO 8601); the date is anchored to the start of that day in tz_name. Null to leave the job unscheduled; any other non-string, false included, answers 422.
+     * The job's last day, as a calendar date (`YYYY-MM-DD`) in tz_name, stored as the end of that day there, the same as the web. Null to leave the job unscheduled. A date-time answers 422 naming the day to send; a blank, any other non-date, or a non-string answers 422.
      */
     end_time?: string | null;
     /**
@@ -6081,7 +6081,7 @@ export type FormDefinitionResponseObject = {
     data: Array<FormDefinitionObject>;
 };
 /**
- * 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 type FormSubmissionIndexObject = {
     meta: Meta;
@@ -6113,7 +6113,7 @@ export type FormSubmissionIndexObject = {
     }>;
 };
 /**
- * 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 type FormSubmissionResponseObject = {
     /**
@@ -6168,6 +6168,29 @@ export type FormSubmissionResponseObject = {
      */
     updated_at: string;
 };
+/**
+ * Create a submission using supported keys from the form definition's submission_shape. Requires a user-scoped API key.
+ */
+export type FormSubmissionCreateParameters = {
+    /**
+     * ID of an active, non-archived form definition. Read its detail endpoint before building answers.
+     */
+    form_definition_id: string;
+    /**
+     * UUID of the key's own user, who must be a current member of the key's company. Missing or unauthorized users return 403.
+     */
+    user_id: string;
+    /**
+     * Answer object keyed by SurveyJS valueName when set, otherwise name. Use question choice values and GlobalIDs for DSPTCH reference questions. Missing or null returns 422. The API validates recursive structure and primitive types. Choice fields accept strings, which are stored unchanged. Choice membership, required answers, dates, and SurveyJS logic are not validated.
+     */
+    json: {
+        [key: string]: unknown;
+    };
+    /**
+     * Optional IANA timezone such as America/Chicago; defaults to UTC.
+     */
+    timezone?: string;
+};
 /**
  * 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.
  */
@@ -7206,21 +7229,21 @@ export type TimeCardResponseObject = {
         2: number;
     };
     /**
-     * Total pay for the period in integer cents, as a decimal string.
+     * Total pay for the period in integer cents, as a decimal string. Omitted when the caller may see the time card but not its money.
      */
-    pay_cents: string;
+    pay_cents?: string;
     /**
-     * Base-wage portion of pay in integer cents, as a decimal string.
+     * Base-wage portion of pay in integer cents, as a decimal string. Omitted when the caller may see the time card but not its money.
      */
-    base_wage_pay_cents: string;
+    base_wage_pay_cents?: string;
     /**
-     * Additional pay from the 1.5x overtime multiplier in integer cents, as a decimal string.
+     * Additional pay from the 1.5x overtime multiplier in integer cents, as a decimal string. Omitted when the caller may see the time card but not its money.
      */
-    one_five_x_adder_cents: string;
+    one_five_x_adder_cents?: string;
     /**
-     * Additional pay from the 2.0x overtime multiplier in integer cents, as a decimal string.
+     * Additional pay from the 2.0x overtime multiplier in integer cents, as a decimal string. Omitted when the caller may see the time card but not its money.
      */
-    two_x_adder_cents: string;
+    two_x_adder_cents?: string;
     /**
      * IDs of the wage-determination regions (boundaries) that contributed to this rollup.
      */
@@ -7329,21 +7352,21 @@ export type JobTimeCardDayResponseObject = {
         2: number;
     };
     /**
-     * Total pay for this date in integer cents, as a decimal string.
+     * Total pay for this date in integer cents, as a decimal string. Omitted when the caller may see the time card but not its money.
      */
-    pay_cents: string;
+    pay_cents?: string;
     /**
-     * Base-wage portion of this date's pay in integer cents, as a decimal string.
+     * Base-wage portion of this date's pay in integer cents, as a decimal string. Omitted when the caller may see the time card but not its money.
      */
-    base_wage_pay_cents: string;
+    base_wage_pay_cents?: string;
     /**
-     * Additional pay from the 1.5x overtime multiplier on this date, in integer cents, as a decimal string.
+     * Additional pay from the 1.5x overtime multiplier on this date, in integer cents, as a decimal string. Omitted when the caller may see the time card but not its money.
      */
-    one_five_x_adder_cents: string;
+    one_five_x_adder_cents?: string;
     /**
-     * Additional pay from the 2.0x overtime multiplier on this date, in integer cents, as a decimal string.
+     * Additional pay from the 2.0x overtime multiplier on this date, in integer cents, as a decimal string. Omitted when the caller may see the time card but not its money.
      */
-    two_x_adder_cents: string;
+    two_x_adder_cents?: string;
     /**
      * IDs of the wage-determination regions (boundaries) that contributed to this rollup.
      */
@@ -7497,37 +7520,37 @@ export type JobTimeCardDayResponseObject = {
         2: number;
     };
     /**
-     * Pay-period-to-date running total of total pay in integer cents, as a decimal string, through this date.
+     * Pay-period-to-date running total of total pay in integer cents, as a decimal string, through this date. Omitted when the caller may see the time card but not its money.
      */
-    cumulative_pay_cents: string;
+    cumulative_pay_cents?: string;
     /**
-     * Week-to-date running total of total pay in integer cents, as a decimal string, through this date.
+     * Week-to-date running total of total pay in integer cents, as a decimal string, through this date. Omitted when the caller may see the time card but not its money.
      */
-    weekly_cumulative_pay_cents: string;
+    weekly_cumulative_pay_cents?: string;
     /**
-     * Pay-period-to-date running total of base-wage pay in integer cents, as a decimal string, through this date.
+     * Pay-period-to-date running total of base-wage pay in integer cents, as a decimal string, through this date. Omitted when the caller may see the time card but not its money.
      */
-    cumulative_base_wage_pay_cents: string;
+    cumulative_base_wage_pay_cents?: string;
     /**
-     * Week-to-date running total of base-wage pay in integer cents, as a decimal string, through this date.
+     * Week-to-date running total of base-wage pay in integer cents, as a decimal string, through this date. Omitted when the caller may see the time card but not its money.
      */
-    weekly_cumulative_base_wage_pay_cents: string;
+    weekly_cumulative_base_wage_pay_cents?: string;
     /**
-     * Pay-period-to-date running total of 1.5x overtime adder pay in integer cents, as a decimal string, through this date.
+     * Pay-period-to-date running total of 1.5x overtime adder pay in integer cents, as a decimal string, through this date. Omitted when the caller may see the time card but not its money.
      */
-    cumulative_one_five_x_adder_cents: string;
+    cumulative_one_five_x_adder_cents?: string;
     /**
-     * Week-to-date running total of 1.5x overtime adder pay in integer cents, as a decimal string, through this date.
+     * Week-to-date running total of 1.5x overtime adder pay in integer cents, as a decimal string, through this date. Omitted when the caller may see the time card but not its money.
      */
-    weekly_cumulative_one_five_x_adder_cents: string;
+    weekly_cumulative_one_five_x_adder_cents?: string;
     /**
-     * Pay-period-to-date running total of 2.0x overtime adder pay in integer cents, as a decimal string, through this date.
+     * Pay-period-to-date running total of 2.0x overtime adder pay in integer cents, as a decimal string, through this date. Omitted when the caller may see the time card but not its money.
      */
-    cumulative_two_x_adder_cents: string;
+    cumulative_two_x_adder_cents?: string;
     /**
-     * Week-to-date running total of 2.0x overtime adder pay in integer cents, as a decimal string, through this date.
+     * Week-to-date running total of 2.0x overtime adder pay in integer cents, as a decimal string, through this date. Omitted when the caller may see the time card but not its money.
      */
-    weekly_cumulative_two_x_adder_cents: string;
+    weekly_cumulative_two_x_adder_cents?: string;
     /**
      * Pay-period-to-date running total of contributing wage-determination region IDs, through this date.
      */
@@ -9122,7 +9145,7 @@ export type ComplianceCheckParameters = {
      */
     status?: 'dismissed' | 'pending';
     /**
-     * The day the check is due, as a calendar date (`YYYY-MM-DD`). It is stored as 00:00 UTC on that day, the same as the web. A value with a time of day is refused with `422`. Send null to clear it, or omit to leave it unchanged.
+     * When the check is due, as a date-time with a UTC offset (`Z` or `-05:00`). A time without an offset, a bare day included, answers 422 invalid_date at its pointer, showing the time fixed with the offset of the check's zone (its job's, else its project's, else its company's) and in UTC; a check on a person shows it only in UTC. A non-string answers 422 at its pointer; a string that does not parse as a date and time answers 422 invalid_date. Send null to clear it, or omit to leave it unchanged.
      */
     time_due?: string | null;
     /**
@@ -13871,7 +13894,7 @@ export type AssetsItemResponseObject = {
      */
     status: 'available' | 'assigned' | null;
     /**
-     * When the item was purchased (ISO 8601); null when not recorded.
+     * The day the item was purchased, as a calendar date (`YYYY-MM-DD`), the UTC day it is stored on, the same day the web shows. Null when not recorded.
      */
     purchase_date: string | null;
     /**
@@ -14008,7 +14031,7 @@ export type AssetsItemParameters = {
          */
         file?: string;
         /**
-         * Set true to remove the attachment named by id.
+         * Set true to remove the attachment named by id. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -14103,7 +14126,7 @@ export type AssetsItemUpdateParameters = {
          */
         file?: string;
         /**
-         * Set true to remove the attachment named by id.
+         * Set true to remove the attachment named by id. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -15155,7 +15178,7 @@ export type AssetsServiceEventParameters = {
          */
         file?: string;
         /**
-         * Set true to remove the attachment named by id.
+         * Set true to remove the attachment named by id. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -15197,7 +15220,7 @@ export type AssetsServiceEventUpdateParameters = {
          */
         file?: string;
         /**
-         * Set true to remove the attachment named by id.
+         * Set true to remove the attachment named by id. A row that sets it without an id answers 422 at that row's id.
          */
         _destroy?: boolean;
     }>;
@@ -22677,6 +22700,38 @@ export type ListFormSubmissionsResponses = {
     200: FormSubmissionIndexObject;
 };
 export type ListFormSubmissionsResponse = ListFormSubmissionsResponses[keyof ListFormSubmissionsResponses];
+export type CreateFormSubmissionData = {
+    body: FormSubmissionCreateParameters;
+    path?: never;
+    query?: never;
+    url: '/api/v1/form_submissions';
+};
+export type CreateFormSubmissionErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreateFormSubmissionError = CreateFormSubmissionErrors[keyof CreateFormSubmissionErrors];
+export type CreateFormSubmissionResponses = {
+    /**
+     * Created
+     */
+    201: FormSubmissionResponseObject;
+};
+export type CreateFormSubmissionResponse = CreateFormSubmissionResponses[keyof CreateFormSubmissionResponses];
 export type GetFormSubmissionData = {
     body?: never;
     path: {