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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/bin/mcp-server.js +6 -6
  2. package/bin/mcp-server.js.map +4 -4
  3. package/examples/package-lock.json +1 -1
  4. package/jsr.json +1 -1
  5. package/lib/config.d.ts +3 -3
  6. package/lib/config.js +3 -3
  7. package/mcp-server/mcp-server.js +1 -1
  8. package/mcp-server/server.js +1 -1
  9. package/openapi.json +33 -33
  10. package/package.json +1 -1
  11. package/src/lib/config.ts +3 -3
  12. package/src/mcp-server/mcp-server.ts +1 -1
  13. package/src/mcp-server/server.ts +1 -1
  14. package/.devcontainer/README.md +0 -35
  15. package/api-reference/sdks/agents/README.md +0 -224
  16. package/api-reference/sdks/availabletargets/README.md +0 -49
  17. package/api-reference/sdks/channels/README.md +0 -92
  18. package/api-reference/sdks/chats/README.md +0 -55
  19. package/api-reference/sdks/conversations/README.md +0 -91
  20. package/api-reference/sdks/dashboards/README.md +0 -321
  21. package/api-reference/sdks/events/README.md +0 -50
  22. package/api-reference/sdks/greetings/README.md +0 -223
  23. package/api-reference/sdks/organizations/README.md +0 -48
  24. package/api-reference/sdks/prompts/README.md +0 -225
  25. package/api-reference/sdks/sessions/README.md +0 -50
  26. package/api-reference/sdks/syllable/README.md +0 -22
  27. package/api-reference/sdks/targets/README.md +0 -194
  28. package/api-reference/sdks/tools/README.md +0 -92
  29. package/docs/sdks/agents/README.md +0 -589
  30. package/docs/sdks/batches/README.md +0 -742
  31. package/docs/sdks/campaigns/README.md +0 -526
  32. package/docs/sdks/channels/README.md +0 -401
  33. package/docs/sdks/conversations/README.md +0 -100
  34. package/docs/sdks/custommessages/README.md +0 -496
  35. package/docs/sdks/dashboards/README.md +0 -481
  36. package/docs/sdks/datasources/README.md +0 -458
  37. package/docs/sdks/directory/README.md +0 -727
  38. package/docs/sdks/events/README.md +0 -100
  39. package/docs/sdks/folders/README.md +0 -675
  40. package/docs/sdks/fullsummary/README.md +0 -82
  41. package/docs/sdks/incidents/README.md +0 -501
  42. package/docs/sdks/insights/README.md +0 -100
  43. package/docs/sdks/languagegroups/README.md +0 -565
  44. package/docs/sdks/latency/README.md +0 -82
  45. package/docs/sdks/numbers/README.md +0 -250
  46. package/docs/sdks/organizations/README.md +0 -317
  47. package/docs/sdks/permissions/README.md +0 -78
  48. package/docs/sdks/prompts/README.md +0 -592
  49. package/docs/sdks/pronunciations/README.md +0 -360
  50. package/docs/sdks/roles/README.md +0 -430
  51. package/docs/sdks/services/README.md +0 -430
  52. package/docs/sdks/sessiondebug/README.md +0 -236
  53. package/docs/sdks/sessionlabels/README.md +0 -262
  54. package/docs/sdks/sessions/README.md +0 -325
  55. package/docs/sdks/syllablesdktools/README.md +0 -578
  56. package/docs/sdks/takeouts/README.md +0 -228
  57. package/docs/sdks/targets/README.md +0 -454
  58. package/docs/sdks/test/README.md +0 -92
  59. package/docs/sdks/tools/README.md +0 -518
  60. package/docs/sdks/transcript/README.md +0 -82
  61. package/docs/sdks/twilio/README.md +0 -246
  62. package/docs/sdks/users/README.md +0 -561
  63. package/docs/sdks/v1/README.md +0 -561
  64. package/docs/sdks/voicegroups/README.md +0 -551
  65. package/docs/sdks/workflows/README.md +0 -781
  66. package/examples/README.md +0 -31
