@greensecurity/javascript-sdk 0.40.8-beta.3 → 0.40.8-beta.31

package/docs/sdks/vendorscans/README.md

@@ -0,0 +1,104 @@
+# VendorScans
+(*vendorScans*)
+
+## Overview
+
+### Available Operations
+
+* [vendorScanOut](#vendorscanout) - Vendor scan out
+
+## vendorScanOut
+
+It scans out vendor from facility
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="vendorScanOut" method="post" path="/vendor-scans/{id}/scan-out" -->
+```typescript
+import { GreenSecurity } from "@greensecurity/javascript-sdk";
+
+const greenSecurity = new GreenSecurity({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await greenSecurity.vendorScans.vendorScanOut({
+    id: 716728,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { vendorScansVendorScanOut } from "@greensecurity/javascript-sdk/funcs/vendorScansVendorScanOut.js";
+
+// Use `GreenSecurityCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const greenSecurity = new GreenSecurityCore({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await vendorScansVendorScanOut(greenSecurity, {
+    id: 716728,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("vendorScansVendorScanOut failed:", res.error);
+  }
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useVendorScansVendorScanOutMutation
+} from "@greensecurity/javascript-sdk/react-query/vendorScansVendorScanOut.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.VendorScanOutRequest](../../models/operations/vendorscanoutrequest.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.VendorScanOutVendorScanOutOk](../../models/operations/vendorscanoutvendorscanoutok.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403, 404      | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |

package/docs/sdks/webhooks/README.md

@@ -0,0 +1,352 @@
+# Webhooks
+(*webhooks*)
+
+## Overview
+
+### Available Operations
+
+* [listAllWebhookEndpoints](#listallwebhookendpoints) - List all webhook endpoints 
+* [getWebhookEndpoint](#getwebhookendpoint) - Retrieves the webhook endpoint with the given ID.
+* [updatesTheWebhookEndpointWithTheGivenId](#updatesthewebhookendpointwiththegivenid) - Updates the webhook endpoint with the given ID.
+
+## listAllWebhookEndpoints
+
+Returns a list of your webhook endpoints.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="listAllWebhookEndpoints" method="get" path="/webhooks" -->
+```typescript
+import { GreenSecurity } from "@greensecurity/javascript-sdk";
+
+const greenSecurity = new GreenSecurity({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await greenSecurity.webhooks.listAllWebhookEndpoints({
+    itemsPerPage: 25,
+    desc: true,
+    sort: "job",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { webhooksListAllWebhookEndpoints } from "@greensecurity/javascript-sdk/funcs/webhooksListAllWebhookEndpoints.js";
+
+// Use `GreenSecurityCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const greenSecurity = new GreenSecurityCore({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await webhooksListAllWebhookEndpoints(greenSecurity, {
+    itemsPerPage: 25,
+    desc: true,
+    sort: "job",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("webhooksListAllWebhookEndpoints failed:", res.error);
+  }
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useWebhooksListAllWebhookEndpoints,
+  useWebhooksListAllWebhookEndpointsSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchWebhooksListAllWebhookEndpoints,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateWebhooksListAllWebhookEndpoints,
+  invalidateAllWebhooksListAllWebhookEndpoints,
+} from "@greensecurity/javascript-sdk/react-query/webhooksListAllWebhookEndpoints.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.ListAllWebhookEndpointsRequest](../../models/operations/listallwebhookendpointsrequest.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.ListAllWebhookEndpointsListAllWebhookEndpointsOk](../../models/operations/listallwebhookendpointslistallwebhookendpointsok.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403           | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |
+
+## getWebhookEndpoint
+
+Returns the definition of a webhook endpoint by ID.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getWebhookEndpoint" method="get" path="/webhooks/{id}" -->
+```typescript
+import { GreenSecurity } from "@greensecurity/javascript-sdk";
+
+const greenSecurity = new GreenSecurity({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await greenSecurity.webhooks.getWebhookEndpoint({
+    id: 304761,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { webhooksGetWebhookEndpoint } from "@greensecurity/javascript-sdk/funcs/webhooksGetWebhookEndpoint.js";
+
+// Use `GreenSecurityCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const greenSecurity = new GreenSecurityCore({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await webhooksGetWebhookEndpoint(greenSecurity, {
+    id: 304761,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("webhooksGetWebhookEndpoint failed:", res.error);
+  }
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useWebhooksGetWebhookEndpoint,
+  useWebhooksGetWebhookEndpointSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchWebhooksGetWebhookEndpoint,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateWebhooksGetWebhookEndpoint,
+  invalidateAllWebhooksGetWebhookEndpoint,
+} from "@greensecurity/javascript-sdk/react-query/webhooksGetWebhookEndpoint.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetWebhookEndpointRequest](../../models/operations/getwebhookendpointrequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.WebhookEndpoint](../../models/components/webhookendpoint.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403, 404      | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |
+
+## updatesTheWebhookEndpointWithTheGivenId
+
+Updates the webhook endpoint with the given ID.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="updatesTheWebhookEndpointWithTheGivenId" method="put" path="/webhooks/{id}" -->
+```typescript
+import { GreenSecurity } from "@greensecurity/javascript-sdk";
+
+const greenSecurity = new GreenSecurity({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await greenSecurity.webhooks.updatesTheWebhookEndpointWithTheGivenId({
+    id: 220782,
+    webhookEndpoint: {
+      id: 1,
+      webhookUrl: "https://example.com/webhook/incoming",
+      subscriptions: [
+        "<value 1>",
+        "<value 2>",
+      ],
+      consumers: {
+        systemId: 1,
+        facilityId: 1,
+        companyId: 1,
+        userId: 1,
+      },
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { webhooksUpdatesTheWebhookEndpointWithTheGivenId } from "@greensecurity/javascript-sdk/funcs/webhooksUpdatesTheWebhookEndpointWithTheGivenId.js";
+
+// Use `GreenSecurityCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const greenSecurity = new GreenSecurityCore({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
+
+async function run() {
+  const res = await webhooksUpdatesTheWebhookEndpointWithTheGivenId(greenSecurity, {
+    id: 220782,
+    webhookEndpoint: {
+      id: 1,
+      webhookUrl: "https://example.com/webhook/incoming",
+      subscriptions: [
+        "<value 1>",
+        "<value 2>",
+      ],
+      consumers: {
+        systemId: 1,
+        facilityId: 1,
+        companyId: 1,
+        userId: 1,
+      },
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("webhooksUpdatesTheWebhookEndpointWithTheGivenId failed:", res.error);
+  }
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useWebhooksUpdatesTheWebhookEndpointWithTheGivenIdMutation
+} from "@greensecurity/javascript-sdk/react-query/webhooksUpdatesTheWebhookEndpointWithTheGivenId.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdatesTheWebhookEndpointWithTheGivenIdRequest](../../models/operations/updatesthewebhookendpointwiththegivenidrequest.md)                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.WebhookEndpoint](../../models/components/webhookendpoint.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403, 404      | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |