@signalwire/sdk 2.0.5 → 3.5.0

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 (656) hide show
  1. package/CHANGELOG.md +785 -0
  2. package/LICENSE +21 -0
  3. package/README.md +163 -68
  4. package/dist/AGENTS.md +13 -0
  5. package/dist/AgentBase.d.ts +481 -126
  6. package/dist/AgentBase.js +1502 -438
  7. package/dist/AgentBase.js.map +1 -1
  8. package/dist/AgentServer.d.ts +21 -0
  9. package/dist/AgentServer.js +154 -47
  10. package/dist/AgentServer.js.map +1 -1
  11. package/dist/AuthHandler.d.ts +14 -2
  12. package/dist/AuthHandler.js +7 -2
  13. package/dist/AuthHandler.js.map +1 -1
  14. package/dist/ConfigLoader.d.ts +5 -13
  15. package/dist/ConfigLoader.js +15 -29
  16. package/dist/ConfigLoader.js.map +1 -1
  17. package/dist/ContextBuilder.d.ts +202 -9
  18. package/dist/ContextBuilder.js +219 -36
  19. package/dist/ContextBuilder.js.map +1 -1
  20. package/dist/DataMap.d.ts +158 -45
  21. package/dist/DataMap.js +167 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +277 -83
  24. package/dist/FunctionResult.js +444 -116
  25. package/dist/FunctionResult.js.map +1 -1
  26. package/dist/Logger.d.ts +30 -5
  27. package/dist/Logger.js +77 -19
  28. package/dist/Logger.js.map +1 -1
  29. package/dist/POM/PromptObjectModel.d.ts +12 -1
  30. package/dist/POM/PromptObjectModel.js +25 -9
  31. package/dist/POM/PromptObjectModel.js.map +1 -1
  32. package/dist/ParameterSchema.d.ts +306 -0
  33. package/dist/ParameterSchema.js +251 -0
  34. package/dist/ParameterSchema.js.map +1 -0
  35. package/dist/PlatformContracts.d.ts +21 -0
  36. package/dist/PlatformContracts.generated.d.ts +109 -0
  37. package/dist/PlatformContracts.generated.js +8 -0
  38. package/dist/PlatformContracts.generated.js.map +1 -0
  39. package/dist/PlatformContracts.js +2 -0
  40. package/dist/PlatformContracts.js.map +1 -0
  41. package/dist/PomBuilder.d.ts +18 -0
  42. package/dist/PomBuilder.js +53 -3
  43. package/dist/PomBuilder.js.map +1 -1
  44. package/dist/PostPrompt.d.ts +110 -0
  45. package/dist/PostPrompt.js +204 -0
  46. package/dist/PostPrompt.js.map +1 -0
  47. package/dist/PromptManager.d.ts +22 -1
  48. package/dist/PromptManager.js +28 -1
  49. package/dist/PromptManager.js.map +1 -1
  50. package/dist/PublicFetch.d.ts +132 -0
  51. package/dist/PublicFetch.js +311 -0
  52. package/dist/PublicFetch.js.map +1 -0
  53. package/dist/RobotsTxt.d.ts +41 -0
  54. package/dist/RobotsTxt.js +152 -0
  55. package/dist/RobotsTxt.js.map +1 -0
  56. package/dist/SWMLHandler.js.map +1 -1
  57. package/dist/SWMLService.d.ts +158 -58
  58. package/dist/SWMLService.js +435 -127
  59. package/dist/SWMLService.js.map +1 -1
  60. package/dist/SchemaUtils.d.ts +115 -2
  61. package/dist/SchemaUtils.js +444 -12
  62. package/dist/SchemaUtils.js.map +1 -1
  63. package/dist/SecurityUtils.d.ts +49 -9
  64. package/dist/SecurityUtils.js +153 -51
  65. package/dist/SecurityUtils.js.map +1 -1
  66. package/dist/ServerlessAdapter.d.ts +156 -7
  67. package/dist/ServerlessAdapter.js +399 -42
  68. package/dist/ServerlessAdapter.js.map +1 -1
  69. package/dist/SessionManager.d.ts +11 -2
  70. package/dist/SessionManager.js +50 -18
  71. package/dist/SessionManager.js.map +1 -1
  72. package/dist/SslConfig.d.ts +2 -1
  73. package/dist/SslConfig.js +4 -1
  74. package/dist/SslConfig.js.map +1 -1
  75. package/dist/SwaigActions.generated.d.ts +23 -0
  76. package/dist/SwaigActions.generated.js +8 -0
  77. package/dist/SwaigActions.generated.js.map +1 -0
  78. package/dist/SwaigContracts.d.ts +15 -0
  79. package/dist/SwaigContracts.generated.d.ts +264 -0
  80. package/dist/SwaigContracts.generated.js +12 -0
  81. package/dist/SwaigContracts.generated.js.map +1 -0
  82. package/dist/SwaigContracts.js +2 -0
  83. package/dist/SwaigContracts.js.map +1 -0
  84. package/dist/SwaigFunction.d.ts +110 -4
  85. package/dist/SwaigFunction.js +151 -19
  86. package/dist/SwaigFunction.js.map +1 -1
  87. package/dist/SwmlBuilder.d.ts +68 -19
  88. package/dist/SwmlBuilder.js +74 -38
  89. package/dist/SwmlBuilder.js.map +1 -1
  90. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  91. package/dist/SwmlVerbMethods.generated.js +1 -1
  92. package/dist/TypeInference.d.ts +39 -3
  93. package/dist/TypeInference.js +256 -16
  94. package/dist/TypeInference.js.map +1 -1
  95. package/dist/WebService.d.ts +79 -11
  96. package/dist/WebService.js +320 -109
  97. package/dist/WebService.js.map +1 -1
  98. package/dist/WebhookMiddleware.d.ts +119 -0
  99. package/dist/WebhookMiddleware.js +271 -0
  100. package/dist/WebhookMiddleware.js.map +1 -0
  101. package/dist/WebhookValidator.d.ts +92 -0
  102. package/dist/WebhookValidator.js +409 -0
  103. package/dist/WebhookValidator.js.map +1 -0
  104. package/dist/agents/BedrockAgent.d.ts +162 -0
  105. package/dist/agents/BedrockAgent.js +323 -0
  106. package/dist/agents/BedrockAgent.js.map +1 -0
  107. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  108. package/dist/ai-chat/AIChatClient.js +535 -0
  109. package/dist/ai-chat/AIChatClient.js.map +1 -0
  110. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  111. package/dist/ai-chat/ChatGateway.js +747 -0
  112. package/dist/ai-chat/ChatGateway.js.map +1 -0
  113. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  114. package/dist/ai-chat/HandoffRouter.js +518 -0
  115. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  116. package/dist/ai-chat/index.d.ts +12 -0
  117. package/dist/ai-chat/index.js +10 -0
  118. package/dist/ai-chat/index.js.map +1 -0
  119. package/dist/capabilities.d.ts +64 -0
  120. package/dist/capabilities.js +95 -0
  121. package/dist/capabilities.js.map +1 -0
  122. package/dist/cli/agent-loader.d.ts +32 -6
  123. package/dist/cli/agent-loader.js +92 -33
  124. package/dist/cli/agent-loader.js.map +1 -1
  125. package/dist/cli/datamap-exec.d.ts +175 -0
  126. package/dist/cli/datamap-exec.js +1284 -0
  127. package/dist/cli/datamap-exec.js.map +1 -0
  128. package/dist/cli/function-args.d.ts +40 -0
  129. package/dist/cli/function-args.js +146 -0
  130. package/dist/cli/function-args.js.map +1 -0
  131. package/dist/cli/simulation.d.ts +99 -0
  132. package/dist/cli/simulation.js +490 -0
  133. package/dist/cli/simulation.js.map +1 -0
  134. package/dist/cli/swaig-test.d.ts +12 -25
  135. package/dist/cli/swaig-test.js +935 -371
  136. package/dist/cli/swaig-test.js.map +1 -1
  137. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  138. package/dist/cli/tsdocs/agentsNote.js +92 -0
  139. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  140. package/dist/cli/tsdocs/api-index.json +1 -0
  141. package/dist/cli/tsdocs/api.d.ts +91 -0
  142. package/dist/cli/tsdocs/api.js +372 -0
  143. package/dist/cli/tsdocs/api.js.map +1 -0
  144. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  145. package/dist/cli/tsdocs/apiTypes.js +7 -0
  146. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  147. package/dist/cli/tsdocs/bin.d.ts +6 -0
  148. package/dist/cli/tsdocs/bin.js +23 -0
  149. package/dist/cli/tsdocs/bin.js.map +1 -0
  150. package/dist/cli/tsdocs/files.d.ts +108 -0
  151. package/dist/cli/tsdocs/files.js +287 -0
  152. package/dist/cli/tsdocs/files.js.map +1 -0
  153. package/dist/cli/tsdocs/index.d.ts +28 -0
  154. package/dist/cli/tsdocs/index.js +307 -0
  155. package/dist/cli/tsdocs/index.js.map +1 -0
  156. package/dist/cli/tsdocs/live.d.ts +41 -0
  157. package/dist/cli/tsdocs/live.js +202 -0
  158. package/dist/cli/tsdocs/live.js.map +1 -0
  159. package/dist/cli/tsdocs/locate.d.ts +51 -0
  160. package/dist/cli/tsdocs/locate.js +75 -0
  161. package/dist/cli/tsdocs/locate.js.map +1 -0
  162. package/dist/cli/tsdocs/render.d.ts +75 -0
  163. package/dist/cli/tsdocs/render.js +323 -0
  164. package/dist/cli/tsdocs/render.js.map +1 -0
  165. package/dist/cli/tsdocs/topics.d.ts +43 -0
  166. package/dist/cli/tsdocs/topics.js +916 -0
  167. package/dist/cli/tsdocs/topics.js.map +1 -0
  168. package/dist/index.d.ts +47 -68
  169. package/dist/index.js +44 -73
  170. package/dist/index.js.map +1 -1
  171. package/dist/livewire/index.d.ts +229 -155
  172. package/dist/livewire/index.js +298 -195
  173. package/dist/livewire/index.js.map +1 -1
  174. package/dist/llms.txt +65 -0
  175. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  176. package/dist/prefabs/CallSessionStore.js +72 -0
  177. package/dist/prefabs/CallSessionStore.js.map +1 -0
  178. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  179. package/dist/prefabs/ConciergeAgent.js +36 -31
  180. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  181. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  182. package/dist/prefabs/FAQBotAgent.js +113 -47
  183. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  184. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  185. package/dist/prefabs/InfoGathererAgent.js +67 -58
  186. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  187. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  188. package/dist/prefabs/ReceptionistAgent.js +39 -31
  189. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  190. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  191. package/dist/prefabs/SurveyAgent.js +84 -68
  192. package/dist/prefabs/SurveyAgent.js.map +1 -1
  193. package/dist/relay/Action.d.ts +44 -21
  194. package/dist/relay/Action.js +75 -17
  195. package/dist/relay/Action.js.map +1 -1
  196. package/dist/relay/Call.d.ts +312 -47
  197. package/dist/relay/Call.js +369 -18
  198. package/dist/relay/Call.js.map +1 -1
  199. package/dist/relay/Deferred.js.map +1 -1
  200. package/dist/relay/Message.d.ts +26 -5
  201. package/dist/relay/Message.js +36 -6
  202. package/dist/relay/Message.js.map +1 -1
  203. package/dist/relay/RelayClient.d.ts +44 -17
  204. package/dist/relay/RelayClient.js +175 -65
  205. package/dist/relay/RelayClient.js.map +1 -1
  206. package/dist/relay/RelayError.d.ts +14 -0
  207. package/dist/relay/RelayError.js +15 -0
  208. package/dist/relay/RelayError.js.map +1 -1
  209. package/dist/relay/RelayEvent.d.ts +96 -65
  210. package/dist/relay/RelayEvent.js +85 -56
  211. package/dist/relay/RelayEvent.js.map +1 -1
  212. package/dist/relay/closedSets.d.ts +111 -0
  213. package/dist/relay/closedSets.js +83 -0
  214. package/dist/relay/closedSets.js.map +1 -0
  215. package/dist/relay/index.d.ts +3 -1
  216. package/dist/relay/index.js +1 -0
  217. package/dist/relay/index.js.map +1 -1
  218. package/dist/relay/normalize.js.map +1 -1
  219. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  220. package/dist/relay/protocol.types.generated.js +8 -0
  221. package/dist/relay/protocol.types.generated.js.map +1 -0
  222. package/dist/relay/types.d.ts +73 -42
  223. package/dist/rest/HttpClient.d.ts +36 -8
  224. package/dist/rest/HttpClient.js +233 -40
  225. package/dist/rest/HttpClient.js.map +1 -1
  226. package/dist/rest/RequestOptions.d.ts +110 -0
  227. package/dist/rest/RequestOptions.js +113 -0
  228. package/dist/rest/RequestOptions.js.map +1 -0
  229. package/dist/rest/RestError.d.ts +52 -6
  230. package/dist/rest/RestError.js +89 -5
  231. package/dist/rest/RestError.js.map +1 -1
  232. package/dist/rest/base/CrudResource.d.ts +16 -26
  233. package/dist/rest/base/CrudResource.js +19 -33
  234. package/dist/rest/base/CrudResource.js.map +1 -1
  235. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  236. package/dist/rest/base/CrudWithAddresses.js +2 -2
  237. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  238. package/dist/rest/base/FabricResource.d.ts +15 -0
  239. package/dist/rest/base/FabricResource.js +16 -0
  240. package/dist/rest/base/FabricResource.js.map +1 -0
  241. package/dist/rest/base/ReadResource.d.ts +62 -0
  242. package/dist/rest/base/ReadResource.js +69 -0
  243. package/dist/rest/base/ReadResource.js.map +1 -0
  244. package/dist/rest/callHandler.d.ts +5 -2
  245. package/dist/rest/callHandler.js +4 -1
  246. package/dist/rest/callHandler.js.map +1 -1
  247. package/dist/rest/index.d.ts +18 -77
  248. package/dist/rest/index.js +47 -120
  249. package/dist/rest/index.js.map +1 -1
  250. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  251. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  252. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  253. package/dist/rest/namespaces/addresses.d.ts +3 -42
  254. package/dist/rest/namespaces/addresses.js +3 -50
  255. package/dist/rest/namespaces/addresses.js.map +1 -1
  256. package/dist/rest/namespaces/calling.d.ts +6 -378
  257. package/dist/rest/namespaces/calling.js +6 -473
  258. package/dist/rest/namespaces/calling.js.map +1 -1
  259. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  260. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  261. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  262. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  263. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  264. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  265. package/dist/rest/namespaces/chat.d.ts +4 -18
  266. package/dist/rest/namespaces/chat.js +4 -21
  267. package/dist/rest/namespaces/chat.js.map +1 -1
  268. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  269. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  270. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  271. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  272. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  273. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  274. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  275. package/dist/rest/namespaces/datasphere.js +6 -72
  276. package/dist/rest/namespaces/datasphere.js.map +1 -1
  277. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  278. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  279. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  280. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  281. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  282. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  283. package/dist/rest/namespaces/fabric.d.ts +11 -327
  284. package/dist/rest/namespaces/fabric.js +14 -439
  285. package/dist/rest/namespaces/fabric.js.map +1 -1
  286. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  287. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  288. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  289. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  290. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  291. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  293. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  294. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  296. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  297. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  298. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  299. package/dist/rest/namespaces/imported-numbers.js +3 -21
  300. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  301. package/dist/rest/namespaces/logs.d.ts +10 -101
  302. package/dist/rest/namespaces/logs.js +10 -128
  303. package/dist/rest/namespaces/logs.js.map +1 -1
  304. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  305. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  306. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  307. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  308. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  309. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  310. package/dist/rest/namespaces/lookup.d.ts +3 -25
  311. package/dist/rest/namespaces/lookup.js +3 -27
  312. package/dist/rest/namespaces/lookup.js.map +1 -1
  313. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  314. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  315. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  316. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  317. package/dist/rest/namespaces/message.types.generated.js +8 -0
  318. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  319. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  320. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  321. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  323. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  324. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  325. package/dist/rest/namespaces/mfa.d.ts +3 -42
  326. package/dist/rest/namespaces/mfa.js +3 -49
  327. package/dist/rest/namespaces/mfa.js.map +1 -1
  328. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  329. package/dist/rest/namespaces/number-groups.js +3 -53
  330. package/dist/rest/namespaces/number-groups.js.map +1 -1
  331. package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
  332. package/dist/rest/namespaces/phone-numbers.js +8 -230
  333. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  334. package/dist/rest/namespaces/project.d.ts +6 -42
  335. package/dist/rest/namespaces/project.js +6 -51
  336. package/dist/rest/namespaces/project.js.map +1 -1
  337. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  338. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  339. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  340. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  341. package/dist/rest/namespaces/project.types.generated.js +8 -0
  342. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  343. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  344. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  345. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  347. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  348. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  349. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  350. package/dist/rest/namespaces/pubsub.js +4 -21
  351. package/dist/rest/namespaces/pubsub.js.map +1 -1
  352. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  353. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  354. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  355. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  356. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  357. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  358. package/dist/rest/namespaces/queues.d.ts +3 -38
  359. package/dist/rest/namespaces/queues.js +3 -44
  360. package/dist/rest/namespaces/queues.js.map +1 -1
  361. package/dist/rest/namespaces/recordings.d.ts +3 -34
  362. package/dist/rest/namespaces/recordings.js +3 -40
  363. package/dist/rest/namespaces/recordings.js.map +1 -1
  364. package/dist/rest/namespaces/registry.d.ts +6 -137
  365. package/dist/rest/namespaces/registry.js +6 -173
  366. package/dist/rest/namespaces/registry.js.map +1 -1
  367. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  368. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  369. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  370. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  371. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  372. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  373. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  374. package/dist/rest/namespaces/short-codes.js +3 -41
  375. package/dist/rest/namespaces/short-codes.js.map +1 -1
  376. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  377. package/dist/rest/namespaces/sip-profile.js +3 -29
  378. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  379. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  380. package/dist/rest/namespaces/verified-callers.js +3 -34
  381. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  382. package/dist/rest/namespaces/video.d.ts +10 -227
  383. package/dist/rest/namespaces/video.js +10 -288
  384. package/dist/rest/namespaces/video.js.map +1 -1
  385. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  386. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  387. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  388. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  389. package/dist/rest/namespaces/video.types.generated.js +8 -0
  390. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  391. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  392. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  393. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  395. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  396. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  397. package/dist/rest/pagination.d.ts +5 -1
  398. package/dist/rest/pagination.js +40 -20
  399. package/dist/rest/pagination.js.map +1 -1
  400. package/dist/rest/types.d.ts +21 -3
  401. package/dist/schema.json +299 -98
  402. package/dist/skills/SkillBase.d.ts +97 -20
  403. package/dist/skills/SkillBase.js +100 -17
  404. package/dist/skills/SkillBase.js.map +1 -1
  405. package/dist/skills/SkillManager.d.ts +66 -13
  406. package/dist/skills/SkillManager.js +101 -20
  407. package/dist/skills/SkillManager.js.map +1 -1
  408. package/dist/skills/SkillName.d.ts +44 -0
  409. package/dist/skills/SkillName.js +2 -0
  410. package/dist/skills/SkillName.js.map +1 -0
  411. package/dist/skills/SkillRegistry.d.ts +22 -11
  412. package/dist/skills/SkillRegistry.js +47 -17
  413. package/dist/skills/SkillRegistry.js.map +1 -1
  414. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  415. package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
  416. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  417. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  418. package/dist/skills/builtin/ask_claude.js +36 -14
  419. package/dist/skills/builtin/ask_claude.js.map +1 -1
  420. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  421. package/dist/skills/builtin/claude_skills.js +19 -15
  422. package/dist/skills/builtin/claude_skills.js.map +1 -1
  423. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  424. package/dist/skills/builtin/custom_skills.js +26 -9
  425. package/dist/skills/builtin/custom_skills.js.map +1 -1
  426. package/dist/skills/builtin/datasphere.d.ts +5 -3
  427. package/dist/skills/builtin/datasphere.js +21 -22
  428. package/dist/skills/builtin/datasphere.js.map +1 -1
  429. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  430. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  431. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  432. package/dist/skills/builtin/datetime.d.ts +3 -1
  433. package/dist/skills/builtin/datetime.js +11 -7
  434. package/dist/skills/builtin/datetime.js.map +1 -1
  435. package/dist/skills/builtin/google_maps.d.ts +29 -14
  436. package/dist/skills/builtin/google_maps.js +89 -269
  437. package/dist/skills/builtin/google_maps.js.map +1 -1
  438. package/dist/skills/builtin/index.d.ts +8 -6
  439. package/dist/skills/builtin/index.js +8 -6
  440. package/dist/skills/builtin/index.js.map +1 -1
  441. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  442. package/dist/skills/builtin/info_gatherer.js +20 -12
  443. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  444. package/dist/skills/builtin/joke.d.ts +16 -6
  445. package/dist/skills/builtin/joke.js +54 -37
  446. package/dist/skills/builtin/joke.js.map +1 -1
  447. package/dist/skills/builtin/math.d.ts +3 -1
  448. package/dist/skills/builtin/math.js +14 -9
  449. package/dist/skills/builtin/math.js.map +1 -1
  450. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  451. package/dist/skills/builtin/mcp_gateway.js +77 -46
  452. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  453. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  454. package/dist/skills/builtin/native_vector_search.js +179 -61
  455. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  456. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  457. package/dist/skills/builtin/play_background_file.js +43 -122
  458. package/dist/skills/builtin/play_background_file.js.map +1 -1
  459. package/dist/skills/builtin/spider.d.ts +42 -4
  460. package/dist/skills/builtin/spider.js +277 -104
  461. package/dist/skills/builtin/spider.js.map +1 -1
  462. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  463. package/dist/skills/builtin/swml_transfer.js +45 -24
  464. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  465. package/dist/skills/builtin/weather_api.d.ts +24 -13
  466. package/dist/skills/builtin/weather_api.js +38 -30
  467. package/dist/skills/builtin/weather_api.js.map +1 -1
  468. package/dist/skills/builtin/web_search.d.ts +48 -10
  469. package/dist/skills/builtin/web_search.js +294 -100
  470. package/dist/skills/builtin/web_search.js.map +1 -1
  471. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  472. package/dist/skills/builtin/wikipedia_search.js +14 -13
  473. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  474. package/dist/skills/index.d.ts +3 -2
  475. package/dist/skills/index.js +1 -1
  476. package/dist/skills/index.js.map +1 -1
  477. package/dist/swml_verbs_generated.d.ts +2824 -0
  478. package/dist/swml_verbs_generated.js +12 -0
  479. package/dist/swml_verbs_generated.js.map +1 -0
  480. package/dist/types.d.ts +59 -6
  481. package/dist/web.d.ts +27 -0
  482. package/dist/web.js +20 -0
  483. package/dist/web.js.map +1 -0
  484. package/docs/agent-guide.md +1034 -0
  485. package/docs/ai_chat.md +560 -0
  486. package/docs/api-reference.md +3534 -0
  487. package/docs/architecture.md +846 -0
  488. package/docs/bedrock_agent.md +411 -0
  489. package/docs/cli-guide.md +403 -0
  490. package/docs/cloud_functions_guide.md +399 -0
  491. package/docs/configuration.md +548 -0
  492. package/docs/contexts-guide.md +884 -0
  493. package/docs/datamap-guide.md +1160 -0
  494. package/docs/developer_pain_points.md +548 -0
  495. package/docs/llm_parameters.md +298 -0
  496. package/docs/mcp_gateway_reference.md +354 -0
  497. package/docs/mcp_integration.md +162 -0
  498. package/docs/pgi_agent_guide.md +1820 -0
  499. package/docs/prefabs-guide.md +815 -0
  500. package/docs/programmatically_governed_inference.md +301 -0
  501. package/docs/sdk_features.md +501 -0
  502. package/docs/security.md +559 -0
  503. package/docs/serverless-guide.md +520 -0
  504. package/docs/skills-guide.md +1223 -0
  505. package/docs/skills-system.md +405 -0
  506. package/docs/skills_parameter_schema.md +417 -0
  507. package/docs/swaig-reference.md +1938 -0
  508. package/docs/swml_service_guide.md +573 -0
  509. package/docs/third_party_skills.md +410 -0
  510. package/docs/web_service.md +666 -0
  511. package/examples/README.md +202 -0
  512. package/examples/advanced-datamap.ts +108 -0
  513. package/examples/advanced-dynamic-config.ts +70 -0
  514. package/examples/auto-vivified.ts +95 -0
  515. package/examples/call-flow.ts +65 -0
  516. package/examples/comprehensive-dynamic.ts +125 -0
  517. package/examples/contexts-steps.ts +65 -0
  518. package/examples/custom-path.ts +45 -0
  519. package/examples/datamap-tools.ts +51 -0
  520. package/examples/datasphere-multi-instance.ts +66 -0
  521. package/examples/datasphere-serverless-env.ts +87 -0
  522. package/examples/datasphere-webhook-env.ts +65 -0
  523. package/examples/datasphere.ts +56 -0
  524. package/examples/declarative.ts +100 -0
  525. package/examples/dynamic-config.ts +54 -0
  526. package/examples/dynamic-info-gatherer.ts +69 -0
  527. package/examples/dynamic-swml-service.ts +67 -0
  528. package/examples/gather-info.ts +95 -0
  529. package/examples/gather-per-question-functions-demo.ts +139 -0
  530. package/examples/joke-agent.ts +34 -0
  531. package/examples/kubernetes-agent.ts +45 -0
  532. package/examples/llm-params.ts +75 -0
  533. package/examples/mcp-agent.ts +89 -0
  534. package/examples/mcp-gateway.ts +81 -0
  535. package/examples/multi-agent.ts +80 -0
  536. package/examples/multi-endpoint.ts +79 -0
  537. package/examples/pgi/case-domain.ts +114 -0
  538. package/examples/pgi/serve.ts +16 -0
  539. package/examples/pgi/support-agent.ts +265 -0
  540. package/examples/pom-prompt.ts +70 -0
  541. package/examples/prefab-concierge.ts +42 -0
  542. package/examples/prefab-faq.ts +58 -0
  543. package/examples/prefab-info-gatherer.ts +33 -0
  544. package/examples/prefab-receptionist.ts +36 -0
  545. package/examples/prefab-survey.ts +69 -0
  546. package/examples/quickstart-agent.ts +29 -0
  547. package/examples/quickstart-relay.ts +25 -0
  548. package/examples/quickstart-rest.ts +25 -0
  549. package/examples/record-call.ts +65 -0
  550. package/examples/relay-demo.ts +33 -0
  551. package/examples/room-and-sip.ts +93 -0
  552. package/examples/serverless-lambda.ts +43 -0
  553. package/examples/session-state.ts +83 -0
  554. package/examples/simple-agent.ts +36 -0
  555. package/examples/simple-static.ts +29 -0
  556. package/examples/skills-demo.ts +41 -0
  557. package/examples/step-function-inheritance-demo.ts +124 -0
  558. package/examples/swaig-features.ts +193 -0
  559. package/examples/swml-service-routing.ts +66 -0
  560. package/examples/swml-service.ts +38 -0
  561. package/examples/swmlservice_ai_sidecar.ts +104 -0
  562. package/examples/swmlservice_swaig_standalone.ts +79 -0
  563. package/examples/tap.ts +67 -0
  564. package/examples/typed-tools.ts +68 -0
  565. package/examples/verb-methods.ts +45 -0
  566. package/examples/web-search-multi-instance.ts +75 -0
  567. package/examples/web-search.ts +38 -0
  568. package/examples/wikipedia.ts +36 -0
  569. package/livewire/README.md +164 -0
  570. package/livewire/docs/migration-guide.md +251 -0
  571. package/livewire/examples/livewire-basic-agent.ts +74 -0
  572. package/livewire/examples/livewire-handoff.ts +196 -0
  573. package/livewire/examples/livewire-multi-tool.ts +121 -0
  574. package/package.json +85 -13
  575. package/relay/README.md +101 -0
  576. package/relay/docs/call-methods.md +622 -0
  577. package/relay/docs/client-reference.md +281 -0
  578. package/relay/docs/events.md +193 -0
  579. package/relay/docs/getting-started.md +221 -0
  580. package/relay/docs/guide.md +386 -0
  581. package/relay/docs/messaging.md +246 -0
  582. package/relay/examples/relay-inbound.ts +66 -0
  583. package/relay/examples/relay-messaging.ts +74 -0
  584. package/relay/examples/relay-outbound.ts +76 -0
  585. package/rest/README.md +141 -0
  586. package/rest/docs/calling.md +313 -0
  587. package/rest/docs/client-reference.md +149 -0
  588. package/rest/docs/fabric.md +192 -0
  589. package/rest/docs/getting-started.md +138 -0
  590. package/rest/docs/guide.md +421 -0
  591. package/rest/docs/namespaces.md +367 -0
  592. package/rest/docs/phone-binding.md +116 -0
  593. package/rest/examples/rest-10dlc-registration.ts +177 -0
  594. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  595. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  596. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  597. package/rest/examples/rest-client.ts +59 -0
  598. package/rest/examples/rest-datasphere-search.ts +81 -0
  599. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  600. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  601. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  602. package/rest/examples/rest-manage-resources.ts +64 -0
  603. package/rest/examples/rest-phone-number-management.ts +200 -0
  604. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  605. package/rest/examples/rest-video-rooms.ts +186 -0
  606. package/tutorial/fred/fred.ts +218 -0
  607. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  608. package/tutorial/fred/tutorial/02-setup.md +304 -0
  609. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  610. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  611. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  612. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  613. package/tutorial/fred/tutorial/README.md +56 -0
  614. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  615. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  616. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  617. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  618. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  619. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  620. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  621. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  622. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  623. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  624. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  625. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  626. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  627. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  628. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  629. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  630. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  631. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  632. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  633. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  634. package/tutorial/multi_agents/README.md +175 -0
  635. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  636. package/tutorial/multi_agents/extending_agents.ts +641 -0
  637. package/tutorial/multi_agents/knowledge.ts +59 -0
  638. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  639. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  640. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  641. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  642. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  643. package/tutorial/multi_agents/pc_builder.ts +529 -0
  644. package/tutorial/multi_agents/sales_agent.ts +88 -0
  645. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  646. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  647. package/tutorial/multi_agents/support_knowledge.md +256 -0
  648. package/dist/cli/mock-data.d.ts +0 -37
  649. package/dist/cli/mock-data.js +0 -80
  650. package/dist/cli/mock-data.js.map +0 -1
  651. package/dist/generateVerbTypes.d.ts +0 -11
  652. package/dist/generateVerbTypes.js +0 -265
  653. package/dist/generateVerbTypes.js.map +0 -1
  654. package/dist/rest/namespaces/compat.d.ts +0 -585
  655. package/dist/rest/namespaces/compat.js +0 -735
  656. package/dist/rest/namespaces/compat.js.map +0 -1
