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/availabletargets/README.md DELETED
@@ -1,49 +0,0 @@
1
- # AvailableTargets
2
- (*channels.available_targets*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - Available Targets List
9
-
10
- ## list
11
-
12
- List the available phone numbers
13
-
14
- ### Example Usage
15
-
16
- ```python
17
- import os
18
- from syllable_sdk import Syllable
19
-
20
- s = Syllable(
21
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
22
- )
23
-
24
- res = s.channels.available_targets.list()
25
-
26
- if res is not None:
27
- # handle response
28
- pass
29
-
30
- ```
31
-
32
- ### Parameters
33
-
34
- | Parameter | Type | Required | Description |
35
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
36
- | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
37
- | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A |
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
- **[models.AvailableTargetsListResponse](../../models/availabletargetslistresponse.md)**
43
-
44
- ### Errors
45
-
46
- | Error Type | Status Code | Content Type |
47
- | -------------------------- | -------------------------- | -------------------------- |
48
- | models.HTTPValidationError | 422 | application/json |
49
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/channels/README.md DELETED
@@ -1,92 +0,0 @@
1
- # Channels
2
- (*channels*)
3
-
4
- ## Overview
5
-
6
- Operations related to channels
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Get Channels
11
- * [delete](#delete) - Delete Channel
12
-
13
- ## list
14
-
15
- Get Channels
16
-
17
- ### Example Usage
18
-
19
- ```python
20
- import os
21
- from syllable_sdk import Syllable
22
-
23
- s = Syllable(
24
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
25
- )
26
-
27
- res = s.channels.list()
28
-
29
- if res is not None:
30
- # handle response
31
- pass
32
-
33
- ```
34
-
35
- ### Parameters
36
-
37
- | Parameter | Type | Required | Description |
38
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
39
- | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
40
- | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A |
41
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
42
-
43
- ### Response
44
-
45
- **[models.ChannelListResponse](../../models/channellistresponse.md)**
46
-
47
- ### Errors
48
-
49
- | Error Type | Status Code | Content Type |
50
- | -------------------------- | -------------------------- | -------------------------- |
51
- | models.HTTPValidationError | 422 | application/json |
52
- | models.SDKError | 4XX, 5XX | \*/\* |
53
-
54
- ## delete
55
-
56
- Delete channel by ID
57
-
58
- ### Example Usage
59
-
60
- ```python
61
- import os
62
- from syllable_sdk import Syllable
63
-
64
- s = Syllable(
65
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
66
- )
67
-
68
- res = s.channels.delete(channel_id="<id>")
69
-
70
- if res is not None:
71
- # handle response
72
- pass
73
-
74
- ```
75
-
76
- ### Parameters
77
-
78
- | Parameter | Type | Required | Description |
79
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
80
- | `channel_id` | *str* | :heavy_check_mark: | N/A |
81
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
82
-
83
- ### Response
84
-
85
- **[models.ChannelTarget](../../models/channeltarget.md)**
86
-
87
- ### Errors
88
-
89
- | Error Type | Status Code | Content Type |
90
- | -------------------------- | -------------------------- | -------------------------- |
91
- | models.HTTPValidationError | 422 | application/json |
92
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/chats/README.md DELETED
@@ -1,55 +0,0 @@
1
- # Chats
2
- (*agents.chats*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [send_message](#send_message) - Send New Message
9
-
10
- ## send_message
11
-
12
- Send a new message
13
-
14
- ### Example Usage
15
-
16
- ```python
17
- import os
18
- from syllable_sdk import Syllable
19
-
20
- s = Syllable(
21
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
22
- )
23
-
24
- res = s.agents.chats.send_message(request={
25
- "service_name": "<value>",
26
- "source_name": "<value>",
27
- "chat_id": "<id>",
28
- "agent_id": "<id>",
29
- "org_name": "<value>",
30
- "text": "<value>",
31
- })
32
-
33
- if res is not None:
34
- # handle response
35
- pass
36
-
37
- ```
38
-
39
- ### Parameters
40
-
41
- | Parameter | Type | Required | Description |
42
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
43
- | `request` | [models.ChatMessage](../../models/chatmessage.md) | :heavy_check_mark: | The request object to use for the request. |
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.ChatMessageResponse](../../models/chatmessageresponse.md)**
49
-
50
- ### Errors
51
-
52
- | Error Type | Status Code | Content Type |
53
- | -------------------------- | -------------------------- | -------------------------- |
54
- | models.HTTPValidationError | 422 | application/json |
55
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/conversations/README.md DELETED
@@ -1,91 +0,0 @@
1
- # Conversations
2
- (*conversations*)
3
-
4
- ## Overview
5
-
6
- Operations related to conversations
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Conversations List
11
- * [get](#get) - Get Conversation By Id
12
-
13
- ## list
14
-
15
- Conversations List
16
-
17
- ### Example Usage
18
-
19
- ```python
20
- import os
21
- from syllable_sdk import Syllable
22
-
23
- s = Syllable(
24
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
25
- )
26
-
27
- res = s.conversations.list()
28
-
29
- if res is not None:
30
- # handle response
31
- pass
32
-
33
- ```
34
-
35
- ### Parameters
36
-
37
- | Parameter | Type | Required | Description |
38
- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
39
- | `request` | [models.ConversationsListRequest](../../models/conversationslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
40
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
41
-
42
- ### Response
43
-
44
- **[models.ConversationListResponse](../../models/conversationlistresponse.md)**
45
-
46
- ### Errors
47
-
48
- | Error Type | Status Code | Content Type |
49
- | -------------------------- | -------------------------- | -------------------------- |
50
- | models.HTTPValidationError | 422 | application/json |
51
- | models.SDKError | 4XX, 5XX | \*/\* |
52
-
53
- ## get
54
-
55
- Get Conversation By Id
56
-
57
- ### Example Usage
58
-
59
- ```python
60
- import os
61
- from syllable_sdk import Syllable
62
-
63
- s = Syllable(
64
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
65
- )
66
-
67
- res = s.conversations.get(conversation_id="<id>")
68
-
69
- if res is not None:
70
- # handle response
71
- pass
72
-
73
- ```
74
-
75
- ### Parameters
76
-
77
- | Parameter | Type | Required | Description |
78
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
79
- | `conversation_id` | *str* | :heavy_check_mark: | N/A |
80
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
81
-
82
- ### Response
83
-
84
- **[models.ConversationTranscriptionResponse](../../models/conversationtranscriptionresponse.md)**
85
-
86
- ### Errors
87
-
88
- | Error Type | Status Code | Content Type |
89
- | -------------------------- | -------------------------- | -------------------------- |
90
- | models.HTTPValidationError | 422 | application/json |
91
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/dashboards/README.md DELETED
@@ -1,321 +0,0 @@
1
- # Dashboards
2
- (*dashboards*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [get_total_call_volume_by_weekday](#get_total_call_volume_by_weekday) - Get Total Call Volume By Weekday
9
- * [get_total_call_volume_by_hour](#get_total_call_volume_by_hour) - Get Total Call Volume By Hour
10
- * [get_weekly_call_volume_by_weekday](#get_weekly_call_volume_by_weekday) - Get Weekly Call Volume By Weekday
11
- * [get_daily_call_volume_by_hour](#get_daily_call_volume_by_hour) - Get Daily Call Volume By Hour
12
- * [get_monthly_call_volume_by_week](#get_monthly_call_volume_by_week) - Get Monthly Call Volume By Week
13
- * [get_monthly_call_volume_by_day](#get_monthly_call_volume_by_day) - Get Monthly Call Volume By Day
14
- * [get_session_summary](#get_session_summary) - Get Session Summary
15
- * [get_session_agents](#get_session_agents) - Get Agents
16
-
17
- ## get_total_call_volume_by_weekday
18
-
19
- Get total call volume by weekday.
20
-
21
- ### Example Usage
22
-
23
- ```python
24
- import os
25
- from syllable_sdk import Syllable
26
-
27
- s = Syllable(
28
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
29
- )
30
-
31
- res = s.dashboards.get_total_call_volume_by_weekday()
32
-
33
- if res is not None:
34
- # handle response
35
- pass
36
-
37
- ```
38
-
39
- ### Parameters
40
-
41
- | Parameter | Type | Required | Description |
42
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
43
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
44
-
45
- ### Response
46
-
47
- **[models.TotalCallVolumeByWeekdayResponseTotalCallVolumeByWeekday](../../models/totalcallvolumebyweekdayresponsetotalcallvolumebyweekday.md)**
48
-
49
- ### Errors
50
-
51
- | Error Type | Status Code | Content Type |
52
- | --------------- | --------------- | --------------- |
53
- | models.SDKError | 4XX, 5XX | \*/\* |
54
-
55
- ## get_total_call_volume_by_hour
56
-
57
- Get total call volume by hour.
58
-
59
- ### Example Usage
60
-
61
- ```python
62
- import os
63
- from syllable_sdk import Syllable
64
-
65
- s = Syllable(
66
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
67
- )
68
-
69
- res = s.dashboards.get_total_call_volume_by_hour()
70
-
71
- if res is not None:
72
- # handle response
73
- pass
74
-
75
- ```
76
-
77
- ### Parameters
78
-
79
- | Parameter | Type | Required | Description |
80
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
81
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
82
-
83
- ### Response
84
-
85
- **[models.GetTotalCallVolumeByHourResponseGetTotalCallVolumeByHour](../../models/gettotalcallvolumebyhourresponsegettotalcallvolumebyhour.md)**
86
-
87
- ### Errors
88
-
89
- | Error Type | Status Code | Content Type |
90
- | --------------- | --------------- | --------------- |
91
- | models.SDKError | 4XX, 5XX | \*/\* |
92
-
93
- ## get_weekly_call_volume_by_weekday
94
-
95
- Get weekly call volume by weekday.
96
-
97
- ### Example Usage
98
-
99
- ```python
100
- import os
101
- from syllable_sdk import Syllable
102
-
103
- s = Syllable(
104
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
105
- )
106
-
107
- res = s.dashboards.get_weekly_call_volume_by_weekday()
108
-
109
- if res is not None:
110
- # handle response
111
- pass
112
-
113
- ```
114
-
115
- ### Parameters
116
-
117
- | Parameter | Type | Required | Description |
118
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
119
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
120
-
121
- ### Response
122
-
123
- **[models.GetWeeklyCallVolumeByWeekdayResponseGetWeeklyCallVolumeByWeekday](../../models/getweeklycallvolumebyweekdayresponsegetweeklycallvolumebyweekday.md)**
124
-
125
- ### Errors
126
-
127
- | Error Type | Status Code | Content Type |
128
- | --------------- | --------------- | --------------- |
129
- | models.SDKError | 4XX, 5XX | \*/\* |
130
-
131
- ## get_daily_call_volume_by_hour
132
-
133
- Get daily call volume by hour.
134
-
135
- ### Example Usage
136
-
137
- ```python
138
- import os
139
- from syllable_sdk import Syllable
140
-
141
- s = Syllable(
142
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
143
- )
144
-
145
- res = s.dashboards.get_daily_call_volume_by_hour()
146
-
147
- if res is not None:
148
- # handle response
149
- pass
150
-
151
- ```
152
-
153
- ### Parameters
154
-
155
- | Parameter | Type | Required | Description |
156
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
157
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
158
-
159
- ### Response
160
-
161
- **[models.GetDailyCallVolumeByHourResponseGetDailyCallVolumeByHour](../../models/getdailycallvolumebyhourresponsegetdailycallvolumebyhour.md)**
162
-
163
- ### Errors
164
-
165
- | Error Type | Status Code | Content Type |
166
- | --------------- | --------------- | --------------- |
167
- | models.SDKError | 4XX, 5XX | \*/\* |
168
-
169
- ## get_monthly_call_volume_by_week
170
-
171
- Get monthly cal volume by week.
172
-
173
- ### Example Usage
174
-
175
- ```python
176
- import os
177
- from syllable_sdk import Syllable
178
-
179
- s = Syllable(
180
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
181
- )
182
-
183
- res = s.dashboards.get_monthly_call_volume_by_week()
184
-
185
- if res is not None:
186
- # handle response
187
- pass
188
-
189
- ```
190
-
191
- ### Parameters
192
-
193
- | Parameter | Type | Required | Description |
194
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
195
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
196
-
197
- ### Response
198
-
199
- **[models.GetMonthlyCallVolumeByWeekResponseGetMonthlyCallVolumeByWeek](../../models/getmonthlycallvolumebyweekresponsegetmonthlycallvolumebyweek.md)**
200
-
201
- ### Errors
202
-
203
- | Error Type | Status Code | Content Type |
204
- | --------------- | --------------- | --------------- |
205
- | models.SDKError | 4XX, 5XX | \*/\* |
206
-
207
- ## get_monthly_call_volume_by_day
208
-
209
- Get monthly call volume by day.
210
-
211
- ### Example Usage
212
-
213
- ```python
214
- import os
215
- from syllable_sdk import Syllable
216
-
217
- s = Syllable(
218
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
219
- )
220
-
221
- res = s.dashboards.get_monthly_call_volume_by_day()
222
-
223
- if res is not None:
224
- # handle response
225
- pass
226
-
227
- ```
228
-
229
- ### Parameters
230
-
231
- | Parameter | Type | Required | Description |
232
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
233
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
234
-
235
- ### Response
236
-
237
- **[models.GetMonthlyCallVolumeByDayResponseGetMonthlyCallVolumeByDay](../../models/getmonthlycallvolumebydayresponsegetmonthlycallvolumebyday.md)**
238
-
239
- ### Errors
240
-
241
- | Error Type | Status Code | Content Type |
242
- | --------------- | --------------- | --------------- |
243
- | models.SDKError | 4XX, 5XX | \*/\* |
244
-
245
- ## get_session_summary
246
-
247
- Get session summary data
248
-
249
- ### Example Usage
250
-
251
- ```python
252
- import os
253
- from syllable_sdk import Syllable
254
-
255
- s = Syllable(
256
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
257
- )
258
-
259
- res = s.dashboards.get_session_summary()
260
-
261
- if res is not None:
262
- # handle response
263
- pass
264
-
265
- ```
266
-
267
- ### Parameters
268
-
269
- | Parameter | Type | Required | Description |
270
- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
271
- | `request` | [models.GetSessionSummaryRequest](../../models/getsessionsummaryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
272
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
273
-
274
- ### Response
275
-
276
- **[models.GetSessionSummaryResponseGetSessionSummary](../../models/getsessionsummaryresponsegetsessionsummary.md)**
277
-
278
- ### Errors
279
-
280
- | Error Type | Status Code | Content Type |
281
- | -------------------------- | -------------------------- | -------------------------- |
282
- | models.HTTPValidationError | 422 | application/json |
283
- | models.SDKError | 4XX, 5XX | \*/\* |
284
-
285
- ## get_session_agents
286
-
287
- Get list of agents for session summary dropdown
288
-
289
- ### Example Usage
290
-
291
- ```python
292
- import os
293
- from syllable_sdk import Syllable
294
-
295
- s = Syllable(
296
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
297
- )
298
-
299
- res = s.dashboards.get_session_agents()
300
-
301
- if res is not None:
302
- # handle response
303
- pass
304
-
305
- ```
306
-
307
- ### Parameters
308
-
309
- | Parameter | Type | Required | Description |
310
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
311
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
312
-
313
- ### Response
314
-
315
- **[models.GetSessionAgentsResponseGetSessionAgents](../../models/getsessionagentsresponsegetsessionagents.md)**
316
-
317
- ### Errors
318
-
319
- | Error Type | Status Code | Content Type |
320
- | --------------- | --------------- | --------------- |
321
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/events/README.md DELETED
@@ -1,50 +0,0 @@
1
- # Events
2
- (*events*)
3
-
4
- ## Overview
5
-
6
- Operations related to agent events
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Events List
11
-
12
- ## list
13
-
14
- Events 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.events.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.EventsListRequest](../../models/eventslistrequest.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.EventListResponse](../../models/eventlistresponse.md)**
44
-
45
- ### Errors
46
-
47
- | Error Type | Status Code | Content Type |
48
- | -------------------------- | -------------------------- | -------------------------- |
49
- | models.HTTPValidationError | 422 | application/json |
50
- | models.SDKError | 4XX, 5XX | \*/\* |