syllable-sdk 0.1.0-alpha.72 → 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 (278) hide show
  1. package/README.md +28 -11
  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 +527 -0
  5. package/docs/sdks/insights/README.md +1 -1
  6. package/docs/sdks/syllablesdk/README.md +1 -1
  7. package/docs/sdks/syllablesdktools/README.md +82 -2
  8. package/docs/sdks/takeouts/README.md +11 -11
  9. package/docs/sdks/workflows/README.md +1 -1
  10. package/funcs/{outboundBatchesOutboundBatchRemove.d.ts → incidentsCreate.d.ts} +7 -4
  11. package/funcs/incidentsCreate.d.ts.map +1 -0
  12. package/funcs/incidentsCreate.js +102 -0
  13. package/funcs/incidentsCreate.js.map +1 -0
  14. package/funcs/incidentsDelete.d.ts +16 -0
  15. package/funcs/incidentsDelete.d.ts.map +1 -0
  16. package/funcs/incidentsDelete.js +112 -0
  17. package/funcs/incidentsDelete.js.map +1 -0
  18. package/funcs/incidentsGetById.d.ts +17 -0
  19. package/funcs/incidentsGetById.d.ts.map +1 -0
  20. package/funcs/incidentsGetById.js +108 -0
  21. package/funcs/incidentsGetById.js.map +1 -0
  22. package/funcs/incidentsIncidentGetOrganizations.d.ts +15 -0
  23. package/funcs/incidentsIncidentGetOrganizations.d.ts.map +1 -0
  24. package/funcs/incidentsIncidentGetOrganizations.js +89 -0
  25. package/funcs/incidentsIncidentGetOrganizations.js.map +1 -0
  26. package/funcs/incidentsList.d.ts +17 -0
  27. package/funcs/incidentsList.d.ts.map +1 -0
  28. package/funcs/incidentsList.js +114 -0
  29. package/funcs/incidentsList.js.map +1 -0
  30. package/funcs/incidentsUpdate.d.ts +16 -0
  31. package/funcs/incidentsUpdate.d.ts.map +1 -0
  32. package/funcs/incidentsUpdate.js +102 -0
  33. package/funcs/incidentsUpdate.js.map +1 -0
  34. package/funcs/insightsList.d.ts +1 -1
  35. package/funcs/insightsList.js +1 -1
  36. package/funcs/insightsToolsCreate.d.ts +1 -1
  37. package/funcs/insightsToolsCreate.js +3 -3
  38. package/funcs/insightsToolsCreate.js.map +1 -1
  39. package/funcs/insightsToolsInsightsToolTest.d.ts +16 -0
  40. package/funcs/insightsToolsInsightsToolTest.d.ts.map +1 -0
  41. package/funcs/insightsToolsInsightsToolTest.js +103 -0
  42. package/funcs/insightsToolsInsightsToolTest.js.map +1 -0
  43. package/funcs/insightsToolsUpdate.d.ts +1 -1
  44. package/funcs/insightsToolsUpdate.js +1 -1
  45. package/funcs/insightsWorkflowsQueueSessionsWorkflow.d.ts +1 -1
  46. package/funcs/insightsWorkflowsQueueSessionsWorkflow.js +1 -1
  47. package/funcs/{outboundBatchesOutboundBatchAdd.d.ts → outboundBatchesAdd.d.ts} +2 -2
  48. package/funcs/outboundBatchesAdd.d.ts.map +1 -0
  49. package/funcs/{outboundBatchesOutboundBatchAdd.js → outboundBatchesAdd.js} +3 -3
  50. package/funcs/outboundBatchesAdd.js.map +1 -0
  51. package/funcs/outboundBatchesList.d.ts +1 -1
  52. package/funcs/outboundBatchesList.d.ts.map +1 -1
  53. package/funcs/outboundBatchesList.js +1 -2
  54. package/funcs/outboundBatchesList.js.map +1 -1
  55. package/funcs/outboundBatchesRemove.d.ts +13 -0
  56. package/funcs/outboundBatchesRemove.d.ts.map +1 -0
  57. package/funcs/{outboundBatchesOutboundBatchRemove.js → outboundBatchesRemove.js} +3 -3
  58. package/funcs/outboundBatchesRemove.js.map +1 -0
  59. package/funcs/{outboundBatchesOutboundBatchResults.d.ts → outboundBatchesResults.d.ts} +2 -2
  60. package/funcs/outboundBatchesResults.d.ts.map +1 -0
  61. package/funcs/{outboundBatchesOutboundBatchResults.js → outboundBatchesResults.js} +8 -3
  62. package/funcs/outboundBatchesResults.js.map +1 -0
  63. package/funcs/outboundBatchesUpload.d.ts.map +1 -1
  64. package/funcs/outboundBatchesUpload.js +16 -12
  65. package/funcs/outboundBatchesUpload.js.map +1 -1
  66. package/funcs/outboundCampaignsList.d.ts +1 -1
  67. package/funcs/outboundCampaignsList.d.ts.map +1 -1
  68. package/funcs/outboundCampaignsList.js +1 -2
  69. package/funcs/outboundCampaignsList.js.map +1 -1
  70. package/funcs/{takeoutsCreateTakeoutApiV1TakeoutsCreatePost.d.ts → takeoutsCreate.d.ts} +2 -2
  71. package/funcs/takeoutsCreate.d.ts.map +1 -0
  72. package/funcs/{takeoutsCreateTakeoutApiV1TakeoutsCreatePost.js → takeoutsCreate.js} +4 -4
  73. package/funcs/takeoutsCreate.js.map +1 -0
  74. package/funcs/{takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.d.ts → takeoutsTakeoutsGetByJobId.d.ts} +2 -2
  75. package/funcs/takeoutsTakeoutsGetByJobId.d.ts.map +1 -0
  76. package/funcs/{takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.js → takeoutsTakeoutsGetByJobId.js} +5 -5
  77. package/funcs/takeoutsTakeoutsGetByJobId.js.map +1 -0
  78. package/jsr.json +1 -1
  79. package/lib/config.d.ts +2 -2
  80. package/lib/config.js +2 -2
  81. package/models/components/bodyoutboundbatchdelete.d.ts +1 -1
  82. package/models/components/bodyoutboundbatchdelete.d.ts.map +1 -1
  83. package/models/components/bodyoutboundbatchdelete.js +10 -1
  84. package/models/components/bodyoutboundbatchdelete.js.map +1 -1
  85. package/models/components/bodyoutboundbatchupload.d.ts +2 -2
  86. package/models/components/bodyoutboundbatchupload.d.ts.map +1 -1
  87. package/models/components/bodyoutboundbatchupload.js +2 -2
  88. package/models/components/bodyoutboundbatchupload.js.map +1 -1
  89. package/models/components/communicationrequest.d.ts +0 -11
  90. package/models/components/communicationrequest.d.ts.map +1 -1
  91. package/models/components/communicationrequest.js +0 -9
  92. package/models/components/communicationrequest.js.map +1 -1
  93. package/models/components/communicationrequestresult.d.ts +39 -14
  94. package/models/components/communicationrequestresult.d.ts.map +1 -1
  95. package/models/components/communicationrequestresult.js +38 -14
  96. package/models/components/communicationrequestresult.js.map +1 -1
  97. package/models/components/conversation.d.ts +10 -0
  98. package/models/components/conversation.d.ts.map +1 -1
  99. package/models/components/conversation.js +8 -0
  100. package/models/components/conversation.js.map +1 -1
  101. package/models/components/incidentcreaterequest.d.ts +75 -0
  102. package/models/components/incidentcreaterequest.d.ts.map +1 -0
  103. package/models/components/incidentcreaterequest.js +96 -0
  104. package/models/components/incidentcreaterequest.js.map +1 -0
  105. package/models/components/incidentorganizationresponse.d.ts +33 -0
  106. package/models/components/incidentorganizationresponse.d.ts.map +1 -0
  107. package/models/components/incidentorganizationresponse.js +72 -0
  108. package/models/components/incidentorganizationresponse.js.map +1 -0
  109. package/models/components/incidentproperties.d.ts +64 -0
  110. package/models/components/incidentproperties.d.ts.map +1 -0
  111. package/models/components/{requeststatus.js → incidentproperties.js} +25 -19
  112. package/models/components/incidentproperties.js.map +1 -0
  113. package/models/components/incidentresponse.d.ts +90 -0
  114. package/models/components/incidentresponse.d.ts.map +1 -0
  115. package/models/components/incidentresponse.js +106 -0
  116. package/models/components/incidentresponse.js.map +1 -0
  117. package/models/components/incidentupdaterequest.d.ts +90 -0
  118. package/models/components/incidentupdaterequest.d.ts.map +1 -0
  119. package/models/components/incidentupdaterequest.js +106 -0
  120. package/models/components/incidentupdaterequest.js.map +1 -0
  121. package/models/components/index.d.ts +9 -1
  122. package/models/components/index.d.ts.map +1 -1
  123. package/models/components/index.js +9 -1
  124. package/models/components/index.js.map +1 -1
  125. package/models/components/insighttooltestinput.d.ts +40 -0
  126. package/models/components/insighttooltestinput.d.ts.map +1 -0
  127. package/models/components/insighttooltestinput.js +72 -0
  128. package/models/components/insighttooltestinput.js.map +1 -0
  129. package/models/components/listresponsecommunicationbatch.d.ts +53 -0
  130. package/models/components/listresponsecommunicationbatch.d.ts.map +1 -0
  131. package/models/components/listresponsecommunicationbatch.js +81 -0
  132. package/models/components/listresponsecommunicationbatch.js.map +1 -0
  133. package/models/components/listresponseincidentresponse.d.ts +53 -0
  134. package/models/components/listresponseincidentresponse.d.ts.map +1 -0
  135. package/models/components/listresponseincidentresponse.js +81 -0
  136. package/models/components/listresponseincidentresponse.js.map +1 -0
  137. package/models/components/listresponseoutboundcampaign.d.ts +53 -0
  138. package/models/components/listresponseoutboundcampaign.d.ts.map +1 -0
  139. package/models/components/listresponseoutboundcampaign.js +81 -0
  140. package/models/components/listresponseoutboundcampaign.js.map +1 -0
  141. package/models/components/outboundcampaign.d.ts +10 -0
  142. package/models/components/outboundcampaign.d.ts.map +1 -1
  143. package/models/components/outboundcampaign.js +4 -0
  144. package/models/components/outboundcampaign.js.map +1 -1
  145. package/models/components/outboundcampaigninput.d.ts +10 -0
  146. package/models/components/outboundcampaigninput.d.ts.map +1 -1
  147. package/models/components/outboundcampaigninput.js +4 -0
  148. package/models/components/outboundcampaigninput.js.map +1 -1
  149. package/models/components/promptcreaterequest.d.ts +1 -1
  150. package/models/components/promptupdaterequest.d.ts +1 -1
  151. package/models/operations/incidentdelete.d.ts +31 -0
  152. package/models/operations/incidentdelete.d.ts.map +1 -0
  153. package/models/operations/incidentdelete.js +70 -0
  154. package/models/operations/incidentdelete.js.map +1 -0
  155. package/models/operations/incidentgetbyid.d.ts +29 -0
  156. package/models/operations/incidentgetbyid.d.ts.map +1 -0
  157. package/models/operations/incidentgetbyid.js +68 -0
  158. package/models/operations/incidentgetbyid.js.map +1 -0
  159. package/models/operations/incidentlist.d.ts +73 -0
  160. package/models/operations/incidentlist.d.ts.map +1 -0
  161. package/models/operations/incidentlist.js +101 -0
  162. package/models/operations/incidentlist.js.map +1 -0
  163. package/models/operations/index.d.ts +4 -1
  164. package/models/operations/index.d.ts.map +1 -1
  165. package/models/operations/index.js +4 -1
  166. package/models/operations/index.js.map +1 -1
  167. package/models/operations/outboundbatchresults.d.ts +4 -0
  168. package/models/operations/outboundbatchresults.d.ts.map +1 -1
  169. package/models/operations/outboundbatchresults.js +6 -0
  170. package/models/operations/outboundbatchresults.js.map +1 -1
  171. package/models/operations/outboundbatchupload.d.ts +2 -2
  172. package/models/operations/outboundbatchupload.d.ts.map +1 -1
  173. package/models/operations/outboundbatchupload.js +4 -2
  174. package/models/operations/outboundbatchupload.js.map +1 -1
  175. package/models/operations/takeoutsgetbyjobid.d.ts +29 -0
  176. package/models/operations/takeoutsgetbyjobid.d.ts.map +1 -0
  177. package/models/operations/{gettakeoutapiv1takeoutsgetjobidget.js → takeoutsgetbyjobid.js} +17 -17
  178. package/models/operations/takeoutsgetbyjobid.js.map +1 -0
  179. package/openapi.json +1449 -224
  180. package/package.json +1 -1
  181. package/sdk/batches.d.ts +4 -4
  182. package/sdk/batches.d.ts.map +1 -1
  183. package/sdk/batches.js +9 -9
  184. package/sdk/batches.js.map +1 -1
  185. package/sdk/campaigns.d.ts +1 -1
  186. package/sdk/campaigns.d.ts.map +1 -1
  187. package/sdk/incidents.d.ts +48 -0
  188. package/sdk/incidents.d.ts.map +1 -0
  189. package/sdk/incidents.js +72 -0
  190. package/sdk/incidents.js.map +1 -0
  191. package/sdk/insights.d.ts +1 -1
  192. package/sdk/insights.js +1 -1
  193. package/sdk/sdk.d.ts +3 -0
  194. package/sdk/sdk.d.ts.map +1 -1
  195. package/sdk/sdk.js +4 -0
  196. package/sdk/sdk.js.map +1 -1
  197. package/sdk/syllablesdktools.d.ts +9 -2
  198. package/sdk/syllablesdktools.d.ts.map +1 -1
  199. package/sdk/syllablesdktools.js +12 -2
  200. package/sdk/syllablesdktools.js.map +1 -1
  201. package/sdk/takeouts.d.ts +2 -2
  202. package/sdk/takeouts.d.ts.map +1 -1
  203. package/sdk/takeouts.js +6 -6
  204. package/sdk/takeouts.js.map +1 -1
  205. package/sdk/workflows.d.ts +1 -1
  206. package/sdk/workflows.js +1 -1
  207. package/src/funcs/incidentsCreate.ts +135 -0
  208. package/src/funcs/incidentsDelete.ts +147 -0
  209. package/src/funcs/incidentsGetById.ts +142 -0
  210. package/src/funcs/incidentsIncidentGetOrganizations.ts +112 -0
  211. package/src/funcs/incidentsList.ts +148 -0
  212. package/src/funcs/incidentsUpdate.ts +135 -0
  213. package/src/funcs/insightsList.ts +1 -1
  214. package/src/funcs/insightsToolsCreate.ts +4 -4
  215. package/src/funcs/insightsToolsInsightsToolTest.ts +136 -0
  216. package/src/funcs/insightsToolsUpdate.ts +1 -1
  217. package/src/funcs/insightsWorkflowsQueueSessionsWorkflow.ts +1 -1
  218. package/src/funcs/{outboundBatchesOutboundBatchAdd.ts → outboundBatchesAdd.ts} +1 -1
  219. package/src/funcs/outboundBatchesList.ts +3 -4
  220. package/src/funcs/{outboundBatchesOutboundBatchRemove.ts → outboundBatchesRemove.ts} +1 -1
  221. package/src/funcs/{outboundBatchesOutboundBatchResults.ts → outboundBatchesResults.ts} +8 -2
  222. package/src/funcs/outboundBatchesUpload.ts +23 -20
  223. package/src/funcs/outboundCampaignsList.ts +3 -4
  224. package/src/funcs/{takeoutsCreateTakeoutApiV1TakeoutsCreatePost.ts → takeoutsCreate.ts} +2 -2
  225. package/src/funcs/{takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.ts → takeoutsTakeoutsGetByJobId.ts} +4 -7
  226. package/src/lib/config.ts +2 -2
  227. package/src/models/components/bodyoutboundbatchdelete.ts +11 -2
  228. package/src/models/components/bodyoutboundbatchupload.ts +4 -4
  229. package/src/models/components/communicationrequest.ts +0 -23
  230. package/src/models/components/communicationrequestresult.ts +78 -30
  231. package/src/models/components/conversation.ts +18 -0
  232. package/src/models/components/incidentcreaterequest.ts +153 -0
  233. package/src/models/components/incidentorganizationresponse.ts +85 -0
  234. package/src/models/components/incidentproperties.ts +49 -0
  235. package/src/models/components/incidentresponse.ts +182 -0
  236. package/src/models/components/incidentupdaterequest.ts +182 -0
  237. package/src/models/components/index.ts +9 -1
  238. package/src/models/components/insighttooltestinput.ts +90 -0
  239. package/src/models/components/listresponsecommunicationbatch.ts +118 -0
  240. package/src/models/components/listresponseincidentresponse.ts +118 -0
  241. package/src/models/components/listresponseoutboundcampaign.ts +118 -0
  242. package/src/models/components/outboundcampaign.ts +14 -0
  243. package/src/models/components/outboundcampaigninput.ts +14 -0
  244. package/src/models/components/promptcreaterequest.ts +1 -1
  245. package/src/models/components/promptupdaterequest.ts +1 -1
  246. package/src/models/operations/incidentdelete.ts +79 -0
  247. package/src/models/operations/incidentgetbyid.ts +75 -0
  248. package/src/models/operations/incidentlist.ts +151 -0
  249. package/src/models/operations/index.ts +4 -1
  250. package/src/models/operations/outboundbatchresults.ts +10 -0
  251. package/src/models/operations/outboundbatchupload.ts +8 -4
  252. package/src/models/operations/takeoutsgetbyjobid.ts +75 -0
  253. package/src/sdk/batches.ts +10 -10
  254. package/src/sdk/campaigns.ts +1 -1
  255. package/src/sdk/incidents.ts +116 -0
  256. package/src/sdk/insights.ts +1 -1
  257. package/src/sdk/sdk.ts +6 -0
  258. package/src/sdk/syllablesdktools.ts +20 -2
  259. package/src/sdk/takeouts.ts +7 -7
  260. package/src/sdk/workflows.ts +1 -1
  261. package/funcs/outboundBatchesOutboundBatchAdd.d.ts.map +0 -1
  262. package/funcs/outboundBatchesOutboundBatchAdd.js.map +0 -1
  263. package/funcs/outboundBatchesOutboundBatchRemove.d.ts.map +0 -1
  264. package/funcs/outboundBatchesOutboundBatchRemove.js.map +0 -1
  265. package/funcs/outboundBatchesOutboundBatchResults.d.ts.map +0 -1
  266. package/funcs/outboundBatchesOutboundBatchResults.js.map +0 -1
  267. package/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.d.ts.map +0 -1
  268. package/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.js.map +0 -1
  269. package/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.d.ts.map +0 -1
  270. package/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.js.map +0 -1
  271. package/models/components/requeststatus.d.ts +0 -46
  272. package/models/components/requeststatus.d.ts.map +0 -1
  273. package/models/components/requeststatus.js.map +0 -1
  274. package/models/operations/gettakeoutapiv1takeoutsgetjobidget.d.ts +0 -29
  275. package/models/operations/gettakeoutapiv1takeoutsgetjobidget.d.ts.map +0 -1
  276. package/models/operations/gettakeoutapiv1takeoutsgetjobidget.js.map +0 -1
  277. package/src/models/components/requeststatus.ts +0 -43
  278. package/src/models/operations/gettakeoutapiv1takeoutsgetjobidget.ts +0 -87
