servicem8 0.3.3 → 0.3.7

package/dist/commonjs/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "1.0.0";
-    readonly sdkVersion: "0.3.3";
+    readonly sdkVersion: "0.3.7";
     readonly genVersion: "2.593.4";
-    readonly userAgent: "speakeasy-sdk/typescript 0.3.3 2.593.4 1.0.0 servicem8";
+    readonly userAgent: "speakeasy-sdk/typescript 0.3.7 2.593.4 1.0.0 servicem8";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/commonjs/lib/config.js

@@ -28,8 +28,8 @@ function serverURLFromOptions(options) {
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "1.0.0",
-    sdkVersion: "0.3.3",
+    sdkVersion: "0.3.7",
     genVersion: "2.593.4",
-    userAgent: "speakeasy-sdk/typescript 0.3.3 2.593.4 1.0.0 servicem8",
+    userAgent: "speakeasy-sdk/typescript 0.3.7 2.593.4 1.0.0 servicem8",
 };
 //# sourceMappingURL=config.js.map

package/dist/commonjs/mcp-server/mcp-server.js

@@ -22,7 +22,7 @@ const routes = (0, core_1.buildRouteMap)({
 exports.app = (0, core_1.buildApplication)(routes, {
     name: "mcp",
     versionInfo: {
-        currentVersion: "0.3.3",
+        currentVersion: "0.3.7",
     },
 });
 (0, core_1.run)(exports.app, node_process_1.default.argv.slice(2), (0, cli_js_1.buildContext)(node_process_1.default));

package/dist/commonjs/mcp-server/server.js

@@ -184,7 +184,7 @@ const vendorsUpdateVendors_js_1 = require("./tools/vendorsUpdateVendors.js");
 function createMCPServer(deps) {
     const server = new mcp_js_1.McpServer({
         name: "ServiceM8",
-        version: "0.3.3",
+        version: "0.3.7",
     });
     const client = new core_js_1.ServiceM8Core({
         security: deps.security,

package/dist/esm/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "1.0.0";
-    readonly sdkVersion: "0.3.3";
+    readonly sdkVersion: "0.3.7";
     readonly genVersion: "2.593.4";
-    readonly userAgent: "speakeasy-sdk/typescript 0.3.3 2.593.4 1.0.0 servicem8";
+    readonly userAgent: "speakeasy-sdk/typescript 0.3.7 2.593.4 1.0.0 servicem8";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/esm/lib/config.js

@@ -24,8 +24,8 @@ export function serverURLFromOptions(options) {
 export const SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "1.0.0",
-    sdkVersion: "0.3.3",
+    sdkVersion: "0.3.7",
     genVersion: "2.593.4",
-    userAgent: "speakeasy-sdk/typescript 0.3.3 2.593.4 1.0.0 servicem8",
+    userAgent: "speakeasy-sdk/typescript 0.3.7 2.593.4 1.0.0 servicem8",
 };
 //# sourceMappingURL=config.js.map

package/dist/esm/mcp-server/mcp-server.js

@@ -16,7 +16,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
     name: "mcp",
     versionInfo: {
-        currentVersion: "0.3.3",
+        currentVersion: "0.3.7",
     },
 });
 run(app, process.argv.slice(2), buildContext(process));

package/dist/esm/mcp-server/server.js

@@ -181,7 +181,7 @@ import { tool$vendorsUpdateVendors } from "./tools/vendorsUpdateVendors.js";
 export function createMCPServer(deps) {
     const server = new McpServer({
         name: "ServiceM8",
-        version: "0.3.3",
+        version: "0.3.7",
     });
     const client = new ServiceM8Core({
         security: deps.security,

package/docs/sdks/allocationwindows/README.md

@@ -0,0 +1,433 @@
+# AllocationWindows
+(*allocationWindows*)
+
+## Overview
+
+Operations related to Allocation Windows
+
+### Available Operations
+
+* [listAllocationWindows](#listallocationwindows) - List all Allocation Windows
+* [createAllocationWindows](#createallocationwindows) - Create a new Allocation Window
+* [getAllocationWindows](#getallocationwindows) - Retrieve an Allocation Window
+* [updateAllocationWindows](#updateallocationwindows) - Update an Allocation Window
+* [deleteAllocationWindows](#deleteallocationwindows) - Delete an Allocation Window
+
+## listAllocationWindows
+
+
+			
+#### Filtering
+This endpoint supports result filtering. For more information on how to filter this request, [go here](/docs/filtering).
+			
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.allocationWindows.listAllocationWindows();
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { allocationWindowsListAllocationWindows } from "servicem8/funcs/allocationWindowsListAllocationWindows.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: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await allocationWindowsListAllocationWindows(serviceM8);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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.ListAllocationWindowsResponse](../../models/operations/listallocationwindowsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## createAllocationWindows
+
+
+			
+#### 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.
+
+			
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.allocationWindows.createAllocationWindows({
+    uuid: "123e4567-9668-4a12-bc72-22b4d86a47db",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { allocationWindowsCreateAllocationWindows } from "servicem8/funcs/allocationWindowsCreateAllocationWindows.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: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await allocationWindowsCreateAllocationWindows(serviceM8, {
+    uuid: "123e4567-9668-4a12-bc72-22b4d86a47db",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.AllocationWindowInput](../../models/components/allocationwindowinput.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.CreateAllocationWindowsResponse](../../models/operations/createallocationwindowsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## getAllocationWindows
+
+Retrieve an Allocation Window
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.allocationWindows.getAllocationWindows({
+    uuid: "4b696862-c2d8-4bfe-936b-d6716d1d97a4",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { allocationWindowsGetAllocationWindows } from "servicem8/funcs/allocationWindowsGetAllocationWindows.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: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await allocationWindowsGetAllocationWindows(serviceM8, {
+    uuid: "4b696862-c2d8-4bfe-936b-d6716d1d97a4",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetAllocationWindowsRequest](../../models/operations/getallocationwindowsrequest.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.GetAllocationWindowsResponse](../../models/operations/getallocationwindowsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## updateAllocationWindows
+
+Update an Allocation Window
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.allocationWindows.updateAllocationWindows({
+    uuid: "c0cdf698-ce1e-4a18-8dc8-7753e239240e",
+    allocationWindow: {
+      uuid: "123e4567-9668-4a12-bc72-22b4d86a47db",
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { allocationWindowsUpdateAllocationWindows } from "servicem8/funcs/allocationWindowsUpdateAllocationWindows.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: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await allocationWindowsUpdateAllocationWindows(serviceM8, {
+    uuid: "c0cdf698-ce1e-4a18-8dc8-7753e239240e",
+    allocationWindow: {
+      uuid: "123e4567-9668-4a12-bc72-22b4d86a47db",
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateAllocationWindowsRequest](../../models/operations/updateallocationwindowsrequest.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.UpdateAllocationWindowsResponse](../../models/operations/updateallocationwindowsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## deleteAllocationWindows
+
+
+			
+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.
+
+			
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.allocationWindows.deleteAllocationWindows({
+    uuid: "e4f73706-6c1c-46f5-b319-113193db25ca",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { allocationWindowsDeleteAllocationWindows } from "servicem8/funcs/allocationWindowsDeleteAllocationWindows.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: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await allocationWindowsDeleteAllocationWindows(serviceM8, {
+    uuid: "e4f73706-6c1c-46f5-b319-113193db25ca",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DeleteAllocationWindowsRequest](../../models/operations/deleteallocationwindowsrequest.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.DeleteAllocationWindowsResponse](../../models/operations/deleteallocationwindowsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |