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

package/docs/sdks/alerts/README.md

@@ -0,0 +1,219 @@
+# Alerts
+(*alerts*)
+
+## Overview
+
+### Available Operations
+
+* [listAlerts](#listalerts) - List alerts
+* [updateUserAlerts](#updateuseralerts) - Update user alerts
+
+## listAlerts
+
+List alerts for user.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="listAlerts" method="get" path="/alerts" -->
+```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.alerts.listAlerts({
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+  });
+
+  for await (const page of result) {
+    console.log(page);
+  }
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { alertsListAlerts } from "@greensecurity/javascript-sdk/funcs/alertsListAlerts.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 alertsListAlerts(greenSecurity, {
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const page of result) {
+    console.log(page);
+  }
+  } else {
+    console.log("alertsListAlerts 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.
+  useAlertsListAlerts,
+  useAlertsListAlertsSuspense,
+  // Query hooks suitable for building infinite scrolling or "load more" UIs.
+  useAlertsListAlertsInfinite,
+  useAlertsListAlertsInfiniteSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchAlertsListAlerts,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateAlertsListAlerts,
+  invalidateAllAlertsListAlerts,
+} from "@greensecurity/javascript-sdk/react-query/alertsListAlerts.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.ListAlertsRequest](../../models/operations/listalertsrequest.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.ListAlertsResponse](../../models/operations/listalertsresponse.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403           | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |
+
+## updateUserAlerts
+
+Update user alerts
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="updateUserAlerts" method="put" path="/user-alerts" -->
+```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.alerts.updateUserAlerts({});
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { alertsUpdateUserAlerts } from "@greensecurity/javascript-sdk/funcs/alertsUpdateUserAlerts.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 alertsUpdateUserAlerts(greenSecurity, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("alertsUpdateUserAlerts 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.
+  useAlertsUpdateUserAlertsMutation
+} from "@greensecurity/javascript-sdk/react-query/alertsUpdateUserAlerts.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateUserAlertsRequestBody](../../models/operations/updateuseralertsrequestbody.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.UpdateUserAlertsResponseBody](../../models/operations/updateuseralertsresponsebody.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/companies/README.md

@@ -0,0 +1,126 @@
+# Companies
+(*companies*)
+
+## Overview
+
+### Available Operations
+
+* [listOrSearchCompanies](#listorsearchcompanies) - List or search companies
+
+## listOrSearchCompanies
+
+List or search companies.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="listOrSearchCompanies" method="get" path="/companies" -->
+```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.companies.listOrSearchCompanies({
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+  });
+
+  for await (const page of result) {
+    console.log(page);
+  }
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { companiesListOrSearchCompanies } from "@greensecurity/javascript-sdk/funcs/companiesListOrSearchCompanies.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 companiesListOrSearchCompanies(greenSecurity, {
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const page of result) {
+    console.log(page);
+  }
+  } else {
+    console.log("companiesListOrSearchCompanies 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.
+  useCompaniesListOrSearchCompanies,
+  useCompaniesListOrSearchCompaniesSuspense,
+  // Query hooks suitable for building infinite scrolling or "load more" UIs.
+  useCompaniesListOrSearchCompaniesInfinite,
+  useCompaniesListOrSearchCompaniesInfiniteSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchCompaniesListOrSearchCompanies,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateCompaniesListOrSearchCompanies,
+  invalidateAllCompaniesListOrSearchCompanies,
+} from "@greensecurity/javascript-sdk/react-query/companiesListOrSearchCompanies.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.ListOrSearchCompaniesRequest](../../models/operations/listorsearchcompaniesrequest.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.ListOrSearchCompaniesResponse](../../models/operations/listorsearchcompaniesresponse.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 403                | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |

package/docs/sdks/datarequests/README.md

@@ -0,0 +1,302 @@
+# DataRequests
+(*dataRequests*)
+
+## Overview
+
+### Available Operations
+
+* [addDataRequestFile](#adddatarequestfile) - Add vendor credential data request
+* [deleteDataRequestFile](#deletedatarequestfile) - Delete vendor credential data request file
+* [updateDataRequest](#updatedatarequest) - Update vendor credential data request
+
+## addDataRequestFile
+
+It will set the vendor credential data request file attributes
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="addDataRequestFile" method="post" path="/data_requests/{id}/file" -->
+```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.dataRequests.addDataRequestFile({
+    id: 38177,
+    requestBody: {},
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { dataRequestsAddDataRequestFile } from "@greensecurity/javascript-sdk/funcs/dataRequestsAddDataRequestFile.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 dataRequestsAddDataRequestFile(greenSecurity, {
+    id: 38177,
+    requestBody: {},
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("dataRequestsAddDataRequestFile 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.
+  useDataRequestsAddDataRequestFileMutation
+} from "@greensecurity/javascript-sdk/react-query/dataRequestsAddDataRequestFile.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AddDataRequestFileRequest](../../models/operations/adddatarequestfilerequest.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\<[boolean](../../models/.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403           | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |
+
+## deleteDataRequestFile
+
+It will delete the vendor credential data request file
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="deleteDataRequestFile" method="delete" path="/data_requests/{id}/file" -->
+```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.dataRequests.deleteDataRequestFile({
+    id: 787566,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { dataRequestsDeleteDataRequestFile } from "@greensecurity/javascript-sdk/funcs/dataRequestsDeleteDataRequestFile.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 dataRequestsDeleteDataRequestFile(greenSecurity, {
+    id: 787566,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("dataRequestsDeleteDataRequestFile 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.
+  useDataRequestsDeleteDataRequestFileMutation
+} from "@greensecurity/javascript-sdk/react-query/dataRequestsDeleteDataRequestFile.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DeleteDataRequestFileRequest](../../models/operations/deletedatarequestfilerequest.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\<[boolean](../../models/.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403           | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |
+
+## updateDataRequest
+
+It will update the vendor credential data request attributes
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="updateDataRequest" method="put" path="/data_requests/{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.dataRequests.updateDataRequest({
+    id: 536149,
+    requestBody: {},
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { dataRequestsUpdateDataRequest } from "@greensecurity/javascript-sdk/funcs/dataRequestsUpdateDataRequest.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 dataRequestsUpdateDataRequest(greenSecurity, {
+    id: 536149,
+    requestBody: {},
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("dataRequestsUpdateDataRequest 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.
+  useDataRequestsUpdateDataRequestMutation
+} from "@greensecurity/javascript-sdk/react-query/dataRequestsUpdateDataRequest.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateDataRequestRequest](../../models/operations/updatedatarequestrequest.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\<[boolean](../../models/.md)\>**
+
+### Errors
+
+| Error Type              | Status Code             | Content Type            |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ApiErrorResponse | 400, 401, 403           | application/json        |
+| errors.ApiErrorResponse | 500                     | application/json        |
+| errors.APIError         | 4XX, 5XX                | \*/\*                   |