servicem8 0.3.16 → 0.3.17

package/src/models/components/task.ts

@@ -10,89 +10,139 @@ 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 TaskActive = {
   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 TaskActive = ClosedEnum<typeof TaskActive>;
 
 export type Task = {
   /**
-   * Record UUID key
+   * The date by which the task should be completed. Format is YYYY-MM-DD. For mobile app compatibility, may be returned with time component (HHMMSS) in some contexts.
    */
-  uuid?: string | undefined;
+  dueDate?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Detailed description of the task. Contains more comprehensive information about what needs to be done, how to complete the task, or any other relevant notes.
    */
-  active?: TaskActive | undefined;
+  taskDetails?: string | undefined;
   /**
-   * Record last modified timestamp
+   * The name or title of the task. This field is mandatory and used to identify the task in listings and the user interface.
    */
-  editDate?: string | undefined;
-  dueDate?: string | undefined;
-  taskDetails?: string | undefined;
   name: string;
+  /**
+   * The name of the object class this task is related to. Must be a valid object class name in the system (e.g., 'job', 'client', etc.). The value is always stored as lowercase regardless of input case.
+   */
   relatedObject?: string | undefined;
+  /**
+   * UUID of the specific object instance this task is related to. Must be a valid UUID corresponding to an existing object of the type specified in related_object.
+   */
   relatedObjectUuid?: string | undefined;
+  /**
+   * Boolean flag indicating whether the task has been completed (1) or is still pending (0). When set to 1, the completed_timestamp and completed_by_staff_uuid fields are automatically populated.
+   */
   taskComplete?: string | undefined;
+  /**
+   * The date and time when the task was marked as complete. Format is YYYY-MM-DD HH:MM:SS. Automatically set when task_complete is changed to 1.
+   */
   completedTimestamp?: string | undefined;
+  /**
+   * UUID of the staff member who marked the task as complete. Automatically set to the current staff member's UUID when task_complete is changed to 1.
+   */
   completedByStaffUuid?: string | undefined;
+  /**
+   * UUID of the staff member assigned to complete this task. Must be a valid staff UUID in the system.
+   */
   assignedToStaffUuid?: string | undefined;
-  lng?: number | undefined;
-  lat?: number | undefined;
+  /**
+   * DEPRECATED
+   */
+  lng?: any | undefined;
+  /**
+   * DEPRECATED
+   */
+  lat?: any | undefined;
+  /**
+   * Unique identifier for this record
+   */
+  uuid?: string | undefined;
+  /**
+   * Record active/deleted flag.  Valid values are [0,1]
+   */
+  active?: TaskActive | undefined;
+  /**
+   * Timestamp at which record was last modified
+   */
+  editDate?: any | undefined;
   createdByStaffUuid?: string | undefined;
   /**
-   * Record creation timestamp
+   * Timestamp at which record was last modified
    */
-  createDate?: string | undefined;
+  createDate?: any | undefined;
 };
 
 export type TaskInput = {
   /**
-   * Record UUID key
+   * The date by which the task should be completed. Format is YYYY-MM-DD. For mobile app compatibility, may be returned with time component (HHMMSS) in some contexts.
    */
-  uuid?: string | undefined;
+  dueDate?: string | undefined;
   /**
-   * Record active/deleted flag.
-   *
-   * @remarks
-   *
-   * Valid values are [0,1]
+   * Detailed description of the task. Contains more comprehensive information about what needs to be done, how to complete the task, or any other relevant notes.
    */
-  active?: TaskActive | undefined;
-  dueDate?: string | undefined;
   taskDetails?: string | undefined;
+  /**
+   * The name or title of the task. This field is mandatory and used to identify the task in listings and the user interface.
+   */
   name: string;
+  /**
+   * The name of the object class this task is related to. Must be a valid object class name in the system (e.g., 'job', 'client', etc.). The value is always stored as lowercase regardless of input case.
+   */
   relatedObject?: string | undefined;
+  /**
+   * UUID of the specific object instance this task is related to. Must be a valid UUID corresponding to an existing object of the type specified in related_object.
+   */
   relatedObjectUuid?: string | undefined;
+  /**
+   * Boolean flag indicating whether the task has been completed (1) or is still pending (0). When set to 1, the completed_timestamp and completed_by_staff_uuid fields are automatically populated.
+   */
   taskComplete?: string | undefined;
+  /**
+   * The date and time when the task was marked as complete. Format is YYYY-MM-DD HH:MM:SS. Automatically set when task_complete is changed to 1.
+   */
   completedTimestamp?: string | undefined;
+  /**
+   * UUID of the staff member who marked the task as complete. Automatically set to the current staff member's UUID when task_complete is changed to 1.
+   */
   completedByStaffUuid?: string | undefined;
+  /**
+   * UUID of the staff member assigned to complete this task. Must be a valid staff UUID in the system.
+   */
   assignedToStaffUuid?: string | undefined;
-  lng?: number | undefined;
-  lat?: number | undefined;
+  /**
+   * DEPRECATED
+   */
+  lng?: any | undefined;
+  /**
+   * DEPRECATED
+   */
+  lat?: any | undefined;
+  /**
+   * Unique identifier for this record
+   */
+  uuid?: string | undefined;
+  /**
+   * Record active/deleted flag.  Valid values are [0,1]
+   */
+  active?: TaskActive | undefined;
   createdByStaffUuid?: string | undefined;
   /**
-   * Record creation timestamp
+   * Timestamp at which record was last modified
    */
-  createDate?: string | undefined;
+  createDate?: any | undefined;
 };
 
 /** @internal */
@@ -117,9 +167,6 @@ export namespace TaskActive$ {
 /** @internal */
 export const Task$inboundSchema: z.ZodType<Task, z.ZodTypeDef, unknown> = z
   .object({
-    uuid: z.string().optional(),
-    active: TaskActive$inboundSchema.default(1),
-    edit_date: z.string().optional(),
     due_date: z.string().optional(),
     task_details: z.string().optional(),
     name: z.string(),
@@ -129,13 +176,15 @@ export const Task$inboundSchema: z.ZodType<Task, z.ZodTypeDef, unknown> = z
     completed_timestamp: z.string().optional(),
     completed_by_staff_uuid: z.string().optional(),
     assigned_to_staff_uuid: z.string().optional(),
-    lng: z.number().optional(),
-    lat: z.number().optional(),
+    lng: z.any().optional(),
+    lat: z.any().optional(),
+    uuid: z.string().optional(),
+    active: TaskActive$inboundSchema.default(1),
+    edit_date: z.any().optional(),
     created_by_staff_uuid: z.string().optional(),
-    create_date: z.string().optional(),
+    create_date: z.any().optional(),
   }).transform((v) => {
     return remap$(v, {
-      "edit_date": "editDate",
       "due_date": "dueDate",
       "task_details": "taskDetails",
       "related_object": "relatedObject",
@@ -144,6 +193,7 @@ export const Task$inboundSchema: z.ZodType<Task, z.ZodTypeDef, unknown> = z
       "completed_timestamp": "completedTimestamp",
       "completed_by_staff_uuid": "completedByStaffUuid",
       "assigned_to_staff_uuid": "assignedToStaffUuid",
+      "edit_date": "editDate",
       "created_by_staff_uuid": "createdByStaffUuid",
       "create_date": "createDate",
     });
@@ -151,9 +201,6 @@ export const Task$inboundSchema: z.ZodType<Task, z.ZodTypeDef, unknown> = z
 
 /** @internal */
 export type Task$Outbound = {
-  uuid?: string | undefined;
-  active: number;
-  edit_date?: string | undefined;
   due_date?: string | undefined;
   task_details?: string | undefined;
   name: string;
@@ -163,18 +210,18 @@ export type Task$Outbound = {
   completed_timestamp?: string | undefined;
   completed_by_staff_uuid?: string | undefined;
   assigned_to_staff_uuid?: string | undefined;
-  lng?: number | undefined;
-  lat?: number | undefined;
+  lng?: any | undefined;
+  lat?: any | undefined;
+  uuid?: string | undefined;
+  active: number;
+  edit_date?: any | undefined;
   created_by_staff_uuid?: string | undefined;
-  create_date?: string | undefined;
+  create_date?: any | undefined;
 };
 
 /** @internal */
 export const Task$outboundSchema: z.ZodType<Task$Outbound, z.ZodTypeDef, Task> =
   z.object({
-    uuid: z.string().optional(),
-    active: TaskActive$outboundSchema.default(1),
-    editDate: z.string().optional(),
     dueDate: z.string().optional(),
     taskDetails: z.string().optional(),
     name: z.string(),
@@ -184,13 +231,15 @@ export const Task$outboundSchema: z.ZodType<Task$Outbound, z.ZodTypeDef, Task> =
     completedTimestamp: z.string().optional(),
     completedByStaffUuid: z.string().optional(),
     assignedToStaffUuid: z.string().optional(),
-    lng: z.number().optional(),
-    lat: z.number().optional(),
+    lng: z.any().optional(),
+    lat: z.any().optional(),
+    uuid: z.string().optional(),
+    active: TaskActive$outboundSchema.default(1),
+    editDate: z.any().optional(),
     createdByStaffUuid: z.string().optional(),
-    createDate: z.string().optional(),
+    createDate: z.any().optional(),
   }).transform((v) => {
     return remap$(v, {
-      editDate: "edit_date",
       dueDate: "due_date",
       taskDetails: "task_details",
       relatedObject: "related_object",
@@ -199,6 +248,7 @@ export const Task$outboundSchema: z.ZodType<Task$Outbound, z.ZodTypeDef, Task> =
       completedTimestamp: "completed_timestamp",
       completedByStaffUuid: "completed_by_staff_uuid",
       assignedToStaffUuid: "assigned_to_staff_uuid",
+      editDate: "edit_date",
       createdByStaffUuid: "created_by_staff_uuid",
       createDate: "create_date",
     });
@@ -237,8 +287,6 @@ export const TaskInput$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  uuid: z.string().optional(),
-  active: TaskActive$inboundSchema.default(1),
   due_date: z.string().optional(),
   task_details: z.string().optional(),
   name: z.string(),
@@ -248,10 +296,12 @@ export const TaskInput$inboundSchema: z.ZodType<
   completed_timestamp: z.string().optional(),
   completed_by_staff_uuid: z.string().optional(),
   assigned_to_staff_uuid: z.string().optional(),
-  lng: z.number().optional(),
-  lat: z.number().optional(),
+  lng: z.any().optional(),
+  lat: z.any().optional(),
+  uuid: z.string().optional(),
+  active: TaskActive$inboundSchema.default(1),
   created_by_staff_uuid: z.string().optional(),
-  create_date: z.string().optional(),
+  create_date: z.any().optional(),
 }).transform((v) => {
   return remap$(v, {
     "due_date": "dueDate",
@@ -269,8 +319,6 @@ export const TaskInput$inboundSchema: z.ZodType<
 
 /** @internal */
 export type TaskInput$Outbound = {
-  uuid?: string | undefined;
-  active: number;
   due_date?: string | undefined;
   task_details?: string | undefined;
   name: string;
@@ -280,10 +328,12 @@ export type TaskInput$Outbound = {
   completed_timestamp?: string | undefined;
   completed_by_staff_uuid?: string | undefined;
   assigned_to_staff_uuid?: string | undefined;
-  lng?: number | undefined;
-  lat?: number | undefined;
+  lng?: any | undefined;
+  lat?: any | undefined;
+  uuid?: string | undefined;
+  active: number;
   created_by_staff_uuid?: string | undefined;
-  create_date?: string | undefined;
+  create_date?: any | undefined;
 };
 
 /** @internal */
@@ -292,8 +342,6 @@ export const TaskInput$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TaskInput
 > = z.object({
-  uuid: z.string().optional(),
-  active: TaskActive$outboundSchema.default(1),
   dueDate: z.string().optional(),
   taskDetails: z.string().optional(),
   name: z.string(),
@@ -303,10 +351,12 @@ export const TaskInput$outboundSchema: z.ZodType<
   completedTimestamp: z.string().optional(),
   completedByStaffUuid: z.string().optional(),
   assignedToStaffUuid: z.string().optional(),
-  lng: z.number().optional(),
-  lat: z.number().optional(),
+  lng: z.any().optional(),
+  lat: z.any().optional(),
+  uuid: z.string().optional(),
+  active: TaskActive$outboundSchema.default(1),
   createdByStaffUuid: z.string().optional(),
-  createDate: z.string().optional(),
+  createDate: z.any().optional(),
 }).transform((v) => {
   return remap$(v, {
     dueDate: "due_date",

package/src/models/components/taxrate.ts

@@ -10,87 +10,63 @@ 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 TaxRateActive = {
   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 TaxRateActive = ClosedEnum<typeof TaxRateActive>;
 
 /**
- * @remarks
- *
- * Valid values are [0,1]
+ *  Valid values are [0,1]
  */
 export const IsDefaultTaxRate = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * @remarks
- *
- * Valid values are [0,1]
+ *  Valid values are [0,1]
  */
 export type IsDefaultTaxRate = ClosedEnum<typeof IsDefaultTaxRate>;
 
 export type TaxRate = {
   /**
-   * 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?: TaxRateActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   name: string;
   amount?: string | undefined;
   /**
-   * @remarks
-   *
-   * Valid values are [0,1]
+   *  Valid values are [0,1]
    */
   isDefaultTaxRate?: IsDefaultTaxRate | undefined;
 };
 
 export type TaxRateInput = {
   /**
-   * 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?: TaxRateActive | undefined;
   name: string;
   amount?: string | undefined;
   /**
-   * @remarks
-   *
-   * Valid values are [0,1]
+   *  Valid values are [0,1]
    */
   isDefaultTaxRate?: IsDefaultTaxRate | undefined;
 };
@@ -142,7 +118,7 @@ export const TaxRate$inboundSchema: z.ZodType<TaxRate, z.ZodTypeDef, unknown> =
   z.object({
     uuid: z.string().optional(),
     active: TaxRateActive$inboundSchema.default(1),
-    edit_date: z.string().optional(),
+    edit_date: z.any().optional(),
     name: z.string(),
     amount: z.string().optional(),
     is_default_tax_rate: IsDefaultTaxRate$inboundSchema.optional(),
@@ -157,7 +133,7 @@ export const TaxRate$inboundSchema: z.ZodType<TaxRate, z.ZodTypeDef, unknown> =
 export type TaxRate$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   name: string;
   amount?: string | undefined;
   is_default_tax_rate?: number | undefined;
@@ -171,7 +147,7 @@ export const TaxRate$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: TaxRateActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   name: z.string(),
   amount: z.string().optional(),
   isDefaultTaxRate: IsDefaultTaxRate$outboundSchema.optional(),

package/src/models/components/vendor.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 VendorActive = {
   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 VendorActive = ClosedEnum<typeof VendorActive>;
 
 export type Vendor = {
   /**
-   * 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?: VendorActive | undefined;
   /**
-   * Record last modified timestamp
+   * Timestamp at which record was last modified
    */
-  editDate?: string | undefined;
+  editDate?: any | undefined;
   /**
    * Company Name
    */
@@ -86,15 +74,11 @@ export type Vendor = {
 
 export type VendorInput = {
   /**
-   * 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?: VendorActive | undefined;
   /**
@@ -159,7 +143,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
   .object({
     uuid: z.string().optional(),
     active: VendorActive$inboundSchema.default(1),
-    edit_date: z.string().optional(),
+    edit_date: z.any().optional(),
     name: z.string(),
     abn_number: z.string().optional(),
     business_number: z.string().optional(),
@@ -220,7 +204,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
 export type Vendor$Outbound = {
   uuid?: string | undefined;
   active: number;
-  edit_date?: string | undefined;
+  edit_date?: any | undefined;
   name: string;
   abn_number?: string | undefined;
   business_number?: string | undefined;
@@ -258,7 +242,7 @@ export const Vendor$outboundSchema: z.ZodType<
 > = z.object({
   uuid: z.string().optional(),
   active: VendorActive$outboundSchema.default(1),
-  editDate: z.string().optional(),
+  editDate: z.any().optional(),
   name: z.string(),
   abnNumber: z.string().optional(),
   businessNumber: z.string().optional(),

package/src/sdk/allocationwindows.ts

@@ -36,7 +36,7 @@ export class AllocationWindows extends ClientSDK {
    * @remarks
    *
    * #### 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.
    */
   async createAllocationWindows(
     request: components.AllocationWindowInput,
@@ -82,7 +82,7 @@ export class AllocationWindows extends ClientSDK {
    *
    * @remarks
    *
-   * 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`.
    */
   async deleteAllocationWindows(
     request: operations.DeleteAllocationWindowsRequest,

package/src/sdk/assets.ts

@@ -69,7 +69,7 @@ export class Assets extends ClientSDK {
    *
    * @remarks
    *
-   * 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`.
    */
   async deleteAssets(
     request: operations.DeleteAssetsRequest,

package/src/sdk/assettypefields.ts

@@ -42,7 +42,7 @@ export class AssetTypeFields extends ClientSDK {
    * This endpoint requires the following OAuth scope **manage_assets**.
    *
    * #### 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.
    */
   async createAssetTypeFields(
     request: components.AssetTypeFieldInput,
@@ -93,7 +93,7 @@ export class AssetTypeFields extends ClientSDK {
    *
    * @remarks
    *
-   * 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`.
    */
   async deleteAssetTypeFields(
     request: operations.DeleteAssetTypeFieldsRequest,

package/src/sdk/assettypes.ts

@@ -42,7 +42,7 @@ export class AssetTypes extends ClientSDK {
    * This endpoint requires the following OAuth scope **manage_assets**.
    *
    * #### 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.
    */
   async createAssetTypes(
     request: components.AssetTypeInput,
@@ -93,7 +93,7 @@ export class AssetTypes extends ClientSDK {
    *
    * @remarks
    *
-   * 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`.
    */
   async deleteAssetTypes(
     request: operations.DeleteAssetTypesRequest,

package/src/sdk/attachments.ts

@@ -36,7 +36,7 @@ export class Attachments extends ClientSDK {
    * @remarks
    *
    * #### 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.
    */
   async createAttachments(
     request: components.AttachmentInput,
@@ -82,7 +82,7 @@ export class Attachments extends ClientSDK {
    *
    * @remarks
    *
-   * 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`.
    */
   async deleteAttachments(
     request: operations.DeleteAttachmentsRequest,

package/src/sdk/badges.ts

@@ -42,7 +42,7 @@ export class Badges extends ClientSDK {
    * This endpoint requires the following OAuth scope **manage_badges**.
    *
    * #### 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.
    */
   async createBadges(
     request: components.BadgeInput,
@@ -93,7 +93,7 @@ export class Badges extends ClientSDK {
    *
    * @remarks
    *
-   * 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`.
    */
   async deleteBadges(
     request: operations.DeleteBadgesRequest,