servicem8 0.9.43 → 0.9.45

package/docs/sdks/staffmessages/README.md

@@ -8,7 +8,10 @@ Operations related to Staff Messages
 ### Available Operations
 
 * [listStaffMessages](#liststaffmessages) - List all Staff Messages
+* [createStaffMessages](#createstaffmessages) - Create a new Staff Message
 * [getStaffMessages](#getstaffmessages) - Retrieve a Staff Message
+* [updateStaffMessages](#updatestaffmessages) - Update a Staff Message
+* [deleteStaffMessages](#deletestaffmessages) - Delete a Staff Message
 
 ## listStaffMessages
 
@@ -96,6 +99,110 @@ run();
 | errors.ErrorT              | 500                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## createStaffMessages
+
+
+			
+#### OAuth Scope
+This endpoint requires the following OAuth scope **publish_messages**.
+
+			
+			
+#### 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.
+
+			
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="createStaffMessages" method="post" path="/staffmessage.json" -->
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.staffMessages.createStaffMessages({
+    uuid: "123e4567-1c8f-40c2-a5c0-233123836c5b",
+    fromStaffUuid: "123e4567-c43e-40f3-b36d-23312741015b",
+    toStaffUuid: "123e4567-f929-4647-9417-23312a8692bb",
+    sentTimestamp: "2025-09-01 12:00:00",
+    deliveredTimestamp: "2025-09-01 12:00:00",
+    readTimestamp: "2025-09-01 12:00:00",
+    regardingJobUuid: "123e4567-0219-4490-b8df-23312b5e0fbb",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { staffMessagesCreateStaffMessages } from "servicem8/funcs/staffMessagesCreateStaffMessages.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 staffMessagesCreateStaffMessages(serviceM8, {
+    uuid: "123e4567-1c8f-40c2-a5c0-233123836c5b",
+    fromStaffUuid: "123e4567-c43e-40f3-b36d-23312741015b",
+    toStaffUuid: "123e4567-f929-4647-9417-23312a8692bb",
+    sentTimestamp: "2025-09-01 12:00:00",
+    deliveredTimestamp: "2025-09-01 12:00:00",
+    readTimestamp: "2025-09-01 12:00:00",
+    regardingJobUuid: "123e4567-0219-4490-b8df-23312b5e0fbb",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("staffMessagesCreateStaffMessages failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.StaffMessageInput](../../models/components/staffmessageinput.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.CreateStaffMessagesResponse](../../models/operations/createstaffmessagesresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.ErrorT              | 400                        | application/json           |
+| errors.AuthenticationError | 401                        | application/json           |
+| errors.ForbiddenError      | 403                        | application/json           |
+| errors.RateLimitError      | 429                        | application/json           |
+| errors.ErrorT              | 500                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## getStaffMessages
 
 
@@ -174,6 +281,204 @@ run();
 
 ### Errors
 
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.ErrorT              | 400                        | application/json           |
+| errors.AuthenticationError | 401                        | application/json           |
+| errors.ForbiddenError      | 403                        | application/json           |
+| errors.NotFoundError       | 404                        | application/json           |
+| errors.RateLimitError      | 429                        | application/json           |
+| errors.ErrorT              | 500                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## updateStaffMessages
+
+
+			
+#### OAuth Scope
+This endpoint requires the following OAuth scope **publish_messages**.
+
+			
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="updateStaffMessages" method="post" path="/staffmessage/{uuid}.json" -->
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.staffMessages.updateStaffMessages({
+    uuid: "b5fd0f7a-6810-4261-acdb-e8e543cf4e72",
+    staffMessage: {
+      uuid: "123e4567-1c8f-40c2-a5c0-233123836c5b",
+      fromStaffUuid: "123e4567-c43e-40f3-b36d-23312741015b",
+      toStaffUuid: "123e4567-f929-4647-9417-23312a8692bb",
+      sentTimestamp: "2025-09-01 12:00:00",
+      deliveredTimestamp: "2025-09-01 12:00:00",
+      readTimestamp: "2025-09-01 12:00:00",
+      regardingJobUuid: "123e4567-0219-4490-b8df-23312b5e0fbb",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { staffMessagesUpdateStaffMessages } from "servicem8/funcs/staffMessagesUpdateStaffMessages.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 staffMessagesUpdateStaffMessages(serviceM8, {
+    uuid: "b5fd0f7a-6810-4261-acdb-e8e543cf4e72",
+    staffMessage: {
+      uuid: "123e4567-1c8f-40c2-a5c0-233123836c5b",
+      fromStaffUuid: "123e4567-c43e-40f3-b36d-23312741015b",
+      toStaffUuid: "123e4567-f929-4647-9417-23312a8692bb",
+      sentTimestamp: "2025-09-01 12:00:00",
+      deliveredTimestamp: "2025-09-01 12:00:00",
+      readTimestamp: "2025-09-01 12:00:00",
+      regardingJobUuid: "123e4567-0219-4490-b8df-23312b5e0fbb",
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("staffMessagesUpdateStaffMessages failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateStaffMessagesRequest](../../models/operations/updatestaffmessagesrequest.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\<[components.Result](../../models/components/result.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.ErrorT              | 400                        | application/json           |
+| errors.AuthenticationError | 401                        | application/json           |
+| errors.ForbiddenError      | 403                        | application/json           |
+| errors.NotFoundError       | 404                        | application/json           |
+| errors.RateLimitError      | 429                        | application/json           |
+| errors.ErrorT              | 500                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## deleteStaffMessages
+
+
+			
+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 **publish_messages**.
+
+			
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="deleteStaffMessages" method="delete" path="/staffmessage/{uuid}.json" -->
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.staffMessages.deleteStaffMessages({
+    uuid: "f09dd42b-85e0-454a-8494-c181a7fff788",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { staffMessagesDeleteStaffMessages } from "servicem8/funcs/staffMessagesDeleteStaffMessages.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 staffMessagesDeleteStaffMessages(serviceM8, {
+    uuid: "f09dd42b-85e0-454a-8494-c181a7fff788",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("staffMessagesDeleteStaffMessages failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DeleteStaffMessagesRequest](../../models/operations/deletestaffmessagesrequest.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\<[components.Result](../../models/components/result.md)\>**
+
+### Errors
+
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.ErrorT              | 400                        | application/json           |

package/docs/sdks/tasks/README.md

@@ -129,13 +129,13 @@ async function run() {
   const result = await serviceM8.tasks.createTasks({
     dueDate: "YYYY-MM-DD",
     name: "<value>",
-    relatedObjectUuid: "123e4567-befe-4749-8655-2322267c817b",
-    completedTimestamp: "2025-08-01 12:00:00",
-    completedByStaffUuid: "123e4567-0e5b-4e53-bb67-232229c425cb",
-    assignedToStaffUuid: "123e4567-a78d-4066-a382-2322283a02ab",
-    uuid: "123e4567-7a69-4bcf-9558-232225ab0e1b",
-    createdByStaffUuid: "123e4567-fad1-476e-a330-232227f6b1eb",
-    createDate: "2025-08-01 12:00:00",
+    relatedObjectUuid: "123e4567-f9eb-41c1-a5fd-23312ab7338b",
+    completedTimestamp: "2025-09-01 12:00:00",
+    completedByStaffUuid: "123e4567-e042-433e-af65-23312650743b",
+    assignedToStaffUuid: "123e4567-adeb-4ad5-822a-23312e91a59b",
+    uuid: "123e4567-a073-4c0b-b873-233126e2173b",
+    createdByStaffUuid: "123e4567-10fb-4bd7-89b3-23312b33259b",
+    createDate: "2025-09-01 12:00:00",
   });
 
   console.log(result);
@@ -164,13 +164,13 @@ async function run() {
   const res = await tasksCreateTasks(serviceM8, {
     dueDate: "YYYY-MM-DD",
     name: "<value>",
-    relatedObjectUuid: "123e4567-befe-4749-8655-2322267c817b",
-    completedTimestamp: "2025-08-01 12:00:00",
-    completedByStaffUuid: "123e4567-0e5b-4e53-bb67-232229c425cb",
-    assignedToStaffUuid: "123e4567-a78d-4066-a382-2322283a02ab",
-    uuid: "123e4567-7a69-4bcf-9558-232225ab0e1b",
-    createdByStaffUuid: "123e4567-fad1-476e-a330-232227f6b1eb",
-    createDate: "2025-08-01 12:00:00",
+    relatedObjectUuid: "123e4567-f9eb-41c1-a5fd-23312ab7338b",
+    completedTimestamp: "2025-09-01 12:00:00",
+    completedByStaffUuid: "123e4567-e042-433e-af65-23312650743b",
+    assignedToStaffUuid: "123e4567-adeb-4ad5-822a-23312e91a59b",
+    uuid: "123e4567-a073-4c0b-b873-233126e2173b",
+    createdByStaffUuid: "123e4567-10fb-4bd7-89b3-23312b33259b",
+    createDate: "2025-09-01 12:00:00",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -322,13 +322,13 @@ async function run() {
     task: {
       dueDate: "YYYY-MM-DD",
       name: "<value>",
-      relatedObjectUuid: "123e4567-befe-4749-8655-2322267c817b",
-      completedTimestamp: "2025-08-01 12:00:00",
-      completedByStaffUuid: "123e4567-0e5b-4e53-bb67-232229c425cb",
-      assignedToStaffUuid: "123e4567-a78d-4066-a382-2322283a02ab",
-      uuid: "123e4567-7a69-4bcf-9558-232225ab0e1b",
-      createdByStaffUuid: "123e4567-fad1-476e-a330-232227f6b1eb",
-      createDate: "2025-08-01 12:00:00",
+      relatedObjectUuid: "123e4567-f9eb-41c1-a5fd-23312ab7338b",
+      completedTimestamp: "2025-09-01 12:00:00",
+      completedByStaffUuid: "123e4567-e042-433e-af65-23312650743b",
+      assignedToStaffUuid: "123e4567-adeb-4ad5-822a-23312e91a59b",
+      uuid: "123e4567-a073-4c0b-b873-233126e2173b",
+      createdByStaffUuid: "123e4567-10fb-4bd7-89b3-23312b33259b",
+      createDate: "2025-09-01 12:00:00",
     },
   });
 
@@ -360,13 +360,13 @@ async function run() {
     task: {
       dueDate: "YYYY-MM-DD",
       name: "<value>",
-      relatedObjectUuid: "123e4567-befe-4749-8655-2322267c817b",
-      completedTimestamp: "2025-08-01 12:00:00",
-      completedByStaffUuid: "123e4567-0e5b-4e53-bb67-232229c425cb",
-      assignedToStaffUuid: "123e4567-a78d-4066-a382-2322283a02ab",
-      uuid: "123e4567-7a69-4bcf-9558-232225ab0e1b",
-      createdByStaffUuid: "123e4567-fad1-476e-a330-232227f6b1eb",
-      createDate: "2025-08-01 12:00:00",
+      relatedObjectUuid: "123e4567-f9eb-41c1-a5fd-23312ab7338b",
+      completedTimestamp: "2025-09-01 12:00:00",
+      completedByStaffUuid: "123e4567-e042-433e-af65-23312650743b",
+      assignedToStaffUuid: "123e4567-adeb-4ad5-822a-23312e91a59b",
+      uuid: "123e4567-a073-4c0b-b873-233126e2173b",
+      createdByStaffUuid: "123e4567-10fb-4bd7-89b3-23312b33259b",
+      createDate: "2025-09-01 12:00:00",
     },
   });
   if (res.ok) {

package/docs/sdks/taxrates/README.md

@@ -127,7 +127,7 @@ const serviceM8 = new ServiceM8({
 
 async function run() {
   const result = await serviceM8.taxRates.createTaxRates({
-    uuid: "123e4567-8057-4193-b6c8-23222e27682b",
+    uuid: "123e4567-7bd8-4d67-be76-2331257b5d3b",
     name: "<value>",
   });
 
@@ -155,7 +155,7 @@ const serviceM8 = new ServiceM8Core({
 
 async function run() {
   const res = await taxRatesCreateTaxRates(serviceM8, {
-    uuid: "123e4567-8057-4193-b6c8-23222e27682b",
+    uuid: "123e4567-7bd8-4d67-be76-2331257b5d3b",
     name: "<value>",
   });
   if (res.ok) {
@@ -306,7 +306,7 @@ async function run() {
   const result = await serviceM8.taxRates.updateTaxRates({
     uuid: "276d45f4-bf8b-41ae-82d4-264af7ec45cc",
     taxRate: {
-      uuid: "123e4567-8057-4193-b6c8-23222e27682b",
+      uuid: "123e4567-7bd8-4d67-be76-2331257b5d3b",
       name: "<value>",
     },
   });
@@ -337,7 +337,7 @@ async function run() {
   const res = await taxRatesUpdateTaxRates(serviceM8, {
     uuid: "276d45f4-bf8b-41ae-82d4-264af7ec45cc",
     taxRate: {
-      uuid: "123e4567-8057-4193-b6c8-23222e27682b",
+      uuid: "123e4567-7bd8-4d67-be76-2331257b5d3b",
       name: "<value>",
     },
   });

package/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "servicem8",
-      "version": "0.9.43",
+      "version": "0.9.45",
       "dependencies": {
         "zod": "^3.20.0"
       },

package/jsr.json

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

package/package.json

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