package/dist/schema.json CHANGED
@@ -75,6 +75,9 @@
75
75
  {
76
76
  "$ref": "#/$defs/LiveTranscribe"
77
77
  },
78
+ {
79
+ "$ref": "#/$defs/AiSidecar"
80
+ },
78
81
  {
79
82
  "$ref": "#/$defs/LiveTranslate"
80
83
  },
@@ -572,7 +575,8 @@
572
575
  "examples": [
573
576
  "busy"
574
577
  ],
575
- "description": "The reason for hanging up the call."
578
+ "description": "The reason for hanging up the call.",
579
+ "x-sdk-widen": true
576
580
  }
577
581
  },
578
582
  "unevaluatedProperties": {
@@ -727,7 +731,11 @@
727
731
  "examples": [
728
732
  "female"
729
733
  ],
730
- "description": "The gender to use for the text to speech."
734
+ "description": "The gender to use for the text to speech.",
735
+ "x-sdk-enum-literal": [
736
+ "male",
737
+ "female"
738
+ ]
731
739
  },
732
740
  "max_digits": {
733
741
  "anyOf": [
@@ -2582,16 +2590,24 @@
2582
2590
  "description": "Time, in seconds, to set the SIP `Session-Expires` header in INVITE.\nMust be a positive, non-zero number.\nIt has no effect on calls to phone numbers.\nBased on SignalWire settings."
2583
2591
  },
2584
2592
  "ringback": {
2585
- "type": "array",
2586
- "items": {
2587
- "type": "string"
2588
- },
2589
- "examples": [
2590
- [
2591
- "https://example.com/ringback.mp3"
2592
- ]
2593
+ "oneOf": [
2594
+ {
2595
+ "type": "array",
2596
+ "items": {
2597
+ "type": "string"
2598
+ },
2599
+ "examples": [
2600
+ [
2601
+ "https://example.com/ringback.mp3"
2602
+ ]
2603
+ ],
2604
+ "description": "Array of URIs to play as ringback (legacy form)."
2605
+ },
2606
+ {
2607
+ "$ref": "#/$defs/RingbackConfig"
2608
+ }
2593
2609
  ],
2594
- "description": "Array of URIs to play as ringback tone. If not specified, plays audio from the provider."
2610
+ "description": "Ringback to play while the far end rings: a legacy array of URIs, or a RingbackConfig object."
2595
2611
  },
2596
2612
  "result": {
2597
2613
  "anyOf": [
@@ -2824,16 +2840,24 @@
2824
2840
  "description": "Time, in seconds, to set the SIP `Session-Expires` header in INVITE.\nMust be a positive, non-zero number.\nIt has no effect on calls to phone numbers.\nBased on SignalWire settings."
2825
2841
  },
2826
2842
  "ringback": {
2827
- "type": "array",
2828
- "items": {
2829
- "type": "string"
2830
- },
2831
- "examples": [
2832
- [
2833
- "https://example.com/ringback.mp3"
2834
- ]
2843
+ "oneOf": [
2844
+ {
2845
+ "type": "array",
2846
+ "items": {
2847
+ "type": "string"
2848
+ },
2849
+ "examples": [
2850
+ [
2851
+ "https://example.com/ringback.mp3"
2852
+ ]
2853
+ ],
2854
+ "description": "Array of URIs to play as ringback (legacy form)."
2855
+ },
2856
+ {
2857
+ "$ref": "#/$defs/RingbackConfig"
2858
+ }
2835
2859
  ],
2836
- "description": "Array of URIs to play as ringback tone. If not specified, plays audio from the provider."
2860
+ "description": "Ringback to play while the far end rings: a legacy array of URIs, or a RingbackConfig object."
2837
2861
  },
2838
2862
  "result": {
2839
2863
  "anyOf": [
@@ -3065,16 +3089,24 @@
3065
3089
  "description": "Time, in seconds, to set the SIP `Session-Expires` header in INVITE.\nMust be a positive, non-zero number.\nIt has no effect on calls to phone numbers.\nBased on SignalWire settings."
3066
3090
  },
3067
3091
  "ringback": {
3068
- "type": "array",
3069
- "items": {
3070
- "type": "string"
3071
- },
3072
- "examples": [
3073
- [
3074
- "https://example.com/ringback.mp3"
3075
- ]
3092
+ "oneOf": [
3093
+ {
3094
+ "type": "array",
3095
+ "items": {
3096
+ "type": "string"
3097
+ },
3098
+ "examples": [
3099
+ [
3100
+ "https://example.com/ringback.mp3"
3101
+ ]
3102
+ ],
3103
+ "description": "Array of URIs to play as ringback (legacy form)."
3104
+ },
3105
+ {
3106
+ "$ref": "#/$defs/RingbackConfig"
3107
+ }
3076
3108
  ],
3077
- "description": "Array of URIs to play as ringback tone. If not specified, plays audio from the provider."
3109
+ "description": "Ringback to play while the far end rings: a legacy array of URIs, or a RingbackConfig object."
3078
3110
  },
3079
3111
  "result": {
3080
3112
  "anyOf": [
@@ -3307,16 +3339,24 @@
3307
3339
  "description": "Time, in seconds, to set the SIP `Session-Expires` header in INVITE.\nMust be a positive, non-zero number.\nIt has no effect on calls to phone numbers.\nBased on SignalWire settings."
3308
3340
  },
3309
3341
  "ringback": {
3310
- "type": "array",
3311
- "items": {
3312
- "type": "string"
3313
- },
3314
- "examples": [
3315
- [
3316
- "https://example.com/ringback.mp3"
3317
- ]
3342
+ "oneOf": [
3343
+ {
3344
+ "type": "array",
3345
+ "items": {
3346
+ "type": "string"
3347
+ },
3348
+ "examples": [
3349
+ [
3350
+ "https://example.com/ringback.mp3"
3351
+ ]
3352
+ ],
3353
+ "description": "Array of URIs to play as ringback (legacy form)."
3354
+ },
3355
+ {
3356
+ "$ref": "#/$defs/RingbackConfig"
3357
+ }
3318
3358
  ],
3319
- "description": "Array of URIs to play as ringback tone. If not specified, plays audio from the provider."
3359
+ "description": "Ringback to play while the far end rings: a legacy array of URIs, or a RingbackConfig object."
3320
3360
  },
3321
3361
  "result": {
3322
3362
  "anyOf": [
@@ -4033,7 +4073,11 @@
4033
4073
  "examples": [
4034
4074
  "female"
4035
4075
  ],
4036
- "description": "Gender to use for the text to speech."
4076
+ "description": "Gender to use for the text to speech.",
4077
+ "x-sdk-enum-literal": [
4078
+ "male",
4079
+ "female"
4080
+ ]
4037
4081
  },
4038
4082
  "status_url": {
4039
4083
  "type": "string",
@@ -4124,7 +4168,11 @@
4124
4168
  "examples": [
4125
4169
  "female"
4126
4170
  ],
4127
- "description": "Gender to use for the text to speech."
4171
+ "description": "Gender to use for the text to speech.",
4172
+ "x-sdk-enum-literal": [
4173
+ "male",
4174
+ "female"
4175
+ ]
4128
4176
  },
4129
4177
  "status_url": {
4130
4178
  "type": "string",
@@ -8775,8 +8823,8 @@
8775
8823
  },
8776
8824
  "examples": [
8777
8825
  [
8778
- "един момент",
8779
- "нека проверя"
8826
+ "\u0435\u0434\u0438\u043d \u043c\u043e\u043c\u0435\u043d\u0442",
8827
+ "\u043d\u0435\u043a\u0430 \u043f\u0440\u043e\u0432\u0435\u0440\u044f"
8780
8828
  ]
8781
8829
  ],
8782
8830
  "description": "Bulgarian"
@@ -8823,8 +8871,8 @@
8823
8871
  },
8824
8872
  "examples": [
8825
8873
  [
8826
- "请稍等",
8827
- "让我查一下"
8874
+ "\u8bf7\u7a0d\u7b49",
8875
+ "\u8ba9\u6211\u67e5\u4e00\u4e0b"
8828
8876
  ]
8829
8877
  ],
8830
8878
  "description": "Chinese (Simplified)"
@@ -8847,8 +8895,8 @@
8847
8895
  },
8848
8896
  "examples": [
8849
8897
  [
8850
- "请稍等",
8851
- "让我查一下"
8898
+ "\u8bf7\u7a0d\u7b49",
8899
+ "\u8ba9\u6211\u67e5\u4e00\u4e0b"
8852
8900
  ]
8853
8901
  ],
8854
8902
  "description": "Chinese (Simplified, China)"
@@ -8871,8 +8919,8 @@
8871
8919
  },
8872
8920
  "examples": [
8873
8921
  [
8874
- "请稍等",
8875
- "让我查一下"
8922
+ "\u8bf7\u7a0d\u7b49",
8923
+ "\u8ba9\u6211\u67e5\u4e00\u4e0b"
8876
8924
  ]
8877
8925
  ],
8878
8926
  "description": "Chinese (Simplified Han)"
@@ -8895,8 +8943,8 @@
8895
8943
  },
8896
8944
  "examples": [
8897
8945
  [
8898
- "請稍等",
8899
- "讓我查一下"
8946
+ "\u8acb\u7a0d\u7b49",
8947
+ "\u8b93\u6211\u67e5\u4e00\u4e0b"
8900
8948
  ]
8901
8949
  ],
8902
8950
  "description": "Chinese (Traditional, Taiwan)"
@@ -8919,8 +8967,8 @@
8919
8967
  },
8920
8968
  "examples": [
8921
8969
  [
8922
- "請稍等",
8923
- "讓我查一下"
8970
+ "\u8acb\u7a0d\u7b49",
8971
+ "\u8b93\u6211\u67e5\u4e00\u4e0b"
8924
8972
  ]
8925
8973
  ],
8926
8974
  "description": "Chinese (Traditional Han)"
@@ -8943,8 +8991,8 @@
8943
8991
  },
8944
8992
  "examples": [
8945
8993
  [
8946
- "請稍等",
8947
- "讓我查一下"
8994
+ "\u8acb\u7a0d\u7b49",
8995
+ "\u8b93\u6211\u67e5\u4e00\u4e0b"
8948
8996
  ]
8949
8997
  ],
8950
8998
  "description": "Chinese (Traditional, Hong Kong)"
@@ -8967,8 +9015,8 @@
8967
9015
  },
8968
9016
  "examples": [
8969
9017
  [
8970
- "moment prosím",
8971
- "nechte mě zkontrolovat"
9018
+ "moment pros\u00edm",
9019
+ "nechte m\u011b zkontrolovat"
8972
9020
  ]
8973
9021
  ],
8974
9022
  "description": "Czech"
@@ -8991,7 +9039,7 @@
8991
9039
  },
8992
9040
  "examples": [
8993
9041
  [
8994
- "et øjeblik",
9042
+ "et \u00f8jeblik",
8995
9043
  "lad mig tjekke"
8996
9044
  ]
8997
9045
  ],
@@ -9015,7 +9063,7 @@
9015
9063
  },
