syllable-sdk 0.1.0-alpha.46 → 0.1.0-alpha.48

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 (202) hide show
  1. package/README.md +34 -0
  2. package/docs/sdks/insights/README.md +6 -0
  3. package/docs/sdks/summary/README.md +85 -0
  4. package/docs/sdks/syllablesdktools/README.md +411 -0
  5. package/docs/sdks/workflows/README.md +429 -0
  6. package/funcs/insightsToolsCreate.d.ts +16 -0
  7. package/funcs/insightsToolsCreate.d.ts.map +1 -0
  8. package/funcs/insightsToolsCreate.js +102 -0
  9. package/funcs/insightsToolsCreate.js.map +1 -0
  10. package/funcs/insightsToolsGetById.d.ts +17 -0
  11. package/funcs/insightsToolsGetById.d.ts.map +1 -0
  12. package/funcs/insightsToolsGetById.js +108 -0
  13. package/funcs/insightsToolsGetById.js.map +1 -0
  14. package/funcs/insightsToolsInsightToolGetDefinitions.d.ts +15 -0
  15. package/funcs/insightsToolsInsightToolGetDefinitions.d.ts.map +1 -0
  16. package/funcs/insightsToolsInsightToolGetDefinitions.js +89 -0
  17. package/funcs/insightsToolsInsightToolGetDefinitions.js.map +1 -0
  18. package/funcs/insightsToolsList.d.ts +17 -0
  19. package/funcs/insightsToolsList.d.ts.map +1 -0
  20. package/funcs/insightsToolsList.js +114 -0
  21. package/funcs/insightsToolsList.js.map +1 -0
  22. package/funcs/insightsToolsUpdate.d.ts +17 -0
  23. package/funcs/insightsToolsUpdate.d.ts.map +1 -0
  24. package/funcs/insightsToolsUpdate.js +109 -0
  25. package/funcs/insightsToolsUpdate.js.map +1 -0
  26. package/funcs/insightsWorkflowsCreate.d.ts +16 -0
  27. package/funcs/insightsWorkflowsCreate.d.ts.map +1 -0
  28. package/funcs/insightsWorkflowsCreate.js +102 -0
  29. package/funcs/insightsWorkflowsCreate.js.map +1 -0
  30. package/funcs/insightsWorkflowsDelete.d.ts +16 -0
  31. package/funcs/insightsWorkflowsDelete.d.ts.map +1 -0
  32. package/funcs/insightsWorkflowsDelete.js +108 -0
  33. package/funcs/insightsWorkflowsDelete.js.map +1 -0
  34. package/funcs/insightsWorkflowsGetById.d.ts +17 -0
  35. package/funcs/insightsWorkflowsGetById.d.ts.map +1 -0
  36. package/funcs/insightsWorkflowsGetById.js +108 -0
  37. package/funcs/insightsWorkflowsGetById.js.map +1 -0
  38. package/funcs/insightsWorkflowsList.d.ts +17 -0
  39. package/funcs/insightsWorkflowsList.d.ts.map +1 -0
  40. package/funcs/insightsWorkflowsList.js +114 -0
  41. package/funcs/insightsWorkflowsList.js.map +1 -0
  42. package/funcs/insightsWorkflowsUpdate.d.ts +17 -0
  43. package/funcs/insightsWorkflowsUpdate.d.ts.map +1 -0
  44. package/funcs/insightsWorkflowsUpdate.js +111 -0
  45. package/funcs/insightsWorkflowsUpdate.js.map +1 -0
  46. package/funcs/sessionsSummaryGetById.d.ts +13 -0
  47. package/funcs/sessionsSummaryGetById.d.ts.map +1 -0
  48. package/funcs/sessionsSummaryGetById.js +105 -0
  49. package/funcs/sessionsSummaryGetById.js.map +1 -0
  50. package/jsr.json +1 -1
  51. package/lib/config.d.ts +2 -2
  52. package/lib/config.js +2 -2
  53. package/mintlify/mint.json +4 -2
  54. package/models/components/index.d.ts +9 -0
  55. package/models/components/index.d.ts.map +1 -1
  56. package/models/components/index.js +9 -0
  57. package/models/components/index.js.map +1 -1
  58. package/models/components/insighttooldefinition.d.ts +105 -0
  59. package/models/components/insighttooldefinition.d.ts.map +1 -0
  60. package/models/components/insighttooldefinition.js +126 -0
  61. package/models/components/insighttooldefinition.js.map +1 -0
  62. package/models/components/insighttoolinput.d.ts +76 -0
  63. package/models/components/insighttoolinput.d.ts.map +1 -0
  64. package/models/components/insighttoolinput.js +101 -0
  65. package/models/components/insighttoolinput.js.map +1 -0
  66. package/models/components/insighttooloutput.d.ts +102 -0
  67. package/models/components/insighttooloutput.d.ts.map +1 -0
  68. package/models/components/insighttooloutput.js +124 -0
  69. package/models/components/insighttooloutput.js.map +1 -0
  70. package/models/components/insighttoolproperties.d.ts +40 -0
  71. package/models/components/insighttoolproperties.d.ts.map +1 -0
  72. package/models/components/insighttoolproperties.js +54 -0
  73. package/models/components/insighttoolproperties.js.map +1 -0
  74. package/models/components/insightworkflowinput.d.ts +76 -0
  75. package/models/components/insightworkflowinput.d.ts.map +1 -0
  76. package/models/components/insightworkflowinput.js +99 -0
  77. package/models/components/insightworkflowinput.js.map +1 -0
  78. package/models/components/insightworkflowoutput.d.ts +102 -0
  79. package/models/components/insightworkflowoutput.d.ts.map +1 -0
  80. package/models/components/insightworkflowoutput.js +120 -0
  81. package/models/components/insightworkflowoutput.js.map +1 -0
  82. package/models/components/insightworkflowproperties.d.ts +43 -0
  83. package/models/components/insightworkflowproperties.d.ts.map +1 -0
  84. package/models/components/insightworkflowproperties.js +55 -0
  85. package/models/components/insightworkflowproperties.js.map +1 -0
  86. package/models/components/listresponseinsighttooloutput.d.ts +38 -0
  87. package/models/components/listresponseinsighttooloutput.d.ts.map +1 -0
  88. package/models/components/listresponseinsighttooloutput.js +81 -0
  89. package/models/components/listresponseinsighttooloutput.js.map +1 -0
  90. package/models/components/listresponseinsightworkflowoutput.d.ts +38 -0
  91. package/models/components/listresponseinsightworkflowoutput.d.ts.map +1 -0
  92. package/models/components/listresponseinsightworkflowoutput.js +81 -0
  93. package/models/components/listresponseinsightworkflowoutput.js.map +1 -0
  94. package/models/components/promptcreaterequest.d.ts +5 -0
  95. package/models/components/promptcreaterequest.d.ts.map +1 -1
  96. package/models/components/promptcreaterequest.js +4 -0
  97. package/models/components/promptcreaterequest.js.map +1 -1
  98. package/models/components/promptupdaterequest.d.ts +5 -0
  99. package/models/components/promptupdaterequest.d.ts.map +1 -1
  100. package/models/components/promptupdaterequest.js +4 -0
  101. package/models/components/promptupdaterequest.js.map +1 -1
  102. package/models/operations/directoryworkflowdelete.d.ts +29 -0
  103. package/models/operations/directoryworkflowdelete.d.ts.map +1 -0
  104. package/models/operations/directoryworkflowdelete.js +68 -0
  105. package/models/operations/directoryworkflowdelete.js.map +1 -0
  106. package/models/operations/index.d.ts +8 -0
  107. package/models/operations/index.d.ts.map +1 -1
  108. package/models/operations/index.js +8 -0
  109. package/models/operations/index.js.map +1 -1
  110. package/models/operations/insightstoolupdate.d.ts +32 -0
  111. package/models/operations/insightstoolupdate.d.ts.map +1 -0
  112. package/models/operations/insightstoolupdate.js +73 -0
  113. package/models/operations/insightstoolupdate.js.map +1 -0
  114. package/models/operations/insightsworkflowgetbyid.d.ts +29 -0
  115. package/models/operations/insightsworkflowgetbyid.d.ts.map +1 -0
  116. package/models/operations/insightsworkflowgetbyid.js +68 -0
  117. package/models/operations/insightsworkflowgetbyid.js.map +1 -0
  118. package/models/operations/insightsworkflowlist.d.ts +46 -0
  119. package/models/operations/insightsworkflowlist.d.ts.map +1 -0
  120. package/models/operations/insightsworkflowlist.js +101 -0
  121. package/models/operations/insightsworkflowlist.js.map +1 -0
  122. package/models/operations/insightsworkflowupdate.d.ts +32 -0
  123. package/models/operations/insightsworkflowupdate.d.ts.map +1 -0
  124. package/models/operations/insightsworkflowupdate.js +73 -0
  125. package/models/operations/insightsworkflowupdate.js.map +1 -0
  126. package/models/operations/insighttoolgetbyid.d.ts +29 -0
  127. package/models/operations/insighttoolgetbyid.d.ts.map +1 -0
  128. package/models/operations/insighttoolgetbyid.js +68 -0
  129. package/models/operations/insighttoolgetbyid.js.map +1 -0
  130. package/models/operations/insighttoollist.d.ts +46 -0
  131. package/models/operations/insighttoollist.d.ts.map +1 -0
  132. package/models/operations/insighttoollist.js +103 -0
  133. package/models/operations/insighttoollist.js.map +1 -0
  134. package/models/operations/sessionsummarygetbyid.d.ts +29 -0
  135. package/models/operations/sessionsummarygetbyid.d.ts.map +1 -0
  136. package/models/operations/sessionsummarygetbyid.js +68 -0
  137. package/models/operations/sessionsummarygetbyid.js.map +1 -0
  138. package/openapi.json +1267 -35
  139. package/package.json +1 -1
  140. package/sdk/insights.d.ts +10 -0
  141. package/sdk/insights.d.ts.map +1 -0
  142. package/sdk/insights.js +19 -0
  143. package/sdk/insights.js.map +1 -0
  144. package/sdk/sdk.d.ts +3 -0
  145. package/sdk/sdk.d.ts.map +1 -1
  146. package/sdk/sdk.js +4 -0
  147. package/sdk/sdk.js.map +1 -1
  148. package/sdk/sessions.d.ts +3 -0
  149. package/sdk/sessions.d.ts.map +1 -1
  150. package/sdk/sessions.js +4 -0
  151. package/sdk/sessions.js.map +1 -1
  152. package/sdk/summary.d.ts +9 -0
  153. package/sdk/summary.d.ts.map +1 -0
  154. package/sdk/summary.js +19 -0
  155. package/sdk/summary.js.map +1 -0
  156. package/sdk/syllablesdktools.d.ts +41 -0
  157. package/sdk/syllablesdktools.d.ts.map +1 -0
  158. package/sdk/syllablesdktools.js +62 -0
  159. package/sdk/syllablesdktools.js.map +1 -0
  160. package/sdk/workflows.d.ts +41 -0
  161. package/sdk/workflows.d.ts.map +1 -0
  162. package/sdk/workflows.js +62 -0
  163. package/sdk/workflows.js.map +1 -0
  164. package/src/funcs/insightsToolsCreate.ts +135 -0
  165. package/src/funcs/insightsToolsGetById.ts +142 -0
  166. package/src/funcs/insightsToolsInsightToolGetDefinitions.ts +112 -0
  167. package/src/funcs/insightsToolsList.ts +148 -0
  168. package/src/funcs/insightsToolsUpdate.ts +143 -0
  169. package/src/funcs/insightsWorkflowsCreate.ts +135 -0
  170. package/src/funcs/insightsWorkflowsDelete.ts +145 -0
  171. package/src/funcs/insightsWorkflowsGetById.ts +145 -0
  172. package/src/funcs/insightsWorkflowsList.ts +149 -0
  173. package/src/funcs/insightsWorkflowsUpdate.ts +148 -0
  174. package/src/funcs/sessionsSummaryGetById.ts +140 -0
  175. package/src/lib/config.ts +2 -2
  176. package/src/models/components/index.ts +9 -0
  177. package/src/models/components/insighttooldefinition.ts +213 -0
  178. package/src/models/components/insighttoolinput.ts +163 -0
  179. package/src/models/components/insighttooloutput.ts +210 -0
  180. package/src/models/components/insighttoolproperties.ts +37 -0
  181. package/src/models/components/insightworkflowinput.ts +161 -0
  182. package/src/models/components/insightworkflowoutput.ts +206 -0
  183. package/src/models/components/insightworkflowproperties.ts +40 -0
  184. package/src/models/components/listresponseinsighttooloutput.ts +103 -0
  185. package/src/models/components/listresponseinsightworkflowoutput.ts +104 -0
  186. package/src/models/components/promptcreaterequest.ts +9 -0
  187. package/src/models/components/promptupdaterequest.ts +9 -0
  188. package/src/models/operations/directoryworkflowdelete.ts +77 -0
  189. package/src/models/operations/index.ts +8 -0
  190. package/src/models/operations/insightstoolupdate.ts +82 -0
  191. package/src/models/operations/insightsworkflowgetbyid.ts +77 -0
  192. package/src/models/operations/insightsworkflowlist.ts +130 -0
  193. package/src/models/operations/insightsworkflowupdate.ts +84 -0
  194. package/src/models/operations/insighttoolgetbyid.ts +75 -0
  195. package/src/models/operations/insighttoollist.ts +126 -0
  196. package/src/models/operations/sessionsummarygetbyid.ts +77 -0
  197. package/src/sdk/insights.ts +19 -0
  198. package/src/sdk/sdk.ts +6 -0
  199. package/src/sdk/sessions.ts +6 -0
  200. package/src/sdk/summary.ts +24 -0
  201. package/src/sdk/syllablesdktools.ts +98 -0
  202. package/src/sdk/workflows.ts +100 -0
