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

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 (192) 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/operations/directoryworkflowdelete.d.ts +29 -0
  95. package/models/operations/directoryworkflowdelete.d.ts.map +1 -0
  96. package/models/operations/directoryworkflowdelete.js +68 -0
  97. package/models/operations/directoryworkflowdelete.js.map +1 -0
  98. package/models/operations/index.d.ts +8 -0
  99. package/models/operations/index.d.ts.map +1 -1
  100. package/models/operations/index.js +8 -0
  101. package/models/operations/index.js.map +1 -1
  102. package/models/operations/insightstoolupdate.d.ts +32 -0
  103. package/models/operations/insightstoolupdate.d.ts.map +1 -0
  104. package/models/operations/insightstoolupdate.js +73 -0
  105. package/models/operations/insightstoolupdate.js.map +1 -0
  106. package/models/operations/insightsworkflowgetbyid.d.ts +29 -0
  107. package/models/operations/insightsworkflowgetbyid.d.ts.map +1 -0
  108. package/models/operations/insightsworkflowgetbyid.js +68 -0
  109. package/models/operations/insightsworkflowgetbyid.js.map +1 -0
  110. package/models/operations/insightsworkflowlist.d.ts +46 -0
  111. package/models/operations/insightsworkflowlist.d.ts.map +1 -0
  112. package/models/operations/insightsworkflowlist.js +101 -0
  113. package/models/operations/insightsworkflowlist.js.map +1 -0
  114. package/models/operations/insightsworkflowupdate.d.ts +32 -0
  115. package/models/operations/insightsworkflowupdate.d.ts.map +1 -0
  116. package/models/operations/insightsworkflowupdate.js +73 -0
  117. package/models/operations/insightsworkflowupdate.js.map +1 -0
  118. package/models/operations/insighttoolgetbyid.d.ts +29 -0
  119. package/models/operations/insighttoolgetbyid.d.ts.map +1 -0
  120. package/models/operations/insighttoolgetbyid.js +68 -0
  121. package/models/operations/insighttoolgetbyid.js.map +1 -0
  122. package/models/operations/insighttoollist.d.ts +46 -0
  123. package/models/operations/insighttoollist.d.ts.map +1 -0
  124. package/models/operations/insighttoollist.js +103 -0
  125. package/models/operations/insighttoollist.js.map +1 -0
  126. package/models/operations/sessionsummarygetbyid.d.ts +29 -0
  127. package/models/operations/sessionsummarygetbyid.d.ts.map +1 -0
  128. package/models/operations/sessionsummarygetbyid.js +68 -0
  129. package/models/operations/sessionsummarygetbyid.js.map +1 -0
  130. package/openapi.json +1255 -35
  131. package/package.json +1 -1
  132. package/sdk/insights.d.ts +10 -0
  133. package/sdk/insights.d.ts.map +1 -0
  134. package/sdk/insights.js +19 -0
  135. package/sdk/insights.js.map +1 -0
  136. package/sdk/sdk.d.ts +3 -0
  137. package/sdk/sdk.d.ts.map +1 -1
  138. package/sdk/sdk.js +4 -0
  139. package/sdk/sdk.js.map +1 -1
  140. package/sdk/sessions.d.ts +3 -0
  141. package/sdk/sessions.d.ts.map +1 -1
  142. package/sdk/sessions.js +4 -0
  143. package/sdk/sessions.js.map +1 -1
  144. package/sdk/summary.d.ts +9 -0
  145. package/sdk/summary.d.ts.map +1 -0
  146. package/sdk/summary.js +19 -0
  147. package/sdk/summary.js.map +1 -0
  148. package/sdk/syllablesdktools.d.ts +41 -0
  149. package/sdk/syllablesdktools.d.ts.map +1 -0
  150. package/sdk/syllablesdktools.js +62 -0
  151. package/sdk/syllablesdktools.js.map +1 -0
  152. package/sdk/workflows.d.ts +41 -0
  153. package/sdk/workflows.d.ts.map +1 -0
  154. package/sdk/workflows.js +62 -0
  155. package/sdk/workflows.js.map +1 -0
  156. package/src/funcs/insightsToolsCreate.ts +135 -0
  157. package/src/funcs/insightsToolsGetById.ts +142 -0
  158. package/src/funcs/insightsToolsInsightToolGetDefinitions.ts +112 -0
  159. package/src/funcs/insightsToolsList.ts +148 -0
  160. package/src/funcs/insightsToolsUpdate.ts +143 -0
  161. package/src/funcs/insightsWorkflowsCreate.ts +135 -0
  162. package/src/funcs/insightsWorkflowsDelete.ts +145 -0
  163. package/src/funcs/insightsWorkflowsGetById.ts +145 -0
  164. package/src/funcs/insightsWorkflowsList.ts +149 -0
  165. package/src/funcs/insightsWorkflowsUpdate.ts +148 -0
  166. package/src/funcs/sessionsSummaryGetById.ts +140 -0
  167. package/src/lib/config.ts +2 -2
  168. package/src/models/components/index.ts +9 -0
  169. package/src/models/components/insighttooldefinition.ts +213 -0
  170. package/src/models/components/insighttoolinput.ts +163 -0
  171. package/src/models/components/insighttooloutput.ts +210 -0
  172. package/src/models/components/insighttoolproperties.ts +37 -0
  173. package/src/models/components/insightworkflowinput.ts +161 -0
  174. package/src/models/components/insightworkflowoutput.ts +206 -0
  175. package/src/models/components/insightworkflowproperties.ts +40 -0
  176. package/src/models/components/listresponseinsighttooloutput.ts +103 -0
  177. package/src/models/components/listresponseinsightworkflowoutput.ts +104 -0
  178. package/src/models/operations/directoryworkflowdelete.ts +77 -0
  179. package/src/models/operations/index.ts +8 -0
  180. package/src/models/operations/insightstoolupdate.ts +82 -0
  181. package/src/models/operations/insightsworkflowgetbyid.ts +77 -0
  182. package/src/models/operations/insightsworkflowlist.ts +130 -0
  183. package/src/models/operations/insightsworkflowupdate.ts +84 -0
  184. package/src/models/operations/insighttoolgetbyid.ts +75 -0
  185. package/src/models/operations/insighttoollist.ts +126 -0
  186. package/src/models/operations/sessionsummarygetbyid.ts +77 -0
  187. package/src/sdk/insights.ts +19 -0
  188. package/src/sdk/sdk.ts +6 -0
  189. package/src/sdk/sessions.ts +6 -0
  190. package/src/sdk/summary.ts +24 -0
  191. package/src/sdk/syllablesdktools.ts +98 -0
  192. package/src/sdk/workflows.ts +100 -0
