syllable-sdk 0.1.0-alpha.73 → 0.1.0-alpha.74

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 (277) hide show
  1. package/README.md +17 -13
  2. package/docs/sdks/batches/README.md +30 -32
  3. package/docs/sdks/campaigns/README.md +11 -3
  4. package/docs/sdks/incidents/README.md +178 -84
  5. package/docs/sdks/insights/README.md +1 -1
  6. package/docs/sdks/syllablesdktools/README.md +82 -2
  7. package/docs/sdks/takeouts/README.md +11 -11
  8. package/docs/sdks/workflows/README.md +1 -1
  9. package/funcs/incidentsCreate.d.ts +1 -1
  10. package/funcs/incidentsCreate.d.ts.map +1 -1
  11. package/funcs/incidentsCreate.js +2 -2
  12. package/funcs/incidentsCreate.js.map +1 -1
  13. package/funcs/incidentsDelete.d.ts.map +1 -1
  14. package/funcs/incidentsDelete.js +4 -0
  15. package/funcs/incidentsDelete.js.map +1 -1
  16. package/funcs/incidentsGetById.d.ts +1 -1
  17. package/funcs/incidentsGetById.d.ts.map +1 -1
  18. package/funcs/incidentsGetById.js +1 -1
  19. package/funcs/incidentsGetById.js.map +1 -1
  20. package/funcs/incidentsIncidentGetOrganizations.d.ts +15 -0
  21. package/funcs/incidentsIncidentGetOrganizations.d.ts.map +1 -0
  22. package/funcs/incidentsIncidentGetOrganizations.js +89 -0
  23. package/funcs/incidentsIncidentGetOrganizations.js.map +1 -0
  24. package/funcs/incidentsList.d.ts +2 -2
  25. package/funcs/incidentsList.d.ts.map +1 -1
  26. package/funcs/incidentsList.js +10 -4
  27. package/funcs/incidentsList.js.map +1 -1
  28. package/funcs/incidentsUpdate.d.ts +1 -2
  29. package/funcs/incidentsUpdate.d.ts.map +1 -1
  30. package/funcs/incidentsUpdate.js +4 -13
  31. package/funcs/incidentsUpdate.js.map +1 -1
  32. package/funcs/insightsList.d.ts +1 -1
  33. package/funcs/insightsList.js +1 -1
  34. package/funcs/insightsToolsCreate.d.ts +1 -1
  35. package/funcs/insightsToolsCreate.js +3 -3
  36. package/funcs/insightsToolsCreate.js.map +1 -1
  37. package/funcs/insightsToolsInsightsToolTest.d.ts +16 -0
  38. package/funcs/insightsToolsInsightsToolTest.d.ts.map +1 -0
  39. package/funcs/insightsToolsInsightsToolTest.js +103 -0
  40. package/funcs/insightsToolsInsightsToolTest.js.map +1 -0
  41. package/funcs/insightsToolsUpdate.d.ts +1 -1
  42. package/funcs/insightsToolsUpdate.js +1 -1
  43. package/funcs/insightsWorkflowsQueueSessionsWorkflow.d.ts +1 -1
  44. package/funcs/insightsWorkflowsQueueSessionsWorkflow.js +1 -1
  45. package/funcs/{outboundBatchesOutboundBatchAdd.d.ts → outboundBatchesAdd.d.ts} +2 -2
  46. package/funcs/outboundBatchesAdd.d.ts.map +1 -0
  47. package/funcs/{outboundBatchesOutboundBatchAdd.js → outboundBatchesAdd.js} +3 -3
  48. package/funcs/outboundBatchesAdd.js.map +1 -0
  49. package/funcs/outboundBatchesList.d.ts +1 -1
  50. package/funcs/outboundBatchesList.d.ts.map +1 -1
  51. package/funcs/outboundBatchesList.js +1 -2
  52. package/funcs/outboundBatchesList.js.map +1 -1
  53. package/funcs/{outboundBatchesOutboundBatchRemove.d.ts → outboundBatchesRemove.d.ts} +2 -2
  54. package/funcs/outboundBatchesRemove.d.ts.map +1 -0
  55. package/funcs/{outboundBatchesOutboundBatchRemove.js → outboundBatchesRemove.js} +3 -3
  56. package/funcs/outboundBatchesRemove.js.map +1 -0
  57. package/funcs/{outboundBatchesOutboundBatchResults.d.ts → outboundBatchesResults.d.ts} +2 -2
  58. package/funcs/outboundBatchesResults.d.ts.map +1 -0
  59. package/funcs/{outboundBatchesOutboundBatchResults.js → outboundBatchesResults.js} +8 -3
  60. package/funcs/outboundBatchesResults.js.map +1 -0
  61. package/funcs/outboundBatchesUpload.d.ts.map +1 -1
  62. package/funcs/outboundBatchesUpload.js +16 -12
  63. package/funcs/outboundBatchesUpload.js.map +1 -1
  64. package/funcs/outboundCampaignsList.d.ts +1 -1
  65. package/funcs/outboundCampaignsList.d.ts.map +1 -1
  66. package/funcs/outboundCampaignsList.js +1 -2
  67. package/funcs/outboundCampaignsList.js.map +1 -1
  68. package/funcs/{takeoutsCreateTakeoutApiV1TakeoutsCreatePost.d.ts → takeoutsCreate.d.ts} +2 -2
  69. package/funcs/takeoutsCreate.d.ts.map +1 -0
  70. package/funcs/{takeoutsCreateTakeoutApiV1TakeoutsCreatePost.js → takeoutsCreate.js} +4 -4
  71. package/funcs/takeoutsCreate.js.map +1 -0
  72. package/funcs/{takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.d.ts → takeoutsTakeoutsGetByJobId.d.ts} +2 -2
  73. package/funcs/takeoutsTakeoutsGetByJobId.d.ts.map +1 -0
  74. package/funcs/{takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.js → takeoutsTakeoutsGetByJobId.js} +5 -5
  75. package/funcs/takeoutsTakeoutsGetByJobId.js.map +1 -0
  76. package/jsr.json +1 -1
  77. package/lib/config.d.ts +2 -2
  78. package/lib/config.js +2 -2
  79. package/models/components/bodyoutboundbatchdelete.d.ts +1 -1
  80. package/models/components/bodyoutboundbatchdelete.d.ts.map +1 -1
  81. package/models/components/bodyoutboundbatchdelete.js +10 -1
  82. package/models/components/bodyoutboundbatchdelete.js.map +1 -1
  83. package/models/components/bodyoutboundbatchupload.d.ts +2 -2
  84. package/models/components/bodyoutboundbatchupload.d.ts.map +1 -1
  85. package/models/components/bodyoutboundbatchupload.js +2 -2
  86. package/models/components/bodyoutboundbatchupload.js.map +1 -1
  87. package/models/components/communicationrequest.d.ts +0 -11
  88. package/models/components/communicationrequest.d.ts.map +1 -1
  89. package/models/components/communicationrequest.js +0 -9
  90. package/models/components/communicationrequest.js.map +1 -1
  91. package/models/components/communicationrequestresult.d.ts +39 -14
  92. package/models/components/communicationrequestresult.d.ts.map +1 -1
  93. package/models/components/communicationrequestresult.js +38 -14
  94. package/models/components/communicationrequestresult.js.map +1 -1
  95. package/models/components/conversation.d.ts +10 -0
  96. package/models/components/conversation.d.ts.map +1 -1
  97. package/models/components/conversation.js +8 -0
  98. package/models/components/conversation.js.map +1 -1
  99. package/models/components/incidentcreaterequest.d.ts +75 -0
  100. package/models/components/incidentcreaterequest.d.ts.map +1 -0
  101. package/models/components/{serviceincidentrequest.js → incidentcreaterequest.js} +29 -29
  102. package/models/components/incidentcreaterequest.js.map +1 -0
  103. package/models/components/incidentorganizationresponse.d.ts +33 -0
  104. package/models/components/incidentorganizationresponse.d.ts.map +1 -0
  105. package/models/components/incidentorganizationresponse.js +72 -0
  106. package/models/components/incidentorganizationresponse.js.map +1 -0
  107. package/models/components/incidentproperties.d.ts +64 -0
  108. package/models/components/incidentproperties.d.ts.map +1 -0
  109. package/models/components/{requeststatus.js → incidentproperties.js} +25 -19
  110. package/models/components/incidentproperties.js.map +1 -0
  111. package/models/components/incidentresponse.d.ts +90 -0
  112. package/models/components/incidentresponse.d.ts.map +1 -0
  113. package/models/components/{serviceincidentresponse.js → incidentresponse.js} +33 -33
  114. package/models/components/incidentresponse.js.map +1 -0
  115. package/models/components/incidentupdaterequest.d.ts +90 -0
  116. package/models/components/incidentupdaterequest.d.ts.map +1 -0
  117. package/models/{operations/incidentupdate.js → components/incidentupdaterequest.js} +43 -10
  118. package/models/components/incidentupdaterequest.js.map +1 -0
  119. package/models/components/index.d.ts +9 -3
  120. package/models/components/index.d.ts.map +1 -1
  121. package/models/components/index.js +9 -3
  122. package/models/components/index.js.map +1 -1
  123. package/models/components/insighttooltestinput.d.ts +40 -0
  124. package/models/components/insighttooltestinput.d.ts.map +1 -0
  125. package/models/components/insighttooltestinput.js +72 -0
  126. package/models/components/insighttooltestinput.js.map +1 -0
  127. package/models/components/listresponsecommunicationbatch.d.ts +53 -0
  128. package/models/components/listresponsecommunicationbatch.d.ts.map +1 -0
  129. package/models/components/listresponsecommunicationbatch.js +81 -0
  130. package/models/components/listresponsecommunicationbatch.js.map +1 -0
  131. package/models/components/listresponseincidentresponse.d.ts +53 -0
  132. package/models/components/listresponseincidentresponse.d.ts.map +1 -0
  133. package/models/components/listresponseincidentresponse.js +81 -0
  134. package/models/components/listresponseincidentresponse.js.map +1 -0
  135. package/models/components/listresponseoutboundcampaign.d.ts +53 -0
  136. package/models/components/listresponseoutboundcampaign.d.ts.map +1 -0
  137. package/models/components/listresponseoutboundcampaign.js +81 -0
  138. package/models/components/listresponseoutboundcampaign.js.map +1 -0
  139. package/models/components/outboundcampaign.d.ts +10 -0
  140. package/models/components/outboundcampaign.d.ts.map +1 -1
  141. package/models/components/outboundcampaign.js +4 -0
  142. package/models/components/outboundcampaign.js.map +1 -1
  143. package/models/components/outboundcampaigninput.d.ts +10 -0
  144. package/models/components/outboundcampaigninput.d.ts.map +1 -1
  145. package/models/components/outboundcampaigninput.js +4 -0
  146. package/models/components/outboundcampaigninput.js.map +1 -1
  147. package/models/components/promptcreaterequest.d.ts +1 -1
  148. package/models/components/promptupdaterequest.d.ts +1 -1
  149. package/models/operations/incidentdelete.d.ts +2 -0
  150. package/models/operations/incidentdelete.d.ts.map +1 -1
  151. package/models/operations/incidentdelete.js +2 -0
  152. package/models/operations/incidentdelete.js.map +1 -1
  153. package/models/operations/incidentlist.d.ts +44 -2
  154. package/models/operations/incidentlist.d.ts.map +1 -1
  155. package/models/operations/incidentlist.js +44 -4
  156. package/models/operations/incidentlist.js.map +1 -1
  157. package/models/operations/index.d.ts +1 -2
  158. package/models/operations/index.d.ts.map +1 -1
  159. package/models/operations/index.js +1 -2
  160. package/models/operations/index.js.map +1 -1
  161. package/models/operations/outboundbatchresults.d.ts +4 -0
  162. package/models/operations/outboundbatchresults.d.ts.map +1 -1
  163. package/models/operations/outboundbatchresults.js +6 -0
  164. package/models/operations/outboundbatchresults.js.map +1 -1
  165. package/models/operations/outboundbatchupload.d.ts +2 -2
  166. package/models/operations/outboundbatchupload.d.ts.map +1 -1
  167. package/models/operations/outboundbatchupload.js +4 -2
  168. package/models/operations/outboundbatchupload.js.map +1 -1
  169. package/models/operations/takeoutsgetbyjobid.d.ts +29 -0
  170. package/models/operations/takeoutsgetbyjobid.d.ts.map +1 -0
  171. package/models/operations/{gettakeoutapiv1takeoutsgetjobidget.js → takeoutsgetbyjobid.js} +17 -17
  172. package/models/operations/takeoutsgetbyjobid.js.map +1 -0
  173. package/openapi.json +1206 -423
  174. package/package.json +1 -1
  175. package/sdk/batches.d.ts +4 -4
  176. package/sdk/batches.d.ts.map +1 -1
  177. package/sdk/batches.js +9 -9
  178. package/sdk/batches.js.map +1 -1
  179. package/sdk/campaigns.d.ts +1 -1
  180. package/sdk/campaigns.d.ts.map +1 -1
  181. package/sdk/incidents.d.ts +20 -13
  182. package/sdk/incidents.d.ts.map +1 -1
  183. package/sdk/incidents.js +26 -16
  184. package/sdk/incidents.js.map +1 -1
  185. package/sdk/insights.d.ts +1 -1
  186. package/sdk/insights.js +1 -1
  187. package/sdk/syllablesdktools.d.ts +9 -2
  188. package/sdk/syllablesdktools.d.ts.map +1 -1
  189. package/sdk/syllablesdktools.js +12 -2
  190. package/sdk/syllablesdktools.js.map +1 -1
  191. package/sdk/takeouts.d.ts +2 -2
  192. package/sdk/takeouts.d.ts.map +1 -1
  193. package/sdk/takeouts.js +6 -6
  194. package/sdk/takeouts.js.map +1 -1
  195. package/sdk/workflows.d.ts +1 -1
  196. package/sdk/workflows.js +1 -1
  197. package/src/funcs/incidentsCreate.ts +5 -5
  198. package/src/funcs/incidentsDelete.ts +6 -1
  199. package/src/funcs/incidentsGetById.ts +3 -3
  200. package/src/funcs/incidentsIncidentGetOrganizations.ts +112 -0
  201. package/src/funcs/incidentsList.ts +12 -6
  202. package/src/funcs/incidentsUpdate.ts +8 -18
  203. package/src/funcs/insightsList.ts +1 -1
  204. package/src/funcs/insightsToolsCreate.ts +4 -4
  205. package/src/funcs/insightsToolsInsightsToolTest.ts +136 -0
  206. package/src/funcs/insightsToolsUpdate.ts +1 -1
  207. package/src/funcs/insightsWorkflowsQueueSessionsWorkflow.ts +1 -1
  208. package/src/funcs/{outboundBatchesOutboundBatchAdd.ts → outboundBatchesAdd.ts} +1 -1
  209. package/src/funcs/outboundBatchesList.ts +3 -4
  210. package/src/funcs/{outboundBatchesOutboundBatchRemove.ts → outboundBatchesRemove.ts} +1 -1
  211. package/src/funcs/{outboundBatchesOutboundBatchResults.ts → outboundBatchesResults.ts} +8 -2
  212. package/src/funcs/outboundBatchesUpload.ts +23 -20
  213. package/src/funcs/outboundCampaignsList.ts +3 -4
  214. package/src/funcs/{takeoutsCreateTakeoutApiV1TakeoutsCreatePost.ts → takeoutsCreate.ts} +2 -2
  215. package/src/funcs/{takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.ts → takeoutsTakeoutsGetByJobId.ts} +4 -7
  216. package/src/lib/config.ts +2 -2
  217. package/src/models/components/bodyoutboundbatchdelete.ts +11 -2
  218. package/src/models/components/bodyoutboundbatchupload.ts +4 -4
  219. package/src/models/components/communicationrequest.ts +0 -23
  220. package/src/models/components/communicationrequestresult.ts +78 -30
  221. package/src/models/components/conversation.ts +18 -0
  222. package/src/models/components/{serviceincidentrequest.ts → incidentcreaterequest.ts} +69 -39
  223. package/src/models/components/incidentorganizationresponse.ts +85 -0
  224. package/src/models/components/incidentproperties.ts +49 -0
  225. package/src/models/components/incidentresponse.ts +182 -0
  226. package/src/models/components/incidentupdaterequest.ts +182 -0
  227. package/src/models/components/index.ts +9 -3
  228. package/src/models/components/insighttooltestinput.ts +90 -0
  229. package/src/models/components/listresponsecommunicationbatch.ts +118 -0
  230. package/src/models/components/listresponseincidentresponse.ts +118 -0
  231. package/src/models/components/listresponseoutboundcampaign.ts +118 -0
  232. package/src/models/components/outboundcampaign.ts +14 -0
  233. package/src/models/components/outboundcampaigninput.ts +14 -0
  234. package/src/models/components/promptcreaterequest.ts +1 -1
  235. package/src/models/components/promptupdaterequest.ts +1 -1
  236. package/src/models/operations/incidentdelete.ts +4 -0
  237. package/src/models/operations/incidentlist.ts +87 -6
  238. package/src/models/operations/index.ts +1 -2
  239. package/src/models/operations/outboundbatchresults.ts +10 -0
  240. package/src/models/operations/outboundbatchupload.ts +8 -4
  241. package/src/models/operations/takeoutsgetbyjobid.ts +75 -0
  242. package/src/sdk/batches.ts +10 -10
  243. package/src/sdk/campaigns.ts +1 -1
  244. package/src/sdk/incidents.ts +43 -27
  245. package/src/sdk/insights.ts +1 -1
  246. package/src/sdk/syllablesdktools.ts +20 -2
  247. package/src/sdk/takeouts.ts +7 -7
  248. package/src/sdk/workflows.ts +1 -1
  249. package/funcs/outboundBatchesOutboundBatchAdd.d.ts.map +0 -1
  250. package/funcs/outboundBatchesOutboundBatchAdd.js.map +0 -1
  251. package/funcs/outboundBatchesOutboundBatchRemove.d.ts.map +0 -1
  252. package/funcs/outboundBatchesOutboundBatchRemove.js.map +0 -1
  253. package/funcs/outboundBatchesOutboundBatchResults.d.ts.map +0 -1
  254. package/funcs/outboundBatchesOutboundBatchResults.js.map +0 -1
  255. package/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.d.ts.map +0 -1
  256. package/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.js.map +0 -1
  257. package/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.d.ts.map +0 -1
  258. package/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.js.map +0 -1
  259. package/models/components/requeststatus.d.ts +0 -46
  260. package/models/components/requeststatus.d.ts.map +0 -1
  261. package/models/components/requeststatus.js.map +0 -1
  262. package/models/components/serviceincidentrequest.d.ts +0 -45
  263. package/models/components/serviceincidentrequest.d.ts.map +0 -1
  264. package/models/components/serviceincidentrequest.js.map +0 -1
  265. package/models/components/serviceincidentresponse.d.ts +0 -51
  266. package/models/components/serviceincidentresponse.d.ts.map +0 -1
  267. package/models/components/serviceincidentresponse.js.map +0 -1
  268. package/models/operations/gettakeoutapiv1takeoutsgetjobidget.d.ts +0 -29
  269. package/models/operations/gettakeoutapiv1takeoutsgetjobidget.d.ts.map +0 -1
  270. package/models/operations/gettakeoutapiv1takeoutsgetjobidget.js.map +0 -1
  271. package/models/operations/incidentupdate.d.ts +0 -32
  272. package/models/operations/incidentupdate.d.ts.map +0 -1
  273. package/models/operations/incidentupdate.js.map +0 -1
  274. package/src/models/components/requeststatus.ts +0 -43
  275. package/src/models/components/serviceincidentresponse.ts +0 -139
  276. package/src/models/operations/gettakeoutapiv1takeoutsgetjobidget.ts +0 -87
  277. package/src/models/operations/incidentupdate.ts +0 -82
@@ -7,15 +7,16 @@ Operations related to incidents.
7
7
 
8
8
  ### Available Operations
9
9
 
10
- * [getById](#getbyid) - Get Incident By Id
10
+ * [list](#list) - List Incidents
11
+ * [create](#create) - Create Incident
11
12
  * [update](#update) - Update Incident
13
+ * [incidentGetOrganizations](#incidentgetorganizations) - Get Organizations
14
+ * [getById](#getbyid) - Get Incident By Id
12
15
  * [delete](#delete) - Delete Incident
13
- * [create](#create) - Create Incident
14
- * [list](#list) - List Incidents
15
16
 
16
- ## getById
17
+ ## list
17
18
 
18
- Get incident by ID
19
+ List service incidents with pagination and filtering
19
20
 
20
21
  ### Example Usage
21
22
 
@@ -27,8 +28,16 @@ const syllableSDK = new SyllableSDK({
27
28
  });
28
29
 
29
30
  async function run() {
30
- const result = await syllableSDK.incidents.getById({
31
- incidentId: 931598,
31
+ const result = await syllableSDK.incidents.list({
32
+ page: 0,
33
+ searchFields: [
34
+ "start_datetime",
35
+ ],
36
+ searchFieldValues: [
37
+ "Some Object Name",
38
+ ],
39
+ startDatetime: "2023-01-01T00:00:00Z",
40
+ endDatetime: "2024-01-01T00:00:00Z",
32
41
  });
33
42
 
34
43
  // Handle the result
@@ -44,7 +53,7 @@ The standalone function version of this method:
44
53
 
45
54
  ```typescript
46
55
  import { SyllableSDKCore } from "syllable-sdk/core.js";
47
- import { incidentsGetById } from "syllable-sdk/funcs/incidentsGetById.js";
56
+ import { incidentsList } from "syllable-sdk/funcs/incidentsList.js";
48
57
 
49
58
  // Use `SyllableSDKCore` for best tree-shaking performance.
50
59
  // You can create one instance of it to use across an application.
@@ -53,8 +62,16 @@ const syllableSDK = new SyllableSDKCore({
53
62
  });
54
63
 
55
64
  async function run() {
56
- const res = await incidentsGetById(syllableSDK, {
57
- incidentId: 931598,
65
+ const res = await incidentsList(syllableSDK, {
66
+ page: 0,
67
+ searchFields: [
68
+ "start_datetime",
69
+ ],
70
+ searchFieldValues: [
71
+ "Some Object Name",
72
+ ],
73
+ startDatetime: "2023-01-01T00:00:00Z",
74
+ endDatetime: "2024-01-01T00:00:00Z",
58
75
  });
59
76
 
60
77
  if (!res.ok) {
@@ -74,14 +91,14 @@ run();
74
91
 
75
92
  | Parameter | Type | Required | Description |
76
93
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
77
- | `request` | [operations.IncidentGetByIdRequest](../../models/operations/incidentgetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
94
+ | `request` | [operations.IncidentListRequest](../../models/operations/incidentlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
78
95
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
79
96
  | `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. |
80
97
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
81
98
 
82
99
  ### Response
83
100
 
84
- **Promise\<[components.ServiceIncidentResponse](../../models/components/serviceincidentresponse.md)\>**
101
+ **Promise\<[components.ListResponseIncidentResponse](../../models/components/listresponseincidentresponse.md)\>**
85
102
 
86
103
  ### Errors
87
104
 
@@ -90,9 +107,9 @@ run();
90
107
  | errors.HTTPValidationError | 422 | application/json |
91
108
  | errors.SDKError | 4XX, 5XX | \*/\* |
92
109
 
93
- ## update
110
+ ## create
94
111
 
95
- Update an existing incident
112
+ Create a new incident
96
113
 
97
114
  ### Example Usage
98
115
 
@@ -104,19 +121,16 @@ const syllableSDK = new SyllableSDK({
104
121
  });
105
122
 
106
123
  async function run() {
107
- const result = await syllableSDK.incidents.update({
108
- incidentId: 656776,
109
- serviceIncidentRequest: {
110
- organizationId: 857478,
111
- subOrganizationId: 597129,
112
- subOrganization: "<value>",
113
- description: "hydrolyze for drat underneath sticky",
114
- startDatetime: new Date("2023-03-21T03:40:17.460Z"),
115
- resolutionDatetime: new Date("2023-06-16T09:40:21.633Z"),
116
- impactCategory: "<value>",
117
- sessionsImpacted: 342070,
118
- markdown: "<value>",
119
- },
124
+ const result = await syllableSDK.incidents.create({
125
+ description: "Service outage in region X",
126
+ startDatetime: new Date("2023-10-01T08:00:00Z"),
127
+ resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
128
+ impactCategory: "High",
129
+ sessionsImpacted: 1500,
130
+ markdown: "**Incident Details**",
131
+ organizationId: 123,
132
+ subOrganizationId: 456,
133
+ subOrganization: "SubOrg A",
120
134
  });
121
135
 
122
136
  // Handle the result
@@ -132,7 +146,7 @@ The standalone function version of this method:
132
146
 
133
147
  ```typescript
134
148
  import { SyllableSDKCore } from "syllable-sdk/core.js";
135
- import { incidentsUpdate } from "syllable-sdk/funcs/incidentsUpdate.js";
149
+ import { incidentsCreate } from "syllable-sdk/funcs/incidentsCreate.js";
136
150
 
137
151
  // Use `SyllableSDKCore` for best tree-shaking performance.
138
152
  // You can create one instance of it to use across an application.
@@ -141,19 +155,16 @@ const syllableSDK = new SyllableSDKCore({
141
155
  });
142
156
 
143
157
  async function run() {
144
- const res = await incidentsUpdate(syllableSDK, {
145
- incidentId: 656776,
146
- serviceIncidentRequest: {
147
- organizationId: 857478,
148
- subOrganizationId: 597129,
149
- subOrganization: "<value>",
150
- description: "hydrolyze for drat underneath sticky",
151
- startDatetime: new Date("2023-03-21T03:40:17.460Z"),
152
- resolutionDatetime: new Date("2023-06-16T09:40:21.633Z"),
153
- impactCategory: "<value>",
154
- sessionsImpacted: 342070,
155
- markdown: "<value>",
156
- },
158
+ const res = await incidentsCreate(syllableSDK, {
159
+ description: "Service outage in region X",
160
+ startDatetime: new Date("2023-10-01T08:00:00Z"),
161
+ resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
162
+ impactCategory: "High",
163
+ sessionsImpacted: 1500,
164
+ markdown: "**Incident Details**",
165
+ organizationId: 123,
166
+ subOrganizationId: 456,
167
+ subOrganization: "SubOrg A",
157
168
  });
158
169
 
159
170
  if (!res.ok) {
@@ -173,14 +184,14 @@ run();
173
184
 
174
185
  | Parameter | Type | Required | Description |
175
186
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
176
- | `request` | [operations.IncidentUpdateRequest](../../models/operations/incidentupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
187
+ | `request` | [components.IncidentCreateRequest](../../models/components/incidentcreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
177
188
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
178
189
  | `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. |
179
190
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
180
191
 
181
192
  ### Response
182
193
 
183
- **Promise\<[components.ServiceIncidentResponse](../../models/components/serviceincidentresponse.md)\>**
194
+ **Promise\<[components.IncidentResponse](../../models/components/incidentresponse.md)\>**
184
195
 
185
196
  ### Errors
186
197
 
@@ -189,9 +200,9 @@ run();
189
200
  | errors.HTTPValidationError | 422 | application/json |
190
201
  | errors.SDKError | 4XX, 5XX | \*/\* |
191
202
 
192
- ## delete
203
+ ## update
193
204
 
194
- Delete an incident by ID
205
+ Update an existing incident
195
206
 
196
207
  ### Example Usage
197
208
 
@@ -203,8 +214,19 @@ const syllableSDK = new SyllableSDK({
203
214
  });
204
215
 
205
216
  async function run() {
206
- const result = await syllableSDK.incidents.delete({
207
- incidentId: 545907,
217
+ const result = await syllableSDK.incidents.update({
218
+ description: "Service outage in region X",
219
+ startDatetime: new Date("2023-10-01T08:00:00Z"),
220
+ resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
221
+ impactCategory: "High",
222
+ sessionsImpacted: 1500,
223
+ markdown: "**Incident Details**",
224
+ organizationId: 123,
225
+ subOrganizationId: 456,
226
+ subOrganization: "SubOrg A",
227
+ id: 1,
228
+ createdAt: new Date("2023-10-01T08:00:00Z"),
229
+ updatedAt: new Date("2023-10-01T08:00:00Z"),
208
230
  });
209
231
 
210
232
  // Handle the result
@@ -220,7 +242,7 @@ The standalone function version of this method:
220
242
 
221
243
  ```typescript
222
244
  import { SyllableSDKCore } from "syllable-sdk/core.js";
223
- import { incidentsDelete } from "syllable-sdk/funcs/incidentsDelete.js";
245
+ import { incidentsUpdate } from "syllable-sdk/funcs/incidentsUpdate.js";
224
246
 
225
247
  // Use `SyllableSDKCore` for best tree-shaking performance.
226
248
  // You can create one instance of it to use across an application.
@@ -229,8 +251,19 @@ const syllableSDK = new SyllableSDKCore({
229
251
  });
230
252
 
231
253
  async function run() {
232
- const res = await incidentsDelete(syllableSDK, {
233
- incidentId: 545907,
254
+ const res = await incidentsUpdate(syllableSDK, {
255
+ description: "Service outage in region X",
256
+ startDatetime: new Date("2023-10-01T08:00:00Z"),
257
+ resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
258
+ impactCategory: "High",
259
+ sessionsImpacted: 1500,
260
+ markdown: "**Incident Details**",
261
+ organizationId: 123,
262
+ subOrganizationId: 456,
263
+ subOrganization: "SubOrg A",
264
+ id: 1,
265
+ createdAt: new Date("2023-10-01T08:00:00Z"),
266
+ updatedAt: new Date("2023-10-01T08:00:00Z"),
234
267
  });
235
268
 
236
269
  if (!res.ok) {
@@ -250,14 +283,14 @@ run();
250
283
 
251
284
  | Parameter | Type | Required | Description |
252
285
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
253
- | `request` | [operations.IncidentDeleteRequest](../../models/operations/incidentdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
286
+ | `request` | [components.IncidentUpdateRequest](../../models/components/incidentupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
254
287
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
255
288
  | `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. |
256
289
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
257
290
 
258
291
  ### Response
259
292
 
260
- **Promise\<[any](../../models/.md)\>**
293
+ **Promise\<[components.IncidentResponse](../../models/components/incidentresponse.md)\>**
261
294
 
262
295
  ### Errors
263
296
 
@@ -266,9 +299,9 @@ run();
266
299
  | errors.HTTPValidationError | 422 | application/json |
267
300
  | errors.SDKError | 4XX, 5XX | \*/\* |
268
301
 
269
- ## create
302
+ ## incidentGetOrganizations
270
303
 
271
- Create a new incident
304
+ Get all organizations
272
305
 
273
306
  ### Example Usage
274
307
 
@@ -280,16 +313,79 @@ const syllableSDK = new SyllableSDK({
280
313
  });
281
314
 
282
315
  async function run() {
283
- const result = await syllableSDK.incidents.create({
284
- organizationId: 486589,
285
- subOrganizationId: 638424,
286
- subOrganization: "<value>",
287
- description: "calmly fortunately bench around igloo scaffold",
288
- startDatetime: new Date("2025-04-13T05:49:58.922Z"),
289
- resolutionDatetime: new Date("2023-08-30T02:12:40.558Z"),
290
- impactCategory: "<value>",
291
- sessionsImpacted: 449221,
292
- markdown: "<value>",
316
+ const result = await syllableSDK.incidents.incidentGetOrganizations();
317
+
318
+ // Handle the result
319
+ console.log(result);
320
+ }
321
+
322
+ run();
323
+ ```
324
+
325
+ ### Standalone function
326
+
327
+ The standalone function version of this method:
328
+
329
+ ```typescript
330
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
331
+ import { incidentsIncidentGetOrganizations } from "syllable-sdk/funcs/incidentsIncidentGetOrganizations.js";
332
+
333
+ // Use `SyllableSDKCore` for best tree-shaking performance.
334
+ // You can create one instance of it to use across an application.
335
+ const syllableSDK = new SyllableSDKCore({
336
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
337
+ });
338
+
339
+ async function run() {
340
+ const res = await incidentsIncidentGetOrganizations(syllableSDK);
341
+
342
+ if (!res.ok) {
343
+ throw res.error;
344
+ }
345
+
346
+ const { value: result } = res;
347
+
348
+ // Handle the result
349
+ console.log(result);
350
+ }
351
+
352
+ run();
353
+ ```
354
+
355
+ ### Parameters
356
+
357
+ | Parameter | Type | Required | Description |
358
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
359
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
360
+ | `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. |
361
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
362
+
363
+ ### Response
364
+
365
+ **Promise\<[components.IncidentOrganizationResponse[]](../../models/.md)\>**
366
+
367
+ ### Errors
368
+
369
+ | Error Type | Status Code | Content Type |
370
+ | --------------- | --------------- | --------------- |
371
+ | errors.SDKError | 4XX, 5XX | \*/\* |
372
+
373
+ ## getById
374
+
375
+ Get incident by ID
376
+
377
+ ### Example Usage
378
+
379
+ ```typescript
380
+ import { SyllableSDK } from "syllable-sdk";
381
+
382
+ const syllableSDK = new SyllableSDK({
383
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
384
+ });
385
+
386
+ async function run() {
387
+ const result = await syllableSDK.incidents.getById({
388
+ incidentId: 931598,
293
389
  });
294
390
 
295
391
  // Handle the result
@@ -305,7 +401,7 @@ The standalone function version of this method:
305
401
 
306
402
  ```typescript
307
403
  import { SyllableSDKCore } from "syllable-sdk/core.js";
308
- import { incidentsCreate } from "syllable-sdk/funcs/incidentsCreate.js";
404
+ import { incidentsGetById } from "syllable-sdk/funcs/incidentsGetById.js";
309
405
 
310
406
  // Use `SyllableSDKCore` for best tree-shaking performance.
311
407
  // You can create one instance of it to use across an application.
@@ -314,16 +410,8 @@ const syllableSDK = new SyllableSDKCore({
314
410
  });
315
411
 
316
412
  async function run() {
317
- const res = await incidentsCreate(syllableSDK, {
318
- organizationId: 486589,
319
- subOrganizationId: 638424,
320
- subOrganization: "<value>",
321
- description: "calmly fortunately bench around igloo scaffold",
322
- startDatetime: new Date("2025-04-13T05:49:58.922Z"),
323
- resolutionDatetime: new Date("2023-08-30T02:12:40.558Z"),
324
- impactCategory: "<value>",
325
- sessionsImpacted: 449221,
326
- markdown: "<value>",
413
+ const res = await incidentsGetById(syllableSDK, {
414
+ incidentId: 931598,
327
415
  });
328
416
 
329
417
  if (!res.ok) {
@@ -343,14 +431,14 @@ run();
343
431
 
344
432
  | Parameter | Type | Required | Description |
345
433
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
346
- | `request` | [components.ServiceIncidentRequest](../../models/components/serviceincidentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
434
+ | `request` | [operations.IncidentGetByIdRequest](../../models/operations/incidentgetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
347
435
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
348
436
  | `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. |
349
437
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
350
438
 
351
439
  ### Response
352
440
 
353
- **Promise\<[components.ServiceIncidentResponse](../../models/components/serviceincidentresponse.md)\>**
441
+ **Promise\<[components.IncidentResponse](../../models/components/incidentresponse.md)\>**
354
442
 
355
443
  ### Errors
356
444
 
@@ -359,9 +447,9 @@ run();
359
447
  | errors.HTTPValidationError | 422 | application/json |
360
448
  | errors.SDKError | 4XX, 5XX | \*/\* |
361
449
 
362
- ## list
450
+ ## delete
363
451
 
364
- List service incidents with pagination
452
+ Delete an incident by ID
365
453
 
366
454
  ### Example Usage
367
455
 
@@ -373,7 +461,10 @@ const syllableSDK = new SyllableSDK({
373
461
  });
374
462
 
375
463
  async function run() {
376
- const result = await syllableSDK.incidents.list({});
464
+ const result = await syllableSDK.incidents.delete({
465
+ incidentId: 545907,
466
+ reason: "<value>",
467
+ });
377
468
 
378
469
  // Handle the result
379
470
  console.log(result);
@@ -388,7 +479,7 @@ The standalone function version of this method:
388
479
 
389
480
  ```typescript
390
481
  import { SyllableSDKCore } from "syllable-sdk/core.js";
391
- import { incidentsList } from "syllable-sdk/funcs/incidentsList.js";
482
+ import { incidentsDelete } from "syllable-sdk/funcs/incidentsDelete.js";
392
483
 
393
484
  // Use `SyllableSDKCore` for best tree-shaking performance.
394
485
  // You can create one instance of it to use across an application.
@@ -397,7 +488,10 @@ const syllableSDK = new SyllableSDKCore({
397
488
  });
398
489
 
399
490
  async function run() {
400
- const res = await incidentsList(syllableSDK, {});
491
+ const res = await incidentsDelete(syllableSDK, {
492
+ incidentId: 545907,
493
+ reason: "<value>",
494
+ });
401
495
 
402
496
  if (!res.ok) {
403
497
  throw res.error;
@@ -416,14 +510,14 @@ run();
416
510
 
417
511
  | Parameter | Type | Required | Description |
418
512
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
419
- | `request` | [operations.IncidentListRequest](../../models/operations/incidentlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
513
+ | `request` | [operations.IncidentDeleteRequest](../../models/operations/incidentdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
420
514
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
421
515
  | `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. |
422
516
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
423
517
 
424
518
  ### Response
425
519
 
426
- **Promise\<[components.ServiceIncidentResponse[]](../../models/.md)\>**
520
+ **Promise\<[any](../../models/.md)\>**
427
521
 
428
522
  ### Errors
429
523
 
@@ -11,7 +11,7 @@ Operations related to insights results. An insight is a tool that processes
11
11
 
12
12
  ## list
13
13
 
14
- List the existing insight_tools
14
+ List the evaluated insights for sessions.
15
15
 
16
16
  ### Example Usage
17
17
 
@@ -11,6 +11,7 @@ Operations related to insights tools. An insight is a tool that processes
11
11
  * [create](#create) - Create Insight Tool
12
12
  * [getById](#getbyid) - Get Insight Tool By Id
13
13
  * [update](#update) - Update Insights Tool
14
+ * [insightsToolTest](#insightstooltest) - Test Insights Tool
14
15
  * [insightToolGetDefinitions](#insighttoolgetdefinitions) - Get Insight Tool Definitions
15
16
 
16
17
  ## list
@@ -108,7 +109,7 @@ run();
108
109
 
109
110
  ## create
110
111
 
111
- Create a new tool in the insights
112
+ Create a new insight tool.
112
113
 
113
114
  ### Example Usage
114
115
 
@@ -270,7 +271,7 @@ run();
270
271
 
271
272
  ## update
272
273
 
273
- Update a InsightTool.
274
+ Update an Insights tool.
274
275
 
275
276
  ### Example Usage
276
277
 
@@ -359,6 +360,85 @@ run();
359
360
  | errors.HTTPValidationError | 422 | application/json |
360
361
  | errors.SDKError | 4XX, 5XX | \*/\* |
361
362
 
363
+ ## insightsToolTest
364
+
365
+ Manually run the given insight tool against a session and return the response.
366
+
367
+ ### Example Usage
368
+
369
+ ```typescript
370
+ import { SyllableSDK } from "syllable-sdk";
371
+
372
+ const syllableSDK = new SyllableSDK({
373
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
374
+ });
375
+
376
+ async function run() {
377
+ const result = await syllableSDK.insights.tools.insightsToolTest({
378
+ toolName: "summary-tool",
379
+ sessionId: 283467,
380
+ });
381
+
382
+ // Handle the result
383
+ console.log(result);
384
+ }
385
+
386
+ run();
387
+ ```
388
+
389
+ ### Standalone function
390
+
391
+ The standalone function version of this method:
392
+
393
+ ```typescript
394
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
395
+ import { insightsToolsInsightsToolTest } from "syllable-sdk/funcs/insightsToolsInsightsToolTest.js";
396
+
397
+ // Use `SyllableSDKCore` for best tree-shaking performance.
398
+ // You can create one instance of it to use across an application.
399
+ const syllableSDK = new SyllableSDKCore({
400
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
401
+ });
402
+
403
+ async function run() {
404
+ const res = await insightsToolsInsightsToolTest(syllableSDK, {
405
+ toolName: "summary-tool",
406
+ sessionId: 283467,
407
+ });
408
+
409
+ if (!res.ok) {
410
+ throw res.error;
411
+ }
412
+
413
+ const { value: result } = res;
414
+
415
+ // Handle the result
416
+ console.log(result);
417
+ }
418
+
419
+ run();
420
+ ```
421
+
422
+ ### Parameters
423
+
424
+ | Parameter | Type | Required | Description |
425
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
426
+ | `request` | [components.InsightToolTestInput](../../models/components/insighttooltestinput.md) | :heavy_check_mark: | The request object to use for the request. |
427
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
428
+ | `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. |
429
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
430
+
431
+ ### Response
432
+
433
+ **Promise\<[any](../../models/.md)\>**
434
+
435
+ ### Errors
436
+
437
+ | Error Type | Status Code | Content Type |
438
+ | -------------------------- | -------------------------- | -------------------------- |
439
+ | errors.HTTPValidationError | 422 | application/json |
440
+ | errors.SDKError | 4XX, 5XX | \*/\* |
441
+
362
442
  ## insightToolGetDefinitions
363
443
 
364
444
  Get a InsightTool by Name.