servicem8 0.3.15 → 0.3.17

package/docs/sdks/jobs/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 { jobsListJobs } from "servicem8/funcs/jobsListJobs.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 **create_jobs**.
 			
 			
 #### 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,35 +119,35 @@ 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.jobs.createJobs({
-    uuid: "123e4567-9443-40f8-a097-22b4d1d047fb",
     createdByStaffUuid: "123e4567-a308-44ce-a0e1-22b4d0829b3b",
     date: "YYYY-MM-DD",
     companyUuid: "123e4567-db1c-45f1-b8d3-22b4d70ec70b",
-    status: "<value>",
+    status: "Unsuccessful",
     paymentDate: "YYYY-MM-DD HH:MM:SS",
     paymentActionedByUuid: "123e4567-79d7-4031-8216-22b4d90caa2b",
     categoryUuid: "123e4567-1e98-4f7e-b691-22b4d501e20b",
     invoiceSentStamp: "YYYY-MM-DD HH:MM:SS",
     readyToInvoiceStamp: "YYYY-MM-DD HH:MM:SS",
-    paymentProcessedStamp: "YYYY-MM-DD HH:MM:SS",
     queueUuid: "123e4567-4eca-4c40-ae6d-22b4d3576c7b",
     queueExpiryDate: "YYYY-MM-DD HH:MM:SS",
     queueAssignedStaffUuid: "123e4567-b6b5-4aee-9f2e-22b4d13f676b",
-    paymentReceivedStamp: "YYYY-MM-DD HH:MM:SS",
     quoteDate: "YYYY-MM-DD HH:MM:SS",
     quoteSentStamp: "YYYY-MM-DD HH:MM:SS",
     workOrderDate: "YYYY-MM-DD HH:MM:SS",
+    activeNetworkRequestUuid: "123e4567-bf1f-4806-b2ac-22b4d33ee99b",
+    uuid: "123e4567-9443-40f8-a097-22b4d1d047fb",
+    paymentProcessedStamp: "YYYY-MM-DD HH:MM:SS",
+    paymentReceivedStamp: "YYYY-MM-DD HH:MM:SS",
     completionDate: "YYYY-MM-DD HH:MM:SS",
     completionActionedByUuid: "123e4567-ced8-4c56-90ff-22b4deca2cdb",
     unsuccessfulDate: "YYYY-MM-DD HH:MM:SS",
     jobIsScheduledUntilStamp: "YYYY-MM-DD HH:MM:SS",
-    activeNetworkRequestUuid: "123e4567-bf1f-4806-b2ac-22b4d33ee99b",
   });
 
   // Handle the result
@@ -169,35 +169,35 @@ import { jobsCreateJobs } from "servicem8/funcs/jobsCreateJobs.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 jobsCreateJobs(serviceM8, {
-    uuid: "123e4567-9443-40f8-a097-22b4d1d047fb",
     createdByStaffUuid: "123e4567-a308-44ce-a0e1-22b4d0829b3b",
     date: "YYYY-MM-DD",
     companyUuid: "123e4567-db1c-45f1-b8d3-22b4d70ec70b",
-    status: "<value>",
+    status: "Unsuccessful",
     paymentDate: "YYYY-MM-DD HH:MM:SS",
     paymentActionedByUuid: "123e4567-79d7-4031-8216-22b4d90caa2b",
     categoryUuid: "123e4567-1e98-4f7e-b691-22b4d501e20b",
     invoiceSentStamp: "YYYY-MM-DD HH:MM:SS",
     readyToInvoiceStamp: "YYYY-MM-DD HH:MM:SS",
-    paymentProcessedStamp: "YYYY-MM-DD HH:MM:SS",
     queueUuid: "123e4567-4eca-4c40-ae6d-22b4d3576c7b",
     queueExpiryDate: "YYYY-MM-DD HH:MM:SS",
     queueAssignedStaffUuid: "123e4567-b6b5-4aee-9f2e-22b4d13f676b",
-    paymentReceivedStamp: "YYYY-MM-DD HH:MM:SS",
     quoteDate: "YYYY-MM-DD HH:MM:SS",
     quoteSentStamp: "YYYY-MM-DD HH:MM:SS",
     workOrderDate: "YYYY-MM-DD HH:MM:SS",
+    activeNetworkRequestUuid: "123e4567-bf1f-4806-b2ac-22b4d33ee99b",
+    uuid: "123e4567-9443-40f8-a097-22b4d1d047fb",
+    paymentProcessedStamp: "YYYY-MM-DD HH:MM:SS",
+    paymentReceivedStamp: "YYYY-MM-DD HH:MM:SS",
     completionDate: "YYYY-MM-DD HH:MM:SS",
     completionActionedByUuid: "123e4567-ced8-4c56-90ff-22b4deca2cdb",
     unsuccessfulDate: "YYYY-MM-DD HH:MM:SS",
     jobIsScheduledUntilStamp: "YYYY-MM-DD HH:MM:SS",
-    activeNetworkRequestUuid: "123e4567-bf1f-4806-b2ac-22b4d33ee99b",
   });
 
   if (!res.ok) {
@@ -249,7 +249,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -277,7 +277,7 @@ import { jobsGetJobs } from "servicem8/funcs/jobsGetJobs.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"] ?? "",
   },
 });
 
@@ -335,7 +335,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -343,29 +343,29 @@ async function run() {
   const result = await serviceM8.jobs.updateJobs({
     uuid: "4f33e04f-a386-479f-8e76-bf95913d83ac",
     job: {
-      uuid: "123e4567-9443-40f8-a097-22b4d1d047fb",
       createdByStaffUuid: "123e4567-a308-44ce-a0e1-22b4d0829b3b",
       date: "YYYY-MM-DD",
       companyUuid: "123e4567-db1c-45f1-b8d3-22b4d70ec70b",
-      status: "<value>",
+      status: "Work Order",
       paymentDate: "YYYY-MM-DD HH:MM:SS",
       paymentActionedByUuid: "123e4567-79d7-4031-8216-22b4d90caa2b",
       categoryUuid: "123e4567-1e98-4f7e-b691-22b4d501e20b",
       invoiceSentStamp: "YYYY-MM-DD HH:MM:SS",
       readyToInvoiceStamp: "YYYY-MM-DD HH:MM:SS",
-      paymentProcessedStamp: "YYYY-MM-DD HH:MM:SS",
       queueUuid: "123e4567-4eca-4c40-ae6d-22b4d3576c7b",
       queueExpiryDate: "YYYY-MM-DD HH:MM:SS",
       queueAssignedStaffUuid: "123e4567-b6b5-4aee-9f2e-22b4d13f676b",
-      paymentReceivedStamp: "YYYY-MM-DD HH:MM:SS",
       quoteDate: "YYYY-MM-DD HH:MM:SS",
       quoteSentStamp: "YYYY-MM-DD HH:MM:SS",
       workOrderDate: "YYYY-MM-DD HH:MM:SS",
+      activeNetworkRequestUuid: "123e4567-bf1f-4806-b2ac-22b4d33ee99b",
+      uuid: "123e4567-9443-40f8-a097-22b4d1d047fb",
+      paymentProcessedStamp: "YYYY-MM-DD HH:MM:SS",
+      paymentReceivedStamp: "YYYY-MM-DD HH:MM:SS",
       completionDate: "YYYY-MM-DD HH:MM:SS",
       completionActionedByUuid: "123e4567-ced8-4c56-90ff-22b4deca2cdb",
       unsuccessfulDate: "YYYY-MM-DD HH:MM:SS",
       jobIsScheduledUntilStamp: "YYYY-MM-DD HH:MM:SS",
-      activeNetworkRequestUuid: "123e4567-bf1f-4806-b2ac-22b4d33ee99b",
     },
   });
 
@@ -388,7 +388,7 @@ import { jobsUpdateJobs } from "servicem8/funcs/jobsUpdateJobs.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"] ?? "",
   },
 });
 
@@ -396,29 +396,29 @@ async function run() {
   const res = await jobsUpdateJobs(serviceM8, {
     uuid: "4f33e04f-a386-479f-8e76-bf95913d83ac",
     job: {
-      uuid: "123e4567-9443-40f8-a097-22b4d1d047fb",
       createdByStaffUuid: "123e4567-a308-44ce-a0e1-22b4d0829b3b",
       date: "YYYY-MM-DD",
       companyUuid: "123e4567-db1c-45f1-b8d3-22b4d70ec70b",
-      status: "<value>",
+      status: "Work Order",
       paymentDate: "YYYY-MM-DD HH:MM:SS",
       paymentActionedByUuid: "123e4567-79d7-4031-8216-22b4d90caa2b",
       categoryUuid: "123e4567-1e98-4f7e-b691-22b4d501e20b",
       invoiceSentStamp: "YYYY-MM-DD HH:MM:SS",
       readyToInvoiceStamp: "YYYY-MM-DD HH:MM:SS",
-      paymentProcessedStamp: "YYYY-MM-DD HH:MM:SS",
       queueUuid: "123e4567-4eca-4c40-ae6d-22b4d3576c7b",
       queueExpiryDate: "YYYY-MM-DD HH:MM:SS",
       queueAssignedStaffUuid: "123e4567-b6b5-4aee-9f2e-22b4d13f676b",
-      paymentReceivedStamp: "YYYY-MM-DD HH:MM:SS",
       quoteDate: "YYYY-MM-DD HH:MM:SS",
       quoteSentStamp: "YYYY-MM-DD HH:MM:SS",
       workOrderDate: "YYYY-MM-DD HH:MM:SS",
+      activeNetworkRequestUuid: "123e4567-bf1f-4806-b2ac-22b4d33ee99b",
+      uuid: "123e4567-9443-40f8-a097-22b4d1d047fb",
+      paymentProcessedStamp: "YYYY-MM-DD HH:MM:SS",
+      paymentReceivedStamp: "YYYY-MM-DD HH:MM:SS",
       completionDate: "YYYY-MM-DD HH:MM:SS",
       completionActionedByUuid: "123e4567-ced8-4c56-90ff-22b4deca2cdb",
       unsuccessfulDate: "YYYY-MM-DD HH:MM:SS",
       jobIsScheduledUntilStamp: "YYYY-MM-DD HH:MM:SS",
-      activeNetworkRequestUuid: "123e4567-bf1f-4806-b2ac-22b4d33ee99b",
     },
   });
 
@@ -459,7 +459,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`.
 
 			
 			
@@ -475,7 +475,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -503,7 +503,7 @@ import { jobsDeleteJobs } from "servicem8/funcs/jobsDeleteJobs.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/knowledgearticles/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 { knowledgeArticlesListKnowledgeArticles } from "servicem8/funcs/knowledg
 // 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_knowledge**.
 			
 			
 #### 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,7 +119,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -148,7 +148,7 @@ import { knowledgeArticlesCreateKnowledgeArticles } from "servicem8/funcs/knowle
 // 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"] ?? "",
   },
 });
 
@@ -207,7 +207,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -235,7 +235,7 @@ import { knowledgeArticlesGetKnowledgeArticles } from "servicem8/funcs/knowledge
 // 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"] ?? "",
   },
 });
 
@@ -288,7 +288,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -320,7 +320,7 @@ import { knowledgeArticlesUpdateKnowledgeArticles } from "servicem8/funcs/knowle
 // 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"] ?? "",
   },
 });
 
@@ -370,7 +370,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`.
 
 			
 
@@ -381,7 +381,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -409,7 +409,7 @@ import { knowledgeArticlesDeleteKnowledgeArticles } from "servicem8/funcs/knowle
 // 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/locations/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 { locationsListLocations } from "servicem8/funcs/locationsListLocations.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"] ?? "",
   },
 });
 
@@ -108,7 +108,7 @@ This endpoint requires the following OAuth scope **manage_locations**.
 			
 			
 #### 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,14 +119,14 @@ 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.locations.createLocations({
-    uuid: "123e4567-05e7-48cd-a7e5-22b4d5838b3b",
     name: "<value>",
+    uuid: "123e4567-05e7-48cd-a7e5-22b4d5838b3b",
   });
 
   // Handle the result
@@ -148,14 +148,14 @@ import { locationsCreateLocations } from "servicem8/funcs/locationsCreateLocatio
 // 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 locationsCreateLocations(serviceM8, {
-    uuid: "123e4567-05e7-48cd-a7e5-22b4d5838b3b",
     name: "<value>",
+    uuid: "123e4567-05e7-48cd-a7e5-22b4d5838b3b",
   });
 
   if (!res.ok) {
@@ -207,7 +207,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -235,7 +235,7 @@ import { locationsGetLocations } from "servicem8/funcs/locationsGetLocations.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"] ?? "",
   },
 });
 
@@ -293,7 +293,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -301,8 +301,8 @@ async function run() {
   const result = await serviceM8.locations.updateLocations({
     uuid: "f05b34ba-ce1d-4329-a6e7-836cc33d661d",
     location: {
-      uuid: "123e4567-05e7-48cd-a7e5-22b4d5838b3b",
       name: "<value>",
+      uuid: "123e4567-05e7-48cd-a7e5-22b4d5838b3b",
     },
   });
 
@@ -325,7 +325,7 @@ import { locationsUpdateLocations } from "servicem8/funcs/locationsUpdateLocatio
 // 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"] ?? "",
   },
 });
 
@@ -333,8 +333,8 @@ async function run() {
   const res = await locationsUpdateLocations(serviceM8, {
     uuid: "f05b34ba-ce1d-4329-a6e7-836cc33d661d",
     location: {
-      uuid: "123e4567-05e7-48cd-a7e5-22b4d5838b3b",
       name: "<value>",
+      uuid: "123e4567-05e7-48cd-a7e5-22b4d5838b3b",
     },
   });
 
@@ -375,7 +375,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`.
 
 			
 			
@@ -391,7 +391,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -419,7 +419,7 @@ import { locationsDeleteLocations } from "servicem8/funcs/locationsDeleteLocatio
 // 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/materials/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 { materialsListMaterials } from "servicem8/funcs/materialsListMaterials.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"] ?? "",
   },
 });
 
@@ -108,7 +108,7 @@ This endpoint requires the following OAuth scope **manage_inventory**.
 			
 			
 #### 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,14 +119,14 @@ 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.materials.createMaterials({
-    uuid: "123e4567-429f-42f8-99b2-22b4d99c01fb",
     name: "<value>",
+    uuid: "123e4567-429f-42f8-99b2-22b4d99c01fb",
     taxRateUuid: "123e4567-a383-44b3-9a26-22b4d8639acb",
   });
 
@@ -149,14 +149,14 @@ import { materialsCreateMaterials } from "servicem8/funcs/materialsCreateMateria
 // 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 materialsCreateMaterials(serviceM8, {
-    uuid: "123e4567-429f-42f8-99b2-22b4d99c01fb",
     name: "<value>",
+    uuid: "123e4567-429f-42f8-99b2-22b4d99c01fb",
     taxRateUuid: "123e4567-a383-44b3-9a26-22b4d8639acb",
   });
 
@@ -209,7 +209,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -237,7 +237,7 @@ import { materialsGetMaterials } from "servicem8/funcs/materialsGetMaterials.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"] ?? "",
   },
 });
 
@@ -295,7 +295,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -303,8 +303,8 @@ async function run() {
   const result = await serviceM8.materials.updateMaterials({
     uuid: "f79ab30e-0472-4cdf-a61f-508f28b33d8e",
     material: {
-      uuid: "123e4567-429f-42f8-99b2-22b4d99c01fb",
       name: "<value>",
+      uuid: "123e4567-429f-42f8-99b2-22b4d99c01fb",
       taxRateUuid: "123e4567-a383-44b3-9a26-22b4d8639acb",
     },
   });
@@ -328,7 +328,7 @@ import { materialsUpdateMaterials } from "servicem8/funcs/materialsUpdateMateria
 // 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"] ?? "",
   },
 });
 
@@ -336,8 +336,8 @@ async function run() {
   const res = await materialsUpdateMaterials(serviceM8, {
     uuid: "f79ab30e-0472-4cdf-a61f-508f28b33d8e",
     material: {
-      uuid: "123e4567-429f-42f8-99b2-22b4d99c01fb",
       name: "<value>",
+      uuid: "123e4567-429f-42f8-99b2-22b4d99c01fb",
       taxRateUuid: "123e4567-a383-44b3-9a26-22b4d8639acb",
     },
   });
@@ -379,7 +379,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`.
 
 			
 			
@@ -395,7 +395,7 @@ import { ServiceM8 } from "servicem8";
 
 const serviceM8 = new ServiceM8({
   security: {
-    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+    apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
   },
 });
 
@@ -423,7 +423,7 @@ import { materialsDeleteMaterials } from "servicem8/funcs/materialsDeleteMateria
 // 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"] ?? "",
   },
 });