syllable-sdk 0.1.0-alpha.37 → 0.1.0-alpha.38

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 (209) hide show
  1. package/README.md +8 -12
  2. package/docs/sdks/datasources/README.md +10 -10
  3. package/docs/sdks/services/README.md +166 -8
  4. package/docs/sdks/tools/README.md +80 -0
  5. package/docs/sdks/v1/README.md +0 -408
  6. package/funcs/{v1DataSourcesDeleteByName.d.ts → dataSourcesDelete.d.ts} +2 -2
  7. package/funcs/dataSourcesDelete.d.ts.map +1 -0
  8. package/funcs/{v1DataSourcesDeleteByName.js → dataSourcesDelete.js} +7 -10
  9. package/funcs/dataSourcesDelete.js.map +1 -0
  10. package/funcs/dataSourcesGetByName.d.ts.map +1 -1
  11. package/funcs/dataSourcesGetByName.js +2 -5
  12. package/funcs/dataSourcesGetByName.js.map +1 -1
  13. package/funcs/servicesCreate.d.ts +4 -1
  14. package/funcs/servicesCreate.d.ts.map +1 -1
  15. package/funcs/servicesCreate.js +5 -2
  16. package/funcs/servicesCreate.js.map +1 -1
  17. package/funcs/{dataSourcesDataSourcesDeleteByName.d.ts → servicesDelete.d.ts} +4 -4
  18. package/funcs/servicesDelete.d.ts.map +1 -0
  19. package/funcs/{dataSourcesDataSourcesDeleteByName.js → servicesDelete.js} +9 -9
  20. package/funcs/servicesDelete.js.map +1 -0
  21. package/funcs/{v1GetByName.d.ts → servicesGetById.d.ts} +4 -4
  22. package/funcs/servicesGetById.d.ts.map +1 -0
  23. package/funcs/{v1GetByName.js → servicesGetById.js} +10 -10
  24. package/funcs/servicesGetById.js.map +1 -0
  25. package/funcs/servicesList.d.ts +2 -2
  26. package/funcs/servicesList.d.ts.map +1 -1
  27. package/funcs/servicesList.js +2 -2
  28. package/funcs/servicesList.js.map +1 -1
  29. package/funcs/servicesUpdate.d.ts +4 -1
  30. package/funcs/servicesUpdate.d.ts.map +1 -1
  31. package/funcs/servicesUpdate.js +5 -2
  32. package/funcs/servicesUpdate.js.map +1 -1
  33. package/funcs/{v1List.d.ts → toolsDelete.d.ts} +4 -5
  34. package/funcs/toolsDelete.d.ts.map +1 -0
  35. package/funcs/{v1Create.js → toolsDelete.js} +23 -13
  36. package/funcs/toolsDelete.js.map +1 -0
  37. package/jsr.json +1 -1
  38. package/lib/config.d.ts +2 -2
  39. package/lib/config.js +2 -2
  40. package/mintlify/mint.json +10 -0
  41. package/models/components/agentcreate.d.ts +5 -0
  42. package/models/components/agentcreate.d.ts.map +1 -1
  43. package/models/components/agentcreate.js +4 -0
  44. package/models/components/agentcreate.js.map +1 -1
  45. package/models/components/agentresponse.d.ts +5 -0
  46. package/models/components/agentresponse.d.ts.map +1 -1
  47. package/models/components/agentresponse.js +4 -0
  48. package/models/components/agentresponse.js.map +1 -1
  49. package/models/components/agentupdate.d.ts +5 -0
  50. package/models/components/agentupdate.d.ts.map +1 -1
  51. package/models/components/agentupdate.js +4 -0
  52. package/models/components/agentupdate.js.map +1 -1
  53. package/models/components/index.d.ts +4 -4
  54. package/models/components/index.d.ts.map +1 -1
  55. package/models/components/index.js +4 -4
  56. package/models/components/index.js.map +1 -1
  57. package/models/components/listresponseserviceresponse.d.ts +38 -0
  58. package/models/components/listresponseserviceresponse.d.ts.map +1 -0
  59. package/models/components/{listresponseservice.js → listresponseserviceresponse.js} +20 -20
  60. package/models/components/listresponseserviceresponse.js.map +1 -0
  61. package/models/components/servicecreaterequest.d.ts +37 -0
  62. package/models/components/servicecreaterequest.d.ts.map +1 -0
  63. package/models/components/{serviceupdate.js → servicecreaterequest.js} +17 -19
  64. package/models/components/servicecreaterequest.js.map +1 -0
  65. package/models/components/serviceproperties.d.ts +9 -0
  66. package/models/components/serviceproperties.d.ts.map +1 -1
  67. package/models/components/serviceproperties.js +3 -0
  68. package/models/components/serviceproperties.js.map +1 -1
  69. package/models/components/serviceresponse.d.ts +65 -0
  70. package/models/components/serviceresponse.d.ts.map +1 -0
  71. package/models/components/serviceresponse.js +84 -0
  72. package/models/components/serviceresponse.js.map +1 -0
  73. package/models/components/serviceupdaterequest.d.ts +47 -0
  74. package/models/components/serviceupdaterequest.d.ts.map +1 -0
  75. package/models/components/{service.js → serviceupdaterequest.js} +28 -19
  76. package/models/components/serviceupdaterequest.js.map +1 -0
  77. package/models/components/tooldetailresponse.d.ts +49 -4
  78. package/models/components/tooldetailresponse.d.ts.map +1 -1
  79. package/models/components/tooldetailresponse.js +32 -4
  80. package/models/components/tooldetailresponse.js.map +1 -1
  81. package/models/components/toolproperties.d.ts +6 -0
  82. package/models/components/toolproperties.d.ts.map +1 -1
  83. package/models/components/toolproperties.js +2 -0
  84. package/models/components/toolproperties.js.map +1 -1
  85. package/models/components/toolresponse.d.ts +15 -0
  86. package/models/components/toolresponse.d.ts.map +1 -1
  87. package/models/components/toolresponse.js +12 -0
  88. package/models/components/toolresponse.js.map +1 -1
  89. package/models/components/toolupdaterequest.d.ts +5 -0
  90. package/models/components/toolupdaterequest.d.ts.map +1 -1
  91. package/models/components/toolupdaterequest.js +4 -0
  92. package/models/components/toolupdaterequest.js.map +1 -1
  93. package/models/operations/datasourcesdelete.d.ts +31 -0
  94. package/models/operations/datasourcesdelete.d.ts.map +1 -0
  95. package/models/operations/datasourcesdelete.js +70 -0
  96. package/models/operations/datasourcesdelete.js.map +1 -0
  97. package/models/operations/datasourcesgetbyname.d.ts +2 -2
  98. package/models/operations/datasourcesgetbyname.d.ts.map +1 -1
  99. package/models/operations/datasourcesgetbyname.js +11 -2
  100. package/models/operations/datasourcesgetbyname.js.map +1 -1
  101. package/models/operations/index.d.ts +4 -1
  102. package/models/operations/index.d.ts.map +1 -1
  103. package/models/operations/index.js +4 -1
  104. package/models/operations/index.js.map +1 -1
  105. package/models/operations/servicedelete.d.ts +31 -0
  106. package/models/operations/servicedelete.d.ts.map +1 -0
  107. package/models/operations/servicedelete.js +70 -0
  108. package/models/operations/servicedelete.js.map +1 -0
  109. package/models/operations/servicesgetbyid.d.ts +29 -0
  110. package/models/operations/servicesgetbyid.d.ts.map +1 -0
  111. package/models/operations/servicesgetbyid.js +68 -0
  112. package/models/operations/servicesgetbyid.js.map +1 -0
  113. package/models/operations/tooldelete.d.ts +31 -0
  114. package/models/operations/tooldelete.d.ts.map +1 -0
  115. package/models/operations/{datasourcesdeletebyname.js → tooldelete.js} +28 -19
  116. package/models/operations/tooldelete.js.map +1 -0
  117. package/openapi.json +359 -56
  118. package/package.json +1 -1
  119. package/sdk/datasources.d.ts +1 -1
  120. package/sdk/datasources.d.ts.map +1 -1
  121. package/sdk/datasources.js +3 -3
  122. package/sdk/datasources.js.map +1 -1
  123. package/sdk/sdk.d.ts +2 -2
  124. package/sdk/sdk.d.ts.map +1 -1
  125. package/sdk/sdk.js +3 -3
  126. package/sdk/sdk.js.map +1 -1
  127. package/sdk/services.d.ts +24 -4
  128. package/sdk/services.d.ts.map +1 -1
  129. package/sdk/services.js +27 -1
  130. package/sdk/services.js.map +1 -1
  131. package/sdk/tools.d.ts +7 -0
  132. package/sdk/tools.d.ts.map +1 -1
  133. package/sdk/tools.js +10 -0
  134. package/sdk/tools.js.map +1 -1
  135. package/sdk/v1.d.ts +0 -36
  136. package/sdk/v1.d.ts.map +1 -1
  137. package/sdk/v1.js +0 -50
  138. package/sdk/v1.js.map +1 -1
  139. package/src/funcs/{v1Create.ts → dataSourcesDelete.ts} +30 -15
  140. package/src/funcs/dataSourcesGetByName.ts +8 -5
  141. package/src/funcs/servicesCreate.ts +8 -5
  142. package/src/funcs/{dataSourcesDataSourcesDeleteByName.ts → servicesDelete.ts} +8 -9
  143. package/src/funcs/{v1GetByName.ts → servicesGetById.ts} +11 -12
  144. package/src/funcs/servicesList.ts +4 -4
  145. package/src/funcs/servicesUpdate.ts +8 -5
  146. package/src/funcs/{v1DataSourcesDeleteByName.ts → toolsDelete.ts} +8 -9
  147. package/src/lib/config.ts +2 -2
  148. package/src/models/components/agentcreate.ts +9 -0
  149. package/src/models/components/agentresponse.ts +9 -0
  150. package/src/models/components/agentupdate.ts +9 -0
  151. package/src/models/components/index.ts +4 -4
  152. package/src/models/components/{listresponseservice.ts → listresponseserviceresponse.ts} +32 -30
  153. package/src/models/components/servicecreaterequest.ts +76 -0
  154. package/src/models/components/serviceproperties.ts +3 -0
  155. package/src/models/components/serviceresponse.ts +127 -0
  156. package/src/models/components/serviceupdaterequest.ts +99 -0
  157. package/src/models/components/tooldetailresponse.ts +87 -8
  158. package/src/models/components/toolproperties.ts +2 -0
  159. package/src/models/components/toolresponse.ts +29 -0
  160. package/src/models/components/toolupdaterequest.ts +9 -0
  161. package/src/models/operations/datasourcesdelete.ts +79 -0
  162. package/src/models/operations/datasourcesgetbyname.ts +13 -4
  163. package/src/models/operations/index.ts +4 -1
  164. package/src/models/operations/servicedelete.ts +79 -0
  165. package/src/models/operations/servicesgetbyid.ts +75 -0
  166. package/src/models/operations/tooldelete.ts +79 -0
  167. package/src/sdk/datasources.ts +4 -4
  168. package/src/sdk/sdk.ts +5 -5
  169. package/src/sdk/services.ts +48 -6
  170. package/src/sdk/tools.ts +18 -0
  171. package/src/sdk/v1.ts +0 -91
  172. package/funcs/dataSourcesDataSourcesDeleteByName.d.ts.map +0 -1
  173. package/funcs/dataSourcesDataSourcesDeleteByName.js.map +0 -1
  174. package/funcs/v1Create.d.ts +0 -16
  175. package/funcs/v1Create.d.ts.map +0 -1
  176. package/funcs/v1Create.js.map +0 -1
  177. package/funcs/v1DataSourcesDeleteByName.d.ts.map +0 -1
  178. package/funcs/v1DataSourcesDeleteByName.js.map +0 -1
  179. package/funcs/v1GetByName.d.ts.map +0 -1
  180. package/funcs/v1GetByName.js.map +0 -1
  181. package/funcs/v1List.d.ts.map +0 -1
  182. package/funcs/v1List.js +0 -113
  183. package/funcs/v1List.js.map +0 -1
  184. package/funcs/v1Update.d.ts +0 -16
  185. package/funcs/v1Update.d.ts.map +0 -1
  186. package/funcs/v1Update.js +0 -101
  187. package/funcs/v1Update.js.map +0 -1
  188. package/models/components/listresponseservice.d.ts +0 -38
  189. package/models/components/listresponseservice.d.ts.map +0 -1
  190. package/models/components/listresponseservice.js.map +0 -1
  191. package/models/components/service.d.ts +0 -50
  192. package/models/components/service.d.ts.map +0 -1
  193. package/models/components/service.js.map +0 -1
  194. package/models/components/servicecreate.d.ts +0 -37
  195. package/models/components/servicecreate.d.ts.map +0 -1
  196. package/models/components/servicecreate.js +0 -61
  197. package/models/components/servicecreate.js.map +0 -1
  198. package/models/components/serviceupdate.d.ts +0 -42
  199. package/models/components/serviceupdate.d.ts.map +0 -1
  200. package/models/components/serviceupdate.js.map +0 -1
  201. package/models/operations/datasourcesdeletebyname.d.ts +0 -31
  202. package/models/operations/datasourcesdeletebyname.d.ts.map +0 -1
  203. package/models/operations/datasourcesdeletebyname.js.map +0 -1
  204. package/src/funcs/v1List.ts +0 -150
  205. package/src/funcs/v1Update.ts +0 -134
  206. package/src/models/components/service.ts +0 -86
  207. package/src/models/components/servicecreate.ts +0 -72
  208. package/src/models/components/serviceupdate.ts +0 -79
  209. package/src/models/operations/datasourcesdeletebyname.ts +0 -72
