syllable-sdk 1.0.8-rc.1 → 1.0.8-rc.3

package/docs/sdks/channels/README.md

@@ -1,401 +0,0 @@
-# Channels
-(*channels*)
-
-## Overview
-
-Operations related to channel configuration.           A channel is an organization-level point of communication, like a phone number or a web           chat. A channel can be associated with an agent by creating a channel target linking           them.
-
-### Available Operations
-
-* [list](#list) - Get Channels
-* [create](#create) - Create Channel
-* [update](#update) - Update Channel
-* [delete](#delete) - Delete Channel Target
-
-## list
-
-Get Channels
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="channels_list" method="get" path="/api/v1/channels/" -->
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.channels.list({
-    page: 0,
-    searchFields: [
-      "name",
-    ],
-    searchFieldValues: [
-      "Some Object Name",
-    ],
-    startDatetime: "2023-01-01T00:00:00Z",
-    endDatetime: "2024-01-01T00:00:00Z",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { channelsList } from "syllable-sdk/funcs/channelsList.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 channelsList(syllableSDK, {
-    page: 0,
-    searchFields: [
-      "name",
-    ],
-    searchFieldValues: [
-      "Some Object Name",
-    ],
-    startDatetime: "2023-01-01T00:00:00Z",
-    endDatetime: "2024-01-01T00:00:00Z",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsList failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ChannelsListRequest](../../models/operations/channelslistrequest.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.ListResponseChannel](../../models/components/listresponsechannel.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## create
-
-Create Channel
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="channels_create" method="post" path="/api/v1/channels/" -->
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.channels.create({
-    name: "twilio",
-    channelService: "sip",
-    supportedModes: "chat,voice",
-    isSystemChannel: false,
-    config: {
-      accountSid: "AC123...",
-      authToken: "sometoken",
-      providerCredentials: {
-        "api_key": "atk123",
-        "username": "test_username",
-      },
-      telephony: {
-        preInputTimeout: 1.2,
-        overallInputTimeout: 20,
-        interruptibility: "dtmf_only",
-        passiveSpeechInputEnabled: true,
-        passiveInputStart: 0.5,
-      },
-    },
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { channelsCreate } from "syllable-sdk/funcs/channelsCreate.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 channelsCreate(syllableSDK, {
-    name: "twilio",
-    channelService: "sip",
-    supportedModes: "chat,voice",
-    isSystemChannel: false,
-    config: {
-      accountSid: "AC123...",
-      authToken: "sometoken",
-      providerCredentials: {
-        "api_key": "atk123",
-        "username": "test_username",
-      },
-      telephony: {
-        preInputTimeout: 1.2,
-        overallInputTimeout: 20,
-        interruptibility: "dtmf_only",
-        passiveSpeechInputEnabled: true,
-        passiveInputStart: 0.5,
-      },
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsCreate failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.OrganizationChannelCreateRequest](../../models/components/organizationchannelcreaterequest.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.Channel](../../models/components/channel.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## update
-
-Update Channel
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="channels_update" method="put" path="/api/v1/channels/" -->
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.channels.update({
-    name: "twilio",
-    channelService: "sip",
-    supportedModes: "chat,voice",
-    isSystemChannel: false,
-    config: {
-      accountSid: "AC123...",
-      authToken: "sometoken",
-      providerCredentials: {
-        "api_key": "atk123",
-        "username": "test_username",
-      },
-      telephony: {
-        preInputTimeout: 1.2,
-        overallInputTimeout: 20,
-        interruptibility: "dtmf_only",
-        passiveSpeechInputEnabled: true,
-        passiveInputStart: 0.5,
-      },
-    },
-    id: 1,
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { channelsUpdate } from "syllable-sdk/funcs/channelsUpdate.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 channelsUpdate(syllableSDK, {
-    name: "twilio",
-    channelService: "sip",
-    supportedModes: "chat,voice",
-    isSystemChannel: false,
-    config: {
-      accountSid: "AC123...",
-      authToken: "sometoken",
-      providerCredentials: {
-        "api_key": "atk123",
-        "username": "test_username",
-      },
-      telephony: {
-        preInputTimeout: 1.2,
-        overallInputTimeout: 20,
-        interruptibility: "dtmf_only",
-        passiveSpeechInputEnabled: true,
-        passiveInputStart: 0.5,
-      },
-    },
-    id: 1,
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsUpdate failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.OrganizationChannelUpdateRequest](../../models/components/organizationchannelupdaterequest.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.Channel](../../models/components/channel.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## delete
-
-Hard-delete a channel target by ID
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="channel_targets_delete" method="delete" path="/api/v1/channels/{channel_id}" -->
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.channels.delete({
-    channelId: "<id>",
-    targetId: "<id>",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { channelsDelete } from "syllable-sdk/funcs/channelsDelete.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 channelsDelete(syllableSDK, {
-    channelId: "<id>",
-    targetId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsDelete failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ChannelTargetsDeleteRequest](../../models/operations/channeltargetsdeleterequest.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                   | \*/\*                      |

package/docs/sdks/conversations/README.md

@@ -1,100 +0,0 @@
-# Conversations
-(*conversations*)
-
-## Overview
-
-Operations related to conversations.           A conversation is a record of messages between a user and an agent, and is composed of           one or more sessions.
-
-### Available Operations
-
-* [list](#list) - Conversations List
-
-## list
-
-Conversations List
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="conversations_list" method="get" path="/api/v1/conversations/" -->
-```typescript
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.conversations.list({
-    page: 0,
-    searchFields: [
-      "agent_name",
-    ],
-    searchFieldValues: [
-      "Some Object Name",
-    ],
-    startDatetime: "2023-01-01T00:00:00Z",
-    endDatetime: "2024-01-01T00:00:00Z",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { conversationsList } from "syllable-sdk/funcs/conversationsList.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 conversationsList(syllableSDK, {
-    page: 0,
-    searchFields: [
-      "agent_name",
-    ],
-    searchFieldValues: [
-      "Some Object Name",
-    ],
-    startDatetime: "2023-01-01T00:00:00Z",
-    endDatetime: "2024-01-01T00:00:00Z",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("conversationsList failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ConversationsListRequest](../../models/operations/conversationslistrequest.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.ListResponseConversation](../../models/components/listresponseconversation.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |