servicem8 0.3.16 → 0.3.17

package/src/models/components/staff.ts

@@ -10,58 +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]
+ * Boolean flag controlling whether this staff member appears in the schedule view. When true (1), the staff member is hidden from the schedule. When false (0), they appear normally in scheduling interfaces..  Valid values are [0,1]
  */
-export const StaffActive = {
+export const HideFromSchedule = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Boolean flag controlling whether this staff member appears in the schedule view. When true (1), the staff member is hidden from the schedule. When false (0), they appear normally in scheduling interfaces..  Valid values are [0,1]
  */
-export type StaffActive = ClosedEnum<typeof StaffActive>;
+export type HideFromSchedule = ClosedEnum<typeof HideFromSchedule>;
 
 /**
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
-export const HideFromSchedule = {
+export const StaffActive = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
-export type HideFromSchedule = ClosedEnum<typeof HideFromSchedule>;
+export type StaffActive = ClosedEnum<typeof StaffActive>;
 
 export type Staff = {
-  /**
-   * Record UUID key
-   */
-  uuid?: string | undefined;
-  /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
-   */
-  active?: StaffActive | undefined;
-  /**
-   * Record last modified timestamp
-   */
-  editDate?: string | undefined;
   /**
    * Staff First Name
    */
@@ -74,41 +46,78 @@ export type Staff = {
    * Staff Email Address. This is also your login name.
    */
   email: string;
+  /**
+   * Mobile phone number of the staff member. Used for SMS communications and identification when calling.
+   */
   mobile?: string | undefined;
+  /**
+   * Longitude coordinate of the staff member's current or last known location. Used for tracking staff locations and calculating routes and travel distances.
+   */
   lng?: number | undefined;
+  /**
+   * Latitude coordinate of the staff member's current or last known location. Used for tracking staff locations and calculating routes and travel distances.
+   */
   lat?: number | undefined;
+  /**
+   * The date and time when the staff member's geographic location (lat/lng) was last updated. Format is YYYY-MM-DD HH:MM:SS. Used to determine how recent the location data is.
+   */
   geoTimestamp?: string | undefined;
+  /**
+   * The staff member's job title or role within the organization. Used for organizational purposes and displayed in various places throughout the system.
+   */
   jobTitle?: string | undefined;
+  /**
+   * UUID of the job the staff member is currently navigating to. Used to track which job a staff member is traveling toward.
+   */
   navigatingToJobUuid?: string | undefined;
+  /**
+   * The date and time when the staff member started navigating to a job. Format is YYYY-MM-DD HH:MM:SS. Used to track when navigation began.
+   */
   navigatingTimestamp?: string | undefined;
+  /**
+   * The date and time when navigation to a job is expected to complete or expire. Format is YYYY-MM-DD HH:MM:SS. Used to determine if navigation is still active.
+   */
   navigatingExpiryTimestamp?: string | undefined;
+  /**
+   * The color assigned to this staff member, represented as a hex color code. Used for visual identification in the schedule, dispatch board, and other interfaces.
+   */
   color?: string | undefined;
-  customIconUrl?: string | undefined;
+  /**
+   * DEPRECATED
+   */
+  customIconUrl?: any | undefined;
+  /**
+   * Short message summarising the staff's current status.
+   */
   statusMessage?: string | undefined;
+  /**
+   * The date and time when the staff member's status message was last updated. Format is YYYY-MM-DD HH:MM:SS. Used to determine how recent the status message is.
+   */
   statusMessageTimestamp?: string | undefined;
-  canReceivePushNotification?: string | undefined;
   /**
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Boolean flag controlling whether this staff member appears in the schedule view. When true (1), the staff member is hidden from the schedule. When false (0), they appear normally in scheduling interfaces..  Valid values are [0,1]
    */
   hideFromSchedule?: HideFromSchedule | undefined;
+  /**
+   * UUID of the primary security role assigned to this staff member. Controls the staff member's permissions and access levels throughout the system.
+   */
   securityRoleUuid?: string | undefined;
-};
-
-export type StaffInput = {
   /**
-   * 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?: StaffActive | undefined;
+  /**
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
+  canReceivePushNotification?: string | undefined;
+};
+
+export type StaffInput = {
   /**
    * Staff First Name
    */
@@ -121,47 +130,73 @@ export type StaffInput = {
    * Staff Email Address. This is also your login name.
    */
   email: string;
+  /**
+   * Mobile phone number of the staff member. Used for SMS communications and identification when calling.
+   */
   mobile?: string | undefined;
+  /**
+   * Longitude coordinate of the staff member's current or last known location. Used for tracking staff locations and calculating routes and travel distances.
+   */
   lng?: number | undefined;
+  /**
+   * Latitude coordinate of the staff member's current or last known location. Used for tracking staff locations and calculating routes and travel distances.
+   */
   lat?: number | undefined;
+  /**
+   * The date and time when the staff member's geographic location (lat/lng) was last updated. Format is YYYY-MM-DD HH:MM:SS. Used to determine how recent the location data is.
+   */
   geoTimestamp?: string | undefined;
+  /**
+   * The staff member's job title or role within the organization. Used for organizational purposes and displayed in various places throughout the system.
+   */
   jobTitle?: string | undefined;
+  /**
+   * UUID of the job the staff member is currently navigating to. Used to track which job a staff member is traveling toward.
+   */
   navigatingToJobUuid?: string | undefined;
+  /**
+   * The date and time when the staff member started navigating to a job. Format is YYYY-MM-DD HH:MM:SS. Used to track when navigation began.
+   */
   navigatingTimestamp?: string | undefined;
+  /**
+   * The date and time when navigation to a job is expected to complete or expire. Format is YYYY-MM-DD HH:MM:SS. Used to determine if navigation is still active.
+   */
   navigatingExpiryTimestamp?: string | undefined;
+  /**
+   * The color assigned to this staff member, represented as a hex color code. Used for visual identification in the schedule, dispatch board, and other interfaces.
+   */
   color?: string | undefined;
-  customIconUrl?: string | undefined;
+  /**
+   * DEPRECATED
+   */
+  customIconUrl?: any | undefined;
+  /**
+   * Short message summarising the staff's current status.
+   */
   statusMessage?: string | undefined;
+  /**
+   * The date and time when the staff member's status message was last updated. Format is YYYY-MM-DD HH:MM:SS. Used to determine how recent the status message is.
+   */
   statusMessageTimestamp?: string | undefined;
-  canReceivePushNotification?: string | undefined;
   /**
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Boolean flag controlling whether this staff member appears in the schedule view. When true (1), the staff member is hidden from the schedule. When false (0), they appear normally in scheduling interfaces..  Valid values are [0,1]
    */
   hideFromSchedule?: HideFromSchedule | undefined;
+  /**
+   * UUID of the primary security role assigned to this staff member. Controls the staff member's permissions and access levels throughout the system.
+   */
   securityRoleUuid?: string | undefined;
+  /**
+   * Unique identifier for this record
+   */
+  uuid?: string | undefined;
+  /**
+   * Record active/deleted flag.  Valid values are [0,1]
+   */
+  active?: StaffActive | undefined;
+  canReceivePushNotification?: string | undefined;
 };
 
-/** @internal */
-export const StaffActive$inboundSchema: z.ZodNativeEnum<typeof StaffActive> = z
-  .nativeEnum(StaffActive);
-
-/** @internal */
-export const StaffActive$outboundSchema: z.ZodNativeEnum<typeof StaffActive> =
-  StaffActive$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace StaffActive$ {
-  /** @deprecated use `StaffActive$inboundSchema` instead. */
-  export const inboundSchema = StaffActive$inboundSchema;
-  /** @deprecated use `StaffActive$outboundSchema` instead. */
-  export const outboundSchema = StaffActive$outboundSchema;
-}
-
 /** @internal */
 export const HideFromSchedule$inboundSchema: z.ZodNativeEnum<
   typeof HideFromSchedule
@@ -183,12 +218,28 @@ export namespace HideFromSchedule$ {
   export const outboundSchema = HideFromSchedule$outboundSchema;
 }
 
+/** @internal */
+export const StaffActive$inboundSchema: z.ZodNativeEnum<typeof StaffActive> = z
+  .nativeEnum(StaffActive);
+
+/** @internal */
+export const StaffActive$outboundSchema: z.ZodNativeEnum<typeof StaffActive> =
+  StaffActive$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StaffActive$ {
+  /** @deprecated use `StaffActive$inboundSchema` instead. */
+  export const inboundSchema = StaffActive$inboundSchema;
+  /** @deprecated use `StaffActive$outboundSchema` instead. */
+  export const outboundSchema = StaffActive$outboundSchema;
+}
+
 /** @internal */
 export const Staff$inboundSchema: z.ZodType<Staff, z.ZodTypeDef, unknown> = z
   .object({
-    uuid: z.string().optional(),
-    active: StaffActive$inboundSchema.default(1),
-    edit_date: z.string().optional(),
     first: z.string(),
     last: z.string(),
     email: z.string(),
@@ -201,15 +252,17 @@ export const Staff$inboundSchema: z.ZodType<Staff, z.ZodTypeDef, unknown> = z
     navigating_timestamp: z.string().optional(),
     navigating_expiry_timestamp: z.string().optional(),
     color: z.string().optional(),
-    custom_icon_url: z.string().optional(),
+    custom_icon_url: z.any().optional(),
     status_message: z.string().optional(),
     status_message_timestamp: z.string().optional(),
-    can_receive_push_notification: z.string().optional(),
     hide_from_schedule: HideFromSchedule$inboundSchema.optional(),
     security_role_uuid: z.string().optional(),
+    uuid: z.string().optional(),
+    active: StaffActive$inboundSchema.default(1),
+    edit_date: z.any().optional(),
+    can_receive_push_notification: z.string().optional(),
   }).transform((v) => {
     return remap$(v, {
-      "edit_date": "editDate",
       "geo_timestamp": "geoTimestamp",
       "job_title": "jobTitle",
       "navigating_to_job_uuid": "navigatingToJobUuid",
@@ -218,17 +271,15 @@ export const Staff$inboundSchema: z.ZodType<Staff, z.ZodTypeDef, unknown> = z
       "custom_icon_url": "customIconUrl",
       "status_message": "statusMessage",
       "status_message_timestamp": "statusMessageTimestamp",
-      "can_receive_push_notification": "canReceivePushNotification",
       "hide_from_schedule": "hideFromSchedule",
       "security_role_uuid": "securityRoleUuid",
+      "edit_date": "editDate",
+      "can_receive_push_notification": "canReceivePushNotification",
     });
   });
 
 /** @internal */
 export type Staff$Outbound = {
-  uuid?: string | undefined;
-  active: number;
-  edit_date?: string | undefined;
   first: string;
   last: string;
   email: string;
@@ -241,12 +292,15 @@ export type Staff$Outbound = {
   navigating_timestamp?: string | undefined;
   navigating_expiry_timestamp?: string | undefined;
   color?: string | undefined;
-  custom_icon_url?: string | undefined;
+  custom_icon_url?: any | undefined;
   status_message?: string | undefined;
   status_message_timestamp?: string | undefined;
-  can_receive_push_notification?: string | undefined;
   hide_from_schedule?: number | undefined;
   security_role_uuid?: string | undefined;
+  uuid?: string | undefined;
+  active: number;
+  edit_date?: any | undefined;
+  can_receive_push_notification?: string | undefined;
 };
 
 /** @internal */
@@ -255,9 +309,6 @@ export const Staff$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Staff
 > = z.object({
-  uuid: z.string().optional(),
-  active: StaffActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
   first: z.string(),
   last: z.string(),
   email: z.string(),
@@ -270,15 +321,17 @@ export const Staff$outboundSchema: z.ZodType<
   navigatingTimestamp: z.string().optional(),
   navigatingExpiryTimestamp: z.string().optional(),
   color: z.string().optional(),
-  customIconUrl: z.string().optional(),
+  customIconUrl: z.any().optional(),
   statusMessage: z.string().optional(),
   statusMessageTimestamp: z.string().optional(),
-  canReceivePushNotification: z.string().optional(),
   hideFromSchedule: HideFromSchedule$outboundSchema.optional(),
   securityRoleUuid: z.string().optional(),
+  uuid: z.string().optional(),
+  active: StaffActive$outboundSchema.default(1),
+  editDate: z.any().optional(),
+  canReceivePushNotification: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    editDate: "edit_date",
     geoTimestamp: "geo_timestamp",
     jobTitle: "job_title",
     navigatingToJobUuid: "navigating_to_job_uuid",
@@ -287,9 +340,10 @@ export const Staff$outboundSchema: z.ZodType<
     customIconUrl: "custom_icon_url",
     statusMessage: "status_message",
     statusMessageTimestamp: "status_message_timestamp",
-    canReceivePushNotification: "can_receive_push_notification",
     hideFromSchedule: "hide_from_schedule",
     securityRoleUuid: "security_role_uuid",
+    editDate: "edit_date",
+    canReceivePushNotification: "can_receive_push_notification",
   });
 });
 
@@ -326,8 +380,6 @@ export const StaffInput$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  uuid: z.string().optional(),
-  active: StaffActive$inboundSchema.default(1),
   first: z.string(),
   last: z.string(),
   email: z.string(),
@@ -340,12 +392,14 @@ export const StaffInput$inboundSchema: z.ZodType<
   navigating_timestamp: z.string().optional(),
   navigating_expiry_timestamp: z.string().optional(),
   color: z.string().optional(),
-  custom_icon_url: z.string().optional(),
+  custom_icon_url: z.any().optional(),
   status_message: z.string().optional(),
   status_message_timestamp: z.string().optional(),
-  can_receive_push_notification: z.string().optional(),
   hide_from_schedule: HideFromSchedule$inboundSchema.optional(),
   security_role_uuid: z.string().optional(),
+  uuid: z.string().optional(),
+  active: StaffActive$inboundSchema.default(1),
+  can_receive_push_notification: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "geo_timestamp": "geoTimestamp",
@@ -356,16 +410,14 @@ export const StaffInput$inboundSchema: z.ZodType<
     "custom_icon_url": "customIconUrl",
     "status_message": "statusMessage",
     "status_message_timestamp": "statusMessageTimestamp",
-    "can_receive_push_notification": "canReceivePushNotification",
     "hide_from_schedule": "hideFromSchedule",
     "security_role_uuid": "securityRoleUuid",
+    "can_receive_push_notification": "canReceivePushNotification",
   });
 });
 
 /** @internal */
 export type StaffInput$Outbound = {
-  uuid?: string | undefined;
-  active: number;
   first: string;
   last: string;
   email: string;
@@ -378,12 +430,14 @@ export type StaffInput$Outbound = {
   navigating_timestamp?: string | undefined;
   navigating_expiry_timestamp?: string | undefined;
   color?: string | undefined;
-  custom_icon_url?: string | undefined;
+  custom_icon_url?: any | undefined;
   status_message?: string | undefined;
   status_message_timestamp?: string | undefined;
-  can_receive_push_notification?: string | undefined;
   hide_from_schedule?: number | undefined;
   security_role_uuid?: string | undefined;
+  uuid?: string | undefined;
+  active: number;
+  can_receive_push_notification?: string | undefined;
 };
 
 /** @internal */
@@ -392,8 +446,6 @@ export const StaffInput$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StaffInput
 > = z.object({
-  uuid: z.string().optional(),
-  active: StaffActive$outboundSchema.default(1),
   first: z.string(),
   last: z.string(),
   email: z.string(),
@@ -406,12 +458,14 @@ export const StaffInput$outboundSchema: z.ZodType<
   navigatingTimestamp: z.string().optional(),
   navigatingExpiryTimestamp: z.string().optional(),
   color: z.string().optional(),
-  customIconUrl: z.string().optional(),
+  customIconUrl: z.any().optional(),
   statusMessage: z.string().optional(),
   statusMessageTimestamp: z.string().optional(),
-  canReceivePushNotification: z.string().optional(),
   hideFromSchedule: HideFromSchedule$outboundSchema.optional(),
   securityRoleUuid: z.string().optional(),
+  uuid: z.string().optional(),
+  active: StaffActive$outboundSchema.default(1),
+  canReceivePushNotification: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     geoTimestamp: "geo_timestamp",
@@ -422,9 +476,9 @@ export const StaffInput$outboundSchema: z.ZodType<
     customIconUrl: "custom_icon_url",
     statusMessage: "status_message",
     statusMessageTimestamp: "status_message_timestamp",
-    canReceivePushNotification: "can_receive_push_notification",
     hideFromSchedule: "hide_from_schedule",
     securityRoleUuid: "security_role_uuid",
+    canReceivePushNotification: "can_receive_push_notification",
   });
 });
 

