servicem8 0.8.0 → 0.9.0

package/docs/sdks/jobs/README.md

@@ -121,25 +121,25 @@ const serviceM8 = new ServiceM8({
 
 async function run() {
   const result = await serviceM8.jobs.createJobs({
-    createdByStaffUuid: "123e4567-10bf-401e-8fea-22fc0ad143eb",
+    createdByStaffUuid: "123e4567-17ed-499e-b5cc-22fd8922cb5b",
     date: "YYYY-MM-DD",
-    companyUuid: "123e4567-895a-4f4d-a730-22fc0c4091fb",
+    companyUuid: "123e4567-9737-4bff-bead-22fd8f6ea44b",
     status: "Unsuccessful",
     paymentDate: "2025-07-01 12:00:00",
-    paymentActionedByUuid: "123e4567-e844-43d2-8fe9-22fc05dc017b",
-    categoryUuid: "123e4567-2ceb-4c0b-8b98-22fc08ca836b",
+    paymentActionedByUuid: "123e4567-5ce8-4ed9-8d01-22fd8715648b",
+    categoryUuid: "123e4567-442a-41cd-8595-22fd8ce7341b",
     invoiceSentStamp: "2025-07-01 12:00:00",
-    queueUuid: "123e4567-05f3-44d9-a9ae-22fc03d520cb",
+    queueUuid: "123e4567-d015-4766-9b61-22fd88eedb5b",
     queueExpiryDate: "2025-07-01 12:00:00",
-    queueAssignedStaffUuid: "123e4567-49b9-41bc-8ee9-22fc0b9f949b",
+    queueAssignedStaffUuid: "123e4567-ba50-40b3-afd9-22fd87c1ccab",
     quoteDate: "2025-07-01 12:00:00",
     quoteSentStamp: "2025-07-01 12:00:00",
     workOrderDate: "2025-07-01 12:00:00",
-    uuid: "123e4567-aa4a-4c67-aba5-22fc0acc52cb",
+    uuid: "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
     paymentProcessedStamp: "2025-07-01 12:00:00",
     paymentReceivedStamp: "2025-07-01 12:00:00",
     completionDate: "2025-07-01 12:00:00",
-    completionActionedByUuid: "123e4567-3bed-4708-b906-22fc0b77a9db",
+    completionActionedByUuid: "123e4567-b501-4400-be53-22fd83e6a36b",
     unsuccessfulDate: "2025-07-01 12:00:00",
     jobIsScheduledUntilStamp: "2025-07-01 12:00:00",
   });
@@ -168,25 +168,25 @@ const serviceM8 = new ServiceM8Core({
 
 async function run() {
   const res = await jobsCreateJobs(serviceM8, {
-    createdByStaffUuid: "123e4567-10bf-401e-8fea-22fc0ad143eb",
+    createdByStaffUuid: "123e4567-17ed-499e-b5cc-22fd8922cb5b",
     date: "YYYY-MM-DD",
-    companyUuid: "123e4567-895a-4f4d-a730-22fc0c4091fb",
+    companyUuid: "123e4567-9737-4bff-bead-22fd8f6ea44b",
     status: "Unsuccessful",
     paymentDate: "2025-07-01 12:00:00",
-    paymentActionedByUuid: "123e4567-e844-43d2-8fe9-22fc05dc017b",
-    categoryUuid: "123e4567-2ceb-4c0b-8b98-22fc08ca836b",
+    paymentActionedByUuid: "123e4567-5ce8-4ed9-8d01-22fd8715648b",
+    categoryUuid: "123e4567-442a-41cd-8595-22fd8ce7341b",
     invoiceSentStamp: "2025-07-01 12:00:00",
-    queueUuid: "123e4567-05f3-44d9-a9ae-22fc03d520cb",
+    queueUuid: "123e4567-d015-4766-9b61-22fd88eedb5b",
     queueExpiryDate: "2025-07-01 12:00:00",
-    queueAssignedStaffUuid: "123e4567-49b9-41bc-8ee9-22fc0b9f949b",
+    queueAssignedStaffUuid: "123e4567-ba50-40b3-afd9-22fd87c1ccab",
     quoteDate: "2025-07-01 12:00:00",
     quoteSentStamp: "2025-07-01 12:00:00",
     workOrderDate: "2025-07-01 12:00:00",
-    uuid: "123e4567-aa4a-4c67-aba5-22fc0acc52cb",
+    uuid: "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
     paymentProcessedStamp: "2025-07-01 12:00:00",
     paymentReceivedStamp: "2025-07-01 12:00:00",
     completionDate: "2025-07-01 12:00:00",
-    completionActionedByUuid: "123e4567-3bed-4708-b906-22fc0b77a9db",
+    completionActionedByUuid: "123e4567-b501-4400-be53-22fd83e6a36b",
     unsuccessfulDate: "2025-07-01 12:00:00",
     jobIsScheduledUntilStamp: "2025-07-01 12:00:00",
   });
@@ -327,25 +327,25 @@ async function run() {
   const result = await serviceM8.jobs.updateJobs({
     uuid: "f751bf5c-f1f2-4a20-8df3-7628082340b1",
     job: {
-      createdByStaffUuid: "123e4567-10bf-401e-8fea-22fc0ad143eb",
+      createdByStaffUuid: "123e4567-17ed-499e-b5cc-22fd8922cb5b",
       date: "YYYY-MM-DD",
-      companyUuid: "123e4567-895a-4f4d-a730-22fc0c4091fb",
+      companyUuid: "123e4567-9737-4bff-bead-22fd8f6ea44b",
       status: "Work Order",
       paymentDate: "2025-07-01 12:00:00",
-      paymentActionedByUuid: "123e4567-e844-43d2-8fe9-22fc05dc017b",
-      categoryUuid: "123e4567-2ceb-4c0b-8b98-22fc08ca836b",
+      paymentActionedByUuid: "123e4567-5ce8-4ed9-8d01-22fd8715648b",
+      categoryUuid: "123e4567-442a-41cd-8595-22fd8ce7341b",
       invoiceSentStamp: "2025-07-01 12:00:00",
-      queueUuid: "123e4567-05f3-44d9-a9ae-22fc03d520cb",
+      queueUuid: "123e4567-d015-4766-9b61-22fd88eedb5b",
       queueExpiryDate: "2025-07-01 12:00:00",
-      queueAssignedStaffUuid: "123e4567-49b9-41bc-8ee9-22fc0b9f949b",
+      queueAssignedStaffUuid: "123e4567-ba50-40b3-afd9-22fd87c1ccab",
       quoteDate: "2025-07-01 12:00:00",
       quoteSentStamp: "2025-07-01 12:00:00",
       workOrderDate: "2025-07-01 12:00:00",
-      uuid: "123e4567-aa4a-4c67-aba5-22fc0acc52cb",
+      uuid: "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
       paymentProcessedStamp: "2025-07-01 12:00:00",
       paymentReceivedStamp: "2025-07-01 12:00:00",
       completionDate: "2025-07-01 12:00:00",
-      completionActionedByUuid: "123e4567-3bed-4708-b906-22fc0b77a9db",
+      completionActionedByUuid: "123e4567-b501-4400-be53-22fd83e6a36b",
       unsuccessfulDate: "2025-07-01 12:00:00",
       jobIsScheduledUntilStamp: "2025-07-01 12:00:00",
     },
@@ -377,25 +377,25 @@ async function run() {
   const res = await jobsUpdateJobs(serviceM8, {
     uuid: "f751bf5c-f1f2-4a20-8df3-7628082340b1",
     job: {
-      createdByStaffUuid: "123e4567-10bf-401e-8fea-22fc0ad143eb",
+      createdByStaffUuid: "123e4567-17ed-499e-b5cc-22fd8922cb5b",
       date: "YYYY-MM-DD",
-      companyUuid: "123e4567-895a-4f4d-a730-22fc0c4091fb",
+      companyUuid: "123e4567-9737-4bff-bead-22fd8f6ea44b",
       status: "Work Order",
       paymentDate: "2025-07-01 12:00:00",
-      paymentActionedByUuid: "123e4567-e844-43d2-8fe9-22fc05dc017b",
-      categoryUuid: "123e4567-2ceb-4c0b-8b98-22fc08ca836b",
+      paymentActionedByUuid: "123e4567-5ce8-4ed9-8d01-22fd8715648b",
+      categoryUuid: "123e4567-442a-41cd-8595-22fd8ce7341b",
       invoiceSentStamp: "2025-07-01 12:00:00",
-      queueUuid: "123e4567-05f3-44d9-a9ae-22fc03d520cb",
+      queueUuid: "123e4567-d015-4766-9b61-22fd88eedb5b",
       queueExpiryDate: "2025-07-01 12:00:00",
-      queueAssignedStaffUuid: "123e4567-49b9-41bc-8ee9-22fc0b9f949b",
+      queueAssignedStaffUuid: "123e4567-ba50-40b3-afd9-22fd87c1ccab",
       quoteDate: "2025-07-01 12:00:00",
       quoteSentStamp: "2025-07-01 12:00:00",
       workOrderDate: "2025-07-01 12:00:00",
-      uuid: "123e4567-aa4a-4c67-aba5-22fc0acc52cb",
+      uuid: "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
       paymentProcessedStamp: "2025-07-01 12:00:00",
       paymentReceivedStamp: "2025-07-01 12:00:00",
       completionDate: "2025-07-01 12:00:00",
-      completionActionedByUuid: "123e4567-3bed-4708-b906-22fc0b77a9db",
+      completionActionedByUuid: "123e4567-b501-4400-be53-22fd83e6a36b",
       unsuccessfulDate: "2025-07-01 12:00:00",
       jobIsScheduledUntilStamp: "2025-07-01 12:00:00",
     },

package/docs/sdks/jobtemplates/README.md

@@ -0,0 +1,104 @@
+# JobTemplates
+(*jobTemplates*)
+
+## Overview
+
+### Available Operations
+
+* [createJobFromTemplate](#createjobfromtemplate) - Create a job from a template
+
+## createJobFromTemplate
+
+Creates a new job by cloning an existing job template. All template entities (tasks, materials, checklists, quotes, custom fields) are cloned to the new job.
+
+#### Field Overrides
+Only the following fields can be overridden when creating a job from a template:
+- `job_description` - Job description
+- `company_uuid` - UUID of the company/client
+- `job_address` - Street address for the job
+
+Any other fields in the request body will be ignored.
+
+#### OAuth Scope
+This endpoint requires the following OAuth scope **manage_jobs**.
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.jobTemplates.createJobFromTemplate({
+    uuid: "550e8400-e29b-41d4-a716-446655440000",
+    jobTemplateOverrides: {
+      companyUuid: "550e8400-e29b-41d4-a716-446655440001",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { jobTemplatesCreateJobFromTemplate } from "servicem8/funcs/jobTemplatesCreateJobFromTemplate.js";
+
+// Use `ServiceM8Core` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const serviceM8 = new ServiceM8Core({
+  security: {
+    apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await jobTemplatesCreateJobFromTemplate(serviceM8, {
+    uuid: "550e8400-e29b-41d4-a716-446655440000",
+    jobTemplateOverrides: {
+      companyUuid: "550e8400-e29b-41d4-a716-446655440001",
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("jobTemplatesCreateJobFromTemplate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CreateJobFromTemplateRequest](../../models/operations/createjobfromtemplaterequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.CreateJobFromTemplateResponse](../../models/operations/createjobfromtemplateresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400, 403, 404    | application/json |
+| errors.ErrorT    | 405              | application/json |
+| errors.ErrorT    | 500              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |

package/docs/sdks/knowledgearticles/README.md

@@ -121,7 +121,7 @@ const serviceM8 = new ServiceM8({
 
 async function run() {
   const result = await serviceM8.knowledgeArticles.createKnowledgeArticles({
-    uuid: "123e4567-319c-42b5-a7ca-22fc080147db",
+    uuid: "123e4567-02ce-47cc-a353-22fd851ac5ab",
     name: "<value>",
   });
 
@@ -149,7 +149,7 @@ const serviceM8 = new ServiceM8Core({
 
 async function run() {
   const res = await knowledgeArticlesCreateKnowledgeArticles(serviceM8, {
-    uuid: "123e4567-319c-42b5-a7ca-22fc080147db",
+    uuid: "123e4567-02ce-47cc-a353-22fd851ac5ab",
     name: "<value>",
   });
   if (res.ok) {
@@ -289,7 +289,7 @@ async function run() {
   const result = await serviceM8.knowledgeArticles.updateKnowledgeArticles({
     uuid: "a643fa14-496b-46a5-88bc-4e67bb92bafd",
     knowledgeArticle: {
-      uuid: "123e4567-319c-42b5-a7ca-22fc080147db",
+      uuid: "123e4567-02ce-47cc-a353-22fd851ac5ab",
       name: "<value>",
     },
   });
@@ -320,7 +320,7 @@ async function run() {
   const res = await knowledgeArticlesUpdateKnowledgeArticles(serviceM8, {
     uuid: "a643fa14-496b-46a5-88bc-4e67bb92bafd",
     knowledgeArticle: {
-      uuid: "123e4567-319c-42b5-a7ca-22fc080147db",
+      uuid: "123e4567-02ce-47cc-a353-22fd851ac5ab",
       name: "<value>",
     },
   });

package/docs/sdks/locations/README.md

@@ -122,7 +122,7 @@ const serviceM8 = new ServiceM8({
 async function run() {
   const result = await serviceM8.locations.createLocations({
     name: "<value>",
-    uuid: "123e4567-4fb7-4a11-a01b-22fc098ba7ab",
+    uuid: "123e4567-50ec-4117-b93f-22fd86574f2b",
   });
 
   console.log(result);
@@ -150,7 +150,7 @@ const serviceM8 = new ServiceM8Core({
 async function run() {
   const res = await locationsCreateLocations(serviceM8, {
     name: "<value>",
-    uuid: "123e4567-4fb7-4a11-a01b-22fc098ba7ab",
+    uuid: "123e4567-50ec-4117-b93f-22fd86574f2b",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -290,7 +290,7 @@ async function run() {
     uuid: "fee3b1fa-ab4e-4094-823d-0885a2f7b69f",
     location: {
       name: "<value>",
-      uuid: "123e4567-4fb7-4a11-a01b-22fc098ba7ab",
+      uuid: "123e4567-50ec-4117-b93f-22fd86574f2b",
     },
   });
 
@@ -321,7 +321,7 @@ async function run() {
     uuid: "fee3b1fa-ab4e-4094-823d-0885a2f7b69f",
     location: {
       name: "<value>",
-      uuid: "123e4567-4fb7-4a11-a01b-22fc098ba7ab",
+      uuid: "123e4567-50ec-4117-b93f-22fd86574f2b",
     },
   });
   if (res.ok) {

package/docs/sdks/materials/README.md

@@ -122,8 +122,8 @@ const serviceM8 = new ServiceM8({
 async function run() {
   const result = await serviceM8.materials.createMaterials({
     name: "<value>",
-    uuid: "123e4567-a4f0-4472-b9d0-22fc07638c4b",
-    taxRateUuid: "123e4567-c1f2-44d1-8258-22fc04717cdb",
+    uuid: "123e4567-e9cf-4eab-97b5-22fd84f1aa9b",
+    taxRateUuid: "123e4567-eddf-4538-b5b7-22fd807ae23b",
   });
 
   console.log(result);
@@ -151,8 +151,8 @@ const serviceM8 = new ServiceM8Core({
 async function run() {
   const res = await materialsCreateMaterials(serviceM8, {
     name: "<value>",
-    uuid: "123e4567-a4f0-4472-b9d0-22fc07638c4b",
-    taxRateUuid: "123e4567-c1f2-44d1-8258-22fc04717cdb",
+    uuid: "123e4567-e9cf-4eab-97b5-22fd84f1aa9b",
+    taxRateUuid: "123e4567-eddf-4538-b5b7-22fd807ae23b",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -292,8 +292,8 @@ async function run() {
     uuid: "8a4aa688-8b41-4ab3-b862-24327504b606",
     material: {
       name: "<value>",
-      uuid: "123e4567-a4f0-4472-b9d0-22fc07638c4b",
-      taxRateUuid: "123e4567-c1f2-44d1-8258-22fc04717cdb",
+      uuid: "123e4567-e9cf-4eab-97b5-22fd84f1aa9b",
+      taxRateUuid: "123e4567-eddf-4538-b5b7-22fd807ae23b",
     },
   });
 
@@ -324,8 +324,8 @@ async function run() {
     uuid: "8a4aa688-8b41-4ab3-b862-24327504b606",
     material: {
       name: "<value>",
-      uuid: "123e4567-a4f0-4472-b9d0-22fc07638c4b",
-      taxRateUuid: "123e4567-c1f2-44d1-8258-22fc04717cdb",
+      uuid: "123e4567-e9cf-4eab-97b5-22fd84f1aa9b",
+      taxRateUuid: "123e4567-eddf-4538-b5b7-22fd807ae23b",
     },
   });
   if (res.ok) {

package/docs/sdks/notes/README.md

@@ -111,9 +111,9 @@ const serviceM8 = new ServiceM8({
 
 async function run() {
   const result = await serviceM8.notes.createNotes({
-    uuid: "123e4567-5386-4286-9d03-22fc02853d7b",
-    relatedObjectUuid: "123e4567-6b99-4cf2-965c-22fc0b93844b",
-    actionCompletedByStaffUuid: "123e4567-8be2-4f69-a718-22fc041af7eb",
+    uuid: "123e4567-1f95-4ea2-b9d8-22fd8f59c73b",
+    relatedObjectUuid: "123e4567-c873-425f-ae77-22fd8305f44b",
+    actionCompletedByStaffUuid: "123e4567-2350-4f3f-b5c4-22fd86c2948b",
     createDate: "2025-07-01 12:00:00",
   });
 
@@ -141,9 +141,9 @@ const serviceM8 = new ServiceM8Core({
 
 async function run() {
   const res = await notesCreateNotes(serviceM8, {
-    uuid: "123e4567-5386-4286-9d03-22fc02853d7b",
-    relatedObjectUuid: "123e4567-6b99-4cf2-965c-22fc0b93844b",
-    actionCompletedByStaffUuid: "123e4567-8be2-4f69-a718-22fc041af7eb",
+    uuid: "123e4567-1f95-4ea2-b9d8-22fd8f59c73b",
+    relatedObjectUuid: "123e4567-c873-425f-ae77-22fd8305f44b",
+    actionCompletedByStaffUuid: "123e4567-2350-4f3f-b5c4-22fd86c2948b",
     createDate: "2025-07-01 12:00:00",
   });
   if (res.ok) {
@@ -273,9 +273,9 @@ async function run() {
   const result = await serviceM8.notes.updateNotes({
     uuid: "1607abff-6202-4423-ae91-39b08699f830",
     note: {
-      uuid: "123e4567-5386-4286-9d03-22fc02853d7b",
-      relatedObjectUuid: "123e4567-6b99-4cf2-965c-22fc0b93844b",
-      actionCompletedByStaffUuid: "123e4567-8be2-4f69-a718-22fc041af7eb",
+      uuid: "123e4567-1f95-4ea2-b9d8-22fd8f59c73b",
+      relatedObjectUuid: "123e4567-c873-425f-ae77-22fd8305f44b",
+      actionCompletedByStaffUuid: "123e4567-2350-4f3f-b5c4-22fd86c2948b",
       createDate: "2025-07-01 12:00:00",
     },
   });
@@ -306,9 +306,9 @@ async function run() {
   const res = await notesUpdateNotes(serviceM8, {
     uuid: "1607abff-6202-4423-ae91-39b08699f830",
     note: {
-      uuid: "123e4567-5386-4286-9d03-22fc02853d7b",
-      relatedObjectUuid: "123e4567-6b99-4cf2-965c-22fc0b93844b",
-      actionCompletedByStaffUuid: "123e4567-8be2-4f69-a718-22fc041af7eb",
+      uuid: "123e4567-1f95-4ea2-b9d8-22fd8f59c73b",
+      relatedObjectUuid: "123e4567-c873-425f-ae77-22fd8305f44b",
+      actionCompletedByStaffUuid: "123e4567-2350-4f3f-b5c4-22fd86c2948b",
       createDate: "2025-07-01 12:00:00",
     },
   });