package/README.md CHANGED
@@ -176,7 +176,7 @@ run();
176
176
  * [create](docs/sdks/datasources/README.md#create) - Create Data Source
177
177
  * [update](docs/sdks/datasources/README.md#update) - Update Data Source
178
178
  * [getByName](docs/sdks/datasources/README.md#getbyname) - Get Data Source
179
- * [dataSourcesDeleteByName](docs/sdks/datasources/README.md#datasourcesdeletebyname) - Delete Data Source
179
+ * [delete](docs/sdks/datasources/README.md#delete) - Delete Data Source
180
180
 
181
181
  ### [events](docs/sdks/events/README.md)
182
182
 
@@ -196,6 +196,8 @@ run();
196
196
  * [list](docs/sdks/services/README.md#list) - Service List
197
197
  * [create](docs/sdks/services/README.md#create) - Create Service
198
198
  * [update](docs/sdks/services/README.md#update) - Update Service
199
+ * [getById](docs/sdks/services/README.md#getbyid) - Get Service By Id
200
+ * [delete](docs/sdks/services/README.md#delete) - Delete Service
199
201
 
200
202
  ### [sessionLabels](docs/sdks/sessionlabels/README.md)
201
203
 
@@ -221,14 +223,10 @@ run();
221
223
  * [create](docs/sdks/tools/README.md#create) - Create Tool
222
224
  * [update](docs/sdks/tools/README.md#update) - Update Tool
223
225
  * [getByName](docs/sdks/tools/README.md#getbyname) - Tool Info
226
+ * [delete](docs/sdks/tools/README.md#delete) - Delete Tool
224
227
 
225
228
  ### [v1](docs/sdks/v1/README.md)
226
229
 
227
- * [list](docs/sdks/v1/README.md#list) - List Data Sources
228
- * [create](docs/sdks/v1/README.md#create) - Create Data Source
229
- * [update](docs/sdks/v1/README.md#update) - Update Data Source
230
- * [getByName](docs/sdks/v1/README.md#getbyname) - Get Data Source
231
- * [dataSourcesDeleteByName](docs/sdks/v1/README.md#datasourcesdeletebyname) - Delete Data Source
232
230
  * [postSessionEventsDashboard](docs/sdks/v1/README.md#postsessioneventsdashboard) - Post Session Events
233
231
  * [postSessionSummaryDashboard](docs/sdks/v1/README.md#postsessionsummarydashboard) - Post Session Summary
234
232
  * [postSessionTransfersDashboard](docs/sdks/v1/README.md#postsessiontransfersdashboard) - Post Session Transfers
@@ -277,7 +275,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
277
275
  - [`dashboardsPostSessionSummaryDashboard`](docs/sdks/dashboards/README.md#postsessionsummarydashboard) - Post Session Summary
278
276
  - [`dashboardsPostSessionTransfersDashboard`](docs/sdks/dashboards/README.md#postsessiontransfersdashboard) - Post Session Transfers
279
277
  - [`dataSourcesCreate`](docs/sdks/datasources/README.md#create) - Create Data Source
280
- - [`dataSourcesDataSourcesDeleteByName`](docs/sdks/datasources/README.md#datasourcesdeletebyname) - Delete Data Source
278
+ - [`dataSourcesDelete`](docs/sdks/datasources/README.md#delete) - Delete Data Source
281
279
  - [`dataSourcesGetByName`](docs/sdks/datasources/README.md#getbyname) - Get Data Source
282
280
  - [`dataSourcesList`](docs/sdks/datasources/README.md#list) - List Data Sources
283
281
  - [`dataSourcesUpdate`](docs/sdks/datasources/README.md#update) - Update Data Source
@@ -289,6 +287,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
289
287
  - [`promptsPromptsHistory`](docs/sdks/prompts/README.md#promptshistory) - Get Prompt History
290
288
  - [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update Prompt
291
289
  - [`servicesCreate`](docs/sdks/services/README.md#create) - Create Service
290
+ - [`servicesDelete`](docs/sdks/services/README.md#delete) - Delete Service
291
+ - [`servicesGetById`](docs/sdks/services/README.md#getbyid) - Get Service By Id
292
292
  - [`servicesList`](docs/sdks/services/README.md#list) - Service List
293
293
  - [`servicesUpdate`](docs/sdks/services/README.md#update) - Update Service
294
294
  - [`sessionLabelsCreate`](docs/sdks/sessionlabels/README.md#create) - Create Label
@@ -300,18 +300,14 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
300
300
  - [`sessionsSessionRecordingStream`](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
301
301
  - [`sessionsTranscriptGetById`](docs/sdks/transcript/README.md#getbyid) - Get Session Transcript By Id
302
302
  - [`toolsCreate`](docs/sdks/tools/README.md#create) - Create Tool
303
+ - [`toolsDelete`](docs/sdks/tools/README.md#delete) - Delete Tool
303
304
  - [`toolsGetByName`](docs/sdks/tools/README.md#getbyname) - Tool Info
304
305
  - [`toolsList`](docs/sdks/tools/README.md#list) - Tool List
305
306
  - [`toolsUpdate`](docs/sdks/tools/README.md#update) - Update Tool
306
- - [`v1Create`](docs/sdks/v1/README.md#create) - Create Data Source
307
- - [`v1DataSourcesDeleteByName`](docs/sdks/v1/README.md#datasourcesdeletebyname) - Delete Data Source
308
- - [`v1GetByName`](docs/sdks/v1/README.md#getbyname) - Get Data Source
309
- - [`v1List`](docs/sdks/v1/README.md#list) - List Data Sources
310
307
  - [`v1PostSessionEventsDashboard`](docs/sdks/v1/README.md#postsessioneventsdashboard) - Post Session Events
311
308
  - [`v1PostSessionsDashboard`](docs/sdks/v1/README.md#postsessionsdashboard) - Post Sessions
312
309
  - [`v1PostSessionSummaryDashboard`](docs/sdks/v1/README.md#postsessionsummarydashboard) - Post Session Summary
313
310
  - [`v1PostSessionTransfersDashboard`](docs/sdks/v1/README.md#postsessiontransfersdashboard) - Post Session Transfers
314
- - [`v1Update`](docs/sdks/v1/README.md#update) - Update Data Source
315
311
 
316
312
  </details>
317
313
  <!-- End Standalone functions [standalone-funcs] -->
package/docs/sdks/datasources/README.md CHANGED
@@ -11,7 +11,7 @@ Operations related to data sources. A data source is a blob of text that
11
11
  * [create](#create) - Create Data Source
12
12
  * [update](#update) - Update Data Source
13
13
  * [getByName](#getbyname) - Get Data Source
14
- * [dataSourcesDeleteByName](#datasourcesdeletebyname) - Delete Data Source
14
+ * [delete](#delete) - Delete Data Source
15
15
 
16
16
  ## list
17
17
 
@@ -275,7 +275,7 @@ const syllableSDK = new SyllableSDK({
275
275
 
276
276
  async function run() {
277
277
  const result = await syllableSDK.dataSources.getByName({
278
- name: "<value>",
278
+ dataSourceName: "<value>",
279
279
  });
280
280
 
281
281
  // Handle the result
@@ -301,7 +301,7 @@ const syllableSDK = new SyllableSDKCore({
301
301
 
302
302
  async function run() {
303
303
  const res = await dataSourcesGetByName(syllableSDK, {
304
- name: "<value>",
304
+ dataSourceName: "<value>",
305
305
  });
306
306
 
307
307
  if (!res.ok) {
@@ -337,7 +337,7 @@ run();
337
337
  | errors.HTTPValidationError | 422 | application/json |
338
338
  | errors.SDKError | 4XX, 5XX | \*/\* |
339
339
 
340
- ## dataSourcesDeleteByName
340
+ ## delete
341
341
 
342
342
  Delete a given data source.
343
343
 
@@ -351,8 +351,8 @@ const syllableSDK = new SyllableSDK({
351
351
  });
352
352
 
353
353
  async function run() {
354
- const result = await syllableSDK.dataSources.dataSourcesDeleteByName({
355
- name: "<value>",
354
+ const result = await syllableSDK.dataSources.delete({
355
+ dataSourceName: "<value>",
356
356
  reason: "<value>",
357
357
  });
358
358
 
@@ -369,7 +369,7 @@ The standalone function version of this method:
369
369
 
370
370
  ```typescript
371
371
  import { SyllableSDKCore } from "syllable-sdk/core.js";
372
- import { dataSourcesDataSourcesDeleteByName } from "syllable-sdk/funcs/dataSourcesDataSourcesDeleteByName.js";
372
+ import { dataSourcesDelete } from "syllable-sdk/funcs/dataSourcesDelete.js";
373
373
 
374
374
  // Use `SyllableSDKCore` for best tree-shaking performance.
375
375
  // You can create one instance of it to use across an application.
@@ -378,8 +378,8 @@ const syllableSDK = new SyllableSDKCore({
378
378
  });
379
379
 
380
380
  async function run() {
381
- const res = await dataSourcesDataSourcesDeleteByName(syllableSDK, {
382
- name: "<value>",
381
+ const res = await dataSourcesDelete(syllableSDK, {
382
+ dataSourceName: "<value>",
383
383
  reason: "<value>",
384
384
  });
385
385
 
@@ -400,7 +400,7 @@ run();
400
400
 
401
401
  | Parameter | Type | Required | Description |
402
402
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
403
- | `request` | [operations.DataSourcesDeleteByNameRequest](../../models/operations/datasourcesdeletebynamerequest.md) | :heavy_check_mark: | The request object to use for the request. |
403
+ | `request` | [operations.DataSourcesDeleteRequest](../../models/operations/datasourcesdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
404
404
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
405
405
  | `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. |
406
406
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
package/docs/sdks/services/README.md CHANGED
@@ -10,10 +10,12 @@ Operations related to service configuration. A service is a collection of
10
10
  * [list](#list) - Service List
11
11
  * [create](#create) - Create Service
12
12
  * [update](#update) - Update Service
13
+ * [getById](#getbyid) - Get Service By Id
14
+ * [delete](#delete) - Delete Service
13
15
 
14
16
  ## list
15
17
 
16
- List the existing agents
18
+ List the existing services
17
19
 
18
20
  ### Example Usage
19
21
 
@@ -75,7 +77,7 @@ run();
75
77
 
76
78
  ### Response
77
79
 
78
- **Promise\<[components.ListResponseService](../../models/components/listresponseservice.md)\>**
80
+ **Promise\<[components.ListResponseServiceResponse](../../models/components/listresponseserviceresponse.md)\>**
79
81
 
80
82
  ### Errors
81
83
 
@@ -86,7 +88,7 @@ run();
86
88
 
87
89
  ## create
88
90
 
89
- Create Service
91
+ Create a new service.
90
92
 
91
93
  ### Example Usage
92
94
 
@@ -147,14 +149,14 @@ run();
147
149
 
148
150
  | Parameter | Type | Required | Description |
149
151
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
150
- | `request` | [components.ServiceCreate](../../models/components/servicecreate.md) | :heavy_check_mark: | The request object to use for the request. |
152
+ | `request` | [components.ServiceCreateRequest](../../models/components/servicecreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
151
153
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
152
154
  | `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. |
153
155
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
154
156
 
155
157
  ### Response
156
158
 
157
- **Promise\<[components.Service](../../models/components/service.md)\>**
159
+ **Promise\<[components.ServiceResponse](../../models/components/serviceresponse.md)\>**
158
160
 
159
161
  ### Errors
160
162
 
@@ -165,7 +167,7 @@ run();
165
167
 
166
168
  ## update
167
169
 
168
- Update Service
170
+ Update an existing service.
169
171
 
170
172
  ### Example Usage
171
173
 
@@ -228,14 +230,170 @@ run();
228
230
 
229
231
  | Parameter | Type | Required | Description |
230
232
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
231
- | `request` | [components.ServiceUpdate](../../models/components/serviceupdate.md) | :heavy_check_mark: | The request object to use for the request. |
233
+ | `request` | [components.ServiceUpdateRequest](../../models/components/serviceupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
232
234
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
233
235
  | `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. |
234
236
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
235
237
 
236
238
  ### Response
237
239
 
238
- **Promise\<[components.Service](../../models/components/service.md)\>**
240
+ **Promise\<[components.ServiceResponse](../../models/components/serviceresponse.md)\>**
241
+
242
+ ### Errors
243
+
244
+ | Error Type | Status Code | Content Type |
245
+ | -------------------------- | -------------------------- | -------------------------- |
246
+ | errors.HTTPValidationError | 422 | application/json |
247
+ | errors.SDKError | 4XX, 5XX | \*/\* |
248
+
249
+ ## getById
250
+
251
+ Get a service by its ID
252
+
253
+ ### Example Usage
254
+
255
+ ```typescript
256
+ import { SyllableSDK } from "syllable-sdk";
257
+
258
+ const syllableSDK = new SyllableSDK({
259
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
260
+ });
261
+
262
+ async function run() {
263
+ const result = await syllableSDK.services.getById({
264
+ serviceId: 931598,
265
+ });
266
+
267
+ // Handle the result
268
+ console.log(result);
269
+ }
270
+
271
+ run();
272
+ ```
273
+
274
+ ### Standalone function
275
+
276
+ The standalone function version of this method:
277
+
278
+ ```typescript
279
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
280
+ import { servicesGetById } from "syllable-sdk/funcs/servicesGetById.js";
281
+
282
+ // Use `SyllableSDKCore` for best tree-shaking performance.
283
+ // You can create one instance of it to use across an application.
284
+ const syllableSDK = new SyllableSDKCore({
285
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
286
+ });
287
+
288
+ async function run() {
289
+ const res = await servicesGetById(syllableSDK, {
290
+ serviceId: 931598,
291
+ });
292
+
293
+ if (!res.ok) {
294
+ throw res.error;
295
+ }
296
+
297
+ const { value: result } = res;
298
+
299
+ // Handle the result
300
+ console.log(result);
301
+ }
302
+
303
+ run();
304
+ ```
305
+
306
+ ### Parameters
307
+
308
+ | Parameter | Type | Required | Description |
309
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
310
+ | `request` | [operations.ServicesGetByIdRequest](../../models/operations/servicesgetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
311
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
312
+ | `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. |
313
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
314
+
315
+ ### Response
316
+
317
+ **Promise\<[components.ServiceResponse](../../models/components/serviceresponse.md)\>**
318
+
319
+ ### Errors
320
+
321
+ | Error Type | Status Code | Content Type |
322
+ | -------------------------- | -------------------------- | -------------------------- |
323
+ | errors.HTTPValidationError | 422 | application/json |
324
+ | errors.SDKError | 4XX, 5XX | \*/\* |
325
+
326
+ ## delete
327
+
328
+ Delete a service. A service with linked tools cannot be deleted.
329
+
330
+ ### Example Usage
331
+
332
+ ```typescript
333
+ import { SyllableSDK } from "syllable-sdk";
334
+
335
+ const syllableSDK = new SyllableSDK({
336
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
337
+ });
338
+
339
+ async function run() {
340
+ const result = await syllableSDK.services.delete({
341
+ serviceId: 545907,
342
+ reason: "<value>",
343
+ });
344
+
345
+ // Handle the result
346
+ console.log(result);
347
+ }
348
+
349
+ run();
350
+ ```
351
+
352
+ ### Standalone function
353
+
354
+ The standalone function version of this method:
355
+
356
+ ```typescript
357
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
358
+ import { servicesDelete } from "syllable-sdk/funcs/servicesDelete.js";
359
+
360
+ // Use `SyllableSDKCore` for best tree-shaking performance.
361
+ // You can create one instance of it to use across an application.
362
+ const syllableSDK = new SyllableSDKCore({
363
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
364
+ });
365
+
366
+ async function run() {
367
+ const res = await servicesDelete(syllableSDK, {
368
+ serviceId: 545907,
369
+ reason: "<value>",
370
+ });
371
+
372
+ if (!res.ok) {
373
+ throw res.error;
374
+ }
375
+
376
+ const { value: result } = res;
377
+
378
+ // Handle the result
379
+ console.log(result);
380
+ }
381
+
382
+ run();
383
+ ```
384
+
385
+ ### Parameters
386
+
387
+ | Parameter | Type | Required | Description |
388
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
389
+ | `request` | [operations.ServiceDeleteRequest](../../models/operations/servicedeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
390
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
391
+ | `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. |
392
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
393
+
394
+ ### Response
395
+
396
+ **Promise\<[any](../../models/.md)\>**
239
397
 
240
398
  ### Errors
241
399
 
package/docs/sdks/tools/README.md CHANGED
@@ -11,6 +11,7 @@ Operations related to tool configuration. A tool is a function that an
11
11
  * [create](#create) - Create Tool
12
12
  * [update](#update) - Update Tool
13
13
  * [getByName](#getbyname) - Tool Info
14
+ * [delete](#delete) - Delete Tool
14
15
 
15
16
  ## list
16
17
 
@@ -353,6 +354,85 @@ run();
353
354
 
354
355
  ### Errors
355
356
 
357
+ | Error Type | Status Code | Content Type |
358
+ | -------------------------- | -------------------------- | -------------------------- |
359
+ | errors.HTTPValidationError | 422 | application/json |
360
+ | errors.SDKError | 4XX, 5XX | \*/\* |
361
+
362
+ ## delete
363
+
364
+ Delete a tool.
365
+
366
+ ### Example Usage
367
+
368
+ ```typescript
369
+ import { SyllableSDK } from "syllable-sdk";
370
+
371
+ const syllableSDK = new SyllableSDK({
372
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
373
+ });
374
+
375
+ async function run() {
376
+ const result = await syllableSDK.tools.delete({
377
+ toolName: "<value>",
378
+ reason: "<value>",
379
+ });
380
+
381
+ // Handle the result
382
+ console.log(result);
383
+ }
384
+
385
+ run();
386
+ ```
387
+
388
+ ### Standalone function
389
+
390
+ The standalone function version of this method:
391
+
392
+ ```typescript
393
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
394
+ import { toolsDelete } from "syllable-sdk/funcs/toolsDelete.js";
395
+
396
+ // Use `SyllableSDKCore` for best tree-shaking performance.
397
+ // You can create one instance of it to use across an application.
398
+ const syllableSDK = new SyllableSDKCore({
399
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
400
+ });
401
+
402
+ async function run() {
403
+ const res = await toolsDelete(syllableSDK, {
404
+ toolName: "<value>",
405
+ reason: "<value>",
406
+ });
407
+
408
+ if (!res.ok) {
409
+ throw res.error;
410
+ }
411
+
412
+ const { value: result } = res;
413
+
414
+ // Handle the result
415
+ console.log(result);
416
+ }
417
+
418
+ run();
419
+ ```
420
+
421
+ ### Parameters
422
+
423
+ | Parameter | Type | Required | Description |
424
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
425
+ | `request` | [operations.ToolDeleteRequest](../../models/operations/tooldeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
426
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
427
+ | `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. |
428
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
429
+
430
+ ### Response
431
+
432
+ **Promise\<[any](../../models/.md)\>**
433
+
434
+ ### Errors
435
+
356
436
  | Error Type | Status Code | Content Type |
357
437
  | -------------------------- | -------------------------- | -------------------------- |
358
438
  | errors.HTTPValidationError | 422 | application/json |