@signalwire/sdk 2.0.5 → 3.6.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 (659) hide show
  1. package/CHANGELOG.md +821 -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 +510 -126
  6. package/dist/AgentBase.js +1581 -455
  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 +186 -45
  21. package/dist/DataMap.js +210 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +309 -83
  24. package/dist/FunctionResult.js +483 -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 +169 -59
  58. package/dist/SWMLService.js +456 -129
  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/SemanticGate.d.ts +183 -0
  67. package/dist/SemanticGate.js +533 -0
  68. package/dist/SemanticGate.js.map +1 -0
  69. package/dist/ServerlessAdapter.d.ts +156 -7
  70. package/dist/ServerlessAdapter.js +399 -42
  71. package/dist/ServerlessAdapter.js.map +1 -1
  72. package/dist/SessionManager.d.ts +11 -2
  73. package/dist/SessionManager.js +50 -18
  74. package/dist/SessionManager.js.map +1 -1
  75. package/dist/SslConfig.d.ts +2 -1
  76. package/dist/SslConfig.js +4 -1
  77. package/dist/SslConfig.js.map +1 -1
  78. package/dist/SwaigActions.generated.d.ts +23 -0
  79. package/dist/SwaigActions.generated.js +8 -0
  80. package/dist/SwaigActions.generated.js.map +1 -0
  81. package/dist/SwaigContracts.d.ts +15 -0
  82. package/dist/SwaigContracts.generated.d.ts +264 -0
  83. package/dist/SwaigContracts.generated.js +12 -0
  84. package/dist/SwaigContracts.generated.js.map +1 -0
  85. package/dist/SwaigContracts.js +2 -0
  86. package/dist/SwaigContracts.js.map +1 -0
  87. package/dist/SwaigFunction.d.ts +139 -7
  88. package/dist/SwaigFunction.js +170 -22
  89. package/dist/SwaigFunction.js.map +1 -1
  90. package/dist/SwmlBuilder.d.ts +68 -19
  91. package/dist/SwmlBuilder.js +74 -38
  92. package/dist/SwmlBuilder.js.map +1 -1
  93. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  94. package/dist/SwmlVerbMethods.generated.js +1 -1
  95. package/dist/TypeInference.d.ts +39 -3
  96. package/dist/TypeInference.js +256 -16
  97. package/dist/TypeInference.js.map +1 -1
  98. package/dist/WebService.d.ts +79 -11
  99. package/dist/WebService.js +320 -109
  100. package/dist/WebService.js.map +1 -1
  101. package/dist/WebhookMiddleware.d.ts +119 -0
  102. package/dist/WebhookMiddleware.js +271 -0
  103. package/dist/WebhookMiddleware.js.map +1 -0
  104. package/dist/WebhookValidator.d.ts +92 -0
  105. package/dist/WebhookValidator.js +409 -0
  106. package/dist/WebhookValidator.js.map +1 -0
  107. package/dist/agents/BedrockAgent.d.ts +162 -0
  108. package/dist/agents/BedrockAgent.js +323 -0
  109. package/dist/agents/BedrockAgent.js.map +1 -0
  110. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  111. package/dist/ai-chat/AIChatClient.js +535 -0
  112. package/dist/ai-chat/AIChatClient.js.map +1 -0
  113. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  114. package/dist/ai-chat/ChatGateway.js +747 -0
  115. package/dist/ai-chat/ChatGateway.js.map +1 -0
  116. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  117. package/dist/ai-chat/HandoffRouter.js +518 -0
  118. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  119. package/dist/ai-chat/index.d.ts +12 -0
  120. package/dist/ai-chat/index.js +10 -0
  121. package/dist/ai-chat/index.js.map +1 -0
  122. package/dist/capabilities.d.ts +64 -0
  123. package/dist/capabilities.js +95 -0
  124. package/dist/capabilities.js.map +1 -0
  125. package/dist/cli/agent-loader.d.ts +32 -6
  126. package/dist/cli/agent-loader.js +92 -33
  127. package/dist/cli/agent-loader.js.map +1 -1
  128. package/dist/cli/datamap-exec.d.ts +175 -0
  129. package/dist/cli/datamap-exec.js +1284 -0
  130. package/dist/cli/datamap-exec.js.map +1 -0
  131. package/dist/cli/function-args.d.ts +40 -0
  132. package/dist/cli/function-args.js +146 -0
  133. package/dist/cli/function-args.js.map +1 -0
  134. package/dist/cli/simulation.d.ts +99 -0
  135. package/dist/cli/simulation.js +490 -0
  136. package/dist/cli/simulation.js.map +1 -0
  137. package/dist/cli/swaig-test.d.ts +12 -25
  138. package/dist/cli/swaig-test.js +935 -371
  139. package/dist/cli/swaig-test.js.map +1 -1
  140. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  141. package/dist/cli/tsdocs/agentsNote.js +92 -0
  142. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  143. package/dist/cli/tsdocs/api-index.json +1 -0
  144. package/dist/cli/tsdocs/api.d.ts +91 -0
  145. package/dist/cli/tsdocs/api.js +372 -0
  146. package/dist/cli/tsdocs/api.js.map +1 -0
  147. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  148. package/dist/cli/tsdocs/apiTypes.js +7 -0
  149. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  150. package/dist/cli/tsdocs/bin.d.ts +6 -0
  151. package/dist/cli/tsdocs/bin.js +23 -0
  152. package/dist/cli/tsdocs/bin.js.map +1 -0
  153. package/dist/cli/tsdocs/files.d.ts +108 -0
  154. package/dist/cli/tsdocs/files.js +287 -0
  155. package/dist/cli/tsdocs/files.js.map +1 -0
  156. package/dist/cli/tsdocs/index.d.ts +28 -0
  157. package/dist/cli/tsdocs/index.js +307 -0
  158. package/dist/cli/tsdocs/index.js.map +1 -0
  159. package/dist/cli/tsdocs/live.d.ts +41 -0
  160. package/dist/cli/tsdocs/live.js +202 -0
  161. package/dist/cli/tsdocs/live.js.map +1 -0
  162. package/dist/cli/tsdocs/locate.d.ts +51 -0
  163. package/dist/cli/tsdocs/locate.js +75 -0
  164. package/dist/cli/tsdocs/locate.js.map +1 -0
  165. package/dist/cli/tsdocs/render.d.ts +75 -0
  166. package/dist/cli/tsdocs/render.js +323 -0
  167. package/dist/cli/tsdocs/render.js.map +1 -0
  168. package/dist/cli/tsdocs/topics.d.ts +43 -0
  169. package/dist/cli/tsdocs/topics.js +920 -0
  170. package/dist/cli/tsdocs/topics.js.map +1 -0
  171. package/dist/index.d.ts +49 -68
  172. package/dist/index.js +45 -73
  173. package/dist/index.js.map +1 -1
  174. package/dist/livewire/index.d.ts +229 -155
  175. package/dist/livewire/index.js +298 -195
  176. package/dist/livewire/index.js.map +1 -1
  177. package/dist/llms.txt +65 -0
  178. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  179. package/dist/prefabs/CallSessionStore.js +72 -0
  180. package/dist/prefabs/CallSessionStore.js.map +1 -0
  181. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  182. package/dist/prefabs/ConciergeAgent.js +36 -31
  183. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  184. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  185. package/dist/prefabs/FAQBotAgent.js +113 -47
  186. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  187. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  188. package/dist/prefabs/InfoGathererAgent.js +67 -58
  189. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  190. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  191. package/dist/prefabs/ReceptionistAgent.js +39 -31
  192. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  193. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  194. package/dist/prefabs/SurveyAgent.js +84 -68
  195. package/dist/prefabs/SurveyAgent.js.map +1 -1
  196. package/dist/relay/Action.d.ts +44 -21
  197. package/dist/relay/Action.js +75 -17
  198. package/dist/relay/Action.js.map +1 -1
  199. package/dist/relay/Call.d.ts +312 -47
  200. package/dist/relay/Call.js +369 -18
  201. package/dist/relay/Call.js.map +1 -1
  202. package/dist/relay/Deferred.js.map +1 -1
  203. package/dist/relay/Message.d.ts +26 -5
  204. package/dist/relay/Message.js +36 -6
  205. package/dist/relay/Message.js.map +1 -1
  206. package/dist/relay/RelayClient.d.ts +44 -17
  207. package/dist/relay/RelayClient.js +175 -65
  208. package/dist/relay/RelayClient.js.map +1 -1
  209. package/dist/relay/RelayError.d.ts +14 -0
  210. package/dist/relay/RelayError.js +15 -0
  211. package/dist/relay/RelayError.js.map +1 -1
  212. package/dist/relay/RelayEvent.d.ts +96 -65
  213. package/dist/relay/RelayEvent.js +85 -56
  214. package/dist/relay/RelayEvent.js.map +1 -1
  215. package/dist/relay/closedSets.d.ts +111 -0
  216. package/dist/relay/closedSets.js +83 -0
  217. package/dist/relay/closedSets.js.map +1 -0
  218. package/dist/relay/index.d.ts +3 -1
  219. package/dist/relay/index.js +1 -0
  220. package/dist/relay/index.js.map +1 -1
  221. package/dist/relay/normalize.js.map +1 -1
  222. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  223. package/dist/relay/protocol.types.generated.js +8 -0
  224. package/dist/relay/protocol.types.generated.js.map +1 -0
  225. package/dist/relay/types.d.ts +73 -42
  226. package/dist/rest/HttpClient.d.ts +36 -8
  227. package/dist/rest/HttpClient.js +233 -40
  228. package/dist/rest/HttpClient.js.map +1 -1
  229. package/dist/rest/RequestOptions.d.ts +110 -0
  230. package/dist/rest/RequestOptions.js +113 -0
  231. package/dist/rest/RequestOptions.js.map +1 -0
  232. package/dist/rest/RestError.d.ts +52 -6
  233. package/dist/rest/RestError.js +89 -5
  234. package/dist/rest/RestError.js.map +1 -1
  235. package/dist/rest/base/CrudResource.d.ts +16 -26
  236. package/dist/rest/base/CrudResource.js +19 -33
  237. package/dist/rest/base/CrudResource.js.map +1 -1
  238. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  239. package/dist/rest/base/CrudWithAddresses.js +2 -2
  240. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  241. package/dist/rest/base/FabricResource.d.ts +15 -0
  242. package/dist/rest/base/FabricResource.js +16 -0
  243. package/dist/rest/base/FabricResource.js.map +1 -0
  244. package/dist/rest/base/ReadResource.d.ts +62 -0
  245. package/dist/rest/base/ReadResource.js +69 -0
  246. package/dist/rest/base/ReadResource.js.map +1 -0
  247. package/dist/rest/callHandler.d.ts +5 -2
  248. package/dist/rest/callHandler.js +4 -1
  249. package/dist/rest/callHandler.js.map +1 -1
  250. package/dist/rest/index.d.ts +18 -77
  251. package/dist/rest/index.js +47 -120
  252. package/dist/rest/index.js.map +1 -1
  253. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  254. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  255. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  256. package/dist/rest/namespaces/addresses.d.ts +3 -42
  257. package/dist/rest/namespaces/addresses.js +3 -50
  258. package/dist/rest/namespaces/addresses.js.map +1 -1
  259. package/dist/rest/namespaces/calling.d.ts +6 -378
  260. package/dist/rest/namespaces/calling.js +6 -473
  261. package/dist/rest/namespaces/calling.js.map +1 -1
  262. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  263. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  264. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  265. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  266. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  267. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  268. package/dist/rest/namespaces/chat.d.ts +4 -18
  269. package/dist/rest/namespaces/chat.js +4 -21
  270. package/dist/rest/namespaces/chat.js.map +1 -1
  271. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  272. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  273. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  274. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  275. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  276. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  277. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  278. package/dist/rest/namespaces/datasphere.js +6 -72
  279. package/dist/rest/namespaces/datasphere.js.map +1 -1
  280. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  281. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  282. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  283. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  284. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  285. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  286. package/dist/rest/namespaces/fabric.d.ts +11 -327
  287. package/dist/rest/namespaces/fabric.js +14 -439
  288. package/dist/rest/namespaces/fabric.js.map +1 -1
  289. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  290. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  291. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  293. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  294. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  296. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  297. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  298. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  299. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  300. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  301. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  302. package/dist/rest/namespaces/imported-numbers.js +3 -21
  303. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  304. package/dist/rest/namespaces/logs.d.ts +10 -101
  305. package/dist/rest/namespaces/logs.js +10 -128
  306. package/dist/rest/namespaces/logs.js.map +1 -1
  307. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  308. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  309. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  310. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  311. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  312. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  313. package/dist/rest/namespaces/lookup.d.ts +3 -25
  314. package/dist/rest/namespaces/lookup.js +3 -27
  315. package/dist/rest/namespaces/lookup.js.map +1 -1
  316. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  317. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  318. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  319. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  320. package/dist/rest/namespaces/message.types.generated.js +8 -0
  321. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  323. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  324. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  325. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  326. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  327. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  328. package/dist/rest/namespaces/mfa.d.ts +3 -42
  329. package/dist/rest/namespaces/mfa.js +3 -49
  330. package/dist/rest/namespaces/mfa.js.map +1 -1
  331. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  332. package/dist/rest/namespaces/number-groups.js +3 -53
  333. package/dist/rest/namespaces/number-groups.js.map +1 -1
  334. package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
  335. package/dist/rest/namespaces/phone-numbers.js +8 -230
  336. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  337. package/dist/rest/namespaces/project.d.ts +6 -42
  338. package/dist/rest/namespaces/project.js +6 -51
  339. package/dist/rest/namespaces/project.js.map +1 -1
  340. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  341. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  342. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  343. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  344. package/dist/rest/namespaces/project.types.generated.js +8 -0
  345. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  347. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  348. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  349. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  350. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  351. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  352. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  353. package/dist/rest/namespaces/pubsub.js +4 -21
  354. package/dist/rest/namespaces/pubsub.js.map +1 -1
  355. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  356. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  357. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  358. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  359. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  360. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  361. package/dist/rest/namespaces/queues.d.ts +3 -38
  362. package/dist/rest/namespaces/queues.js +3 -44
  363. package/dist/rest/namespaces/queues.js.map +1 -1
  364. package/dist/rest/namespaces/recordings.d.ts +3 -34
  365. package/dist/rest/namespaces/recordings.js +3 -40
  366. package/dist/rest/namespaces/recordings.js.map +1 -1
  367. package/dist/rest/namespaces/registry.d.ts +6 -137
  368. package/dist/rest/namespaces/registry.js +6 -173
  369. package/dist/rest/namespaces/registry.js.map +1 -1
  370. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  371. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  372. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  373. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  374. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  375. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  376. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  377. package/dist/rest/namespaces/short-codes.js +3 -41
  378. package/dist/rest/namespaces/short-codes.js.map +1 -1
  379. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  380. package/dist/rest/namespaces/sip-profile.js +3 -29
  381. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  382. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  383. package/dist/rest/namespaces/verified-callers.js +3 -34
  384. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  385. package/dist/rest/namespaces/video.d.ts +10 -227
  386. package/dist/rest/namespaces/video.js +10 -288
  387. package/dist/rest/namespaces/video.js.map +1 -1
  388. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  389. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  390. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  391. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  392. package/dist/rest/namespaces/video.types.generated.js +8 -0
  393. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  395. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  396. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  397. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  398. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  399. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  400. package/dist/rest/pagination.d.ts +5 -1
  401. package/dist/rest/pagination.js +40 -20
  402. package/dist/rest/pagination.js.map +1 -1
  403. package/dist/rest/types.d.ts +21 -3
  404. package/dist/schema.json +299 -98
  405. package/dist/skills/SkillBase.d.ts +111 -21
  406. package/dist/skills/SkillBase.js +100 -17
  407. package/dist/skills/SkillBase.js.map +1 -1
  408. package/dist/skills/SkillManager.d.ts +66 -13
  409. package/dist/skills/SkillManager.js +101 -20
  410. package/dist/skills/SkillManager.js.map +1 -1
  411. package/dist/skills/SkillName.d.ts +44 -0
  412. package/dist/skills/SkillName.js +2 -0
  413. package/dist/skills/SkillName.js.map +1 -0
  414. package/dist/skills/SkillRegistry.d.ts +22 -11
  415. package/dist/skills/SkillRegistry.js +47 -17
  416. package/dist/skills/SkillRegistry.js.map +1 -1
  417. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  418. package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
  419. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  420. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  421. package/dist/skills/builtin/ask_claude.js +36 -14
  422. package/dist/skills/builtin/ask_claude.js.map +1 -1
  423. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  424. package/dist/skills/builtin/claude_skills.js +19 -15
  425. package/dist/skills/builtin/claude_skills.js.map +1 -1
  426. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  427. package/dist/skills/builtin/custom_skills.js +26 -9
  428. package/dist/skills/builtin/custom_skills.js.map +1 -1
  429. package/dist/skills/builtin/datasphere.d.ts +5 -3
  430. package/dist/skills/builtin/datasphere.js +21 -22
  431. package/dist/skills/builtin/datasphere.js.map +1 -1
  432. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  433. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  434. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  435. package/dist/skills/builtin/datetime.d.ts +3 -1
  436. package/dist/skills/builtin/datetime.js +11 -7
  437. package/dist/skills/builtin/datetime.js.map +1 -1
  438. package/dist/skills/builtin/google_maps.d.ts +29 -14
  439. package/dist/skills/builtin/google_maps.js +89 -269
  440. package/dist/skills/builtin/google_maps.js.map +1 -1
  441. package/dist/skills/builtin/index.d.ts +8 -6
  442. package/dist/skills/builtin/index.js +8 -6
  443. package/dist/skills/builtin/index.js.map +1 -1
  444. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  445. package/dist/skills/builtin/info_gatherer.js +20 -12
  446. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  447. package/dist/skills/builtin/joke.d.ts +16 -6
  448. package/dist/skills/builtin/joke.js +54 -37
  449. package/dist/skills/builtin/joke.js.map +1 -1
  450. package/dist/skills/builtin/math.d.ts +3 -1
  451. package/dist/skills/builtin/math.js +14 -9
  452. package/dist/skills/builtin/math.js.map +1 -1
  453. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  454. package/dist/skills/builtin/mcp_gateway.js +77 -46
  455. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  456. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  457. package/dist/skills/builtin/native_vector_search.js +179 -61
  458. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  459. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  460. package/dist/skills/builtin/play_background_file.js +43 -122
  461. package/dist/skills/builtin/play_background_file.js.map +1 -1
  462. package/dist/skills/builtin/spider.d.ts +42 -4
  463. package/dist/skills/builtin/spider.js +277 -104
  464. package/dist/skills/builtin/spider.js.map +1 -1
  465. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  466. package/dist/skills/builtin/swml_transfer.js +45 -24
  467. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  468. package/dist/skills/builtin/weather_api.d.ts +24 -13
  469. package/dist/skills/builtin/weather_api.js +38 -30
  470. package/dist/skills/builtin/weather_api.js.map +1 -1
  471. package/dist/skills/builtin/web_search.d.ts +48 -10
  472. package/dist/skills/builtin/web_search.js +294 -100
  473. package/dist/skills/builtin/web_search.js.map +1 -1
  474. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  475. package/dist/skills/builtin/wikipedia_search.js +14 -13
  476. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  477. package/dist/skills/index.d.ts +3 -2
  478. package/dist/skills/index.js +1 -1
  479. package/dist/skills/index.js.map +1 -1
  480. package/dist/swml_verbs_generated.d.ts +2824 -0
  481. package/dist/swml_verbs_generated.js +12 -0
  482. package/dist/swml_verbs_generated.js.map +1 -0
  483. package/dist/types.d.ts +59 -6
  484. package/dist/web.d.ts +27 -0
  485. package/dist/web.js +20 -0
  486. package/dist/web.js.map +1 -0
  487. package/docs/agent-guide.md +1034 -0
  488. package/docs/ai_chat.md +560 -0
  489. package/docs/api-reference.md +3641 -0
  490. package/docs/architecture.md +846 -0
  491. package/docs/bedrock_agent.md +411 -0
  492. package/docs/cli-guide.md +403 -0
  493. package/docs/cloud_functions_guide.md +399 -0
  494. package/docs/configuration.md +548 -0
  495. package/docs/contexts-guide.md +884 -0
  496. package/docs/datamap-guide.md +1207 -0
  497. package/docs/developer_pain_points.md +548 -0
  498. package/docs/llm_parameters.md +298 -0
  499. package/docs/mcp_gateway_reference.md +354 -0
  500. package/docs/mcp_integration.md +162 -0
  501. package/docs/pgi_agent_guide.md +1820 -0
  502. package/docs/prefabs-guide.md +815 -0
  503. package/docs/programmatically_governed_inference.md +301 -0
  504. package/docs/sdk_features.md +501 -0
  505. package/docs/security.md +559 -0
  506. package/docs/serverless-guide.md +520 -0
  507. package/docs/skills-guide.md +1223 -0
  508. package/docs/skills-system.md +405 -0
  509. package/docs/skills_parameter_schema.md +417 -0
  510. package/docs/swaig-reference.md +1986 -0
  511. package/docs/swml_service_guide.md +573 -0
  512. package/docs/third_party_skills.md +410 -0
  513. package/docs/web_service.md +666 -0
  514. package/examples/README.md +202 -0
  515. package/examples/advanced-datamap.ts +108 -0
  516. package/examples/advanced-dynamic-config.ts +70 -0
  517. package/examples/auto-vivified.ts +95 -0
  518. package/examples/call-flow.ts +65 -0
  519. package/examples/comprehensive-dynamic.ts +125 -0
  520. package/examples/contexts-steps.ts +65 -0
  521. package/examples/custom-path.ts +45 -0
  522. package/examples/datamap-tools.ts +51 -0
  523. package/examples/datasphere-multi-instance.ts +66 -0
  524. package/examples/datasphere-serverless-env.ts +87 -0
  525. package/examples/datasphere-webhook-env.ts +65 -0
  526. package/examples/datasphere.ts +56 -0
  527. package/examples/declarative.ts +100 -0
  528. package/examples/dynamic-config.ts +54 -0
  529. package/examples/dynamic-info-gatherer.ts +69 -0
  530. package/examples/dynamic-swml-service.ts +67 -0
  531. package/examples/gather-info.ts +95 -0
  532. package/examples/gather-per-question-functions-demo.ts +139 -0
  533. package/examples/joke-agent.ts +34 -0
  534. package/examples/kubernetes-agent.ts +45 -0
  535. package/examples/llm-params.ts +75 -0
  536. package/examples/mcp-agent.ts +89 -0
  537. package/examples/mcp-gateway.ts +81 -0
  538. package/examples/multi-agent.ts +80 -0
  539. package/examples/multi-endpoint.ts +79 -0
  540. package/examples/pgi/case-domain.ts +114 -0
  541. package/examples/pgi/serve.ts +16 -0
  542. package/examples/pgi/support-agent.ts +265 -0
  543. package/examples/pom-prompt.ts +70 -0
  544. package/examples/prefab-concierge.ts +42 -0
  545. package/examples/prefab-faq.ts +58 -0
  546. package/examples/prefab-info-gatherer.ts +33 -0
  547. package/examples/prefab-receptionist.ts +36 -0
  548. package/examples/prefab-survey.ts +69 -0
  549. package/examples/quickstart-agent.ts +29 -0
  550. package/examples/quickstart-relay.ts +25 -0
  551. package/examples/quickstart-rest.ts +25 -0
  552. package/examples/record-call.ts +65 -0
  553. package/examples/relay-demo.ts +33 -0
  554. package/examples/room-and-sip.ts +93 -0
  555. package/examples/serverless-lambda.ts +43 -0
  556. package/examples/session-state.ts +83 -0
  557. package/examples/simple-agent.ts +36 -0
  558. package/examples/simple-static.ts +29 -0
  559. package/examples/skills-demo.ts +41 -0
  560. package/examples/step-function-inheritance-demo.ts +124 -0
  561. package/examples/swaig-features.ts +193 -0
  562. package/examples/swml-service-routing.ts +66 -0
  563. package/examples/swml-service.ts +38 -0
  564. package/examples/swmlservice_ai_sidecar.ts +104 -0
  565. package/examples/swmlservice_swaig_standalone.ts +79 -0
  566. package/examples/tap.ts +67 -0
  567. package/examples/typed-tools.ts +68 -0
  568. package/examples/verb-methods.ts +45 -0
  569. package/examples/web-search-multi-instance.ts +75 -0
  570. package/examples/web-search.ts +38 -0
  571. package/examples/wikipedia.ts +36 -0
  572. package/livewire/README.md +164 -0
  573. package/livewire/docs/migration-guide.md +251 -0
  574. package/livewire/examples/livewire-basic-agent.ts +74 -0
  575. package/livewire/examples/livewire-handoff.ts +196 -0
  576. package/livewire/examples/livewire-multi-tool.ts +121 -0
  577. package/package.json +85 -13
  578. package/relay/README.md +101 -0
  579. package/relay/docs/call-methods.md +622 -0
  580. package/relay/docs/client-reference.md +281 -0
  581. package/relay/docs/events.md +193 -0
  582. package/relay/docs/getting-started.md +221 -0
  583. package/relay/docs/guide.md +386 -0
  584. package/relay/docs/messaging.md +246 -0
  585. package/relay/examples/relay-inbound.ts +66 -0
  586. package/relay/examples/relay-messaging.ts +74 -0
  587. package/relay/examples/relay-outbound.ts +76 -0
  588. package/rest/README.md +141 -0
  589. package/rest/docs/calling.md +313 -0
  590. package/rest/docs/client-reference.md +149 -0
  591. package/rest/docs/fabric.md +192 -0
  592. package/rest/docs/getting-started.md +138 -0
  593. package/rest/docs/guide.md +421 -0
  594. package/rest/docs/namespaces.md +367 -0
  595. package/rest/docs/phone-binding.md +116 -0
  596. package/rest/examples/rest-10dlc-registration.ts +177 -0
  597. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  598. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  599. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  600. package/rest/examples/rest-client.ts +59 -0
  601. package/rest/examples/rest-datasphere-search.ts +81 -0
  602. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  603. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  604. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  605. package/rest/examples/rest-manage-resources.ts +64 -0
  606. package/rest/examples/rest-phone-number-management.ts +200 -0
  607. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  608. package/rest/examples/rest-video-rooms.ts +186 -0
  609. package/tutorial/fred/fred.ts +218 -0
  610. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  611. package/tutorial/fred/tutorial/02-setup.md +304 -0
  612. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  613. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  614. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  615. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  616. package/tutorial/fred/tutorial/README.md +56 -0
  617. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  618. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  619. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  620. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  621. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  622. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  623. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  624. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  625. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  626. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  627. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  628. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  629. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  630. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  631. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  632. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  633. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  634. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  635. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  636. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  637. package/tutorial/multi_agents/README.md +175 -0
  638. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  639. package/tutorial/multi_agents/extending_agents.ts +641 -0
  640. package/tutorial/multi_agents/knowledge.ts +59 -0
  641. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  642. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  643. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  644. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  645. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  646. package/tutorial/multi_agents/pc_builder.ts +529 -0
  647. package/tutorial/multi_agents/sales_agent.ts +88 -0
  648. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  649. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  650. package/tutorial/multi_agents/support_knowledge.md +256 -0
  651. package/dist/cli/mock-data.d.ts +0 -37
  652. package/dist/cli/mock-data.js +0 -80
  653. package/dist/cli/mock-data.js.map +0 -1
  654. package/dist/generateVerbTypes.d.ts +0 -11
  655. package/dist/generateVerbTypes.js +0 -265
  656. package/dist/generateVerbTypes.js.map +0 -1
  657. package/dist/rest/namespaces/compat.d.ts +0 -585
  658. package/dist/rest/namespaces/compat.js +0 -735
  659. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -1,735 +0,0 @@
1
- /**
2
- * Compatibility API namespace — Twilio-compatible LAML API with AccountSid scoping.
3
- *
4
- * All updates use POST (Twilio-compatible, not REST-idiomatic PATCH/PUT).
5
- */
6
- import { BaseResource } from '../base/BaseResource.js';
7
- import { CrudResource } from '../base/CrudResource.js';
8
- /** Compat account / subproject management (Twilio-compatible LAML). */
9
- export class CompatAccounts extends BaseResource {
10
- constructor(http) {
11
- super(http, '/api/laml/2010-04-01/Accounts');
12
- }
13
- /**
14
- * List accounts visible to the authenticated project.
15
- *
16
- * @param params - Optional filter / pagination query parameters.
17
- * @returns A LAML-shaped paginated account list.
18
- * @throws {RestError} On any non-2xx HTTP response.
19
- */
20
- async list(params) {
21
- return this._http.get(this._basePath, params);
22
- }
23
- /**
24
- * Create a new sub-account under the authenticated parent account.
25
- *
26
- * @param body - Account payload (`FriendlyName`, etc.) — LAML form keys.
27
- * @returns The newly-created account record.
28
- * @throws {RestError} On any non-2xx HTTP response.
29
- */
30
- async create(body) {
31
- return this._http.post(this._basePath, body);
32
- }
33
- /**
34
- * Fetch an account by SID.
35
- *
36
- * @param sid - Account SID (e.g. `"AC..."`).
37
- * @returns The account record.
38
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
39
- */
40
- async get(sid) {
41
- return this._http.get(this._path(sid));
42
- }
43
- /**
44
- * Update an account's attributes. LAML uses `POST` (not PATCH/PUT).
45
- *
46
- * @param sid - Account SID.
47
- * @param body - Partial update payload. Defaults to `{}`.
48
- * @returns The updated account record.
49
- * @throws {RestError} On any non-2xx HTTP response.
50
- */
51
- async update(sid, body = {}) {
52
- return this._http.post(this._path(sid), body);
53
- }
54
- }
55
- /** Compat call management with recording and stream sub-resources. */
56
- export class CompatCalls extends CrudResource {
57
- constructor(http, basePath) {
58
- super(http, basePath);
59
- }
60
- /**
61
- * Update an in-progress or past call. LAML uses `POST` (not PATCH/PUT).
62
- *
63
- * @param sid - Call SID (e.g. `"CA..."`).
64
- * @param body - LAML-form update payload (`Status`, `Url`, etc.). Defaults to `{}`.
65
- * @returns The updated call record.
66
- * @throws {RestError} On any non-2xx HTTP response.
67
- */
68
- async update(sid, body = {}) {
69
- return this._http.post(this._path(sid), body);
70
- }
71
- /**
72
- * Start recording an active call.
73
- *
74
- * @param callSid - Call SID.
75
- * @param body - Recording parameters (channels, trim, status callback, etc.).
76
- * Defaults to `{}`.
77
- * @returns The newly-started recording record.
78
- * @throws {RestError} On any non-2xx HTTP response.
79
- */
80
- async startRecording(callSid, body = {}) {
81
- return this._http.post(this._path(callSid, 'Recordings'), body);
82
- }
83
- /**
84
- * Update an active recording (e.g. `Status=paused` / `Status=stopped`).
85
- *
86
- * @param callSid - Call SID.
87
- * @param recordingSid - Recording SID returned by {@link startRecording}.
88
- * @param body - Update payload. Defaults to `{}`.
89
- * @returns The updated recording record.
90
- * @throws {RestError} On any non-2xx HTTP response.
91
- */
92
- async updateRecording(callSid, recordingSid, body = {}) {
93
- return this._http.post(this._path(callSid, 'Recordings', recordingSid), body);
94
- }
95
- /**
96
- * Start a media stream on an active call (WebSocket media forwarding).
97
- *
98
- * @param callSid - Call SID.
99
- * @param body - Stream parameters (URL, track, etc.). Defaults to `{}`.
100
- * @returns The newly-started stream record.
101
- * @throws {RestError} On any non-2xx HTTP response.
102
- */
103
- async startStream(callSid, body = {}) {
104
- return this._http.post(this._path(callSid, 'Streams'), body);
105
- }
106
- /**
107
- * Stop an active media stream on a call.
108
- *
109
- * @param callSid - Call SID.
110
- * @param streamSid - Stream SID returned by {@link startStream}.
111
- * @param body - Update payload. Defaults to `{}`.
112
- * @returns The stopped stream record.
113
- * @throws {RestError} On any non-2xx HTTP response.
114
- */
115
- async stopStream(callSid, streamSid, body = {}) {
116
- return this._http.post(this._path(callSid, 'Streams', streamSid), body);
117
- }
118
- }
119
- /** Compat message management with media sub-resources. */
120
- export class CompatMessages extends CrudResource {
121
- constructor(http, basePath) {
122
- super(http, basePath);
123
- }
124
- /**
125
- * Update a message. LAML uses `POST` (not PATCH/PUT).
126
- *
127
- * @param sid - Message SID (e.g. `"SM..."` / `"MM..."`).
128
- * @param body - LAML-form update payload. Defaults to `{}`.
129
- * @returns The updated message record.
130
- * @throws {RestError} On any non-2xx HTTP response.
131
- */
132
- async update(sid, body = {}) {
133
- return this._http.post(this._path(sid), body);
134
- }
135
- /**
136
- * List media attachments for a message (MMS).
137
- *
138
- * @param messageSid - Message SID.
139
- * @param params - Optional filter / pagination query parameters.
140
- * @returns A paginated list of media records.
141
- * @throws {RestError} On any non-2xx HTTP response.
142
- */
143
- async listMedia(messageSid, params) {
144
- return this._http.get(this._path(messageSid, 'Media'), params);
145
- }
146
- /**
147
- * Fetch a specific media attachment on a message.
148
- *
149
- * @param messageSid - Message SID.
150
- * @param mediaSid - Media SID.
151
- * @returns The media record (metadata + URL).
152
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
153
- */
154
- async getMedia(messageSid, mediaSid) {
155
- return this._http.get(this._path(messageSid, 'Media', mediaSid));
156
- }
157
- /**
158
- * Delete a media attachment from a message.
159
- *
160
- * @param messageSid - Message SID.
161
- * @param mediaSid - Media SID.
162
- * @returns The platform's delete response.
163
- * @throws {RestError} On any non-2xx HTTP response.
164
- */
165
- async deleteMedia(messageSid, mediaSid) {
166
- return this._http.delete(this._path(messageSid, 'Media', mediaSid));
167
- }
168
- }
169
- /** Compat fax management with media sub-resources. */
170
- export class CompatFaxes extends CrudResource {
171
- constructor(http, basePath) {
172
- super(http, basePath);
173
- }
174
- /**
175
- * Update a fax. LAML uses `POST` (not PATCH/PUT).
176
- *
177
- * @param sid - Fax SID (e.g. `"FX..."`).
178
- * @param body - LAML-form update payload. Defaults to `{}`.
179
- * @returns The updated fax record.
180
- * @throws {RestError} On any non-2xx HTTP response.
181
- */
182
- async update(sid, body = {}) {
183
- return this._http.post(this._path(sid), body);
184
- }
185
- /**
186
- * List media attachments for a fax.
187
- *
188
- * @param faxSid - Fax SID.
189
- * @param params - Optional filter / pagination query parameters.
190
- * @returns A paginated list of media records.
191
- * @throws {RestError} On any non-2xx HTTP response.
192
- */
193
- async listMedia(faxSid, params) {
194
- return this._http.get(this._path(faxSid, 'Media'), params);
195
- }
196
- /**
197
- * Fetch a specific media attachment on a fax.
198
- *
199
- * @param faxSid - Fax SID.
200
- * @param mediaSid - Media SID.
201
- * @returns The media record.
202
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
203
- */
204
- async getMedia(faxSid, mediaSid) {
205
- return this._http.get(this._path(faxSid, 'Media', mediaSid));
206
- }
207
- /**
208
- * Delete a media attachment from a fax.
209
- *
210
- * @param faxSid - Fax SID.
211
- * @param mediaSid - Media SID.
212
- * @returns The platform's delete response.
213
- * @throws {RestError} On any non-2xx HTTP response.
214
- */
215
- async deleteMedia(faxSid, mediaSid) {
216
- return this._http.delete(this._path(faxSid, 'Media', mediaSid));
217
- }
218
- }
219
- /** Compat conference management with participants, recordings, and streams. */
220
- export class CompatConferences extends BaseResource {
221
- constructor(http, basePath) {
222
- super(http, basePath);
223
- }
224
- /**
225
- * List conferences in the account.
226
- *
227
- * @param params - Optional filter / pagination query parameters.
228
- * @returns A paginated list of conferences.
229
- * @throws {RestError} On any non-2xx HTTP response.
230
- */
231
- async list(params) {
232
- return this._http.get(this._basePath, params);
233
- }
234
- /**
235
- * Fetch a conference by SID.
236
- *
237
- * @param sid - Conference SID (e.g. `"CF..."`).
238
- * @returns The conference record.
239
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
240
- */
241
- async get(sid) {
242
- return this._http.get(this._path(sid));
243
- }
244
- /**
245
- * Update a conference (e.g. `Status=completed` to terminate).
246
- * LAML uses `POST` (not PATCH/PUT).
247
- *
248
- * @param sid - Conference SID.
249
- * @param body - LAML-form update payload. Defaults to `{}`.
250
- * @returns The updated conference record.
251
- * @throws {RestError} On any non-2xx HTTP response.
252
- */
253
- async update(sid, body = {}) {
254
- return this._http.post(this._path(sid), body);
255
- }
256
- // Participants
257
- /**
258
- * List participants in a conference.
259
- *
260
- * @param conferenceSid - Conference SID.
261
- * @param params - Optional filter / pagination query parameters.
262
- * @returns A paginated list of participants.
263
- * @throws {RestError} On any non-2xx HTTP response.
264
- */
265
- async listParticipants(conferenceSid, params) {
266
- return this._http.get(this._path(conferenceSid, 'Participants'), params);
267
- }
268
- /**
269
- * Fetch a specific participant (by its call SID) in a conference.
270
- *
271
- * @param conferenceSid - Conference SID.
272
- * @param callSid - Participant's call SID.
273
- * @returns The participant record.
274
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
275
- */
276
- async getParticipant(conferenceSid, callSid) {
277
- return this._http.get(this._path(conferenceSid, 'Participants', callSid));
278
- }
279
- /**
280
- * Update a participant (mute, hold, announce, etc.). LAML uses `POST`.
281
- *
282
- * @param conferenceSid - Conference SID.
283
- * @param callSid - Participant's call SID.
284
- * @param body - LAML-form update payload (e.g. `{ Muted: 'true' }`).
285
- * Defaults to `{}`.
286
- * @returns The updated participant record.
287
- * @throws {RestError} On any non-2xx HTTP response.
288
- */
289
- async updateParticipant(conferenceSid, callSid, body = {}) {
290
- return this._http.post(this._path(conferenceSid, 'Participants', callSid), body);
291
- }
292
- /**
293
- * Remove a participant from a conference (kick).
294
- *
295
- * @param conferenceSid - Conference SID.
296
- * @param callSid - Participant's call SID.
297
- * @returns The platform's delete response.
298
- * @throws {RestError} On any non-2xx HTTP response.
299
- */
300
- async removeParticipant(conferenceSid, callSid) {
301
- return this._http.delete(this._path(conferenceSid, 'Participants', callSid));
302
- }
303
- // Conference recordings
304
- /**
305
- * List recordings taken of a conference.
306
- *
307
- * @param conferenceSid - Conference SID.
308
- * @param params - Optional filter / pagination query parameters.
309
- * @returns A paginated list of recordings.
310
- * @throws {RestError} On any non-2xx HTTP response.
311
- */
312
- async listRecordings(conferenceSid, params) {
313
- return this._http.get(this._path(conferenceSid, 'Recordings'), params);
314
- }
315
- /**
316
- * Fetch a specific conference recording.
317
- *
318
- * @param conferenceSid - Conference SID.
319
- * @param recordingSid - Recording SID.
320
- * @returns The recording record.
321
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
322
- */
323
- async getRecording(conferenceSid, recordingSid) {
324
- return this._http.get(this._path(conferenceSid, 'Recordings', recordingSid));
325
- }
326
- /**
327
- * Update an active conference recording (pause, resume, stop). LAML uses `POST`.
328
- *
329
- * @param conferenceSid - Conference SID.
330
- * @param recordingSid - Recording SID.
331
- * @param body - LAML-form update payload. Defaults to `{}`.
332
- * @returns The updated recording record.
333
- * @throws {RestError} On any non-2xx HTTP response.
334
- */
335
- async updateRecording(conferenceSid, recordingSid, body = {}) {
336
- return this._http.post(this._path(conferenceSid, 'Recordings', recordingSid), body);
337
- }
338
- /**
339
- * Delete a conference recording.
340
- *
341
- * @param conferenceSid - Conference SID.
342
- * @param recordingSid - Recording SID.
343
- * @returns The platform's delete response.
344
- * @throws {RestError} On any non-2xx HTTP response.
345
- */
346
- async deleteRecording(conferenceSid, recordingSid) {
347
- return this._http.delete(this._path(conferenceSid, 'Recordings', recordingSid));
348
- }
349
- // Conference streams
350
- /**
351
- * Start a media stream on a conference.
352
- *
353
- * @param conferenceSid - Conference SID.
354
- * @param body - Stream parameters (URL, track, etc.). Defaults to `{}`.
355
- * @returns The newly-started stream record.
356
- * @throws {RestError} On any non-2xx HTTP response.
357
- */
358
- async startStream(conferenceSid, body = {}) {
359
- return this._http.post(this._path(conferenceSid, 'Streams'), body);
360
- }
361
- /**
362
- * Stop an active conference media stream.
363
- *
364
- * @param conferenceSid - Conference SID.
365
- * @param streamSid - Stream SID returned by {@link startStream}.
366
- * @param body - Update payload. Defaults to `{}`.
367
- * @returns The stopped stream record.
368
- * @throws {RestError} On any non-2xx HTTP response.
369
- */
370
- async stopStream(conferenceSid, streamSid, body = {}) {
371
- return this._http.post(this._path(conferenceSid, 'Streams', streamSid), body);
372
- }
373
- }
374
- /** Compat phone number management with searching, purchasing, and import. */
375
- export class CompatPhoneNumbers extends BaseResource {
376
- _availableBase;
377
- constructor(http, basePath) {
378
- super(http, basePath);
379
- this._availableBase = basePath.replace('/IncomingPhoneNumbers', '/AvailablePhoneNumbers');
380
- }
381
- /**
382
- * List owned incoming phone numbers in the account.
383
- *
384
- * @param params - Optional filter / pagination query parameters.
385
- * @returns A paginated list of owned numbers.
386
- * @throws {RestError} On any non-2xx HTTP response.
387
- */
388
- async list(params) {
389
- return this._http.get(this._basePath, params);
390
- }
391
- /**
392
- * Purchase a phone number (LAML `POST /IncomingPhoneNumbers`).
393
- *
394
- * @param body - Purchase payload, typically including `PhoneNumber` or
395
- * `AreaCode` plus webhook URLs.
396
- * @returns The newly-purchased phone-number record.
397
- * @throws {RestError} On any non-2xx HTTP response.
398
- */
399
- async purchase(body) {
400
- return this._http.post(this._basePath, body);
401
- }
402
- /**
403
- * Fetch an owned phone number by SID.
404
- *
405
- * @param sid - Phone number SID (e.g. `"PN..."`).
406
- * @returns The phone-number record.
407
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
408
- */
409
- async get(sid) {
410
- return this._http.get(this._path(sid));
411
- }
412
- /**
413
- * Update an owned phone number (webhook URLs, friendly name, etc.).
414
- * LAML uses `POST`.
415
- *
416
- * @param sid - Phone number SID.
417
- * @param body - LAML-form update payload. Defaults to `{}`.
418
- * @returns The updated phone-number record.
419
- * @throws {RestError} On any non-2xx HTTP response.
420
- */
421
- async update(sid, body = {}) {
422
- return this._http.post(this._path(sid), body);
423
- }
424
- /**
425
- * Release an owned phone number (delete).
426
- *
427
- * @param sid - Phone number SID.
428
- * @returns The platform's delete response.
429
- * @throws {RestError} On any non-2xx HTTP response.
430
- */
431
- async delete(sid) {
432
- return this._http.delete(this._path(sid));
433
- }
434
- /**
435
- * Import an externally-hosted phone number into the account
436
- * (LAML `/ImportedPhoneNumbers`).
437
- *
438
- * @param body - Import payload (number, carrier details, etc.).
439
- * @returns The newly-imported number record.
440
- * @throws {RestError} On any non-2xx HTTP response.
441
- */
442
- async importNumber(body) {
443
- const path = this._basePath.replace('/IncomingPhoneNumbers', '/ImportedPhoneNumbers');
444
- return this._http.post(path, body);
445
- }
446
- /**
447
- * List countries in which numbers are available for purchase.
448
- *
449
- * @param params - Optional filter / pagination query parameters.
450
- * @returns A paginated list of country records with capabilities.
451
- * @throws {RestError} On any non-2xx HTTP response.
452
- */
453
- async listAvailableCountries(params) {
454
- return this._http.get(this._availableBase, params);
455
- }
456
- /**
457
- * Search for available local phone numbers in a country.
458
- *
459
- * @param country - ISO-3166 country code (e.g. `"US"`, `"CA"`).
460
- * @param params - Search filters (`AreaCode`, `Contains`, `NearNumber`, etc.).
461
- * @returns A paginated list of available local numbers.
462
- * @throws {RestError} On any non-2xx HTTP response.
463
- */
464
- async searchLocal(country, params) {
465
- return this._http.get(`${this._availableBase}/${country}/Local`, params);
466
- }
467
- /**
468
- * Search for available toll-free phone numbers in a country.
469
- *
470
- * @param country - ISO-3166 country code.
471
- * @param params - Search filters (`Contains`, `NearNumber`, etc.).
472
- * @returns A paginated list of available toll-free numbers.
473
- * @throws {RestError} On any non-2xx HTTP response.
474
- */
475
- async searchTollFree(country, params) {
476
- return this._http.get(`${this._availableBase}/${country}/TollFree`, params);
477
- }
478
- }
479
- /** Compat application management (LAML-style `Applications`). */
480
- export class CompatApplications extends CrudResource {
481
- constructor(http, basePath) {
482
- super(http, basePath);
483
- }
484
- /**
485
- * Update an application. LAML uses `POST` (not PATCH/PUT).
486
- *
487
- * @param sid - Application SID (e.g. `"AP..."`).
488
- * @param body - LAML-form update payload. Defaults to `{}`.
489
- * @returns The updated application record.
490
- * @throws {RestError} On any non-2xx HTTP response.
491
- */
492
- async update(sid, body = {}) {
493
- return this._http.post(this._path(sid), body);
494
- }
495
- }
496
- /** Compat cXML / LaML Bin management. */
497
- export class CompatLamlBins extends CrudResource {
498
- constructor(http, basePath) {
499
- super(http, basePath);
500
- }
501
- /**
502
- * Update a LaML Bin's stored script. LAML uses `POST` (not PATCH/PUT).
503
- *
504
- * @param sid - LaML Bin SID (e.g. `"LA..."`).
505
- * @param body - Payload containing the new `VoiceMethod`, `Url`, etc.
506
- * Defaults to `{}`.
507
- * @returns The updated LaML Bin record.
508
- * @throws {RestError} On any non-2xx HTTP response.
509
- */
510
- async update(sid, body = {}) {
511
- return this._http.post(this._path(sid), body);
512
- }
513
- }
514
- /** Compat queue management with member operations. */
515
- export class CompatQueues extends CrudResource {
516
- constructor(http, basePath) {
517
- super(http, basePath);
518
- }
519
- /**
520
- * Update a queue. LAML uses `POST` (not PATCH/PUT).
521
- *
522
- * @param sid - Queue SID (e.g. `"QU..."`).
523
- * @param body - LAML-form update payload. Defaults to `{}`.
524
- * @returns The updated queue record.
525
- * @throws {RestError} On any non-2xx HTTP response.
526
- */
527
- async update(sid, body = {}) {
528
- return this._http.post(this._path(sid), body);
529
- }
530
- /**
531
- * List members (calls) currently waiting in a queue.
532
- *
533
- * @param queueSid - Queue SID.
534
- * @param params - Optional filter / pagination query parameters.
535
- * @returns A paginated list of queue members.
536
- * @throws {RestError} On any non-2xx HTTP response.
537
- */
538
- async listMembers(queueSid, params) {
539
- return this._http.get(this._path(queueSid, 'Members'), params);
540
- }
541
- /**
542
- * Fetch a specific member (by call SID) currently waiting in a queue.
543
- *
544
- * @param queueSid - Queue SID.
545
- * @param callSid - Call SID of the queued member.
546
- * @returns The queue-member record.
547
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
548
- */
549
- async getMember(queueSid, callSid) {
550
- return this._http.get(this._path(queueSid, 'Members', callSid));
551
- }
552
- /**
553
- * Dequeue a member — LAML's `POST` on a queued call redirects it to the
554
- * given `Url` (typically to connect the caller to a queue consumer).
555
- *
556
- * @param queueSid - Queue SID.
557
- * @param callSid - Call SID of the queued member.
558
- * @param body - LAML-form payload (commonly `{ Url, Method }`).
559
- * Defaults to `{}`.
560
- * @returns The updated queue-member record.
561
- * @throws {RestError} On any non-2xx HTTP response.
562
- */
563
- async dequeueMember(queueSid, callSid, body = {}) {
564
- return this._http.post(this._path(queueSid, 'Members', callSid), body);
565
- }
566
- }
567
- /** Compat recording management (list / get / delete). */
568
- export class CompatRecordings extends BaseResource {
569
- constructor(http, basePath) {
570
- super(http, basePath);
571
- }
572
- /**
573
- * List recordings in the account.
574
- *
575
- * @param params - Optional filter / pagination query parameters
576
- * (date range, call SID, conference SID, etc.).
577
- * @returns A paginated list of recordings.
578
- * @throws {RestError} On any non-2xx HTTP response.
579
- */
580
- async list(params) {
581
- return this._http.get(this._basePath, params);
582
- }
583
- /**
584
- * Fetch a recording by SID.
585
- *
586
- * @param sid - Recording SID (e.g. `"RE..."`).
587
- * @returns The recording record.
588
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
589
- */
590
- async get(sid) {
591
- return this._http.get(this._path(sid));
592
- }
593
- /**
594
- * Delete a recording.
595
- *
596
- * @param sid - Recording SID.
597
- * @returns The platform's delete response.
598
- * @throws {RestError} On any non-2xx HTTP response.
599
- */
600
- async delete(sid) {
601
- return this._http.delete(this._path(sid));
602
- }
603
- }
604
- /** Compat transcription management (list / get / delete). */
605
- export class CompatTranscriptions extends BaseResource {
606
- constructor(http, basePath) {
607
- super(http, basePath);
608
- }
609
- /**
610
- * List transcriptions in the account.
611
- *
612
- * @param params - Optional filter / pagination query parameters.
613
- * @returns A paginated list of transcriptions.
614
- * @throws {RestError} On any non-2xx HTTP response.
615
- */
616
- async list(params) {
617
- return this._http.get(this._basePath, params);
618
- }
619
- /**
620
- * Fetch a transcription by SID.
621
- *
622
- * @param sid - Transcription SID (e.g. `"TR..."`).
623
- * @returns The transcription record.
624
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
625
- */
626
- async get(sid) {
627
- return this._http.get(this._path(sid));
628
- }
629
- /**
630
- * Delete a transcription.
631
- *
632
- * @param sid - Transcription SID.
633
- * @returns The platform's delete response.
634
- * @throws {RestError} On any non-2xx HTTP response.
635
- */
636
- async delete(sid) {
637
- return this._http.delete(this._path(sid));
638
- }
639
- }
640
- /** Compat API token management (non-LAML — uses `PATCH`). */
641
- export class CompatTokens extends BaseResource {
642
- constructor(http, basePath) {
643
- super(http, basePath);
644
- }
645
- /**
646
- * Create a new Compat API token.
647
- *
648
- * @param body - Token payload (friendly name, scopes, etc.).
649
- * @returns The newly-created token record, including the secret value.
650
- * @throws {RestError} On any non-2xx HTTP response.
651
- */
652
- async create(body) {
653
- return this._http.post(this._basePath, body);
654
- }
655
- /**
656
- * Update a Compat API token.
657
- *
658
- * @param tokenId - Unique identifier of the token.
659
- * @param body - Partial update payload. Defaults to `{}`.
660
- * @returns The updated token record.
661
- * @throws {RestError} On any non-2xx HTTP response.
662
- */
663
- async update(tokenId, body = {}) {
664
- return this._http.patch(this._path(tokenId), body);
665
- }
666
- /**
667
- * Revoke and delete a Compat API token.
668
- *
669
- * @param tokenId - Unique identifier of the token.
670
- * @returns The platform's delete response.
671
- * @throws {RestError} On any non-2xx HTTP response.
672
- */
673
- async delete(tokenId) {
674
- return this._http.delete(this._path(tokenId));
675
- }
676
- }
677
- /**
678
- * Twilio-compatible LAML API namespace with AccountSid scoping.
679
- *
680
- * Access via `client.compat.*`. This is the legacy LAML (cXML) surface for code
681
- * migrated from Twilio — all updates use POST bodies instead of REST-idiomatic
682
- * PATCH/PUT. Prefer the native SignalWire namespaces (`client.calling`, `client.fabric`,
683
- * etc.) for greenfield projects.
684
- *
685
- * @example Send an SMS via the LAML Messages API
686
- * ```ts
687
- * await client.compat.messages.create({
688
- * From: '+15551112222',
689
- * To: '+15553334444',
690
- * Body: 'Hello from SignalWire!',
691
- * });
692
- * ```
693
- */
694
- export class CompatNamespace {
695
- /** Main and sub-account CRUD. */
696
- accounts;
697
- /** Call CRUD plus recording / stream sub-resource management. */
698
- calls;
699
- /** Message CRUD plus media sub-resource management. */
700
- messages;
701
- /** Fax CRUD plus media sub-resource management. */
702
- faxes;
703
- /** Conference read / update with participants, recordings, and streams. */
704
- conferences;
705
- /** Phone number CRUD plus search / purchase / import helpers. */
706
- phoneNumbers;
707
- /** LAML Application CRUD. */
708
- applications;
709
- /** LaML Bin (hosted script) CRUD. */
710
- lamlBins;
711
- /** Queue CRUD plus member list / fetch / dequeue. */
712
- queues;
713
- /** Recording list / fetch / delete. */
714
- recordings;
715
- /** Transcription list / fetch / delete. */
716
- transcriptions;
717
- /** Compat API token create / update / delete. */
718
- tokens;
719
- constructor(http, accountSid) {
720
- const base = `/api/laml/2010-04-01/Accounts/${accountSid}`;
721
- this.accounts = new CompatAccounts(http);
722
- this.calls = new CompatCalls(http, `${base}/Calls`);
723
- this.messages = new CompatMessages(http, `${base}/Messages`);
724
- this.faxes = new CompatFaxes(http, `${base}/Faxes`);
725
- this.conferences = new CompatConferences(http, `${base}/Conferences`);
726
- this.phoneNumbers = new CompatPhoneNumbers(http, `${base}/IncomingPhoneNumbers`);
727
- this.applications = new CompatApplications(http, `${base}/Applications`);
728
- this.lamlBins = new CompatLamlBins(http, `${base}/LamlBins`);
729
- this.queues = new CompatQueues(http, `${base}/Queues`);
730
- this.recordings = new CompatRecordings(http, `${base}/Recordings`);
731
- this.transcriptions = new CompatTranscriptions(http, `${base}/Transcriptions`);
732
- this.tokens = new CompatTokens(http, `${base}/tokens`);
733
- }
734
- }
735
- //# sourceMappingURL=compat.js.map