servicem8 0.3.3 → 0.3.7

package/docs/sdks/assets/README.md

@@ -0,0 +1,364 @@
+# Assets
+(*assets*)
+
+## Overview
+
+Operations related to Assets
+
+### Available Operations
+
+* [listAssets](#listassets) - List all Assets
+* [getAssets](#getassets) - Retrieve an Asset
+* [updateAssets](#updateassets) - Update an Asset
+* [deleteAssets](#deleteassets) - Delete an Asset
+
+## listAssets
+
+
+			
+#### 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_assets**.
+
+			
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.assets.listAssets();
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { assetsListAssets } from "servicem8/funcs/assetsListAssets.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 assetsListAssets(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.ListAssetsResponse](../../models/operations/listassetsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## getAssets
+
+
+			
+#### OAuth Scope
+This endpoint requires the following OAuth scope **read_assets**.
+
+			
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.assets.getAssets({
+    uuid: "8eb1fa27-739c-4946-b465-dfd310714838",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { assetsGetAssets } from "servicem8/funcs/assetsGetAssets.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 assetsGetAssets(serviceM8, {
+    uuid: "8eb1fa27-739c-4946-b465-dfd310714838",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetAssetsRequest](../../models/operations/getassetsrequest.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.GetAssetsResponse](../../models/operations/getassetsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## updateAssets
+
+Update an Asset
+
+### Example Usage
+
+```typescript
+import { ServiceM8 } from "servicem8";
+
+const serviceM8 = new ServiceM8({
+  security: {
+    oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await serviceM8.assets.updateAssets({
+    uuid: "6722d620-da15-4c25-9986-572ac1041593",
+    asset: {
+      uuid: "123e4567-ae39-46c1-9052-22b4d002e90b",
+      companyUuid: "123e4567-7127-4d5d-968a-22b4d53438eb",
+      assetTypeUuid: "123e4567-41f4-4c6c-934a-22b4d5af612b",
+      name: "<value>",
+      geoTimestamp: "YYYY-MM-DD HH:MM:SS",
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { assetsUpdateAssets } from "servicem8/funcs/assetsUpdateAssets.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 assetsUpdateAssets(serviceM8, {
+    uuid: "6722d620-da15-4c25-9986-572ac1041593",
+    asset: {
+      uuid: "123e4567-ae39-46c1-9052-22b4d002e90b",
+      companyUuid: "123e4567-7127-4d5d-968a-22b4d53438eb",
+      assetTypeUuid: "123e4567-41f4-4c6c-934a-22b4d5af612b",
+      name: "<value>",
+      geoTimestamp: "YYYY-MM-DD HH:MM:SS",
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateAssetsRequest](../../models/operations/updateassetsrequest.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.UpdateAssetsResponse](../../models/operations/updateassetsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |
+
+## deleteAssets
+
+
+			
+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.assets.deleteAssets({
+    uuid: "08c79778-2e1b-42dd-a9de-5ce4bf6cd898",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ServiceM8Core } from "servicem8/core.js";
+import { assetsDeleteAssets } from "servicem8/funcs/assetsDeleteAssets.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 assetsDeleteAssets(serviceM8, {
+    uuid: "08c79778-2e1b-42dd-a9de-5ce4bf6cd898",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DeleteAssetsRequest](../../models/operations/deleteassetsrequest.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.DeleteAssetsResponse](../../models/operations/deleteassetsresponse.md)\>**
+
+### Errors
+
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorT    | 400              | application/json |
+| errors.APIError  | 4XX, 5XX         | \*/\*            |