servicem8 0.3.15 → 0.3.17

package/docs/sdks/tasks/README.md

@@ -33,7 +33,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -59,7 +59,7 @@ import { tasksListTasks } from "servicem8/funcs/tasksListTasks.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -108,7 +108,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.
 
 			
 
@@ -119,19 +119,19 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
 async function run() {
   const result = await serviceM8.tasks.createTasks({
-    uuid: "123e4567-a72d-4a44-883e-22b4dc3e260b",
     dueDate: "YYYY-MM-DD",
     name: "<value>",
     relatedObjectUuid: "123e4567-ea7a-418d-8bc7-22b4d6f88e8b",
     completedTimestamp: "YYYY-MM-DD HH:MM:SS",
     completedByStaffUuid: "123e4567-1596-433b-8657-22b4d1913aab",
     assignedToStaffUuid: "123e4567-299b-4b50-b21f-22b4d1057ebb",
+    uuid: "123e4567-a72d-4a44-883e-22b4dc3e260b",
     createdByStaffUuid: "123e4567-dd10-49af-ba90-22b4d80f729b",
     createDate: "YYYY-MM-DD HH:MM:SS",
   });
@@ -155,19 +155,19 @@ import { tasksCreateTasks } from "servicem8/funcs/tasksCreateTasks.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
 async function run() {
   const res = await tasksCreateTasks(serviceM8, {
-    uuid: "123e4567-a72d-4a44-883e-22b4dc3e260b",
     dueDate: "YYYY-MM-DD",
     name: "<value>",
     relatedObjectUuid: "123e4567-ea7a-418d-8bc7-22b4d6f88e8b",
     completedTimestamp: "YYYY-MM-DD HH:MM:SS",
     completedByStaffUuid: "123e4567-1596-433b-8657-22b4d1913aab",
     assignedToStaffUuid: "123e4567-299b-4b50-b21f-22b4d1057ebb",
+    uuid: "123e4567-a72d-4a44-883e-22b4dc3e260b",
     createdByStaffUuid: "123e4567-dd10-49af-ba90-22b4d80f729b",
     createDate: "YYYY-MM-DD HH:MM:SS",
   });
@@ -221,7 +221,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -249,7 +249,7 @@ import { tasksGetTasks } from "servicem8/funcs/tasksGetTasks.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -307,7 +307,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -315,13 +315,13 @@ async function run() {
   const result = await serviceM8.tasks.updateTasks({
     uuid: "63b2819d-65b6-4785-8dec-6cc2953e2c97",
     task: {
-      uuid: "123e4567-a72d-4a44-883e-22b4dc3e260b",
       dueDate: "YYYY-MM-DD",
       name: "<value>",
       relatedObjectUuid: "123e4567-ea7a-418d-8bc7-22b4d6f88e8b",
       completedTimestamp: "YYYY-MM-DD HH:MM:SS",
       completedByStaffUuid: "123e4567-1596-433b-8657-22b4d1913aab",
       assignedToStaffUuid: "123e4567-299b-4b50-b21f-22b4d1057ebb",
+      uuid: "123e4567-a72d-4a44-883e-22b4dc3e260b",
       createdByStaffUuid: "123e4567-dd10-49af-ba90-22b4d80f729b",
       createDate: "YYYY-MM-DD HH:MM:SS",
     },
@@ -346,7 +346,7 @@ import { tasksUpdateTasks } from "servicem8/funcs/tasksUpdateTasks.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -354,13 +354,13 @@ async function run() {
   const res = await tasksUpdateTasks(serviceM8, {
     uuid: "63b2819d-65b6-4785-8dec-6cc2953e2c97",
     task: {
-      uuid: "123e4567-a72d-4a44-883e-22b4dc3e260b",
       dueDate: "YYYY-MM-DD",
       name: "<value>",
       relatedObjectUuid: "123e4567-ea7a-418d-8bc7-22b4d6f88e8b",
       completedTimestamp: "YYYY-MM-DD HH:MM:SS",
       completedByStaffUuid: "123e4567-1596-433b-8657-22b4d1913aab",
       assignedToStaffUuid: "123e4567-299b-4b50-b21f-22b4d1057ebb",
+      uuid: "123e4567-a72d-4a44-883e-22b4dc3e260b",
       createdByStaffUuid: "123e4567-dd10-49af-ba90-22b4d80f729b",
       createDate: "YYYY-MM-DD HH:MM:SS",
     },
@@ -403,7 +403,7 @@ run();
 
 
 			
-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`.
 
 			
 			
@@ -419,7 +419,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -447,7 +447,7 @@ import { tasksDeleteTasks } from "servicem8/funcs/tasksDeleteTasks.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 

package/docs/sdks/taxrates/README.md

@@ -28,7 +28,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -54,7 +54,7 @@ import { taxRatesListTaxRates } from "servicem8/funcs/taxRatesListTaxRates.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -98,7 +98,7 @@ run();
 
 			
 #### 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.
 
 			
 
@@ -109,7 +109,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -138,7 +138,7 @@ import { taxRatesCreateTaxRates } from "servicem8/funcs/taxRatesCreateTaxRates.j
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -192,7 +192,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -220,7 +220,7 @@ import { taxRatesGetTaxRates } from "servicem8/funcs/taxRatesGetTaxRates.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -273,7 +273,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -305,7 +305,7 @@ import { taxRatesUpdateTaxRates } from "servicem8/funcs/taxRatesUpdateTaxRates.j
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -355,7 +355,7 @@ run();
 
 
 			
-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`.
 
 			
 
@@ -366,7 +366,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -394,7 +394,7 @@ import { taxRatesDeleteTaxRates } from "servicem8/funcs/taxRatesDeleteTaxRates.j
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 

package/docs/sdks/vendors/README.md

@@ -33,7 +33,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -59,7 +59,7 @@ import { vendorsListVendors } from "servicem8/funcs/vendorsListVendors.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -116,7 +116,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -144,7 +144,7 @@ import { vendorsGetVendors } from "servicem8/funcs/vendorsGetVendors.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -199,7 +199,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -231,7 +231,7 @@ import { vendorsUpdateVendors } from "servicem8/funcs/vendorsUpdateVendors.js";
 // You can create one instance of it to use across an application.
 const serviceM8 = new ServiceM8Core({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "servicem8",
-  "version": "0.3.15",
+  "version": "0.3.17",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "servicem8",
-  "version": "0.3.15",
+  "version": "0.3.17",
   "author": "ServiceM8",
   "type": "module",
   "bin": {

package/src/funcs/allocationWindowsCreateAllocationWindows.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * @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.
  */
 export function allocationWindowsCreateAllocationWindows(
   client: ServiceM8Core,

package/src/funcs/allocationWindowsDeleteAllocationWindows.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function allocationWindowsDeleteAllocationWindows(
   client: ServiceM8Core,

package/src/funcs/assetTypeFieldsCreateAssetTypeFields.ts

@@ -34,7 +34,7 @@ import { Result } from "../types/fp.js";
  * 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.
  */
 export function assetTypeFieldsCreateAssetTypeFields(
   client: ServiceM8Core,

package/src/funcs/assetTypeFieldsDeleteAssetTypeFields.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function assetTypeFieldsDeleteAssetTypeFields(
   client: ServiceM8Core,

package/src/funcs/assetTypesCreateAssetTypes.ts

@@ -34,7 +34,7 @@ import { Result } from "../types/fp.js";
  * 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.
  */
 export function assetTypesCreateAssetTypes(
   client: ServiceM8Core,

package/src/funcs/assetTypesDeleteAssetTypes.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function assetTypesDeleteAssetTypes(
   client: ServiceM8Core,

package/src/funcs/assetsDeleteAssets.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function assetsDeleteAssets(
   client: ServiceM8Core,

package/src/funcs/attachmentsCreateAttachments.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * @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.
  */
 export function attachmentsCreateAttachments(
   client: ServiceM8Core,

package/src/funcs/attachmentsDeleteAttachments.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function attachmentsDeleteAttachments(
   client: ServiceM8Core,

package/src/funcs/badgesCreateBadges.ts

@@ -34,7 +34,7 @@ import { Result } from "../types/fp.js";
  * 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.
  */
 export function badgesCreateBadges(
   client: ServiceM8Core,

package/src/funcs/badgesDeleteBadges.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function badgesDeleteBadges(
   client: ServiceM8Core,

package/src/funcs/bundlesCreateBundles.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * @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.
  */
 export function bundlesCreateBundles(
   client: ServiceM8Core,

package/src/funcs/bundlesDeleteBundles.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function bundlesDeleteBundles(
   client: ServiceM8Core,

package/src/funcs/categoriesCreateCategories.ts

@@ -34,7 +34,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_job_categories**.
  *
  * #### 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.
  */
 export function categoriesCreateCategories(
   client: ServiceM8Core,

package/src/funcs/categoriesDeleteCategories.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_job_categories**.

package/src/funcs/clientsCreateClients.ts

@@ -34,7 +34,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_customers**.
  *
  * #### 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.
  */
 export function clientsCreateClients(
   client: ServiceM8Core,

package/src/funcs/clientsDeleteClients.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_customers**.

package/src/funcs/companyContactsCreateCompanyContacts.ts

@@ -34,7 +34,7 @@ import { Result } from "../types/fp.js";
  * This endpoint requires the following OAuth scope **manage_customer_contacts**.
  *
  * #### 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.
  */
 export function companyContactsCreateCompanyContacts(
   client: ServiceM8Core,

package/src/funcs/companyContactsDeleteCompanyContacts.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  *
  * #### OAuth Scope
  * This endpoint requires the following OAuth scope **manage_customer_contacts**.

package/src/funcs/emailTemplatesCreateEmailTemplates.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * @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.
  */
 export function emailTemplatesCreateEmailTemplates(
   client: ServiceM8Core,

package/src/funcs/emailTemplatesDeleteEmailTemplates.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function emailTemplatesDeleteEmailTemplates(
   client: ServiceM8Core,

package/src/funcs/feedbackCreateFeedback.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * @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.
  */
 export function feedbackCreateFeedback(
   client: ServiceM8Core,

package/src/funcs/feedbackDeleteFeedback.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function feedbackDeleteFeedback(
   client: ServiceM8Core,

package/src/funcs/formFieldsCreateFormFields.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * @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.
  */
 export function formFieldsCreateFormFields(
   client: ServiceM8Core,

package/src/funcs/formFieldsDeleteFormFields.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function formFieldsDeleteFormFields(
   client: ServiceM8Core,

package/src/funcs/formResponsesCreateFormResponses.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * @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.
  */
 export function formResponsesCreateFormResponses(
   client: ServiceM8Core,

package/src/funcs/formResponsesDeleteFormResponses.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  */
 export function formResponsesDeleteFormResponses(
   client: ServiceM8Core,