@@ -0,0 +1,429 @@
1
+ # Workflows
2
+ (*insights.workflows*)
3
+
4
+ ## Overview
5
+
6
+ Operations related to insights workflows. An workflow is series of tool invocations that processes conversation data to extract information and generate reports.
7
+
8
+ ### Available Operations
9
+
10
+ * [list](#list) - Insight Workflow List
11
+ * [create](#create) - Create Insight Workflow
12
+ * [getById](#getbyid) - Get Insight Workflow By Id
13
+ * [update](#update) - Update Insights Workflow
14
+ * [delete](#delete) - Delete Insights Workflow
15
+
16
+ ## list
17
+
18
+ List the existing insight_workflows
19
+
20
+ ### Example Usage
21
+
22
+ ```typescript
23
+ import { SyllableSDK } from "syllable-sdk";
24
+
25
+ const syllableSDK = new SyllableSDK({
26
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
27
+ });
28
+
29
+ async function run() {
30
+ const result = await syllableSDK.insights.workflows.list({});
31
+
32
+ // Handle the result
33
+ console.log(result);
34
+ }
35
+
36
+ run();
37
+ ```
38
+
39
+ ### Standalone function
40
+
41
+ The standalone function version of this method:
42
+
43
+ ```typescript
44
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
45
+ import { insightsWorkflowsList } from "syllable-sdk/funcs/insightsWorkflowsList.js";
46
+
47
+ // Use `SyllableSDKCore` for best tree-shaking performance.
48
+ // You can create one instance of it to use across an application.
49
+ const syllableSDK = new SyllableSDKCore({
50
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
51
+ });
52
+
53
+ async function run() {
54
+ const res = await insightsWorkflowsList(syllableSDK, {});
55
+
56
+ if (!res.ok) {
57
+ throw res.error;
58
+ }
59
+
60
+ const { value: result } = res;
61
+
62
+ // Handle the result
63
+ console.log(result);
64
+ }
65
+
66
+ run();
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Parameter | Type | Required | Description |
72
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
73
+ | `request` | [operations.InsightsWorkflowListRequest](../../models/operations/insightsworkflowlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
74
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
75
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
76
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
77
+
78
+ ### Response
79
+
80
+ **Promise\<[components.ListResponseInsightWorkflowOutput](../../models/components/listresponseinsightworkflowoutput.md)\>**
81
+
82
+ ### Errors
83
+
84
+ | Error Type | Status Code | Content Type |
85
+ | -------------------------- | -------------------------- | -------------------------- |
86
+ | errors.HTTPValidationError | 422 | application/json |
87
+ | errors.SDKError | 4XX, 5XX | \*/\* |
88
+
89
+ ## create
90
+
91
+ Create a new tool in the insights
92
+
93
+ ### Example Usage
94
+
95
+ ```typescript
96
+ import { SyllableSDK } from "syllable-sdk";
97
+
98
+ const syllableSDK = new SyllableSDK({
99
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
100
+ });
101
+
102
+ async function run() {
103
+ const result = await syllableSDK.insights.workflows.create({
104
+ name: "<value>",
105
+ description: "yuck vice between gee ugh ha",
106
+ insightToolIds: [
107
+ 780486,
108
+ 760259,
109
+ 219974,
110
+ ],
111
+ conditions: {},
112
+ status: "<value>",
113
+ });
114
+
115
+ // Handle the result
116
+ console.log(result);
117
+ }
118
+
119
+ run();
120
+ ```
121
+
122
+ ### Standalone function
123
+
124
+ The standalone function version of this method:
125
+
126
+ ```typescript
127
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
128
+ import { insightsWorkflowsCreate } from "syllable-sdk/funcs/insightsWorkflowsCreate.js";
129
+
130
+ // Use `SyllableSDKCore` for best tree-shaking performance.
131
+ // You can create one instance of it to use across an application.
132
+ const syllableSDK = new SyllableSDKCore({
133
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
134
+ });
135
+
136
+ async function run() {
137
+ const res = await insightsWorkflowsCreate(syllableSDK, {
138
+ name: "<value>",
139
+ description: "yuck vice between gee ugh ha",
140
+ insightToolIds: [
141
+ 780486,
142
+ 760259,
143
+ 219974,
144
+ ],
145
+ conditions: {},
146
+ status: "<value>",
147
+ });
148
+
149
+ if (!res.ok) {
150
+ throw res.error;
151
+ }
152
+
153
+ const { value: result } = res;
154
+
155
+ // Handle the result
156
+ console.log(result);
157
+ }
158
+
159
+ run();
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ | Parameter | Type | Required | Description |
165
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
166
+ | `request` | [components.InsightWorkflowInput](../../models/components/insightworkflowinput.md) | :heavy_check_mark: | The request object to use for the request. |
167
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
168
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
169
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
170
+
171
+ ### Response
172
+
173
+ **Promise\<[components.InsightWorkflowOutput](../../models/components/insightworkflowoutput.md)\>**
174
+
175
+ ### Errors
176
+
177
+ | Error Type | Status Code | Content Type |
178
+ | -------------------------- | -------------------------- | -------------------------- |
179
+ | errors.HTTPValidationError | 422 | application/json |
180
+ | errors.SDKError | 4XX, 5XX | \*/\* |
181
+
182
+ ## getById
183
+
184
+ Get a InsightWorkflow by ID.
185
+
186
+ ### Example Usage
187
+
188
+ ```typescript
189
+ import { SyllableSDK } from "syllable-sdk";
190
+
191
+ const syllableSDK = new SyllableSDK({
192
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
193
+ });
194
+
195
+ async function run() {
196
+ const result = await syllableSDK.insights.workflows.getById({
197
+ workflowId: 931598,
198
+ });
199
+
200
+ // Handle the result
201
+ console.log(result);
202
+ }
203
+
204
+ run();
205
+ ```
206
+
207
+ ### Standalone function
208
+
209
+ The standalone function version of this method:
210
+
211
+ ```typescript
212
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
213
+ import { insightsWorkflowsGetById } from "syllable-sdk/funcs/insightsWorkflowsGetById.js";
214
+
215
+ // Use `SyllableSDKCore` for best tree-shaking performance.
216
+ // You can create one instance of it to use across an application.
217
+ const syllableSDK = new SyllableSDKCore({
218
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
219
+ });
220
+
221
+ async function run() {
222
+ const res = await insightsWorkflowsGetById(syllableSDK, {
223
+ workflowId: 931598,
224
+ });
225
+
226
+ if (!res.ok) {
227
+ throw res.error;
228
+ }
229
+
230
+ const { value: result } = res;
231
+
232
+ // Handle the result
233
+ console.log(result);
234
+ }
235
+
236
+ run();
237
+ ```
238
+
239
+ ### Parameters
240
+
241
+ | Parameter | Type | Required | Description |
242
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
243
+ | `request` | [operations.InsightsWorkflowGetByIdRequest](../../models/operations/insightsworkflowgetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
244
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
245
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
246
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
247
+
248
+ ### Response
249
+
250
+ **Promise\<[components.InsightWorkflowOutput](../../models/components/insightworkflowoutput.md)\>**
251
+
252
+ ### Errors
253
+
254
+ | Error Type | Status Code | Content Type |
255
+ | -------------------------- | -------------------------- | -------------------------- |
256
+ | errors.HTTPValidationError | 422 | application/json |
257
+ | errors.SDKError | 4XX, 5XX | \*/\* |
258
+
259
+ ## update
260
+
261
+ Update a InsightWorkflow.
262
+
263
+ ### Example Usage
264
+
265
+ ```typescript
266
+ import { SyllableSDK } from "syllable-sdk";
267
+
268
+ const syllableSDK = new SyllableSDK({
269
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
270
+ });
271
+
272
+ async function run() {
273
+ const result = await syllableSDK.insights.workflows.update({
274
+ workflowId: 265006,
275
+ insightWorkflowInput: {
276
+ name: "<value>",
277
+ description: "awful underneath retention too mobility char innocently dowse restfully",
278
+ insightToolIds: [
279
+
280
+ ],
281
+ conditions: {},
282
+ status: "<value>",
283
+ },
284
+ });
285
+
286
+ // Handle the result
287
+ console.log(result);
288
+ }
289
+
290
+ run();
291
+ ```
292
+
293
+ ### Standalone function
294
+
295
+ The standalone function version of this method:
296
+
297
+ ```typescript
298
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
299
+ import { insightsWorkflowsUpdate } from "syllable-sdk/funcs/insightsWorkflowsUpdate.js";
300
+
301
+ // Use `SyllableSDKCore` for best tree-shaking performance.
302
+ // You can create one instance of it to use across an application.
303
+ const syllableSDK = new SyllableSDKCore({
304
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
305
+ });
306
+
307
+ async function run() {
308
+ const res = await insightsWorkflowsUpdate(syllableSDK, {
309
+ workflowId: 265006,
310
+ insightWorkflowInput: {
311
+ name: "<value>",
312
+ description: "awful underneath retention too mobility char innocently dowse restfully",
313
+ insightToolIds: [
314
+
315
+ ],
316
+ conditions: {},
317
+ status: "<value>",
318
+ },
319
+ });
320
+
321
+ if (!res.ok) {
322
+ throw res.error;
323
+ }
324
+
325
+ const { value: result } = res;
326
+
327
+ // Handle the result
328
+ console.log(result);
329
+ }
330
+
331
+ run();
332
+ ```
333
+
334
+ ### Parameters
335
+
336
+ | Parameter | Type | Required | Description |
337
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
338
+ | `request` | [operations.InsightsWorkflowUpdateRequest](../../models/operations/insightsworkflowupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
339
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
340
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
341
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
342
+
343
+ ### Response
344
+
345
+ **Promise\<[components.InsightWorkflowOutput](../../models/components/insightworkflowoutput.md)\>**
346
+
347
+ ### Errors
348
+
349
+ | Error Type | Status Code | Content Type |
350
+ | -------------------------- | -------------------------- | -------------------------- |
351
+ | errors.HTTPValidationError | 422 | application/json |
352
+ | errors.SDKError | 4XX, 5XX | \*/\* |
353
+
354
+ ## delete
355
+
356
+ Delete a Insights workflow.
357
+
358
+ ### Example Usage
359
+
360
+ ```typescript
361
+ import { SyllableSDK } from "syllable-sdk";
362
+
363
+ const syllableSDK = new SyllableSDK({
364
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
365
+ });
366
+
367
+ async function run() {
368
+ const result = await syllableSDK.insights.workflows.delete({
369
+ workflowId: 545907,
370
+ });
371
+
372
+ // Handle the result
373
+ console.log(result);
374
+ }
375
+
376
+ run();
377
+ ```
378
+
379
+ ### Standalone function
380
+
381
+ The standalone function version of this method:
382
+
383
+ ```typescript
384
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
385
+ import { insightsWorkflowsDelete } from "syllable-sdk/funcs/insightsWorkflowsDelete.js";
386
+
387
+ // Use `SyllableSDKCore` for best tree-shaking performance.
388
+ // You can create one instance of it to use across an application.
389
+ const syllableSDK = new SyllableSDKCore({
390
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
391
+ });
392
+
393
+ async function run() {
394
+ const res = await insightsWorkflowsDelete(syllableSDK, {
395
+ workflowId: 545907,
396
+ });
397
+
398
+ if (!res.ok) {
399
+ throw res.error;
400
+ }
401
+
402
+ const { value: result } = res;
403
+
404
+ // Handle the result
405
+ console.log(result);
406
+ }
407
+
408
+ run();
409
+ ```
410
+
411
+ ### Parameters
412
+
413
+ | Parameter | Type | Required | Description |
414
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
415
+ | `request` | [operations.DirectoryWorkflowDeleteRequest](../../models/operations/directoryworkflowdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
416
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
417
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
418
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
419
+
420
+ ### Response
421
+
422
+ **Promise\<[any](../../models/.md)\>**
423
+
424
+ ### Errors
425
+
426
+ | Error Type | Status Code | Content Type |
427
+ | -------------------------- | -------------------------- | -------------------------- |
428
+ | errors.HTTPValidationError | 422 | application/json |
429
+ | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -0,0 +1,16 @@
1
+ import { SyllableSDKCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import * as components from "../models/components/index.js";
4
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
+ import * as errors from "../models/errors/index.js";
6
+ import { SDKError } from "../models/errors/sdkerror.js";
7
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
8
+ import { Result } from "../types/fp.js";
9
+ /**
10
+ * Create Insight Tool
11
+ *
12
+ * @remarks
13
+ * Create a new tool in the insights
14
+ */
15
+ export declare function insightsToolsCreate(client: SyllableSDKCore, request: components.InsightToolInput, options?: RequestOptions): Promise<Result<components.InsightToolOutput, errors.HTTPValidationError | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
16
+ //# sourceMappingURL=insightsToolsCreate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"insightsToolsCreate.d.ts","sourceRoot":"","sources":["../src/funcs/insightsToolsCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAK7C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,UAAU,CAAC,gBAAgB,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,iBAAiB,EAC1B,MAAM,CAAC,mBAAmB,GAC1B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAuFA"}
@@ -0,0 +1,102 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.insightsToolsCreate = insightsToolsCreate;
30
+ const encodings_js_1 = require("../lib/encodings.js");
31
+ const M = __importStar(require("../lib/matchers.js"));
32
+ const primitives_js_1 = require("../lib/primitives.js");
33
+ const schemas_js_1 = require("../lib/schemas.js");
34
+ const security_js_1 = require("../lib/security.js");
35
+ const url_js_1 = require("../lib/url.js");
36
+ const components = __importStar(require("../models/components/index.js"));
37
+ const errors = __importStar(require("../models/errors/index.js"));
38
+ /**
39
+ * Create Insight Tool
40
+ *
41
+ * @remarks
42
+ * Create a new tool in the insights
43
+ */
44
+ async function insightsToolsCreate(client, request, options) {
45
+ const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.InsightToolInput$outboundSchema.parse(value), "Input validation failed");
46
+ if (!parsed.ok) {
47
+ return parsed;
48
+ }
49
+ const payload = parsed.value;
50
+ const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true });
51
+ const path = (0, url_js_1.pathToFunc)("/api/v1/insights/tools")();
52
+ const headers = new Headers((0, primitives_js_1.compactMap)({
53
+ "Content-Type": "application/json",
54
+ Accept: "application/json",
55
+ }));
56
+ const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKeyHeader);
57
+ const securityInput = secConfig == null ? {} : { apiKeyHeader: secConfig };
58
+ const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
59
+ const context = {
60
+ baseURL: options?.serverURL ?? "",
61
+ operationID: "insights_tool_create",
62
+ oAuth2Scopes: [],
63
+ resolvedSecurity: requestSecurity,
64
+ securitySource: client._options.apiKeyHeader,
65
+ retryConfig: options?.retries
66
+ || client._options.retryConfig
67
+ || { strategy: "none" },
68
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
69
+ };
70
+ const requestRes = client._createRequest(context, {
71
+ security: requestSecurity,
72
+ method: "POST",
73
+ baseURL: options?.serverURL,
74
+ path: path,
75
+ headers: headers,
76
+ body: body,
77
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
78
+ }, options);
79
+ if (!requestRes.ok) {
80
+ return requestRes;
81
+ }
82
+ const req = requestRes.value;
83
+ const doResult = await client._do(req, {
84
+ context,
85
+ errorCodes: ["422", "4XX", "5XX"],
86
+ retryConfig: context.retryConfig,
87
+ retryCodes: context.retryCodes,
88
+ });
89
+ if (!doResult.ok) {
90
+ return doResult;
91
+ }
92
+ const response = doResult.value;
93
+ const responseFields = {
94
+ HttpMeta: { Response: response, Request: req },
95
+ };
96
+ const [result] = await M.match(M.json(200, components.InsightToolOutput$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, { extraFields: responseFields });
97
+ if (!result.ok) {
98
+ return result;
99
+ }
100
+ return result;
101
+ }
102
+ //# sourceMappingURL=insightsToolsCreate.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"insightsToolsCreate.js","sourceRoot":"","sources":["../src/funcs/insightsToolsCreate.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;AA6BH,kDAuGC;AAjID,sDAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAC3C,0EAA4D;AAQ5D,kEAAoD;AAKpD;;;;;GAKG;AACI,KAAK,UAAU,mBAAmB,CACvC,MAAuB,EACvB,OAAoC,EACpC,OAAwB;IAcxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,+BAA+B,CAAC,KAAK,CAAC,KAAK,CAAC,EAClE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,wBAAwB,CAAC,EAAE,CAAC;IAEpD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACtE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC;IAC3E,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,EAAE;QACjC,WAAW,EAAE,sBAAsB;QACnC,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,YAAY;QAC5C,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACjC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAW5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,+BAA+B,CAAC,EACvD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -0,0 +1,17 @@
1
+ import { SyllableSDKCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import * as components from "../models/components/index.js";
4
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
+ import * as errors from "../models/errors/index.js";
6
+ import { SDKError } from "../models/errors/sdkerror.js";
7
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
8
+ import * as operations from "../models/operations/index.js";
9
+ import { Result } from "../types/fp.js";
10
+ /**
11
+ * Get Insight Tool By Id
12
+ *
13
+ * @remarks
14
+ * Get a InsightTool by Name.
15
+ */
16
+ export declare function insightsToolsGetById(client: SyllableSDKCore, request: operations.InsightToolGetByIdRequest, options?: RequestOptions): Promise<Result<components.InsightToolOutput, errors.HTTPValidationError | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
17
+ //# sourceMappingURL=insightsToolsGetById.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"insightsToolsGetById.d.ts","sourceRoot":"","sources":["../src/funcs/insightsToolsGetById.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAK7C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,iBAAiB,EAC1B,MAAM,CAAC,mBAAmB,GAC1B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CA6FA"}