servicem8 0.3.16 → 0.3.18

package/src/models/components/jobactivity.ts

@@ -10,42 +10,30 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1].  Valid values are [0,1]
  */
 export const JobActivityActive = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1].  Valid values are [0,1]
  */
 export type JobActivityActive = ClosedEnum<typeof JobActivityActive>;
 
 export type JobActivity = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1].  Valid values are [0,1]
    */
   active?: JobActivityActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   jobUuid?: string | undefined;
   staffUuid?: string | undefined;
   startDate?: string | undefined;
@@ -61,22 +49,18 @@ export type JobActivity = {
   allocatedTimestamp?: string | undefined;
   materialUuid?: string | undefined;
   /**
-   * Staff Member who last modified record
+   * UUID of Staff Member who last modified record
    */
-  editByStaffUuid?: string | undefined;
+  editByStaffUuid?: any | undefined;
 };
 
 export type JobActivityInput = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1].  Valid values are [0,1]
    */
   active?: JobActivityActive | undefined;
   jobUuid?: string | undefined;
@@ -124,7 +108,7 @@ export const JobActivity$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobActivityActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   job_uuid: z.string().optional(),
   staff_uuid: z.string().optional(),
   start_date: z.string().optional(),
@@ -139,7 +123,7 @@ export const JobActivity$inboundSchema: z.ZodType<
   allocated_by_staff_uuid: z.string().optional(),
   allocated_timestamp: z.string().optional(),
   material_uuid: z.string().optional(),
-  edit_by_staff_uuid: z.string().optional(),
+  edit_by_staff_uuid: z.any().optional(),
 }).transform((v) => {
   return remap$(v, {
     "edit_date": "editDate",
@@ -165,7 +149,7 @@ export const JobActivity$inboundSchema: z.ZodType<
 export type JobActivity$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   job_uuid?: string | undefined;
   staff_uuid?: string | undefined;
   start_date?: string | undefined;
@@ -180,7 +164,7 @@ export type JobActivity$Outbound = {
   allocated_by_staff_uuid?: string | undefined;
   allocated_timestamp?: string | undefined;
   material_uuid?: string | undefined;
-  edit_by_staff_uuid?: string | undefined;
+  edit_by_staff_uuid?: any | undefined;
 };
 
 /** @internal */
@@ -191,7 +175,7 @@ export const JobActivity$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobActivityActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   jobUuid: z.string().optional(),
   staffUuid: z.string().optional(),
   startDate: z.string().optional(),
@@ -206,7 +190,7 @@ export const JobActivity$outboundSchema: z.ZodType<
   allocatedByStaffUuid: z.string().optional(),
   allocatedTimestamp: z.string().optional(),
   materialUuid: z.string().optional(),
-  editByStaffUuid: z.string().optional(),
+  editByStaffUuid: z.any().optional(),
 }).transform((v) => {
   return remap$(v, {
     editDate: "edit_date",

package/src/models/components/joballocation.ts

@@ -10,42 +10,30 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
 export const JobAllocationActive = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
 export type JobAllocationActive = ClosedEnum<typeof JobAllocationActive>;
 
 export type JobAllocation = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1]
    */
   active?: JobAllocationActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   jobUuid?: string | undefined;
   queueUuid?: string | undefined;
   staffUuid?: string | undefined;
@@ -66,15 +54,11 @@ export type JobAllocation = {
 
 export type JobAllocationInput = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1]
    */
   active?: JobAllocationActive | undefined;
   jobUuid?: string | undefined;
@@ -124,7 +108,7 @@ export const JobAllocation$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobAllocationActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   job_uuid: z.string().optional(),
   queue_uuid: z.string().optional(),
   staff_uuid: z.string().optional(),
@@ -167,7 +151,7 @@ export const JobAllocation$inboundSchema: z.ZodType<
 export type JobAllocation$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   job_uuid?: string | undefined;
   queue_uuid?: string | undefined;
   staff_uuid?: string | undefined;
@@ -194,7 +178,7 @@ export const JobAllocation$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobAllocationActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   jobUuid: z.string().optional(),
   queueUuid: z.string().optional(),
   staffUuid: z.string().optional(),

package/src/models/components/jobchecklist.ts

@@ -10,22 +10,14 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
 export const JobChecklistActive = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
 export type JobChecklistActive = ClosedEnum<typeof JobChecklistActive>;
 
@@ -37,6 +29,9 @@ export type ReminderData1 = {};
 
 export type ReminderDataUnion1 = ReminderData1 | string;
 
+/**
+ * JSON data containing additional information for the reminder. Format depends on the reminder_type. For ABSOLUTE_DATETIME, includes 'absoluteDateTime'. For RELATIVE_DATETIME, includes 'relativeDateTime' with 'baseDate', 'unit', and 'quantity'. Exposed via API as 'reminder_data'.
+ */
 export type ReminderDataUnion3 =
   | ReminderData1
   | string
@@ -44,51 +39,69 @@ export type ReminderDataUnion3 =
   | string;
 
 /**
- * If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read-only).
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read only).  Valid values are [0,1]
  */
 export const IsLocked = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read-only).
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read only).  Valid values are [0,1]
  */
 export type IsLocked = ClosedEnum<typeof IsLocked>;
 
 export type JobChecklist = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1]
    */
   active?: JobChecklistActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
+  /**
+   * UUID of the job this checklist item belongs to. This links the checklist item to a specific job in the system.
    */
-  editDate?: string | undefined;
   jobUuid?: string | undefined;
+  /**
+   * The name or description of the checklist item. This is displayed to users in the mobile app and web interface.
+   */
   name?: string | undefined;
+  /**
+   * The section or category name under which this checklist item is grouped. This helps organize related checklist items together.
+   */
   sectionName?: string | undefined;
+  /**
+   * The type of checklist item. Valid values are: 'Todo', 'Asset', 'Photo', 'Form', and 'Document'. Defaults to 'Todo' if not specified. This determines the functionality and appearance of the checklist item.
+   */
   itemType?: string | undefined;
+  /**
+   * A numeric value determining the order in which checklist items appear in the user interface. Lower values appear first. Used to customize the display sequence of items.
+   */
   sortOrder?: number | undefined;
+  /**
+   * The date and time when the checklist item was marked as completed. Empty or '0000-00-00 00:00:00' indicates the item is not completed.
+   */
   completedTimestamp?: string | undefined;
+  /**
+   * UUID of the staff member who completed this checklist item. References a Staff object. Empty if the item is not completed.
+   */
   completedByStaffUuid?: string | undefined;
+  /**
+   * UUID of the job check-in during which this checklist item was completed. This links the checklist completion to a specific check-in event in the job history.
+   */
   completedDuringCheckinUuid?: string | undefined;
+  /**
+   * The type of reminder associated with this checklist item. Valid values are: '' (no reminder), 'CHECK_IN', 'NAVIGATE', 'CHECK_OUT', 'ABSOLUTE_DATETIME', or 'RELATIVE_DATETIME'. Determines when the system will remind users about this checklist item.
+   */
   reminderType?: string | undefined;
+  /**
+   * JSON data containing additional information for the reminder. Format depends on the reminder_type. For ABSOLUTE_DATETIME, includes 'absoluteDateTime'. For RELATIVE_DATETIME, includes 'relativeDateTime' with 'baseDate', 'unit', and 'quantity'. Exposed via API as 'reminder_data'.
+   */
   reminderData?: ReminderData1 | string | ReminderData2 | string | undefined;
   /**
    * The type of object which this checklist item is related to. For example, for Form checklists, this will be 'Form'.
@@ -106,47 +119,72 @@ export type JobChecklist = {
    * The UUID of the object which completes this checklist item. For example, for Form checklists, this references the UUID of a FormResponse record.
    */
   fulfilledByObjectUuid?: string | undefined;
+  /**
+   * JSON array of staff UUIDs to whom this checklist item is assigned. Determines which staff members are responsible for completing this checklist item. Currently limited to a maximum of 1 staff member.
+   */
   assignedToStaffUuids?: Array<string> | undefined;
   /**
-   * If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read-only).
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read only).  Valid values are [0,1]
    */
   isLocked?: IsLocked | undefined;
   /**
-   * The timestamp when the checklist item was assigned to the staff member. (Read-only)
+   * The timestamp when the checklist item was assigned to the staff member. (Read only)
    */
   assignedTimestamp?: string | undefined;
   /**
-   * The UUID of the staff member who assigned the checklist item to the staff member. (Read-only)
+   * The UUID of the staff member who assigned the checklist item to the staff member. (Read only)
    */
   assignedByStaffUuid?: string | undefined;
 };
 
 export type JobChecklistInput = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1]
    */
   active?: JobChecklistActive | undefined;
+  /**
+   * UUID of the job this checklist item belongs to. This links the checklist item to a specific job in the system.
+   */
   jobUuid?: string | undefined;
+  /**
+   * The name or description of the checklist item. This is displayed to users in the mobile app and web interface.
+   */
   name?: string | undefined;
+  /**
+   * The section or category name under which this checklist item is grouped. This helps organize related checklist items together.
+   */
   sectionName?: string | undefined;
+  /**
+   * The type of checklist item. Valid values are: 'Todo', 'Asset', 'Photo', 'Form', and 'Document'. Defaults to 'Todo' if not specified. This determines the functionality and appearance of the checklist item.
+   */
   itemType?: string | undefined;
+  /**
+   * A numeric value determining the order in which checklist items appear in the user interface. Lower values appear first. Used to customize the display sequence of items.
+   */
   sortOrder?: number | undefined;
+  /**
+   * The date and time when the checklist item was marked as completed. Empty or '0000-00-00 00:00:00' indicates the item is not completed.
+   */
   completedTimestamp?: string | undefined;
+  /**
+   * UUID of the staff member who completed this checklist item. References a Staff object. Empty if the item is not completed.
+   */
   completedByStaffUuid?: string | undefined;
+  /**
+   * UUID of the job check-in during which this checklist item was completed. This links the checklist completion to a specific check-in event in the job history.
+   */
   completedDuringCheckinUuid?: string | undefined;
+  /**
+   * The type of reminder associated with this checklist item. Valid values are: '' (no reminder), 'CHECK_IN', 'NAVIGATE', 'CHECK_OUT', 'ABSOLUTE_DATETIME', or 'RELATIVE_DATETIME'. Determines when the system will remind users about this checklist item.
+   */
   reminderType?: string | undefined;
+  /**
+   * JSON data containing additional information for the reminder. Format depends on the reminder_type. For ABSOLUTE_DATETIME, includes 'absoluteDateTime'. For RELATIVE_DATETIME, includes 'relativeDateTime' with 'baseDate', 'unit', and 'quantity'. Exposed via API as 'reminder_data'.
+   */
   reminderData?: ReminderData1 | string | ReminderData2 | string | undefined;
   /**
    * The type of object which this checklist item is related to. For example, for Form checklists, this will be 'Form'.
@@ -164,21 +202,20 @@ export type JobChecklistInput = {
    * The UUID of the object which completes this checklist item. For example, for Form checklists, this references the UUID of a FormResponse record.
    */
   fulfilledByObjectUuid?: string | undefined;
+  /**
+   * JSON array of staff UUIDs to whom this checklist item is assigned. Determines which staff members are responsible for completing this checklist item. Currently limited to a maximum of 1 staff member.
+   */
   assignedToStaffUuids?: Array<string> | undefined;
   /**
-   * If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read-only).
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read only).  Valid values are [0,1]
    */
   isLocked?: IsLocked | undefined;
   /**
-   * The timestamp when the checklist item was assigned to the staff member. (Read-only)
+   * The timestamp when the checklist item was assigned to the staff member. (Read only)
    */
   assignedTimestamp?: string | undefined;
   /**
-   * The UUID of the staff member who assigned the checklist item to the staff member. (Read-only)
+   * The UUID of the staff member who assigned the checklist item to the staff member. (Read only)
    */
   assignedByStaffUuid?: string | undefined;
 };
@@ -473,7 +510,7 @@ export const JobChecklist$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobChecklistActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   job_uuid: z.string().optional(),
   name: z.string().optional(),
   section_name: z.string().optional(),
@@ -522,7 +559,7 @@ export const JobChecklist$inboundSchema: z.ZodType<
 export type JobChecklist$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   job_uuid?: string | undefined;
   name?: string | undefined;
   section_name?: string | undefined;
@@ -556,7 +593,7 @@ export const JobChecklist$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobChecklistActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   jobUuid: z.string().optional(),
   name: z.string().optional(),
   sectionName: z.string().optional(),

package/src/models/components/jobcontact.ts

@@ -10,42 +10,30 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
 export const JobContactActive = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
 export type JobContactActive = ClosedEnum<typeof JobContactActive>;
 
 export type JobContact = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1]
    */
   active?: JobContactActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   jobUuid?: string | undefined;
   first?: string | undefined;
   last?: string | undefined;
@@ -58,15 +46,11 @@ export type JobContact = {
 
 export type JobContactInput = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1]
    */
   active?: JobContactActive | undefined;
   jobUuid?: string | undefined;
@@ -108,7 +92,7 @@ export const JobContact$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobContactActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   job_uuid: z.string().optional(),
   first: z.string().optional(),
   last: z.string().optional(),
@@ -129,7 +113,7 @@ export const JobContact$inboundSchema: z.ZodType<
 export type JobContact$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   job_uuid?: string | undefined;
   first?: string | undefined;
   last?: string | undefined;
@@ -148,7 +132,7 @@ export const JobContact$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobContactActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   jobUuid: z.string().optional(),
   first: z.string().optional(),
   last: z.string().optional(),

package/src/models/components/jobmaterial.ts

@@ -10,42 +10,30 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
 export const JobMaterialActive = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
 export type JobMaterialActive = ClosedEnum<typeof JobMaterialActive>;
 
 export type JobMaterial = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1]
    */
   active?: JobMaterialActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   jobUuid?: string | undefined;
   materialUuid?: string | undefined;
   name?: string | undefined;
@@ -65,15 +53,11 @@ export type JobMaterial = {
 
 export type JobMaterialInput = {
   /**
-   * Record UUID key
+   * Unique identifier for this record
    */
   uuid?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Record active/deleted flag.  Valid values are [0,1]
    */
   active?: JobMaterialActive | undefined;
   jobUuid?: string | undefined;
@@ -122,7 +106,7 @@ export const JobMaterial$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobMaterialActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   job_uuid: z.string().optional(),
   material_uuid: z.string().optional(),
   name: z.string().optional(),
@@ -153,7 +137,7 @@ export const JobMaterial$inboundSchema: z.ZodType<
 export type JobMaterial$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   job_uuid?: string | undefined;
   material_uuid?: string | undefined;
   name?: string | undefined;
@@ -176,7 +160,7 @@ export const JobMaterial$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobMaterialActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   jobUuid: z.string().optional(),
   materialUuid: z.string().optional(),
   name: z.string().optional(),