9016
9064
  "examples": [
9017
9065
  [
9018
- "et øjeblik",
9066
+ "et \u00f8jeblik",
9019
9067
  "lad mig tjekke"
9020
9068
  ]
9021
9069
  ],
@@ -9207,7 +9255,7 @@
9207
9255
  },
9208
9256
  "examples": [
9209
9257
  [
9210
- "üks hetk",
9258
+ "\u00fcks hetk",
9211
9259
  "las ma kontrollin"
9212
9260
  ]
9213
9261
  ],
@@ -9280,7 +9328,7 @@
9280
9328
  "examples": [
9281
9329
  [
9282
9330
  "un instant",
9283
- "laissez-moi vérifier"
9331
+ "laissez-moi v\u00e9rifier"
9284
9332
  ]
9285
9333
  ],
9286
9334
  "description": "French"
@@ -9304,7 +9352,7 @@
9304
9352
  "examples": [
9305
9353
  [
9306
9354
  "un instant",
9307
- "laissez-moi vérifier"
9355
+ "laissez-moi v\u00e9rifier"
9308
9356
  ]
9309
9357
  ],
9310
9358
  "description": "French (Canada)"
@@ -9375,8 +9423,8 @@
9375
9423
  },
9376
9424
  "examples": [
9377
9425
  [
9378
- "μια στιγμή",
9379
- "επιτρέψτε μου να ελέγξω"
9426
+ "\u03bc\u03b9\u03b1 \u03c3\u03c4\u03b9\u03b3\u03bc\u03ae",
9427
+ "\u03b5\u03c0\u03b9\u03c4\u03c1\u03ad\u03c8\u03c4\u03b5 \u03bc\u03bf\u03c5 \u03bd\u03b1 \u03b5\u03bb\u03ad\u03b3\u03be\u03c9"
9380
9428
  ]
9381
9429
  ],
9382
9430
  "description": "Greek"
@@ -9399,8 +9447,8 @@
9399
9447
  },
9400
9448
  "examples": [
9401
9449
  [
9402
- "एक पल रुकिए",
9403
- "मुझे जांचने दीजिए"
9450
+ "\u090f\u0915 \u092a\u0932 \u0930\u0941\u0915\u093f\u090f",
9451
+ "\u092e\u0941\u091d\u0947 \u091c\u093e\u0902\u091a\u0928\u0947 \u0926\u0940\u091c\u093f\u090f"
9404
9452
  ]
9405
9453
  ],
9406
9454
  "description": "Hindi"
@@ -9424,7 +9472,7 @@
9424
9472
  "examples": [
9425
9473
  [
9426
9474
  "egy pillanat",
9427
- "hadd ellenőrizzem"
9475
+ "hadd ellen\u0151rizzem"
9428
9476
  ]
9429
9477
  ],
9430
9478
  "description": "Hungarian"
@@ -9495,8 +9543,8 @@
9495
9543
  },
9496
9544
  "examples": [
9497
9545
  [
9498
- "少々お待ちください",
9499
- "確認いたします"
9546
+ "\u5c11\u3005\u304a\u5f85\u3061\u304f\u3060\u3055\u3044",
9547
+ "\u78ba\u8a8d\u3044\u305f\u3057\u307e\u3059"
9500
9548
  ]
9501
9549
  ],