package/openapi.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "openapi": "3.1.0",
3
3
  "info": {
4
4
  "title": "SyllableSDK",
5
- "description": "\n# Syllable Platform SDK\n\nSyllable SDK gives you the power of awesome AI agentry. 🚀\n\n## Overview\n\nThe Syllable SDK provides a comprehensive set of tools and APIs to integrate powerful AI \ncapabilities into your communication applications. Whether you're building chatbots, virtual\nassistants, or any other AI-driven solutions, Syllable SDK has got you covered.\n\n## Features\n\n- **Natural Language Processing (NLP)**: Understand and generate human language with ease.\n- **Machine Learning Models**: Leverage pre-trained models or train your own custom models.\n- **Speech Recognition**: Convert speech to text and vice versa.\n- **Data Analytics**: Analyze and visualize data to gain insights.\n- **Integration**: Seamlessly integrate with other services and platforms.\n\n",
5
+ "description": "\n# Syllable Platform SDK\n\nSyllable SDK gives you the power of awesome AI agentry. 🚀\n\n## Overview\n\nThe Syllable SDK provides a comprehensive set of tools and APIs to integrate powerful AI\ncapabilities into your communication applications. Whether you're building chatbots, virtual\nassistants, or any other AI-driven solutions, Syllable SDK has got you covered.\n\n## Features\n\n- **Natural Language Processing (NLP)**: Understand and generate human language with ease.\n- **Machine Learning Models**: Leverage pre-trained models or train your own custom models.\n- **Speech Recognition**: Convert speech to text and vice versa.\n- **Data Analytics**: Analyze and visualize data to gain insights.\n- **Integration**: Seamlessly integrate with other services and platforms.\n\n",
6
6
  "version": "0.0.2"
7
7
  },
8
8
  "servers": [
@@ -1592,6 +1592,451 @@
1592
1592
  }
1593
1593
  }
1594
1594
  },
1595
+ "/api/v1/incidents/": {
1596
+ "get": {
1597
+ "tags": [
1598
+ "incidents",
1599
+ "V1"
1600
+ ],
1601
+ "summary": "List Incidents",
1602
+ "description": "List service incidents with pagination and filtering",
1603
+ "operationId": "incident_list",
1604
+ "security": [
1605
+ {
1606
+ "APIKeyHeader": []
1607
+ }
1608
+ ],
1609
+ "parameters": [
1610
+ {
1611
+ "name": "page",
1612
+ "in": "query",
1613
+ "required": false,
1614
+ "schema": {
1615
+ "anyOf": [
1616
+ {
1617
+ "type": "integer",
1618
+ "minimum": 0
1619
+ },
1620
+ {
1621
+ "type": "null"
1622
+ }
1623
+ ],
1624
+ "description": "The page number from which to start (0-based)",
1625
+ "examples": [
1626
+ 0
1627
+ ],
1628
+ "default": 0,
1629
+ "title": "Page"
1630
+ },
1631
+ "description": "The page number from which to start (0-based)"
1632
+ },
1633
+ {
1634
+ "name": "limit",
1635
+ "in": "query",
1636
+ "required": false,
1637
+ "schema": {
1638
+ "type": "integer",
1639
+ "minimum": 0,
1640
+ "description": "The maximum number of items to return",
1641
+ "examples": [
1642
+ 25
1643
+ ],
1644
+ "default": 25,
1645
+ "title": "Limit"
1646
+ },
1647
+ "description": "The maximum number of items to return"
1648
+ },
1649
+ {
1650
+ "name": "search_fields",
1651
+ "in": "query",
1652
+ "required": false,
1653
+ "schema": {
1654
+ "type": "array",
1655
+ "items": {
1656
+ "$ref": "#/components/schemas/IncidentProperties"
1657
+ },
1658
+ "description": "String names of fields to search. Correspond by index to search field values",
1659
+ "examples": [
1660
+ "name"
1661
+ ],
1662
+ "default": [],
1663
+ "title": "Search Fields"
1664
+ },
1665
+ "description": "String names of fields to search. Correspond by index to search field values"
1666
+ },
1667
+ {
1668
+ "name": "search_field_values",
1669
+ "in": "query",
1670
+ "required": false,
1671
+ "schema": {
1672
+ "type": "array",
1673
+ "items": {
1674
+ "type": "string"
1675
+ },
1676
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
1677
+ "examples": [
1678
+ "Some Object Name"
1679
+ ],
1680
+ "default": [],
1681
+ "title": "Search Field Values"
1682
+ },
1683
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
1684
+ },
1685
+ {
1686
+ "name": "order_by",
1687
+ "in": "query",
1688
+ "required": false,
1689
+ "schema": {
1690
+ "anyOf": [
1691
+ {
1692
+ "$ref": "#/components/schemas/IncidentProperties"
1693
+ },
1694
+ {
1695
+ "type": "null"
1696
+ }
1697
+ ],
1698
+ "description": "The field whose value should be used to order the results",
1699
+ "examples": [
1700
+ "name"
1701
+ ],
1702
+ "title": "Order By"
1703
+ },
1704
+ "description": "The field whose value should be used to order the results"
1705
+ },
1706
+ {
1707
+ "name": "order_by_direction",
1708
+ "in": "query",
1709
+ "required": false,
1710
+ "schema": {
1711
+ "anyOf": [
1712
+ {
1713
+ "$ref": "#/components/schemas/OrderByDirection"
1714
+ },
1715
+ {
1716
+ "type": "null"
1717
+ }
1718
+ ],
1719
+ "description": "The direction in which to order the results",
1720
+ "title": "Order By Direction"
1721
+ },
1722
+ "description": "The direction in which to order the results"
1723
+ },
1724
+ {
1725
+ "name": "fields",
1726
+ "in": "query",
1727
+ "required": false,
1728
+ "schema": {
1729
+ "anyOf": [
1730
+ {
1731
+ "type": "array",
1732
+ "items": {
1733
+ "$ref": "#/components/schemas/IncidentProperties"
1734
+ }
1735
+ },
1736
+ {
1737
+ "type": "null"
1738
+ }
1739
+ ],
1740
+ "description": "The fields to include in the response",
1741
+ "default": [],
1742
+ "title": "Fields"
1743
+ },
1744
+ "description": "The fields to include in the response"
1745
+ },
1746
+ {
1747
+ "name": "start_datetime",
1748
+ "in": "query",
1749
+ "required": false,
1750
+ "schema": {
1751
+ "anyOf": [
1752
+ {
1753
+ "type": "string"
1754
+ },
1755
+ {
1756
+ "type": "null"
1757
+ }
1758
+ ],
1759
+ "description": "The start datetime for filtering results",
1760
+ "examples": [
1761
+ "2023-01-01T00:00:00Z"
1762
+ ],
1763
+ "title": "Start Datetime"
1764
+ },
1765
+ "description": "The start datetime for filtering results"
1766
+ },
1767
+ {
1768
+ "name": "end_datetime",
1769
+ "in": "query",
1770
+ "required": false,
1771
+ "schema": {
1772
+ "anyOf": [
1773
+ {
1774
+ "type": "string"
1775
+ },
1776
+ {
1777
+ "type": "null"
1778
+ }
1779
+ ],
1780
+ "description": "The end datetime for filtering results",
1781
+ "examples": [
1782
+ "2024-01-01T00:00:00Z"
1783
+ ],
1784
+ "title": "End Datetime"
1785
+ },
1786
+ "description": "The end datetime for filtering results"
1787
+ }
1788
+ ],
1789
+ "responses": {
1790
+ "200": {
1791
+ "description": "Successful Response",
1792
+ "content": {
1793
+ "application/json": {
1794
+ "schema": {
1795
+ "$ref": "#/components/schemas/ListResponse_IncidentResponse_"
1796
+ }
1797
+ }
1798
+ }
1799
+ },
1800
+ "422": {
1801
+ "description": "Validation Error",
1802
+ "content": {
1803
+ "application/json": {
1804
+ "schema": {
1805
+ "$ref": "#/components/schemas/HTTPValidationError"
1806
+ }
1807
+ }
1808
+ }
1809
+ }
1810
+ }
1811
+ },
1812
+ "post": {
1813
+ "tags": [
1814
+ "incidents",
1815
+ "V1"
1816
+ ],
1817
+ "summary": "Create Incident",
1818
+ "description": "Create a new incident",
1819
+ "operationId": "incident_create",
1820
+ "security": [
1821
+ {
1822
+ "APIKeyHeader": []
1823
+ }
1824
+ ],
1825
+ "requestBody": {
1826
+ "required": true,
1827
+ "content": {
1828
+ "application/json": {
1829
+ "schema": {
1830
+ "$ref": "#/components/schemas/IncidentCreateRequest"
1831
+ }
1832
+ }
1833
+ }
1834
+ },
1835
+ "responses": {
1836
+ "200": {
1837
+ "description": "Successful Response",
1838
+ "content": {
1839
+ "application/json": {
1840
+ "schema": {
1841
+ "$ref": "#/components/schemas/IncidentResponse"
1842
+ }
1843
+ }
1844
+ }
1845
+ },
1846
+ "422": {
1847
+ "description": "Validation Error",
1848
+ "content": {
1849
+ "application/json": {
1850
+ "schema": {
1851
+ "$ref": "#/components/schemas/HTTPValidationError"
1852
+ }
1853
+ }
1854
+ }
1855
+ }
1856
+ }
1857
+ },
1858
+ "put": {
1859
+ "tags": [
1860
+ "incidents",
1861
+ "V1"
1862
+ ],
1863
+ "summary": "Update Incident",
1864
+ "description": "Update an existing incident",
1865
+ "operationId": "incident_update",
1866
+ "security": [
1867
+ {
1868
+ "APIKeyHeader": []
1869
+ }
1870
+ ],
1871
+ "requestBody": {
1872
+ "required": true,
1873
+ "content": {
1874
+ "application/json": {
1875
+ "schema": {
1876
+ "$ref": "#/components/schemas/IncidentUpdateRequest"
1877
+ }
1878
+ }
1879
+ }
1880
+ },
1881
+ "responses": {
1882
+ "200": {
1883
+ "description": "Successful Response",
1884
+ "content": {
1885
+ "application/json": {
1886
+ "schema": {
1887
+ "$ref": "#/components/schemas/IncidentResponse"
1888
+ }
1889
+ }
1890
+ }
1891
+ },
1892
+ "422": {
1893
+ "description": "Validation Error",
1894
+ "content": {
1895
+ "application/json": {
1896
+ "schema": {
1897
+ "$ref": "#/components/schemas/HTTPValidationError"
1898
+ }
1899
+ }
1900
+ }
1901
+ }
1902
+ }
1903
+ }
1904
+ },
1905
+ "/api/v1/incidents/organizations": {
1906
+ "get": {
1907
+ "tags": [
1908
+ "incidents",
1909
+ "V1"
1910
+ ],
1911
+ "summary": "Get Organizations",
1912
+ "description": "Get all organizations",
1913
+ "operationId": "incident_get_organizations",
1914
+ "responses": {
1915
+ "200": {
1916
+ "description": "Successful Response",
1917
+ "content": {
1918
+ "application/json": {
1919
+ "schema": {
1920
+ "items": {
1921
+ "$ref": "#/components/schemas/IncidentOrganizationResponse"
1922
+ },
1923
+ "type": "array",
1924
+ "title": "Response Incident Get Organizations"
1925
+ }
1926
+ }
1927
+ }
1928
+ }
1929
+ },
1930
+ "security": [
1931
+ {
1932
+ "APIKeyHeader": []
1933
+ }
1934
+ ]
1935
+ }
1936
+ },
1937
+ "/api/v1/incidents/{incident_id}": {
1938
+ "get": {
1939
+ "tags": [
1940
+ "incidents",
1941
+ "V1"
1942
+ ],
1943
+ "summary": "Get Incident By Id",
1944
+ "description": "Get incident by ID",
1945
+ "operationId": "incident_get_by_id",
1946
+ "security": [
1947
+ {
1948
+ "APIKeyHeader": []
1949
+ }
1950
+ ],
1951
+ "parameters": [
1952
+ {
1953
+ "name": "incident_id",
1954
+ "in": "path",
1955
+ "required": true,
1956
+ "schema": {
1957
+ "type": "integer",
1958
+ "title": "Incident Id"
1959
+ }
1960
+ }
1961
+ ],
1962
+ "responses": {
1963
+ "200": {
1964
+ "description": "Successful Response",
1965
+ "content": {
1966
+ "application/json": {
1967
+ "schema": {
1968
+ "$ref": "#/components/schemas/IncidentResponse"
1969
+ }
1970
+ }
1971
+ }
1972
+ },
1973
+ "422": {
1974
+ "description": "Validation Error",
1975
+ "content": {
1976
+ "application/json": {
1977
+ "schema": {
1978
+ "$ref": "#/components/schemas/HTTPValidationError"
1979
+ }
1980
+ }
1981
+ }
1982
+ }
1983
+ }
1984
+ },
1985
+ "delete": {
1986
+ "tags": [
1987
+ "incidents",
1988
+ "V1"
1989
+ ],
1990
+ "summary": "Delete Incident",
1991
+ "description": "Delete an incident by ID",
1992
+ "operationId": "incident_delete",
1993
+ "security": [
1994
+ {
1995
+ "APIKeyHeader": []
1996
+ }
1997
+ ],
1998
+ "parameters": [
1999
+ {
2000
+ "name": "incident_id",
2001
+ "in": "path",
2002
+ "required": true,
2003
+ "schema": {
2004
+ "type": "integer",
2005
+ "title": "Incident Id"
2006
+ }
2007
+ },
2008
+ {
2009
+ "name": "reason",
2010
+ "in": "query",
2011
+ "required": true,
2012
+ "schema": {
2013
+ "type": "string",
2014
+ "title": "Reason"
2015
+ }
2016
+ }
2017
+ ],
2018
+ "responses": {
2019
+ "200": {
2020
+ "description": "Successful Response",
2021
+ "content": {
2022
+ "application/json": {
2023
+ "schema": {}
2024
+ }
2025
+ }
2026
+ },
2027
+ "422": {
2028
+ "description": "Validation Error",
2029
+ "content": {
2030
+ "application/json": {
2031
+ "schema": {
2032
+ "$ref": "#/components/schemas/HTTPValidationError"
2033
+ }
2034
+ }
2035
+ }
2036
+ }
2037
+ }
2038
+ }
2039
+ },
1595
2040
  "/api/v1/insights/": {
1596
2041
  "get": {
1597
2042
  "tags": [
@@ -1599,7 +2044,7 @@
1599
2044
  "V1"
1600
2045
  ],
1601
2046
  "summary": "Insights List",
1602
- "description": "List the existing insight_tools",
2047
+ "description": "List the evaluated insights for sessions.",
1603
2048
  "operationId": "insights_list",
1604
2049
  "security": [
1605
2050
  {
@@ -2253,7 +2698,7 @@
2253
2698
  "V1"
2254
2699
  ],
2255
2700
  "summary": "Queue Insights Workflow For Sessions",
2256
- "description": "Delete a Insights workflow.",
2701
+ "description": "Manually queue sessions for insights workflow evaluation.",
2257
2702
  "operationId": "queue_sessions_workflow",
2258
2703
  "requestBody": {
2259
2704
  "content": {
@@ -2524,7 +2969,7 @@
2524
2969
  "V1"
2525
2970
  ],
2526
2971
  "summary": "Create Insight Tool",
2527
- "description": "Create a new tool in the insights",
2972
+ "description": "Create a new insight tool.",
2528
2973
  "operationId": "insights_tool_create",
2529
2974
  "security": [
2530
2975
  {
@@ -2552,6 +2997,12 @@
2552
2997
  }
2553
2998
  }
2554
2999
  },
3000
+ "400": {
3001
+ "description": "Bad Request"
3002
+ },
3003
+ "500": {
3004
+ "description": "Internal Server Error"
3005
+ },
2555
3006
  "422": {
2556
3007
  "description": "Validation Error",
2557
3008
  "content": {
@@ -2619,7 +3070,7 @@
2619
3070
  "V1"
2620
3071
  ],
2621
3072
  "summary": "Update Insights Tool",
2622
- "description": "Update a InsightTool.",
3073
+ "description": "Update an Insights tool.",
2623
3074
  "operationId": "insights_tool_update",
2624
3075
  "security": [
2625
3076
  {
@@ -2683,6 +3134,61 @@
2683
3134
  }
2684
3135
  }
2685
3136
  },
3137
+ "/api/v1/insights/tools-test": {
3138
+ "post": {
3139
+ "tags": [
3140
+ "insights.tools",
3141
+ "V1"
3142
+ ],
3143
+ "summary": "Test Insights Tool",
3144
+ "description": "Manually run the given insight tool against a session and return the response.",
3145
+ "operationId": "insights_tool_test",
3146
+ "requestBody": {
3147
+ "content": {
3148
+ "application/json": {
3149
+ "schema": {
3150
+ "$ref": "#/components/schemas/InsightToolTestInput"
3151
+ }
3152
+ }
3153
+ },
3154
+ "required": true
3155
+ },
3156
+ "responses": {
3157
+ "200": {
3158
+ "description": "Successful Response",
3159
+ "content": {
3160
+ "application/json": {
3161
+ "schema": {}
3162
+ }
3163
+ }
3164
+ },
3165
+ "400": {
3166
+ "description": "Bad Request"
3167
+ },
3168
+ "404": {
3169
+ "description": "Not Found"
3170
+ },
3171
+ "500": {
3172
+ "description": "Internal Server Error"
3173
+ },
3174
+ "422": {
3175
+ "description": "Validation Error",
3176
+ "content": {
3177
+ "application/json": {
3178
+ "schema": {
3179
+ "$ref": "#/components/schemas/HTTPValidationError"
3180
+ }
3181
+ }
3182
+ }
3183
+ }
3184
+ },
3185
+ "security": [
3186
+ {
3187
+ "APIKeyHeader": []
3188
+ }
3189
+ ]
3190
+ }
3191
+ },
2686
3192
  "/api/v1/insights/tool-definitions": {
2687
3193
  "get": {
2688
3194
  "tags": [
@@ -7174,11 +7680,7 @@
7174
7680
  "content": {
7175
7681
  "application/json": {
7176
7682
  "schema": {
7177
- "type": "array",
7178
- "items": {
7179
- "$ref": "#/components/schemas/CommunicationBatch"
7180
- },
7181
- "title": "Response Outbound Batch List"
7683
+ "$ref": "#/components/schemas/ListResponse_CommunicationBatch_"
7182
7684
  }
7183
7685
  }
7184
7686
  }
@@ -7432,7 +7934,6 @@
7432
7934
  }
7433
7935
  ],
7434
7936
  "requestBody": {
7435
- "required": true,
7436
7937
  "content": {
7437
7938
  "multipart/form-data": {
7438
7939
  "schema": {
@@ -7485,6 +7986,24 @@
7485
7986
  "type": "string",
7486
7987
  "title": "Batch Id"
7487
7988
  }
7989
+ },
7990
+ {
7991
+ "name": "reference_id",
7992
+ "in": "query",
7993
+ "required": false,
7994
+ "schema": {
7995
+ "type": "string",
7996
+ "title": "Reference Id"
7997
+ }
7998
+ },
7999
+ {
8000
+ "name": "status",
8001
+ "in": "query",
8002
+ "required": false,
8003
+ "schema": {
8004
+ "type": "string",
8005
+ "title": "Status"
8006
+ }
7488
8007
  }
7489
8008
  ],
7490
8009
  "responses": {
@@ -7832,10 +8351,7 @@
7832
8351
  "schema": {
7833
8352
  "anyOf": [
7834
8353
  {
7835
- "type": "array",
7836
- "items": {
7837
- "$ref": "#/components/schemas/OutboundCampaign"
7838
- }
8354
+ "$ref": "#/components/schemas/ListResponse_OutboundCampaign_"
7839
8355
  },
7840
8356
  {
7841
8357
  "type": "null"
@@ -8436,7 +8952,7 @@
8436
8952
  "V1"
8437
8953
  ],
8438
8954
  "summary": "Create Takeout",
8439
- "operationId": "create_takeout_api_v1_takeouts_create_post",
8955
+ "operationId": "takeouts_create",
8440
8956
  "responses": {
8441
8957
  "200": {
8442
8958
  "description": "Successful Response",
@@ -8463,7 +8979,7 @@
8463
8979
  "V1"
8464
8980
  ],
8465
8981
  "summary": "Get Takeout",
8466
- "operationId": "get_takeout_api_v1_takeouts_get__job_id__get",
8982
+ "operationId": "takeouts_get_by_job_id",
8467
8983
  "security": [
8468
8984
  {
8469
8985
  "APIKeyHeader": []
@@ -9641,7 +10157,7 @@
9641
10157
  "title": "Batch Id",
9642
10158
  "description": "Unique ID for conversation batch",
9643
10159
  "examples": [
9644
- "20250117.9"
10160
+ "20250407.9"
9645
10161
  ]
9646
10162
  },
9647
10163
  "campaign_id": {
@@ -9664,7 +10180,7 @@
9664
10180
  "title": "Expires On",
9665
10181
  "description": "Timestamp of batch expiration",
9666
10182
  "examples": [
9667
- "2024-01-01T00:00:00Z"
10183
+ "2025-04-07T00:00:00Z"
9668
10184
  ]
9669
10185
  },
9670
10186
  "status": {
@@ -9700,7 +10216,7 @@
9700
10216
  "title": "Created At",
9701
10217
  "description": "Timestamp of batch creation",
9702
10218
  "examples": [
9703
- "2024-01-01T00:00:00Z"
10219
+ "2025-04-07T00:00:00Z"
9704
10220
  ]
9705
10221
  },
9706
10222
  "deleted_at": {
@@ -9715,7 +10231,7 @@
9715
10231
  "title": "Deleted At",
9716
10232
  "description": "Timestamp of batch deletion",
9717
10233
  "examples": [
9718
- "2024-01-01T00:00:00Z"
10234
+ "2025-04-07T00:00:00Z"
9719
10235
  ]
9720
10236
  },
9721
10237
  "deleted_reason": {
@@ -9745,7 +10261,7 @@
9745
10261
  "title": "Last Worked On",
9746
10262
  "description": "Timestamp of last batch activity",
9747
10263
  "examples": [
9748
- "2024-01-01T00:00:00Z"
10264
+ "2025-04-07T00:00:00Z"
9749
10265
  ]
9750
10266
  },
9751
10267
  "last_updated_by": {
@@ -9826,14 +10342,14 @@
9826
10342
  },
9827
10343
  "Body_outbound_batch_delete": {
9828
10344
  "properties": {
9829
- "deleteReason": {
10345
+ "delete_reason": {
9830
10346
  "type": "string",
9831
- "title": "Deletereason"
10347
+ "title": "Delete Reason"
9832
10348
  }
9833
10349
  },
9834
10350
  "type": "object",
9835
10351
  "required": [
9836
- "deleteReason"
10352
+ "delete_reason"
9837
10353
  ],
9838
10354
  "title": "Body_outbound_batch_delete"
9839
10355
  },
@@ -9846,9 +10362,6 @@
9846
10362
  }
9847
10363
  },
9848
10364
  "type": "object",
9849
- "required": [
9850
- "file"
9851
- ],
9852
10365
  "title": "Body_outbound_batch_upload"
9853
10366
  },
9854
10367
  "CampaignProperties": {
@@ -10220,7 +10733,7 @@
10220
10733
  "title": "Batch Id",
10221
10734
  "description": "Unique ID for conversation batch",
10222
10735
  "examples": [
10223
- "20250117.9"
10736
+ "20250407.9"
10224
10737
  ]
10225
10738
  },
10226
10739
  "campaign_id": {
@@ -10243,7 +10756,7 @@
10243
10756
  "title": "Expires On",
10244
10757
  "description": "Timestamp of batch expiration",
10245
10758
  "examples": [
10246
- "2024-01-01T00:00:00Z"
10759
+ "2025-04-07T00:00:00Z"
10247
10760
  ]
10248
10761
  },
10249
10762
  "status": {
@@ -10279,7 +10792,7 @@
10279
10792
  "title": "Created At",
10280
10793
  "description": "Timestamp of batch creation",
10281
10794
  "examples": [
10282
- "2024-01-01T00:00:00Z"
10795
+ "2025-04-07T00:00:00Z"
10283
10796
  ]
10284
10797
  },
10285
10798
  "deleted_at": {
@@ -10294,7 +10807,7 @@
10294
10807
  "title": "Deleted At",
10295
10808
  "description": "Timestamp of batch deletion",
10296
10809
  "examples": [
10297
- "2024-01-01T00:00:00Z"
10810
+ "2025-04-07T00:00:00Z"
10298
10811
  ]
10299
10812
  },
10300
10813
  "deleted_reason": {
@@ -10324,7 +10837,7 @@
10324
10837
  "title": "Last Worked On",
10325
10838
  "description": "Timestamp of last batch activity",
10326
10839
  "examples": [
10327
- "2024-01-01T00:00:00Z"
10840
+ "2025-04-07T00:00:00Z"
10328
10841
  ]
10329
10842
  },
10330
10843
  "last_updated_by": {
@@ -10351,7 +10864,7 @@
10351
10864
  "title": "Batch Id",
10352
10865
  "description": "Unique ID for conversation batch",
10353
10866
  "examples": [
10354
- "20250117.9"
10867
+ "20250407.9"
10355
10868
  ]
10356
10869
  },
10357
10870
  "campaign_id": {
@@ -10374,7 +10887,7 @@
10374
10887
  "title": "Expires On",
10375
10888
  "description": "Timestamp of batch expiration",
10376
10889
  "examples": [
10377
- "2024-01-01T00:00:00Z"
10890
+ "2025-04-07T00:00:00Z"
10378
10891
  ]
10379
10892
  }
10380
10893
  },
@@ -10387,14 +10900,6 @@
10387
10900
  },
10388
10901
  "CommunicationRequest": {
10389
10902
  "properties": {
10390
- "batch_id": {
10391
- "type": "string",
10392
- "title": "Batch Id",
10393
- "description": "Unique ID for conversation batch",
10394
- "examples": [
10395
- "20250117.9"
10396
- ]
10397
- },
10398
10903
  "reference_id": {
10399
10904
  "type": "string",
10400
10905
  "title": "Reference Id",
@@ -10411,19 +10916,6 @@
10411
10916
  "user@email.com"
10412
10917
  ]
10413
10918
  },
10414
- "request_status": {
10415
- "$ref": "#/components/schemas/RequestStatus",
10416
- "description": "Status of request",
10417
- "default": "PENDING",
10418
- "examples": [
10419
- "PENDING",
10420
- "DUPLICATE",
10421
- "INITIATED",
10422
- "CONNECTED",
10423
- "FAILED",
10424
- "CANCELED"
10425
- ]
10426
- },
10427
10919
  "request_variables": {
10428
10920
  "type": "object",
10429
10921
  "title": "Request Variables",
@@ -10432,7 +10924,6 @@
10432
10924
  },
10433
10925
  "type": "object",
10434
10926
  "required": [
10435
- "batch_id",
10436
10927
  "reference_id",
10437
10928
  "target",
10438
10929
  "request_variables"
@@ -10441,14 +10932,6 @@
10441
10932
  },
10442
10933
  "CommunicationRequestResult": {
10443
10934
  "properties": {
10444
- "batch_id": {
10445
- "type": "string",
10446
- "title": "Batch Id",
10447
- "description": "Unique ID for conversation batch",
10448
- "examples": [
10449
- "20250117.9"
10450
- ]
10451
- },
10452
10935
  "reference_id": {
10453
10936
  "type": "string",
10454
10937
  "title": "Reference Id",
@@ -10465,25 +10948,12 @@
10465
10948
  "user@email.com"
10466
10949
  ]
10467
10950
  },
10468
- "request_status": {
10469
- "$ref": "#/components/schemas/RequestStatus",
10470
- "description": "Status of request",
10471
- "default": "PENDING",
10472
- "examples": [
10473
- "PENDING",
10474
- "DUPLICATE",
10475
- "INITIATED",
10476
- "CONNECTED",
10477
- "FAILED",
10478
- "CANCELED"
10479
- ]
10480
- },
10481
10951
  "request_variables": {
10482
10952
  "type": "object",
10483
10953
  "title": "Request Variables",
10484
10954
  "description": "Variables for request"
10485
10955
  },
10486
- "call_manager_sid": {
10956
+ "channel_manager_sid": {
10487
10957
  "anyOf": [
10488
10958
  {
10489
10959
  "type": "string"
@@ -10492,8 +10962,8 @@
10492
10962
  "type": "null"
10493
10963
  }
10494
10964
  ],
10495
- "title": "Call Manager Sid",
10496
- "description": "Call manager SID",
10965
+ "title": "Channel Manager Sid",
10966
+ "description": "Channel manager SID",
10497
10967
  "examples": [
10498
10968
  "LMc4b16a9df2ce33d84b3d30581fe6598c"
10499
10969
  ]
@@ -10503,7 +10973,7 @@
10503
10973
  "title": "Created At",
10504
10974
  "description": "Timestamp of request creation",
10505
10975
  "examples": [
10506
- "2024-01-01T00:00:00Z"
10976
+ "2025-04-06T00:00:00Z"
10507
10977
  ]
10508
10978
  },
10509
10979
  "sent_at": {
@@ -10518,7 +10988,7 @@
10518
10988
  "title": "Sent At",
10519
10989
  "description": "Timestamp at which request was sent",
10520
10990
  "examples": [
10521
- "2024-01-02T00:00:00Z"
10991
+ "2025-04-07T00:00:00Z"
10522
10992
  ]
10523
10993
  },
10524
10994
  "attempt_count": {
@@ -10527,43 +10997,96 @@
10527
10997
  "description": "Number of attempts for request",
10528
10998
  "default": 0,
10529
10999
  "examples": [
10530
- 0
11000
+ 0
11001
+ ]
11002
+ },
11003
+ "session_id": {
11004
+ "anyOf": [
11005
+ {
11006
+ "type": "integer"
11007
+ },
11008
+ {
11009
+ "type": "null"
11010
+ }
11011
+ ],
11012
+ "title": "Session Id",
11013
+ "description": "Unique ID for call session",
11014
+ "examples": [
11015
+ 1
11016
+ ]
11017
+ },
11018
+ "conversation_id": {
11019
+ "anyOf": [
11020
+ {
11021
+ "type": "integer"
11022
+ },
11023
+ {
11024
+ "type": "null"
11025
+ }
11026
+ ],
11027
+ "title": "Conversation Id",
11028
+ "description": "Unique ID for conversation",
11029
+ "examples": [
11030
+ 1
11031
+ ]
11032
+ },
11033
+ "channel_manager_status": {
11034
+ "anyOf": [
11035
+ {
11036
+ "type": "string"
11037
+ },
11038
+ {
11039
+ "type": "null"
11040
+ }
11041
+ ],
11042
+ "title": "Channel Manager Status",
11043
+ "description": "Status of request in channel manager",
11044
+ "examples": [
11045
+ "COMPLETED",
11046
+ "FAILED",
11047
+ "NO_ANSWER",
11048
+ "BUSY"
10531
11049
  ]
10532
11050
  },
10533
- "session_id": {
11051
+ "insights_status": {
10534
11052
  "anyOf": [
10535
11053
  {
10536
- "type": "integer"
11054
+ "type": "string"
10537
11055
  },
10538
11056
  {
10539
11057
  "type": "null"
10540
11058
  }
10541
11059
  ],
10542
- "title": "Session Id",
10543
- "description": "Unique ID for call session",
11060
+ "title": "Insights Status",
11061
+ "description": "Status of session in insight workflow",
10544
11062
  "examples": [
10545
- 1
11063
+ "PENDING",
11064
+ "PROCESSING",
11065
+ "COMPLETED",
11066
+ "FAILED"
10546
11067
  ]
10547
11068
  },
10548
- "conversation_id": {
11069
+ "insights": {
10549
11070
  "anyOf": [
10550
11071
  {
10551
- "type": "integer"
11072
+ "type": "object"
10552
11073
  },
10553
11074
  {
10554
11075
  "type": "null"
10555
11076
  }
10556
11077
  ],
10557
- "title": "Conversation Id",
10558
- "description": "Unique ID for conversation",
11078
+ "title": "Insights",
11079
+ "description": "Insights from call",
10559
11080
  "examples": [
10560
- 1
11081
+ {
11082
+ "rating": "Good",
11083
+ "summary": "The customer service agent successfully assisted the caller with their inquiry and the call ended positively."
11084
+ }
10561
11085
  ]
10562
11086
  }
10563
11087
  },
10564
11088
  "type": "object",
10565
11089
  "required": [
10566
- "batch_id",
10567
11090
  "reference_id",
10568
11091
  "target",
10569
11092
  "request_variables"
@@ -10691,6 +11214,30 @@
10691
11214
  "title": "Llm Version",
10692
11215
  "description": "Version for the LLM used in the conversation (see PromptResponse.llm_config.version)"
10693
11216
  },
11217
+ "llm_temperature": {
11218
+ "anyOf": [
11219
+ {
11220
+ "type": "number"
11221
+ },
11222
+ {
11223
+ "type": "null"
11224
+ }
11225
+ ],
11226
+ "title": "Llm Temperature",
11227
+ "description": "Temperature for the LLM used in the conversation (see PromptResponse.llm_config.temperature)"
11228
+ },
11229
+ "llm_seed": {
11230
+ "anyOf": [
11231
+ {
11232
+ "type": "integer"
11233
+ },
11234
+ {
11235
+ "type": "null"
11236
+ }
11237
+ ],
11238
+ "title": "Llm Seed",
11239
+ "description": "Seed for the LLM used in the conversation (see PromptResponse.llm_config.seed)."
11240
+ },
10694
11241
  "is_legacy": {
10695
11242
  "anyOf": [
10696
11243
  {
@@ -12045,32 +12592,299 @@
12045
12592
  ]
12046
12593
  ]
12047
12594
  },
12048
- "contact_tags": {
12595
+ "contact_tags": {
12596
+ "anyOf": [
12597
+ {
12598
+ "type": "object"
12599
+ },
12600
+ {
12601
+ "type": "null"
12602
+ }
12603
+ ],
12604
+ "title": "Contact Tags",
12605
+ "description": ""
12606
+ },
12607
+ "updated_at": {
12608
+ "anyOf": [
12609
+ {
12610
+ "type": "string",
12611
+ "format": "date-time"
12612
+ },
12613
+ {
12614
+ "type": "null"
12615
+ }
12616
+ ],
12617
+ "title": "Updated At",
12618
+ "description": ""
12619
+ },
12620
+ "last_updated_by": {
12621
+ "anyOf": [
12622
+ {
12623
+ "type": "string"
12624
+ },
12625
+ {
12626
+ "type": "null"
12627
+ }
12628
+ ],
12629
+ "title": "Last Updated By",
12630
+ "description": ""
12631
+ }
12632
+ },
12633
+ "type": "object",
12634
+ "required": [
12635
+ "name",
12636
+ "type"
12637
+ ],
12638
+ "title": "DirectoryMemberCreate",
12639
+ "description": "Request model to create a directory member."
12640
+ },
12641
+ "DirectoryMemberProperties": {
12642
+ "type": "string",
12643
+ "enum": [
12644
+ "id",
12645
+ "name",
12646
+ "type",
12647
+ "extensions",
12648
+ "contact_tags",
12649
+ "updated_at"
12650
+ ],
12651
+ "title": "DirectoryMemberProperties"
12652
+ },
12653
+ "Event": {
12654
+ "properties": {
12655
+ "timestamp": {
12656
+ "type": "string",
12657
+ "format": "date-time",
12658
+ "title": "Timestamp",
12659
+ "description": "Timestamp at which the event occurred"
12660
+ },
12661
+ "session_id": {
12662
+ "anyOf": [
12663
+ {
12664
+ "type": "string"
12665
+ },
12666
+ {
12667
+ "type": "null"
12668
+ }
12669
+ ],
12670
+ "title": "Session Id",
12671
+ "description": "ID of the session in which the event occurred"
12672
+ },
12673
+ "conversation_id": {
12674
+ "anyOf": [
12675
+ {
12676
+ "type": "string"
12677
+ },
12678
+ {
12679
+ "type": "null"
12680
+ }
12681
+ ],
12682
+ "title": "Conversation Id",
12683
+ "description": "ID of the conversation associated with the session in which the event occurred"
12684
+ },
12685
+ "source": {
12686
+ "anyOf": [
12687
+ {
12688
+ "type": "string"
12689
+ },
12690
+ {
12691
+ "type": "null"
12692
+ }
12693
+ ],
12694
+ "title": "Source",
12695
+ "description": "Source of the event (either a tool call or an LLM prompt)",
12696
+ "examples": [
12697
+ "tool-call"
12698
+ ]
12699
+ },
12700
+ "source_id": {
12701
+ "anyOf": [
12702
+ {
12703
+ "type": "string"
12704
+ },
12705
+ {
12706
+ "type": "null"
12707
+ }
12708
+ ],
12709
+ "title": "Source Id",
12710
+ "description": "ID of the source of the event (either a tool ID or a prompt ID)"
12711
+ },
12712
+ "category": {
12713
+ "anyOf": [
12714
+ {
12715
+ "type": "string"
12716
+ },
12717
+ {
12718
+ "type": "null"
12719
+ }
12720
+ ],
12721
+ "title": "Category",
12722
+ "description": "Broad categorization of the event",
12723
+ "examples": [
12724
+ "automation"
12725
+ ]
12726
+ },
12727
+ "type": {
12728
+ "anyOf": [
12729
+ {
12730
+ "type": "string"
12731
+ },
12732
+ {
12733
+ "type": "null"
12734
+ }
12735
+ ],
12736
+ "title": "Type",
12737
+ "description": "More specific class of the event",
12738
+ "examples": [
12739
+ "phone-transfer"
12740
+ ]
12741
+ },
12742
+ "user_id": {
12743
+ "anyOf": [
12744
+ {
12745
+ "type": "string"
12746
+ },
12747
+ {
12748
+ "type": "null"
12749
+ }
12750
+ ],
12751
+ "title": "User Id",
12752
+ "description": "ID of the user interacting with the system when the event occurred (e.g., their phone number)",
12753
+ "examples": [
12754
+ "+18042221111"
12755
+ ]
12756
+ },
12757
+ "description": {
12758
+ "anyOf": [
12759
+ {
12760
+ "type": "string"
12761
+ },
12762
+ {
12763
+ "type": "null"
12764
+ }
12765
+ ],
12766
+ "title": "Description",
12767
+ "description": "Human-readable description of the event",
12768
+ "examples": [
12769
+ "Transfer to phone number +18042221111"
12770
+ ]
12771
+ },
12772
+ "attributes": {
12773
+ "anyOf": [
12774
+ {
12775
+ "type": "object"
12776
+ },
12777
+ {
12778
+ "type": "null"
12779
+ }
12780
+ ],
12781
+ "title": "Attributes",
12782
+ "description": "Arbitrary additional metadata for the event"
12783
+ }
12784
+ },
12785
+ "type": "object",
12786
+ "required": [
12787
+ "timestamp"
12788
+ ],
12789
+ "title": "Event",
12790
+ "description": "An event represents a specific occurrence during a session."
12791
+ },
12792
+ "EventProperties": {
12793
+ "type": "string",
12794
+ "enum": [
12795
+ "timestamp",
12796
+ "session_id",
12797
+ "conversation_id",
12798
+ "source",
12799
+ "source_id",
12800
+ "category",
12801
+ "type",
12802
+ "user_id",
12803
+ "description",
12804
+ "attributes"
12805
+ ],
12806
+ "title": "EventProperties"
12807
+ },
12808
+ "HTTPValidationError": {
12809
+ "properties": {
12810
+ "detail": {
12811
+ "items": {
12812
+ "$ref": "#/components/schemas/ValidationError"
12813
+ },
12814
+ "type": "array",
12815
+ "title": "Detail"
12816
+ }
12817
+ },
12818
+ "type": "object",
12819
+ "title": "HTTPValidationError"
12820
+ },
12821
+ "IncidentCreateRequest": {
12822
+ "properties": {
12823
+ "description": {
12824
+ "type": "string",
12825
+ "title": "Description",
12826
+ "description": "Description of the service incident",
12827
+ "example": "Service outage in region X"
12828
+ },
12829
+ "start_datetime": {
12830
+ "type": "string",
12831
+ "format": "date-time",
12832
+ "title": "Start Datetime",
12833
+ "description": "Start time of the incident",
12834
+ "example": "2023-10-01T08:00:00Z"
12835
+ },
12836
+ "resolution_datetime": {
12837
+ "type": "string",
12838
+ "format": "date-time",
12839
+ "title": "Resolution Datetime",
12840
+ "description": "Resolution time of the incident",
12841
+ "example": "2023-10-01T12:00:00Z"
12842
+ },
12843
+ "impact_category": {
12844
+ "type": "string",
12845
+ "title": "Impact Category",
12846
+ "description": "Category of the impact",
12847
+ "example": "High"
12848
+ },
12849
+ "sessions_impacted": {
12850
+ "type": "integer",
12851
+ "title": "Sessions Impacted",
12852
+ "description": "Number of sessions impacted",
12853
+ "example": 1500
12854
+ },
12855
+ "markdown": {
12856
+ "type": "string",
12857
+ "title": "Markdown",
12858
+ "description": "Detailed markdown description of the incident",
12859
+ "example": "**Incident Details**"
12860
+ },
12861
+ "organization_id": {
12049
12862
  "anyOf": [
12050
12863
  {
12051
- "type": "object"
12864
+ "type": "integer"
12052
12865
  },
12053
12866
  {
12054
12867
  "type": "null"
12055
12868
  }
12056
12869
  ],
12057
- "title": "Contact Tags",
12058
- "description": ""
12870
+ "title": "Organization Id",
12871
+ "description": "The ID of the organization",
12872
+ "example": 123
12059
12873
  },
12060
- "updated_at": {
12874
+ "sub_organization_id": {
12061
12875
  "anyOf": [
12062
12876
  {
12063
- "type": "string",
12064
- "format": "date-time"
12877
+ "type": "integer"
12065
12878
  },
12066
12879
  {
12067
12880
  "type": "null"
12068
12881
  }
12069
12882
  ],
12070
- "title": "Updated At",
12071
- "description": ""
12883
+ "title": "Sub Organization Id",
12884
+ "description": "The ID of the sub-organization",
12885
+ "example": 456
12072
12886
  },
12073
- "last_updated_by": {
12887
+ "sub_organization": {
12074
12888
  "anyOf": [
12075
12889
  {
12076
12890
  "type": "string"
@@ -12079,63 +12893,132 @@
12079
12893
  "type": "null"
12080
12894
  }
12081
12895
  ],
12082
- "title": "Last Updated By",
12083
- "description": ""
12896
+ "title": "Sub Organization",
12897
+ "description": "The name of the sub-organization",
12898
+ "example": "SubOrg A"
12899
+ }
12900
+ },
12901
+ "type": "object",
12902
+ "required": [
12903
+ "description",
12904
+ "start_datetime",
12905
+ "resolution_datetime",
12906
+ "impact_category",
12907
+ "sessions_impacted",
12908
+ "markdown"
12909
+ ],
12910
+ "title": "IncidentCreateRequest",
12911
+ "description": "Request model to create a service incident."
12912
+ },
12913
+ "IncidentOrganizationResponse": {
12914
+ "properties": {
12915
+ "id": {
12916
+ "type": "integer",
12917
+ "title": "Id"
12918
+ },
12919
+ "name": {
12920
+ "type": "string",
12921
+ "title": "Name"
12922
+ },
12923
+ "display_name": {
12924
+ "type": "string",
12925
+ "title": "Display Name"
12084
12926
  }
12085
12927
  },
12086
12928
  "type": "object",
12087
12929
  "required": [
12930
+ "id",
12088
12931
  "name",
12089
- "type"
12932
+ "display_name"
12090
12933
  ],
12091
- "title": "DirectoryMemberCreate",
12092
- "description": "Request model to create a directory member."
12934
+ "title": "IncidentOrganizationResponse"
12093
12935
  },
12094
- "DirectoryMemberProperties": {
12936
+ "IncidentProperties": {
12095
12937
  "type": "string",
12096
12938
  "enum": [
12097
12939
  "id",
12098
- "name",
12099
- "type",
12100
- "extensions",
12101
- "contact_tags",
12102
- "updated_at"
12940
+ "description",
12941
+ "impact_category",
12942
+ "sessions_impacted",
12943
+ "markdown",
12944
+ "created_at",
12945
+ "updated_at",
12946
+ "organization_id",
12947
+ "sub_organization_id",
12948
+ "start_datetime",
12949
+ "end_datetime",
12950
+ "resolution_datetime"
12103
12951
  ],
12104
- "title": "DirectoryMemberProperties"
12952
+ "title": "IncidentProperties",
12953
+ "description": "Names of agent fields supported for filtering/sorting on list endpoint."
12105
12954
  },
12106
- "Event": {
12955
+ "IncidentResponse": {
12107
12956
  "properties": {
12108
- "timestamp": {
12957
+ "description": {
12958
+ "type": "string",
12959
+ "title": "Description",
12960
+ "description": "Description of the service incident",
12961
+ "example": "Service outage in region X"
12962
+ },
12963
+ "start_datetime": {
12109
12964
  "type": "string",
12110
12965
  "format": "date-time",
12111
- "title": "Timestamp",
12112
- "description": "Timestamp at which the event occurred"
12966
+ "title": "Start Datetime",
12967
+ "description": "Start time of the incident",
12968
+ "example": "2023-10-01T08:00:00Z"
12113
12969
  },
12114
- "session_id": {
12970
+ "resolution_datetime": {
12971
+ "type": "string",
12972
+ "format": "date-time",
12973
+ "title": "Resolution Datetime",
12974
+ "description": "Resolution time of the incident",
12975
+ "example": "2023-10-01T12:00:00Z"
12976
+ },
12977
+ "impact_category": {
12978
+ "type": "string",
12979
+ "title": "Impact Category",
12980
+ "description": "Category of the impact",
12981
+ "example": "High"
12982
+ },
12983
+ "sessions_impacted": {
12984
+ "type": "integer",
12985
+ "title": "Sessions Impacted",
12986
+ "description": "Number of sessions impacted",
12987
+ "example": 1500
12988
+ },
12989
+ "markdown": {
12990
+ "type": "string",
12991
+ "title": "Markdown",
12992
+ "description": "Detailed markdown description of the incident",
12993
+ "example": "**Incident Details**"
12994
+ },
12995
+ "organization_id": {
12115
12996
  "anyOf": [
12116
12997
  {
12117
- "type": "string"
12998
+ "type": "integer"
12118
12999
  },
12119
13000
  {
12120
13001
  "type": "null"
12121
13002
  }
12122
13003
  ],
12123
- "title": "Session Id",
12124
- "description": "ID of the session in which the event occurred"
13004
+ "title": "Organization Id",
13005
+ "description": "The ID of the organization",
13006
+ "example": 123
12125
13007
  },
12126
- "conversation_id": {
13008
+ "sub_organization_id": {
12127
13009
  "anyOf": [
12128
13010
  {
12129
- "type": "string"
13011
+ "type": "integer"
12130
13012
  },
12131
13013
  {
12132
13014
  "type": "null"
12133
13015
  }
12134
13016
  ],
12135
- "title": "Conversation Id",
12136
- "description": "ID of the conversation associated with the session in which the event occurred"
13017
+ "title": "Sub Organization Id",
13018
+ "description": "The ID of the sub-organization",
13019
+ "example": 456
12137
13020
  },
12138
- "source": {
13021
+ "sub_organization": {
12139
13022
  "anyOf": [
12140
13023
  {
12141
13024
  "type": "string"
@@ -12144,70 +13027,125 @@
12144
13027
  "type": "null"
12145
13028
  }
12146
13029
  ],
12147
- "title": "Source",
12148
- "description": "Source of the event (either a tool call or an LLM prompt)",
12149
- "examples": [
12150
- "tool-call"
12151
- ]
13030
+ "title": "Sub Organization",
13031
+ "description": "The name of the sub-organization",
13032
+ "example": "SubOrg A"
12152
13033
  },
12153
- "source_id": {
13034
+ "id": {
13035
+ "type": "integer",
13036
+ "title": "Id",
13037
+ "description": "The ID of the incident to update",
13038
+ "example": 1
13039
+ },
13040
+ "created_at": {
12154
13041
  "anyOf": [
12155
13042
  {
12156
- "type": "string"
13043
+ "type": "string",
13044
+ "format": "date-time"
12157
13045
  },
12158
13046
  {
12159
13047
  "type": "null"
12160
13048
  }
12161
13049
  ],
12162
- "title": "Source Id",
12163
- "description": "ID of the source of the event (either a tool ID or a prompt ID)"
13050
+ "title": "Created At",
13051
+ "description": "Creation time of the incident",
13052
+ "example": "2023-10-01T08:00:00Z"
12164
13053
  },
12165
- "category": {
13054
+ "updated_at": {
12166
13055
  "anyOf": [
12167
13056
  {
12168
- "type": "string"
13057
+ "type": "string",
13058
+ "format": "date-time"
12169
13059
  },
12170
13060
  {
12171
13061
  "type": "null"
12172
13062
  }
12173
13063
  ],
12174
- "title": "Category",
12175
- "description": "Broad categorization of the event",
12176
- "examples": [
12177
- "automation"
12178
- ]
13064
+ "title": "Updated At",
13065
+ "description": "Last update time of the incident",
13066
+ "example": "2023-10-01T08:00:00Z"
13067
+ }
13068
+ },
13069
+ "type": "object",
13070
+ "required": [
13071
+ "description",
13072
+ "start_datetime",
13073
+ "resolution_datetime",
13074
+ "impact_category",
13075
+ "sessions_impacted",
13076
+ "markdown",
13077
+ "id"
13078
+ ],
13079
+ "title": "IncidentResponse",
13080
+ "description": "Response model for service incident operations."
13081
+ },
13082
+ "IncidentUpdateRequest": {
13083
+ "properties": {
13084
+ "description": {
13085
+ "type": "string",
13086
+ "title": "Description",
13087
+ "description": "Description of the service incident",
13088
+ "example": "Service outage in region X"
12179
13089
  },
12180
- "type": {
13090
+ "start_datetime": {
13091
+ "type": "string",
13092
+ "format": "date-time",
13093
+ "title": "Start Datetime",
13094
+ "description": "Start time of the incident",
13095
+ "example": "2023-10-01T08:00:00Z"
13096
+ },
13097
+ "resolution_datetime": {
13098
+ "type": "string",
13099
+ "format": "date-time",
13100
+ "title": "Resolution Datetime",
13101
+ "description": "Resolution time of the incident",
13102
+ "example": "2023-10-01T12:00:00Z"
13103
+ },
13104
+ "impact_category": {
13105
+ "type": "string",
13106
+ "title": "Impact Category",
13107
+ "description": "Category of the impact",
13108
+ "example": "High"
13109
+ },
13110
+ "sessions_impacted": {
13111
+ "type": "integer",
13112
+ "title": "Sessions Impacted",
13113
+ "description": "Number of sessions impacted",
13114
+ "example": 1500
13115
+ },
13116
+ "markdown": {
13117
+ "type": "string",
13118
+ "title": "Markdown",
13119
+ "description": "Detailed markdown description of the incident",
13120
+ "example": "**Incident Details**"
13121
+ },
13122
+ "organization_id": {
12181
13123
  "anyOf": [
12182
13124
  {
12183
- "type": "string"
13125
+ "type": "integer"
12184
13126
  },
12185
13127
  {
12186
13128
  "type": "null"
12187
13129
  }
12188
13130
  ],
12189
- "title": "Type",
12190
- "description": "More specific class of the event",
12191
- "examples": [
12192
- "phone-transfer"
12193
- ]
13131
+ "title": "Organization Id",
13132
+ "description": "The ID of the organization",
13133
+ "example": 123
12194
13134
  },
12195
- "user_id": {
13135
+ "sub_organization_id": {
12196
13136
  "anyOf": [
12197
13137
  {
12198
- "type": "string"
13138
+ "type": "integer"
12199
13139
  },
12200
13140
  {
12201
13141
  "type": "null"
12202
13142
  }
12203
13143
  ],
12204
- "title": "User Id",
12205
- "description": "ID of the user interacting with the system when the event occurred (e.g., their phone number)",
12206
- "examples": [
12207
- "+18042221111"
12208
- ]
13144
+ "title": "Sub Organization Id",
13145
+ "description": "The ID of the sub-organization",
13146
+ "example": 456
12209
13147
  },
12210
- "description": {
13148
+ "sub_organization": {
12211
13149
  "anyOf": [
12212
13150
  {
12213
13151
  "type": "string"
@@ -12216,60 +13154,57 @@
12216
13154
  "type": "null"
12217
13155
  }
12218
13156
  ],
12219
- "title": "Description",
12220
- "description": "Human-readable description of the event",
12221
- "examples": [
12222
- "Transfer to phone number +18042221111"
12223
- ]
13157
+ "title": "Sub Organization",
13158
+ "description": "The name of the sub-organization",
13159
+ "example": "SubOrg A"
12224
13160
  },
12225
- "attributes": {
13161
+ "id": {
13162
+ "type": "integer",
13163
+ "title": "Id",
13164
+ "description": "The ID of the incident to update",
13165
+ "example": 1
13166
+ },
13167
+ "created_at": {
12226
13168
  "anyOf": [
12227
13169
  {
12228
- "type": "object"
13170
+ "type": "string",
13171
+ "format": "date-time"
12229
13172
  },
12230
13173
  {
12231
13174
  "type": "null"
12232
13175
  }
12233
13176
  ],
12234
- "title": "Attributes",
12235
- "description": "Arbitrary additional metadata for the event"
13177
+ "title": "Created At",
13178
+ "description": "Creation time of the incident",
13179
+ "example": "2023-10-01T08:00:00Z"
13180
+ },
13181
+ "updated_at": {
13182
+ "anyOf": [
13183
+ {
13184
+ "type": "string",
13185
+ "format": "date-time"
13186
+ },
13187
+ {
13188
+ "type": "null"
13189
+ }
13190
+ ],
13191
+ "title": "Updated At",
13192
+ "description": "Last update time of the incident",
13193
+ "example": "2023-10-01T08:00:00Z"
12236
13194
  }
12237
13195
  },
12238
13196
  "type": "object",
12239
13197
  "required": [
12240
- "timestamp"
12241
- ],
12242
- "title": "Event",
12243
- "description": "An event represents a specific occurrence during a session."
12244
- },
12245
- "EventProperties": {
12246
- "type": "string",
12247
- "enum": [
12248
- "timestamp",
12249
- "session_id",
12250
- "conversation_id",
12251
- "source",
12252
- "source_id",
12253
- "category",
12254
- "type",
12255
- "user_id",
12256
13198
  "description",
12257
- "attributes"
13199
+ "start_datetime",
13200
+ "resolution_datetime",
13201
+ "impact_category",
13202
+ "sessions_impacted",
13203
+ "markdown",
13204
+ "id"
12258
13205
  ],
12259
- "title": "EventProperties"
12260
- },
12261
- "HTTPValidationError": {
12262
- "properties": {
12263
- "detail": {
12264
- "items": {
12265
- "$ref": "#/components/schemas/ValidationError"
12266
- },
12267
- "type": "array",
12268
- "title": "Detail"
12269
- }
12270
- },
12271
- "type": "object",
12272
- "title": "HTTPValidationError"
13206
+ "title": "IncidentUpdateRequest",
13207
+ "description": "Request model to update an existing service incident."
12273
13208
  },
12274
13209
  "InsightToolDefinition": {
12275
13210
  "properties": {
@@ -12460,7 +13395,7 @@
12460
13395
  "title": "Created At",
12461
13396
  "description": "Timestamp of at which insight tool was created",
12462
13397
  "examples": [
12463
- "2024-01-01T00:00:00Z"
13398
+ "2025-04-06T00:00:00Z"
12464
13399
  ]
12465
13400
  },
12466
13401
  "updated_at": {
@@ -12469,7 +13404,7 @@
12469
13404
  "title": "Updated At",
12470
13405
  "description": "Timestamp at which insight tool was last updated",
12471
13406
  "examples": [
12472
- "2024-01-02T00:00:00Z"
13407
+ "2025-04-07T00:00:00Z"
12473
13408
  ]
12474
13409
  },
12475
13410
  "last_updated_by": {
@@ -12506,6 +13441,33 @@
12506
13441
  ],
12507
13442
  "title": "InsightToolProperties"
12508
13443
  },
13444
+ "InsightToolTestInput": {
13445
+ "properties": {
13446
+ "tool_name": {
13447
+ "type": "string",
13448
+ "title": "Tool Name",
13449
+ "description": "Human readable name of insight tool",
13450
+ "examples": [
13451
+ "summary-tool"
13452
+ ]
13453
+ },
13454
+ "session_id": {
13455
+ "type": "integer",
13456
+ "title": "Session Id",
13457
+ "description": "The session ID of the session to run the tool against",
13458
+ "examples": [
13459
+ "283467"
13460
+ ]
13461
+ }
13462
+ },
13463
+ "type": "object",
13464
+ "required": [
13465
+ "tool_name",
13466
+ "session_id"
13467
+ ],
13468
+ "title": "InsightToolTestInput",
13469
+ "description": "Request model to test an insight tool."
13470
+ },
12509
13471
  "InsightWorkflowInput": {
12510
13472
  "properties": {
12511
13473
  "name": {
@@ -12638,7 +13600,7 @@
12638
13600
  "title": "Created At",
12639
13601
  "description": "Timestamp at which the insight workflow was created",
12640
13602
  "examples": [
12641
- "2024-01-01T00:00:00Z"
13603
+ "2025-04-06T00:00:00Z"
12642
13604
  ]
12643
13605
  },
12644
13606
  "updated_at": {
@@ -12647,7 +13609,7 @@
12647
13609
  "title": "Updated At",
12648
13610
  "description": "Timestamp of most recent update to the insight workflow",
12649
13611
  "examples": [
12650
- "2024-01-02T00:00:00Z"
13612
+ "2025-04-07T00:00:00Z"
12651
13613
  ]
12652
13614
  },
12653
13615
  "last_updated_by": {
@@ -12776,7 +13738,7 @@
12776
13738
  "title": "Created At",
12777
13739
  "description": "Timestamp at which insight tool result was created",
12778
13740
  "examples": [
12779
- "2024-01-01T00:00:00Z"
13741
+ "2025-04-06T00:00:00Z"
12780
13742
  ]
12781
13743
  },
12782
13744
  "updated_at": {
@@ -12785,7 +13747,7 @@
12785
13747
  "title": "Updated At",
12786
13748
  "description": "Timestamp at which insight tool result was last updated",
12787
13749
  "examples": [
12788
- "2024-01-02T00:00:00Z"
13750
+ "2025-04-07T00:00:00Z"
12789
13751
  ]
12790
13752
  }
12791
13753
  },
@@ -13516,6 +14478,72 @@
13516
14478
  ],
13517
14479
  "title": "ListResponse[Channel]"
13518
14480
  },
14481
+ "ListResponse_CommunicationBatch_": {
14482
+ "properties": {
14483
+ "items": {
14484
+ "items": {
14485
+ "$ref": "#/components/schemas/CommunicationBatch"
14486
+ },
14487
+ "type": "array",
14488
+ "title": "Items",
14489
+ "description": "List of items returned from the query",
14490
+ "examples": []
14491
+ },
14492
+ "page": {
14493
+ "type": "integer",
14494
+ "title": "Page",
14495
+ "description": "The page number of the results (0-based)",
14496
+ "examples": [
14497
+ 0
14498
+ ]
14499
+ },
14500
+ "page_size": {
14501
+ "type": "integer",
14502
+ "title": "Page Size",
14503
+ "description": "The number of items returned per page",
14504
+ "examples": [
14505
+ 25
14506
+ ]
14507
+ },
14508
+ "total_pages": {
14509
+ "anyOf": [
14510
+ {
14511
+ "type": "integer"
14512
+ },
14513
+ {
14514
+ "type": "null"
14515
+ }
14516
+ ],
14517
+ "title": "Total Pages",
14518
+ "description": "The total number of pages of results given the indicated page size",
14519
+ "examples": [
14520
+ 4
14521
+ ]
14522
+ },
14523
+ "total_count": {
14524
+ "anyOf": [
14525
+ {
14526
+ "type": "integer"
14527
+ },
14528
+ {
14529
+ "type": "null"
14530
+ }
14531
+ ],
14532
+ "title": "Total Count",
14533
+ "description": "The total number of items returned from the query",
14534
+ "examples": [
14535
+ 100
14536
+ ]
14537
+ }
14538
+ },
14539
+ "type": "object",
14540
+ "required": [
14541
+ "items",
14542
+ "page",
14543
+ "page_size"
14544
+ ],
14545
+ "title": "ListResponse[CommunicationBatch]"
14546
+ },
13519
14547
  "ListResponse_Conversation_": {
13520
14548
  "properties": {
13521
14549
  "items": {
@@ -13912,6 +14940,72 @@
13912
14940
  ],
13913
14941
  "title": "ListResponse[Event]"
13914
14942
  },
14943
+ "ListResponse_IncidentResponse_": {
14944
+ "properties": {
14945
+ "items": {
14946
+ "items": {
14947
+ "$ref": "#/components/schemas/IncidentResponse"
14948
+ },
14949
+ "type": "array",
14950
+ "title": "Items",
14951
+ "description": "List of items returned from the query",
14952
+ "examples": []
14953
+ },
14954
+ "page": {
14955
+ "type": "integer",
14956
+ "title": "Page",
14957
+ "description": "The page number of the results (0-based)",
14958
+ "examples": [
14959
+ 0
14960
+ ]
14961
+ },
14962
+ "page_size": {
14963
+ "type": "integer",
14964
+ "title": "Page Size",
14965
+ "description": "The number of items returned per page",
14966
+ "examples": [
14967
+ 25
14968
+ ]
14969
+ },
14970
+ "total_pages": {
14971
+ "anyOf": [
14972
+ {
14973
+ "type": "integer"
14974
+ },
14975
+ {
14976
+ "type": "null"
14977
+ }
14978
+ ],
14979
+ "title": "Total Pages",
14980
+ "description": "The total number of pages of results given the indicated page size",
14981
+ "examples": [
14982
+ 4
14983
+ ]
14984
+ },
14985
+ "total_count": {
14986
+ "anyOf": [
14987
+ {
14988
+ "type": "integer"
14989
+ },
14990
+ {
14991
+ "type": "null"
14992
+ }
14993
+ ],
14994
+ "title": "Total Count",
14995
+ "description": "The total number of items returned from the query",
14996
+ "examples": [
14997
+ 100
14998
+ ]
14999
+ }
15000
+ },
15001
+ "type": "object",
15002
+ "required": [
15003
+ "items",
15004
+ "page",
15005
+ "page_size"
15006
+ ],
15007
+ "title": "ListResponse[IncidentResponse]"
15008
+ },
13915
15009
  "ListResponse_InsightToolOutput_": {
13916
15010
  "properties": {
13917
15011
  "items": {
@@ -14176,6 +15270,72 @@
14176
15270
  ],
14177
15271
  "title": "ListResponse[LanguageGroupResponse]"
14178
15272
  },
15273
+ "ListResponse_OutboundCampaign_": {
15274
+ "properties": {
15275
+ "items": {
15276
+ "items": {
15277
+ "$ref": "#/components/schemas/OutboundCampaign"
15278
+ },
15279
+ "type": "array",
15280
+ "title": "Items",
15281
+ "description": "List of items returned from the query",
15282
+ "examples": []
15283
+ },
15284
+ "page": {
15285
+ "type": "integer",
15286
+ "title": "Page",
15287
+ "description": "The page number of the results (0-based)",
15288
+ "examples": [
15289
+ 0
15290
+ ]
15291
+ },
15292
+ "page_size": {
15293
+ "type": "integer",
15294
+ "title": "Page Size",
15295
+ "description": "The number of items returned per page",
15296
+ "examples": [
15297
+ 25
15298
+ ]
15299
+ },
15300
+ "total_pages": {
15301
+ "anyOf": [
15302
+ {
15303
+ "type": "integer"
15304
+ },
15305
+ {
15306
+ "type": "null"
15307
+ }
15308
+ ],
15309
+ "title": "Total Pages",
15310
+ "description": "The total number of pages of results given the indicated page size",
15311
+ "examples": [
15312
+ 4
15313
+ ]
15314
+ },
15315
+ "total_count": {
15316
+ "anyOf": [
15317
+ {
15318
+ "type": "integer"
15319
+ },
15320
+ {
15321
+ "type": "null"
15322
+ }
15323
+ ],
15324
+ "title": "Total Count",
15325
+ "description": "The total number of items returned from the query",
15326
+ "examples": [
15327
+ 100
15328
+ ]
15329
+ }
15330
+ },
15331
+ "type": "object",
15332
+ "required": [
15333
+ "items",
15334
+ "page",
15335
+ "page_size"
15336
+ ],
15337
+ "title": "ListResponse[OutboundCampaign]"
15338
+ },
14179
15339
  "ListResponse_PromptResponse_": {
14180
15340
  "properties": {
14181
15341
  "items": {
@@ -14525,6 +15685,37 @@
14525
15685
  "Outbound Campaign 1"
14526
15686
  ]
14527
15687
  },
15688
+ "description": {
15689
+ "anyOf": [
15690
+ {
15691
+ "type": "string"
15692
+ },
15693
+ {
15694
+ "type": "null"
15695
+ }
15696
+ ],
15697
+ "title": "Description",
15698
+ "description": "Description of campaign",
15699
+ "examples": [
15700
+ "This is a test campaign"
15701
+ ]
15702
+ },
15703
+ "label": {
15704
+ "anyOf": [
15705
+ {
15706
+ "type": "string"
15707
+ },
15708
+ {
15709
+ "type": "null"
15710
+ }
15711
+ ],
15712
+ "title": "Label",
15713
+ "description": "Label for campaign",
15714
+ "examples": [
15715
+ "test",
15716
+ "demo"
15717
+ ]
15718
+ },
14528
15719
  "campaign_variables": {
14529
15720
  "type": "object",
14530
15721
  "title": "Campaign Variables",
@@ -14654,7 +15845,7 @@
14654
15845
  "title": "Created At",
14655
15846
  "description": "Timestamp of campaign creation",
14656
15847
  "examples": [
14657
- "2024-01-01T00:00:00Z"
15848
+ "2025-04-07T00:00:00Z"
14658
15849
  ]
14659
15850
  },
14660
15851
  "updated_at": {
@@ -14662,7 +15853,7 @@
14662
15853
  "title": "Updated At",
14663
15854
  "description": "Timestamp of campaign update",
14664
15855
  "examples": [
14665
- "2024-01-01T00:00:00Z"
15856
+ "2025-04-07T00:00:00Z"
14666
15857
  ]
14667
15858
  },
14668
15859
  "last_updated_by": {
@@ -14697,6 +15888,37 @@
14697
15888
  "Outbound Campaign 1"
14698
15889
  ]
14699
15890
  },
15891
+ "description": {
15892
+ "anyOf": [
15893
+ {
15894
+ "type": "string"
15895
+ },
15896
+ {
15897
+ "type": "null"
15898
+ }
15899
+ ],
15900
+ "title": "Description",
15901
+ "description": "Description of campaign",
15902
+ "examples": [
15903
+ "This is a test campaign"
15904
+ ]
15905
+ },
15906
+ "label": {
15907
+ "anyOf": [
15908
+ {
15909
+ "type": "string"
15910
+ },
15911
+ {
15912
+ "type": "null"
15913
+ }
15914
+ ],
15915
+ "title": "Label",
15916
+ "description": "Label for campaign",
15917
+ "examples": [
15918
+ "test",
15919
+ "demo"
15920
+ ]
15921
+ },
14700
15922
  "campaign_variables": {
14701
15923
  "type": "object",
14702
15924
  "title": "Campaign Variables",
@@ -14902,7 +16124,7 @@
14902
16124
  "include_default_tools": {
14903
16125
  "type": "boolean",
14904
16126
  "title": "Include Default Tools",
14905
- "description": "Whether to include the default tools (`hangup`, `summary`) in the list of tools for the prompt. If you disable this during creation, you might want to disable it during updates as well, otherwise the default tools will be added when updating the prompt.",
16127
+ "description": "Whether to include the default tools (`summary`, `hangup`) in the list of tools for the prompt. If you disable this during creation, you might want to disable it during updates as well, otherwise the default tools will be added when updating the prompt.",
14906
16128
  "default": true,
14907
16129
  "examples": [
14908
16130
  true
@@ -15397,7 +16619,7 @@
15397
16619
  "include_default_tools": {
15398
16620
  "type": "boolean",
15399
16621
  "title": "Include Default Tools",
15400
- "description": "Whether to include the default tools (`hangup`, `summary`) in the list of tools for the prompt. If you remove one of the default tools from your prompt, you might want to disable this option so that the tool is not added again when updated.",
16622
+ "description": "Whether to include the default tools (`summary`, `hangup`) in the list of tools for the prompt. If you remove one of the default tools from your prompt, you might want to disable this option so that the tool is not added again when updated.",
15401
16623
  "default": true,
15402
16624
  "examples": [
15403
16625
  true
@@ -15414,19 +16636,6 @@
15414
16636
  "title": "PromptUpdateRequest",
15415
16637
  "description": "Request model to update an existing prompt."
15416
16638
  },
15417
- "RequestStatus": {
15418
- "type": "string",
15419
- "enum": [
15420
- "PENDING",
15421
- "DUPLICATE",
15422
- "INITIATED",
15423
- "CONNECTED",
15424
- "FAILED",
15425
- "CANCELED"
15426
- ],
15427
- "title": "RequestStatus",
15428
- "description": "Status of a communication request."
15429
- },
15430
16639
  "ServiceCreateRequest": {
15431
16640
  "properties": {
15432
16641
  "name": {
@@ -17699,6 +18908,10 @@
17699
18908
  "name": "events",
17700
18909
  "description": "Operations related to events. An event represents a specific occurrence during a session. Currently the API/SDK only supports fetching logged events."
17701
18910
  },
18911
+ {
18912
+ "name": "incidents",
18913
+ "description": "Operations related to incidents."
18914
+ },
17702
18915
  {
17703
18916
  "name": "insights",
17704
18917
  "description": "Operations related to insights results. An insight is a tool that processes conversation data to extract information and generate reports."
@@ -17772,6 +18985,18 @@
17772
18985
  {
17773
18986
  "operationId": ".*_get_by_name$",
17774
18987
  "methodNameOverride": "get_by_name"
18988
+ },
18989
+ {
18990
+ "operationId": ".*_add$",
18991
+ "methodNameOverride": "add"
18992
+ },
18993
+ {
18994
+ "operationId": ".*_remove$",
18995
+ "methodNameOverride": "remove"
18996
+ },
18997
+ {
18998
+ "operationId": ".*_results$",
18999
+ "methodNameOverride": "results"
17775
19000
  }
17776
19001
  ]
17777
19002
  }