servicem8 0.3.15 → 0.3.17

package/src/models/components/badge.ts

@@ -10,72 +10,62 @@ 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 BadgeActive = {
   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 BadgeActive = ClosedEnum<typeof BadgeActive>;
 
 export type Badge = {
   /**
-   * 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?: BadgeActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   /**
-   * Badge Name
+   * The display name of the badge. Used to identify the badge in the system. Examples include 'Warranty', 'VIP', 'Take Payment Facilities', etc.
    */
   name: string;
   automaticallyAllocated?: string | undefined;
   fileName?: string | undefined;
   regardingFormUuid?: string | undefined;
+  /**
+   * UUID of the asset type that this badge is associated with. Only applicable for asset-based badges. When set, the badge represents a specific asset type in the system and will appear on assets of this type.
+   */
   regardingAssetTypeUuid?: string | undefined;
 };
 
 export type BadgeInput = {
   /**
-   * 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?: BadgeActive | undefined;
   /**
-   * Badge Name
+   * The display name of the badge. Used to identify the badge in the system. Examples include 'Warranty', 'VIP', 'Take Payment Facilities', etc.
    */
   name: string;
   automaticallyAllocated?: string | undefined;
   fileName?: string | undefined;
   regardingFormUuid?: string | undefined;
+  /**
+   * UUID of the asset type that this badge is associated with. Only applicable for asset-based badges. When set, the badge represents a specific asset type in the system and will appear on assets of this type.
+   */
   regardingAssetTypeUuid?: string | undefined;
 };
 
@@ -103,7 +93,7 @@ export const Badge$inboundSchema: z.ZodType<Badge, z.ZodTypeDef, unknown> = z
   .object({
     uuid: z.string().optional(),
     active: BadgeActive$inboundSchema.default(1),
-    edit_date: z.string().optional(),
+    edit_date: z.any().optional(),
     name: z.string(),
     automatically_allocated: z.string().optional(),
     file_name: z.string().optional(),
@@ -123,7 +113,7 @@ export const Badge$inboundSchema: z.ZodType<Badge, z.ZodTypeDef, unknown> = z
 export type Badge$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   name: string;
   automatically_allocated?: string | undefined;
   file_name?: string | undefined;
@@ -139,7 +129,7 @@ export const Badge$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: BadgeActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   name: z.string(),
   automaticallyAllocated: z.string().optional(),
   fileName: z.string().optional(),

package/src/models/components/category.ts

@@ -10,61 +10,57 @@ 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 CategoryActive = {
   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 CategoryActive = ClosedEnum<typeof CategoryActive>;
 
 export type Category = {
   /**
-   * Record UUID key
+   * The name of the job category. Used to classify and organize jobs.
+   */
+  name: string;
+  /**
+   * The colour associated with this job category. This colour is used to visually identify the category on the dispatch board and in calendar views. The value is a hexadecimal colour code (6 characters 0-9a-f).
+   */
+  colour?: string | undefined;
+  /**
+   * 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?: CategoryActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
-  name: string;
-  colour?: string | undefined;
+  editDate?: any | undefined;
 };
 
 export type CategoryInput = {
   /**
-   * Record UUID key
+   * The name of the job category. Used to classify and organize jobs.
+   */
+  name: string;
+  /**
+   * The colour associated with this job category. This colour is used to visually identify the category on the dispatch board and in calendar views. The value is a hexadecimal colour code (6 characters 0-9a-f).
+   */
+  colour?: string | undefined;
+  /**
+   * 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?: CategoryActive | undefined;
-  name: string;
-  colour?: string | undefined;
 };
 
 /** @internal */
@@ -94,11 +90,11 @@ export const Category$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  uuid: z.string().optional(),
-  active: CategoryActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
   name: z.string(),
   colour: z.string().optional(),
+  uuid: z.string().optional(),
+  active: CategoryActive$inboundSchema.default(1),
+  edit_date: z.any().optional(),
 }).transform((v) => {
   return remap$(v, {
     "edit_date": "editDate",
@@ -107,11 +103,11 @@ export const Category$inboundSchema: z.ZodType<
 
 /** @internal */
 export type Category$Outbound = {
-  uuid?: string | undefined;
-  active: number;
-  edit_date?: string | undefined;
   name: string;
   colour?: string | undefined;
+  uuid?: string | undefined;
+  active: number;
+  edit_date?: any | undefined;
 };
 
 /** @internal */
@@ -120,11 +116,11 @@ export const Category$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Category
 > = z.object({
-  uuid: z.string().optional(),
-  active: CategoryActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
   name: z.string(),
   colour: z.string().optional(),
+  uuid: z.string().optional(),
+  active: CategoryActive$outboundSchema.default(1),
+  editDate: z.any().optional(),
 }).transform((v) => {
   return remap$(v, {
     editDate: "edit_date",
@@ -164,18 +160,18 @@ export const CategoryInput$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  uuid: z.string().optional(),
-  active: CategoryActive$inboundSchema.default(1),
   name: z.string(),
   colour: z.string().optional(),
+  uuid: z.string().optional(),
+  active: CategoryActive$inboundSchema.default(1),
 });
 
 /** @internal */
 export type CategoryInput$Outbound = {
-  uuid?: string | undefined;
-  active: number;
   name: string;
   colour?: string | undefined;
+  uuid?: string | undefined;
+  active: number;
 };
 
 /** @internal */
@@ -184,10 +180,10 @@ export const CategoryInput$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CategoryInput
 > = z.object({
-  uuid: z.string().optional(),
-  active: CategoryActive$outboundSchema.default(1),
   name: z.string(),
   colour: z.string().optional(),
+  uuid: z.string().optional(),
+  active: CategoryActive$outboundSchema.default(1),
 });
 
 /**

package/src/models/components/company.ts

@@ -10,48 +10,51 @@ 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 CompanyActive = {
   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 CompanyActive = ClosedEnum<typeof CompanyActive>;
 
 export type Company = {
   /**
-   * Record UUID key
+   * Company Name
    */
-  uuid?: string | undefined;
+  name: string;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Australian Business Number. A unique 11-digit identifier issued by the Australian Taxation Office to businesses. Required for tax compliance and validation of business identity in Australia.
    */
-  active?: CompanyActive | undefined;
+  abnNumber?: string | undefined;
   /**
-   * Record last modified timestamp
+   * Password
    */
-  editDate?: string | undefined;
+  address?: string | undefined;
   /**
-   * Company Name
+   * Confirm Password
    */
-  name: string;
+  billingAddress?: string | undefined;
+  /**
+   * If provided, specifies the UUID of this Site's parent Company. If blank, this record is a Head Office rather than a Site. This field is only present on ServiceM8 Accounts with the Company Sites addon activated.
+   */
+  parentCompanyUuid?: any | undefined;
+  /**
+   * Unique identifier for this record
+   */
+  uuid?: string | undefined;
+  /**
+   * Record active/deleted flag.  Valid values are [0,1]
+   */
+  active?: CompanyActive | undefined;
+  /**
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
   website?: string | undefined;
-  abnNumber?: string | undefined;
   isIndividual?: string | undefined;
   addressStreet?: string | undefined;
   addressCity?: string | undefined;
@@ -59,6 +62,21 @@ export type Company = {
   addressPostcode?: string | undefined;
   addressCountry?: string | undefined;
   faxNumber?: string | undefined;
+  badges?: string | undefined;
+  taxRateUuid?: string | undefined;
+  billingAttention?: string | undefined;
+  paymentTerms?: string | undefined;
+};
+
+export type CompanyInput = {
+  /**
+   * Company Name
+   */
+  name: string;
+  /**
+   * Australian Business Number. A unique 11-digit identifier issued by the Australian Taxation Office to businesses. Required for tax compliance and validation of business identity in Australia.
+   */
+  abnNumber?: string | undefined;
   /**
    * Password
    */
@@ -67,31 +85,19 @@ export type Company = {
    * Confirm Password
    */
   billingAddress?: string | undefined;
-  badges?: string | undefined;
-  taxRateUuid?: string | undefined;
-  billingAttention?: string | undefined;
-  paymentTerms?: string | undefined;
-};
-
-export type CompanyInput = {
   /**
-   * Record UUID key
+   * If provided, specifies the UUID of this Site's parent Company. If blank, this record is a Head Office rather than a Site. This field is only present on ServiceM8 Accounts with the Company Sites addon activated.
    */
-  uuid?: string | undefined;
+  parentCompanyUuid?: any | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Unique identifier for this record
    */
-  active?: CompanyActive | undefined;
+  uuid?: string | undefined;
   /**
-   * Company Name
+   * Record active/deleted flag.  Valid values are [0,1]
    */
-  name: string;
+  active?: CompanyActive | undefined;
   website?: string | undefined;
-  abnNumber?: string | undefined;
   isIndividual?: string | undefined;
   addressStreet?: string | undefined;
   addressCity?: string | undefined;
@@ -99,14 +105,6 @@ export type CompanyInput = {
   addressPostcode?: string | undefined;
   addressCountry?: string | undefined;
   faxNumber?: string | undefined;
-  /**
-   * Password
-   */
-  address?: string | undefined;
-  /**
-   * Confirm Password
-   */
-  billingAddress?: string | undefined;
   badges?: string | undefined;
   taxRateUuid?: string | undefined;
   billingAttention?: string | undefined;
@@ -137,12 +135,15 @@ export namespace CompanyActive$ {
 /** @internal */
 export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
   z.object({
+    name: z.string(),
+    abn_number: z.string().optional(),
+    address: z.string().optional(),
+    billing_address: z.string().optional(),
+    parent_company_uuid: z.any().optional(),
     uuid: z.string().optional(),
     active: CompanyActive$inboundSchema.default(1),
-    edit_date: z.string().optional(),
-    name: z.string(),
+    edit_date: z.any().optional(),
     website: z.string().optional(),
-    abn_number: z.string().optional(),
     is_individual: z.string().optional(),
     address_street: z.string().optional(),
     address_city: z.string().optional(),
@@ -150,16 +151,16 @@ export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
     address_postcode: z.string().optional(),
     address_country: z.string().optional(),
     fax_number: z.string().optional(),
-    address: z.string().optional(),
-    billing_address: z.string().optional(),
     badges: z.string().optional(),
     tax_rate_uuid: z.string().optional(),
     billing_attention: z.string().optional(),
     payment_terms: z.string().optional(),
   }).transform((v) => {
     return remap$(v, {
-      "edit_date": "editDate",
       "abn_number": "abnNumber",
+      "billing_address": "billingAddress",
+      "parent_company_uuid": "parentCompanyUuid",
+      "edit_date": "editDate",
       "is_individual": "isIndividual",
       "address_street": "addressStreet",
       "address_city": "addressCity",
@@ -167,7 +168,6 @@ export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
       "address_postcode": "addressPostcode",
       "address_country": "addressCountry",
       "fax_number": "faxNumber",
-      "billing_address": "billingAddress",
       "tax_rate_uuid": "taxRateUuid",
       "billing_attention": "billingAttention",
       "payment_terms": "paymentTerms",
@@ -176,12 +176,15 @@ export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
 
 /** @internal */
 export type Company$Outbound = {
+  name: string;
+  abn_number?: string | undefined;
+  address?: string | undefined;
+  billing_address?: string | undefined;
+  parent_company_uuid?: any | undefined;
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
-  name: string;
+  edit_date?: any | undefined;
   website?: string | undefined;
-  abn_number?: string | undefined;
   is_individual?: string | undefined;
   address_street?: string | undefined;
   address_city?: string | undefined;
@@ -189,8 +192,6 @@ export type Company$Outbound = {
   address_postcode?: string | undefined;
   address_country?: string | undefined;
   fax_number?: string | undefined;
-  address?: string | undefined;
-  billing_address?: string | undefined;
   badges?: string | undefined;
   tax_rate_uuid?: string | undefined;
   billing_attention?: string | undefined;
@@ -203,12 +204,15 @@ export const Company$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Company
 > = z.object({
+  name: z.string(),
+  abnNumber: z.string().optional(),
+  address: z.string().optional(),
+  billingAddress: z.string().optional(),
+  parentCompanyUuid: z.any().optional(),
   uuid: z.string().optional(),
   active: CompanyActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
-  name: z.string(),
+  editDate: z.any().optional(),
   website: z.string().optional(),
-  abnNumber: z.string().optional(),
   isIndividual: z.string().optional(),
   addressStreet: z.string().optional(),
   addressCity: z.string().optional(),
@@ -216,16 +220,16 @@ export const Company$outboundSchema: z.ZodType<
   addressPostcode: z.string().optional(),
   addressCountry: z.string().optional(),
   faxNumber: z.string().optional(),
-  address: z.string().optional(),
-  billingAddress: z.string().optional(),
   badges: z.string().optional(),
   taxRateUuid: z.string().optional(),
   billingAttention: z.string().optional(),
   paymentTerms: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    editDate: "edit_date",
     abnNumber: "abn_number",
+    billingAddress: "billing_address",
+    parentCompanyUuid: "parent_company_uuid",
+    editDate: "edit_date",
     isIndividual: "is_individual",
     addressStreet: "address_street",
     addressCity: "address_city",
@@ -233,7 +237,6 @@ export const Company$outboundSchema: z.ZodType<
     addressPostcode: "address_postcode",
     addressCountry: "address_country",
     faxNumber: "fax_number",
-    billingAddress: "billing_address",
     taxRateUuid: "tax_rate_uuid",
     billingAttention: "billing_attention",
     paymentTerms: "payment_terms",
@@ -273,11 +276,14 @@ export const CompanyInput$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  name: z.string(),
+  abn_number: z.string().optional(),
+  address: z.string().optional(),
+  billing_address: z.string().optional(),
+  parent_company_uuid: z.any().optional(),
   uuid: z.string().optional(),
   active: CompanyActive$inboundSchema.default(1),
-  name: z.string(),
   website: z.string().optional(),
-  abn_number: z.string().optional(),
   is_individual: z.string().optional(),
   address_street: z.string().optional(),
   address_city: z.string().optional(),
@@ -285,8 +291,6 @@ export const CompanyInput$inboundSchema: z.ZodType<
   address_postcode: z.string().optional(),
   address_country: z.string().optional(),
   fax_number: z.string().optional(),
-  address: z.string().optional(),
-  billing_address: z.string().optional(),
   badges: z.string().optional(),
   tax_rate_uuid: z.string().optional(),
   billing_attention: z.string().optional(),
@@ -294,6 +298,8 @@ export const CompanyInput$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "abn_number": "abnNumber",
+    "billing_address": "billingAddress",
+    "parent_company_uuid": "parentCompanyUuid",
     "is_individual": "isIndividual",
     "address_street": "addressStreet",
     "address_city": "addressCity",
@@ -301,7 +307,6 @@ export const CompanyInput$inboundSchema: z.ZodType<
     "address_postcode": "addressPostcode",
     "address_country": "addressCountry",
     "fax_number": "faxNumber",
-    "billing_address": "billingAddress",
     "tax_rate_uuid": "taxRateUuid",
     "billing_attention": "billingAttention",
     "payment_terms": "paymentTerms",
@@ -310,11 +315,14 @@ export const CompanyInput$inboundSchema: z.ZodType<
 
 /** @internal */
 export type CompanyInput$Outbound = {
+  name: string;
+  abn_number?: string | undefined;
+  address?: string | undefined;
+  billing_address?: string | undefined;
+  parent_company_uuid?: any | undefined;
   uuid?: string | undefined;
   active: number;
-  name: string;
   website?: string | undefined;
-  abn_number?: string | undefined;
   is_individual?: string | undefined;
   address_street?: string | undefined;
   address_city?: string | undefined;
@@ -322,8 +330,6 @@ export type CompanyInput$Outbound = {
   address_postcode?: string | undefined;
   address_country?: string | undefined;
   fax_number?: string | undefined;
-  address?: string | undefined;
-  billing_address?: string | undefined;
   badges?: string | undefined;
   tax_rate_uuid?: string | undefined;
   billing_attention?: string | undefined;
@@ -336,11 +342,14 @@ export const CompanyInput$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CompanyInput
 > = z.object({
+  name: z.string(),
+  abnNumber: z.string().optional(),
+  address: z.string().optional(),
+  billingAddress: z.string().optional(),
+  parentCompanyUuid: z.any().optional(),
   uuid: z.string().optional(),
   active: CompanyActive$outboundSchema.default(1),
-  name: z.string(),
   website: z.string().optional(),
-  abnNumber: z.string().optional(),
   isIndividual: z.string().optional(),
   addressStreet: z.string().optional(),
   addressCity: z.string().optional(),
@@ -348,8 +357,6 @@ export const CompanyInput$outboundSchema: z.ZodType<
   addressPostcode: z.string().optional(),
   addressCountry: z.string().optional(),
   faxNumber: z.string().optional(),
-  address: z.string().optional(),
-  billingAddress: z.string().optional(),
   badges: z.string().optional(),
   taxRateUuid: z.string().optional(),
   billingAttention: z.string().optional(),
@@ -357,6 +364,8 @@ export const CompanyInput$outboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     abnNumber: "abn_number",
+    billingAddress: "billing_address",
+    parentCompanyUuid: "parent_company_uuid",
     isIndividual: "is_individual",
     addressStreet: "address_street",
     addressCity: "address_city",
@@ -364,7 +373,6 @@ export const CompanyInput$outboundSchema: z.ZodType<
     addressPostcode: "address_postcode",
     addressCountry: "address_country",
     faxNumber: "fax_number",
-    billingAddress: "billing_address",
     taxRateUuid: "tax_rate_uuid",
     billingAttention: "billing_attention",
     paymentTerms: "payment_terms",