9502
9550
  "description": "Japanese"
@@ -9519,8 +9567,8 @@
9519
9567
  },
9520
9568
  "examples": [
9521
9569
  [
9522
- "잠시만요",
9523
- "확인해 보겠습니다"
9570
+ "\uc7a0\uc2dc\ub9cc\uc694",
9571
+ "\ud655\uc778\ud574 \ubcf4\uaca0\uc2b5\ub2c8\ub2e4"
9524
9572
  ]
9525
9573
  ],
9526
9574
  "description": "Korean"
@@ -9543,8 +9591,8 @@
9543
9591
  },
9544
9592
  "examples": [
9545
9593
  [
9546
- "잠시만요",
9547
- "확인해 보겠습니다"
9594
+ "\uc7a0\uc2dc\ub9cc\uc694",
9595
+ "\ud655\uc778\ud574 \ubcf4\uaca0\uc2b5\ub2c8\ub2e4"
9548
9596
  ]
9549
9597
  ],
9550
9598
  "description": "Korean (South Korea)"
@@ -9567,8 +9615,8 @@
9567
9615
  },
9568
9616
  "examples": [
9569
9617
  [
9570
- "vienu brīdi",
9571
- "ļaujiet man pārbaudīt"
9618
+ "vienu br\u012bdi",
9619
+ "\u013caujiet man p\u0101rbaud\u012bt"
9572
9620
  ]
9573
9621
  ],