package/src/models/components/staffmessage.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 StaffMessageActive = {
   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 StaffMessageActive = ClosedEnum<typeof StaffMessageActive>;
 
 export type StaffMessage = {
   /**
-   * 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?: StaffMessageActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   fromStaffUuid?: string | undefined;
   toStaffUuid?: string | undefined;
   sentTimestamp?: string | undefined;
@@ -58,15 +46,11 @@ export type StaffMessage = {
 
 export type StaffMessageInput = {
   /**
-   * 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?: StaffMessageActive | undefined;
   fromStaffUuid?: string | undefined;
@@ -108,7 +92,7 @@ export const StaffMessage$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: StaffMessageActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   from_staff_uuid: z.string().optional(),
   to_staff_uuid: z.string().optional(),
   sent_timestamp: z.string().optional(),
@@ -134,7 +118,7 @@ export const StaffMessage$inboundSchema: z.ZodType<
 export type StaffMessage$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   from_staff_uuid?: string | undefined;
   to_staff_uuid?: string | undefined;
   sent_timestamp?: string | undefined;
@@ -153,7 +137,7 @@ export const StaffMessage$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: StaffMessageActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   fromStaffUuid: z.string().optional(),
   toStaffUuid: z.string().optional(),
   sentTimestamp: z.string().optional(),