syllable-sdk 1.0.7 → 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.
- package/bin/mcp-server.js +54 -17
- package/bin/mcp-server.js.map +11 -10
- package/examples/package-lock.json +1 -1
- package/funcs/directoryUpdate.js +3 -1
- package/funcs/directoryUpdate.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/mcp-server.js.map +1 -1
- package/mcp-server/server.js +1 -1
- package/mcp-server/server.js.map +1 -1
- package/models/components/directorymember.d.ts +4 -4
- package/models/components/directorymember.d.ts.map +1 -1
- package/models/components/directorymember.js +4 -4
- package/models/components/directorymember.js.map +1 -1
- package/models/components/directorymemberupdate.d.ts +60 -0
- package/models/components/directorymemberupdate.d.ts.map +1 -0
- package/models/components/directorymemberupdate.js +87 -0
- package/models/components/directorymemberupdate.js.map +1 -0
- package/models/components/index.d.ts +1 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +1 -0
- package/models/components/index.js.map +1 -1
- package/models/operations/directorymemberupdate.d.ts +2 -2
- package/models/operations/directorymemberupdate.d.ts.map +1 -1
- package/models/operations/directorymemberupdate.js +4 -4
- package/models/operations/directorymemberupdate.js.map +1 -1
- package/openapi.json +136 -52
- package/package.json +1 -1
- package/src/funcs/directoryUpdate.ts +3 -1
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/models/components/directorymember.ts +8 -10
- package/src/models/components/directorymemberupdate.ts +115 -0
- package/src/models/components/index.ts +1 -0
- package/src/models/operations/directorymemberupdate.ts +6 -6
- package/.devcontainer/README.md +0 -35
- package/api-reference/sdks/agents/README.md +0 -224
- package/api-reference/sdks/availabletargets/README.md +0 -49
- package/api-reference/sdks/channels/README.md +0 -92
- package/api-reference/sdks/chats/README.md +0 -55
- package/api-reference/sdks/conversations/README.md +0 -91
- package/api-reference/sdks/dashboards/README.md +0 -321
- package/api-reference/sdks/events/README.md +0 -50
- package/api-reference/sdks/greetings/README.md +0 -223
- package/api-reference/sdks/organizations/README.md +0 -48
- package/api-reference/sdks/prompts/README.md +0 -225
- package/api-reference/sdks/sessions/README.md +0 -50
- package/api-reference/sdks/syllable/README.md +0 -22
- package/api-reference/sdks/targets/README.md +0 -194
- package/api-reference/sdks/tools/README.md +0 -92
- package/docs/sdks/agents/README.md +0 -589
- package/docs/sdks/batches/README.md +0 -742
- package/docs/sdks/campaigns/README.md +0 -526
- package/docs/sdks/channels/README.md +0 -401
- package/docs/sdks/conversations/README.md +0 -100
- package/docs/sdks/custommessages/README.md +0 -496
- package/docs/sdks/dashboards/README.md +0 -481
- package/docs/sdks/datasources/README.md +0 -458
- package/docs/sdks/directory/README.md +0 -731
- package/docs/sdks/events/README.md +0 -100
- package/docs/sdks/folders/README.md +0 -675
- package/docs/sdks/fullsummary/README.md +0 -82
- package/docs/sdks/incidents/README.md +0 -501
- package/docs/sdks/insights/README.md +0 -100
- package/docs/sdks/languagegroups/README.md +0 -565
- package/docs/sdks/latency/README.md +0 -82
- package/docs/sdks/numbers/README.md +0 -250
- package/docs/sdks/organizations/README.md +0 -317
- package/docs/sdks/permissions/README.md +0 -78
- package/docs/sdks/prompts/README.md +0 -592
- package/docs/sdks/pronunciations/README.md +0 -360
- package/docs/sdks/roles/README.md +0 -430
- package/docs/sdks/services/README.md +0 -430
- package/docs/sdks/sessiondebug/README.md +0 -236
- package/docs/sdks/sessionlabels/README.md +0 -262
- package/docs/sdks/sessions/README.md +0 -325
- package/docs/sdks/syllablesdktools/README.md +0 -578
- package/docs/sdks/takeouts/README.md +0 -228
- package/docs/sdks/targets/README.md +0 -454
- package/docs/sdks/test/README.md +0 -92
- package/docs/sdks/tools/README.md +0 -518
- package/docs/sdks/transcript/README.md +0 -82
- package/docs/sdks/twilio/README.md +0 -246
- package/docs/sdks/users/README.md +0 -561
- package/docs/sdks/v1/README.md +0 -561
- package/docs/sdks/voicegroups/README.md +0 -551
- package/docs/sdks/workflows/README.md +0 -781
- package/examples/README.md +0 -31
|
@@ -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 | \*/\* |
|
|
@@ -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 | \*/\* |
|
|
@@ -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 | \*/\* |
|
|
@@ -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 | \*/\* |
|