package/api-reference/sdks/greetings/README.md DELETED
@@ -1,223 +0,0 @@
1
- # Greetings
2
- (*greetings*)
3
-
4
- ## Overview
5
-
6
- Operations related to conversation greetings
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Greetings List
11
- * [create](#create) - Create Greeting
12
- * [update](#update) - Update Greeting
13
- * [get_by_id](#get_by_id) - Get Greeting By Id
14
- * [delete](#delete) - Delete Greeting
15
-
16
- ## list
17
-
18
- List the existing greetings
19
-
20
- ### Example Usage
21
-
22
- ```python
23
- import os
24
- from syllable_sdk import Syllable
25
-
26
- s = Syllable(
27
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
28
- )
29
-
30
- res = s.greetings.list()
31
-
32
- if res is not None:
33
- # handle response
34
- pass
35
-
36
- ```
37
-
38
- ### Parameters
39
-
40
- | Parameter | Type | Required | Description |
41
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
42
- | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
43
- | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A |
44
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
45
-
46
- ### Response
47
-
48
- **[models.GreetingListResponse](../../models/greetinglistresponse.md)**
49
-
50
- ### Errors
51
-
52
- | Error Type | Status Code | Content Type |
53
- | -------------------------- | -------------------------- | -------------------------- |
54
- | models.HTTPValidationError | 422 | application/json |
55
- | models.SDKError | 4XX, 5XX | \*/\* |
56
-
57
- ## create
58
-
59
- Create a new greeting
60
-
61
- ### Example Usage
62
-
63
- ```python
64
- import os
65
- from syllable_sdk import Syllable
66
-
67
- s = Syllable(
68
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
69
- )
70
-
71
- res = s.greetings.create(request={
72
- "name": "<value>",
73
- "text": "<value>",
74
- })
75
-
76
- if res is not None:
77
- # handle response
78
- pass
79
-
80
- ```
81
-
82
- ### Parameters
83
-
84
- | Parameter | Type | Required | Description |
85
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
86
- | `request` | [models.GreetingCreate](../../models/greetingcreate.md) | :heavy_check_mark: | The request object to use for the request. |
87
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
88
-
89
- ### Response
90
-
91
- **[models.GreetingResponse](../../models/greetingresponse.md)**
92
-
93
- ### Errors
94
-
95
- | Error Type | Status Code | Content Type |
96
- | -------------------------- | -------------------------- | -------------------------- |
97
- | models.HTTPValidationError | 422 | application/json |
98
- | models.SDKError | 4XX, 5XX | \*/\* |
99
-
100
- ## update
101
-
102
- Update a greeting
103
-
104
- ### Example Usage
105
-
106
- ```python
107
- import os
108
- from syllable_sdk import Syllable
109
-
110
- s = Syllable(
111
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
112
- )
113
-
114
- res = s.greetings.update(request={
115
- "name": "<value>",
116
- "text": "<value>",
117
- "id": 857478,
118
- })
119
-
120
- if res is not None:
121
- # handle response
122
- pass
123
-
124
- ```
125
-
126
- ### Parameters
127
-
128
- | Parameter | Type | Required | Description |
129
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
130
- | `request` | [models.Greeting](../../models/greeting.md) | :heavy_check_mark: | The request object to use for the request. |
131
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
132
-
133
- ### Response
134
-
135
- **[models.GreetingResponse](../../models/greetingresponse.md)**
136
-
137
- ### Errors
138
-
139
- | Error Type | Status Code | Content Type |
140
- | -------------------------- | -------------------------- | -------------------------- |
141
- | models.HTTPValidationError | 422 | application/json |
142
- | models.SDKError | 4XX, 5XX | \*/\* |
143
-
144
- ## get_by_id
145
-
146
- Get the greeting by its ID
147
-
148
- ### Example Usage
149
-
150
- ```python
151
- import os
152
- from syllable_sdk import Syllable
153
-
154
- s = Syllable(
155
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
156
- )
157
-
158
- res = s.greetings.get_by_id(greeting_id=931598)
159
-
160
- if res is not None:
161
- # handle response
162
- pass
163
-
164
- ```
165
-
166
- ### Parameters
167
-
168
- | Parameter | Type | Required | Description |
169
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
170
- | `greeting_id` | *int* | :heavy_check_mark: | N/A |
171
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
172
-
173
- ### Response
174
-
175
- **[models.GreetingResponse](../../models/greetingresponse.md)**
176
-
177
- ### Errors
178
-
179
- | Error Type | Status Code | Content Type |
180
- | -------------------------- | -------------------------- | -------------------------- |
181
- | models.HTTPValidationError | 422 | application/json |
182
- | models.SDKError | 4XX, 5XX | \*/\* |
183
-
184
- ## delete
185
-
186
- Delete greeting by ID
187
-
188
- ### Example Usage
189
-
190
- ```python
191
- import os
192
- from syllable_sdk import Syllable
193
-
194
- s = Syllable(
195
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
196
- )
197
-
198
- res = s.greetings.delete(greeting_id=911017, reason="<value>")
199
-
200
- if res is not None:
201
- # handle response
202
- pass
203
-
204
- ```
205
-
206
- ### Parameters
207
-
208
- | Parameter | Type | Required | Description |
209
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
210
- | `greeting_id` | *int* | :heavy_check_mark: | N/A |
211
- | `reason` | *str* | :heavy_check_mark: | N/A |
212
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
213
-
214
- ### Response
215
-
216
- **[Any](../../models/.md)**
217
-
218
- ### Errors
219
-
220
- | Error Type | Status Code | Content Type |
221
- | -------------------------- | -------------------------- | -------------------------- |
222
- | models.HTTPValidationError | 422 | application/json |
223
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/organizations/README.md DELETED
@@ -1,48 +0,0 @@
1
- # Organizations
2
- (*organizations*)
3
-
4
- ## Overview
5
-
6
- Operations related to organizations
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Organizations List
11
-
12
- ## list
13
-
14
- List all organizations
15
-
16
- ### Example Usage
17
-
18
- ```python
19
- import os
20
- from syllable_sdk import Syllable
21
-
22
- s = Syllable(
23
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
24
- )
25
-
26
- res = s.organizations.list()
27
-
28
- if res is not None:
29
- # handle response
30
- pass
31
-
32
- ```
33
-
34
- ### Parameters
35
-
36
- | Parameter | Type | Required | Description |
37
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
38
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
39
-
40
- ### Response
41
-
42
- **[List[models.Organization]](../../models/.md)**
43
-
44
- ### Errors
45
-
46
- | Error Type | Status Code | Content Type |
47
- | --------------- | --------------- | --------------- |
48
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/prompts/README.md DELETED
@@ -1,225 +0,0 @@
1
- # Prompts
2
- (*prompts*)
3
-
4
- ## Overview
5
-
6
- Operations related to prompts
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Prompt List
11
- * [create](#create) - Create Prompt
12
- * [update](#update) - Update Prompt
13
- * [get_by_id](#get_by_id) - Get Prompt By Id
14
- * [delete](#delete) - Delete Prompt
15
-
16
- ## list
17
-
18
- List the existing prompts
19
-
20
- ### Example Usage
21
-
22
- ```python
23
- import os
24
- from syllable_sdk import Syllable
25
-
26
- s = Syllable(
27
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
28
- )
29
-
30
- res = s.prompts.list()
31
-
32
- if res is not None:
33
- # handle response
34
- pass
35
-
36
- ```
37
-
38
- ### Parameters
39
-
40
- | Parameter | Type | Required | Description |
41
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
42
- | `filter_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
43
- | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
44
- | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A |
45
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
46
-
47
- ### Response
48
-
49
- **[models.PromptListResponse](../../models/promptlistresponse.md)**
50
-
51
- ### Errors
52
-
53
- | Error Type | Status Code | Content Type |
54
- | -------------------------- | -------------------------- | -------------------------- |
55
- | models.HTTPValidationError | 422 | application/json |
56
- | models.SDKError | 4XX, 5XX | \*/\* |
57
-
58
- ## create
59
-
60
- Create a new prompt
61
-
62
- ### Example Usage
63
-
64
- ```python
65
- import os
66
- from syllable_sdk import Syllable
67
-
68
- s = Syllable(
69
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
70
- )
71
-
72
- res = s.prompts.create(request={
73
- "name": "<value>",
74
- "llm_config": {},
75
- })
76
-
77
- if res is not None:
78
- # handle response
79
- pass
80
-
81
- ```
82
-
83
- ### Parameters
84
-
85
- | Parameter | Type | Required | Description |
86
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
87
- | `request` | [models.PromptCreate](../../models/promptcreate.md) | :heavy_check_mark: | The request object to use for the request. |
88
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
89
-
90
- ### Response
91
-
92
- **[models.Prompt](../../models/prompt.md)**
93
-
94
- ### Errors
95
-
96
- | Error Type | Status Code | Content Type |
97
- | -------------------------- | -------------------------- | -------------------------- |
98
- | models.HTTPValidationError | 422 | application/json |
99
- | models.SDKError | 4XX, 5XX | \*/\* |
100
-
101
- ## update
102
-
103
- Update an existing prompt
104
-
105
- ### Example Usage
106
-
107
- ```python
108
- import os
109
- from syllable_sdk import Syllable
110
-
111
- s = Syllable(
112
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
113
- )
114
-
115
- res = s.prompts.update(request={
116
- "name": "<value>",
117
- "llm_config": {},
118
- "id": 857478,
119
- "last_updated": "<value>",
120
- })
121
-
122
- if res is not None:
123
- # handle response
124
- pass
125
-
126
- ```
127
-
128
- ### Parameters
129
-
130
- | Parameter | Type | Required | Description |
131
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
132
- | `request` | [models.Prompt](../../models/prompt.md) | :heavy_check_mark: | The request object to use for the request. |
133
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
134
-
135
- ### Response
136
-
137
- **[models.Prompt](../../models/prompt.md)**
138
-
139
- ### Errors
140
-
141
- | Error Type | Status Code | Content Type |
142
- | -------------------------- | -------------------------- | -------------------------- |
143
- | models.HTTPValidationError | 422 | application/json |
144
- | models.SDKError | 4XX, 5XX | \*/\* |
145
-
146
- ## get_by_id
147
-
148
- Get a prompt by ID
149
-
150
- ### Example Usage
151
-
152
- ```python
153
- import os
154
- from syllable_sdk import Syllable
155
-
156
- s = Syllable(
157
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
158
- )
159
-
160
- res = s.prompts.get_by_id(prompt_id=931598)
161
-
162
- if res is not None:
163
- # handle response
164
- pass
165
-
166
- ```
167
-
168
- ### Parameters
169
-
170
- | Parameter | Type | Required | Description |
171
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
172
- | `prompt_id` | *int* | :heavy_check_mark: | N/A |
173
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
174
-
175
- ### Response
176
-
177
- **[models.Prompt](../../models/prompt.md)**
178
-
179
- ### Errors
180
-
181
- | Error Type | Status Code | Content Type |
182
- | -------------------------- | -------------------------- | -------------------------- |
183
- | models.HTTPValidationError | 422 | application/json |
184
- | models.SDKError | 4XX, 5XX | \*/\* |
185
-
186
- ## delete
187
-
188
- Delete an prompt by ID
189
-
190
- ### Example Usage
191
-
192
- ```python
193
- import os
194
- from syllable_sdk import Syllable
195
-
196
- s = Syllable(
197
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
198
- )
199
-
200
- res = s.prompts.delete(prompt_id=426520, reason="<value>")
201
-
202
- if res is not None:
203
- # handle response
204
- pass
205
-
206
- ```
207
-
208
- ### Parameters
209
-
210
- | Parameter | Type | Required | Description |
211
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
212
- | `prompt_id` | *int* | :heavy_check_mark: | N/A |
213
- | `reason` | *str* | :heavy_check_mark: | N/A |
214
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
215
-
216
- ### Response
217
-
218
- **[Any](../../models/.md)**
219
-
220
- ### Errors
221
-
222
- | Error Type | Status Code | Content Type |
223
- | -------------------------- | -------------------------- | -------------------------- |
224
- | models.HTTPValidationError | 422 | application/json |
225
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/sessions/README.md DELETED
@@ -1,50 +0,0 @@
1
- # Sessions
2
- (*sessions*)
3
-
4
- ## Overview
5
-
6
- Operations related to agent sessions
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Sessions List
11
-
12
- ## list
13
-
14
- Sessions List
15
-
16
- ### Example Usage
17
-
18
- ```python
19
- import os
20
- from syllable_sdk import Syllable
21
-
22
- s = Syllable(
23
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
24
- )
25
-
26
- res = s.sessions.list()
27
-
28
- if res is not None:
29
- # handle response
30
- pass
31
-
32
- ```
33
-
34
- ### Parameters
35
-
36
- | Parameter | Type | Required | Description |
37
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
38
- | `request` | [models.SessionsListRequest](../../models/sessionslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
39
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
40
-
41
- ### Response
42
-
43
- **[models.SessionListResponse](../../models/sessionlistresponse.md)**
44
-
45
- ### Errors
46
-
47
- | Error Type | Status Code | Content Type |
48
- | -------------------------- | -------------------------- | -------------------------- |
49
- | models.HTTPValidationError | 422 | application/json |
50
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/syllable/README.md DELETED
@@ -1,22 +0,0 @@
1
- # Syllable SDK
2
-
3
- ## Overview
4
-
5
- SyllableSDK:
6
- # Syllble Platform SDK
7
-
8
- Syllble SDK gives you the power of awesome AI agentry. 🚀
9
-
10
- ## Overview
11
-
12
- The Syllble SDK provides a comprehensive set of tools and APIs to integrate powerful AI capabilities into your applications. Whether you're building chatbots, virtual assistants, or any other AI-driven solutions, Syllble SDK has got you covered.
13
-
14
- ## Features
15
-
16
- - **Natural Language Processing (NLP)**: Understand and generate human language with ease.
17
- - **Machine Learning Models**: Leverage pre-trained models or train your own custom models.
18
- - **Speech Recognition**: Convert speech to text and vice versa.
19
- - **Image Recognition**: Identify objects, faces, and scenes in images.
20
- - **Data Analytics**: Analyze and visualize data to gain insights.
21
- - **Integration**: Seamlessly integrate with other services and platforms.
22
-