package/README.md CHANGED
@@ -184,6 +184,25 @@ run();
184
184
 
185
185
  * [list](docs/sdks/events/README.md#list) - Events List
186
186
 
187
+ ### [insights](docs/sdks/insights/README.md)
188
+
189
+
190
+ #### [insights.tools](docs/sdks/syllablesdktools/README.md)
191
+
192
+ * [list](docs/sdks/syllablesdktools/README.md#list) - Insight Tool List
193
+ * [create](docs/sdks/syllablesdktools/README.md#create) - Create Insight Tool
194
+ * [getById](docs/sdks/syllablesdktools/README.md#getbyid) - Get Insight Tool By Id
195
+ * [update](docs/sdks/syllablesdktools/README.md#update) - Update Insights Tool
196
+ * [insightToolGetDefinitions](docs/sdks/syllablesdktools/README.md#insighttoolgetdefinitions) - Get Insight Tool Definitions
197
+
198
+ #### [insights.workflows](docs/sdks/workflows/README.md)
199
+
200
+ * [list](docs/sdks/workflows/README.md#list) - Insight Workflow List
201
+ * [create](docs/sdks/workflows/README.md#create) - Create Insight Workflow
202
+ * [getById](docs/sdks/workflows/README.md#getbyid) - Get Insight Workflow By Id
203
+ * [update](docs/sdks/workflows/README.md#update) - Update Insights Workflow
204
+ * [delete](docs/sdks/workflows/README.md#delete) - Delete Insights Workflow
205
+
187
206
  ### [prompts](docs/sdks/prompts/README.md)
188
207
 
189
208
  * [list](docs/sdks/prompts/README.md#list) - Prompt List
@@ -214,6 +233,10 @@ run();
214
233
  * [generateSessionRecordingUrls](docs/sdks/sessions/README.md#generatesessionrecordingurls) - Generate Recording Urls
215
234
  * [sessionRecordingStream](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
216
235
 
236
+ #### [sessions.summary](docs/sdks/summary/README.md)
237
+
238
+ * [getById](docs/sdks/summary/README.md#getbyid) - Get Session Summary By Id
239
+
217
240
  #### [sessions.transcript](docs/sdks/transcript/README.md)
218
241
 
219
242
  * [getById](docs/sdks/transcript/README.md#getbyid) - Get Session Transcript By Id
@@ -284,6 +307,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
284
307
  - [`dataSourcesList`](docs/sdks/datasources/README.md#list) - List Data Sources
285
308
  - [`dataSourcesUpdate`](docs/sdks/datasources/README.md#update) - Update Data Source
286
309
  - [`eventsList`](docs/sdks/events/README.md#list) - Events List
310
+ - [`insightsToolsCreate`](docs/sdks/syllablesdktools/README.md#create) - Create Insight Tool
311
+ - [`insightsToolsGetById`](docs/sdks/syllablesdktools/README.md#getbyid) - Get Insight Tool By Id
312
+ - [`insightsToolsInsightToolGetDefinitions`](docs/sdks/syllablesdktools/README.md#insighttoolgetdefinitions) - Get Insight Tool Definitions
313
+ - [`insightsToolsList`](docs/sdks/syllablesdktools/README.md#list) - Insight Tool List
314
+ - [`insightsToolsUpdate`](docs/sdks/syllablesdktools/README.md#update) - Update Insights Tool
315
+ - [`insightsWorkflowsCreate`](docs/sdks/workflows/README.md#create) - Create Insight Workflow
316
+ - [`insightsWorkflowsDelete`](docs/sdks/workflows/README.md#delete) - Delete Insights Workflow
317
+ - [`insightsWorkflowsGetById`](docs/sdks/workflows/README.md#getbyid) - Get Insight Workflow By Id
318
+ - [`insightsWorkflowsList`](docs/sdks/workflows/README.md#list) - Insight Workflow List
319
+ - [`insightsWorkflowsUpdate`](docs/sdks/workflows/README.md#update) - Update Insights Workflow
287
320
  - [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create Prompt
288
321
  - [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete Prompt
289
322
  - [`promptsGetById`](docs/sdks/prompts/README.md#getbyid) - Get Prompt By Id
@@ -302,6 +335,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
302
335
  - [`sessionsGetById`](docs/sdks/sessions/README.md#getbyid) - Get A Single Session By Id
303
336
  - [`sessionsList`](docs/sdks/sessions/README.md#list) - Sessions List
304
337
  - [`sessionsSessionRecordingStream`](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
338
+ - [`sessionsSummaryGetById`](docs/sdks/summary/README.md#getbyid) - Get Session Summary By Id
305
339
  - [`sessionsTranscriptGetById`](docs/sdks/transcript/README.md#getbyid) - Get Session Transcript By Id
306
340
  - [`toolsCreate`](docs/sdks/tools/README.md#create) - Create Tool
307
341
  - [`toolsDelete`](docs/sdks/tools/README.md#delete) - Delete Tool
@@ -0,0 +1,6 @@
1
+ # Insights
2
+ (*insights*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
@@ -0,0 +1,85 @@
1
+ # Summary
2
+ (*sessions.summary*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [getById](#getbyid) - Get Session Summary By Id
9
+
10
+ ## getById
11
+
12
+ Get Session Summary By Id
13
+
14
+ ### Example Usage
15
+
16
+ ```typescript
17
+ import { SyllableSDK } from "syllable-sdk";
18
+
19
+ const syllableSDK = new SyllableSDK({
20
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
21
+ });
22
+
23
+ async function run() {
24
+ const result = await syllableSDK.sessions.summary.getById({
25
+ sessionId: "<id>",
26
+ });
27
+
28
+ // Handle the result
29
+ console.log(result);
30
+ }
31
+
32
+ run();
33
+ ```
34
+
35
+ ### Standalone function
36
+
37
+ The standalone function version of this method:
38
+
39
+ ```typescript
40
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
41
+ import { sessionsSummaryGetById } from "syllable-sdk/funcs/sessionsSummaryGetById.js";
42
+
43
+ // Use `SyllableSDKCore` for best tree-shaking performance.
44
+ // You can create one instance of it to use across an application.
45
+ const syllableSDK = new SyllableSDKCore({
46
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
47
+ });
48
+
49
+ async function run() {
50
+ const res = await sessionsSummaryGetById(syllableSDK, {
51
+ sessionId: "<id>",
52
+ });
53
+
54
+ if (!res.ok) {
55
+ throw res.error;
56
+ }
57
+
58
+ const { value: result } = res;
59
+
60
+ // Handle the result
61
+ console.log(result);
62
+ }
63
+
64
+ run();
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ | Parameter | Type | Required | Description |
70
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
71
+ | `request` | [operations.SessionSummaryGetByIdRequest](../../models/operations/sessionsummarygetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
72
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
73
+ | `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. |
74
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
75
+
76
+ ### Response
77
+
78
+ **Promise\<[string](../../models/.md)\>**
79
+
80
+ ### Errors
81
+
82
+ | Error Type | Status Code | Content Type |
83
+ | -------------------------- | -------------------------- | -------------------------- |
84
+ | errors.HTTPValidationError | 422 | application/json |
85
+ | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -0,0 +1,411 @@
1
+ # SyllableSDKTools
2
+ (*insights.tools*)
3
+
4
+ ## Overview
5
+
6
+ Operations related to insights tools. An insight is a tool that processes conversation data to extract information and generate reports.
7
+
8
+ ### Available Operations
9
+
10
+ * [list](#list) - Insight Tool List
11
+ * [create](#create) - Create Insight Tool
12
+ * [getById](#getbyid) - Get Insight Tool By Id
13
+ * [update](#update) - Update Insights Tool
14
+ * [insightToolGetDefinitions](#insighttoolgetdefinitions) - Get Insight Tool Definitions
15
+
16
+ ## list
17
+
18
+ List the existing insight_tools
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.tools.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 { insightsToolsList } from "syllable-sdk/funcs/insightsToolsList.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 insightsToolsList(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.InsightToolListRequest](../../models/operations/insighttoollistrequest.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.ListResponseInsightToolOutput](../../models/components/listresponseinsighttooloutput.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.tools.create({
104
+ name: "<value>",
105
+ description: "yuck vice between gee ugh ha",
106
+ version: 920994,
107
+ toolArguments: {},
108
+ insightToolDefinitionId: 780486,
109
+ });
110
+
111
+ // Handle the result
112
+ console.log(result);
113
+ }
114
+
115
+ run();
116
+ ```
117
+
118
+ ### Standalone function
119
+
120
+ The standalone function version of this method:
121
+
122
+ ```typescript
123
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
124
+ import { insightsToolsCreate } from "syllable-sdk/funcs/insightsToolsCreate.js";
125
+
126
+ // Use `SyllableSDKCore` for best tree-shaking performance.
127
+ // You can create one instance of it to use across an application.
128
+ const syllableSDK = new SyllableSDKCore({
129
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
130
+ });
131
+
132
+ async function run() {
133
+ const res = await insightsToolsCreate(syllableSDK, {
134
+ name: "<value>",
135
+ description: "yuck vice between gee ugh ha",
136
+ version: 920994,
137
+ toolArguments: {},
138
+ insightToolDefinitionId: 780486,
139
+ });
140
+
141
+ if (!res.ok) {
142
+ throw res.error;
143
+ }
144
+
145
+ const { value: result } = res;
146
+
147
+ // Handle the result
148
+ console.log(result);
149
+ }
150
+
151
+ run();
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ | Parameter | Type | Required | Description |
157
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
158
+ | `request` | [components.InsightToolInput](../../models/components/insighttoolinput.md) | :heavy_check_mark: | The request object to use for the request. |
159
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
160
+ | `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. |
161
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
162
+
163
+ ### Response
164
+
165
+ **Promise\<[components.InsightToolOutput](../../models/components/insighttooloutput.md)\>**
166
+
167
+ ### Errors
168
+
169
+ | Error Type | Status Code | Content Type |
170
+ | -------------------------- | -------------------------- | -------------------------- |
171
+ | errors.HTTPValidationError | 422 | application/json |
172
+ | errors.SDKError | 4XX, 5XX | \*/\* |
173
+
174
+ ## getById
175
+
176
+ Get a InsightTool by Name.
177
+
178
+ ### Example Usage
179
+
180
+ ```typescript
181
+ import { SyllableSDK } from "syllable-sdk";
182
+
183
+ const syllableSDK = new SyllableSDK({
184
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
185
+ });
186
+
187
+ async function run() {
188
+ const result = await syllableSDK.insights.tools.getById({
189
+ toolId: "<id>",
190
+ });
191
+
192
+ // Handle the result
193
+ console.log(result);
194
+ }
195
+
196
+ run();
197
+ ```
198
+
199
+ ### Standalone function
200
+
201
+ The standalone function version of this method:
202
+
203
+ ```typescript
204
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
205
+ import { insightsToolsGetById } from "syllable-sdk/funcs/insightsToolsGetById.js";
206
+
207
+ // Use `SyllableSDKCore` for best tree-shaking performance.
208
+ // You can create one instance of it to use across an application.
209
+ const syllableSDK = new SyllableSDKCore({
210
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
211
+ });
212
+
213
+ async function run() {
214
+ const res = await insightsToolsGetById(syllableSDK, {
215
+ toolId: "<id>",
216
+ });
217
+
218
+ if (!res.ok) {
219
+ throw res.error;
220
+ }
221
+
222
+ const { value: result } = res;
223
+
224
+ // Handle the result
225
+ console.log(result);
226
+ }
227
+
228
+ run();
229
+ ```
230
+
231
+ ### Parameters
232
+
233
+ | Parameter | Type | Required | Description |
234
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
235
+ | `request` | [operations.InsightToolGetByIdRequest](../../models/operations/insighttoolgetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
236
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
237
+ | `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. |
238
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
239
+
240
+ ### Response
241
+
242
+ **Promise\<[components.InsightToolOutput](../../models/components/insighttooloutput.md)\>**
243
+
244
+ ### Errors
245
+
246
+ | Error Type | Status Code | Content Type |
247
+ | -------------------------- | -------------------------- | -------------------------- |
248
+ | errors.HTTPValidationError | 422 | application/json |
249
+ | errors.SDKError | 4XX, 5XX | \*/\* |
250
+
251
+ ## update
252
+
253
+ Update a InsightTool.
254
+
255
+ ### Example Usage
256
+
257
+ ```typescript
258
+ import { SyllableSDK } from "syllable-sdk";
259
+
260
+ const syllableSDK = new SyllableSDK({
261
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
262
+ });
263
+
264
+ async function run() {
265
+ const result = await syllableSDK.insights.tools.update({
266
+ toolId: 198183,
267
+ insightToolInput: {
268
+ name: "<value>",
269
+ description: "awful underneath retention too mobility char innocently dowse restfully",
270
+ version: 243447,
271
+ toolArguments: {},
272
+ insightToolDefinitionId: 265006,
273
+ },
274
+ });
275
+
276
+ // Handle the result
277
+ console.log(result);
278
+ }
279
+
280
+ run();
281
+ ```
282
+
283
+ ### Standalone function
284
+
285
+ The standalone function version of this method:
286
+
287
+ ```typescript
288
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
289
+ import { insightsToolsUpdate } from "syllable-sdk/funcs/insightsToolsUpdate.js";
290
+
291
+ // Use `SyllableSDKCore` for best tree-shaking performance.
292
+ // You can create one instance of it to use across an application.
293
+ const syllableSDK = new SyllableSDKCore({
294
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
295
+ });
296
+
297
+ async function run() {
298
+ const res = await insightsToolsUpdate(syllableSDK, {
299
+ toolId: 198183,
300
+ insightToolInput: {
301
+ name: "<value>",
302
+ description: "awful underneath retention too mobility char innocently dowse restfully",
303
+ version: 243447,
304
+ toolArguments: {},
305
+ insightToolDefinitionId: 265006,
306
+ },
307
+ });
308
+
309
+ if (!res.ok) {
310
+ throw res.error;
311
+ }
312
+
313
+ const { value: result } = res;
314
+
315
+ // Handle the result
316
+ console.log(result);
317
+ }
318
+
319
+ run();
320
+ ```
321
+
322
+ ### Parameters
323
+
324
+ | Parameter | Type | Required | Description |
325
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
326
+ | `request` | [operations.InsightsToolUpdateRequest](../../models/operations/insightstoolupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
327
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
328
+ | `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. |
329
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
330
+
331
+ ### Response
332
+
333
+ **Promise\<[components.InsightToolOutput](../../models/components/insighttooloutput.md)\>**
334
+
335
+ ### Errors
336
+
337
+ | Error Type | Status Code | Content Type |
338
+ | -------------------------- | -------------------------- | -------------------------- |
339
+ | errors.HTTPValidationError | 422 | application/json |
340
+ | errors.SDKError | 4XX, 5XX | \*/\* |
341
+
342
+ ## insightToolGetDefinitions
343
+
344
+ Get a InsightTool by Name.
345
+
346
+ ### Example Usage
347
+
348
+ ```typescript
349
+ import { SyllableSDK } from "syllable-sdk";
350
+
351
+ const syllableSDK = new SyllableSDK({
352
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
353
+ });
354
+
355
+ async function run() {
356
+ const result = await syllableSDK.insights.tools.insightToolGetDefinitions();
357
+
358
+ // Handle the result
359
+ console.log(result);
360
+ }
361
+
362
+ run();
363
+ ```
364
+
365
+ ### Standalone function
366
+
367
+ The standalone function version of this method:
368
+
369
+ ```typescript
370
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
371
+ import { insightsToolsInsightToolGetDefinitions } from "syllable-sdk/funcs/insightsToolsInsightToolGetDefinitions.js";
372
+
373
+ // Use `SyllableSDKCore` for best tree-shaking performance.
374
+ // You can create one instance of it to use across an application.
375
+ const syllableSDK = new SyllableSDKCore({
376
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
377
+ });
378
+
379
+ async function run() {
380
+ const res = await insightsToolsInsightToolGetDefinitions(syllableSDK);
381
+
382
+ if (!res.ok) {
383
+ throw res.error;
384
+ }
385
+
386
+ const { value: result } = res;
387
+
388
+ // Handle the result
389
+ console.log(result);
390
+ }
391
+
392
+ run();
393
+ ```
394
+
395
+ ### Parameters
396
+
397
+ | Parameter | Type | Required | Description |
398
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
399
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
400
+ | `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. |
401
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
402
+
403
+ ### Response
404
+
405
+ **Promise\<[components.InsightToolDefinition[]](../../models/.md)\>**
406
+
407
+ ### Errors
408
+
409
+ | Error Type | Status Code | Content Type |
410
+ | --------------- | --------------- | --------------- |
411
+ | errors.SDKError | 4XX, 5XX | \*/\* |