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
|
@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
|
11
11
|
|
|
12
12
|
export type DirectoryMemberUpdateRequest = {
|
|
13
13
|
memberId: number;
|
|
14
|
-
|
|
14
|
+
directoryMemberUpdate: components.DirectoryMemberUpdate;
|
|
15
15
|
};
|
|
16
16
|
|
|
17
17
|
/** @internal */
|
|
@@ -21,18 +21,18 @@ export const DirectoryMemberUpdateRequest$inboundSchema: z.ZodType<
|
|
|
21
21
|
unknown
|
|
22
22
|
> = z.object({
|
|
23
23
|
member_id: z.number().int(),
|
|
24
|
-
|
|
24
|
+
DirectoryMemberUpdate: components.DirectoryMemberUpdate$inboundSchema,
|
|
25
25
|
}).transform((v) => {
|
|
26
26
|
return remap$(v, {
|
|
27
27
|
"member_id": "memberId",
|
|
28
|
-
"
|
|
28
|
+
"DirectoryMemberUpdate": "directoryMemberUpdate",
|
|
29
29
|
});
|
|
30
30
|
});
|
|
31
31
|
|
|
32
32
|
/** @internal */
|
|
33
33
|
export type DirectoryMemberUpdateRequest$Outbound = {
|
|
34
34
|
member_id: number;
|
|
35
|
-
|
|
35
|
+
DirectoryMemberUpdate: components.DirectoryMemberUpdate$Outbound;
|
|
36
36
|
};
|
|
37
37
|
|
|
38
38
|
/** @internal */
|
|
@@ -42,11 +42,11 @@ export const DirectoryMemberUpdateRequest$outboundSchema: z.ZodType<
|
|
|
42
42
|
DirectoryMemberUpdateRequest
|
|
43
43
|
> = z.object({
|
|
44
44
|
memberId: z.number().int(),
|
|
45
|
-
|
|
45
|
+
directoryMemberUpdate: components.DirectoryMemberUpdate$outboundSchema,
|
|
46
46
|
}).transform((v) => {
|
|
47
47
|
return remap$(v, {
|
|
48
48
|
memberId: "member_id",
|
|
49
|
-
|
|
49
|
+
directoryMemberUpdate: "DirectoryMemberUpdate",
|
|
50
50
|
});
|
|
51
51
|
});
|
|
52
52
|
|
package/.devcontainer/README.md
DELETED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
<div align="center">
|
|
3
|
-
<a href="https://codespaces.new/asksyllable/syllable-sdk-typescript.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
|
|
4
|
-
</div>
|
|
5
|
-
<br>
|
|
6
|
-
|
|
7
|
-
> **Remember to shutdown a GitHub Codespace when it is not in use!**
|
|
8
|
-
|
|
9
|
-
# Dev Containers Quick Start
|
|
10
|
-
|
|
11
|
-
The default location for usage snippets is the `samples` directory.
|
|
12
|
-
|
|
13
|
-
## Running a Usage Sample
|
|
14
|
-
|
|
15
|
-
A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
|
|
16
|
-
|
|
17
|
-
```
|
|
18
|
-
ts-node root.ts
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Generating Additional Usage Samples
|
|
22
|
-
|
|
23
|
-
The speakeasy CLI allows you to generate more usage snippets. Here's how:
|
|
24
|
-
|
|
25
|
-
- To generate a sample for a specific operation by providing an operation ID, use:
|
|
26
|
-
|
|
27
|
-
```
|
|
28
|
-
speakeasy generate usage -s openapi.yaml -l typescript -i {INPUT_OPERATION_ID} -o ./samples
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
- To generate samples for an entire namespace (like a tag or group name), use:
|
|
32
|
-
|
|
33
|
-
```
|
|
34
|
-
speakeasy generate usage -s openapi.yaml -l typescript -n {INPUT_TAG_NAME} -o ./samples
|
|
35
|
-
```
|
|
@@ -1,224 +0,0 @@
|
|
|
1
|
-
# Agents
|
|
2
|
-
(*agents*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
Operations related to agents
|
|
7
|
-
|
|
8
|
-
### Available Operations
|
|
9
|
-
|
|
10
|
-
* [list](#list) - Agent List
|
|
11
|
-
* [create](#create) - Create Agent
|
|
12
|
-
* [update](#update) - Update Agent
|
|
13
|
-
* [get_by_id](#get_by_id) - Get Agent By Id
|
|
14
|
-
* [delete](#delete) - Delete Agent
|
|
15
|
-
|
|
16
|
-
## list
|
|
17
|
-
|
|
18
|
-
List the existing agents
|
|
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.agents.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
|
-
| `request` | [models.AgentListRequest](../../models/agentlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
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.AgentListResponse](../../models/agentlistresponse.md)**
|
|
48
|
-
|
|
49
|
-
### Errors
|
|
50
|
-
|
|
51
|
-
| Error Type | Status Code | Content Type |
|
|
52
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
53
|
-
| models.HTTPValidationError | 422 | application/json |
|
|
54
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
55
|
-
|
|
56
|
-
## create
|
|
57
|
-
|
|
58
|
-
Create a new agent
|
|
59
|
-
|
|
60
|
-
### Example Usage
|
|
61
|
-
|
|
62
|
-
```python
|
|
63
|
-
import os
|
|
64
|
-
from syllable_sdk import Syllable
|
|
65
|
-
|
|
66
|
-
s = Syllable(
|
|
67
|
-
api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
|
|
68
|
-
)
|
|
69
|
-
|
|
70
|
-
res = s.agents.create(request={
|
|
71
|
-
"name": "<value>",
|
|
72
|
-
"timezone": "Antarctica/Rothera",
|
|
73
|
-
"type_extra": {},
|
|
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.AgentCreate](../../models/agentcreate.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.Agent](../../models/agent.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 an existing agent
|
|
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.agents.update(request={
|
|
115
|
-
"name": "<value>",
|
|
116
|
-
"timezone": "Europe/Tallinn",
|
|
117
|
-
"type_extra": {},
|
|
118
|
-
"id": 597129,
|
|
119
|
-
})
|
|
120
|
-
|
|
121
|
-
if res is not None:
|
|
122
|
-
# handle response
|
|
123
|
-
pass
|
|
124
|
-
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
### Parameters
|
|
128
|
-
|
|
129
|
-
| Parameter | Type | Required | Description |
|
|
130
|
-
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
|
131
|
-
| `request` | [models.Agent](../../models/agent.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
132
|
-
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
133
|
-
|
|
134
|
-
### Response
|
|
135
|
-
|
|
136
|
-
**[models.Agent](../../models/agent.md)**
|
|
137
|
-
|
|
138
|
-
### Errors
|
|
139
|
-
|
|
140
|
-
| Error Type | Status Code | Content Type |
|
|
141
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
142
|
-
| models.HTTPValidationError | 422 | application/json |
|
|
143
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
144
|
-
|
|
145
|
-
## get_by_id
|
|
146
|
-
|
|
147
|
-
Get an agent by ID.
|
|
148
|
-
|
|
149
|
-
### Example Usage
|
|
150
|
-
|
|
151
|
-
```python
|
|
152
|
-
import os
|
|
153
|
-
from syllable_sdk import Syllable
|
|
154
|
-
|
|
155
|
-
s = Syllable(
|
|
156
|
-
api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
|
|
157
|
-
)
|
|
158
|
-
|
|
159
|
-
res = s.agents.get_by_id(agent_id=931598)
|
|
160
|
-
|
|
161
|
-
if res is not None:
|
|
162
|
-
# handle response
|
|
163
|
-
pass
|
|
164
|
-
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
### Parameters
|
|
168
|
-
|
|
169
|
-
| Parameter | Type | Required | Description |
|
|
170
|
-
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
|
171
|
-
| `agent_id` | *int* | :heavy_check_mark: | N/A |
|
|
172
|
-
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
173
|
-
|
|
174
|
-
### Response
|
|
175
|
-
|
|
176
|
-
**[models.Agent](../../models/agent.md)**
|
|
177
|
-
|
|
178
|
-
### Errors
|
|
179
|
-
|
|
180
|
-
| Error Type | Status Code | Content Type |
|
|
181
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
182
|
-
| models.HTTPValidationError | 422 | application/json |
|
|
183
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
184
|
-
|
|
185
|
-
## delete
|
|
186
|
-
|
|
187
|
-
Delete an agent by ID
|
|
188
|
-
|
|
189
|
-
### Example Usage
|
|
190
|
-
|
|
191
|
-
```python
|
|
192
|
-
import os
|
|
193
|
-
from syllable_sdk import Syllable
|
|
194
|
-
|
|
195
|
-
s = Syllable(
|
|
196
|
-
api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
|
|
197
|
-
)
|
|
198
|
-
|
|
199
|
-
res = s.agents.delete(agent_id=5705, reason="<value>")
|
|
200
|
-
|
|
201
|
-
if res is not None:
|
|
202
|
-
# handle response
|
|
203
|
-
pass
|
|
204
|
-
|
|
205
|
-
```
|
|
206
|
-
|
|
207
|
-
### Parameters
|
|
208
|
-
|
|
209
|
-
| Parameter | Type | Required | Description |
|
|
210
|
-
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
|
211
|
-
| `agent_id` | *int* | :heavy_check_mark: | N/A |
|
|
212
|
-
| `reason` | *str* | :heavy_check_mark: | N/A |
|
|
213
|
-
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
214
|
-
|
|
215
|
-
### Response
|
|
216
|
-
|
|
217
|
-
**[Any](../../models/.md)**
|
|
218
|
-
|
|
219
|
-
### Errors
|
|
220
|
-
|
|
221
|
-
| Error Type | Status Code | Content Type |
|
|
222
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
223
|
-
| models.HTTPValidationError | 422 | application/json |
|
|
224
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -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 | \*/\* |
|
|
@@ -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 | \*/\* |
|
|
@@ -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 | \*/\* |
|
|
@@ -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 | \*/\* |
|