@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/rest-apis/calling/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // Held to the same lint bar as hand-written source (no rule suppressions, no
5
+ // loose types). If the generator cannot emit a clean faithful type, fix the
6
+ // generator rather than weaken the output.
7
+ export {};
8
+ //# sourceMappingURL=calling.types.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"calling.types.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/calling.types.generated.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,0DAA0D;AAC1D,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,2CAA2C"}
@@ -1,22 +1,8 @@
1
1
  /**
2
2
  * Chat API namespace — token creation.
3
- */
4
- import type { HttpClient } from '../HttpClient.js';
5
- import { BaseResource } from '../base/BaseResource.js';
6
- /**
7
- * Chat token generation.
8
3
  *
9
- * Access via `client.chat.*`. Issues short-lived tokens that end-user clients
10
- * use to join chat channels.
4
+ * The `Chat` resource class is generated from the chat OpenAPI spec
5
+ * (`chat.resources.generated.ts`); this module re-exports it (plus the
6
+ * `ChatResource` back-compat alias) so existing imports keep working.
11
7
  */
12
- export declare class ChatResource extends BaseResource {
13
- constructor(http: HttpClient);
14
- /**
15
- * Generate a short-lived Chat token.
16
- *
17
- * @param body - Token payload (e.g. `{ room_name, user_name, permissions }`).
18
- * @returns The token record, typically `{ token: "eyJ..." }`.
19
- * @throws {RestError} On any non-2xx HTTP response.
20
- */
21
- createToken(body: any): Promise<any>;
22
- }
8
+ export { Chat, Chat as ChatResource } from './chat.resources.generated.js';
@@ -1,26 +1,9 @@
1
1
  /**
2
2
  * Chat API namespace — token creation.
3
- */
4
- import { BaseResource } from '../base/BaseResource.js';
5
- /**
6
- * Chat token generation.
7
3
  *
8
- * Access via `client.chat.*`. Issues short-lived tokens that end-user clients
9
- * use to join chat channels.
4
+ * The `Chat` resource class is generated from the chat OpenAPI spec
5
+ * (`chat.resources.generated.ts`); this module re-exports it (plus the
6
+ * `ChatResource` back-compat alias) so existing imports keep working.
10
7
  */
11
- export class ChatResource extends BaseResource {
12
- constructor(http) {
13
- super(http, '/api/chat/tokens');
14
- }
15
- /**
16
- * Generate a short-lived Chat token.
17
- *
18
- * @param body - Token payload (e.g. `{ room_name, user_name, permissions }`).
19
- * @returns The token record, typically `{ token: "eyJ..." }`.
20
- * @throws {RestError} On any non-2xx HTTP response.
21
- */
22
- async createToken(body) {
23
- return this._http.post(this._basePath, body);
24
- }
25
- }
8
+ export { Chat, Chat as ChatResource } from './chat.resources.generated.js';
26
9
  //# sourceMappingURL=chat.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"chat.js","sourceRoot":"","sources":["../../../src/rest/namespaces/chat.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,IAAS;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;CACF"}
1
+ {"version":3,"file":"chat.js","sourceRoot":"","sources":["../../../src/rest/namespaces/chat.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAC"}
@@ -0,0 +1,12 @@
1
+ import type { HttpClient } from '../HttpClient.js';
2
+ import type { RequestOptionsInit } from '../RequestOptions.js';
3
+ import { BaseResource } from '../base/BaseResource.js';
4
+ import type { ChatChannel, ChatState, ChatToken } from './chat.types.generated.js';
5
+ export declare class Chat extends BaseResource {
6
+ constructor(http: HttpClient);
7
+ createToken(ttl: number, channels: ChatChannel, options?: {
8
+ member_id?: string;
9
+ state?: ChatState;
10
+ extras?: Record<string, unknown>;
11
+ }, requestOptions?: RequestOptionsInit): Promise<ChatToken>;
12
+ }
@@ -0,0 +1,29 @@
1
+ // AUTO-GENERATED from porting-sdk/rest-apis/chat/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // One typed resource class per x-sdk-resource: CRUD bases bound to the
5
+ // resource's spec types (closed body + extras door) plus declared operation
6
+ // methods, command-dispatch, and set_methods — mirrors the Python reference's
7
+ // <ns>_resources_generated module.
8
+ import { BaseResource } from '../base/BaseResource.js';
9
+ export class Chat extends BaseResource {
10
+ constructor(http) {
11
+ super(http, '/api/chat/tokens');
12
+ }
13
+ async createToken(ttl, channels, options, requestOptions) {
14
+ const body = {};
15
+ const _fields = {
16
+ ttl,
17
+ channels,
18
+ member_id: options?.member_id,
19
+ state: options?.state,
20
+ };
21
+ for (const [k, v] of Object.entries(_fields))
22
+ if (v !== undefined)
23
+ body[k] = v;
24
+ if (options?.extras)
25
+ Object.assign(body, options.extras);
26
+ return this._http.post(this._basePath, body, undefined, requestOptions);
27
+ }
28
+ }
29
+ //# sourceMappingURL=chat.resources.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chat.resources.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/chat.resources.generated.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,0DAA0D;AAC1D,EAAE;AACF,uEAAuE;AACvE,4EAA4E;AAC5E,8EAA8E;AAC9E,mCAAmC;AAInC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGvD,MAAM,OAAO,IAAK,SAAQ,YAAY;IACpC,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,WAAW,CACf,GAAW,EACX,QAAqB,EACrB,OAAqF,EACrF,cAAmC;QAEnC,MAAM,IAAI,GAA4B,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG;YACd,GAAG;YACH,QAAQ;YACR,SAAS,EAAE,OAAO,EAAE,SAAS;YAC7B,KAAK,EAAE,OAAO,EAAE,KAAK;SACtB,CAAC;QACF,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,KAAK,SAAS;gBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC/E,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAY,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IACrF,CAAC;CACF"}
@@ -0,0 +1,56 @@
1
+ /** User-defined channel names. Each channel is an object with `read` and/or `write` properties. */
2
+ export type ChatChannel = Record<string, ChatPermissionWithRead | ChatPermissionWithWrite>;
3
+ export interface ChatPermissionWithRead {
4
+ /** Gives the token read access to the channel. */
5
+ read: boolean;
6
+ /** Gives the token write access to the channel. */
7
+ write?: boolean;
8
+ }
9
+ export interface ChatPermissionWithWrite {
10
+ /** Gives the token read access to the channel. */
11
+ read?: boolean;
12
+ /** Gives the token write access to the channel. */
13
+ write: boolean;
14
+ }
15
+ /** An arbitrary JSON object available to store stateful application information in. Must be valid JSON and have a maximum size of 2,000 characters. */
16
+ export type ChatState = Record<string, Record<string, unknown>>;
17
+ export interface ChatToken {
18
+ /** The generated Chat Token. */
19
+ token: string;
20
+ }
21
+ /** The request contains invalid parameters. See errors for details. */
22
+ export interface ChatToken422Error {
23
+ /** List of validation errors. */
24
+ errors: Types_StatusCodes_RestApiErrorItem[];
25
+ }
26
+ export interface NewChatToken {
27
+ /** The maximum time, in minutes, that the access token will be valid for. Between 1 and 43,200 (30 days). */
28
+ ttl: number;
29
+ /** User-defined channel names with read/write permissions. Max of 500 channels. Channel names cannot start with the reserved prefix `sw_` and can be up to 250 characters. */
30
+ channels: ChatChannel;
31
+ /** The unique identifier of the member. Up to 250 characters. If not specified, a random UUID will be generated. */
32
+ member_id?: string;
33
+ /** An arbitrary JSON object available to store stateful application information in. Must be valid JSON and have a maximum size of 2,000 characters. */
34
+ state?: ChatState;
35
+ }
36
+ /** Details about a specific error. */
37
+ export interface Types_StatusCodes_RestApiErrorItem {
38
+ /** The category of error. */
39
+ type: string;
40
+ /** A specific error code. */
41
+ code: string;
42
+ /** A description of what caused the error. */
43
+ message: string;
44
+ /** The request parameter that caused the error, if applicable. */
45
+ attribute?: string | null;
46
+ /** A link to documentation about this error. */
47
+ url: string;
48
+ }
49
+ /** The request is invalid. */
50
+ export interface Types_StatusCodes_StatusCode400 {
51
+ error: 'Bad Request';
52
+ }
53
+ /** Access is unauthorized. */
54
+ export interface Types_StatusCodes_StatusCode401 {
55
+ error: 'Unauthorized';
56
+ }
@@ -0,0 +1,8 @@
1
+ // AUTO-GENERATED from porting-sdk/rest-apis/chat/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // Held to the same lint bar as hand-written source (no rule suppressions, no
5
+ // loose types). If the generator cannot emit a clean faithful type, fix the
6
+ // generator rather than weaken the output.
7
+ export {};
8
+ //# sourceMappingURL=chat.types.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chat.types.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/chat.types.generated.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,0DAA0D;AAC1D,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,2CAA2C"}
@@ -1,66 +1,10 @@
1
1
  /**
2
2
  * Datasphere API namespace — document management and semantic search.
3
- */
4
- import type { HttpClient } from '../HttpClient.js';
5
- import type { QueryParams } from '../types.js';
6
- import { CrudResource } from '../base/CrudResource.js';
7
- /** Document management with search and chunk operations. */
8
- export declare class DatasphereDocuments extends CrudResource {
9
- constructor(http: HttpClient);
10
- /**
11
- * Run a semantic search across indexed documents.
12
- *
13
- * @param body - Search payload (typically `{ query: "...", document_id?: "...",
14
- * limit?: 5, tags?: [...] }`).
15
- * @returns The ranked search hits.
16
- * @throws {RestError} On any non-2xx HTTP response.
17
- */
18
- search(body: any): Promise<any>;
19
- /**
20
- * List content chunks for a document.
21
- *
22
- * @param documentId - Unique identifier of the document.
23
- * @param params - Optional filter / pagination query parameters.
24
- * @returns A paginated list of chunks.
25
- * @throws {RestError} On any non-2xx HTTP response.
26
- */
27
- listChunks(documentId: string, params?: QueryParams): Promise<any>;
28
- /**
29
- * Fetch a specific chunk of a document by ID.
30
- *
31
- * @param documentId - Unique identifier of the document.
32
- * @param chunkId - Unique identifier of the chunk.
33
- * @returns The chunk record with its content.
34
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
35
- */
36
- getChunk(documentId: string, chunkId: string): Promise<any>;
37
- /**
38
- * Delete a specific chunk from a document.
39
- *
40
- * @param documentId - Unique identifier of the document.
41
- * @param chunkId - Unique identifier of the chunk.
42
- * @returns The platform's delete response.
43
- * @throws {RestError} On any non-2xx HTTP response.
44
- */
45
- deleteChunk(documentId: string, chunkId: string): Promise<any>;
46
- }
47
- /**
48
- * Datasphere API namespace.
49
- *
50
- * Access via `client.datasphere.*`. Datasphere is SignalWire's RAG service —
51
- * index documents and run semantic search from within agent tools.
52
3
  *
53
- * @example
54
- * ```ts
55
- * const hits = await client.datasphere.documents.search({
56
- * query: 'refund policy',
57
- * document_id: 'doc_abc',
58
- * limit: 5,
59
- * });
60
- * ```
4
+ * The `DatasphereDocuments` resource class is generated from the datasphere
5
+ * OpenAPI spec (`datasphere.resources.generated.ts`); the `DatasphereNamespace`
6
+ * container is generated into the client tree (`_client_tree_generated.ts`).
7
+ * This module re-exports both so existing imports keep working.
61
8
  */
62
- export declare class DatasphereNamespace {
63
- /** Document CRUD plus semantic search and chunk management. */
64
- readonly documents: DatasphereDocuments;
65
- constructor(http: HttpClient);
66
- }
9
+ export { DatasphereDocuments } from './datasphere.resources.generated.js';
10
+ export { DatasphereNamespace } from './_client_tree_generated.js';
@@ -1,77 +1,11 @@
1
1
  /**
2
2
  * Datasphere API namespace — document management and semantic search.
3
- */
4
- import { CrudResource } from '../base/CrudResource.js';
5
- /** Document management with search and chunk operations. */
6
- export class DatasphereDocuments extends CrudResource {
7
- constructor(http) {
8
- super(http, '/api/datasphere/documents');
9
- }
10
- /**
11
- * Run a semantic search across indexed documents.
12
- *
13
- * @param body - Search payload (typically `{ query: "...", document_id?: "...",
14
- * limit?: 5, tags?: [...] }`).
15
- * @returns The ranked search hits.
16
- * @throws {RestError} On any non-2xx HTTP response.
17
- */
18
- async search(body) {
19
- return this._http.post(this._path('search'), body);
20
- }
21
- /**
22
- * List content chunks for a document.
23
- *
24
- * @param documentId - Unique identifier of the document.
25
- * @param params - Optional filter / pagination query parameters.
26
- * @returns A paginated list of chunks.
27
- * @throws {RestError} On any non-2xx HTTP response.
28
- */
29
- async listChunks(documentId, params) {
30
- return this._http.get(this._path(documentId, 'chunks'), params);
31
- }
32
- /**
33
- * Fetch a specific chunk of a document by ID.
34
- *
35
- * @param documentId - Unique identifier of the document.
36
- * @param chunkId - Unique identifier of the chunk.
37
- * @returns The chunk record with its content.
38
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
39
- */
40
- async getChunk(documentId, chunkId) {
41
- return this._http.get(this._path(documentId, 'chunks', chunkId));
42
- }
43
- /**
44
- * Delete a specific chunk from a document.
45
- *
46
- * @param documentId - Unique identifier of the document.
47
- * @param chunkId - Unique identifier of the chunk.
48
- * @returns The platform's delete response.
49
- * @throws {RestError} On any non-2xx HTTP response.
50
- */
51
- async deleteChunk(documentId, chunkId) {
52
- return this._http.delete(this._path(documentId, 'chunks', chunkId));
53
- }
54
- }
55
- /**
56
- * Datasphere API namespace.
57
- *
58
- * Access via `client.datasphere.*`. Datasphere is SignalWire's RAG service —
59
- * index documents and run semantic search from within agent tools.
60
3
  *
61
- * @example
62
- * ```ts
63
- * const hits = await client.datasphere.documents.search({
64
- * query: 'refund policy',
65
- * document_id: 'doc_abc',
66
- * limit: 5,
67
- * });
68
- * ```
4
+ * The `DatasphereDocuments` resource class is generated from the datasphere
5
+ * OpenAPI spec (`datasphere.resources.generated.ts`); the `DatasphereNamespace`
6
+ * container is generated into the client tree (`_client_tree_generated.ts`).
7
+ * This module re-exports both so existing imports keep working.
69
8
  */
70
- export class DatasphereNamespace {
71
- /** Document CRUD plus semantic search and chunk management. */
72
- documents;
73
- constructor(http) {
74
- this.documents = new DatasphereDocuments(http);
75
- }
76
- }
9
+ export { DatasphereDocuments } from './datasphere.resources.generated.js';
10
+ export { DatasphereNamespace } from './_client_tree_generated.js';
77
11
  //# sourceMappingURL=datasphere.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"datasphere.js","sourceRoot":"","sources":["../../../src/rest/namespaces/datasphere.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,4DAA4D;AAC5D,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IACnD,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,IAAS;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,CAAC,UAAkB,EAAE,MAAoB;QACvD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CAAC,UAAkB,EAAE,OAAe;QAChD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CAAC,UAAkB,EAAE,OAAe;QACnD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACtE,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,mBAAmB;IAC9B,+DAA+D;IACtD,SAAS,CAAsB;IAExC,YAAY,IAAgB;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;CACF"}
1
+ {"version":3,"file":"datasphere.js","sourceRoot":"","sources":["../../../src/rest/namespaces/datasphere.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC"}
@@ -0,0 +1,25 @@
1
+ import type { HttpClient } from '../HttpClient.js';
2
+ import type { RequestOptionsInit } from '../RequestOptions.js';
3
+ import type { QueryParams } from '../types.js';
4
+ import { CrudResource } from '../base/CrudResource.js';
5
+ import type { ChunkListResponse, ChunkResponse, Document, DocumentCreateRequest, DocumentListResponse, DocumentUpdateRequest, SearchResponse, docid } from './datasphere.types.generated.js';
6
+ export declare class DatasphereDocuments extends CrudResource<DocumentListResponse, Document, DocumentCreateRequest, DocumentUpdateRequest> {
7
+ constructor(http: HttpClient);
8
+ /** Create — typed request body plus an `extras` escape hatch for fields not yet typed. */
9
+ create(body: DocumentCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<Document>;
10
+ /** Update — typed request body plus an `extras` escape hatch. */
11
+ update(id: string, body: DocumentUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<Document>;
12
+ search(query_string: string, options?: {
13
+ tags?: string[];
14
+ document_id?: docid;
15
+ distance?: number;
16
+ count?: number;
17
+ language?: string;
18
+ pos_to_expand?: string[];
19
+ max_synonyms?: number;
20
+ extras?: Record<string, unknown>;
21
+ }, requestOptions?: RequestOptionsInit): Promise<SearchResponse>;
22
+ listChunks(document_id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ChunkListResponse>;
23
+ getChunk(document_id: string, chunk_id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ChunkResponse>;
24
+ deleteChunk(document_id: string, chunk_id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>;
25
+ }
@@ -0,0 +1,50 @@
1
+ // AUTO-GENERATED from porting-sdk/rest-apis/datasphere/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // One typed resource class per x-sdk-resource: CRUD bases bound to the
5
+ // resource's spec types (closed body + extras door) plus declared operation
6
+ // methods, command-dispatch, and set_methods — mirrors the Python reference's
7
+ // <ns>_resources_generated module.
8
+ import { CrudResource } from '../base/CrudResource.js';
9
+ export class DatasphereDocuments extends CrudResource {
10
+ constructor(http) {
11
+ super(http, '/api/datasphere/documents');
12
+ }
13
+ /** Create — typed request body plus an `extras` escape hatch for fields not yet typed. */
14
+ async create(body, extras, requestOptions) {
15
+ return this._http.post(this._basePath, { ...body, ...extras }, undefined, requestOptions);
16
+ }
17
+ /** Update — typed request body plus an `extras` escape hatch. */
18
+ async update(id, body, extras, requestOptions) {
19
+ return this._http.patch(this._path(id), { ...body, ...extras }, requestOptions);
20
+ }
21
+ async search(query_string, options, requestOptions) {
22
+ const body = {};
23
+ const _fields = {
24
+ query_string,
25
+ tags: options?.tags,
26
+ document_id: options?.document_id,
27
+ distance: options?.distance,
28
+ count: options?.count,
29
+ language: options?.language,
30
+ pos_to_expand: options?.pos_to_expand,
31
+ max_synonyms: options?.max_synonyms,
32
+ };
33
+ for (const [k, v] of Object.entries(_fields))
34
+ if (v !== undefined)
35
+ body[k] = v;
36
+ if (options?.extras)
37
+ Object.assign(body, options.extras);
38
+ return this._http.post(this._path('search'), body, undefined, requestOptions);
39
+ }
40
+ async listChunks(document_id, params, requestOptions) {
41
+ return this._http.get(this._path(document_id, 'chunks'), params, requestOptions);
42
+ }
43
+ async getChunk(document_id, chunk_id, params, requestOptions) {
44
+ return this._http.get(this._path(document_id, 'chunks', chunk_id), params, requestOptions);
45
+ }
46
+ async deleteChunk(document_id, chunk_id, requestOptions) {
47
+ return this._http.delete(this._path(document_id, 'chunks', chunk_id), requestOptions);
48
+ }
49
+ }
50
+ //# sourceMappingURL=datasphere.resources.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"datasphere.resources.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/datasphere.resources.generated.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,0DAA0D;AAC1D,EAAE;AACF,uEAAuE;AACvE,4EAA4E;AAC5E,8EAA8E;AAC9E,mCAAmC;AAKnC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAYvD,MAAM,OAAO,mBAAoB,SAAQ,YAKxC;IACC,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC;IAC3C,CAAC;IAED,0FAA0F;IACjF,KAAK,CAAC,MAAM,CACnB,IAA2B,EAC3B,MAAgC,EAChC,cAAmC;QAEnC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CACpB,IAAI,CAAC,SAAS,EACd,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,EAAE,EACtB,SAAS,EACT,cAAc,CACf,CAAC;IACJ,CAAC;IAED,iEAAiE;IACxD,KAAK,CAAC,MAAM,CACnB,EAAU,EACV,IAA2B,EAC3B,MAAgC,EAChC,cAAmC;QAEnC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAW,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,EAAE,EAAE,cAAc,CAAC,CAAC;IAC5F,CAAC;IAED,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,OASC,EACD,cAAmC;QAEnC,MAAM,IAAI,GAA4B,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG;YACd,YAAY;YACZ,IAAI,EAAE,OAAO,EAAE,IAAI;YACnB,WAAW,EAAE,OAAO,EAAE,WAAW;YACjC,QAAQ,EAAE,OAAO,EAAE,QAAQ;YAC3B,KAAK,EAAE,OAAO,EAAE,KAAK;YACrB,QAAQ,EAAE,OAAO,EAAE,QAAQ;YAC3B,aAAa,EAAE,OAAO,EAAE,aAAa;YACrC,YAAY,EAAE,OAAO,EAAE,YAAY;SACpC,CAAC;QACF,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,KAAK,SAAS;gBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC/E,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAiB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IAChG,CAAC;IAED,KAAK,CAAC,UAAU,CACd,WAAmB,EACnB,MAAoB,EACpB,cAAmC;QAEnC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CACnB,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,QAAQ,CAAC,EACjC,MAAM,EACN,cAAc,CACf,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,WAAmB,EACnB,QAAgB,EAChB,MAAoB,EACpB,cAAmC;QAEnC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CACnB,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAC3C,MAAM,EACN,cAAc,CACf,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CACf,WAAmB,EACnB,QAAgB,EAChB,cAAmC;QAEnC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CACtB,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAC3C,cAAc,CACf,CAAC;IACJ,CAAC;CACF"}
@@ -0,0 +1,180 @@
1
+ export interface Chunk {
2
+ /** A search result. */
3
+ text: string;
4
+ /** Unique ID of the Document. */
5
+ document_id: docid;
6
+ }
7
+ export interface ChunkListResponse {
8
+ /** A list of chunks. */
9
+ data: ChunkResponse[];
10
+ /** Pagination links. */
11
+ links: ChunkPaginationResponse;
12
+ }
13
+ export interface ChunkPaginationResponse {
14
+ /** Link of the current page. */
15
+ self: string;
16
+ /** Link to the first page. */
17
+ first: string;
18
+ /** Link to the next page. Only present when there are more results. */
19
+ next?: string;
20
+ /** Link to the previous page. Only present when not on the first page. */
21
+ prev?: string;
22
+ }
23
+ export interface ChunkResponse {
24
+ /** Unique ID of the chunk. */
25
+ id: uuid;
26
+ /** Unique ID of the chunk's datasphere document. */
27
+ datasphere_document_id: uuid;
28
+ /** Unique ID of the project. */
29
+ project_id: uuid;
30
+ /** Status of the chunk. */
31
+ status: ChunkStatus;
32
+ /** The tags of the document associated with the chunk. */
33
+ tags: string[];
34
+ /** Content of the chunk. */
35
+ content: string;
36
+ /** Chunk Creation Date. */
37
+ created_at: string;
38
+ /** Chunk Update Date. */
39
+ updated_at: string;
40
+ }
41
+ /** The current Status of the Chunk. */
42
+ export type ChunkStatus = 'submitted' | 'in_progress' | 'completed' | 'failed';
43
+ /** Strategy to use when chunking the document. */
44
+ export type ChunkingStrategy = 'sentence' | 'paragraph' | 'page' | 'sliding';
45
+ /** The request contains invalid parameters. See errors for details. */
46
+ export interface CreateStatusCode422 {
47
+ /** List of validation errors. */
48
+ errors: Types_StatusCodes_RestApiErrorItem[];
49
+ }
50
+ export interface Document {
51
+ /** Unique ID of the Document. */
52
+ id: docid;
53
+ /** Name of the Document. */
54
+ filename: string;
55
+ /** Status of the Document. */
56
+ status: DocumentStatus;
57
+ /** Document tags. */
58
+ tags: string[];
59
+ /** Strategy used to chunk the document. */
60
+ chunking_strategy: ChunkingStrategy;
61
+ /** Max Sentences per Chunk. Only present when chunking strategy is 'sentence', null otherwise. */
62
+ max_sentences_per_chunk: number | null;
63
+ /** Split on Newlines. Only present when chunking strategy is 'sentence', null otherwise. */
64
+ split_newlines: boolean | null;
65
+ /** Overlap Size. Only present when chunking strategy is 'sliding', null otherwise. */
66
+ overlap_size: number | null;
67
+ /** Chunk Size. Only present when chunking strategy is 'sliding', null otherwise. */
68
+ chunk_size: number | null;
69
+ /** Number of Chunks in the Document. */
70
+ number_of_chunks: number;
71
+ /** URI path to the chunks for this document. */
72
+ chunks_uri: string;
73
+ /** Document Creation Date. */
74
+ created_at: string;
75
+ /** Document Update Date. */
76
+ updated_at: string;
77
+ }
78
+ export type DocumentCreatePageRequest = DocumentCreateRequestBase;
79
+ export type DocumentCreateParagraphRequest = DocumentCreateRequestBase;
80
+ export type DocumentCreateRequest = DocumentCreateSentenceRequest | DocumentCreateSlidingRequest | DocumentCreatePageRequest | DocumentCreateParagraphRequest;
81
+ export interface DocumentCreateRequestBase {
82
+ /** URL of the document. */
83
+ url: string;
84
+ /** Document tags. */
85
+ tags?: string[];
86
+ }
87
+ export type DocumentCreateSentenceRequest = DocumentCreateRequestBase;
88
+ export type DocumentCreateSlidingRequest = DocumentCreateRequestBase;
89
+ export interface DocumentListResponse {
90
+ /** A list of documents. */
91
+ data: Document[];
92
+ /** Pagination links. */
93
+ links: PaginationResponse;
94
+ }
95
+ export interface DocumentSearchRequest {
96
+ /** Document tags. */
97
+ tags?: string[];
98
+ /** Unique ID of a Document. */
99
+ document_id?: docid;
100
+ /** Search term. */
101
+ query_string: string;
102
+ /** Specifies how closely related the query is to the document. Low distance means high relevance and similarity. High distance means low relevance and similarity. */
103
+ distance?: number;
104
+ /** Specifies number of returned Chunks. */
105
+ count?: number;
106
+ /** Language of the Document. */
107
+ language?: string;
108
+ /** Part of Speech considered for expansion or analysis. */
109
+ pos_to_expand?: string[];
110
+ /** Maximum number of synonyms to consider. */
111
+ max_synonyms?: number;
112
+ }
113
+ /** The current Status of the Document. */
114
+ export type DocumentStatus = 'submitted' | 'in_progress' | 'completed' | 'failed';
115
+ export interface DocumentUpdateRequest {
116
+ /** Document tags. */
117
+ tags: string[];
118
+ }
119
+ /** The request contains invalid parameters. See errors for details. */
120
+ export interface ListStatusCode422 {
121
+ /** List of validation errors. */
122
+ errors: Types_StatusCodes_RestApiErrorItem[];
123
+ }
124
+ export interface PaginationResponse {
125
+ /** Link of the current page. */
126
+ self: string;
127
+ /** Link to the first page. */
128
+ first: string;
129
+ /** Link to the next page. Only present when there are more results. */
130
+ next?: string;
131
+ /** Link to the previous page. Only present when not on the first page. */
132
+ prev?: string;
133
+ }
134
+ export interface SearchResponse {
135
+ /** A list of search result chunks. */
136
+ chunks: Chunk[];
137
+ }
138
+ /** The request contains invalid parameters. See errors for details. */
139
+ export interface SearchStatusCode422 {
140
+ /** List of validation errors. */
141
+ errors: Types_StatusCodes_RestApiErrorItem[];
142
+ }
143
+ /** Details about a specific error. */
144
+ export interface Types_StatusCodes_RestApiErrorItem {
145
+ /** The category of error. */
146
+ type: string;
147
+ /** A specific error code. */
148
+ code: string;
149
+ /** A description of what caused the error. */
150
+ message: string;
151
+ /** The request parameter that caused the error, if applicable. */
152
+ attribute?: string | null;
153
+ /** A link to documentation about this error. */
154
+ url: string;
155
+ }
156
+ /** The request is invalid. */
157
+ export interface Types_StatusCodes_StatusCode400 {
158
+ error: 'Bad Request';
159
+ }
160
+ /** Access is unauthorized. */
161
+ export interface Types_StatusCodes_StatusCode401 {
162
+ error: 'Unauthorized';
163
+ }
164
+ /** The server cannot find the requested resource. */
165
+ export interface Types_StatusCodes_StatusCode404 {
166
+ error: 'Not Found';
167
+ }
168
+ /** An internal server error occurred. */
169
+ export interface Types_StatusCodes_StatusCode500 {
170
+ error: 'Internal Server Error';
171
+ }
172
+ /** The request contains invalid parameters. See errors for details. */
173
+ export interface UpdateStatusCode422 {
174
+ /** List of validation errors. */
175
+ errors: Types_StatusCodes_RestApiErrorItem[];
176
+ }
177
+ /** Unique ID of a Document. */
178
+ export type docid = string;
179
+ /** Universal Unique Identifier. */
180
+ export type uuid = string;
@@ -0,0 +1,8 @@
1
+ // AUTO-GENERATED from porting-sdk/rest-apis/datasphere/openapi.yaml — DO NOT EDIT.
2
+ // Regenerate with: npx tsx scripts/generate-rest-types.ts
3
+ //
4
+ // Held to the same lint bar as hand-written source (no rule suppressions, no
5
+ // loose types). If the generator cannot emit a clean faithful type, fix the
6
+ // generator rather than weaken the output.
7
+ export {};
8
+ //# sourceMappingURL=datasphere.types.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"datasphere.types.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/datasphere.types.generated.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,0DAA0D;AAC1D,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,2CAA2C"}