servicem8 0.3.16 → 0.3.18

package/src/models/components/jobmaterialbundle.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 JobMaterialBundleActive = {
   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 JobMaterialBundleActive = ClosedEnum<
   typeof JobMaterialBundleActive
@@ -33,53 +25,75 @@ export type JobMaterialBundleActive = ClosedEnum<
 
 export type JobMaterialBundle = {
   /**
-   * 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?: JobMaterialBundleActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
+  /**
+   * Unique identifier for the material bundle within the job. Displayed on the Quote/Invoice in the same way as for JobMaterials.
    */
-  editDate?: string | undefined;
   itemNumber?: string | undefined;
+  /**
+   * Descriptive name of the job material bundle. Displayed on the Quote/Invoice in the same way as for JobMaterials.
+   */
   name?: string | undefined;
+  /**
+   * The quantity shown for the bundle line item on the invoice. Must be greater than zero. The quantity of each JobMaterial within the bundle is determined by dividing by this value.
+   */
   quantity?: string | undefined;
+  /**
+   * Defines the display order of the JobMaterialBundle relative to other JobMaterials and JobMaterialBundles on the Job. Lower values are displayed first.
+   */
   sortOrder?: number | undefined;
   /**
    * UUID of the MaterialBundle which this JobMaterialBundle was originally created from.
    */
   materialBundleUuid?: string | undefined;
+  /**
+   * UUID of the job that this material bundle is associated with. Links the bundle to a specific job record.
+   */
   jobUuid?: string | undefined;
 };
 
 export type JobMaterialBundleInput = {
   /**
-   * 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?: JobMaterialBundleActive | undefined;
+  /**
+   * Unique identifier for the material bundle within the job. Displayed on the Quote/Invoice in the same way as for JobMaterials.
+   */
   itemNumber?: string | undefined;
+  /**
+   * Descriptive name of the job material bundle. Displayed on the Quote/Invoice in the same way as for JobMaterials.
+   */
   name?: string | undefined;
+  /**
+   * The quantity shown for the bundle line item on the invoice. Must be greater than zero. The quantity of each JobMaterial within the bundle is determined by dividing by this value.
+   */
   quantity?: string | undefined;
+  /**
+   * Defines the display order of the JobMaterialBundle relative to other JobMaterials and JobMaterialBundles on the Job. Lower values are displayed first.
+   */
   sortOrder?: number | undefined;
   /**
    * UUID of the MaterialBundle which this JobMaterialBundle was originally created from.
    */
   materialBundleUuid?: string | undefined;
+  /**
+   * UUID of the job that this material bundle is associated with. Links the bundle to a specific job record.
+   */
   jobUuid?: string | undefined;
 };
 
@@ -112,7 +126,7 @@ export const JobMaterialBundle$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobMaterialBundleActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   item_number: z.string().optional(),
   name: z.string().optional(),
   quantity: z.string().optional(),
@@ -133,7 +147,7 @@ export const JobMaterialBundle$inboundSchema: z.ZodType<
 export type JobMaterialBundle$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   item_number?: string | undefined;
   name?: string | undefined;
   quantity?: string | undefined;
@@ -150,7 +164,7 @@ export const JobMaterialBundle$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobMaterialBundleActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   itemNumber: z.string().optional(),
   name: z.string().optional(),
   quantity: z.string().optional(),

package/src/models/components/jobpayment.ts

@@ -10,62 +10,42 @@ 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 JobPaymentActive = {
   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 JobPaymentActive = ClosedEnum<typeof JobPaymentActive>;
 
 /**
- * (Read-only).
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Boolean flag indicating whether this payment represents a deposit against future work (true) rather than a payment for completed work (false). Read-only in the API. (Read only).  Valid values are [0,1]
  */
 export const IsDeposit = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * (Read-only).
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Boolean flag indicating whether this payment represents a deposit against future work (true) rather than a payment for completed work (false). Read-only in the API. (Read only).  Valid values are [0,1]
  */
 export type IsDeposit = ClosedEnum<typeof IsDeposit>;
 
 export type JobPayment = {
   /**
-   * 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?: JobPaymentActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   jobUuid?: string | undefined;
   actionedByUuid?: string | undefined;
   timestamp?: string | undefined;
@@ -74,26 +54,18 @@ export type JobPayment = {
   note?: string | undefined;
   attachmentUuid?: string | undefined;
   /**
-   * (Read-only).
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Boolean flag indicating whether this payment represents a deposit against future work (true) rather than a payment for completed work (false). Read-only in the API. (Read only).  Valid values are [0,1]
    */
   isDeposit?: IsDeposit | undefined;
 };
 
 export type JobPaymentInput = {
   /**
-   * 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?: JobPaymentActive | undefined;
   jobUuid?: string | undefined;
@@ -104,11 +76,7 @@ export type JobPaymentInput = {
   note?: string | undefined;
   attachmentUuid?: string | undefined;
   /**
-   * (Read-only).
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Boolean flag indicating whether this payment represents a deposit against future work (true) rather than a payment for completed work (false). Read-only in the API. (Read only).  Valid values are [0,1]
    */
   isDeposit?: IsDeposit | undefined;
 };
@@ -161,7 +129,7 @@ export const JobPayment$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobPaymentActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   job_uuid: z.string().optional(),
   actioned_by_uuid: z.string().optional(),
   timestamp: z.string().optional(),
@@ -184,7 +152,7 @@ export const JobPayment$inboundSchema: z.ZodType<
 export type JobPayment$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   job_uuid?: string | undefined;
   actioned_by_uuid?: string | undefined;
   timestamp?: string | undefined;
@@ -203,7 +171,7 @@ export const JobPayment$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: JobPaymentActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   jobUuid: z.string().optional(),
   actionedByUuid: z.string().optional(),
   timestamp: z.string().optional(),

package/src/models/components/knowledgearticle.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 KnowledgeArticleActive = {
   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 KnowledgeArticleActive = ClosedEnum<typeof KnowledgeArticleActive>;
 
@@ -44,45 +36,67 @@ export type Relationship = {
 
 export type KnowledgeArticle = {
   /**
-   * 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?: KnowledgeArticleActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
+  /**
+   * Title of the knowledge article. This is a mandatory field with a maximum length of 100 characters. Used for identifying and searching for articles in the knowledge base.
    */
-  editDate?: string | undefined;
   name: string;
+  /**
+   * The main content of the knowledge article. For 'richtext' articles, this contains HTML formatted text. For 'video' articles, this may contain supplementary information. For 'call' articles, this contains call details. Supports extended text length.
+   */
   content?: string | undefined;
+  /**
+   * Type of knowledge article. Valid values are 'video', 'richtext', or 'call'. This determines how the article content is presented and processed in the system.
+   */
   articleType?: string | undefined;
+  /**
+   * Comma-separated list of tags associated with this knowledge article. Maximum length is 2000 characters. Tags are used for categorization, searching, and automatic relationship generation with other objects like Services, Materials, and Companies.
+   */
   tags?: string | undefined;
+  /**
+   * JSON array of manually created relationships between this knowledge article and other objects. Contains objects with properties: object_name (e.g., 'job'), object_uuid (the related object's UUID), object_description (a description of the related object), and create_date. Used to associate articles with specific jobs or other system objects.
+   */
   relationships?: Array<Relationship> | undefined;
 };
 
 export type KnowledgeArticleInput = {
   /**
-   * 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?: KnowledgeArticleActive | undefined;
+  /**
+   * Title of the knowledge article. This is a mandatory field with a maximum length of 100 characters. Used for identifying and searching for articles in the knowledge base.
+   */
   name: string;
+  /**
+   * The main content of the knowledge article. For 'richtext' articles, this contains HTML formatted text. For 'video' articles, this may contain supplementary information. For 'call' articles, this contains call details. Supports extended text length.
+   */
   content?: string | undefined;
+  /**
+   * Type of knowledge article. Valid values are 'video', 'richtext', or 'call'. This determines how the article content is presented and processed in the system.
+   */
   articleType?: string | undefined;
+  /**
+   * Comma-separated list of tags associated with this knowledge article. Maximum length is 2000 characters. Tags are used for categorization, searching, and automatic relationship generation with other objects like Services, Materials, and Companies.
+   */
   tags?: string | undefined;
+  /**
+   * JSON array of manually created relationships between this knowledge article and other objects. Contains objects with properties: object_name (e.g., 'job'), object_uuid (the related object's UUID), object_description (a description of the related object), and create_date. Used to associate articles with specific jobs or other system objects.
+   */
   relationships?: Array<Relationship> | undefined;
 };
 
@@ -207,7 +221,7 @@ export const KnowledgeArticle$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: KnowledgeArticleActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   name: z.string(),
   content: z.string().optional(),
   article_type: z.string().optional(),
@@ -224,7 +238,7 @@ export const KnowledgeArticle$inboundSchema: z.ZodType<
 export type KnowledgeArticle$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   name: string;
   content?: string | undefined;
   article_type?: string | undefined;
@@ -240,7 +254,7 @@ export const KnowledgeArticle$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: KnowledgeArticleActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   name: z.string(),
   content: z.string().optional(),
   articleType: z.string().optional(),

package/src/models/components/location.ts

@@ -10,48 +10,33 @@ 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 LocationActive = {
   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 LocationActive = ClosedEnum<typeof LocationActive>;
 
 export type Location = {
   /**
-   * Record UUID key
+   * Location's name
    */
-  uuid?: string | undefined;
+  name: string;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * First line of the location's address. Contains the street number and street name.
    */
-  active?: LocationActive | undefined;
+  line1?: string | undefined;
   /**
-   * Record last modified timestamp
+   * Second line of the location's address. Used for additional address information such as building/suite numbers or street details.
    */
-  editDate?: string | undefined;
+  line2?: string | undefined;
   /**
-   * Location's name
+   * Third line of the location's address. Used for additional address details when line1 and line2 are not sufficient.
    */
-  name: string;
-  line1?: string | undefined;
-  line2?: string | undefined;
   line3?: string | undefined;
   /**
    * Email Address
@@ -65,34 +50,52 @@ export type Location = {
    * Email Address
    */
   postCode?: string | undefined;
+  /**
+   * Primary contact phone number for the location. Can include formatting characters.
+   */
   phone1?: string | undefined;
   /**
    * Address State
    */
   state?: string | undefined;
+  /**
+   * Longitude coordinate of the location in decimal degrees format. Used for geolocation and distance calculations. Expected range is between -180 and 180 degrees.
+   */
   lng?: number | undefined;
+  /**
+   * Latitude coordinate of the location in decimal degrees format. Used for geolocation and distance calculations. Expected range is between -90 and 90 degrees.
+   */
   lat?: number | undefined;
-};
-
-export type LocationInput = {
   /**
-   * 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?: LocationActive | undefined;
+  /**
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
+};
+
+export type LocationInput = {
   /**
    * Location's name
    */
   name: string;
+  /**
+   * First line of the location's address. Contains the street number and street name.
+   */
   line1?: string | undefined;
+  /**
+   * Second line of the location's address. Used for additional address information such as building/suite numbers or street details.
+   */
   line2?: string | undefined;
+  /**
+   * Third line of the location's address. Used for additional address details when line1 and line2 are not sufficient.
+   */
   line3?: string | undefined;
   /**
    * Email Address
@@ -106,13 +109,30 @@ export type LocationInput = {
    * Email Address
    */
   postCode?: string | undefined;
+  /**
+   * Primary contact phone number for the location. Can include formatting characters.
+   */
   phone1?: string | undefined;
   /**
    * Address State
    */
   state?: string | undefined;
+  /**
+   * Longitude coordinate of the location in decimal degrees format. Used for geolocation and distance calculations. Expected range is between -180 and 180 degrees.
+   */
   lng?: number | undefined;
+  /**
+   * Latitude coordinate of the location in decimal degrees format. Used for geolocation and distance calculations. Expected range is between -90 and 90 degrees.
+   */
   lat?: number | undefined;
+  /**
+   * Unique identifier for this record
+   */
+  uuid?: string | undefined;
+  /**
+   * Record active/deleted flag.  Valid values are [0,1]
+   */
+  active?: LocationActive | undefined;
 };
 
 /** @internal */
@@ -142,9 +162,6 @@ export const Location$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  uuid: z.string().optional(),
-  active: LocationActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
   name: z.string(),
   line1: z.string().optional(),
   line2: z.string().optional(),
@@ -156,19 +173,19 @@ export const Location$inboundSchema: z.ZodType<
   state: z.string().optional(),
   lng: z.number().optional(),
   lat: z.number().optional(),
+  uuid: z.string().optional(),
+  active: LocationActive$inboundSchema.default(1),
+  edit_date: z.any().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "edit_date": "editDate",
     "post_code": "postCode",
     "phone_1": "phone1",
+    "edit_date": "editDate",
   });
 });
 
 /** @internal */
 export type Location$Outbound = {
-  uuid?: string | undefined;
-  active: number;
-  edit_date?: string | undefined;
   name: string;
   line1?: string | undefined;
   line2?: string | undefined;
@@ -180,6 +197,9 @@ export type Location$Outbound = {
   state?: string | undefined;
   lng?: number | undefined;
   lat?: number | undefined;
+  uuid?: string | undefined;
+  active: number;
+  edit_date?: any | undefined;
 };
 
 /** @internal */
@@ -188,9 +208,6 @@ export const Location$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Location
 > = z.object({
-  uuid: z.string().optional(),
-  active: LocationActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
   name: z.string(),
   line1: z.string().optional(),
   line2: z.string().optional(),
@@ -202,11 +219,14 @@ export const Location$outboundSchema: z.ZodType<
   state: z.string().optional(),
   lng: z.number().optional(),
   lat: z.number().optional(),
+  uuid: z.string().optional(),
+  active: LocationActive$outboundSchema.default(1),
+  editDate: z.any().optional(),
 }).transform((v) => {
   return remap$(v, {
-    editDate: "edit_date",
     postCode: "post_code",
     phone1: "phone_1",
+    editDate: "edit_date",
   });
 });
 
@@ -243,8 +263,6 @@ export const LocationInput$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  uuid: z.string().optional(),
-  active: LocationActive$inboundSchema.default(1),
   name: z.string(),
   line1: z.string().optional(),
   line2: z.string().optional(),
@@ -256,6 +274,8 @@ export const LocationInput$inboundSchema: z.ZodType<
   state: z.string().optional(),
   lng: z.number().optional(),
   lat: z.number().optional(),
+  uuid: z.string().optional(),
+  active: LocationActive$inboundSchema.default(1),
 }).transform((v) => {
   return remap$(v, {
     "post_code": "postCode",
@@ -265,8 +285,6 @@ export const LocationInput$inboundSchema: z.ZodType<
 
 /** @internal */
 export type LocationInput$Outbound = {
-  uuid?: string | undefined;
-  active: number;
   name: string;
   line1?: string | undefined;
   line2?: string | undefined;
@@ -278,6 +296,8 @@ export type LocationInput$Outbound = {
   state?: string | undefined;
   lng?: number | undefined;
   lat?: number | undefined;
+  uuid?: string | undefined;
+  active: number;
 };
 
 /** @internal */
@@ -286,8 +306,6 @@ export const LocationInput$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   LocationInput
 > = z.object({
-  uuid: z.string().optional(),
-  active: LocationActive$outboundSchema.default(1),
   name: z.string(),
   line1: z.string().optional(),
   line2: z.string().optional(),
@@ -299,6 +317,8 @@ export const LocationInput$outboundSchema: z.ZodType<
   state: z.string().optional(),
   lng: z.number().optional(),
   lat: z.number().optional(),
+  uuid: z.string().optional(),
+  active: LocationActive$outboundSchema.default(1),
 }).transform((v) => {
   return remap$(v, {
     postCode: "post_code",