9574
9622
  "description": "Latvian"
@@ -9591,7 +9639,7 @@
9591
9639
  },
9592
9640
  "examples": [
9593
9641
  [
9594
- "vieną akimirką",
9642
+ "vien\u0105 akimirk\u0105",
9595
9643
  "leiskite patikrinti"
9596
9644
  ]
9597
9645
  ],
@@ -9663,7 +9711,7 @@
9663
9711
  },
9664
9712
  "examples": [
9665
9713
  [
9666
- "et øyeblikk",
9714
+ "et \u00f8yeblikk",
9667
9715
  "la meg sjekke"
9668
9716
  ]
9669
9717
  ],
@@ -9687,8 +9735,8 @@
9687
9735
  },
9688
9736
  "examples": [
9689
9737
  [
9690
- "chwileczkę",
9691
- "pozwól mi sprawdzić"
9738
+ "chwileczk\u0119",
9739
+ "pozw\u00f3l mi sprawdzi\u0107"
9692
9740
  ]
9693
9741
  ],
9694
9742
  "description": "Polish"
@@ -9784,7 +9832,7 @@
9784
9832
  "examples": [
9785
9833
  [
9786
9834
  "un moment",
9787
- "să verific"
9835
+ "s\u0103 verific"
9788
9836
  ]
9789
9837
  ],
9790
9838
  "description": "Romanian"
@@ -9807,8 +9855,8 @@
9807
9855
  },
9808
9856
  "examples": [
9809
9857
  [
9810
- "одну минуту",
9811
- "позвольте проверить"
9858
+ "\u043e\u0434\u043d\u0443 \u043c\u0438\u043d\u0443\u0442\u0443",
9859
+ "\u043f\u043e\u0437\u0432\u043e\u043b\u044c\u0442\u0435 \u043f\u0440\u043e\u0432\u0435\u0440\u0438\u0442\u044c"
9812
9860
  ]
9813
9861
  ],
9814
9862
  "description": "Russian"
@@ -9831,8 +9879,8 @@
9831
9879
  },
9832
9880
  "examples": [
9833
9881
  [
9834
- "moment prosím",
9835
- "dovoľte mi skontrolovať"
9882
+ "moment pros\u00edm",
9883
+ "dovo\u013ete mi skontrolova\u0165"
9836
9884
  ]
9837
9885
  ],
9838
9886
  "description": "Slovak"
@@ -9856,7 +9904,7 @@
9856
9904
  "examples": [
9857
9905
  [
9858
9906
  "un momento",
9859
- "déjame verificar"
9907
+ "d\u00e9jame verificar"
9860
9908
  ]
9861
9909
  ],
9862
9910
  "description": "Spanish"
@@ -9880,7 +9928,7 @@
9880
9928
  "examples": [
9881
9929
  [
9882
9930
  "un momento",
9883
- "déjame verificar"
9931
+ "d\u00e9jame verificar"
9884
9932
  ]
9885
9933
  ],
9886
9934
  "description": "Spanish (Latin America)"
@@ -9903,8 +9951,8 @@
9903
9951
  },
9904
9952
  "examples": [
9905
9953
  [
9906
- "ett ögonblick",
9907
- "låt mig kolla"
9954
+ "ett \u00f6gonblick",
9955
+ "l\u00e5t mig kolla"
9908
9956
  ]
9909
9957
  ],
9910
9958
  "description": "Swedish"
@@ -9927,8 +9975,8 @@
9927
9975
  },
9928
9976
  "examples": [
9929
9977
  [
9930
- "ett ögonblick",
9931
- "låt mig kolla"
9978
+ "ett \u00f6gonblick",
9979
+ "l\u00e5t mig kolla"
9932
9980
  ]
9933
9981
  ],
9934
9982
  "description": "Swedish (Sweden)"
@@ -9951,8 +9999,8 @@
9951
9999
  },
9952
10000
  "examples": [
9953
10001
  [
9954
- "สักครู่",
9955
- "ให้ผมตรวจสอบ"
10002
+ "\u0e2a\u0e31\u0e01\u0e04\u0e23\u0e39\u0e48",
10003
+ "\u0e43\u0e2b\u0e49\u0e1c\u0e21\u0e15\u0e23\u0e27\u0e08\u0e2a\u0e2d\u0e1a"
9956
10004
  ]
9957
10005
  ],
9958
10006
  "description": "Thai"
@@ -9975,8 +10023,8 @@
9975
10023
  },
9976
10024
  "examples": [
9977
10025
  [
9978
- "สักครู่",
9979
- "ให้ผมตรวจสอบ"
10026
+ "\u0e2a\u0e31\u0e01\u0e04\u0e23\u0e39\u0e48",
10027
+ "\u0e43\u0e2b\u0e49\u0e1c\u0e21\u0e15\u0e23\u0e27\u0e08\u0e2a\u0e2d\u0e1a"
9980
10028
  ]
9981
10029
  ],
9982
10030
  "description": "Thai (Thailand)"
@@ -10023,8 +10071,8 @@
10023
10071
  },
10024
10072
  "examples": [
10025
10073
  [
10026
- "одну хвилину",
10027
- "дозвольте перевірити"
10074
+ "\u043e\u0434\u043d\u0443 \u0445\u0432\u0438\u043b\u0438\u043d\u0443",
10075
+ "\u0434\u043e\u0437\u0432\u043e\u043b\u044c\u0442\u0435 \u043f\u0435\u0440\u0435\u0432\u0456\u0440\u0438\u0442\u0438"
10028
10076
  ]
10029
10077
  ],
10030
10078
  "description": "Ukrainian"
@@ -10047,8 +10095,8 @@
10047
10095
  },
10048
10096
  "examples": [
10049
10097
  [
10050
- "xin chờ một chút",
10051
- "để tôi kiểm tra"
10098
+ "xin ch\u1edd m\u1ed9t ch\u00fat",
10099
+ "\u0111\u1ec3 t\u00f4i ki\u1ec3m tra"
10052
10100
  ]
10053
10101
  ],
10054
10102
  "description": "Vietnamese"
@@ -12245,6 +12293,159 @@
12245
12293
  "not": {}
12246
12294
  },
12247
12295
  "title": "UserInputAction object"
12296
+ },
12297
+ "AiSidecar": {
12298
+ "type": "object",
12299
+ "properties": {
12300
+ "ai_sidecar": {
12301
+ "type": "object",
12302
+ "properties": {
12303
+ "prompt": {
12304
+ "oneOf": [
12305
+ {
12306
+ "type": "string"
12307
+ },
12308
+ {
12309
+ "type": "object",
12310
+ "not": {
12311
+ "required": [
12312
+ "file"
12313
+ ]
12314
+ },
12315
+ "description": "POM object passed through to mod_openai's prompt resolver."
12316
+ },
12317
+ {
12318
+ "type": "object",
12319
+ "properties": {
12320
+ "file": {
12321
+ "type": "string"
12322
+ }
12323
+ },
12324
+ "required": [
12325
+ "file"
12326
+ ]
12327
+ }
12328
+ ],
12329
+ "description": "Operator prompt \u2014 POM object, plain string, or {file: path}."
12330
+ },
12331
+ "lang": {
12332
+ "type": "string",
12333
+ "description": "BCP-47 conversation language. Required."
12334
+ },
12335
+ "model": {
12336
+ "type": "string",
12337
+ "description": "LLM model for sidecar tick + close-time summaries."
12338
+ },
12339
+ "direction": {
12340
+ "type": "array",
12341
+ "items": {
12342
+ "type": "string",
12343
+ "enum": [
12344
+ "remote-caller",
12345
+ "local-caller"
12346
+ ]
12347
+ },
12348
+ "minItems": 2,
12349
+ "uniqueItems": true,
12350
+ "description": "Both legs are required for sidecar mode."
12351
+ },
12352
+ "customer_role": {
12353
+ "type": "string",
12354
+ "enum": [
12355
+ "remote-caller",
12356
+ "local-caller"
12357
+ ],
12358
+ "description": "Which leg is the customer (turn-end trigger source)."
12359
+ },
12360
+ "url": {
12361
+ "type": "string",
12362
+ "description": "Webhook URL for transcribe events AND sidecar events."
12363
+ },
12364
+ "SWAIG": {
12365
+ "$ref": "#/$defs/SWAIG",
12366
+ "description": "SWAIG functions and MCP servers."
12367
+ },
12368
+ "permissions": {
12369
+ "type": "object",
12370
+ "description": "SWAIG permission overrides \u2014 pass-through to mod_openai.",
12371
+ "additionalProperties": true
12372
+ },
12373
+ "global_data": {
12374
+ "type": "object",
12375
+ "description": "Initial sidecar global_data.",
12376
+ "additionalProperties": true
12377
+ },
12378
+ "hints": {
12379
+ "type": "array",
12380
+ "items": {
12381
+ "type": "string"
12382
+ },
12383
+ "description": "Speech-recognition hints biasing ASR toward specific terms."
12384
+ },
12385
+ "params": {
12386
+ "type": "object",
12387
+ "description": "Tunable knobs (idle_timeout_ms, ai_summary, etc.) \u2014 pass-through to mod_openai which validates them strictly. New tunables only land here.",
12388
+ "additionalProperties": true
12389
+ },
12390
+ "action": {
12391
+ "description": "Reserved for future runtime sub-actions."
12392
+ }
12393
+ },
12394
+ "required": [
12395
+ "prompt",
12396
+ "lang"
12397
+ ],
12398
+ "additionalProperties": false,
12399
+ "description": "Start ai_sidecar mode \u2014 live_transcribe with an LLM/SWAIG/MCP loop on top.",
12400
+ "title": "ai_sidecar"
12401
+ }
12402
+ },
12403
+ "required": [
12404
+ "ai_sidecar"
12405
+ ],
12406
+ "additionalProperties": false,
12407
+ "title": "AiSidecar object"
12408
+ },
12409
+ "RingbackConfig": {
12410
+ "type": "object",
12411
+ "properties": {
12412
+ "url": {
12413
+ "type": "string"
12414
+ },
12415
+ "urls": {
12416
+ "type": "array",
12417
+ "items": {
12418
+ "type": "string"
12419
+ }
12420
+ },
12421
+ "volume": {
12422
+ "type": "number"
12423
+ },
12424
+ "auto_answer": {
12425
+ "type": "boolean"
12426
+ },
12427
+ "say_voice": {
12428
+ "type": "string"
12429
+ },
12430
+ "say_language": {
12431
+ "type": "string"
12432
+ },
12433
+ "say_gender": {
12434
+ "type": "string",
12435
+ "x-sdk-enum-literal": [
12436
+ "male",
12437
+ "female"
12438
+ ]
12439
+ },
12440
+ "status_url": {
12441
+ "type": "string"
12442
+ },
12443
+ "loop": {
12444
+ "type": "integer"
12445
+ }
12446
+ },
12447
+ "additionalProperties": false,
12448
+ "description": "Ringback configuration (the modern object form). Declared as a named $defs entry so every generator emits a TYPED shape via $ref rather than collapsing an inline object to an untyped map; the legacy URI array remains the other oneOf branch."
12248
12449
  }
12249
12450
  }
12250
- }
12451
+ }