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/targets/README.md DELETED
@@ -1,194 +0,0 @@
1
- # Targets
2
- (*channels.targets*)
3
-
4
- ## Overview
5
-
6
- Operations related to channel targets
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Get Channel Targets
11
- * [create](#create) - Assign A Channel Target
12
- * [get_by_id](#get_by_id) - Get A Channel Target
13
- * [update](#update) - Edit Channel Target
14
-
15
- ## list
16
-
17
- Get Channel Targets
18
-
19
- ### Example Usage
20
-
21
- ```python
22
- import os
23
- from syllable_sdk import Syllable
24
-
25
- s = Syllable(
26
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
27
- )
28
-
29
- res = s.channels.targets.list()
30
-
31
- if res is not None:
32
- # handle response
33
- pass
34
-
35
- ```
36
-
37
- ### Parameters
38
-
39
- | Parameter | Type | Required | Description |
40
- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
41
- | `request` | [models.ChannelTargetsListRequest](../../models/channeltargetslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
42
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
43
-
44
- ### Response
45
-
46
- **[models.ChannelTargetListResponse](../../models/channeltargetlistresponse.md)**
47
-
48
- ### Errors
49
-
50
- | Error Type | Status Code | Content Type |
51
- | -------------------------- | -------------------------- | -------------------------- |
52
- | models.HTTPValidationError | 422 | application/json |
53
- | models.SDKError | 4XX, 5XX | \*/\* |
54
-
55
- ## create
56
-
57
- Assign A Channel Target
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.channels.targets.create(channel_id=134365, channel_target_create_request={
70
- "channel_id": 486589,
71
- "channel_name": "<value>",
72
- "agent_id": 638424,
73
- "target": "<value>",
74
- "target_mode": "<value>",
75
- "fallback_target": "<value>",
76
- "is_test": True,
77
- })
78
-
79
- if res is not None:
80
- # handle response
81
- pass
82
-
83
- ```
84
-
85
- ### Parameters
86
-
87
- | Parameter | Type | Required | Description |
88
- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
89
- | `channel_id` | *int* | :heavy_check_mark: | N/A |
90
- | `channel_target_create_request` | [models.ChannelTargetCreateRequest](../../models/channeltargetcreaterequest.md) | :heavy_check_mark: | N/A |
91
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
92
-
93
- ### Response
94
-
95
- **[models.ChannelTarget](../../models/channeltarget.md)**
96
-
97
- ### Errors
98
-
99
- | Error Type | Status Code | Content Type |
100
- | -------------------------- | -------------------------- | -------------------------- |
101
- | models.HTTPValidationError | 422 | application/json |
102
- | models.SDKError | 4XX, 5XX | \*/\* |
103
-
104
- ## get_by_id
105
-
106
- Get A Channel Target
107
-
108
- ### Example Usage
109
-
110
- ```python
111
- import os
112
- from syllable_sdk import Syllable
113
-
114
- s = Syllable(
115
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
116
- )
117
-
118
- res = s.channels.targets.get_by_id(channel_id=931598, target_id=505057)
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
- | `channel_id` | *int* | :heavy_check_mark: | N/A |
131
- | `target_id` | *int* | :heavy_check_mark: | N/A |
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.ChannelTarget](../../models/channeltarget.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
- ## update
146
-
147
- Update channel target 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.channels.targets.update(channel_id=627690, target_id=488852, channel_target={
160
- "id": 857478,
161
- "channel_id": 597129,
162
- "channel_name": "<value>",
163
- "agent_id": 344620,
164
- "target": "<value>",
165
- "target_mode": "<value>",
166
- "fallback_target": "<value>",
167
- "is_test": False,
168
- })
169
-
170
- if res is not None:
171
- # handle response
172
- pass
173
-
174
- ```
175
-
176
- ### Parameters
177
-
178
- | Parameter | Type | Required | Description |
179
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
180
- | `channel_id` | *int* | :heavy_check_mark: | N/A |
181
- | `target_id` | *int* | :heavy_check_mark: | N/A |
182
- | `channel_target` | [models.ChannelTarget](../../models/channeltarget.md) | :heavy_check_mark: | N/A |
183
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
184
-
185
- ### Response
186
-
187
- **[models.ChannelTarget](../../models/channeltarget.md)**
188
-
189
- ### Errors
190
-
191
- | Error Type | Status Code | Content Type |
192
- | -------------------------- | -------------------------- | -------------------------- |
193
- | models.HTTPValidationError | 422 | application/json |
194
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/tools/README.md DELETED
@@ -1,92 +0,0 @@
1
- # Tools
2
- (*tools*)
3
-
4
- ## Overview
5
-
6
- Operations related to tools
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Tool List
11
- * [get_by_name](#get_by_name) - Tool Info
12
-
13
- ## list
14
-
15
- List the existing agents
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.tools.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.ToolListResponse](../../models/toollistresponse.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
- ## get_by_name
55
-
56
- Get the details of a specific tool
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.tools.get_by_name(tool_name="<value>")
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
- | `tool_name` | *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.ToolDetailResponse](../../models/tooldetailresponse.md)**
86
-
87
- ### Errors
88
-
89
- | Error Type | Status Code | Content Type |
90
- | -------------------------- | -------------------------- | -------------------------- |
91
- | models.HTTPValidationError | 422 | application/json |
92
- | models.SDKError | 4XX, 5XX | \*/\* |