syllable-sdk 0.1.0-alpha.26 → 0.1.0-alpha.28

package/docs/sdks/v1/README.md

@@ -1,629 +0,0 @@
-# V1
-(*v1*)
-
-## Overview
-
-### Available Operations
-
-* [agentGetAvailableVoices](#agentgetavailablevoices) - Get Available Agent Voices
-* [list](#list) - Directory Member List
-* [create](#create) - Create Directory Member
-* [getById](#getbyid) - Get Directory Member By Id
-* [update](#update) - Update Directory Member
-* [delete](#delete) - Delete Directory Member
-* [directoryMemberBulkLoad](#directorymemberbulkload) - Bulk Load Directory Members
-* [directoryMemberDownload](#directorymemberdownload) - Download Directory Members
-
-## agentGetAvailableVoices
-
-Get available agent voices.
-
-### Example Usage
-
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.v1.agentGetAvailableVoices();
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { v1AgentGetAvailableVoices } from "syllable-sdk/funcs/v1AgentGetAvailableVoices.js";
-
-// Use `SyllableSDKCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const syllableSDK = new SyllableSDKCore({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const res = await v1AgentGetAvailableVoices(syllableSDK);
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.AgentVoice[]](../../models/.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
-
-## list
-
-List the existing directory_members
-
-### Example Usage
-
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.v1.list({});
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { v1List } from "syllable-sdk/funcs/v1List.js";
-
-// Use `SyllableSDKCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const syllableSDK = new SyllableSDKCore({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const res = await v1List(syllableSDK, {});
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DirectoryMemberListRequest](../../models/operations/directorymemberlistrequest.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.ListResponseDirectoryMember](../../models/components/listresponsedirectorymember.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## create
-
-Create a new member in the directory
-
-### Example Usage
-
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.v1.create({
-    name: "<value>",
-    type: "<value>",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { v1Create } from "syllable-sdk/funcs/v1Create.js";
-
-// Use `SyllableSDKCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const syllableSDK = new SyllableSDKCore({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const res = await v1Create(syllableSDK, {
-    name: "<value>",
-    type: "<value>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.DirectoryMemberCreate](../../models/components/directorymembercreate.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.DirectoryMember](../../models/components/directorymember.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## getById
-
-Get a DirectoryMember by ID.
-
-### Example Usage
-
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.v1.getById({
-    memberId: 931598,
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { v1GetById } from "syllable-sdk/funcs/v1GetById.js";
-
-// Use `SyllableSDKCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const syllableSDK = new SyllableSDKCore({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const res = await v1GetById(syllableSDK, {
-    memberId: 931598,
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DirectoryMemberGetByIdRequest](../../models/operations/directorymembergetbyidrequest.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.DirectoryMember](../../models/components/directorymember.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## update
-
-Update a DirectoryMember.
-
-### Example Usage
-
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.v1.update({
-    memberId: 597129,
-    directoryMember: {
-      name: "<value>",
-      type: "<value>",
-      id: 857478,
-    },
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { v1Update } from "syllable-sdk/funcs/v1Update.js";
-
-// Use `SyllableSDKCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const syllableSDK = new SyllableSDKCore({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const res = await v1Update(syllableSDK, {
-    memberId: 597129,
-    directoryMember: {
-      name: "<value>",
-      type: "<value>",
-      id: 857478,
-    },
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DirectoryMemberUpdateRequest](../../models/operations/directorymemberupdaterequest.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.DirectoryMember](../../models/components/directorymember.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## delete
-
-Delete a DirectoryMember.
-
-### Example Usage
-
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.v1.delete({
-    memberId: 545907,
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { v1Delete } from "syllable-sdk/funcs/v1Delete.js";
-
-// Use `SyllableSDKCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const syllableSDK = new SyllableSDKCore({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const res = await v1Delete(syllableSDK, {
-    memberId: 545907,
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DirectoryMemberDeleteRequest](../../models/operations/directorymemberdeleterequest.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\<[any](../../models/.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## directoryMemberBulkLoad
-
-Update Directory Members in chunks of 100.
-
-### Example Usage
-
-```typescript
-import { openAsBlob } from "node:fs";
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.v1.directoryMemberBulkLoad({
-    file: await openAsBlob("example.file"),
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { openAsBlob } from "node:fs";
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { v1DirectoryMemberBulkLoad } from "syllable-sdk/funcs/v1DirectoryMemberBulkLoad.js";
-
-// Use `SyllableSDKCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const syllableSDK = new SyllableSDKCore({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const res = await v1DirectoryMemberBulkLoad(syllableSDK, {
-    file: await openAsBlob("example.file"),
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.BodyDirectoryMemberBulkLoad](../../models/components/bodydirectorymemberbulkload.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\<[any](../../models/.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## directoryMemberDownload
-
-Download the entire directory as a JSON file.
-
-### Example Usage
-
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.v1.directoryMemberDownload();
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { v1DirectoryMemberDownload } from "syllable-sdk/funcs/v1DirectoryMemberDownload.js";
-
-// Use `SyllableSDKCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const syllableSDK = new SyllableSDKCore({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const res = await v1DirectoryMemberDownload(syllableSDK);
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[any](../../models/.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |