@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,771 @@
1
+ /** Active session information for a room. */
2
+ export interface ActiveSession {
3
+ /** Unique ID of the session. */
4
+ id?: string;
5
+ /** Unique ID of the Room if the Session was created from a Room and was not an auto-created Session. */
6
+ room_id?: string;
7
+ /** The named identifier of room session. */
8
+ name?: string;
9
+ /** Display name of room, no character limitations. Maximum of 200 characters. Defaults to the value of name. */
10
+ display_name?: string;
11
+ /** Room Session does not accept new Members before this time. */
12
+ join_from?: string;
13
+ /** Room Session stops accepting new Members at this time. */
14
+ join_until?: string;
15
+ /** Remove Members from the Room Session at this time. */
16
+ remove_at?: string;
17
+ /** Remove Members after they are in the Room Session for N seconds. */
18
+ remove_after_seconds_elapsed?: number;
19
+ /** The Room Session's initial layout. See documentation for a full list of supported layouts. */
20
+ layout?: string;
21
+ /** The maximum number of members allowed in the room at a time. */
22
+ max_members?: number;
23
+ /** The Room Session's frames per second. */
24
+ fps?: VideoFps;
25
+ /** The Room Session's resolution. */
26
+ quality?: VideoQuality;
27
+ /** Start time of the session. */
28
+ start_time?: string;
29
+ /** End time of the session. */
30
+ end_time?: string;
31
+ /** How long, in seconds, the Room Session lasted. */
32
+ duration?: number;
33
+ /** Status of the session. */
34
+ status?: RoomSessionStatus;
35
+ /** Whether a recording was automatically started when this Room Session began. */
36
+ record_on_start?: boolean;
37
+ /** Whether a video with a preview of the content of the room is to be generated. */
38
+ enable_room_previews?: boolean;
39
+ /** If room previews are enabled and the room session is in progress, this is the URL of the preview video. */
40
+ preview_url?: string;
41
+ /** Enable/disable jitter buffer audio-video sync. */
42
+ audio_video_sync?: boolean;
43
+ }
44
+ /** Charge detail item for logs. */
45
+ export interface ChargeDetail {
46
+ /** Description for this charge. */
47
+ description: string;
48
+ /** Charged amount, in dollars. */
49
+ charge: number;
50
+ }
51
+ /** Video conference response object. */
52
+ export interface Conference {
53
+ /** Unique ID of the video conference. */
54
+ id: string;
55
+ /** A named unique identifier for the conference. Allowed characters: `A-Za-z0-9_-`. */
56
+ name: string;
57
+ /** Display name of the video conference. Maximum of 200 characters. */
58
+ display_name: string | null;
59
+ /** Description of the conference. Maximum of 3000 characters. */
60
+ description: string | null;
61
+ /** Conference does not accept new participants before this time. */
62
+ join_from: string | null;
63
+ /** Conference stops accepting new participants at this time, but keeps running until all participants leave. */
64
+ join_until: string | null;
65
+ /** The conference's resolution. */
66
+ quality: VideoQuality;
67
+ /** The conference's initial layout. */
68
+ layout: VideoLayout;
69
+ /** The size of the video conference. */
70
+ size: ConferenceSize | null;
71
+ /** Whether to start recording when a conference session begins. */
72
+ record_on_start: boolean;
73
+ /** Whether a tone is played when a member enters or exits the conference. */
74
+ tone_on_entry_and_exit: boolean;
75
+ /** Whether participants join with video off by user setting. */
76
+ user_join_video_off: boolean;
77
+ /** Whether participants join with video off by room setting. */
78
+ room_join_video_off: boolean;
79
+ /** Whether group chat is enabled for conference participants. */
80
+ enable_chat: boolean;
81
+ /** Whether a preview video of the conference content is generated. */
82
+ enable_room_previews: boolean | null;
83
+ /** CTA buttons and selected items color (dark theme). */
84
+ dark_primary: string | null;
85
+ /** Main background color (dark theme). */
86
+ dark_background: string | null;
87
+ /** Main foreground color (dark theme). */
88
+ dark_foreground: string | null;
89
+ /** Success indication color (dark theme). */
90
+ dark_success: string | null;
91
+ /** Error indication color (dark theme). */
92
+ dark_negative: string | null;
93
+ /** CTA buttons and selected items color (light theme). */
94
+ light_primary: string | null;
95
+ /** Main background color (light theme). */
96
+ light_background: string | null;
97
+ /** Main foreground color (light theme). */
98
+ light_foreground: string | null;
99
+ /** Success indication color (light theme). */
100
+ light_success: string | null;
101
+ /** Error indication color (light theme). */
102
+ light_negative: string | null;
103
+ /** User-defined metadata for the conference. */
104
+ meta: Record<string, Record<string, unknown>> | null;
105
+ /** Timestamp when the conference was created. */
106
+ created_at: string;
107
+ /** Timestamp when the conference was last updated. */
108
+ updated_at: string;
109
+ /** Active session information. Only present when requested via the `include_active_session` query parameter. */
110
+ active_session?: ActiveSession;
111
+ }
112
+ /** Conference size options. */
113
+ export type ConferenceSize = 'small' | 'medium' | 'large';
114
+ /** A conference token object. */
115
+ export interface ConferenceToken {
116
+ /** Unique identifier for the conference token. */
117
+ id: string;
118
+ /** Name of the conference token. */
119
+ name: string | null;
120
+ /** Conference token's randomly generated sequence. */
121
+ token: string;
122
+ /** List of permissions. */
123
+ scopes: string[];
124
+ }
125
+ /** Request body for creating a conference. */
126
+ export interface CreateConferenceRequest {
127
+ /** A named unique identifier for the conference. Allowed characters: `A-Za-z0-9_-`. Maximum of 100 characters. */
128
+ name?: string;
129
+ /** Display name of the video conference. Maximum of 200 characters. */
130
+ display_name: string;
131
+ /** Description of the conference. Maximum of 3000 characters. */
132
+ description?: string;
133
+ /** Conference does not accept new participants before this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
134
+ join_from?: string;
135
+ /** Conference stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
136
+ join_until?: string;
137
+ /** The conference's resolution. */
138
+ quality?: VideoQuality;
139
+ /** The conference's initial layout. */
140
+ layout?: VideoLayout;
141
+ /** The size of the video conference. */
142
+ size?: ConferenceSize;
143
+ /** Whether to start recording when a conference session begins. */
144
+ record_on_start?: boolean;
145
+ /** Whether a preview video of the conference content is generated. */
146
+ enable_room_previews?: boolean;
147
+ /** Whether group chat is enabled for conference participants. */
148
+ enable_chat?: boolean;
149
+ /** CTA buttons and selected items color (dark theme). */
150
+ dark_primary?: string;
151
+ /** Main background color (dark theme). */
152
+ dark_background?: string;
153
+ /** Main foreground color (dark theme). */
154
+ dark_foreground?: string;
155
+ /** Success indication color (dark theme). */
156
+ dark_success?: string;
157
+ /** Error indication color (dark theme). */
158
+ dark_negative?: string;
159
+ /** CTA buttons and selected items color (light theme). */
160
+ light_primary?: string;
161
+ /** Main background color (light theme). */
162
+ light_background?: string;
163
+ /** Main foreground color (light theme). */
164
+ light_foreground?: string;
165
+ /** Success indication color (light theme). */
166
+ light_success?: string;
167
+ /** Error indication color (light theme). */
168
+ light_negative?: string;
169
+ }
170
+ /** Request body for creating a room. */
171
+ export interface CreateRoomRequest {
172
+ /** A named unique identifier for the room. Allowed characters: `A-Za-z0-9_-`. Maximum of 100 characters. */
173
+ name: string;
174
+ /** Display name of the room. Maximum of 200 characters. Defaults to the value of name. */
175
+ display_name?: string;
176
+ /** Description of the room. Maximum of 3000 characters. */
177
+ description?: string;
178
+ /** The maximum number of members in the room at a time. Must be at least 1 to a maximum of 300. */
179
+ max_members?: number;
180
+ /** The room's resolution. */
181
+ quality?: VideoQuality;
182
+ /** Room does not accept new participants before this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
183
+ join_from?: string;
184
+ /** Room stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
185
+ join_until?: string;
186
+ /** Remove users from the room at this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
187
+ remove_at?: string;
188
+ /** Remove users after they are in the room for N seconds. */
189
+ remove_after_seconds_elapsed?: number;
190
+ /** The room's initial layout. */
191
+ layout?: RoomLayout;
192
+ /** Specifies whether to start recording a Room Session when one is started for this Room. */
193
+ record_on_start?: boolean;
194
+ /** Whether a video with a preview of the content of the room is to be generated. */
195
+ enable_room_previews?: boolean;
196
+ /** User-defined metadata for the room. Must be a valid JSON object. Maximum of 2000 characters when serialized. */
197
+ meta?: Record<string, Record<string, unknown>>;
198
+ /** Enable/disable jitter buffer audio-video sync. */
199
+ sync_audio_video?: boolean;
200
+ }
201
+ /** Request body for creating a room token. */
202
+ export interface CreateRoomTokenRequest {
203
+ /** Room's unique named identifier. Allowed characters: A-Za-z0-9_-. Up to 100 characters. The room does not have to exist when the token is created, but must exist prior to joining, or ensure auto_create_room is set to true. */
204
+ room_name: string;
205
+ /** A display name to use for the user. Up to 100 characters. (If not supplied, a random alphanumeric string will be returned for each authorization with this token.) */
206
+ user_name?: string;
207
+ /** A list of permissions, which define what user can do once they join the room. If `join_as` is `audience`, permissions are set to an empty array regardless of the value provided. */
208
+ permissions?: RoomTokenPermission[];
209
+ /** The user can't join the room before this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z` */
210
+ join_from?: string;
211
+ /** The user can't join the room after this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z` */
212
+ join_until?: string;
213
+ /** Remove user from the room at this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z` */
214
+ remove_at?: string;
215
+ /** Remove user after they are in the room for N seconds. */
216
+ remove_after_seconds_elapsed?: number;
217
+ /** Whether the user joins the room with their audio muted. */
218
+ join_audio_muted?: boolean;
219
+ /** Whether the user joins the room with their video muted. */
220
+ join_video_muted?: boolean;
221
+ /** By default, if the user tries to use this token to join a room that doesn't exist, it will be created with default configuration. Set this to false to require the room to exist beforehand. */
222
+ auto_create_room?: boolean;
223
+ /** Whether to generate a video with a preview of the content of the room. This parameter has effect only if this token auto-creates the room, thus it will be ignored if the room already exists. */
224
+ enable_room_previews?: boolean;
225
+ /** Display name used if a room is auto-created when the token joins. Maximum of 200 characters. Defaults to the value of room_name. */
226
+ room_display_name?: string;
227
+ /** Whether to end the room session when the member using this token leaves the room. */
228
+ end_room_session_on_leave?: boolean;
229
+ /** Whether the user should join as a member or as a non-interactive audience participant. Audience participants cannot send audio or video. */
230
+ join_as?: JoinAsType;
231
+ /** Indicates what media the user is allowed to receive. */
232
+ media_allowed?: MediaAllowedType;
233
+ /** Set the room meta. Maximum of 2000 characters when serialized to JSON. */
234
+ room_meta?: Record<string, Record<string, unknown>>;
235
+ /** Set the member meta. Maximum of 2000 characters when serialized to JSON. */
236
+ meta?: Record<string, Record<string, unknown>>;
237
+ /** Enable/disable jitter buffer audio-video sync. */
238
+ sync_audio_video?: boolean;
239
+ }
240
+ /** Request body for creating a stream. */
241
+ export interface CreateStreamRequest {
242
+ /** RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams. */
243
+ url: string;
244
+ }
245
+ /** A discarded/deleted video log entry. Returned when the log has been deleted. Only present when `include_deleted` is `true`. */
246
+ export interface DiscardedLog {
247
+ /** A unique identifier for the log. */
248
+ id: string;
249
+ /** Date and time when the log was discarded. */
250
+ discarded_at: string;
251
+ /** Date and time when the log was originally created. */
252
+ created_at: string;
253
+ }
254
+ /** Join as type for room tokens. */
255
+ export type JoinAsType = 'audience' | 'member';
256
+ /** List conference tokens response. */
257
+ export interface ListConferenceTokensResponse {
258
+ /** Pagination links. */
259
+ links: PaginationLinks;
260
+ /** List of conference tokens. */
261
+ data: ConferenceToken[];
262
+ }
263
+ /** List conferences response. */
264
+ export interface ListConferencesResponse {
265
+ /** Pagination links. */
266
+ links: PaginationLinks;
267
+ /** List of conferences. */
268
+ data: Conference[];
269
+ }
270
+ /** List logs response. */
271
+ export interface ListLogsResponse {
272
+ /** Pagination links. */
273
+ links: PaginationLinks;
274
+ /** List of logs. */
275
+ data: VideoLog[];
276
+ }
277
+ /** List room recording events response. */
278
+ export interface ListRoomRecordingEventsResponse {
279
+ /** Pagination links. */
280
+ links: PaginationLinks;
281
+ /** List of room recording events. */
282
+ data: RoomSessionEvent[];
283
+ }
284
+ /** List room recordings response. */
285
+ export interface ListRoomRecordingsResponse {
286
+ /** Pagination links. */
287
+ links: PaginationLinks;
288
+ /** List of room recordings. */
289
+ data: RoomRecording[];
290
+ }
291
+ /** List room session events response. */
292
+ export interface ListRoomSessionEventsResponse {
293
+ /** Pagination links. */
294
+ links: PaginationLinks;
295
+ /** List of room session events. */
296
+ data: RoomSessionEvent[];
297
+ }
298
+ /** List room session members response. */
299
+ export interface ListRoomSessionMembersResponse {
300
+ /** Pagination links. */
301
+ links: PaginationLinks;
302
+ /** List of room session members. */
303
+ data: RoomSessionMember[];
304
+ }
305
+ /** List room session recordings response. */
306
+ export interface ListRoomSessionRecordingsResponse {
307
+ /** Pagination links. */
308
+ links: PaginationLinks;
309
+ /** List of room recordings. */
310
+ data: RoomRecording[];
311
+ }
312
+ /** List room sessions response. */
313
+ export interface ListRoomSessionsResponse {
314
+ /** Pagination links. */
315
+ links: PaginationLinks;
316
+ /** List of room sessions. */
317
+ data: RoomSession[];
318
+ }
319
+ /** List rooms response. */
320
+ export interface ListRoomsResponse {
321
+ /** Pagination links. */
322
+ links: PaginationLinks;
323
+ /** List of rooms. */
324
+ data: RoomResponse[];
325
+ }
326
+ /** List streams response. */
327
+ export interface ListStreamsResponse {
328
+ /** Pagination links. */
329
+ links: PaginationLinks;
330
+ /** List of streams. */
331
+ data: Stream[];
332
+ }
333
+ /** Log object representing a video activity entry. */
334
+ export interface Log {
335
+ /** A unique identifier for the log. */
336
+ id: string;
337
+ /** Source of this log entry. */
338
+ source: LogSource;
339
+ /** Type of this log entry. */
340
+ type: LogType;
341
+ /** URL for the resource associated with this log entry. */
342
+ url: string;
343
+ /** A named unique identifier for the room. */
344
+ room_name: string | null;
345
+ /** Status of the log entry. */
346
+ status: LogStatus | null;
347
+ /** Whether the room session is locked. */
348
+ locked: boolean;
349
+ /** Start time of the activity. */
350
+ started_at: string | null;
351
+ /** End time of the activity. */
352
+ ended_at: string | null;
353
+ /** Charge amount for this activity, in dollars. */
354
+ charge: number;
355
+ /** Timestamp when the log was created. */
356
+ created_at: string;
357
+ /** Details on charges associated with this log. */
358
+ charge_details: ChargeDetail[];
359
+ }
360
+ /** Source of a video log entry. */
361
+ export type LogSource = 'realtime_api';
362
+ /** Status of a video room session. */
363
+ export type LogStatus = 'in-progress' | 'completed';
364
+ /** Type of video activity recorded in the log. */
365
+ export type LogType = 'video_room_session' | 'video_conference_session';
366
+ /** Media allowed type for room tokens. */
367
+ export type MediaAllowedType = 'all' | 'video-only' | 'audio-only';
368
+ /** Pagination links for list responses. */
369
+ export interface PaginationLinks {
370
+ /** Link to the current page. */
371
+ self: string;
372
+ /** Link to the first page. */
373
+ first: string;
374
+ /** Link to the next page. */
375
+ next?: string;
376
+ /** Link to the previous page. */
377
+ prev?: string;
378
+ }
379
+ /** The room's layout. */
380
+ export type RoomLayout = 'grid-responsive' | 'grid-responsive-mobile' | 'highlight-1-responsive' | '1x1' | '2x1' | '2x2' | '5up' | '3x3' | '4x4' | '5x5' | '6x6' | '8x8' | '10x10';
381
+ /** Room recording response object. */
382
+ export interface RoomRecording {
383
+ /** Unique ID of the Room Recording. */
384
+ id: string;
385
+ /** Unique ID of the Room Session the Room Recording was made in. */
386
+ room_session_id: string;
387
+ /** Status of the recording. */
388
+ status: RoomRecordingStatus | null;
389
+ /** Timestamp of when the Room Recording started. */
390
+ started_at: string | null;
391
+ /** Timestamp of when the Room Recording stopped. */
392
+ finished_at: string | null;
393
+ /** The length of the Room Recording in seconds. */
394
+ duration: number | null;
395
+ /** The number of bytes of the Room Recording file. */
396
+ size_in_bytes: number | null;
397
+ /** The MIME type of the Room Recording file. */
398
+ format: string | null;
399
+ /** The cost of the recording in dollars. */
400
+ cost_in_dollars: number;
401
+ /** A temporary URL for accessing the recording file. By default, valid for 15 minutes. */
402
+ uri: string | null;
403
+ /** Timestamp when the recording was created. */
404
+ created_at: string;
405
+ /** Timestamp when the recording was last updated. */
406
+ updated_at: string;
407
+ }
408
+ /** Status of a room recording. */
409
+ export type RoomRecordingStatus = 'recording' | 'paused' | 'processing' | 'completed';
410
+ /** Room response object. */
411
+ export interface RoomResponse {
412
+ /** A unique identifier for the room. */
413
+ id: string;
414
+ /** A named unique identifier for the room. */
415
+ name: string;
416
+ /** Display name of the room. */
417
+ display_name: string | null;
418
+ /** Description of the room. */
419
+ description: string | null;
420
+ /** The maximum number of members in the room at a time. */
421
+ max_members: number;
422
+ /** The room's resolution. */
423
+ quality: VideoQuality;
424
+ /** Frames per second parameter of room video quality. */
425
+ fps: number;
426
+ /** Room does not accept new participants before this time. */
427
+ join_from: string | null;
428
+ /** Room stops accepting new participants at this time. */
429
+ join_until: string | null;
430
+ /** Remove users from the room at this time. */
431
+ remove_at: string | null;
432
+ /** Remove users after they are in the room for N seconds. */
433
+ remove_after_seconds_elapsed: number | null;
434
+ /** The room's initial layout. */
435
+ layout: RoomLayout;
436
+ /** Specifies whether to start recording a Room Session when one is started for this Room. */
437
+ record_on_start: boolean;
438
+ /** Whether a tone is played when participants enter or exit the room. */
439
+ tone_on_entry_and_exit: boolean;
440
+ /** Whether the room's video is turned off when participants join. */
441
+ room_join_video_off: boolean;
442
+ /** Whether a user's video is turned off when they join the room. */
443
+ user_join_video_off: boolean;
444
+ /** Whether a video with a preview of the content of the room is to be generated. */
445
+ enable_room_previews: boolean | null;
446
+ /** Enable/disable jitter buffer audio-video sync. */
447
+ sync_audio_video: boolean | null;
448
+ /** User-defined metadata for the room. */
449
+ meta: Record<string, Record<string, unknown>> | null;
450
+ /** Whether hand raises are prioritized in the room layout. */
451
+ prioritize_handraise: boolean;
452
+ /** Active session information for the room. */
453
+ active_session?: ActiveSession;
454
+ /** Timestamp when the room was created. */
455
+ created_at: string;
456
+ /** Timestamp when the room was last updated. */
457
+ updated_at: string;
458
+ }
459
+ /** Room session response object. */
460
+ export interface RoomSession {
461
+ /** Unique ID of the session. */
462
+ id: string;
463
+ /** Unique ID of the Room if the Session was created from a Room and was not an auto-created Session. Null if the room was set to delete on end. */
464
+ room_id: string | null;
465
+ /** The named identifier of the room session. */
466
+ name: string | null;
467
+ /** Display name of the room. Maximum of 200 characters. Defaults to the value of name. */
468
+ display_name: string | null;
469
+ /** The maximum number of members allowed in the room at a time. */
470
+ max_members: number | null;
471
+ /** The room session's resolution. */
472
+ quality: VideoQuality | null;
473
+ /** The room session's frames per second. */
474
+ fps: VideoFps | null;
475
+ /** Room Session does not accept new Members before this time. */
476
+ join_from: string | null;
477
+ /** Room Session stops accepting new Members at this time. */
478
+ join_until: string | null;
479
+ /** Remove Members from the Room Session at this time. */
480
+ remove_at: string | null;
481
+ /** Remove Members after they are in the Room Session for N seconds. */
482
+ remove_after_seconds_elapsed: number | null;
483
+ /** The room session's initial layout. */
484
+ layout: string | null;
485
+ /** Whether a recording was automatically started when this Room Session began. */
486
+ record_on_start: boolean;
487
+ /** Whether a tone is played when a member enters or exits the room session. */
488
+ tone_on_entry_and_exit: boolean;
489
+ /** Whether participants join with video off by room setting. */
490
+ room_join_video_off: boolean;
491
+ /** Whether participants join with video off by user setting. */
492
+ user_join_video_off: boolean;
493
+ /** Whether the room session is locked. */
494
+ locked: boolean;
495
+ /** Start time of the session. */
496
+ start_time: string | null;
497
+ /** End time of the session. */
498
+ end_time: string | null;
499
+ /** How long, in seconds, the Room Session lasted. */
500
+ duration: number | null;
501
+ /** Status of the session. */
502
+ status: RoomSessionStatus | null;
503
+ /** Timestamp when the room session was created. */
504
+ created_at: string;
505
+ /** Timestamp when the room session was last updated. */
506
+ updated_at: string;
507
+ /** If room previews are enabled and the room session is in progress, this is the URL of the preview video. */
508
+ preview_url: string | null;
509
+ /** Whether raised hands are prioritized in the layout. */
510
+ prioritize_handraise: boolean | null;
511
+ /** Enable/disable jitter buffer audio-video sync. */
512
+ sync_audio_video: boolean | null;
513
+ /** The cost of the room session in dollars. */
514
+ cost_in_dollars: number;
515
+ /** Whether a video with a preview of the content of the room is to be generated. */
516
+ enable_room_previews: boolean;
517
+ /** URL of the locked room cover image. */
518
+ locked_cover: string;
519
+ }
520
+ /** Room session event response object. */
521
+ export interface RoomSessionEvent {
522
+ /** Unique ID of the event. */
523
+ id: string;
524
+ /** The ID of the project. */
525
+ project_id: string;
526
+ /** The ID of the room. */
527
+ room_id: string;
528
+ /** The ID of the room session. */
529
+ room_session_id: string;
530
+ /** The ID of the associated room recording. Only present for recording-related events. */
531
+ room_recording_id?: string;
532
+ /** The ID of the associated room participant. Only present for participant-related events. */
533
+ room_participant_id?: string;
534
+ /** The severity level of the event. */
535
+ level: string;
536
+ /** The name of the event. */
537
+ name: string;
538
+ /** Event-specific payload data. */
539
+ payload: Record<string, Record<string, unknown>>;
540
+ /** Timestamp when the event was created. */
541
+ created_at: string;
542
+ }
543
+ /** Room session member response object. */
544
+ export interface RoomSessionMember {
545
+ /** Unique ID of the Member. */
546
+ id: string;
547
+ /** Unique ID of the Room Session. */
548
+ room_session_id: string;
549
+ /** Display name of the Member. */
550
+ name: string | null;
551
+ /** Timestamp of when the Member joined the Room Session. */
552
+ join_time: string | null;
553
+ /** Timestamp of when the Member left the Room Session. */
554
+ leave_time: string | null;
555
+ /** How long the Member stayed in the Room Session, in seconds. Null if the member has not yet joined. */
556
+ duration: number | null;
557
+ /** The cost of the member's participation in dollars. */
558
+ cost_in_dollars: number;
559
+ }
560
+ /** Status of a room session. */
561
+ export type RoomSessionStatus = 'in-progress' | 'completed';
562
+ /** Room session summary, returned by the show endpoint. Omits list-only fields. */
563
+ export interface RoomSessionSummary {
564
+ /** Unique ID of the session. */
565
+ id: string;
566
+ /** Unique ID of the Room if the Session was created from a Room and was not an auto-created Session. Null if the room was set to delete on end. */
567
+ room_id: string | null;
568
+ /** The named identifier of the room session. */
569
+ name: string | null;
570
+ /** Display name of the room. Maximum of 200 characters. Defaults to the value of name. */
571
+ display_name: string | null;
572
+ /** The maximum number of members allowed in the room at a time. */
573
+ max_members: number | null;
574
+ /** The room session's resolution. */
575
+ quality: VideoQuality | null;
576
+ /** The room session's frames per second. */
577
+ fps: VideoFps | null;
578
+ /** Room Session does not accept new Members before this time. */
579
+ join_from: string | null;
580
+ /** Room Session stops accepting new Members at this time. */
581
+ join_until: string | null;
582
+ /** Remove Members from the Room Session at this time. */
583
+ remove_at: string | null;
584
+ /** Remove Members after they are in the Room Session for N seconds. */
585
+ remove_after_seconds_elapsed: number | null;
586
+ /** The room session's initial layout. */
587
+ layout: string | null;
588
+ /** Whether a recording was automatically started when this Room Session began. */
589
+ record_on_start: boolean;
590
+ /** Whether a tone is played when a member enters or exits the room session. */
591
+ tone_on_entry_and_exit: boolean;
592
+ /** Whether participants join with video off by room setting. */
593
+ room_join_video_off: boolean;
594
+ /** Whether participants join with video off by user setting. */
595
+ user_join_video_off: boolean;
596
+ /** Whether the room session is locked. */
597
+ locked: boolean;
598
+ /** Start time of the session. */
599
+ start_time: string | null;
600
+ /** End time of the session. */
601
+ end_time: string | null;
602
+ /** How long, in seconds, the Room Session lasted. */
603
+ duration: number | null;
604
+ /** Status of the session. */
605
+ status: RoomSessionStatus | null;
606
+ /** Timestamp when the room session was created. */
607
+ created_at: string;
608
+ /** Timestamp when the room session was last updated. */
609
+ updated_at: string;
610
+ /** If room previews are enabled and the room session is in progress, this is the URL of the preview video. */
611
+ preview_url: string | null;
612
+ /** Whether raised hands are prioritized in the layout. */
613
+ prioritize_handraise: boolean | null;
614
+ /** Enable/disable jitter buffer audio-video sync. */
615
+ sync_audio_video: boolean | null;
616
+ }
617
+ /** Valid permission scopes for room tokens. */
618
+ export type RoomTokenPermission = 'room.member.audio_mute' | 'room.member.audio_unmute' | 'room.member.video_mute' | 'room.member.video_unmute' | 'room.member.deaf' | 'room.member.undeaf' | 'room.member.set_input_volume' | 'room.member.set_output_volume' | 'room.member.set_input_sensitivity' | 'room.member.set_position' | 'room.member.set_meta' | 'room.member.raisehand' | 'room.member.lowerhand' | 'room.member.remove' | 'room.member.promote' | 'room.member.demote' | 'room.hide_video_muted' | 'room.list_available_layouts' | 'room.lock' | 'room.playback' | 'room.playback_seek' | 'room.prioritize_handraise' | 'room.recording' | 'room.set_layout' | 'room.set_position' | 'room.set_meta' | 'room.show_video_muted' | 'room.stream' | 'room.unlock' | 'room.self.audio_mute' | 'room.self.audio_unmute' | 'room.self.video_mute' | 'room.self.video_unmute' | 'room.self.deaf' | 'room.self.undeaf' | 'room.self.set_input_volume' | 'room.self.set_output_volume' | 'room.self.set_input_sensitivity' | 'room.self.set_position' | 'room.self.set_meta' | 'room.self.raisehand' | 'room.self.lowerhand' | 'room.self.screenshare' | 'room.self.additional_source';
619
+ /** Room token response object. */
620
+ export interface RoomTokenResponse {
621
+ /** A Room Token to be used by clients to connect to the Room. */
622
+ token: string;
623
+ }
624
+ /** A video stream object. */
625
+ export interface Stream {
626
+ /** Unique identifier for the stream. */
627
+ id: string;
628
+ /** RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams. */
629
+ url: string | null;
630
+ /** The type of stream. */
631
+ stream_type: string | null;
632
+ /** The stream's width in pixels. */
633
+ width: number | null;
634
+ /** The stream's height in pixels. */
635
+ height: number | null;
636
+ /** The stream's frames per second. */
637
+ fps: number | null;
638
+ /** Timestamp when the stream was created. */
639
+ created_at: string;
640
+ /** Timestamp when the stream was last updated. */
641
+ updated_at: string;
642
+ }
643
+ /** Details about a specific error. */
644
+ export interface Types_StatusCodes_RestApiErrorItem {
645
+ /** The category of error. */
646
+ type: string;
647
+ /** A specific error code. */
648
+ code: string;
649
+ /** A description of what caused the error. */
650
+ message: string;
651
+ /** The request parameter that caused the error, if applicable. */
652
+ attribute?: string | null;
653
+ /** A link to documentation about this error. */
654
+ url: string;
655
+ }
656
+ /** The request is invalid. */
657
+ export interface Types_StatusCodes_StatusCode400 {
658
+ error: 'Bad Request';
659
+ }
660
+ /** Access is unauthorized. */
661
+ export interface Types_StatusCodes_StatusCode401 {
662
+ error: 'Unauthorized';
663
+ }
664
+ /** Access is forbidden. */
665
+ export interface Types_StatusCodes_StatusCode403 {
666
+ error: 'Forbidden';
667
+ }
668
+ /** The server cannot find the requested resource. */
669
+ export interface Types_StatusCodes_StatusCode404 {
670
+ error: 'Not Found';
671
+ }
672
+ /** An internal server error occurred. */
673
+ export interface Types_StatusCodes_StatusCode500 {
674
+ error: 'Internal Server Error';
675
+ }
676
+ /** Request body for updating a conference. */
677
+ export interface UpdateConferenceRequest {
678
+ /** Display name of the video conference. Maximum of 200 characters. */
679
+ display_name: string;
680
+ /** Description of the conference. Maximum of 3000 characters. */
681
+ description?: string;
682
+ /** Conference does not accept new participants before this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
683
+ join_from?: string;
684
+ /** Conference stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
685
+ join_until?: string;
686
+ /** The conference's resolution. */
687
+ quality?: VideoQuality;
688
+ /** The conference's initial layout. */
689
+ layout?: VideoLayout;
690
+ /** The size of the video conference. */
691
+ size?: ConferenceSize;
692
+ /** Whether to start recording when a conference session begins. */
693
+ record_on_start?: boolean;
694
+ /** Whether a tone is played when a member enters or exits the conference. */
695
+ tone_on_entry_and_exit?: boolean;
696
+ /** Whether participants join with video off by room setting. */
697
+ room_join_video_off?: boolean;
698
+ /** Whether participants join with video off by user setting. */
699
+ user_join_video_off?: boolean;
700
+ /** Whether a preview video of the conference content is generated. */
701
+ enable_room_previews?: boolean;
702
+ /** Whether group chat is enabled for conference participants. */
703
+ enable_chat?: boolean;
704
+ /** CTA buttons and selected items color (dark theme). */
705
+ dark_primary?: string;
706
+ /** Main background color (dark theme). */
707
+ dark_background?: string;
708
+ /** Main foreground color (dark theme). */
709
+ dark_foreground?: string;
710
+ /** Success indication color (dark theme). */
711
+ dark_success?: string;
712
+ /** Error indication color (dark theme). */
713
+ dark_negative?: string;
714
+ /** CTA buttons and selected items color (light theme). */
715
+ light_primary?: string;
716
+ /** Main background color (light theme). */
717
+ light_background?: string;
718
+ /** Main foreground color (light theme). */
719
+ light_foreground?: string;
720
+ /** Success indication color (light theme). */
721
+ light_success?: string;
722
+ /** Error indication color (light theme). */
723
+ light_negative?: string;
724
+ }
725
+ /** Request body for updating a room. */
726
+ export interface UpdateRoomRequest {
727
+ /** Display name of the room. Maximum of 200 characters. Defaults to the value of name. */
728
+ display_name?: string;
729
+ /** Description of the room. Maximum of 3000 characters. */
730
+ description?: string;
731
+ /** The maximum number of members in the room at a time. Must be at least 1 to a maximum of 300. */
732
+ max_members?: number;
733
+ /** The room's resolution. */
734
+ quality?: VideoQuality;
735
+ /** Room does not accept new participants before this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
736
+ join_from?: string;
737
+ /** Room stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
738
+ join_until?: string;
739
+ /** Remove users from the room at this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`. */
740
+ remove_at?: string;
741
+ /** Remove users after they are in the room for N seconds. */
742
+ remove_after_seconds_elapsed?: number;
743
+ /** The room's initial layout. */
744
+ layout?: RoomLayout;
745
+ /** Specifies whether to start recording a Room Session when one is started for this Room. */
746
+ record_on_start?: boolean;
747
+ /** Whether a video with a preview of the content of the room is to be generated. */
748
+ enable_room_previews?: boolean;
749
+ /** User-defined metadata for the room. Must be a valid JSON object. Maximum of 2000 characters when serialized. */
750
+ meta?: Record<string, Record<string, unknown>>;
751
+ /** Enable/disable jitter buffer audio-video sync. */
752
+ sync_audio_video?: boolean;
753
+ }
754
+ /** Request body for updating a stream. */
755
+ export interface UpdateStreamRequest {
756
+ /** RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams. */
757
+ url: string;
758
+ }
759
+ /** Video frames per second. */
760
+ export type VideoFps = 20 | 30;
761
+ /** Video room layout options. */
762
+ export type VideoLayout = 'grid-responsive' | 'grid-responsive-mobile' | 'highlight-1-responsive' | '1x1' | '2x1' | '2x2' | '5up' | '3x3' | '4x4' | '5x5' | '6x6' | '8x8' | '10x10';
763
+ /** A video log entry. Discarded logs return only `id`, `discarded_at`, and `created_at`. */
764
+ export type VideoLog = Log | DiscardedLog;
765
+ /** Video quality resolution. */
766
+ export type VideoQuality = '720p' | '1080p';
767
+ /** The request contains invalid parameters. See errors for details. */
768
+ export interface VideoStatusCode422 {
769
+ /** List of validation errors. */
770
+ errors: Types_StatusCodes_RestApiErrorItem[];
771
+ }