servicem8 0.3.16 → 0.3.17

package/src/models/components/material.ts

@@ -10,154 +10,137 @@ 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 indicating whether the price and cost values include tax (1/true) or exclude tax (0/false). Controls tax calculations when determining final pricing. New materials inherit this setting from the account's default tax display preference..  Valid values are [0,1]
  */
-export const MaterialActive = {
+export const PriceIncludesTaxes = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Record active/deleted flag.
- *
- * @remarks
- *
- * Valid values are [0,1]
+ * Boolean flag indicating whether the price and cost values include tax (1/true) or exclude tax (0/false). Controls tax calculations when determining final pricing. New materials inherit this setting from the account's default tax display preference..  Valid values are [0,1]
  */
-export type MaterialActive = ClosedEnum<typeof MaterialActive>;
+export type PriceIncludesTaxes = ClosedEnum<typeof PriceIncludesTaxes>;
 
 /**
- * @remarks
- *
- * Valid values are [0,1]
+ * Boolean flag indicating whether inventory tracking is enabled for this material (1/true) or disabled (0/false). When enabled, the quantity_in_stock is tracked and updated automatically when the material is used in jobs. Only physical products typically have this enabled..  Valid values are [0,1]
  */
-export const PriceIncludesTaxes = {
+export const ItemIsInventoried = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * @remarks
- *
- * Valid values are [0,1]
+ * Boolean flag indicating whether inventory tracking is enabled for this material (1/true) or disabled (0/false). When enabled, the quantity_in_stock is tracked and updated automatically when the material is used in jobs. Only physical products typically have this enabled..  Valid values are [0,1]
  */
-export type PriceIncludesTaxes = ClosedEnum<typeof PriceIncludesTaxes>;
+export type ItemIsInventoried = ClosedEnum<typeof ItemIsInventoried>;
 
 /**
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
-export const ItemIsInventoried = {
+export const MaterialActive = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * @remarks
- *
- * Valid values are [0,1]
+ * Record active/deleted flag.  Valid values are [0,1]
  */
-export type ItemIsInventoried = ClosedEnum<typeof ItemIsInventoried>;
+export type MaterialActive = ClosedEnum<typeof MaterialActive>;
 
 export type Material = {
   /**
-   * Record UUID key
+   * Name of the material, product or labour rate. The maximum length varies based on accounting package integration 30-100 characters for standard mode, up to 2000 characters for description billing mode. Required field that identifies the material in inventory lists, job forms, and invoices.
    */
-  uuid?: string | undefined;
+  name: string;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Unique identifier code for the material. max length. Must be unique within an account.
    */
-  active?: MaterialActive | undefined;
+  itemNumber?: string | undefined;
   /**
-   * Record last modified timestamp
+   * The selling price of the material. May include or exclude tax based on the price_includes_taxes field. Used as the default price when adding this material to jobs and generating invoices.
    */
-  editDate?: string | undefined;
-  name: string;
-  itemNumber?: string | undefined;
   price?: string | undefined;
+  /**
+   * The purchase cost of the material. May include or exclude tax depending on the price_includes_taxes setting. Used for profit calculations and reporting. This field may be hidden from users without appropriate permissions.
+   */
   cost?: string | undefined;
-  itemDescription?: string | undefined;
+  /**
+   * The current inventory quantity of this material available in stock. Stored as a numeric value with decimal support. Updated automatically when materials are used in jobs or when inventory is manually adjusted. Only tracked if item_is_inventoried is enabled.
+   */
   quantityInStock?: number | undefined;
   /**
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Boolean flag indicating whether the price and cost values include tax (1/true) or exclude tax (0/false). Controls tax calculations when determining final pricing. New materials inherit this setting from the account's default tax display preference..  Valid values are [0,1]
    */
   priceIncludesTaxes?: PriceIncludesTaxes | undefined;
-  useDescriptionForInvoicing?: string | undefined;
-  taxRateUuid?: string | undefined;
+  /**
+   * The barcode identifier for the material.  Can store UPC, EAN, or other barcode formats. Used for inventory scanning and quick material lookup in the mobile app.
+   */
   barcode?: string | undefined;
   /**
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Boolean flag indicating whether inventory tracking is enabled for this material (1/true) or disabled (0/false). When enabled, the quantity_in_stock is tracked and updated automatically when the material is used in jobs. Only physical products typically have this enabled..  Valid values are [0,1]
    */
   itemIsInventoried?: ItemIsInventoried | undefined;
-};
-
-export type MaterialInput = {
   /**
-   * 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?: MaterialActive | undefined;
+  /**
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
+  itemDescription?: string | undefined;
+  useDescriptionForInvoicing?: string | undefined;
+  taxRateUuid?: string | undefined;
+};
+
+export type MaterialInput = {
+  /**
+   * Name of the material, product or labour rate. The maximum length varies based on accounting package integration 30-100 characters for standard mode, up to 2000 characters for description billing mode. Required field that identifies the material in inventory lists, job forms, and invoices.
+   */
   name: string;
+  /**
+   * Unique identifier code for the material. max length. Must be unique within an account.
+   */
   itemNumber?: string | undefined;
+  /**
+   * The selling price of the material. May include or exclude tax based on the price_includes_taxes field. Used as the default price when adding this material to jobs and generating invoices.
+   */
   price?: string | undefined;
+  /**
+   * The purchase cost of the material. May include or exclude tax depending on the price_includes_taxes setting. Used for profit calculations and reporting. This field may be hidden from users without appropriate permissions.
+   */
   cost?: string | undefined;
-  itemDescription?: string | undefined;
+  /**
+   * The current inventory quantity of this material available in stock. Stored as a numeric value with decimal support. Updated automatically when materials are used in jobs or when inventory is manually adjusted. Only tracked if item_is_inventoried is enabled.
+   */
   quantityInStock?: number | undefined;
   /**
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Boolean flag indicating whether the price and cost values include tax (1/true) or exclude tax (0/false). Controls tax calculations when determining final pricing. New materials inherit this setting from the account's default tax display preference..  Valid values are [0,1]
    */
   priceIncludesTaxes?: PriceIncludesTaxes | undefined;
-  useDescriptionForInvoicing?: string | undefined;
-  taxRateUuid?: string | undefined;
+  /**
+   * The barcode identifier for the material.  Can store UPC, EAN, or other barcode formats. Used for inventory scanning and quick material lookup in the mobile app.
+   */
   barcode?: string | undefined;
   /**
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Boolean flag indicating whether inventory tracking is enabled for this material (1/true) or disabled (0/false). When enabled, the quantity_in_stock is tracked and updated automatically when the material is used in jobs. Only physical products typically have this enabled..  Valid values are [0,1]
    */
   itemIsInventoried?: ItemIsInventoried | undefined;
+  /**
+   * Unique identifier for this record
+   */
+  uuid?: string | undefined;
+  /**
+   * Record active/deleted flag.  Valid values are [0,1]
+   */
+  active?: MaterialActive | undefined;
+  itemDescription?: string | undefined;
+  useDescriptionForInvoicing?: string | undefined;
+  taxRateUuid?: string | undefined;
 };
 
-/** @internal */
-export const MaterialActive$inboundSchema: z.ZodNativeEnum<
-  typeof MaterialActive
-> = z.nativeEnum(MaterialActive);
-
-/** @internal */
-export const MaterialActive$outboundSchema: z.ZodNativeEnum<
-  typeof MaterialActive
-> = MaterialActive$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace MaterialActive$ {
-  /** @deprecated use `MaterialActive$inboundSchema` instead. */
-  export const inboundSchema = MaterialActive$inboundSchema;
-  /** @deprecated use `MaterialActive$outboundSchema` instead. */
-  export const outboundSchema = MaterialActive$outboundSchema;
-}
-
 /** @internal */
 export const PriceIncludesTaxes$inboundSchema: z.ZodNativeEnum<
   typeof PriceIncludesTaxes
@@ -200,55 +183,76 @@ export namespace ItemIsInventoried$ {
   export const outboundSchema = ItemIsInventoried$outboundSchema;
 }
 
+/** @internal */
+export const MaterialActive$inboundSchema: z.ZodNativeEnum<
+  typeof MaterialActive
+> = z.nativeEnum(MaterialActive);
+
+/** @internal */
+export const MaterialActive$outboundSchema: z.ZodNativeEnum<
+  typeof MaterialActive
+> = MaterialActive$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MaterialActive$ {
+  /** @deprecated use `MaterialActive$inboundSchema` instead. */
+  export const inboundSchema = MaterialActive$inboundSchema;
+  /** @deprecated use `MaterialActive$outboundSchema` instead. */
+  export const outboundSchema = MaterialActive$outboundSchema;
+}
+
 /** @internal */
 export const Material$inboundSchema: z.ZodType<
   Material,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  uuid: z.string().optional(),
-  active: MaterialActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
   name: z.string(),
   item_number: z.string().optional(),
   price: z.string().optional(),
   cost: z.string().optional(),
-  item_description: z.string().optional(),
   quantity_in_stock: z.number().optional(),
   price_includes_taxes: PriceIncludesTaxes$inboundSchema.optional(),
-  use_description_for_invoicing: z.string().optional(),
-  tax_rate_uuid: z.string().optional(),
   barcode: z.string().optional(),
   item_is_inventoried: ItemIsInventoried$inboundSchema.optional(),
+  uuid: z.string().optional(),
+  active: MaterialActive$inboundSchema.default(1),
+  edit_date: z.any().optional(),
+  item_description: z.string().optional(),
+  use_description_for_invoicing: z.string().optional(),
+  tax_rate_uuid: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "edit_date": "editDate",
     "item_number": "itemNumber",
-    "item_description": "itemDescription",
     "quantity_in_stock": "quantityInStock",
     "price_includes_taxes": "priceIncludesTaxes",
+    "item_is_inventoried": "itemIsInventoried",
+    "edit_date": "editDate",
+    "item_description": "itemDescription",
     "use_description_for_invoicing": "useDescriptionForInvoicing",
     "tax_rate_uuid": "taxRateUuid",
-    "item_is_inventoried": "itemIsInventoried",
   });
 });
 
 /** @internal */
 export type Material$Outbound = {
-  uuid?: string | undefined;
-  active: number;
-  edit_date?: string | undefined;
   name: string;
   item_number?: string | undefined;
   price?: string | undefined;
   cost?: string | undefined;
-  item_description?: string | undefined;
   quantity_in_stock?: number | undefined;
   price_includes_taxes?: number | undefined;
-  use_description_for_invoicing?: string | undefined;
-  tax_rate_uuid?: string | undefined;
   barcode?: string | undefined;
   item_is_inventoried?: number | undefined;
+  uuid?: string | undefined;
+  active: number;
+  edit_date?: any | undefined;
+  item_description?: string | undefined;
+  use_description_for_invoicing?: string | undefined;
+  tax_rate_uuid?: string | undefined;
 };
 
 /** @internal */
@@ -257,30 +261,30 @@ export const Material$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Material
 > = z.object({
-  uuid: z.string().optional(),
-  active: MaterialActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
   name: z.string(),
   itemNumber: z.string().optional(),
   price: z.string().optional(),
   cost: z.string().optional(),
-  itemDescription: z.string().optional(),
   quantityInStock: z.number().optional(),
   priceIncludesTaxes: PriceIncludesTaxes$outboundSchema.optional(),
-  useDescriptionForInvoicing: z.string().optional(),
-  taxRateUuid: z.string().optional(),
   barcode: z.string().optional(),
   itemIsInventoried: ItemIsInventoried$outboundSchema.optional(),
+  uuid: z.string().optional(),
+  active: MaterialActive$outboundSchema.default(1),
+  editDate: z.any().optional(),
+  itemDescription: z.string().optional(),
+  useDescriptionForInvoicing: z.string().optional(),
+  taxRateUuid: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    editDate: "edit_date",
     itemNumber: "item_number",
-    itemDescription: "item_description",
     quantityInStock: "quantity_in_stock",
     priceIncludesTaxes: "price_includes_taxes",
+    itemIsInventoried: "item_is_inventoried",
+    editDate: "edit_date",
+    itemDescription: "item_description",
     useDescriptionForInvoicing: "use_description_for_invoicing",
     taxRateUuid: "tax_rate_uuid",
-    itemIsInventoried: "item_is_inventoried",
   });
 });
 
