syllable-sdk 0.1.0-alpha.25 → 0.1.0-alpha.27

package/README.md

@@ -218,17 +218,6 @@ run();
 * [update](docs/sdks/tools/README.md#update) - Update Tool
 * [getByName](docs/sdks/tools/README.md#getbyname) - Tool Info
 
-### [v1](docs/sdks/v1/README.md)
-
-* [agentGetAvailableVoices](docs/sdks/v1/README.md#agentgetavailablevoices) - Get Available Agent Voices
-* [list](docs/sdks/v1/README.md#list) - Directory Member List
-* [create](docs/sdks/v1/README.md#create) - Create Directory Member
-* [getById](docs/sdks/v1/README.md#getbyid) - Get Directory Member By Id
-* [update](docs/sdks/v1/README.md#update) - Update Directory Member
-* [delete](docs/sdks/v1/README.md#delete) - Delete Directory Member
-* [directoryMemberBulkLoad](docs/sdks/v1/README.md#directorymemberbulkload) - Bulk Load Directory Members
-* [directoryMemberDownload](docs/sdks/v1/README.md#directorymemberdownload) - Download Directory Members
-
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
@@ -296,14 +285,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`toolsGetByName`](docs/sdks/tools/README.md#getbyname) - Tool Info
 - [`toolsList`](docs/sdks/tools/README.md#list) - Tool List
 - [`toolsUpdate`](docs/sdks/tools/README.md#update) - Update Tool
-- [`v1AgentGetAvailableVoices`](docs/sdks/v1/README.md#agentgetavailablevoices) - Get Available Agent Voices
-- [`v1Create`](docs/sdks/v1/README.md#create) - Create Directory Member
-- [`v1Delete`](docs/sdks/v1/README.md#delete) - Delete Directory Member
-- [`v1DirectoryMemberBulkLoad`](docs/sdks/v1/README.md#directorymemberbulkload) - Bulk Load Directory Members
-- [`v1DirectoryMemberDownload`](docs/sdks/v1/README.md#directorymemberdownload) - Download Directory Members
-- [`v1GetById`](docs/sdks/v1/README.md#getbyid) - Get Directory Member By Id
-- [`v1List`](docs/sdks/v1/README.md#list) - Directory Member List
-- [`v1Update`](docs/sdks/v1/README.md#update) - Update Directory Member
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -331,7 +312,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.v1.directoryMemberBulkLoad({
+  const result = await syllableSDK.directory.directoryMemberBulkLoad({
     file: await openAsBlob("example.file"),
   });
 
@@ -486,10 +467,10 @@ In some rare cases, the SDK can fail to get a response from the server or even m
 
 You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
 
-| #   | Server                  |
-| --- | ----------------------- |
-| 0   | `http://localhost:8001` |
-| 1   | `http://localhost:8001` |
+| #   | Server                          |
+| --- | ------------------------------- |
+| 0   | `https://api.syllable.ai`       |
+| 1   | `https://trial.api.syllable.ai` |
 
 #### Example
 
@@ -519,7 +500,7 @@ The default server can also be overridden globally by passing a URL to the `serv
 import { SyllableSDK } from "syllable-sdk";
 
 const syllableSDK = new SyllableSDK({
-  serverURL: "http://localhost:8001",
+  serverURL: "https://api.syllable.ai",
   apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
 });
 

package/api-reference/sdks/agents/README.md

@@ -0,0 +1,224 @@
+# Agents
+(*agents*)
+
+## Overview
+
+Operations related to agents
+
+### Available Operations
+
+* [list](#list) - Agent List
+* [create](#create) - Create Agent
+* [update](#update) - Update Agent
+* [get_by_id](#get_by_id) - Get Agent By Id
+* [delete](#delete) - Delete Agent
+
+## list
+
+List the existing agents
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.agents.list()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `request`                                                           | [models.AgentListRequest](../../models/agentlistrequest.md)         | :heavy_check_mark:                                                  | The request object to use for the request.                          |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.AgentListResponse](../../models/agentlistresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## create
+
+Create a new agent
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.agents.create(request={
+    "name": "<value>",
+    "timezone": "Antarctica/Rothera",
+    "type_extra": {},
+})
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `request`                                                           | [models.AgentCreate](../../models/agentcreate.md)                   | :heavy_check_mark:                                                  | The request object to use for the request.                          |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.Agent](../../models/agent.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## update
+
+Update an existing agent
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.agents.update(request={
+    "name": "<value>",
+    "timezone": "Europe/Tallinn",
+    "type_extra": {},
+    "id": 597129,
+})
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `request`                                                           | [models.Agent](../../models/agent.md)                               | :heavy_check_mark:                                                  | The request object to use for the request.                          |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.Agent](../../models/agent.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## get_by_id
+
+Get an agent by ID.
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.agents.get_by_id(agent_id=931598)
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `agent_id`                                                          | *int*                                                               | :heavy_check_mark:                                                  | N/A                                                                 |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.Agent](../../models/agent.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## delete
+
+Delete an agent by ID
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.agents.delete(agent_id=5705, reason="<value>")
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `agent_id`                                                          | *int*                                                               | :heavy_check_mark:                                                  | N/A                                                                 |
+| `reason`                                                            | *str*                                                               | :heavy_check_mark:                                                  | N/A                                                                 |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[Any](../../models/.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/api-reference/sdks/availabletargets/README.md

@@ -0,0 +1,49 @@
+# AvailableTargets
+(*channels.available_targets*)
+
+## Overview
+
+### Available Operations
+
+* [list](#list) - Available Targets List
+
+## list
+
+List the available phone numbers
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.channels.available_targets.list()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `page`                                                              | *OptionalNullable[int]*                                             | :heavy_minus_sign:                                                  | N/A                                                                 |
+| `limit`                                                             | *Optional[int]*                                                     | :heavy_minus_sign:                                                  | N/A                                                                 |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.AvailableTargetsListResponse](../../models/availabletargetslistresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/api-reference/sdks/channels/README.md

@@ -0,0 +1,92 @@
+# Channels
+(*channels*)
+
+## Overview
+
+Operations related to channels
+
+### Available Operations
+
+* [list](#list) - Get Channels
+* [delete](#delete) - Delete Channel
+
+## list
+
+Get Channels
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.channels.list()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `page`                                                              | *OptionalNullable[int]*                                             | :heavy_minus_sign:                                                  | N/A                                                                 |
+| `limit`                                                             | *Optional[int]*                                                     | :heavy_minus_sign:                                                  | N/A                                                                 |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.ChannelListResponse](../../models/channellistresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## delete
+
+Delete channel by ID
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.channels.delete(channel_id="<id>")
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `channel_id`                                                        | *str*                                                               | :heavy_check_mark:                                                  | N/A                                                                 |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.ChannelTarget](../../models/channeltarget.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/api-reference/sdks/chats/README.md

@@ -0,0 +1,55 @@
+# Chats
+(*agents.chats*)
+
+## Overview
+
+### Available Operations
+
+* [send_message](#send_message) - Send New Message
+
+## send_message
+
+Send a new message
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.agents.chats.send_message(request={
+    "service_name": "<value>",
+    "source_name": "<value>",
+    "chat_id": "<id>",
+    "agent_id": "<id>",
+    "org_name": "<value>",
+    "text": "<value>",
+})
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `request`                                                           | [models.ChatMessage](../../models/chatmessage.md)                   | :heavy_check_mark:                                                  | The request object to use for the request.                          |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.ChatMessageResponse](../../models/chatmessageresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/api-reference/sdks/conversations/README.md

@@ -0,0 +1,91 @@
+# Conversations
+(*conversations*)
+
+## Overview
+
+Operations related to conversations
+
+### Available Operations
+
+* [list](#list) - Conversations List
+* [get](#get) - Get Conversation By Id
+
+## list
+
+Conversations List
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.conversations.list()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                                   | Type                                                                        | Required                                                                    | Description                                                                 |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `request`                                                                   | [models.ConversationsListRequest](../../models/conversationslistrequest.md) | :heavy_check_mark:                                                          | The request object to use for the request.                                  |
+| `retries`                                                                   | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)            | :heavy_minus_sign:                                                          | Configuration to override the default retry behavior of the client.         |
+
+### Response
+
+**[models.ConversationListResponse](../../models/conversationlistresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## get
+
+Get Conversation By Id
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.conversations.get(conversation_id="<id>")
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `conversation_id`                                                   | *str*                                                               | :heavy_check_mark:                                                  | N/A                                                                 |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.ConversationTranscriptionResponse](../../models/conversationtranscriptionresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |