npm - servicem8 - Versions diffs - 0.7.0 → 0.8.0 - Mend

servicem8 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (735) hide show

package/docs/sdks/jobtemplates/README.md DELETED Viewed

@@ -1,535 +0,0 @@
-# JobTemplates
-(*jobTemplates*)
-## Overview
-Operations related to Job Templates
-### Available Operations
-* [listJobTemplates](#listjobtemplates) - List all Job Templates
-* [createJobTemplates](#createjobtemplates) - Create a new Job Template
-* [getJobTemplates](#getjobtemplates) - Retrieve a Job Template
-* [updateJobTemplates](#updatejobtemplates) - Update a Job Template
-* [deleteJobTemplates](#deletejobtemplates) - Delete a Job Template
-* [createJobFromTemplate](#createjobfromtemplate) - Create a job from a template
-## listJobTemplates
-#### Filtering
-This endpoint supports result filtering. For more information on how to filter this request, [go here](/docs/filtering).
-#### OAuth Scope
-This endpoint requires the following OAuth scope **read_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.listJobTemplates();
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { ServiceM8Core } from "servicem8/core.js";
-import { jobTemplatesListJobTemplates } from "servicem8/funcs/jobTemplatesListJobTemplates.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 jobTemplatesListJobTemplates(serviceM8);
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("jobTemplatesListJobTemplates failed:", res.error);
-  }
-}
-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.ListJobTemplatesResponse](../../models/operations/listjobtemplatesresponse.md)\>**
-### Errors
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorT    | 400              | application/json |
-| errors.APIError  | 4XX, 5XX         | \*/\*            |
-## createJobTemplates
-#### OAuth Scope
-This endpoint requires the following OAuth scope **manage_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 `x-record-uuid` response header.
-### 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.createJobTemplates({
-    uuid: "123e4567-92df-4f73-b4a2-22fc0bccb61b",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { ServiceM8Core } from "servicem8/core.js";
-import { jobTemplatesCreateJobTemplates } from "servicem8/funcs/jobTemplatesCreateJobTemplates.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 jobTemplatesCreateJobTemplates(serviceM8, {
-    uuid: "123e4567-92df-4f73-b4a2-22fc0bccb61b",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("jobTemplatesCreateJobTemplates failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.JobTemplateInput](../../models/components/jobtemplateinput.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.CreateJobTemplatesResponse](../../models/operations/createjobtemplatesresponse.md)\>**
-### Errors
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorT    | 400              | application/json |
-| errors.APIError  | 4XX, 5XX         | \*/\*            |
-## getJobTemplates
-#### OAuth Scope
-This endpoint requires the following OAuth scope **read_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.getJobTemplates({
-    uuid: "e49a9f4e-3739-4ad4-9990-80e39f58eba8",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { ServiceM8Core } from "servicem8/core.js";
-import { jobTemplatesGetJobTemplates } from "servicem8/funcs/jobTemplatesGetJobTemplates.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 jobTemplatesGetJobTemplates(serviceM8, {
-    uuid: "e49a9f4e-3739-4ad4-9990-80e39f58eba8",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("jobTemplatesGetJobTemplates failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetJobTemplatesRequest](../../models/operations/getjobtemplatesrequest.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.GetJobTemplatesResponse](../../models/operations/getjobtemplatesresponse.md)\>**
-### Errors
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorT    | 400              | application/json |
-| errors.APIError  | 4XX, 5XX         | \*/\*            |
-## updateJobTemplates
-#### 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.updateJobTemplates({
-    uuid: "c3cda462-77ac-4f6b-96fc-278f0e8e4121",
-    jobTemplate: {
-      uuid: "123e4567-92df-4f73-b4a2-22fc0bccb61b",
-    },
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { ServiceM8Core } from "servicem8/core.js";
-import { jobTemplatesUpdateJobTemplates } from "servicem8/funcs/jobTemplatesUpdateJobTemplates.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 jobTemplatesUpdateJobTemplates(serviceM8, {
-    uuid: "c3cda462-77ac-4f6b-96fc-278f0e8e4121",
-    jobTemplate: {
-      uuid: "123e4567-92df-4f73-b4a2-22fc0bccb61b",
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("jobTemplatesUpdateJobTemplates failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.UpdateJobTemplatesRequest](../../models/operations/updatejobtemplatesrequest.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.UpdateJobTemplatesResponse](../../models/operations/updatejobtemplatesresponse.md)\>**
-### Errors
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorT    | 400              | application/json |
-| errors.APIError  | 4XX, 5XX         | \*/\*            |
-## deleteJobTemplates
-In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
-#### OAuth Scope
-This endpoint requires the following OAuth scope **manage_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.deleteJobTemplates({
-    uuid: "5d496bf1-4e89-44b0-bb5d-221123f5cb4f",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { ServiceM8Core } from "servicem8/core.js";
-import { jobTemplatesDeleteJobTemplates } from "servicem8/funcs/jobTemplatesDeleteJobTemplates.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 jobTemplatesDeleteJobTemplates(serviceM8, {
-    uuid: "5d496bf1-4e89-44b0-bb5d-221123f5cb4f",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("jobTemplatesDeleteJobTemplates failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DeleteJobTemplatesRequest](../../models/operations/deletejobtemplatesrequest.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.DeleteJobTemplatesResponse](../../models/operations/deletejobtemplatesresponse.md)\>**
-### Errors
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorT    | 400              | application/json |
-| errors.APIError  | 4XX, 5XX         | \*/\*            |
-## 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         | \*/\*            |