@@ -317,46 +321,46 @@ export const MaterialInput$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  uuid: z.string().optional(),
-  active: MaterialActive$inboundSchema.default(1),
   name: z.string(),
   item_number: z.string().optional(),
   price: z.string().optional(),
   cost: z.string().optional(),
-  item_description: z.string().optional(),
   quantity_in_stock: z.number().optional(),
   price_includes_taxes: PriceIncludesTaxes$inboundSchema.optional(),
-  use_description_for_invoicing: z.string().optional(),
-  tax_rate_uuid: z.string().optional(),
   barcode: z.string().optional(),
   item_is_inventoried: ItemIsInventoried$inboundSchema.optional(),
+  uuid: z.string().optional(),
+  active: MaterialActive$inboundSchema.default(1),
+  item_description: z.string().optional(),
+  use_description_for_invoicing: z.string().optional(),
+  tax_rate_uuid: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "item_number": "itemNumber",
-    "item_description": "itemDescription",
     "quantity_in_stock": "quantityInStock",
     "price_includes_taxes": "priceIncludesTaxes",
+    "item_is_inventoried": "itemIsInventoried",
+    "item_description": "itemDescription",
     "use_description_for_invoicing": "useDescriptionForInvoicing",
     "tax_rate_uuid": "taxRateUuid",
