servicem8 0.3.3 → 0.3.8

package/docs/sdks/jobchecklists/README.md

@@ -0,0 +1,477 @@
+# JobChecklists
+(*jobChecklists*)
+
+## Overview
+
+Operations related to Job Checklists
+
+### Available Operations
+
+* [listJobChecklists](#listjobchecklists) - List all Job Checklists
+* [createJobChecklists](#createjobchecklists) - Create a new Job Checklist
+* [getJobChecklists](#getjobchecklists) - Retrieve a Job Checklist
+* [updateJobChecklists](#updatejobchecklists) - Update a Job Checklist
+* [deleteJobChecklists](#deletejobchecklists) - Delete a Job Checklist
+
+## listJobChecklists
+
+
+			
+#### 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.jobChecklists.listJobChecklists();
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { jobChecklistsListJobChecklists } from "servicem8/funcs/jobChecklistsListJobChecklists.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 jobChecklistsListJobChecklists(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.ListJobChecklistsResponse](../../models/operations/listjobchecklistsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## createJobChecklists
+
+
+			
+#### 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.jobChecklists.createJobChecklists({
+    uuid: "123e4567-3623-4f70-a1f2-22b4d3b4984b",
+    jobUuid: "123e4567-1ea9-4bb9-bb2b-22b4dfbee22b",
+    completedTimestamp: "YYYY-MM-DD HH:MM:SS",
+    completedByStaffUuid: "123e4567-eef3-47c4-b315-22b4d574572b",
+    completedDuringCheckinUuid: "123e4567-8fd6-4a37-a6ad-22b4d367118b",
+    regardingObjectUuid: "123e4567-d5c2-4c2c-bd1b-22b4d7ac90cb",
+    fulfilledByObjectUuid: "123e4567-b18b-4214-9d95-22b4d816852b",
+    assignedToStaffUuids: [
+      "123e4567-0d10-4e2e-be7f-22b4d23beabb",
+    ],
+    assignedTimestamp: "YYYY-MM-DD HH:MM:SS",
+    assignedByStaffUuid: "123e4567-dce7-476d-83aa-22b4df0fc2ab",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { jobChecklistsCreateJobChecklists } from "servicem8/funcs/jobChecklistsCreateJobChecklists.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 jobChecklistsCreateJobChecklists(serviceM8, {
+    uuid: "123e4567-3623-4f70-a1f2-22b4d3b4984b",
+    jobUuid: "123e4567-1ea9-4bb9-bb2b-22b4dfbee22b",
+    completedTimestamp: "YYYY-MM-DD HH:MM:SS",
+    completedByStaffUuid: "123e4567-eef3-47c4-b315-22b4d574572b",
+    completedDuringCheckinUuid: "123e4567-8fd6-4a37-a6ad-22b4d367118b",
+    regardingObjectUuid: "123e4567-d5c2-4c2c-bd1b-22b4d7ac90cb",
+    fulfilledByObjectUuid: "123e4567-b18b-4214-9d95-22b4d816852b",
+    assignedToStaffUuids: [
+      "123e4567-0d10-4e2e-be7f-22b4d23beabb",
+    ],
+    assignedTimestamp: "YYYY-MM-DD HH:MM:SS",
+    assignedByStaffUuid: "123e4567-dce7-476d-83aa-22b4df0fc2ab",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.JobChecklistInput](../../models/components/jobchecklistinput.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.CreateJobChecklistsResponse](../../models/operations/createjobchecklistsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## getJobChecklists
+
+Retrieve a Job Checklist
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.jobChecklists.getJobChecklists({
+    uuid: "63a0aea3-0abf-4ee8-b0d9-411f9216037e",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { jobChecklistsGetJobChecklists } from "servicem8/funcs/jobChecklistsGetJobChecklists.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 jobChecklistsGetJobChecklists(serviceM8, {
+    uuid: "63a0aea3-0abf-4ee8-b0d9-411f9216037e",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetJobChecklistsRequest](../../models/operations/getjobchecklistsrequest.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.GetJobChecklistsResponse](../../models/operations/getjobchecklistsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## updateJobChecklists
+
+Update a Job Checklist
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.jobChecklists.updateJobChecklists({
+    uuid: "d290308e-bcb7-4801-8437-ef8f8d4f4a60",
+    jobChecklist: {
+      uuid: "123e4567-3623-4f70-a1f2-22b4d3b4984b",
+      jobUuid: "123e4567-1ea9-4bb9-bb2b-22b4dfbee22b",
+      completedTimestamp: "YYYY-MM-DD HH:MM:SS",
+      completedByStaffUuid: "123e4567-eef3-47c4-b315-22b4d574572b",
+      completedDuringCheckinUuid: "123e4567-8fd6-4a37-a6ad-22b4d367118b",
+      regardingObjectUuid: "123e4567-d5c2-4c2c-bd1b-22b4d7ac90cb",
+      fulfilledByObjectUuid: "123e4567-b18b-4214-9d95-22b4d816852b",
+      assignedToStaffUuids: [
+        "123e4567-0d10-4e2e-be7f-22b4d23beabb",
+      ],
+      assignedTimestamp: "YYYY-MM-DD HH:MM:SS",
+      assignedByStaffUuid: "123e4567-dce7-476d-83aa-22b4df0fc2ab",
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { jobChecklistsUpdateJobChecklists } from "servicem8/funcs/jobChecklistsUpdateJobChecklists.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 jobChecklistsUpdateJobChecklists(serviceM8, {
+    uuid: "d290308e-bcb7-4801-8437-ef8f8d4f4a60",
+    jobChecklist: {
+      uuid: "123e4567-3623-4f70-a1f2-22b4d3b4984b",
+      jobUuid: "123e4567-1ea9-4bb9-bb2b-22b4dfbee22b",
+      completedTimestamp: "YYYY-MM-DD HH:MM:SS",
+      completedByStaffUuid: "123e4567-eef3-47c4-b315-22b4d574572b",
+      completedDuringCheckinUuid: "123e4567-8fd6-4a37-a6ad-22b4d367118b",
+      regardingObjectUuid: "123e4567-d5c2-4c2c-bd1b-22b4d7ac90cb",
+      fulfilledByObjectUuid: "123e4567-b18b-4214-9d95-22b4d816852b",
+      assignedToStaffUuids: [
+        "123e4567-0d10-4e2e-be7f-22b4d23beabb",
+      ],
+      assignedTimestamp: "YYYY-MM-DD HH:MM:SS",
+      assignedByStaffUuid: "123e4567-dce7-476d-83aa-22b4df0fc2ab",
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateJobChecklistsRequest](../../models/operations/updatejobchecklistsrequest.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.UpdateJobChecklistsResponse](../../models/operations/updatejobchecklistsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## deleteJobChecklists
+
+
+			
+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.jobChecklists.deleteJobChecklists({
+    uuid: "32678106-9e08-4b03-a523-9383529e6e6c",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { jobChecklistsDeleteJobChecklists } from "servicem8/funcs/jobChecklistsDeleteJobChecklists.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 jobChecklistsDeleteJobChecklists(serviceM8, {
+    uuid: "32678106-9e08-4b03-a523-9383529e6e6c",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DeleteJobChecklistsRequest](../../models/operations/deletejobchecklistsrequest.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.DeleteJobChecklistsResponse](../../models/operations/deletejobchecklistsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |