@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
@@ -0,0 +1,131 @@
1
+ export interface ChargeDetails {
2
+ /** Description for this charge. */
3
+ description: string;
4
+ /** Charge amount in dollars. */
5
+ charge: string;
6
+ }
7
+ /** Pagination links for conference log list responses. */
8
+ export interface ConferenceLogPaginationLinks {
9
+ /** Link to the current page. */
10
+ self: string;
11
+ /** Link to the first page. */
12
+ first: string;
13
+ /** Link to the next page. Only present when there are more results. */
14
+ next?: string;
15
+ /** Link to the previous page. Only present when not on the first page. */
16
+ prev?: string;
17
+ }
18
+ /** The request contains invalid parameters. See errors for details. */
19
+ export interface ConferenceLogsStatusCode422 {
20
+ /** List of validation errors. */
21
+ errors: Types_StatusCodes_RestApiErrorItem[];
22
+ }
23
+ /** Response containing a list of conferences. */
24
+ export interface ConferencesResponse {
25
+ /** Pagination links. */
26
+ links: ConferenceLogPaginationLinks;
27
+ /** A list of conference logs. */
28
+ data: (CxmlConference | RelayConference | VideoRoomSessionConference)[];
29
+ }
30
+ /** Core conference object. */
31
+ export interface CxmlConference {
32
+ /** Unique identifier for the conference. */
33
+ id: string;
34
+ /** Creation timestamp. */
35
+ created_at: string;
36
+ /** Project ID of the conference. */
37
+ project_id: uuid;
38
+ /** Region of the conference. */
39
+ region: string;
40
+ /** Name of the conference. */
41
+ name: string | null;
42
+ /** Status of the conference. */
43
+ status: string | null;
44
+ /** Maximum size of the conference. */
45
+ max_size: number | null;
46
+ /** Current participants in the conference. */
47
+ current_participants: number;
48
+ /** Updated timestamp. */
49
+ updated_at: string;
50
+ /** Type of the conference. */
51
+ type: 'cxml_conference';
52
+ }
53
+ /** Core conference object. */
54
+ export interface RelayConference {
55
+ /** Unique identifier for the conference. */
56
+ id: string;
57
+ /** Creation timestamp. */
58
+ created_at: string;
59
+ /** Project ID of the conference. */
60
+ project_id: uuid;
61
+ /** Region of the conference. */
62
+ region: string;
63
+ /** Name of the conference. */
64
+ name: string | null;
65
+ /** Status of the conference. */
66
+ status: string | null;
67
+ /** Maximum size of the conference. */
68
+ max_size: number | null;
69
+ /** Current participants in the conference. */
70
+ current_participants: number;
71
+ /** Updated timestamp. */
72
+ updated_at: string;
73
+ /** Type of the conference. */
74
+ type: 'relay_conference';
75
+ /** Recording URL of the conference. */
76
+ recording_url: string | null;
77
+ /** Recording duration of the conference. */
78
+ recording_duration: number | null;
79
+ /** Recording file size of the conference. */
80
+ recording_file_size: number | null;
81
+ }
82
+ /** Details about a specific error. */
83
+ export interface Types_StatusCodes_RestApiErrorItem {
84
+ /** The category of error. */
85
+ type: string;
86
+ /** A specific error code. */
87
+ code: string;
88
+ /** A description of what caused the error. */
89
+ message: string;
90
+ /** The request parameter that caused the error, if applicable. */
91
+ attribute?: string | null;
92
+ /** A link to documentation about this error. */
93
+ url: string;
94
+ }
95
+ /** Access is unauthorized. */
96
+ export interface Types_StatusCodes_StatusCode401 {
97
+ error: 'Unauthorized';
98
+ }
99
+ /** An internal server error occurred. */
100
+ export interface Types_StatusCodes_StatusCode500 {
101
+ error: 'Internal Server Error';
102
+ }
103
+ /** Core conference object. */
104
+ export interface VideoRoomSessionConference {
105
+ /** Unique identifier for the conference. */
106
+ id: string;
107
+ /** Creation timestamp. */
108
+ created_at: string;
109
+ /** Source of the conference. */
110
+ source: string;
111
+ /** Type of the conference. */
112
+ type: 'video_conference_session' | 'video_room_session';
113
+ /** URL of the conference room session. */
114
+ url: string;
115
+ /** Name of the conference room. */
116
+ room_name: string | null;
117
+ /** Status of the conference. */
118
+ status: string | null;
119
+ /** Whether the conference is locked. */
120
+ locked: boolean;
121
+ /** Timestamp when the conference started. */
122
+ started_at: string | null;
123
+ /** Timestamp when the conference ended. */
124
+ ended_at: string | null;
125
+ /** Total charge amount of the conference in dollars. */
126
+ charge: string;
127
+ /** Details on charges associated with this conference. */
128
+ charge_details: ChargeDetails[];
129
+ }
130
+ /** Universal Unique Identifier. */
131
+ export type uuid = string;
@@ -0,0 +1,8 @@
1
+ // AUTO-GENERATED from porting-sdk/rest-apis/logs/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // Held to the same lint bar as hand-written source (no rule suppressions, no
5
+ // loose types). If the generator cannot emit a clean faithful type, fix the
6
+ // generator rather than weaken the output.
7
+ export {};
8
+ //# sourceMappingURL=logs.types.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logs.types.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/logs.types.generated.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,0DAA0D;AAC1D,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,2CAA2C"}
@@ -1,29 +1,7 @@
1
1
  /**
2
2
  * Phone Number Lookup namespace.
3
- */
4
- import type { HttpClient } from '../HttpClient.js';
5
- import type { QueryParams } from '../types.js';
6
- import { BaseResource } from '../base/BaseResource.js';
7
- /**
8
- * Phone number lookup (carrier, CNAM).
9
- *
10
- * Access via `client.lookup.*`.
11
3
  *
12
- * @example
13
- * ```ts
14
- * const info = await client.lookup.phoneNumber('+15551234567', { include: 'carrier,caller-name' });
15
- * ```
4
+ * Generated from the relay-rest OpenAPI spec; re-exported here (with the
5
+ * `LookupResource` back-compat alias) so existing imports keep working.
16
6
  */
17
- export declare class LookupResource extends BaseResource {
18
- constructor(http: HttpClient);
19
- /**
20
- * Look up carrier and CNAM information for a phone number.
21
- *
22
- * @param e164 - The phone number in E.164 format (e.g. `"+15551234567"`).
23
- * @param params - Optional query parameters, most commonly
24
- * `include: "carrier,caller-name"` to enable carrier and CNAM lookups.
25
- * @returns The lookup record containing any requested datasets.
26
- * @throws {RestError} On any non-2xx HTTP response.
27
- */
28
- phoneNumber(e164: string, params?: QueryParams): Promise<any>;
29
- }
7
+ export { Lookup, Lookup as LookupResource } from './relay-rest.resources.generated.js';
@@ -1,32 +1,8 @@
1
1
  /**
2
2
  * Phone Number Lookup namespace.
3
- */
4
- import { BaseResource } from '../base/BaseResource.js';
5
- /**
6
- * Phone number lookup (carrier, CNAM).
7
- *
8
- * Access via `client.lookup.*`.
9
3
  *
10
- * @example
11
- * ```ts
12
- * const info = await client.lookup.phoneNumber('+15551234567', { include: 'carrier,caller-name' });
13
- * ```
4
+ * Generated from the relay-rest OpenAPI spec; re-exported here (with the
5
+ * `LookupResource` back-compat alias) so existing imports keep working.
14
6
  */
15
- export class LookupResource extends BaseResource {
16
- constructor(http) {
17
- super(http, '/api/relay/rest/lookup');
18
- }
19
- /**
20
- * Look up carrier and CNAM information for a phone number.
21
- *
22
- * @param e164 - The phone number in E.164 format (e.g. `"+15551234567"`).
23
- * @param params - Optional query parameters, most commonly
24
- * `include: "carrier,caller-name"` to enable carrier and CNAM lookups.
25
- * @returns The lookup record containing any requested datasets.
26
- * @throws {RestError} On any non-2xx HTTP response.
27
- */
28
- async phoneNumber(e164, params) {
29
- return this._http.get(this._path('phone_number', e164), params);
30
- }
31
- }
7
+ export { Lookup, Lookup as LookupResource } from './relay-rest.resources.generated.js';
32
8
  //# sourceMappingURL=lookup.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"lookup.js","sourceRoot":"","sources":["../../../src/rest/namespaces/lookup.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD;;;;;;;;;GASG;AACH,MAAM,OAAO,cAAe,SAAQ,YAAY;IAC9C,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,MAAoB;QAClD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;CACF"}
1
+ {"version":3,"file":"lookup.js","sourceRoot":"","sources":["../../../src/rest/namespaces/lookup.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,qCAAqC,CAAC"}
@@ -0,0 +1,6 @@
1
+ import type { HttpClient } from '../HttpClient.js';
2
+ import { ReadResource } from '../base/ReadResource.js';
3
+ import type { LogListResponse, LogRetrieveResponse } from './message.types.generated.js';
4
+ export declare class MessageLogs extends ReadResource<LogListResponse, LogRetrieveResponse> {
5
+ constructor(http: HttpClient);
6
+ }
@@ -0,0 +1,14 @@
1
+ // AUTO-GENERATED from porting-sdk/rest-apis/message/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // One typed resource class per x-sdk-resource: CRUD bases bound to the
5
+ // resource's spec types (closed body + extras door) plus declared operation
6
+ // methods, command-dispatch, and set_methods — mirrors the Python reference's
7
+ // <ns>_resources_generated module.
8
+ import { ReadResource } from '../base/ReadResource.js';
9
+ export class MessageLogs extends ReadResource {
10
+ constructor(http) {
11
+ super(http, '/api/messaging/logs');
12
+ }
13
+ }
14
+ //# sourceMappingURL=message.resources.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"message.resources.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/message.resources.generated.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,0DAA0D;AAC1D,EAAE;AACF,uEAAuE;AACvE,4EAA4E;AAC5E,8EAA8E;AAC9E,mCAAmC;AAGnC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGvD,MAAM,OAAO,WAAY,SAAQ,YAAkD;IACjF,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IACrC,CAAC;CACF"}
@@ -0,0 +1,122 @@
1
+ /** Details on charges associated with this log. */
2
+ export interface ChargeDetail {
3
+ /** Description for this charge. */
4
+ description: string;
5
+ /** Charged amount. */
6
+ charge: number;
7
+ }
8
+ export interface LogListResponse {
9
+ /** Object containing pagination links */
10
+ links: LogPaginationResponse;
11
+ /** Array of message log entries */
12
+ data: MessageLog[];
13
+ }
14
+ export interface LogPaginationResponse {
15
+ /** URL to current page */
16
+ self: string;
17
+ /** URL to first page */
18
+ first: string;
19
+ /** URL to next page (if available) */
20
+ next?: string;
21
+ /** URL to previous page (if available) */
22
+ prev?: string;
23
+ }
24
+ /** Response model for message log retrieve endpoint */
25
+ export interface LogRetrieveResponse {
26
+ /** A unique identifier for the log. */
27
+ id: uuid;
28
+ /** The origin phone number. */
29
+ from: string;
30
+ /** The destination phone number. */
31
+ to: string;
32
+ /** The status of the message. */
33
+ status: 'queued' | 'initiated' | 'delivered' | 'sent' | 'received' | 'undelivered' | 'failed';
34
+ /** The direction of the message. */
35
+ direction: 'inbound' | 'outbound' | 'outbound-api' | 'outbound-call' | 'outbound-reply';
36
+ /** The kind of message. */
37
+ kind: 'sms' | 'mms';
38
+ /** Source of this log entry. */
39
+ source: 'realtime_api' | 'laml';
40
+ /** Type of this log entry. */
41
+ type: 'relay_message' | 'laml_message';
42
+ /** URL for the resource associated with this log entry. Null for Relay messages. */
43
+ url: string | null;
44
+ /** The number of segments. */
45
+ number_of_segments: number;
46
+ /** The charge in dollars. */
47
+ charge: number;
48
+ /** Details on charges associated with this log. */
49
+ charge_details: ChargeDetail[];
50
+ /** Date and time when the message entry was created. */
51
+ created_at: string;
52
+ }
53
+ /** Message log entry with all activity details */
54
+ export interface MessageLog {
55
+ /** A unique identifier for the log. */
56
+ id: uuid;
57
+ /** The origin phone number. */
58
+ from: string;
59
+ /** The destination phone number. */
60
+ to: string;
61
+ /** The status of the message. */
62
+ status: 'queued' | 'initiated' | 'delivered' | 'sent' | 'received' | 'undelivered' | 'failed';
63
+ /** The direction of the message. */
64
+ direction: 'inbound' | 'outbound' | 'outbound-api' | 'outbound-call' | 'outbound-reply';
65
+ /** The kind of message. */
66
+ kind: 'sms' | 'mms';
67
+ /** Source of this log entry. */
68
+ source: 'realtime_api' | 'laml';
69
+ /** Type of this log entry. */
70
+ type: 'relay_message' | 'laml_message';
71
+ /** URL for the resource associated with this log entry. Null for Relay messages. */
72
+ url: string | null;
73
+ /** The number of segments. */
74
+ number_of_segments: number;
75
+ /** The charge in dollars. */
76
+ charge: number;
77
+ /** Details on charges associated with this log. */
78
+ charge_details: ChargeDetail[];
79
+ /** Date and time when the message entry was created. */
80
+ created_at: string;
81
+ }
82
+ /** The request contains invalid parameters. See errors for details. */
83
+ export interface MessageLogShowStatusCode422 {
84
+ /** List of validation errors. */
85
+ errors: Types_StatusCodes_RestApiErrorItem[];
86
+ }
87
+ /** The request contains invalid parameters. See errors for details. */
88
+ export interface MessageLogsListStatusCode422 {
89
+ /** List of validation errors. */
90
+ errors: Types_StatusCodes_RestApiErrorItem[];
91
+ }
92
+ /** Details about a specific error. */
93
+ export interface Types_StatusCodes_RestApiErrorItem {
94
+ /** The category of error. */
95
+ type: string;
96
+ /** A specific error code. */
97
+ code: string;
98
+ /** A description of what caused the error. */
99
+ message: string;
100
+ /** The request parameter that caused the error, if applicable. */
101
+ attribute?: string | null;
102
+ /** A link to documentation about this error. */
103
+ url: string;
104
+ }
105
+ /** The request is invalid. */
106
+ export interface Types_StatusCodes_StatusCode400 {
107
+ error: 'Bad Request';
108
+ }
109
+ /** Access is unauthorized. */
110
+ export interface Types_StatusCodes_StatusCode401 {
111
+ error: 'Unauthorized';
112
+ }
113
+ /** The server cannot find the requested resource. */
114
+ export interface Types_StatusCodes_StatusCode404 {
115
+ error: 'Not Found';
116
+ }
117
+ /** An internal server error occurred. */
118
+ export interface Types_StatusCodes_StatusCode500 {
119
+ error: 'Internal Server Error';
120
+ }
121
+ /** Universal Unique Identifier. */
122
+ export type uuid = string;
@@ -0,0 +1,8 @@
1
+ // AUTO-GENERATED from porting-sdk/rest-apis/message/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // Held to the same lint bar as hand-written source (no rule suppressions, no
5
+ // loose types). If the generator cannot emit a clean faithful type, fix the
6
+ // generator rather than weaken the output.
7
+ export {};
8
+ //# sourceMappingURL=message.types.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"message.types.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/message.types.generated.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,0DAA0D;AAC1D,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,2CAA2C"}
@@ -0,0 +1,18 @@
1
+ import type { HttpClient } from '../HttpClient.js';
2
+ import type { RequestOptionsInit } from '../RequestOptions.js';
3
+ import { BaseResource } from '../base/BaseResource.js';
4
+ import type { Message } from './messages.types.generated.js';
5
+ export declare class Messages extends BaseResource {
6
+ constructor(http: HttpClient);
7
+ create(to: string, from: string, options?: {
8
+ body?: string;
9
+ media?: string[];
10
+ send_as_mms?: boolean;
11
+ status_callback?: string;
12
+ custom_variables?: Record<string, string>;
13
+ extras?: Record<string, unknown>;
14
+ }, requestOptions?: RequestOptionsInit): Promise<Message>;
15
+ update(message_id: string, body: string, options?: {
16
+ extras?: Record<string, unknown>;
17
+ }, requestOptions?: RequestOptionsInit): Promise<Message>;
18
+ }
@@ -0,0 +1,44 @@
1
+ // AUTO-GENERATED from porting-sdk/rest-apis/messages/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // One typed resource class per x-sdk-resource: CRUD bases bound to the
5
+ // resource's spec types (closed body + extras door) plus declared operation
6
+ // methods, command-dispatch, and set_methods — mirrors the Python reference's
7
+ // <ns>_resources_generated module.
8
+ import { BaseResource } from '../base/BaseResource.js';
9
+ export class Messages extends BaseResource {
10
+ constructor(http) {
11
+ super(http, '/api/messaging/messages');
12
+ }
13
+ async create(to, from, options, requestOptions) {
14
+ const body_ = {};
15
+ const _fields = {
16
+ to,
17
+ from,
18
+ body: options?.body,
19
+ media: options?.media,
20
+ send_as_mms: options?.send_as_mms,
21
+ status_callback: options?.status_callback,
22
+ custom_variables: options?.custom_variables,
23
+ };
24
+ for (const [k, v] of Object.entries(_fields))
25
+ if (v !== undefined)
26
+ body_[k] = v;
27
+ if (options?.extras)
28
+ Object.assign(body_, options.extras);
29
+ return this._http.post(this._basePath, body_, undefined, requestOptions);
30
+ }
31
+ async update(message_id, body, options, requestOptions) {
32
+ const body_ = {};
33
+ const _fields = {
34
+ body,
35
+ };
36
+ for (const [k, v] of Object.entries(_fields))
37
+ if (v !== undefined)
38
+ body_[k] = v;
39
+ if (options?.extras)
40
+ Object.assign(body_, options.extras);
41
+ return this._http.patch(this._path(message_id), body_, requestOptions);
42
+ }
43
+ }
44
+ //# sourceMappingURL=messages.resources.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"messages.resources.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/messages.resources.generated.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,0DAA0D;AAC1D,EAAE;AACF,uEAAuE;AACvE,4EAA4E;AAC5E,8EAA8E;AAC9E,mCAAmC;AAInC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGvD,MAAM,OAAO,QAAS,SAAQ,YAAY;IACxC,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAY,EACZ,OAOC,EACD,cAAmC;QAEnC,MAAM,KAAK,GAA4B,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG;YACd,EAAE;YACF,IAAI;YACJ,IAAI,EAAE,OAAO,EAAE,IAAI;YACnB,KAAK,EAAE,OAAO,EAAE,KAAK;YACrB,WAAW,EAAE,OAAO,EAAE,WAAW;YACjC,eAAe,EAAE,OAAO,EAAE,eAAe;YACzC,gBAAgB,EAAE,OAAO,EAAE,gBAAgB;SAC5C,CAAC;QACF,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,KAAK,SAAS;gBAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAChF,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAU,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IACpF,CAAC;IAED,KAAK,CAAC,MAAM,CACV,UAAkB,EAClB,IAAY,EACZ,OAA8C,EAC9C,cAAmC;QAEnC,MAAM,KAAK,GAA4B,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG;YACd,IAAI;SACL,CAAC;QACF,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,KAAK,SAAS;gBAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAChF,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAU,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IAClF,CAAC;CACF"}
@@ -0,0 +1,99 @@
1
+ /** Request body for sending a new SMS or MMS message. */
2
+ export interface CreateMessageRequest {
3
+ /** Destination phone number in E.164 format (`+` followed by 5-17 digits). Also accepts passthrough numbers like `988`/`+988`. */
4
+ to: string;
5
+ /** Source phone number. Must be a purchased SignalWire phone number on the project in E.164 format, or a shortcode (5-6 digits). Verified caller IDs are not permitted. */
6
+ from: string;
7
+ /** Message body text. Required if `media` is not provided. Subject to provider-specific character limits. */
8
+ body?: string;
9
+ /** Array of HTTP or HTTPS URLs for media attachments. Presence of media makes the message MMS. Maximum 8 items. */
10
+ media?: string[];
11
+ /** Force the message to be sent as MMS even when no media attachments are provided. */
12
+ send_as_mms?: boolean;
13
+ /** A valid URL to receive message status callback events at each state change. See the [Message status callback](/docs/apis/rest/messages/webhooks/message-status-callback) webhook for the payload your URL will receive. */
14
+ status_callback?: string;
15
+ /** Your own key/value string pairs to attach to the message — for example, an order or case number you want to recognize later. When you also set `status_callback`, SignalWire includes these pairs as a `custom_variables` object in every status callback it sends to that URL, so you can match each callback to a record in your own system. If you don't set `status_callback`, there is nowhere for the variables to be delivered. */
16
+ custom_variables?: Record<string, string>;
17
+ }
18
+ /** Request body for redacting the body of a previously sent message. Only `body` may be updated, and it must be an empty string. */
19
+ export interface UpdateMessageRequest {
20
+ /** Must be an empty string (`""`) to redact the message. Any non-empty value is rejected with `body_must_be_empty`. This is the only field that can be updated. */
21
+ body: string;
22
+ }
23
+ /** A message record. Returned by the create and update endpoints. */
24
+ export interface Message {
25
+ /** The unique ID of the message. This is the `MessageSegment` ID, consistent with the dashboard and the `/api/messaging/logs` endpoint. */
26
+ id: uuid;
27
+ /** The source phone number. */
28
+ from: string;
29
+ /** The destination phone number. */
30
+ to: string;
31
+ /** The message body text. Returns an empty string when the message has been redacted. */
32
+ body: string;
33
+ status: MessageStatus;
34
+ direction: MessageDirection;
35
+ kind: MessageKind;
36
+ /** Array of URLs for any media attachments on the message. Empty for SMS. */
37
+ media: string[];
38
+ /** Number of segments the message body was split into for delivery. */
39
+ number_of_segments: number;
40
+ /** Provider-specific error code if delivery failed. Null when no error occurred. */
41
+ error_code: string | null;
42
+ /** Human-readable error message if delivery failed. Null when no error occurred. */
43
+ error_message: string | null;
44
+ /** Date and time when the message was created. */
45
+ created_at: string;
46
+ /** The ID of the project the message belongs to. */
47
+ project_id: uuid;
48
+ /** Callback URL configured to receive message status events. Null if no callback was configured. */
49
+ status_callback_url: string | null;
50
+ /** Relative URL for retrieving the message via the `/api/messaging/logs` endpoint. */
51
+ message_uri: string;
52
+ }
53
+ /** Delivery state of a message. */
54
+ export type MessageStatus = 'queued' | 'initiated' | 'sent' | 'delivered' | 'undelivered' | 'failed' | 'read';
55
+ /** The direction of a message. */
56
+ export type MessageDirection = 'inbound' | 'outbound';
57
+ /** The kind of message. */
58
+ export type MessageKind = 'sms' | 'mms';
59
+ /** The request contains invalid parameters. See errors for details. */
60
+ export interface MessagesCreateStatusCode422 {
61
+ /** List of validation errors. */
62
+ errors: Types_StatusCodes_RestApiErrorItem[];
63
+ }
64
+ /** The request contains invalid parameters. See errors for details. */
65
+ export interface MessagesUpdateStatusCode422 {
66
+ /** List of validation errors. */
67
+ errors: Types_StatusCodes_RestApiErrorItem[];
68
+ }
69
+ /** Details about a specific error. */
70
+ export interface Types_StatusCodes_RestApiErrorItem {
71
+ /** The category of error. */
72
+ type: string;
73
+ /** A specific error code. */
74
+ code: string;
75
+ /** A description of what caused the error. */
76
+ message: string;
77
+ /** The request parameter that caused the error, if applicable. */
78
+ attribute?: string | null;
79
+ /** A link to documentation about this error. */
80
+ url: string;
81
+ }
82
+ /** The request is invalid. */
83
+ export interface Types_StatusCodes_StatusCode400 {
84
+ error: 'Bad Request';
85
+ }
86
+ /** Access is unauthorized. */
87
+ export interface Types_StatusCodes_StatusCode401 {
88
+ error: 'Unauthorized';
89
+ }
90
+ /** The server cannot find the requested resource. */
91
+ export interface Types_StatusCodes_StatusCode404 {
92
+ error: 'Not Found';
93
+ }
94
+ /** An internal server error occurred. */
95
+ export interface Types_StatusCodes_StatusCode500 {
96
+ error: 'Internal Server Error';
97
+ }
98
+ /** Universal Unique Identifier. */
99
+ export type uuid = string;
@@ -0,0 +1,8 @@
1
+ // AUTO-GENERATED from porting-sdk/rest-apis/messages/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // Held to the same lint bar as hand-written source (no rule suppressions, no
5
+ // loose types). If the generator cannot emit a clean faithful type, fix the
6
+ // generator rather than weaken the output.
7
+ export {};
8
+ //# sourceMappingURL=messages.types.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"messages.types.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/messages.types.generated.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,0DAA0D;AAC1D,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,2CAA2C"}
@@ -1,46 +1,7 @@
1
1
  /**
2
2
  * MFA (Multi-Factor Authentication) namespace.
3
- */
4
- import type { HttpClient } from '../HttpClient.js';
5
- import { BaseResource } from '../base/BaseResource.js';
6
- /**
7
- * Multi-factor authentication via SMS or phone call.
8
- *
9
- * Access via `client.mfa.*`. Two-step flow: call `.sms()` or `.call()` to send
10
- * a code, then `.verify()` to confirm it.
11
3
  *
12
- * @example
13
- * ```ts
14
- * const req = await client.mfa.sms({ to: '+15551234567' });
15
- * const result = await client.mfa.verify(req.id, { token: '123456' });
16
- * ```
4
+ * Generated from the relay-rest OpenAPI spec; re-exported here (with the
5
+ * `MfaResource` back-compat alias) so existing imports keep working.
17
6
  */
18
- export declare class MfaResource extends BaseResource {
19
- constructor(http: HttpClient);
20
- /**
21
- * Initiate MFA by sending a one-time code to a phone number over SMS.
22
- *
23
- * @param body - MFA request payload (typically `{ to: "+15551234567",
24
- * message?: "Your code is {code}" }`).
25
- * @returns The MFA request record; its `id` is used by {@link verify}.
26
- * @throws {RestError} On any non-2xx HTTP response.
27
- */
28
- sms(body: any): Promise<any>;
29
- /**
30
- * Initiate MFA by placing a phone call that reads out a one-time code.
31
- *
32
- * @param body - MFA request payload (typically `{ to: "+15551234567" }`).
33
- * @returns The MFA request record; its `id` is used by {@link verify}.
34
- * @throws {RestError} On any non-2xx HTTP response.
35
- */
36
- call(body: any): Promise<any>;
37
- /**
38
- * Verify the one-time code the user received via SMS or call.
39
- *
40
- * @param requestId - The `id` returned from {@link sms} or {@link call}.
41
- * @param body - Verification payload (typically `{ token: "123456" }`).
42
- * @returns The verification result — success or failure shape.
43
- * @throws {RestError} On any non-2xx HTTP response.
44
- */
45
- verify(requestId: string, body: any): Promise<any>;
46
- }
7
+ export { Mfa, Mfa as MfaResource } from './relay-rest.resources.generated.js';