-    "item_is_inventoried": "itemIsInventoried",
   });
 });
 
 /** @internal */
 export type MaterialInput$Outbound = {
-  uuid?: string | undefined;
-  active: number;
   name: string;
   item_number?: string | undefined;
   price?: string | undefined;
   cost?: string | undefined;
-  item_description?: string | undefined;
   quantity_in_stock?: number | undefined;
   price_includes_taxes?: number | undefined;
-  use_description_for_invoicing?: string | undefined;
-  tax_rate_uuid?: string | undefined;
   barcode?: string | undefined;
   item_is_inventoried?: number | undefined;
+  uuid?: string | undefined;
+  active: number;
+  item_description?: string | undefined;
+  use_description_for_invoicing?: string | undefined;
+  tax_rate_uuid?: string | undefined;
 };
 
 /** @internal */
@@ -365,28 +369,28 @@ export const MaterialInput$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MaterialInput
 > = z.object({
-  uuid: z.string().optional(),
-  active: MaterialActive$outboundSchema.default(1),
   name: z.string(),
   itemNumber: z.string().optional(),
   price: z.string().optional(),
   cost: z.string().optional(),
-  itemDescription: z.string().optional(),
   quantityInStock: z.number().optional(),
   priceIncludesTaxes: PriceIncludesTaxes$outboundSchema.optional(),
-  useDescriptionForInvoicing: z.string().optional(),
-  taxRateUuid: z.string().optional(),
   barcode: z.string().optional(),
   itemIsInventoried: ItemIsInventoried$outboundSchema.optional(),
+  uuid: z.string().optional(),
+  active: MaterialActive$outboundSchema.default(1),
+  itemDescription: z.string().optional(),
+  useDescriptionForInvoicing: z.string().optional(),
+  taxRateUuid: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     itemNumber: "item_number",
-    itemDescription: "item_description",
     quantityInStock: "quantity_in_stock",
     priceIncludesTaxes: "price_includes_taxes",
+    itemIsInventoried: "item_is_inventoried",
+    itemDescription: "item_description",
     useDescriptionForInvoicing: "use_description_for_invoicing",
     taxRateUuid: "tax_rate_uuid",
-    itemIsInventoried: "item_is_inventoried",
   });
 });
 

package/src/models/components/materialbundle.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 MaterialBundleActive = {
   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 MaterialBundleActive = ClosedEnum<typeof MaterialBundleActive>;
 
@@ -39,41 +31,51 @@ export type MaterialList = {
 
 export type MaterialBundle = {
   /**
-   * 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?: MaterialBundleActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
+  /**
+   * Unique identifier for this bundle. Must be 30 characters or less and unique across both Materials and Bundles. Used when adding bundles to jobs.
    */
-  editDate?: string | undefined;
   itemNumber: string;
+  /**
+   * The display name of the bundle. Used for identification in the system and shows on documents when the bundle is added to a job.
+   */
   name?: string | undefined;
+  /**
+   * A JSON array containing the materials that make up this bundle. Each item includes the material's UUID and the quantity to be added when this bundle is used. Limited to between 1 and 50 items, with all quantities being positive numbers.
+   */
   materialList?: Array<MaterialList> | undefined;
 };
 
 export type MaterialBundleInput = {
   /**
-   * 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?: MaterialBundleActive | undefined;
+  /**
+   * Unique identifier for this bundle. Must be 30 characters or less and unique across both Materials and Bundles. Used when adding bundles to jobs.
+   */
   itemNumber: string;
+  /**
+   * The display name of the bundle. Used for identification in the system and shows on documents when the bundle is added to a job.
+   */
   name?: string | undefined;
+  /**
+   * A JSON array containing the materials that make up this bundle. Each item includes the material's UUID and the quantity to be added when this bundle is used. Limited to between 1 and 50 items, with all quantities being positive numbers.
+   */
   materialList?: Array<MaterialList> | undefined;
 };
 
@@ -159,7 +161,7 @@ export const MaterialBundle$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: MaterialBundleActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   item_number: z.string(),
   name: z.string().optional(),
   material_list: z.array(z.lazy(() => MaterialList$inboundSchema)).optional(),
@@ -175,7 +177,7 @@ export const MaterialBundle$inboundSchema: z.ZodType<
 export type MaterialBundle$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   item_number: string;
   name?: string | undefined;
   material_list?: Array<MaterialList$Outbound> | undefined;
@@ -189,7 +191,7 @@ export const MaterialBundle$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: MaterialBundleActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   itemNumber: z.string(),
   name: z.string().optional(),
   materialList: z.array(z.lazy(() => MaterialList$outboundSchema)).optional(),