servicem8 0.3.15 → 0.3.17

package/src/mcp-server/tools/staffMembersCreateStaffMembers.ts

@@ -23,7 +23,7 @@ This endpoint requires the following OAuth scope **manage_staff**.
 			
 			
 #### Record UUID
-UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the \`x-record-uuid\` response header.
 
 			`,
     args,

package/src/mcp-server/tools/staffMembersDeleteStaffMembers.ts

@@ -17,7 +17,7 @@ export const tool$staffMembersDeleteStaffMembers: ToolDefinition<typeof args> =
 
 
 			
-In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+In ServiceM8, deleting a record sets its \`active\` field to \`0\`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their \`active\` field to \`1\`.
 
 			
 			

package/src/mcp-server/tools/staffMessagesCreateStaffMessages.ts

@@ -19,7 +19,7 @@ export const tool$staffMessagesCreateStaffMessages: ToolDefinition<
 
 			
 #### Record UUID
-UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the \`x-record-uuid\` response header.
 
 			`,
   args,

package/src/mcp-server/tools/staffMessagesDeleteStaffMessages.ts

@@ -18,7 +18,7 @@ export const tool$staffMessagesDeleteStaffMessages: ToolDefinition<
 
 
 			
-In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+In ServiceM8, deleting a record sets its \`active\` field to \`0\`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their \`active\` field to \`1\`.
 
 			`,
   args,

package/src/mcp-server/tools/tasksCreateTasks.ts

@@ -22,7 +22,7 @@ This endpoint requires the following OAuth scope **manage_tasks**.
 			
 			
 #### Record UUID
-UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the \`x-record-uuid\` response header.
 
 			`,
   args,

package/src/mcp-server/tools/tasksDeleteTasks.ts

@@ -16,7 +16,7 @@ export const tool$tasksDeleteTasks: ToolDefinition<typeof args> = {
 
 
 			
-In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+In ServiceM8, deleting a record sets its \`active\` field to \`0\`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their \`active\` field to \`1\`.
 
 			
 			

package/src/mcp-server/tools/taxRatesCreateTaxRates.ts

@@ -17,7 +17,7 @@ export const tool$taxRatesCreateTaxRates: ToolDefinition<typeof args> = {
 
 			
 #### Record UUID
-UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the response header as x-record-uuid.
+UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the \`x-record-uuid\` response header.
 
 			`,
   args,

package/src/mcp-server/tools/taxRatesDeleteTaxRates.ts

@@ -16,7 +16,7 @@ export const tool$taxRatesDeleteTaxRates: ToolDefinition<typeof args> = {
 
 
 			
-In ServiceM8, records are never deleted, but are archived. Archived records will remain accessible via the API as (active = 0), however will no longer be visible in UI. Archived records can be restored to active by setting the record active field to 1.
+In ServiceM8, deleting a record sets its \`active\` field to \`0\`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their \`active\` field to \`1\`.
 
 			`,
   args,

package/src/models/components/allocationwindow.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 AllocationWindowActive = {
   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 AllocationWindowActive = ClosedEnum<typeof AllocationWindowActive>;
 
 export type AllocationWindow = {
   /**
-   * 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?: AllocationWindowActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   name?: string | undefined;
   startTime?: number | undefined;
   endTime?: number | undefined;
@@ -54,15 +42,11 @@ export type AllocationWindow = {
 
 export type AllocationWindowInput = {
   /**
-   * 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?: AllocationWindowActive | undefined;
   name?: string | undefined;
@@ -100,7 +84,7 @@ export const AllocationWindow$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: AllocationWindowActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   name: z.string().optional(),
   start_time: z.number().int().optional(),
   end_time: z.number().int().optional(),
@@ -118,7 +102,7 @@ export const AllocationWindow$inboundSchema: z.ZodType<
 export type AllocationWindow$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   name?: string | undefined;
   start_time?: number | undefined;
   end_time?: number | undefined;
@@ -133,7 +117,7 @@ export const AllocationWindow$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: AllocationWindowActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   name: z.string().optional(),
   startTime: z.number().int().optional(),
   endTime: z.number().int().optional(),

package/src/models/components/asset.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 AssetActive = {
   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 AssetActive = ClosedEnum<typeof AssetActive>;
 
@@ -45,31 +37,27 @@ export type FieldDatum = {
 
 export type Asset = {
   /**
-   * 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?: AssetActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   /**
    * UUID of the Client to which this Asset is attached
    */
   companyUuid?: string | undefined;
   /**
-   * The unique code printed on this Asset's attached label (read only) (Read-only)
+   * The unique code printed on this Asset's attached label (read only)
    */
   assetCode?: string | undefined;
   /**
-   * UUID of an Asset Type which defines the fields that can be stored for this Asset (read only) (Read-only)
+   * UUID of an Asset Type which defines the fields that can be stored for this Asset (read only)
    */
   assetTypeUuid?: string | undefined;
   /**
@@ -92,20 +80,19 @@ export type Asset = {
    * Altitude component of the Asset's location in metres
    */
   altitude?: number | undefined;
+  /**
+   * JSON array containing field values for this asset. Each entry represents a field value defined by the associated AssetType, with field values stored as strings. Date fields use Y-m-d format. This field stores all custom fields defined in the asset type template.
+   */
   fieldData?: Array<FieldDatum> | undefined;
 };
 
 export type AssetInput = {
   /**
-   * 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?: AssetActive | undefined;
   /**
@@ -113,11 +100,11 @@ export type AssetInput = {
    */
   companyUuid?: string | undefined;
   /**
-   * The unique code printed on this Asset's attached label (read only) (Read-only)
+   * The unique code printed on this Asset's attached label (read only)
    */
   assetCode?: string | undefined;
   /**
-   * UUID of an Asset Type which defines the fields that can be stored for this Asset (read only) (Read-only)
+   * UUID of an Asset Type which defines the fields that can be stored for this Asset (read only)
    */
   assetTypeUuid?: string | undefined;
   /**
@@ -140,6 +127,9 @@ export type AssetInput = {
    * Altitude component of the Asset's location in metres
    */
   altitude?: number | undefined;
+  /**
+   * JSON array containing field values for this asset. Each entry represents a field value defined by the associated AssetType, with field values stored as strings. Date fields use Y-m-d format. This field stores all custom fields defined in the asset type template.
+   */
   fieldData?: Array<FieldDatum> | undefined;
 };
 
@@ -229,7 +219,7 @@ export const Asset$inboundSchema: z.ZodType<Asset, z.ZodTypeDef, unknown> = z
   .object({
     uuid: z.string().optional(),
     active: AssetActive$inboundSchema.default(1),
-    edit_date: z.string().optional(),
+    edit_date: z.any().optional(),
     company_uuid: z.string().optional(),
     asset_code: z.string().optional(),
     asset_type_uuid: z.string().optional(),
@@ -254,7 +244,7 @@ export const Asset$inboundSchema: z.ZodType<Asset, z.ZodTypeDef, unknown> = z
 export type Asset$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   company_uuid?: string | undefined;
   asset_code?: string | undefined;
   asset_type_uuid?: string | undefined;
@@ -274,7 +264,7 @@ export const Asset$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: AssetActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   companyUuid: z.string().optional(),
   assetCode: z.string().optional(),
   assetTypeUuid: z.string().optional(),

package/src/models/components/assettype.ts

@@ -10,58 +10,48 @@ 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 AssetTypeActive = {
   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 AssetTypeActive = ClosedEnum<typeof AssetTypeActive>;
 
 export type AssetType = {
   /**
-   * 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?: AssetTypeActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
+  /**
+   * The name of the asset type. Used to identify different categories of assets that can be tracked in the system. Examples might include 'Air Conditioner', 'Fire Extinguisher', etc.
    */
-  editDate?: string | undefined;
   name?: string | undefined;
 };
 
 export type AssetTypeInput = {
   /**
-   * 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?: AssetTypeActive | undefined;
+  /**
+   * The name of the asset type. Used to identify different categories of assets that can be tracked in the system. Examples might include 'Air Conditioner', 'Fire Extinguisher', etc.
+   */
   name?: string | undefined;
 };
 
@@ -94,7 +84,7 @@ export const AssetType$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: AssetTypeActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   name: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -106,7 +96,7 @@ export const AssetType$inboundSchema: z.ZodType<
 export type AssetType$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   name?: string | undefined;
 };
 
@@ -118,7 +108,7 @@ export const AssetType$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: AssetTypeActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   name: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/assettypefield.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 AssetTypeFieldActive = {
   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 AssetTypeFieldActive = ClosedEnum<typeof AssetTypeFieldActive>;
 
@@ -39,6 +31,9 @@ export type AssetTypeFieldFieldType = ClosedEnum<
   typeof AssetTypeFieldFieldType
 >;
 
+/**
+ * Configuration data for the field
+ */
 export type FieldData = {
   fieldType: AssetTypeFieldFieldType;
   mandatory: boolean;
@@ -47,49 +42,59 @@ export type FieldData = {
 
 export type AssetTypeField = {
   /**
-   * 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?: AssetTypeFieldActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   /**
-   * (Read-only)
+   * UUID of the Asset Type to which this field belongs. This field is read-only in the API. (Read only)
    */
   assetTypeUuid?: string | undefined;
+  /**
+   * Name of the field that will be displayed to users. Used as a label for the input field when managing assets.
+   */
   name: string;
+  /**
+   * Configuration data for the field
+   */
   fieldData?: FieldData | undefined;
+  /**
+   * The order in which this field should be displayed relative to other fields of the same asset type. Lower values display first.
+   */
   sortOrder?: number | undefined;
 };
 
 export type AssetTypeFieldInput = {
   /**
-   * 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?: AssetTypeFieldActive | undefined;
   /**
-   * (Read-only)
+   * UUID of the Asset Type to which this field belongs. This field is read-only in the API. (Read only)
    */
   assetTypeUuid?: string | undefined;
+  /**
+   * Name of the field that will be displayed to users. Used as a label for the input field when managing assets.
+   */
   name: string;
+  /**
+   * Configuration data for the field
+   */
   fieldData?: FieldData | undefined;
+  /**
+   * The order in which this field should be displayed relative to other fields of the same asset type. Lower values display first.
+   */
   sortOrder?: number | undefined;
 };
 
@@ -199,7 +204,7 @@ export const AssetTypeField$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: AssetTypeFieldActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   asset_type_uuid: z.string().optional(),
   name: z.string(),
   field_data: z.lazy(() => FieldData$inboundSchema).optional(),
@@ -217,7 +222,7 @@ export const AssetTypeField$inboundSchema: z.ZodType<
 export type AssetTypeField$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   asset_type_uuid?: string | undefined;
   name: string;
   field_data?: FieldData$Outbound | undefined;
@@ -232,7 +237,7 @@ export const AssetTypeField$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: AssetTypeFieldActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   assetTypeUuid: z.string().optional(),
   name: z.string(),
   fieldData: z.lazy(() => FieldData$outboundSchema).optional(),

package/src/models/components/attachment.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 AttachmentActive = {
   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 AttachmentActive = ClosedEnum<typeof AttachmentActive>;
 
 export type Attachment = {
   /**
-   * 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?: AttachmentActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   relatedObject?: string | undefined;
   relatedObjectUuid?: string | undefined;
   /**
@@ -72,15 +60,11 @@ export type Attachment = {
 
 export type AttachmentInput = {
   /**
-   * 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?: AttachmentActive | undefined;
   relatedObject?: string | undefined;
@@ -136,7 +120,7 @@ export const Attachment$inboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: AttachmentActive$inboundSchema.default(1),
-  edit_date: z.string().optional(),
+  edit_date: z.any().optional(),
   related_object: z.string().optional(),
   related_object_uuid: z.string().optional(),
   attachment_name: z.string().optional(),
@@ -174,7 +158,7 @@ export const Attachment$inboundSchema: z.ZodType<
 export type Attachment$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   related_object?: string | undefined;
   related_object_uuid?: string | undefined;
   attachment_name?: string | undefined;
@@ -201,7 +185,7 @@ export const Attachment$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: AttachmentActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   relatedObject: z.string().optional(),
   relatedObjectUuid: z.string().optional(),
   attachmentName: z.string().optional(),