@signalwire/sdk 2.0.4 → 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 +550 -163
  6. package/dist/AgentBase.js +1640 -514
  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 +163 -0
  30. package/dist/POM/PromptObjectModel.js +481 -0
  31. package/dist/POM/PromptObjectModel.js.map +1 -0
  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 +28 -0
  42. package/dist/PomBuilder.js +81 -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 +29 -1
  48. package/dist/PromptManager.js +37 -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 +265 -66
  58. package/dist/SWMLService.js +652 -112
  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 +55 -8
  64. package/dist/SecurityUtils.js +162 -49
  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 +95 -34
  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 -367
  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 +102 -39
  169. package/dist/index.js +107 -30
  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 +79 -14
  204. package/dist/relay/RelayClient.js +268 -61
  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 +81 -39
  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 +63 -0
  245. package/dist/rest/callHandler.js +62 -0
  246. package/dist/rest/callHandler.js.map +1 -0
  247. package/dist/rest/index.d.ts +19 -76
  248. package/dist/rest/index.js +49 -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 -273
  284. package/dist/rest/namespaces/fabric.js +14 -363
  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 +9 -57
  332. package/dist/rest/namespaces/phone-numbers.js +9 -63
  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 +47 -7
  412. package/dist/skills/SkillRegistry.js +85 -13
  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 +24 -8
  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 +34 -25
  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 +46 -1
  460. package/dist/skills/builtin/spider.js +317 -101
  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 +57 -31
  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 +301 -84
  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 +32 -14
  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 +65 -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 +88 -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,8 @@
1
+ // AUTO-GENERATED from porting-sdk/relay-protocol/*.{params,result}.json — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-relay-protocol.ts
3
+ //
4
+ // One interface per RELAY method's params (<Method>Params) and ack result
5
+ // (<Method>Result), from the canonical switchblade wire schemas. Held to the
6
+ // same lint bar as hand-written source (no rule suppressions, no loose types).
7
+ export {};
8
+ //# sourceMappingURL=protocol.types.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"protocol.types.generated.js","sourceRoot":"","sources":["../../src/relay/protocol.types.generated.ts"],"names":[],"mappings":"AAAA,uFAAuF;AACvF,8DAA8D;AAC9D,EAAE;AACF,0EAA0E;AAC1E,6EAA6E;AAC7E,+EAA+E"}
@@ -4,6 +4,7 @@
4
4
  import type { Call } from './Call.js';
5
5
  import type { Message } from './Message.js';
6
6
  import type { RelayEvent } from './RelayEvent.js';
7
+ import type { CallingCollectParams, CallingPlayParams } from './protocol.types.generated.js';
7
8
  /** Options for constructing a RelayClient. */
8
9
  export interface RelayClientOptions {
9
10
  /** SignalWire project ID. Defaults to env SIGNALWIRE_PROJECT_ID. */
@@ -14,6 +15,16 @@ export interface RelayClientOptions {
14
15
  jwtToken?: string;
15
16
  /** RELAY host. Defaults to relay.signalwire.com. */
16
17
  host?: string;
18
+ /**
19
+ * WebSocket scheme — `'wss'` (production, the default) or `'ws'`
20
+ * (loopback fixtures and local audit harnesses). Reads from
21
+ * `SIGNALWIRE_RELAY_SCHEME` if not explicitly set; defaults to `'wss'`.
22
+ *
23
+ * Production deployments should never pass `'ws'` — the value exists
24
+ * solely so tests can drive the real client against a plain-WS loopback
25
+ * fixture without standing up TLS termination.
26
+ */
27
+ scheme?: 'ws' | 'wss';
17
28
  /** Contexts (topics) to receive inbound calls/messages on. */
18
29
  contexts?: string[];
19
30
  /** Maximum number of concurrent active calls. Defaults to env RELAY_MAX_ACTIVE_CALLS or 1000. */
@@ -67,34 +78,73 @@ export interface SipDevice {
67
78
  codecs?: string[];
68
79
  headers?: Record<string, string>[];
69
80
  }
70
- /** Any device specification. */
71
- export type Device = PhoneDevice | SipDevice | Record<string, unknown>;
72
- /** Options for the dial() method. */
73
- export interface DialOptions {
74
- /** Caller ID / from number. */
81
+ /**
82
+ * Fabric device specification for dial/connect — dials a Fabric address directly.
83
+ * The platform resolves the address to whatever it points to (a Subscriber, a
84
+ * Relay/LaML application, a video room, …) and builds the appropriate leg(s); the
85
+ * caller just names the address and never picks a transport. For a Subscriber
86
+ * this fans out in parallel to their live registrations (push + WebRTC + SIP),
87
+ * reaching the person without provisioning an intermediate SIP address.
88
+ */
89
+ export interface FabricDevice {
90
+ type: 'fabric';
91
+ to: string;
75
92
  from?: string;
76
- /** Timeout in seconds for the dial. */
77
93
  timeout?: number;
78
- /** Maximum call duration in seconds. */
94
+ }
95
+ /** Any device specification. */
96
+ export type Device = PhoneDevice | SipDevice | FabricDevice | Record<string, unknown>;
97
+ /** Options for `RelayClient.dial()`. */
98
+ export interface DialOptions {
99
+ /**
100
+ * Client-provided tag for event correlation. Auto-generated (UUID) when
101
+ * omitted.
102
+ */
103
+ tag?: string;
104
+ /** Maximum call duration in **minutes** (sent as `max_duration`). */
79
105
  maxDuration?: number;
106
+ /**
107
+ * Seconds to wait for a device to answer before `dial()` rejects. Defaults
108
+ * to `120`.
109
+ */
110
+ dialTimeout?: number;
80
111
  }
81
- /** Options for the sendMessage() method. */
112
+ /** Options for `RelayClient.sendMessage()`. */
82
113
  export interface SendMessageOptions {
83
114
  /** Destination phone number in E.164 format. */
84
115
  toNumber: string;
85
116
  /** Sender phone number in E.164 format. */
86
117
  fromNumber: string;
87
- /** Message body text. */
118
+ /**
119
+ * Context for receiving state events. Defaults to the negotiated relay
120
+ * protocol.
121
+ */
122
+ context?: string;
123
+ /** Message body text. At least one of `body` or `media` is required. */
88
124
  body?: string;
89
- /** Media URLs for MMS. */
125
+ /** Media URLs for MMS. At least one of `body` or `media` is required. */
90
126
  media?: string[];
91
- /** Context for the message. */
92
- context?: string;
93
- /** Tags for the message. */
127
+ /** Tags attached to the message for correlation. */
94
128
  tags?: string[];
129
+ /** Origination region override. */
130
+ region?: string;
131
+ /**
132
+ * Callback fired once when the message reaches a terminal state
133
+ * (`delivered`, `undelivered` or `failed`).
134
+ */
135
+ onCompleted?: CompletedCallback;
95
136
  }
96
- /** Play item: TTS, audio URL, ringtone, or silence. */
97
- export type PlayItem = {
137
+ /**
138
+ * A play item accepted by `play()` / `playAndCollect()`.
139
+ *
140
+ * The canonical RELAY wire form is `{ type, params }`
141
+ * (`CallingPlayParams['play'][number]`). The SDK also accepts the friendly flat
142
+ * shorthands below (`{ type: 'tts', text }`, etc.), which
143
+ * {@link normalizePlayItem} expands into `params` before sending. So the
144
+ * accepted-input type is the wire shape OR one of the flat shorthands — exactly
145
+ * the set the normalizer handles, not the post-normalization wire shape alone.
146
+ */
147
+ export type PlayItem = CallingPlayParams['play'][number] | {
98
148
  type: 'tts';
99
149
  text: string;
100
150
  language?: string;
@@ -109,30 +159,22 @@ export type PlayItem = {
109
159
  } | {
110
160
  type: 'silence';
111
161
  duration: number;
112
- } | Record<string, unknown>;
113
- /** Collect input configuration. */
114
- export interface CollectConfig {
115
- /** Collect digits. */
116
- digits?: {
117
- max: number;
118
- digit_timeout?: number;
119
- terminators?: string;
120
- };
121
- /** Collect speech. */
122
- speech?: {
123
- end_silence_timeout?: number;
124
- speech_timeout?: number;
125
- language?: string;
126
- hints?: string[];
127
- model?: string;
128
- };
129
- /** Initial timeout in seconds. */
130
- initial_timeout?: number;
131
- /** Partial results? */
132
- partial_results?: boolean;
133
- /** Continuous mode? */
134
- continuous?: boolean;
135
- }
162
+ };
163
+ /**
164
+ * Collect-input configuration — the canonical `calling.collect` params minus the
165
+ * transport keys (`node_id`/`call_id`/`control_id`) the SDK fills internally.
166
+ * The `digits`/`speech`/timer field types come straight from the RELAY schema.
167
+ */
168
+ export type CollectConfig = Omit<CallingCollectParams, 'node_id' | 'call_id' | 'control_id'>;
169
+ /**
170
+ * A device descriptor accepted by `connect()` / `refer()` / `tap()`. Same
171
+ * wire-or-flat duality as {@link PlayItem}: {@link normalizeDevice} accepts a
172
+ * flat `{ type, to, from, … }` and expands it into `{ type, params }`, so the
173
+ * accepted-input type is an object with a `type` plus arbitrary other fields.
174
+ */
175
+ export type DeviceInput = {
176
+ type: string;
177
+ } & Record<string, unknown>;
136
178
  /** Queued request waiting for reconnection. */
137
179
  export interface QueuedRequest {
138
180
  method: string;
@@ -3,13 +3,22 @@
3
3
  *
4
4
  * All methods return parsed JSON. Throws RestError on non-2xx responses.
5
5
  * Returns {} on 204 No Content.
6
+ *
7
+ * Transport behavior (timeout, opt-in retry with an idempotency-aware policy +
8
+ * exponential backoff, cooperative cancellation) is governed by the
9
+ * {@link RequestOptions} envelope (plan 4.2): a client default stored here, plus
10
+ * an optional per-request override each verb accepts. See RequestOptions.ts.
6
11
  */
7
12
  import type { HttpClientOptions, QueryParams } from './types.js';
13
+ import { type RequestOptionsInit } from './RequestOptions.js';
14
+ /** The SDK's User-Agent, shared by the other HTTP clients (the AI Chat client). */
15
+ export declare function _userAgent(): string;
8
16
  /**
9
17
  * Low-level HTTP client used by every REST namespace resource.
10
18
  *
11
- * Handles Basic Auth, JSON encoding/decoding, and error normalisation
12
- * ({@link RestError} on non-2xx). Normally you do not instantiate this
19
+ * Handles Basic Auth, JSON encoding/decoding, error normalisation
20
+ * ({@link RestError} on non-2xx), and the {@link RequestOptions} transport
21
+ * envelope (timeout / retry / abort). Normally you do not instantiate this
13
22
  * directly — construct a {@link RestClient} instead.
14
23
  */
15
24
  export declare class HttpClient {
@@ -17,26 +26,41 @@ export declare class HttpClient {
17
26
  readonly baseUrl: string;
18
27
  private readonly _authHeader;
19
28
  private readonly _fetch;
29
+ /** Client-default request options, shallow-overridden per request. */
30
+ private readonly _requestOptions?;
20
31
  /**
21
32
  * Build a new HTTP client.
22
33
  *
23
34
  * @param options - Connection options. Either `host` (bare hostname;
24
35
  * `https://` is prepended automatically) or `baseUrl` (fully-qualified)
25
- * must be provided along with `project` + `token`.
36
+ * must be provided along with `project` + `token`. An optional
37
+ * `requestOptions` sets the client-default transport envelope.
26
38
  * @throws {Error} When neither `host` nor `baseUrl` is supplied.
27
39
  */
28
40
  constructor(options: HttpClientOptions);
41
+ /** Parse a `Retry-After` header (delta-seconds form) if present, else null. */
42
+ private _retryAfterSeconds;
29
43
  private _request;
44
+ /**
45
+ * Build the per-attempt `AbortSignal` fed to fetch: the caller's abortSignal
46
+ * (TRUE in-flight cancellation) combined with a per-attempt timeout. A fresh
47
+ * timeout is created for each attempt so the wall-clock budget is per attempt,
48
+ * matching the contract. When neither applies, returns undefined.
49
+ */
50
+ private _attemptSignal;
51
+ /** Whether an error is an AbortError (fetch abort or timeout). */
52
+ private _isAbort;
30
53
  /**
31
54
  * Perform an authenticated HTTP GET and return the parsed JSON response.
32
55
  *
33
56
  * @typeParam T - Expected response body type.
34
57
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
35
58
  * @param params - Optional query parameters; `undefined` values are skipped.
59
+ * @param requestOptions - Optional per-request transport envelope override.
36
60
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
37
61
  * @throws {RestError} On any non-2xx HTTP response.
38
62
  */
39
- get<T = any>(path: string, params?: QueryParams): Promise<T>;
63
+ get<T = unknown>(path: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<T>;
40
64
  /**
41
65
  * Perform an authenticated HTTP POST and return the parsed JSON response.
42
66
  *
@@ -44,37 +68,41 @@ export declare class HttpClient {
44
68
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
45
69
  * @param body - JSON-serialisable request body. Omit to send no body.
46
70
  * @param params - Optional query parameters appended to the URL.
71
+ * @param requestOptions - Optional per-request transport envelope override.
47
72
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
48
73
  * @throws {RestError} On any non-2xx HTTP response.
49
74
  */
50
- post<T = any>(path: string, body?: any, params?: QueryParams): Promise<T>;
75
+ post<T = unknown>(path: string, body?: unknown, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<T>;
51
76
  /**
52
77
  * Perform an authenticated HTTP PUT and return the parsed JSON response.
53
78
  *
54
79
  * @typeParam T - Expected response body type.
55
80
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
56
81
  * @param body - JSON-serialisable request body.
82
+ * @param requestOptions - Optional per-request transport envelope override.
57
83
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
58
84
  * @throws {RestError} On any non-2xx HTTP response.
59
85
  */
60
- put<T = any>(path: string, body?: any): Promise<T>;
86
+ put<T = unknown>(path: string, body?: unknown, requestOptions?: RequestOptionsInit): Promise<T>;
61
87
  /**
62
88
  * Perform an authenticated HTTP PATCH and return the parsed JSON response.
63
89
  *
64
90
  * @typeParam T - Expected response body type.
65
91
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
66
92
  * @param body - JSON-serialisable partial request body.
93
+ * @param requestOptions - Optional per-request transport envelope override.
67
94
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
68
95
  * @throws {RestError} On any non-2xx HTTP response.
69
96
  */
70
- patch<T = any>(path: string, body?: any): Promise<T>;
97
+ patch<T = unknown>(path: string, body?: unknown, requestOptions?: RequestOptionsInit): Promise<T>;
71
98
  /**
72
99
  * Perform an authenticated HTTP DELETE and return the parsed JSON response.
73
100
  *
74
101
  * @typeParam T - Expected response body type.
75
102
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
103
+ * @param requestOptions - Optional per-request transport envelope override.
76
104
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
77
105
  * @throws {RestError} On any non-2xx HTTP response.
78
106
  */
79
- delete<T = any>(path: string): Promise<T>;
107
+ delete<T = unknown>(path: string, requestOptions?: RequestOptionsInit): Promise<T>;
80
108
  }
@@ -3,16 +3,116 @@
3
3
  *
4
4
  * All methods return parsed JSON. Throws RestError on non-2xx responses.
5
5
  * Returns {} on 204 No Content.
6
+ *
7
+ * Transport behavior (timeout, opt-in retry with an idempotency-aware policy +
8
+ * exponential backoff, cooperative cancellation) is governed by the
9
+ * {@link RequestOptions} envelope (plan 4.2): a client default stored here, plus
10
+ * an optional per-request override each verb accepts. See RequestOptions.ts.
6
11
  */
7
- /* eslint-disable @typescript-eslint/no-explicit-any */
12
+ import { createRequire } from 'node:module';
8
13
  import { getLogger } from '../Logger.js';
9
- import { RestError } from './RestError.js';
14
+ import { RestError, RestTransportError } from './RestError.js';
15
+ import { resolve, statusIsRetryable, } from './RequestOptions.js';
10
16
  const logger = getLogger('rest_client');
17
+ /**
18
+ * True if `host` (bare host or host:port) is a local loopback address — a local
19
+ * mock/dev server that speaks plain HTTP. Used to pick `http://` vs `https://`
20
+ * so a shipped example runs verbatim against the local mock
21
+ * (SIGNALWIRE_SPACE=127.0.0.1:<port>) without a code change. A real SignalWire
22
+ * space (`<name>.signalwire.com`) is never loopback, so production is unaffected.
23
+ * Mirrors the python reference `rest/_base.py:_is_loopback_host`.
24
+ *
25
+ * Module-private (not exported) — an internal transport helper, not public API
26
+ * surface. RestClient reaches it by passing `host` to this HttpClient rather
27
+ * than pre-building the URL, so the scheme decision lives in one place here.
28
+ */
29
+ function isLoopbackHost(host) {
30
+ const hostname = host.includes(':') ? host.slice(0, host.lastIndexOf(':')) : host;
31
+ return (hostname === '127.0.0.1' ||
32
+ hostname === 'localhost' ||
33
+ hostname === '::1' ||
34
+ hostname === '[::1]');
35
+ }
36
+ /**
37
+ * REST client User-Agent, derived at runtime from the installed package version
38
+ * so it can never drift from a hardcoded literal (the token used to be a stale
39
+ * `@signalwire/sdk-ts/2.0.0` while the package moved on). The product token is
40
+ * `signalwire-typescript`, mirroring the Python reference's `signalwire-python/<v>`.
41
+ *
42
+ * `../../package.json` resolves identically in both layouts — from `src/rest/`
43
+ * during dev (tsx) and from `dist/rest/` when installed — since package.json
44
+ * always ships at the package root two levels above this module.
45
+ */
46
+ function buildUserAgent() {
47
+ let version = 'unknown';
48
+ try {
49
+ const require = createRequire(import.meta.url);
50
+ const pkg = require('../../package.json');
51
+ if (pkg.version)
52
+ version = pkg.version;
53
+ }
54
+ catch {
55
+ // Uninstalled / unusual bundling — fall back to the stable product token.
56
+ }
57
+ return `signalwire-typescript/${version}`;
58
+ }
59
+ const USER_AGENT = buildUserAgent();
60
+ /** The SDK's User-Agent, shared by the other HTTP clients (the AI Chat client). */
61
+ export function _userAgent() {
62
+ return USER_AGENT;
63
+ }
64
+ /**
65
+ * Cached undici dispatcher trusting a custom REST CA bundle, built lazily on
66
+ * first use from `SIGNALWIRE_REST_CA_FILE` (A5 fleet CA-var contract, hard-cut,
67
+ * no aliases). When the env var names a CA bundle, it becomes the REST HTTP
68
+ * client's TLS trust root — the exact REST half of the fleet pair
69
+ * (`SIGNALWIRE_RELAY_CA_FILE` is the RELAY half). Unset → node's default trust
70
+ * store (no dispatcher attached). Mirrors the python reference
71
+ * (`rest/_base.py:163` — `session.verify = SIGNALWIRE_REST_CA_FILE`).
72
+ *
73
+ * The result is cached per resolved file path so repeated requests reuse one
74
+ * connection pool. Returns `undefined` when the env var is unset (or the file
75
+ * cannot be read — in which case node's default trust store applies and the
76
+ * platform cert still validates against the public roots).
77
+ */
78
+ let _restCaDispatcher;
79
+ function restCaDispatcher() {
80
+ const caFile = process.env['SIGNALWIRE_REST_CA_FILE'];
81
+ if (!caFile)
82
+ return undefined;
83
+ if (_restCaDispatcher?.key === caFile)
84
+ return _restCaDispatcher.dispatcher;
85
+ try {
86
+ // Imported lazily so environments without undici (or where the var is never
87
+ // set) pay nothing at module load.
88
+ const require = createRequire(import.meta.url);
89
+ const { Agent } = require('undici');
90
+ const { readFileSync } = require('node:fs');
91
+ const ca = readFileSync(caFile);
92
+ const dispatcher = new Agent({ connect: { ca } });
93
+ _restCaDispatcher = { key: caFile, dispatcher };
94
+ return dispatcher;
95
+ }
96
+ catch (err) {
97
+ logger.warn('rest_ca_file_load_failed', {
98
+ file: caFile,
99
+ error: err instanceof Error ? err.message : String(err),
100
+ });
101
+ return undefined;
102
+ }
103
+ }
104
+ /** Backoff sleep between retries (a Promise-based delay). */
105
+ function sleep(seconds) {
106
+ if (seconds <= 0)
107
+ return Promise.resolve();
108
+ return new Promise((r) => setTimeout(r, seconds * 1000));
109
+ }
11
110
  /**
12
111
  * Low-level HTTP client used by every REST namespace resource.
13
112
  *
14
- * Handles Basic Auth, JSON encoding/decoding, and error normalisation
15
- * ({@link RestError} on non-2xx). Normally you do not instantiate this
113
+ * Handles Basic Auth, JSON encoding/decoding, error normalisation
114
+ * ({@link RestError} on non-2xx), and the {@link RequestOptions} transport
115
+ * envelope (timeout / retry / abort). Normally you do not instantiate this
16
116
  * directly — construct a {@link RestClient} instead.
17
117
  */
18
118
  export class HttpClient {
@@ -20,12 +120,15 @@ export class HttpClient {
20
120
  baseUrl;
21
121
  _authHeader;
22
122
  _fetch;
123
+ /** Client-default request options, shallow-overridden per request. */
124
+ _requestOptions;
23
125
  /**
24
126
  * Build a new HTTP client.
25
127
  *
26
128
  * @param options - Connection options. Either `host` (bare hostname;
27
129
  * `https://` is prepended automatically) or `baseUrl` (fully-qualified)
28
- * must be provided along with `project` + `token`.
130
+ * must be provided along with `project` + `token`. An optional
131
+ * `requestOptions` sets the client-default transport envelope.
29
132
  * @throws {Error} When neither `host` nor `baseUrl` is supplied.
30
133
  */
31
134
  constructor(options) {
@@ -33,13 +136,27 @@ export class HttpClient {
33
136
  throw new Error('HttpClientOptions requires either "host" or "baseUrl".');
34
137
  }
35
138
  // host takes precedence (matches Python's HttpClient(project, token, host) convention
36
- // where a bare hostname is expected and https:// is prepended automatically).
37
- const rawUrl = options.host ? `https://${options.host}` : options.baseUrl;
139
+ // where a bare hostname is expected and the scheme is prepended automatically).
140
+ // A loopback host (127.0.0.1[:port] / localhost) is a local mock/dev server that
141
+ // speaks plain HTTP — use http:// for it; every other host uses https://.
142
+ const rawUrl = options.host
143
+ ? `${isLoopbackHost(options.host) ? 'http' : 'https'}://${options.host}`
144
+ : options.baseUrl;
38
145
  this.baseUrl = rawUrl.replace(/\/+$/, '');
39
- this._authHeader = 'Basic ' + Buffer.from(`${options.project}:${options.token}`).toString('base64');
146
+ this._authHeader =
147
+ 'Basic ' + Buffer.from(`${options.project}:${options.token}`).toString('base64');
40
148
  this._fetch = options.fetchImpl ?? globalThis.fetch;
149
+ this._requestOptions = options.requestOptions;
41
150
  }
42
- async _request(method, path, body, params) {
151
+ /** Parse a `Retry-After` header (delta-seconds form) if present, else null. */
152
+ _retryAfterSeconds(resp) {
153
+ const value = resp.headers.get('Retry-After');
154
+ if (value === null)
155
+ return null;
156
+ const n = Number(value);
157
+ return Number.isFinite(n) ? n : null; // HTTP-date form: fall back to backoff
158
+ }
159
+ async _request(method, path, body, params, requestOptions) {
43
160
  let url = path.startsWith('http') ? path : `${this.baseUrl}${path}`;
44
161
  if (params) {
45
162
  const qs = new URLSearchParams();
@@ -51,38 +168,109 @@ export class HttpClient {
51
168
  if (qsStr)
52
169
  url += (url.includes('?') ? '&' : '?') + qsStr;
53
170
  }
171
+ const opts = resolve(this._requestOptions, requestOptions);
54
172
  logger.debug(`${method} ${url}`);
55
173
  const headers = {
56
- 'Authorization': this._authHeader,
57
- 'Accept': 'application/json',
58
- 'User-Agent': '@signalwire/sdk-ts/2.0.0',
174
+ Authorization: this._authHeader,
175
+ Accept: 'application/json',
176
+ 'User-Agent': USER_AGENT,
59
177
  };
60
178
  if (body !== undefined) {
61
179
  headers['Content-Type'] = 'application/json';
62
180
  }
63
- const resp = await this._fetch(url, {
64
- method,
65
- headers,
66
- body: body !== undefined ? JSON.stringify(body) : undefined,
67
- });
68
- if (!resp.ok) {
69
- const text = await resp.text();
70
- let errBody = text;
181
+ const encodedBody = body !== undefined ? JSON.stringify(body) : undefined;
182
+ // total attempts = retries + 1; retry on a retryable status (idempotency-
183
+ // aware) or a transport error, honoring Retry-After then exponential
184
+ // backoff. abortSignal is checked cooperatively before every attempt AND
185
+ // passed to fetch for TRUE in-flight abort.
186
+ let attempt = 0;
187
+ for (;;) {
188
+ attempt += 1;
189
+ if (opts.abortSignal?.aborted) {
190
+ // Cancelled before this attempt — surface as the transport-error family
191
+ // (no response was produced), not a bare exception.
192
+ throw new RestTransportError('request cancelled by abortSignal', url, method);
193
+ }
194
+ let resp;
71
195
  try {
72
- errBody = JSON.parse(text);
196
+ // Attach the custom-CA dispatcher when SIGNALWIRE_REST_CA_FILE is set so
197
+ // the platform cert validates against the supplied trust bundle (A5).
198
+ const init = {
199
+ method,
200
+ headers,
201
+ body: encodedBody,
202
+ signal: this._attemptSignal(opts),
203
+ };
204
+ const dispatcher = restCaDispatcher();
205
+ if (dispatcher !== undefined)
206
+ init.dispatcher = dispatcher;
207
+ resp = await this._fetch(url, init);
73
208
  }
74
- catch {
75
- // Response was not valid JSON — keep as plain string.
209
+ catch (err) {
210
+ // Transport failure (connection refused / DNS / reset / TLS / timeout /
211
+ // abort): fetch rejects and the request never produced a response.
212
+ // Retry if attempts remain, else wrap in the typed error family so a
213
+ // caller catching RestError handles it too.
214
+ if (this._isAbort(err) && opts.abortSignal?.aborted) {
215
+ // A user-driven abort (not a timeout) is terminal — do not retry.
216
+ throw new RestTransportError('request cancelled by abortSignal', url, method);
217
+ }
218
+ if (attempt <= opts.retries) {
219
+ await sleep(opts.retryBackoff * 2 ** (attempt - 1));
220
+ continue;
221
+ }
222
+ const message = err instanceof Error ? err.message : String(err);
223
+ throw new RestTransportError(message, url, method);
76
224
  }
77
- throw new RestError(resp.status, errBody, url, method);
225
+ if (!resp.ok) {
226
+ if (attempt <= opts.retries && statusIsRetryable(method, resp.status, opts)) {
227
+ let delay = this._retryAfterSeconds(resp);
228
+ if (delay === null)
229
+ delay = opts.retryBackoff * 2 ** (attempt - 1);
230
+ await sleep(delay);
231
+ continue;
232
+ }
233
+ const text = await resp.text();
234
+ let errBody = text;
235
+ try {
236
+ errBody = JSON.parse(text);
237
+ }
238
+ catch {
239
+ // Response was not valid JSON — keep as plain string.
240
+ }
241
+ // §6.6 error-observability: capture the response header map so RestError
242
+ // can surface the platform request id (x-request-id etc.) — no wire change.
243
+ const respHeaders = {};
244
+ resp.headers.forEach((v, k) => {
245
+ respHeaders[k] = v;
246
+ });
247
+ throw new RestError(resp.status, errBody, url, method, respHeaders);
248
+ }
249
+ if (resp.status === 204) {
250
+ return {};
251
+ }
252
+ const text = await resp.text();
253
+ if (!text)
254
+ return {};
255
+ return JSON.parse(text);
78
256
  }
79
- if (resp.status === 204) {
80
- return {};
257
+ }
258
+ /**
259
+ * Build the per-attempt `AbortSignal` fed to fetch: the caller's abortSignal
260
+ * (TRUE in-flight cancellation) combined with a per-attempt timeout. A fresh
261
+ * timeout is created for each attempt so the wall-clock budget is per attempt,
262
+ * matching the contract. When neither applies, returns undefined.
263
+ */
264
+ _attemptSignal(opts) {
265
+ const timeoutSignal = opts.timeout > 0 ? AbortSignal.timeout(opts.timeout * 1000) : undefined;
266
+ if (opts.abortSignal && timeoutSignal) {
267
+ return AbortSignal.any([opts.abortSignal, timeoutSignal]);
81
268
  }
82
- const text = await resp.text();
83
- if (!text)
84
- return {};
85
- return JSON.parse(text);
269
+ return opts.abortSignal ?? timeoutSignal;
270
+ }
271
+ /** Whether an error is an AbortError (fetch abort or timeout). */
272
+ _isAbort(err) {
273
+ return err instanceof Error && (err.name === 'AbortError' || err.name === 'TimeoutError');
86
274
  }
87
275
  /**
88
276
  * Perform an authenticated HTTP GET and return the parsed JSON response.
@@ -90,11 +278,12 @@ export class HttpClient {
90
278
  * @typeParam T - Expected response body type.
91
279
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
92
280
  * @param params - Optional query parameters; `undefined` values are skipped.
281
+ * @param requestOptions - Optional per-request transport envelope override.
93
282
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
94
283
  * @throws {RestError} On any non-2xx HTTP response.
95
284
  */
96
- async get(path, params) {
97
- return this._request('GET', path, undefined, params);
285
+ async get(path, params, requestOptions) {
286
+ return this._request('GET', path, undefined, params, requestOptions);
98
287
  }
99
288
  /**
100
289
  * Perform an authenticated HTTP POST and return the parsed JSON response.
@@ -103,11 +292,12 @@ export class HttpClient {
103
292
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
104
293
  * @param body - JSON-serialisable request body. Omit to send no body.
105
294
  * @param params - Optional query parameters appended to the URL.
295
+ * @param requestOptions - Optional per-request transport envelope override.
106
296
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
107
297
  * @throws {RestError} On any non-2xx HTTP response.
108
298
  */
109
- async post(path, body, params) {
110
- return this._request('POST', path, body, params);
299
+ async post(path, body, params, requestOptions) {
300
+ return this._request('POST', path, body, params, requestOptions);
111
301
  }
112
302
  /**
113
303
  * Perform an authenticated HTTP PUT and return the parsed JSON response.
@@ -115,11 +305,12 @@ export class HttpClient {
115
305
  * @typeParam T - Expected response body type.
116
306
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
117
307
  * @param body - JSON-serialisable request body.
308
+ * @param requestOptions - Optional per-request transport envelope override.
118
309
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
119
310
  * @throws {RestError} On any non-2xx HTTP response.
120
311
  */
121
- async put(path, body) {
122
- return this._request('PUT', path, body);
312
+ async put(path, body, requestOptions) {
313
+ return this._request('PUT', path, body, undefined, requestOptions);
123
314
  }
124
315
  /**
125
316
  * Perform an authenticated HTTP PATCH and return the parsed JSON response.
@@ -127,22 +318,24 @@ export class HttpClient {
127
318
  * @typeParam T - Expected response body type.
128
319
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
129
320
  * @param body - JSON-serialisable partial request body.
321
+ * @param requestOptions - Optional per-request transport envelope override.
130
322
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
131
323
  * @throws {RestError} On any non-2xx HTTP response.
132
324
  */
133
- async patch(path, body) {
134
- return this._request('PATCH', path, body);
325
+ async patch(path, body, requestOptions) {
326
+ return this._request('PATCH', path, body, undefined, requestOptions);
135
327
  }
136
328
  /**
137
329
  * Perform an authenticated HTTP DELETE and return the parsed JSON response.
138
330
  *
139
331
  * @typeParam T - Expected response body type.
140
332
  * @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
333
+ * @param requestOptions - Optional per-request transport envelope override.
141
334
  * @returns The parsed JSON body, or `{}` on `204 No Content`.
142
335
  * @throws {RestError} On any non-2xx HTTP response.
143
336
  */
144
- async delete(path) {
145
- return this._request('DELETE', path);
337
+ async delete(path, requestOptions) {
338
+ return this._request('DELETE', path, undefined, undefined, requestOptions);
146
339
  }
147
340
  }
148
341
  //# sourceMappingURL=HttpClient.js.map