syllable-sdk 0.1.0-alpha.3 → 0.1.0-alpha.30

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

@@ -0,0 +1,321 @@
+# Dashboards
+(*dashboards*)
+
+## Overview
+
+### Available Operations
+
+* [get_total_call_volume_by_weekday](#get_total_call_volume_by_weekday) - Get Total Call Volume By Weekday
+* [get_total_call_volume_by_hour](#get_total_call_volume_by_hour) - Get Total Call Volume By Hour
+* [get_weekly_call_volume_by_weekday](#get_weekly_call_volume_by_weekday) - Get Weekly Call Volume By Weekday
+* [get_daily_call_volume_by_hour](#get_daily_call_volume_by_hour) - Get Daily Call Volume By Hour
+* [get_monthly_call_volume_by_week](#get_monthly_call_volume_by_week) - Get Monthly Call Volume By Week
+* [get_monthly_call_volume_by_day](#get_monthly_call_volume_by_day) - Get Monthly Call Volume By Day
+* [get_session_summary](#get_session_summary) - Get Session Summary
+* [get_session_agents](#get_session_agents) - Get Agents
+
+## get_total_call_volume_by_weekday
+
+Get total call volume by weekday.
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.dashboards.get_total_call_volume_by_weekday()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.TotalCallVolumeByWeekdayResponseTotalCallVolumeByWeekday](../../models/totalcallvolumebyweekdayresponsetotalcallvolumebyweekday.md)**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| models.SDKError | 4XX, 5XX        | \*/\*           |
+
+## get_total_call_volume_by_hour
+
+Get total call volume by hour.
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.dashboards.get_total_call_volume_by_hour()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.GetTotalCallVolumeByHourResponseGetTotalCallVolumeByHour](../../models/gettotalcallvolumebyhourresponsegettotalcallvolumebyhour.md)**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| models.SDKError | 4XX, 5XX        | \*/\*           |
+
+## get_weekly_call_volume_by_weekday
+
+Get weekly call volume by weekday.
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.dashboards.get_weekly_call_volume_by_weekday()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.GetWeeklyCallVolumeByWeekdayResponseGetWeeklyCallVolumeByWeekday](../../models/getweeklycallvolumebyweekdayresponsegetweeklycallvolumebyweekday.md)**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| models.SDKError | 4XX, 5XX        | \*/\*           |
+
+## get_daily_call_volume_by_hour
+
+Get daily call volume by hour.
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.dashboards.get_daily_call_volume_by_hour()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.GetDailyCallVolumeByHourResponseGetDailyCallVolumeByHour](../../models/getdailycallvolumebyhourresponsegetdailycallvolumebyhour.md)**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| models.SDKError | 4XX, 5XX        | \*/\*           |
+
+## get_monthly_call_volume_by_week
+
+Get monthly cal volume by week.
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.dashboards.get_monthly_call_volume_by_week()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.GetMonthlyCallVolumeByWeekResponseGetMonthlyCallVolumeByWeek](../../models/getmonthlycallvolumebyweekresponsegetmonthlycallvolumebyweek.md)**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| models.SDKError | 4XX, 5XX        | \*/\*           |
+
+## get_monthly_call_volume_by_day
+
+Get monthly call volume by day.
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.dashboards.get_monthly_call_volume_by_day()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.GetMonthlyCallVolumeByDayResponseGetMonthlyCallVolumeByDay](../../models/getmonthlycallvolumebydayresponsegetmonthlycallvolumebyday.md)**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| models.SDKError | 4XX, 5XX        | \*/\*           |
+
+## get_session_summary
+
+Get session summary data
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.dashboards.get_session_summary()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                                   | Type                                                                        | Required                                                                    | Description                                                                 |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `request`                                                                   | [models.GetSessionSummaryRequest](../../models/getsessionsummaryrequest.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.GetSessionSummaryResponseGetSessionSummary](../../models/getsessionsummaryresponsegetsessionsummary.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## get_session_agents
+
+Get list of agents for session summary dropdown
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.dashboards.get_session_agents()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[models.GetSessionAgentsResponseGetSessionAgents](../../models/getsessionagentsresponsegetsessionagents.md)**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| models.SDKError | 4XX, 5XX        | \*/\*           |

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

@@ -0,0 +1,50 @@
+# Events
+(*events*)
+
+## Overview
+
+Operations related to agent events
+
+### Available Operations
+
+* [list](#list) - Events List
+
+## list
+
+Events List
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.events.list()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `request`                                                           | [models.EventsListRequest](../../models/eventslistrequest.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.EventListResponse](../../models/eventlistresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |

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

@@ -0,0 +1,223 @@
+# Greetings
+(*greetings*)
+
+## Overview
+
+Operations related to conversation greetings
+
+### Available Operations
+
+* [list](#list) - Greetings List
+* [create](#create) - Create Greeting
+* [update](#update) - Update Greeting
+* [get_by_id](#get_by_id) - Get Greeting By Id
+* [delete](#delete) - Delete Greeting
+
+## list
+
+List the existing greetings
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.greetings.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.GreetingListResponse](../../models/greetinglistresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## create
+
+Create a new greeting
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.greetings.create(request={
+    "name": "<value>",
+    "text": "<value>",
+})
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `request`                                                           | [models.GreetingCreate](../../models/greetingcreate.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.GreetingResponse](../../models/greetingresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## update
+
+Update a greeting
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.greetings.update(request={
+    "name": "<value>",
+    "text": "<value>",
+    "id": 857478,
+})
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `request`                                                           | [models.Greeting](../../models/greeting.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.GreetingResponse](../../models/greetingresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## get_by_id
+
+Get the greeting by its ID
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.greetings.get_by_id(greeting_id=931598)
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `greeting_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.GreetingResponse](../../models/greetingresponse.md)**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## delete
+
+Delete greeting 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.greetings.delete(greeting_id=911017, reason="<value>")
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `greeting_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/organizations/README.md

@@ -0,0 +1,48 @@
+# Organizations
+(*organizations*)
+
+## Overview
+
+Operations related to organizations
+
+### Available Operations
+
+* [list](#list) - Organizations List
+
+## list
+
+List all organizations
+
+### Example Usage
+
+```python
+import os
+from syllable_sdk import Syllable
+
+s = Syllable(
+    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
+)
+
+res = s.organizations.list()
+
+if res is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
+
+### Response
+
+**[List[models.Organization]](../../models/.md)**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| models.SDKError | 4XX, 5XX        | \*/\*           |