@dsptch-work/api-client 0.19.0 → 0.20.0

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

@@ -25,6 +25,19 @@ export type Problem = {
      * 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;
+    /**
+     * Optional nonempty validation entries. Each item gives a readable detail and, when the server can prove a public body location, a pointer to it. Clients must accept entries without a pointer.
+     */
+    errors?: Array<{
+        /**
+         * The validation message for this entry.
+         */
+        detail: string;
+        /**
+         * A JSON Pointer URI fragment for the public request-body field this entry identifies. Omitted when the server cannot reliably name a public field. It may name a required field absent from the body (for example `#/name`); clients must handle that missing target.
+         */
+        pointer?: string;
+    }>;
 };
 /**
  * Error types
@@ -3537,7 +3550,7 @@ export type PwaJobDetailsResponseObject = {
     ny_dol_prc_number?: string | null;
 } | null;
 /**
- * Parameters for creating a job. Sets the job's schedule, work types, address, and optional Prevailing Wage / Apprenticeship (PWA) compliance. Extra keys are accepted, including custom fields.
+ * Fields shared by job creation and updates. Updates may omit any field to preserve its current value. The resulting job must still satisfy its schedule and PWA validation rules. Extra keys are accepted, including custom fields.
  */
 export type JobParameters = {
     /**
@@ -3553,13 +3566,13 @@ export type JobParameters = {
      */
     description?: string;
     /**
-     * ID of the company that requested the job (for example a general contractor). Required.
+     * ID of the company that requested the job (for example a general contractor). Required on create; omit on update to preserve the existing requester.
      */
-    requested_by_company_id: string;
+    requested_by_company_id?: string;
     /**
      * ID of the user creating the job. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
      */
-    created_by_user_id: string;
+    created_by_user_id?: string;
     /**
      * IDs of the users who manage the job; null when the job has no managers.
      */
@@ -3780,7 +3793,13 @@ export type JobParameters = {
     [key: string]: unknown;
 };
 /**
- * Parameters for updating an existing job. Accepts every job_parameters field, plus a directly settable status.
+ * Parameters for creating a job. `requested_by_company_id` and `created_by_user_id` are required. Sets the job's schedule, work types, address, and optional Prevailing Wage / Apprenticeship (PWA) compliance.
+ */
+export type JobCreateParameters = JobParameters & {
+    [key: string]: unknown;
+};
+/**
+ * Parameters for updating an existing job. Every field is optional; omit a field to preserve its current value. The resulting job must still satisfy schedule and PWA validation rules. Accepts every shared job field plus a directly settable status.
  */
 export type JobUpdateParameters = JobParameters & {
     /**
@@ -4227,11 +4246,11 @@ export type UserParameters = {
      */
     avatar_signed_id?: string;
     /**
-     * Id of the internal user recorded as the creator of the worker's invite. Ignored when skip_invite is set.
+     * Id of the internal user recorded as the creator of the worker's invite, and named to the recipient as the person inviting them; must be a member of your company. Ignored when skip_invite is set.
      */
     created_by_user_id?: string;
     /**
-     * Id of the internal user recorded as having last sent the worker's invite. Null, and ignored, when skip_invite is set.
+     * Id of the internal user recorded as having last sent the worker's invite, and named as the sender on that person's in-app notification; must be a member of your company. Null, and ignored, when skip_invite is set.
      */
     last_sent_by_user_id?: string | null;
     /**
@@ -5151,7 +5170,7 @@ export type CustomFieldConfigsResponseObject = {
     updated_at: string;
 };
 /**
- * Request body for creating or updating a custom field definition.
+ * Request body for creating a custom field definition. `name` and `model_type` are required.
  */
 export type CustomFieldConfigParameters = {
     /**
@@ -5171,6 +5190,27 @@ export type CustomFieldConfigParameters = {
      */
     visible?: boolean;
 };
+/**
+ * Request body for updating a custom field definition. Every field is optional; omit a field to preserve its current value. The resulting definition's name must remain unique for its company and model type.
+ */
+export type CustomFieldConfigUpdateParameters = {
+    /**
+     * Name of the custom field; omit to preserve the current value. The resulting name must remain present and unique per company and model type.
+     */
+    name?: string;
+    /**
+     * Optional description of the custom field.
+     */
+    description?: string | null;
+    /**
+     * The kind of record the field attaches to: one of apprenticeship_apprentice, company, job, or user_company. Omit to preserve the current value.
+     */
+    model_type?: 'apprenticeship_apprentice' | 'company' | 'job' | 'user_company';
+    /**
+     * Whether the field is shown.
+     */
+    visible?: boolean;
+};
 /**
  * A user's membership in a group.
  */
@@ -6731,7 +6771,7 @@ export type ProjectResponseObject = {
     updated_at: string;
 };
 /**
- * Request body for creating or updating a project. Only `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body.
+ * Request body for creating a project. `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body.
  */
 export type ProjectParameters = {
     /**
@@ -6746,6 +6786,87 @@ export type ProjectParameters = {
      * Free-form project description, or null.
      */
     description?: string | null;
+    /**
+     * User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
+     */
+    created_by_user_id: string;
+    /**
+     * Schedule start date as an ISO8601 date (YYYY-MM-DD), or null; requires tz_name to be set.
+     */
+    start_date?: string | null;
+    /**
+     * Schedule end date as an ISO8601 date (YYYY-MM-DD), or null; must be on or after start_date.
+     */
+    end_date?: string | null;
+    /**
+     * IANA time zone name. Required when start_date is set.
+     */
+    tz_name?: string | null;
+    /**
+     * Day of week billing starts: 0 (Sunday) through 6 (Saturday).
+     */
+    billing_start_day?: number | null;
+    /**
+     * Federal PWA tracking mode: `all` (prevailing wage + apprenticeship), `pw_only`, `ap_only`, or `none`. Any other value returns 422.
+     */
+    federal_pwa_mode?: 'all' | 'pw_only' | 'ap_only' | 'none';
+    /**
+     * Any value other than `none` requires `region`.
+     */
+    regional_pwa_mode?: 'all' | 'pw_only' | 'ap_only' | 'none';
+    /**
+     * US state abbreviation; must be one of the owning company's operating regions.
+     */
+    region?: string | null;
+    /**
+     * Gates IRA tax-credit checks. Applies only while `federal_pwa_mode` is not `none` — sending `true` or null while federal tracking is off returns 422, and switching to `none` sets it back to `false`.
+     */
+    asset_owner?: boolean;
+    /**
+     * Name of the project administrator. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
+     */
+    administrator_name?: string | null;
+    /**
+     * Email of the project administrator. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
+     */
+    administrator_email?: string | null;
+    /**
+     * Phone of the project administrator, normalized to E.164. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
+     */
+    administrator_phone?: string | null;
+    /**
+     * Decimal string (e.g. "5000.0"). Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
+     */
+    budget?: string;
+    /**
+     * Prevailing-wage lock-in date as an ISO8601 date. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
+     */
+    prevailing_wage_lock_in_date?: string | null;
+    /**
+     * IRA beginning-of-construction date as an ISO8601 date. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
+     */
+    beginning_of_construction_date?: string | null;
+    /**
+     * IRA placed-in-service date as an ISO8601 date. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
+     */
+    placed_in_service_date?: string | null;
+};
+/**
+ * Request body for updating a project. Every field is optional; omit a field to preserve its current value. The resulting project must still satisfy conditional PWA, regional, and schedule validation rules. `created_by_user_id` is create-only and an update that names it is rejected.
+ */
+export type ProjectUpdateParameters = {
+    /**
+     * Client-supplied external identifier, or null.
+     */
+    external_id?: string | null;
+    /**
+     * Human-readable project name; omit to preserve the current value. The resulting project name must remain present and unique within the owning company.
+     */
+    name?: string;
+    /**
+     * Free-form project description, or null.
+     */
+    description?: string | null;
     /**
      * User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
      */
@@ -8165,7 +8286,7 @@ export type PositionParameters = {
     };
 };
 /**
- * Parameters for creating or updating a per-unit scope price on a job.
+ * Parameters for creating a per-unit scope price on a job. `scope_kind` and `unit_price` are required.
  */
 export type ProductionJobScopePriceParameters = {
     /**
@@ -8185,6 +8306,27 @@ export type ProductionJobScopePriceParameters = {
      */
     unit_of_measure?: string;
 };
+/**
+ * Parameters for updating a per-unit scope price on a job. Every field is optional; omit a field to preserve its current value. The resulting price must retain a scope kind and non-negative unit price.
+ */
+export type ProductionJobScopePriceUpdateParameters = {
+    /**
+     * The scope of work this price covers, as a free-text label (for example "annual", "semi_annual", or "modules"). A job has at most one price per scope kind.
+     */
+    scope_kind?: string;
+    /**
+     * Billing rate per unit, as a decimal string in the company's currency.
+     */
+    unit_price?: string;
+    /**
+     * Contracted number of units expected for this scope on the job; null when no target is set.
+     */
+    contracted_count?: number | null;
+    /**
+     * What each priced unit represents, as a free-text label (for example "modules", "piles", or "turbines"); defaults to "units".
+     */
+    unit_of_measure?: string;
+};
 /**
  * A per-unit billing price for one scope of work on a job. Production completions bill against these prices.
  */
@@ -8639,7 +8781,7 @@ export type CertificationResponseObject = {
     updated_at: string;
 };
 /**
- * Request body for recording or updating a certification held by a worker — who holds it, which certification, when it was received, and optional proof, expiry, and verification details.
+ * Request body for recording a certification held by a worker — who holds it, which certification, when it was received, and optional proof, expiry, and verification details.
  */
 export type UserCertificationParameters = {
     /**
@@ -8692,6 +8834,60 @@ export type UserCertificationParameters = {
      */
     approved_at?: string | null;
 };
+/**
+ * Request body for updating a certification held by a worker. Every field is optional; omit a field to preserve its current value. The resulting certification must still have a receipt date and verification state, and any expiry date must remain after its receipt date.
+ */
+export type UserCertificationUpdateParameters = {
+    /**
+     * Id of the worker who holds the certification. Omit to preserve the current worker.
+     */
+    user_id?: string;
+    /**
+     * Id of the certification held. Omit to preserve the current certification; a worker can hold each certification at most once.
+     */
+    certification_id?: string;
+    /**
+     * When the worker earned the certification (ISO 8601). Omit to preserve the current receipt date.
+     */
+    received_at?: string;
+    /**
+     * Optional proof document to attach (for example a certificate scan). Write-only — it is not returned in responses.
+     */
+    file?: {
+        /**
+         * File name of the proof document, including its extension (for example "gwo-cert.pdf").
+         */
+        name: string;
+        /**
+         * Base64-encoded contents of the proof document.
+         */
+        content: string;
+    } | null;
+    /**
+     * Whether DSPTCH has verified this held certification. Distinct from the verified flag on the certification definition itself.
+     */
+    verified?: boolean;
+    /**
+     * When the held certification expires (YYYY-MM-DD). Must be after received_at; null when it does not expire.
+     */
+    expiration_date?: string | null;
+    /**
+     * The credential or document number for the held certification, as issued by the issuer (for example a WINDA number or a license number). Free text; null when none.
+     */
+    credential_id?: string | null;
+    /**
+     * Id of the user recorded as approving this held certification; null when unset.
+     */
+    approved_by_user_id?: string | null;
+    /**
+     * When the held certification was archived (ISO 8601); null while active. Archiving is a soft flag, separate from deleting the record.
+     */
+    archived_at?: string | null;
+    /**
+     * When this held certification was approved (ISO 8601); null when unset.
+     */
+    approved_at?: string | null;
+};
 /**
  * A page of certifications held by your company's workers.
  */
@@ -10212,7 +10408,7 @@ export type AssetsItemResponseObject = {
     updated_at: string;
 };
 /**
- * Create or update an asset item. The write API creates serial items only; assets_product_id and serial_number are set on create and ignored on update. On create you may also place the item — assets_site_id to stock it at a site, or user_id to assign it to a user (the two are mutually exclusive). performed_by_user_id is required.
+ * Create an asset item. The write API creates serial items only; assets_product_id and serial_number identify the product and serial number. On create you may also place the item — assets_site_id to stock it at a site, or user_id to assign it to a user (the two are mutually exclusive). performed_by_user_id is required.
  */
 export type AssetsItemParameters = {
     /**
@@ -10276,6 +10472,71 @@ export type AssetsItemParameters = {
      */
     performed_by_user_id: string;
 };
+/**
+ * Update an asset item. All item fields are optional — send only what changes — but performed_by_user_id is required to record the updater and any placement. Omitted attributes retain their existing values.
+ */
+export type AssetsItemUpdateParameters = {
+    /**
+     * Human-readable name for the item.
+     */
+    name?: string;
+    /**
+     * Free-text description of the item.
+     */
+    description?: string;
+    /**
+     * ID of the product this item is an instance of.
+     */
+    assets_product_id?: string;
+    /**
+     * Serial number identifying the individual physical unit; unique within its product.
+     */
+    serial_number?: string;
+    /**
+     * Placement status of the item: available, or assigned when held by a user.
+     */
+    status?: 'available' | 'assigned';
+    /**
+     * When the item was purchased (ISO 8601).
+     */
+    purchase_date?: string;
+    /**
+     * Purchase price in cents, in the item's currency.
+     */
+    purchase_price_cents?: number;
+    /**
+     * Identifier for this item in an external system.
+     */
+    external_id?: string;
+    /**
+     * URL to this item in an external system.
+     */
+    external_system_url?: string;
+    /**
+     * Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
+     */
+    images_attributes?: Array<AssetsAttachmentParameters>;
+    /**
+     * Optional. Move the item to this site; mutually exclusive with user_id and container_item_id.
+     */
+    assets_site_id?: string;
+    /**
+     * Optional. Assign the item to this user; mutually exclusive with assets_site_id and container_item_id.
+     */
+    user_id?: string;
+    /**
+     * Optional. Place the item inside this container item; mutually exclusive with assets_site_id and user_id.
+     */
+    container_item_id?: string;
+    /**
+     * Optional. The storage location within the placement site or container; omit for an unbinned placement. Ignored for a user assignment.
+     */
+    assets_sub_location_id?: string;
+    /**
+     * ID of the user this update is performed on behalf of, recorded as updater and attributed to any placement. Required; must belong to your company.
+     */
+    performed_by_user_id: string;
+};
 /**
  * A vendor in the company's asset catalog — a supplier or manufacturer that products are sourced from.
  */
@@ -10531,6 +10792,59 @@ export type AssetsFormAssignmentTriggerParameters = {
      */
     assets_product_ids?: Array<string>;
 };
+/**
+ * Update a form-assignment trigger rule. All fields are optional — send only what changes. When changing first_due_by, include the matching day field when required; assigned_user_ids applies only to the custom assign_to mode.
+ */
+export type AssetsFormAssignmentTriggerUpdateParameters = {
+    /**
+     * ID of the form definition (a SurveyJS form template) this assignment is for.
+     */
+    form_definition_id?: string;
+    /**
+     * The custody event that fires the rule: assignment (an item is assigned to a user) or unassignment (an item is removed from a user).
+     */
+    triggered_by?: 'assignment' | 'unassignment';
+    /**
+     * Who the generated form is assigned to: custom (the users in assigned_user_ids), asset_assignee (the user who now holds the item), or previous_asset_assignee (the user who held it before the event).
+     */
+    assign_to?: 'custom' | 'asset_assignee' | 'previous_asset_assignee';
+    /**
+     * How the first due date is set: day_of_event (the day the rule fires), day_of_week (the next day_of_week_due), or day_of_month (day_of_month_due of the current or next month).
+     */
+    first_due_by?: 'day_of_event' | 'day_of_week' | 'day_of_month';
+    /**
+     * IANA time zone (e.g. "America/New_York") in which time_of_day_due is interpreted.
+     */
+    tz_name?: string;
+    /**
+     * Wall-clock time of day the form is due (HH:MM), interpreted in tz_name.
+     */
+    time_of_day_due?: string;
+    /**
+     * Optional label for this trigger rule; null when unset.
+     */
+    name?: string | null;
+    /**
+     * How often the generated form recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment.
+     */
+    recurrence_frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | null;
+    /**
+     * Day of week the form is first due, 0 (Sunday) to 6 (Saturday). Required when first_due_by is day_of_week; null otherwise.
+     */
+    day_of_week_due?: number | null;
+    /**
+     * Day of month the form is first due, 1 to 31 (clamped to the month's last day). Required when first_due_by is day_of_month; null otherwise.
+     */
+    day_of_month_due?: number | null;
+    /**
+     * IDs of the users the generated form is assigned to. Used only when assign_to is custom; cleared for the other modes.
+     */
+    assigned_user_ids?: Array<string>;
+    /**
+     * IDs of the products this rule applies to; the rule fires for items of these products.
+     */
+    assets_product_ids?: Array<string>;
+};
 /**
  * A file attached to an asset — an item or product image, or a service-event attachment. Uploaded through the direct-upload flow; the response carries a URL to download it.
  */
@@ -10665,6 +10979,23 @@ export type AssetsDocumentParameters = {
      */
     description?: string | null;
 };
+/**
+ * Update an asset-item document. All fields are optional — send only what changes. Omit file to retain the existing attachment, or supply a new signed_id to replace it.
+ */
+export type AssetsDocumentUpdateParameters = {
+    /**
+     * A signed_id from POST /api/v1/direct_uploads identifying a replacement blob. Register the upload naming `assets.items.documents` — a signed_id issued for any other resource will not resolve here.
+     */
+    file?: string;
+    /**
+     * The file's human-readable download name; null when not set.
+     */
+    filename?: string | null;
+    /**
+     * Free-text description of the document; null when none.
+     */
+    description?: string | null;
+};
 /**
  * One entry in an item document's change history, recorded whenever the document is created, updated, or deleted — including when only its attached file is replaced.
  */
@@ -10811,6 +11142,69 @@ export type AssetsItemFormAssignmentParameters = {
         }>;
     };
 };
+/**
+ * Update an item form assignment. All fields are optional — send only what changes. recurring gates the recurrence fields, and task_attributes.reminders_attributes replaces the existing reminder set when supplied.
+ */
+export type AssetsItemFormAssignmentUpdateParameters = {
+    /**
+     * ID of the form definition (a SurveyJS form template) this assignment is for.
+     */
+    form_definition_id?: string;
+    /**
+     * When true, frequency and recurrence_end_time apply; when false or omitted, the task is one-time and those fields are cleared.
+     */
+    recurring?: boolean;
+    /**
+     * The underlying task's name, schedule, assignees, and reminders.
+     */
+    task_attributes?: {
+        /**
+         * Name of the form task; defaults to the form definition's name.
+         */
+        name?: string | null;
+        /**
+         * Free-text description of the task.
+         */
+        description?: string | null;
+        /**
+         * ID of the user who created the task. Existing assignments retain their creator when this is omitted.
+         */
+        created_by_user_id?: string;
+        /**
+         * ID of the user updating the task. The API derives the stored updater from the task creator.
+         */
+        updated_by_user_id?: string | null;
+        /**
+         * When the form task is due (ISO 8601), interpreted in tz_name; null for an unscheduled task.
+         */
+        time_due?: string | null;
+        /**
+         * IANA time zone in which time_due is interpreted; null for an unscheduled task.
+         */
+        tz_name?: string | null;
+        /**
+         * How often this form task recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment; on write, applied only when recurring is true.
+         */
+        frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | null;
+        /**
+         * When recurrence stops (ISO 8601); null for a non-recurring or open-ended task.
+         */
+        recurrence_end_time?: string | null;
+        /**
+         * IDs of the users this form task is assigned to.
+         */
+        task_assignee_user_ids?: Array<string>;
+        /**
+         * Reminders to attach, each an offset from the due time. On update, replaces the existing set.
+         */
+        reminders_attributes?: Array<{
+            /**
+             * 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: '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';
+        }>;
+    };
+};
 /**
  * On-hand stock of an item at a site — one row per item, site, and storage location. Read-only. A site with none of the item has no row at all, since a row is removed once its count reaches zero.
  */
@@ -11107,6 +11501,35 @@ export type AssetsServiceScheduleParameters = {
      */
     performed_by_user_id: string;
 };
+/**
+ * Update a service schedule. Cadence and last_serviced_on fields are optional — send only what changes — but performed_by_user_id is required to record the updater. next_due_date is recomputed.
+ */
+export type AssetsServiceScheduleUpdateParameters = {
+    /**
+     * The service cadence: one of calibration or maintenance.
+     */
+    kind?: 'calibration' | 'maintenance';
+    /**
+     * Optional label distinguishing this schedule from others of the same kind on the item; null when unset.
+     */
+    name?: string | null;
+    /**
+     * Unit of the service interval: one of year, month, week, or day.
+     */
+    interval_unit?: 'year' | 'month' | 'week' | 'day';
+    /**
+     * Number of interval_units between services; greater than 0.
+     */
+    interval_count?: number;
+    /**
+     * Manually-set anchor date of the most recent service; next_due_date derives from it until an actual service event supersedes it. Null when unset.
+     */
+    last_serviced_on?: string | null;
+    /**
+     * ID of the user this update is performed on behalf of, recorded as the schedule's updater. Required; must belong to your company.
+     */
+    performed_by_user_id: string;
+};
 /**
  * A service performed on a serial item — scheduled (satisfying a service schedule) or ad-hoc. Recording one advances the linked schedule's next_due_date.
  */
@@ -11185,6 +11608,35 @@ export type AssetsServiceEventParameters = {
      */
     attachments_attributes?: Array<AssetsAttachmentParameters>;
 };
+/**
+ * Update a service event. Event fields are optional — send only what changes — but performed_by_user_id is required to record the updater. A linked schedule dictates kind, and changing or removing the link recomputes affected due dates.
+ */
+export type AssetsServiceEventUpdateParameters = {
+    /**
+     * The kind of service performed: one of calibration, maintenance, or repair. Ignored when assets_service_schedule_id is set — the schedule dictates the kind.
+     */
+    kind?: 'calibration' | 'maintenance' | 'repair';
+    /**
+     * Free-text notes on the service; null when none.
+     */
+    notes?: string | null;
+    /**
+     * Date the service was performed; stored as company-local midnight and returned as performed_at. Omit to retain the existing date.
+     */
+    performed_on?: string;
+    /**
+     * ID of the service schedule this event satisfies; must belong to the item. Omit to retain the existing link, or send null to remove it.
+     */
+    assets_service_schedule_id?: string | null;
+    /**
+     * ID of the user this update is performed on behalf of. Required; must belong to your company.
+     */
+    performed_by_user_id: string;
+    /**
+     * Document attachments for the service. Set _destroy with an id to remove an existing one; omit id to add a new one.
+     */
+    attachments_attributes?: Array<AssetsAttachmentParameters>;
+};
 /**
  * A product-level service cadence that seeds and syncs the matching schedules on that product's items. Changing its defining fields (name, kind, interval) reconciles linked item schedules in the background.
  */
@@ -11251,6 +11703,31 @@ export type AssetsServiceScheduleTemplateParameters = {
      */
     performed_by_user_id: string;
 };
+/**
+ * Update a service schedule template. Cadence fields are optional — send only what changes — but performed_by_user_id is required to record the updater. Changing defining fields reconciles linked item schedules in the background.
+ */
+export type AssetsServiceScheduleTemplateUpdateParameters = {
+    /**
+     * The service cadence: one of calibration or maintenance.
+     */
+    kind?: 'calibration' | 'maintenance';
+    /**
+     * Optional label distinguishing this template from others of the same kind on the product; null when unset.
+     */
+    name?: string | null;
+    /**
+     * Unit of the service interval: one of year, month, week, or day.
+     */
+    interval_unit?: 'year' | 'month' | 'week' | 'day';
+    /**
+     * Number of interval_units between services; greater than 0.
+     */
+    interval_count?: number;
+    /**
+     * ID of the user this update is performed on behalf of, recorded as the template's updater. Required; must belong to your company.
+     */
+    performed_by_user_id: string;
+};
 /**
  * A node of fixed storage structure inside a site or a container item — a zone, aisle, rack, shelf, bin, or drawer. Nodes form a tree per holder, and each carries a scannable path_code composed from its ancestors' codes.
  */
@@ -12902,7 +13379,7 @@ export type GetFormAssignmentTriggerResponses = {
 };
 export type GetFormAssignmentTriggerResponse = GetFormAssignmentTriggerResponses[keyof GetFormAssignmentTriggerResponses];
 export type UpdateFormAssignmentTriggerData = {
-    body: AssetsFormAssignmentTriggerParameters;
+    body: AssetsFormAssignmentTriggerUpdateParameters;
     path: {
         id: string;
     };
@@ -13122,7 +13599,7 @@ export type GetItemResponses = {
 };
 export type GetItemResponse = GetItemResponses[keyof GetItemResponses];
 export type UpdateItemData = {
-    body: AssetsItemParameters;
+    body: AssetsItemUpdateParameters;
     path: {
         id: string;
     };
@@ -13130,10 +13607,18 @@ export type UpdateItemData = {
     url: '/api/v1/assets/items/{id}';
 };
 export type UpdateItemErrors = {
+    /**
+     * Bad Request (missing performed_by_user_id)
+     */
+    400: Problem;
     /**
      * Forbidden
      */
     403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
 };
 export type UpdateItemError = UpdateItemErrors[keyof UpdateItemErrors];
 export type UpdateItemResponses = {
@@ -13328,7 +13813,7 @@ export type GetServiceScheduleResponses = {
 };
 export type GetServiceScheduleResponse = GetServiceScheduleResponses[keyof GetServiceScheduleResponses];
 export type UpdateServiceScheduleData = {
-    body: AssetsServiceScheduleParameters;
+    body: AssetsServiceScheduleUpdateParameters;
     path: {
         item_id: string;
         id: string;
@@ -13337,6 +13822,10 @@ export type UpdateServiceScheduleData = {
     url: '/api/v1/assets/items/{item_id}/service_schedules/{id}';
 };
 export type UpdateServiceScheduleErrors = {
+    /**
+     * Bad Request (missing performed_by_user_id)
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -13486,7 +13975,7 @@ export type GetServiceEventResponses = {
 };
 export type GetServiceEventResponse = GetServiceEventResponses[keyof GetServiceEventResponses];
 export type UpdateServiceEventData = {
-    body: AssetsServiceEventParameters;
+    body: AssetsServiceEventUpdateParameters;
     path: {
         item_id: string;
         id: string;
@@ -13495,6 +13984,10 @@ export type UpdateServiceEventData = {
     url: '/api/v1/assets/items/{item_id}/service_events/{id}';
 };
 export type UpdateServiceEventErrors = {
+    /**
+     * Bad Request (missing performed_by_user_id)
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -13607,7 +14100,7 @@ export type GetFormAssignmentTaskResponses = {
 };
 export type GetFormAssignmentTaskResponse = GetFormAssignmentTaskResponses[keyof GetFormAssignmentTaskResponses];
 export type UpdateFormAssignmentTaskData = {
-    body: AssetsItemFormAssignmentParameters;
+    body: AssetsItemFormAssignmentUpdateParameters;
     path: {
         item_id: string;
         id: string;
@@ -13753,7 +14246,7 @@ export type GetDocumentResponses = {
 };
 export type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses];
 export type UpdateDocumentData = {
-    body: AssetsDocumentParameters;
+    body: AssetsDocumentUpdateParameters;
     path: {
         item_id: string;
         id: string;
@@ -14194,7 +14687,7 @@ export type GetServiceScheduleTemplateResponses = {
 };
 export type GetServiceScheduleTemplateResponse = GetServiceScheduleTemplateResponses[keyof GetServiceScheduleTemplateResponses];
 export type UpdateServiceScheduleTemplateData = {
-    body: AssetsServiceScheduleTemplateParameters;
+    body: AssetsServiceScheduleTemplateUpdateParameters;
     path: {
         product_id: string;
         id: string;
@@ -14203,6 +14696,10 @@ export type UpdateServiceScheduleTemplateData = {
     url: '/api/v1/assets/products/{product_id}/service_schedule_templates/{id}';
 };
 export type UpdateServiceScheduleTemplateErrors = {
+    /**
+     * Bad Request (missing performed_by_user_id)
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -15325,7 +15822,7 @@ export type GetUserCertificationResponses = {
 };
 export type GetUserCertificationResponse = GetUserCertificationResponses[keyof GetUserCertificationResponses];
 export type UpdateUserCertificationData = {
-    body?: UserCertificationParameters;
+    body?: UserCertificationUpdateParameters;
     path: {
         id: string;
     };
@@ -16021,7 +16518,7 @@ export type GetCustomFieldConfigResponses = {
 };
 export type GetCustomFieldConfigResponse = GetCustomFieldConfigResponses[keyof GetCustomFieldConfigResponses];
 export type UpdateCustomFieldConfigData = {
-    body?: CustomFieldConfigParameters;
+    body?: CustomFieldConfigUpdateParameters;
     path: {
         id: string;
     };
@@ -16631,7 +17128,7 @@ export type GetJobScopePriceResponses = {
 };
 export type GetJobScopePriceResponse = GetJobScopePriceResponses[keyof GetJobScopePriceResponses];
 export type UpdateJobScopePriceData = {
-    body?: ProductionJobScopePriceParameters;
+    body?: ProductionJobScopePriceUpdateParameters;
     path: {
         job_id: string;
         id: string;
@@ -17424,7 +17921,7 @@ export type CreateJobData = {
     /**
      * Create a job
      */
-    body: JobParameters;
+    body: JobCreateParameters;
     path?: never;
     query?: never;
     url: '/api/v1/jobs';
@@ -20086,6 +20583,10 @@ export type UpdatePositionFunctionErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
 };
 export type UpdatePositionFunctionError = UpdatePositionFunctionErrors[keyof UpdatePositionFunctionErrors];
 export type UpdatePositionFunctionResponses = {
@@ -20409,7 +20910,7 @@ export type GetProjectResponses = {
 };
 export type GetProjectResponse = GetProjectResponses[keyof GetProjectResponses];
 export type UpdateProjectData = {
-    body: ProjectParameters;
+    body: ProjectUpdateParameters;
     path: {
         /**
          * Unique identifier of the project (UUID).