@greensecurity/javascript-sdk 0.40.3 → 0.40.5-beta.0

package/docs/sdks/datarequests/README.md

@@ -1,302 +0,0 @@
-# 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                | \*/\*                   |