@signalwire/sdk 2.0.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 (325) hide show
  1. package/.github/workflows/publish.yml +27 -0
  2. package/.github/workflows/test.yml +17 -0
  3. package/CLAUDE.md +112 -0
  4. package/README.md +254 -0
  5. package/docs/MIGRATION-2.0.md +81 -0
  6. package/docs/agent-guide.md +869 -0
  7. package/docs/agent_guide.md +1026 -0
  8. package/docs/api-reference.md +2420 -0
  9. package/docs/api_reference.md +1301 -0
  10. package/docs/architecture.md +843 -0
  11. package/docs/cli-guide.md +579 -0
  12. package/docs/cli_guide.md +448 -0
  13. package/docs/cloud_functions_guide.md +474 -0
  14. package/docs/configuration.md +422 -0
  15. package/docs/contexts-guide.md +787 -0
  16. package/docs/contexts_guide.md +511 -0
  17. package/docs/datamap-guide.md +1141 -0
  18. package/docs/datamap_guide.md +595 -0
  19. package/docs/llm_parameters.md +239 -0
  20. package/docs/mcp_gateway_reference.md +648 -0
  21. package/docs/mcp_integration.md +108 -0
  22. package/docs/prefabs-guide.md +800 -0
  23. package/docs/sdk_features.md +477 -0
  24. package/docs/security.md +436 -0
  25. package/docs/serverless-guide.md +513 -0
  26. package/docs/skills-guide.md +857 -0
  27. package/docs/skills-system.md +301 -0
  28. package/docs/skills_parameter_schema.md +392 -0
  29. package/docs/skills_system.md +467 -0
  30. package/docs/swaig-reference.md +1627 -0
  31. package/docs/swaig_reference.md +910 -0
  32. package/docs/swml_service_guide.md +600 -0
  33. package/docs/third_party_skills.md +533 -0
  34. package/docs/web_service.md +677 -0
  35. package/examples/README.md +131 -0
  36. package/examples/advanced-datamap.ts +100 -0
  37. package/examples/advanced-dynamic-config.ts +70 -0
  38. package/examples/auto-vivified.ts +94 -0
  39. package/examples/call-flow.ts +63 -0
  40. package/examples/comprehensive-dynamic.ts +125 -0
  41. package/examples/contexts-steps.ts +65 -0
  42. package/examples/custom-path.ts +45 -0
  43. package/examples/datamap-tools.ts +55 -0
  44. package/examples/datasphere-multi-instance.ts +63 -0
  45. package/examples/datasphere-serverless-env.ts +68 -0
  46. package/examples/datasphere-webhook-env.ts +66 -0
  47. package/examples/datasphere.ts +37 -0
  48. package/examples/declarative.ts +100 -0
  49. package/examples/dynamic-config.ts +54 -0
  50. package/examples/dynamic-info-gatherer.ts +69 -0
  51. package/examples/dynamic-swml-service.ts +67 -0
  52. package/examples/gather-info.ts +71 -0
  53. package/examples/gather-per-question-functions-demo.ts +140 -0
  54. package/examples/joke-agent.ts +34 -0
  55. package/examples/kubernetes-agent.ts +45 -0
  56. package/examples/llm-params.ts +69 -0
  57. package/examples/mcp-agent.ts +84 -0
  58. package/examples/mcp-gateway.ts +35 -0
  59. package/examples/multi-agent.ts +73 -0
  60. package/examples/multi-endpoint.ts +79 -0
  61. package/examples/pom-prompt.ts +71 -0
  62. package/examples/prefab-concierge.ts +47 -0
  63. package/examples/prefab-faq.ts +54 -0
  64. package/examples/prefab-info-gatherer.ts +33 -0
  65. package/examples/prefab-receptionist.ts +36 -0
  66. package/examples/prefab-survey.ts +68 -0
  67. package/examples/record-call.ts +67 -0
  68. package/examples/relay-demo.ts +33 -0
  69. package/examples/room-and-sip.ts +94 -0
  70. package/examples/serverless-lambda.ts +35 -0
  71. package/examples/session-state.ts +83 -0
  72. package/examples/simple-agent.ts +36 -0
  73. package/examples/simple-static.ts +29 -0
  74. package/examples/skills-demo.ts +38 -0
  75. package/examples/step-function-inheritance-demo.ts +124 -0
  76. package/examples/swaig-features.ts +187 -0
  77. package/examples/swml-service-routing.ts +66 -0
  78. package/examples/swml-service.ts +38 -0
  79. package/examples/tap.ts +68 -0
  80. package/examples/verb-methods.ts +45 -0
  81. package/examples/web-search-multi-instance.ts +72 -0
  82. package/examples/web-search.ts +38 -0
  83. package/examples/wikipedia.ts +36 -0
  84. package/livewire/README.md +140 -0
  85. package/livewire/docs/migration-guide.md +228 -0
  86. package/livewire/examples/livewire-basic-agent.ts +74 -0
  87. package/livewire/examples/livewire-handoff.ts +197 -0
  88. package/livewire/examples/livewire-multi-tool.ts +117 -0
  89. package/package.json +38 -0
  90. package/relay/README.md +70 -0
  91. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
  92. package/relay/docs/call-methods.md +474 -0
  93. package/relay/docs/client-reference.md +142 -0
  94. package/relay/docs/events.md +134 -0
  95. package/relay/docs/getting-started.md +134 -0
  96. package/relay/docs/guide.md +306 -0
  97. package/relay/docs/messaging.md +182 -0
  98. package/relay/examples/relay-inbound.ts +66 -0
  99. package/relay/examples/relay-messaging.ts +71 -0
  100. package/relay/examples/relay-outbound.ts +76 -0
  101. package/rest/README.md +95 -0
  102. package/rest/docs/calling.md +273 -0
  103. package/rest/docs/client-reference.md +107 -0
  104. package/rest/docs/compat.md +204 -0
  105. package/rest/docs/fabric.md +183 -0
  106. package/rest/docs/getting-started.md +110 -0
  107. package/rest/docs/guide.md +351 -0
  108. package/rest/docs/namespaces.md +285 -0
  109. package/rest/examples/rest-10dlc-registration.ts +161 -0
  110. package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
  111. package/rest/examples/rest-calling-play-and-record.ts +91 -0
  112. package/rest/examples/rest-client.ts +65 -0
  113. package/rest/examples/rest-compat-laml.ts +210 -0
  114. package/rest/examples/rest-datasphere-search.ts +82 -0
  115. package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
  116. package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
  117. package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
  118. package/rest/examples/rest-manage-resources.ts +65 -0
  119. package/rest/examples/rest-phone-number-management.ts +197 -0
  120. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  121. package/rest/examples/rest-video-rooms.ts +186 -0
  122. package/src/AgentBase.ts +2489 -0
  123. package/src/AgentServer.ts +415 -0
  124. package/src/AuthHandler.ts +256 -0
  125. package/src/ConfigLoader.ts +447 -0
  126. package/src/ContextBuilder.ts +1150 -0
  127. package/src/DataMap.ts +449 -0
  128. package/src/FunctionResult.ts +866 -0
  129. package/src/Logger.ts +337 -0
  130. package/src/PomBuilder.ts +439 -0
  131. package/src/PromptManager.ts +133 -0
  132. package/src/SWMLHandler.ts +298 -0
  133. package/src/SWMLService.ts +717 -0
  134. package/src/SchemaUtils.ts +361 -0
  135. package/src/SecurityUtils.ts +153 -0
  136. package/src/ServerlessAdapter.ts +221 -0
  137. package/src/SessionManager.ts +311 -0
  138. package/src/SslConfig.ts +118 -0
  139. package/src/SwaigFunction.ts +276 -0
  140. package/src/SwmlBuilder.ts +258 -0
  141. package/src/SwmlVerbMethods.generated.ts +234 -0
  142. package/src/TypeInference.ts +181 -0
  143. package/src/WebService.ts +619 -0
  144. package/src/cli/agent-loader.ts +166 -0
  145. package/src/cli/mock-data.ts +111 -0
  146. package/src/cli/swaig-test.ts +452 -0
  147. package/src/generateVerbTypes.ts +322 -0
  148. package/src/index.ts +167 -0
  149. package/src/livewire/index.ts +950 -0
  150. package/src/prefabs/ConciergeAgent.ts +287 -0
  151. package/src/prefabs/FAQBotAgent.ts +384 -0
  152. package/src/prefabs/InfoGathererAgent.ts +339 -0
  153. package/src/prefabs/ReceptionistAgent.ts +366 -0
  154. package/src/prefabs/SurveyAgent.ts +646 -0
  155. package/src/prefabs/index.ts +27 -0
  156. package/src/relay/Action.ts +314 -0
  157. package/src/relay/Call.ts +854 -0
  158. package/src/relay/Deferred.ts +71 -0
  159. package/src/relay/Message.ts +148 -0
  160. package/src/relay/RelayClient.ts +1036 -0
  161. package/src/relay/RelayError.ts +14 -0
  162. package/src/relay/RelayEvent.ts +892 -0
  163. package/src/relay/constants.ts +132 -0
  164. package/src/relay/index.ts +123 -0
  165. package/src/relay/types.ts +149 -0
  166. package/src/rest/HttpClient.ts +103 -0
  167. package/src/rest/RestError.ts +31 -0
  168. package/src/rest/base/BaseResource.ts +19 -0
  169. package/src/rest/base/CrudResource.ts +51 -0
  170. package/src/rest/base/CrudWithAddresses.ts +26 -0
  171. package/src/rest/index.ts +200 -0
  172. package/src/rest/namespaces/addresses.ts +32 -0
  173. package/src/rest/namespaces/calling.ts +187 -0
  174. package/src/rest/namespaces/chat.ts +20 -0
  175. package/src/rest/namespaces/compat.ts +352 -0
  176. package/src/rest/namespaces/datasphere.ts +45 -0
  177. package/src/rest/namespaces/fabric.ts +222 -0
  178. package/src/rest/namespaces/imported-numbers.ts +20 -0
  179. package/src/rest/namespaces/logs.ts +84 -0
  180. package/src/rest/namespaces/lookup.ts +21 -0
  181. package/src/rest/namespaces/mfa.ts +30 -0
  182. package/src/rest/namespaces/number-groups.ts +38 -0
  183. package/src/rest/namespaces/phone-numbers.ts +44 -0
  184. package/src/rest/namespaces/project.ts +36 -0
  185. package/src/rest/namespaces/pubsub.ts +20 -0
  186. package/src/rest/namespaces/queues.ts +33 -0
  187. package/src/rest/namespaces/recordings.ts +28 -0
  188. package/src/rest/namespaces/registry.ts +101 -0
  189. package/src/rest/namespaces/short-codes.ts +28 -0
  190. package/src/rest/namespaces/sip-profile.ts +25 -0
  191. package/src/rest/namespaces/verified-callers.ts +27 -0
  192. package/src/rest/namespaces/video.ts +165 -0
  193. package/src/rest/pagination.ts +84 -0
  194. package/src/rest/types.ts +61 -0
  195. package/src/schema.json +12250 -0
  196. package/src/skills/SkillBase.ts +547 -0
  197. package/src/skills/SkillManager.ts +415 -0
  198. package/src/skills/SkillRegistry.ts +367 -0
  199. package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
  200. package/src/skills/builtin/ask_claude.ts +241 -0
  201. package/src/skills/builtin/claude_skills.ts +978 -0
  202. package/src/skills/builtin/custom_skills.ts +312 -0
  203. package/src/skills/builtin/datasphere.ts +438 -0
  204. package/src/skills/builtin/datasphere_serverless.ts +339 -0
  205. package/src/skills/builtin/datetime.ts +130 -0
  206. package/src/skills/builtin/google_maps.ts +651 -0
  207. package/src/skills/builtin/index.ts +88 -0
  208. package/src/skills/builtin/info_gatherer.ts +405 -0
  209. package/src/skills/builtin/joke.ts +191 -0
  210. package/src/skills/builtin/math.ts +142 -0
  211. package/src/skills/builtin/mcp_gateway.ts +677 -0
  212. package/src/skills/builtin/native_vector_search.ts +901 -0
  213. package/src/skills/builtin/play_background_file.ts +358 -0
  214. package/src/skills/builtin/spider.ts +869 -0
  215. package/src/skills/builtin/swml_transfer.ts +635 -0
  216. package/src/skills/builtin/weather_api.ts +248 -0
  217. package/src/skills/builtin/web_search.ts +1074 -0
  218. package/src/skills/builtin/wikipedia_search.ts +299 -0
  219. package/src/skills/index.ts +12 -0
  220. package/src/types.ts +132 -0
  221. package/tests/AgentBase.test.ts +1093 -0
  222. package/tests/AgentServer.test.ts +126 -0
  223. package/tests/AuthHandler.test.ts +133 -0
  224. package/tests/ConfigLoader.test.ts +151 -0
  225. package/tests/ContextBuilder.test.ts +108 -0
  226. package/tests/DataMap.test.ts +367 -0
  227. package/tests/EphemeralSkillCopy.test.ts +107 -0
  228. package/tests/FunctionResult.test.ts +298 -0
  229. package/tests/GracefulShutdown.test.ts +46 -0
  230. package/tests/Logger.test.ts +420 -0
  231. package/tests/PomBuilder.test.ts +228 -0
  232. package/tests/ProxyDetection.test.ts +228 -0
  233. package/tests/SWMLService.test.ts +320 -0
  234. package/tests/SWMLVerbHandler.test.ts +523 -0
  235. package/tests/SchemaUtils.test.ts +106 -0
  236. package/tests/SchemaUtils.verb.test.ts +206 -0
  237. package/tests/SecurityUtils.test.ts +192 -0
  238. package/tests/ServerlessAdapter.test.ts +222 -0
  239. package/tests/SessionManager.test.ts +257 -0
  240. package/tests/SkillBaseFeatures.test.ts +130 -0
  241. package/tests/SkillMultiInstance.test.ts +102 -0
  242. package/tests/SkillParameterSchemas.test.ts +134 -0
  243. package/tests/SkillRegistrySchema.test.ts +84 -0
  244. package/tests/SslConfig.test.ts +97 -0
  245. package/tests/SwmlBuilder.test.ts +400 -0
  246. package/tests/TypeInference.test.ts +165 -0
  247. package/tests/VerbHandlerRegistry.test.ts +128 -0
  248. package/tests/cli/mock-data.test.ts +113 -0
  249. package/tests/cli/swaig-test.test.ts +108 -0
  250. package/tests/examples.test.ts +194 -0
  251. package/tests/fixtures/scrape-parity/README.md +53 -0
  252. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
  253. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
  254. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
  255. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
  256. package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
  257. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
  258. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
  259. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
  260. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
  261. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
  262. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
  263. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
  264. package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
  265. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
  266. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
  267. package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
  268. package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
  269. package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
  270. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
  271. package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
  272. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
  273. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
  274. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
  275. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
  276. package/tests/fixtures/scrape-parity/python_extract.py +109 -0
  277. package/tests/livewire/livewire.test.ts +780 -0
  278. package/tests/mcp.test.ts +221 -0
  279. package/tests/prefabs/prefabs.test.ts +1093 -0
  280. package/tests/relay/Action.test.ts +392 -0
  281. package/tests/relay/Call.test.ts +535 -0
  282. package/tests/relay/Deferred.test.ts +71 -0
  283. package/tests/relay/Message.test.ts +164 -0
  284. package/tests/relay/RelayClient.test.ts +779 -0
  285. package/tests/relay/RelayEvent.test.ts +463 -0
  286. package/tests/relay/helpers.ts +79 -0
  287. package/tests/rest/HttpClient.test.ts +274 -0
  288. package/tests/rest/RestError.test.ts +53 -0
  289. package/tests/rest/calling.test.ts +156 -0
  290. package/tests/rest/client.test.ts +197 -0
  291. package/tests/rest/compat.test.ts +335 -0
  292. package/tests/rest/datasphere.test.ts +71 -0
  293. package/tests/rest/fabric.test.ts +186 -0
  294. package/tests/rest/helpers.ts +95 -0
  295. package/tests/rest/logs.test.ts +68 -0
  296. package/tests/rest/pagination.test.ts +133 -0
  297. package/tests/rest/registry.test.ts +94 -0
  298. package/tests/rest/relay-rest.test.ts +290 -0
  299. package/tests/rest/video.test.ts +173 -0
  300. package/tests/setup.ts +6 -0
  301. package/tests/skills/SkillBase.test.ts +108 -0
  302. package/tests/skills/SkillManager.test.ts +268 -0
  303. package/tests/skills/SkillRegistry.test.ts +176 -0
  304. package/tests/skills/builtin.test.ts +1472 -0
  305. package/tests/skills/claude-skills.test.ts +54 -0
  306. package/tests/skills/custom-skills.test.ts +53 -0
  307. package/tests/skills/datasphere-serverless.test.ts +70 -0
  308. package/tests/skills/datasphere.test.ts +107 -0
  309. package/tests/skills/datetime.test.ts +101 -0
  310. package/tests/skills/google-maps.test.ts +78 -0
  311. package/tests/skills/info-gatherer.test.ts +411 -0
  312. package/tests/skills/joke.test.ts +81 -0
  313. package/tests/skills/math.test.ts +68 -0
  314. package/tests/skills/mcp-gateway.test.ts +101 -0
  315. package/tests/skills/play-background.test.ts +54 -0
  316. package/tests/skills/spider.test.ts +108 -0
  317. package/tests/skills/swml-transfer.test.ts +178 -0
  318. package/tests/skills/trivia.test.ts +54 -0
  319. package/tests/skills/vector-search.test.ts +135 -0
  320. package/tests/skills/weather-api.test.ts +77 -0
  321. package/tests/skills/web-search-parity.test.ts +59 -0
  322. package/tests/skills/web-search.test.ts +103 -0
  323. package/tests/skills/wikipedia.test.ts +63 -0
  324. package/tsconfig.json +18 -0
  325. package/vitest.config.ts +9 -0
@@ -0,0 +1,352 @@
1
+ /**
2
+ * Compatibility API namespace — Twilio-compatible LAML API with AccountSid scoping.
3
+ *
4
+ * All updates use POST (Twilio-compatible, not REST-idiomatic PATCH/PUT).
5
+ */
6
+
7
+ /* eslint-disable @typescript-eslint/no-explicit-any */
8
+
9
+ import type { HttpClient } from '../HttpClient.js';
10
+ import type { QueryParams } from '../types.js';
11
+ import { BaseResource } from '../base/BaseResource.js';
12
+ import { CrudResource } from '../base/CrudResource.js';
13
+
14
+ /** Compat account/subproject management. */
15
+ export class CompatAccounts extends BaseResource {
16
+ constructor(http: HttpClient) {
17
+ super(http, '/api/laml/2010-04-01/Accounts');
18
+ }
19
+
20
+ async list(params?: QueryParams): Promise<any> {
21
+ return this._http.get(this._basePath, params);
22
+ }
23
+
24
+ async create(body: any): Promise<any> {
25
+ return this._http.post(this._basePath, body);
26
+ }
27
+
28
+ async get(sid: string): Promise<any> {
29
+ return this._http.get(this._path(sid));
30
+ }
31
+
32
+ async update(sid: string, body: any = {}): Promise<any> {
33
+ return this._http.post(this._path(sid), body);
34
+ }
35
+ }
36
+
37
+ /** Compat call management with recording and stream sub-resources. */
38
+ export class CompatCalls extends CrudResource {
39
+ constructor(http: HttpClient, basePath: string) {
40
+ super(http, basePath);
41
+ }
42
+
43
+ override async update(sid: string, body: any = {}): Promise<any> {
44
+ return this._http.post(this._path(sid), body);
45
+ }
46
+
47
+ async startRecording(callSid: string, body: any = {}): Promise<any> {
48
+ return this._http.post(this._path(callSid, 'Recordings'), body);
49
+ }
50
+
51
+ async updateRecording(callSid: string, recordingSid: string, body: any = {}): Promise<any> {
52
+ return this._http.post(this._path(callSid, 'Recordings', recordingSid), body);
53
+ }
54
+
55
+ async startStream(callSid: string, body: any = {}): Promise<any> {
56
+ return this._http.post(this._path(callSid, 'Streams'), body);
57
+ }
58
+
59
+ async stopStream(callSid: string, streamSid: string, body: any = {}): Promise<any> {
60
+ return this._http.post(this._path(callSid, 'Streams', streamSid), body);
61
+ }
62
+ }
63
+
64
+ /** Compat message management with media sub-resources. */
65
+ export class CompatMessages extends CrudResource {
66
+ constructor(http: HttpClient, basePath: string) {
67
+ super(http, basePath);
68
+ }
69
+
70
+ override async update(sid: string, body: any = {}): Promise<any> {
71
+ return this._http.post(this._path(sid), body);
72
+ }
73
+
74
+ async listMedia(messageSid: string, params?: QueryParams): Promise<any> {
75
+ return this._http.get(this._path(messageSid, 'Media'), params);
76
+ }
77
+
78
+ async getMedia(messageSid: string, mediaSid: string): Promise<any> {
79
+ return this._http.get(this._path(messageSid, 'Media', mediaSid));
80
+ }
81
+
82
+ async deleteMedia(messageSid: string, mediaSid: string): Promise<any> {
83
+ return this._http.delete(this._path(messageSid, 'Media', mediaSid));
84
+ }
85
+ }
86
+
87
+ /** Compat fax management with media sub-resources. */
88
+ export class CompatFaxes extends CrudResource {
89
+ constructor(http: HttpClient, basePath: string) {
90
+ super(http, basePath);
91
+ }
92
+
93
+ override async update(sid: string, body: any = {}): Promise<any> {
94
+ return this._http.post(this._path(sid), body);
95
+ }
96
+
97
+ async listMedia(faxSid: string, params?: QueryParams): Promise<any> {
98
+ return this._http.get(this._path(faxSid, 'Media'), params);
99
+ }
100
+
101
+ async getMedia(faxSid: string, mediaSid: string): Promise<any> {
102
+ return this._http.get(this._path(faxSid, 'Media', mediaSid));
103
+ }
104
+
105
+ async deleteMedia(faxSid: string, mediaSid: string): Promise<any> {
106
+ return this._http.delete(this._path(faxSid, 'Media', mediaSid));
107
+ }
108
+ }
109
+
110
+ /** Compat conference management with participants, recordings, and streams. */
111
+ export class CompatConferences extends BaseResource {
112
+ constructor(http: HttpClient, basePath: string) {
113
+ super(http, basePath);
114
+ }
115
+
116
+ async list(params?: QueryParams): Promise<any> {
117
+ return this._http.get(this._basePath, params);
118
+ }
119
+
120
+ async get(sid: string): Promise<any> {
121
+ return this._http.get(this._path(sid));
122
+ }
123
+
124
+ async update(sid: string, body: any = {}): Promise<any> {
125
+ return this._http.post(this._path(sid), body);
126
+ }
127
+
128
+ // Participants
129
+ async listParticipants(conferenceSid: string, params?: QueryParams): Promise<any> {
130
+ return this._http.get(this._path(conferenceSid, 'Participants'), params);
131
+ }
132
+
133
+ async getParticipant(conferenceSid: string, callSid: string): Promise<any> {
134
+ return this._http.get(this._path(conferenceSid, 'Participants', callSid));
135
+ }
136
+
137
+ async updateParticipant(conferenceSid: string, callSid: string, body: any = {}): Promise<any> {
138
+ return this._http.post(this._path(conferenceSid, 'Participants', callSid), body);
139
+ }
140
+
141
+ async removeParticipant(conferenceSid: string, callSid: string): Promise<any> {
142
+ return this._http.delete(this._path(conferenceSid, 'Participants', callSid));
143
+ }
144
+
145
+ // Conference recordings
146
+ async listRecordings(conferenceSid: string, params?: QueryParams): Promise<any> {
147
+ return this._http.get(this._path(conferenceSid, 'Recordings'), params);
148
+ }
149
+
150
+ async getRecording(conferenceSid: string, recordingSid: string): Promise<any> {
151
+ return this._http.get(this._path(conferenceSid, 'Recordings', recordingSid));
152
+ }
153
+
154
+ async updateRecording(conferenceSid: string, recordingSid: string, body: any = {}): Promise<any> {
155
+ return this._http.post(this._path(conferenceSid, 'Recordings', recordingSid), body);
156
+ }
157
+
158
+ async deleteRecording(conferenceSid: string, recordingSid: string): Promise<any> {
159
+ return this._http.delete(this._path(conferenceSid, 'Recordings', recordingSid));
160
+ }
161
+
162
+ // Conference streams
163
+ async startStream(conferenceSid: string, body: any = {}): Promise<any> {
164
+ return this._http.post(this._path(conferenceSid, 'Streams'), body);
165
+ }
166
+
167
+ async stopStream(conferenceSid: string, streamSid: string, body: any = {}): Promise<any> {
168
+ return this._http.post(this._path(conferenceSid, 'Streams', streamSid), body);
169
+ }
170
+ }
171
+
172
+ /** Compat phone number management. */
173
+ export class CompatPhoneNumbers extends BaseResource {
174
+ private readonly _availableBase: string;
175
+
176
+ constructor(http: HttpClient, basePath: string) {
177
+ super(http, basePath);
178
+ this._availableBase = basePath.replace('/IncomingPhoneNumbers', '/AvailablePhoneNumbers');
179
+ }
180
+
181
+ async list(params?: QueryParams): Promise<any> {
182
+ return this._http.get(this._basePath, params);
183
+ }
184
+
185
+ async purchase(body: any): Promise<any> {
186
+ return this._http.post(this._basePath, body);
187
+ }
188
+
189
+ async get(sid: string): Promise<any> {
190
+ return this._http.get(this._path(sid));
191
+ }
192
+
193
+ async update(sid: string, body: any = {}): Promise<any> {
194
+ return this._http.post(this._path(sid), body);
195
+ }
196
+
197
+ async delete(sid: string): Promise<any> {
198
+ return this._http.delete(this._path(sid));
199
+ }
200
+
201
+ async importNumber(body: any): Promise<any> {
202
+ const path = this._basePath.replace('/IncomingPhoneNumbers', '/ImportedPhoneNumbers');
203
+ return this._http.post(path, body);
204
+ }
205
+
206
+ async listAvailableCountries(params?: QueryParams): Promise<any> {
207
+ return this._http.get(this._availableBase, params);
208
+ }
209
+
210
+ async searchLocal(country: string, params?: QueryParams): Promise<any> {
211
+ return this._http.get(`${this._availableBase}/${country}/Local`, params);
212
+ }
213
+
214
+ async searchTollFree(country: string, params?: QueryParams): Promise<any> {
215
+ return this._http.get(`${this._availableBase}/${country}/TollFree`, params);
216
+ }
217
+ }
218
+
219
+ /** Compat application management. */
220
+ export class CompatApplications extends CrudResource {
221
+ constructor(http: HttpClient, basePath: string) {
222
+ super(http, basePath);
223
+ }
224
+
225
+ override async update(sid: string, body: any = {}): Promise<any> {
226
+ return this._http.post(this._path(sid), body);
227
+ }
228
+ }
229
+
230
+ /** Compat cXML/LaML script management. */
231
+ export class CompatLamlBins extends CrudResource {
232
+ constructor(http: HttpClient, basePath: string) {
233
+ super(http, basePath);
234
+ }
235
+
236
+ override async update(sid: string, body: any = {}): Promise<any> {
237
+ return this._http.post(this._path(sid), body);
238
+ }
239
+ }
240
+
241
+ /** Compat queue management with members. */
242
+ export class CompatQueues extends CrudResource {
243
+ constructor(http: HttpClient, basePath: string) {
244
+ super(http, basePath);
245
+ }
246
+
247
+ override async update(sid: string, body: any = {}): Promise<any> {
248
+ return this._http.post(this._path(sid), body);
249
+ }
250
+
251
+ async listMembers(queueSid: string, params?: QueryParams): Promise<any> {
252
+ return this._http.get(this._path(queueSid, 'Members'), params);
253
+ }
254
+
255
+ async getMember(queueSid: string, callSid: string): Promise<any> {
256
+ return this._http.get(this._path(queueSid, 'Members', callSid));
257
+ }
258
+
259
+ async dequeueMember(queueSid: string, callSid: string, body: any = {}): Promise<any> {
260
+ return this._http.post(this._path(queueSid, 'Members', callSid), body);
261
+ }
262
+ }
263
+
264
+ /** Compat recording management. */
265
+ export class CompatRecordings extends BaseResource {
266
+ constructor(http: HttpClient, basePath: string) {
267
+ super(http, basePath);
268
+ }
269
+
270
+ async list(params?: QueryParams): Promise<any> {
271
+ return this._http.get(this._basePath, params);
272
+ }
273
+
274
+ async get(sid: string): Promise<any> {
275
+ return this._http.get(this._path(sid));
276
+ }
277
+
278
+ async delete(sid: string): Promise<any> {
279
+ return this._http.delete(this._path(sid));
280
+ }
281
+ }
282
+
283
+ /** Compat transcription management. */
284
+ export class CompatTranscriptions extends BaseResource {
285
+ constructor(http: HttpClient, basePath: string) {
286
+ super(http, basePath);
287
+ }
288
+
289
+ async list(params?: QueryParams): Promise<any> {
290
+ return this._http.get(this._basePath, params);
291
+ }
292
+
293
+ async get(sid: string): Promise<any> {
294
+ return this._http.get(this._path(sid));
295
+ }
296
+
297
+ async delete(sid: string): Promise<any> {
298
+ return this._http.delete(this._path(sid));
299
+ }
300
+ }
301
+
302
+ /** Compat API token management. */
303
+ export class CompatTokens extends BaseResource {
304
+ constructor(http: HttpClient, basePath: string) {
305
+ super(http, basePath);
306
+ }
307
+
308
+ async create(body: any): Promise<any> {
309
+ return this._http.post(this._basePath, body);
310
+ }
311
+
312
+ async update(tokenId: string, body: any = {}): Promise<any> {
313
+ return this._http.patch(this._path(tokenId), body);
314
+ }
315
+
316
+ async delete(tokenId: string): Promise<any> {
317
+ return this._http.delete(this._path(tokenId));
318
+ }
319
+ }
320
+
321
+ /** Twilio-compatible LAML API namespace with AccountSid scoping. */
322
+ export class CompatNamespace {
323
+ readonly accounts: CompatAccounts;
324
+ readonly calls: CompatCalls;
325
+ readonly messages: CompatMessages;
326
+ readonly faxes: CompatFaxes;
327
+ readonly conferences: CompatConferences;
328
+ readonly phoneNumbers: CompatPhoneNumbers;
329
+ readonly applications: CompatApplications;
330
+ readonly lamlBins: CompatLamlBins;
331
+ readonly queues: CompatQueues;
332
+ readonly recordings: CompatRecordings;
333
+ readonly transcriptions: CompatTranscriptions;
334
+ readonly tokens: CompatTokens;
335
+
336
+ constructor(http: HttpClient, accountSid: string) {
337
+ const base = `/api/laml/2010-04-01/Accounts/${accountSid}`;
338
+
339
+ this.accounts = new CompatAccounts(http);
340
+ this.calls = new CompatCalls(http, `${base}/Calls`);
341
+ this.messages = new CompatMessages(http, `${base}/Messages`);
342
+ this.faxes = new CompatFaxes(http, `${base}/Faxes`);
343
+ this.conferences = new CompatConferences(http, `${base}/Conferences`);
344
+ this.phoneNumbers = new CompatPhoneNumbers(http, `${base}/IncomingPhoneNumbers`);
345
+ this.applications = new CompatApplications(http, `${base}/Applications`);
346
+ this.lamlBins = new CompatLamlBins(http, `${base}/LamlBins`);
347
+ this.queues = new CompatQueues(http, `${base}/Queues`);
348
+ this.recordings = new CompatRecordings(http, `${base}/Recordings`);
349
+ this.transcriptions = new CompatTranscriptions(http, `${base}/Transcriptions`);
350
+ this.tokens = new CompatTokens(http, `${base}/tokens`);
351
+ }
352
+ }
@@ -0,0 +1,45 @@
1
+ /**
2
+ * Datasphere API namespace — document management and semantic search.
3
+ */
4
+
5
+ /* eslint-disable @typescript-eslint/no-explicit-any */
6
+
7
+ import type { HttpClient } from '../HttpClient.js';
8
+ import type { QueryParams } from '../types.js';
9
+ import { CrudResource } from '../base/CrudResource.js';
10
+
11
+ /** Document management with search and chunk operations. */
12
+ export class DatasphereDocuments extends CrudResource {
13
+ constructor(http: HttpClient) {
14
+ super(http, '/api/datasphere/documents');
15
+ }
16
+
17
+ /** Semantic search across documents. */
18
+ async search(body: any): Promise<any> {
19
+ return this._http.post(this._path('search'), body);
20
+ }
21
+
22
+ /** List chunks for a document. */
23
+ async listChunks(documentId: string, params?: QueryParams): Promise<any> {
24
+ return this._http.get(this._path(documentId, 'chunks'), params);
25
+ }
26
+
27
+ /** Get a specific chunk. */
28
+ async getChunk(documentId: string, chunkId: string): Promise<any> {
29
+ return this._http.get(this._path(documentId, 'chunks', chunkId));
30
+ }
31
+
32
+ /** Delete a specific chunk. */
33
+ async deleteChunk(documentId: string, chunkId: string): Promise<any> {
34
+ return this._http.delete(this._path(documentId, 'chunks', chunkId));
35
+ }
36
+ }
37
+
38
+ /** Datasphere API namespace. */
39
+ export class DatasphereNamespace {
40
+ readonly documents: DatasphereDocuments;
41
+
42
+ constructor(http: HttpClient) {
43
+ this.documents = new DatasphereDocuments(http);
44
+ }
45
+ }
@@ -0,0 +1,222 @@
1
+ /**
2
+ * Fabric API namespace — resource composition, addresses, and tokens.
3
+ */
4
+
5
+ /* eslint-disable @typescript-eslint/no-explicit-any */
6
+
7
+ import type { HttpClient } from '../HttpClient.js';
8
+ import type { QueryParams } from '../types.js';
9
+ import { BaseResource } from '../base/BaseResource.js';
10
+ import { CrudWithAddresses } from '../base/CrudWithAddresses.js';
11
+
12
+ /** Standard fabric resource with CRUD + addresses (PATCH updates). */
13
+ export class FabricResource extends CrudWithAddresses {
14
+ constructor(http: HttpClient, basePath: string) {
15
+ super(http, basePath);
16
+ }
17
+ }
18
+
19
+ /** Fabric resource that uses PUT for updates. */
20
+ export class FabricResourcePUT extends CrudWithAddresses {
21
+ protected override _updateMethod: 'PATCH' | 'PUT' = 'PUT';
22
+
23
+ constructor(http: HttpClient, basePath: string) {
24
+ super(http, basePath);
25
+ }
26
+ }
27
+
28
+ /** Call flows with version management. Uses singular 'call_flow' for sub-resource paths. */
29
+ export class CallFlowsResource extends FabricResourcePUT {
30
+ constructor(http: HttpClient, basePath: string) {
31
+ super(http, basePath);
32
+ }
33
+
34
+ override async listAddresses(resourceId: string, params?: QueryParams): Promise<any> {
35
+ const path = this._basePath.replace('/call_flows', '/call_flow');
36
+ return this._http.get(`${path}/${resourceId}/addresses`, params);
37
+ }
38
+
39
+ async listVersions(resourceId: string, params?: QueryParams): Promise<any> {
40
+ const path = this._basePath.replace('/call_flows', '/call_flow');
41
+ return this._http.get(`${path}/${resourceId}/versions`, params);
42
+ }
43
+
44
+ async deployVersion(resourceId: string, body: any = {}): Promise<any> {
45
+ const path = this._basePath.replace('/call_flows', '/call_flow');
46
+ return this._http.post(`${path}/${resourceId}/versions`, body);
47
+ }
48
+ }
49
+
50
+ /** Conference rooms — uses singular 'conference_room' for sub-resource paths. */
51
+ export class ConferenceRoomsResource extends FabricResourcePUT {
52
+ constructor(http: HttpClient, basePath: string) {
53
+ super(http, basePath);
54
+ }
55
+
56
+ override async listAddresses(resourceId: string, params?: QueryParams): Promise<any> {
57
+ const path = this._basePath.replace('/conference_rooms', '/conference_room');
58
+ return this._http.get(`${path}/${resourceId}/addresses`, params);
59
+ }
60
+ }
61
+
62
+ /** Subscribers with SIP endpoint management. */
63
+ export class SubscribersResource extends FabricResourcePUT {
64
+ constructor(http: HttpClient, basePath: string) {
65
+ super(http, basePath);
66
+ }
67
+
68
+ async listSipEndpoints(subscriberId: string, params?: QueryParams): Promise<any> {
69
+ return this._http.get(this._path(subscriberId, 'sip_endpoints'), params);
70
+ }
71
+
72
+ async createSipEndpoint(subscriberId: string, body: any): Promise<any> {
73
+ return this._http.post(this._path(subscriberId, 'sip_endpoints'), body);
74
+ }
75
+
76
+ async getSipEndpoint(subscriberId: string, endpointId: string): Promise<any> {
77
+ return this._http.get(this._path(subscriberId, 'sip_endpoints', endpointId));
78
+ }
79
+
80
+ async updateSipEndpoint(subscriberId: string, endpointId: string, body: any): Promise<any> {
81
+ return this._http.patch(this._path(subscriberId, 'sip_endpoints', endpointId), body);
82
+ }
83
+
84
+ async deleteSipEndpoint(subscriberId: string, endpointId: string): Promise<any> {
85
+ return this._http.delete(this._path(subscriberId, 'sip_endpoints', endpointId));
86
+ }
87
+ }
88
+
89
+ /** cXML applications — no create method (read/update/delete only). */
90
+ export class CxmlApplicationsResource extends FabricResourcePUT {
91
+ constructor(http: HttpClient, basePath: string) {
92
+ super(http, basePath);
93
+ }
94
+
95
+ override async create(): Promise<never> {
96
+ throw new Error('cXML applications cannot be created via this API');
97
+ }
98
+ }
99
+
100
+ /** Generic resource operations across all fabric resource types. */
101
+ export class GenericResources extends BaseResource {
102
+ constructor(http: HttpClient, basePath: string) {
103
+ super(http, basePath);
104
+ }
105
+
106
+ async list(params?: QueryParams): Promise<any> {
107
+ return this._http.get(this._basePath, params);
108
+ }
109
+
110
+ async get(resourceId: string): Promise<any> {
111
+ return this._http.get(this._path(resourceId));
112
+ }
113
+
114
+ async delete(resourceId: string): Promise<any> {
115
+ return this._http.delete(this._path(resourceId));
116
+ }
117
+
118
+ async listAddresses(resourceId: string, params?: QueryParams): Promise<any> {
119
+ return this._http.get(this._path(resourceId, 'addresses'), params);
120
+ }
121
+
122
+ async assignPhoneRoute(resourceId: string, body: any): Promise<any> {
123
+ return this._http.post(this._path(resourceId, 'phone_routes'), body);
124
+ }
125
+
126
+ async assignDomainApplication(resourceId: string, body: any): Promise<any> {
127
+ return this._http.post(this._path(resourceId, 'domain_applications'), body);
128
+ }
129
+ }
130
+
131
+ /** Read-only fabric addresses. */
132
+ export class FabricAddresses extends BaseResource {
133
+ constructor(http: HttpClient, basePath: string) {
134
+ super(http, basePath);
135
+ }
136
+
137
+ async list(params?: QueryParams): Promise<any> {
138
+ return this._http.get(this._basePath, params);
139
+ }
140
+
141
+ async get(addressId: string): Promise<any> {
142
+ return this._http.get(this._path(addressId));
143
+ }
144
+ }
145
+
146
+ /** Subscriber, guest, invite, and embed token creation. */
147
+ export class FabricTokens extends BaseResource {
148
+ constructor(http: HttpClient) {
149
+ super(http, '/api/fabric');
150
+ }
151
+
152
+ async createSubscriberToken(body: any = {}): Promise<any> {
153
+ return this._http.post(this._path('subscribers', 'tokens'), body);
154
+ }
155
+
156
+ async refreshSubscriberToken(body: any = {}): Promise<any> {
157
+ return this._http.post(this._path('subscribers', 'tokens', 'refresh'), body);
158
+ }
159
+
160
+ async createInviteToken(body: any = {}): Promise<any> {
161
+ return this._http.post(this._path('subscriber', 'invites'), body);
162
+ }
163
+
164
+ async createGuestToken(body: any = {}): Promise<any> {
165
+ return this._http.post(this._path('guests', 'tokens'), body);
166
+ }
167
+
168
+ async createEmbedToken(body: any = {}): Promise<any> {
169
+ return this._http.post(this._path('embeds', 'tokens'), body);
170
+ }
171
+ }
172
+
173
+ /** Fabric API namespace grouping all resource types. */
174
+ export class FabricNamespace {
175
+ // PUT-update resources
176
+ readonly swmlScripts: FabricResourcePUT;
177
+ readonly relayApplications: FabricResourcePUT;
178
+ readonly callFlows: CallFlowsResource;
179
+ readonly conferenceRooms: ConferenceRoomsResource;
180
+ readonly freeswitchConnectors: FabricResourcePUT;
181
+ readonly subscribers: SubscribersResource;
182
+ readonly sipEndpoints: FabricResourcePUT;
183
+ readonly cxmlScripts: FabricResourcePUT;
184
+ readonly cxmlApplications: CxmlApplicationsResource;
185
+
186
+ // PATCH-update resources
187
+ readonly swmlWebhooks: FabricResource;
188
+ readonly aiAgents: FabricResource;
189
+ readonly sipGateways: FabricResource;
190
+ readonly cxmlWebhooks: FabricResource;
191
+
192
+ // Special resources
193
+ readonly resources: GenericResources;
194
+ readonly addresses: FabricAddresses;
195
+ readonly tokens: FabricTokens;
196
+
197
+ constructor(http: HttpClient) {
198
+ const base = '/api/fabric/resources';
199
+
200
+ // PUT-update resources
201
+ this.swmlScripts = new FabricResourcePUT(http, `${base}/swml_scripts`);
202
+ this.relayApplications = new FabricResourcePUT(http, `${base}/relay_applications`);
203
+ this.callFlows = new CallFlowsResource(http, `${base}/call_flows`);
204
+ this.conferenceRooms = new ConferenceRoomsResource(http, `${base}/conference_rooms`);
205
+ this.freeswitchConnectors = new FabricResourcePUT(http, `${base}/freeswitch_connectors`);
206
+ this.subscribers = new SubscribersResource(http, `${base}/subscribers`);
207
+ this.sipEndpoints = new FabricResourcePUT(http, `${base}/sip_endpoints`);
208
+ this.cxmlScripts = new FabricResourcePUT(http, `${base}/cxml_scripts`);
209
+ this.cxmlApplications = new CxmlApplicationsResource(http, `${base}/cxml_applications`);
210
+
211
+ // PATCH-update resources
212
+ this.swmlWebhooks = new FabricResource(http, `${base}/swml_webhooks`);
213
+ this.aiAgents = new FabricResource(http, `${base}/ai_agents`);
214
+ this.sipGateways = new FabricResource(http, `${base}/sip_gateways`);
215
+ this.cxmlWebhooks = new FabricResource(http, `${base}/cxml_webhooks`);
216
+
217
+ // Special resources
218
+ this.resources = new GenericResources(http, base);
219
+ this.addresses = new FabricAddresses(http, '/api/fabric/addresses');
220
+ this.tokens = new FabricTokens(http);
221
+ }
222
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * Imported Phone Numbers namespace — create only.
3
+ */
4
+
5
+ /* eslint-disable @typescript-eslint/no-explicit-any */
6
+
7
+ import type { HttpClient } from '../HttpClient.js';
8
+ import { BaseResource } from '../base/BaseResource.js';
9
+
10
+ /** Import externally-hosted phone numbers. */
11
+ export class ImportedNumbersResource extends BaseResource {
12
+ constructor(http: HttpClient) {
13
+ super(http, '/api/relay/rest/imported_phone_numbers');
14
+ }
15
+
16
+ /** Import a phone number. */
17
+ async create(body: any): Promise<any> {
18
+ return this._http.post(this._basePath, body);
19
+ }
20
+ }