@signalwire/sdk 2.0.3 → 2.0.5
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.
- package/dist/AgentBase.d.ts +72 -40
- package/dist/AgentBase.js +147 -85
- package/dist/AgentBase.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +152 -0
- package/dist/POM/PromptObjectModel.js +465 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/PomBuilder.d.ts +10 -0
- package/dist/PomBuilder.js +28 -0
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PromptManager.d.ts +7 -0
- package/dist/PromptManager.js +9 -0
- package/dist/PromptManager.js.map +1 -1
- package/dist/SWMLService.d.ts +121 -22
- package/dist/SWMLService.js +249 -17
- package/dist/SWMLService.js.map +1 -1
- package/dist/SecurityUtils.d.ts +7 -0
- package/dist/SecurityUtils.js +11 -0
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +4 -4
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/cli/agent-loader.js +3 -1
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/swaig-test.js +7 -3
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/index.d.ts +86 -2
- package/dist/index.js +107 -1
- package/dist/index.js.map +1 -1
- package/dist/relay/Call.js +14 -6
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +38 -0
- package/dist/relay/RelayClient.js +101 -3
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/normalize.d.ts +27 -0
- package/dist/relay/normalize.js +53 -0
- package/dist/relay/normalize.js.map +1 -0
- package/dist/relay/types.d.ts +11 -0
- package/dist/rest/callHandler.d.ts +60 -0
- package/dist/rest/callHandler.js +59 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +3 -1
- package/dist/rest/index.js +3 -1
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/fabric.d.ts +59 -5
- package/dist/rest/namespaces/fabric.js +81 -5
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +141 -1
- package/dist/rest/namespaces/phone-numbers.js +169 -1
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/skills/SkillRegistry.d.ts +29 -0
- package/dist/skills/SkillRegistry.js +42 -0
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +6 -2
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/datasphere.js +13 -3
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +7 -0
- package/dist/skills/builtin/spider.js +45 -2
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/weather_api.js +19 -1
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.js +28 -5
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.js +18 -1
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/types.d.ts +7 -1
- package/package.json +5 -2
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PhoneCallHandler — enum of `call_handler` values accepted by
|
|
3
|
+
* {@link PhoneNumbersResource.update}.
|
|
4
|
+
*
|
|
5
|
+
* Named `PhoneCallHandler` (not `CallHandler`) to avoid colliding with the
|
|
6
|
+
* RELAY client's inbound-call-handler callback type already exported from
|
|
7
|
+
* `src/relay/types.ts`.
|
|
8
|
+
*
|
|
9
|
+
* Setting a phone number's `call_handler` + the handler-specific companion
|
|
10
|
+
* field routes inbound calls and auto-materializes the matching Fabric
|
|
11
|
+
* resource on the server. See the high-level helpers on
|
|
12
|
+
* {@link PhoneNumbersResource} (`setSwmlWebhook`, `setCxmlWebhook`,
|
|
13
|
+
* `setCxmlApplication`, `setAiAgent`, `setCallFlow`, `setRelayApplication`,
|
|
14
|
+
* `setRelayTopic`).
|
|
15
|
+
*
|
|
16
|
+
* | Member | Wire value | Companion field | Auto-creates Fabric resource |
|
|
17
|
+
* |---|---|---|---|
|
|
18
|
+
* | `RELAY_SCRIPT` | `relay_script` | `call_relay_script_url` | `swml_webhook` |
|
|
19
|
+
* | `LAML_WEBHOOKS` | `laml_webhooks` | `call_request_url` | `cxml_webhook` |
|
|
20
|
+
* | `LAML_APPLICATION` | `laml_application` | `call_laml_application_id` | `cxml_application` |
|
|
21
|
+
* | `AI_AGENT` | `ai_agent` | `call_ai_agent_id` | `ai_agent` |
|
|
22
|
+
* | `CALL_FLOW` | `call_flow` | `call_flow_id` | `call_flow` |
|
|
23
|
+
* | `RELAY_APPLICATION` | `relay_application` | `call_relay_application` | `relay_application` |
|
|
24
|
+
* | `RELAY_TOPIC` | `relay_topic` | `call_relay_topic` | *(routes via RELAY)* |
|
|
25
|
+
* | `RELAY_CONTEXT` | `relay_context` | `call_relay_context` | *(legacy, prefer topic)* |
|
|
26
|
+
* | `RELAY_CONNECTOR` | `relay_connector` | *(connector config)* | *(internal)* |
|
|
27
|
+
* | `VIDEO_ROOM` | `video_room` | `call_video_room_id` | *(routes to Video API)* |
|
|
28
|
+
* | `DIALOGFLOW` | `dialogflow` | `call_dialogflow_agent_id` | *(none)* |
|
|
29
|
+
*
|
|
30
|
+
* Note: `LAML_WEBHOOKS` (wire value `laml_webhooks`) produces a **cXML**
|
|
31
|
+
* handler, not a generic webhook. For SWML, use `RELAY_SCRIPT`.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* import { PhoneCallHandler } from '@signalwire/sdk';
|
|
36
|
+
*
|
|
37
|
+
* await client.phoneNumbers.update(pnSid, {
|
|
38
|
+
* call_handler: PhoneCallHandler.RELAY_SCRIPT,
|
|
39
|
+
* call_relay_script_url: 'https://example.com/swml',
|
|
40
|
+
* });
|
|
41
|
+
*
|
|
42
|
+
* // Or use the typed helper:
|
|
43
|
+
* await client.phoneNumbers.setSwmlWebhook(pnSid, 'https://example.com/swml');
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
export declare const PhoneCallHandler: {
|
|
47
|
+
readonly RELAY_SCRIPT: "relay_script";
|
|
48
|
+
readonly LAML_WEBHOOKS: "laml_webhooks";
|
|
49
|
+
readonly LAML_APPLICATION: "laml_application";
|
|
50
|
+
readonly AI_AGENT: "ai_agent";
|
|
51
|
+
readonly CALL_FLOW: "call_flow";
|
|
52
|
+
readonly RELAY_APPLICATION: "relay_application";
|
|
53
|
+
readonly RELAY_TOPIC: "relay_topic";
|
|
54
|
+
readonly RELAY_CONTEXT: "relay_context";
|
|
55
|
+
readonly RELAY_CONNECTOR: "relay_connector";
|
|
56
|
+
readonly VIDEO_ROOM: "video_room";
|
|
57
|
+
readonly DIALOGFLOW: "dialogflow";
|
|
58
|
+
};
|
|
59
|
+
/** Union of every valid `call_handler` wire value. */
|
|
60
|
+
export type PhoneCallHandler = typeof PhoneCallHandler[keyof typeof PhoneCallHandler];
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PhoneCallHandler — enum of `call_handler` values accepted by
|
|
3
|
+
* {@link PhoneNumbersResource.update}.
|
|
4
|
+
*
|
|
5
|
+
* Named `PhoneCallHandler` (not `CallHandler`) to avoid colliding with the
|
|
6
|
+
* RELAY client's inbound-call-handler callback type already exported from
|
|
7
|
+
* `src/relay/types.ts`.
|
|
8
|
+
*
|
|
9
|
+
* Setting a phone number's `call_handler` + the handler-specific companion
|
|
10
|
+
* field routes inbound calls and auto-materializes the matching Fabric
|
|
11
|
+
* resource on the server. See the high-level helpers on
|
|
12
|
+
* {@link PhoneNumbersResource} (`setSwmlWebhook`, `setCxmlWebhook`,
|
|
13
|
+
* `setCxmlApplication`, `setAiAgent`, `setCallFlow`, `setRelayApplication`,
|
|
14
|
+
* `setRelayTopic`).
|
|
15
|
+
*
|
|
16
|
+
* | Member | Wire value | Companion field | Auto-creates Fabric resource |
|
|
17
|
+
* |---|---|---|---|
|
|
18
|
+
* | `RELAY_SCRIPT` | `relay_script` | `call_relay_script_url` | `swml_webhook` |
|
|
19
|
+
* | `LAML_WEBHOOKS` | `laml_webhooks` | `call_request_url` | `cxml_webhook` |
|
|
20
|
+
* | `LAML_APPLICATION` | `laml_application` | `call_laml_application_id` | `cxml_application` |
|
|
21
|
+
* | `AI_AGENT` | `ai_agent` | `call_ai_agent_id` | `ai_agent` |
|
|
22
|
+
* | `CALL_FLOW` | `call_flow` | `call_flow_id` | `call_flow` |
|
|
23
|
+
* | `RELAY_APPLICATION` | `relay_application` | `call_relay_application` | `relay_application` |
|
|
24
|
+
* | `RELAY_TOPIC` | `relay_topic` | `call_relay_topic` | *(routes via RELAY)* |
|
|
25
|
+
* | `RELAY_CONTEXT` | `relay_context` | `call_relay_context` | *(legacy, prefer topic)* |
|
|
26
|
+
* | `RELAY_CONNECTOR` | `relay_connector` | *(connector config)* | *(internal)* |
|
|
27
|
+
* | `VIDEO_ROOM` | `video_room` | `call_video_room_id` | *(routes to Video API)* |
|
|
28
|
+
* | `DIALOGFLOW` | `dialogflow` | `call_dialogflow_agent_id` | *(none)* |
|
|
29
|
+
*
|
|
30
|
+
* Note: `LAML_WEBHOOKS` (wire value `laml_webhooks`) produces a **cXML**
|
|
31
|
+
* handler, not a generic webhook. For SWML, use `RELAY_SCRIPT`.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* import { PhoneCallHandler } from '@signalwire/sdk';
|
|
36
|
+
*
|
|
37
|
+
* await client.phoneNumbers.update(pnSid, {
|
|
38
|
+
* call_handler: PhoneCallHandler.RELAY_SCRIPT,
|
|
39
|
+
* call_relay_script_url: 'https://example.com/swml',
|
|
40
|
+
* });
|
|
41
|
+
*
|
|
42
|
+
* // Or use the typed helper:
|
|
43
|
+
* await client.phoneNumbers.setSwmlWebhook(pnSid, 'https://example.com/swml');
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
export const PhoneCallHandler = {
|
|
47
|
+
RELAY_SCRIPT: 'relay_script',
|
|
48
|
+
LAML_WEBHOOKS: 'laml_webhooks',
|
|
49
|
+
LAML_APPLICATION: 'laml_application',
|
|
50
|
+
AI_AGENT: 'ai_agent',
|
|
51
|
+
CALL_FLOW: 'call_flow',
|
|
52
|
+
RELAY_APPLICATION: 'relay_application',
|
|
53
|
+
RELAY_TOPIC: 'relay_topic',
|
|
54
|
+
RELAY_CONTEXT: 'relay_context',
|
|
55
|
+
RELAY_CONNECTOR: 'relay_connector',
|
|
56
|
+
VIDEO_ROOM: 'video_room',
|
|
57
|
+
DIALOGFLOW: 'dialogflow',
|
|
58
|
+
};
|
|
59
|
+
//# sourceMappingURL=callHandler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"callHandler.js","sourceRoot":"","sources":["../../src/rest/callHandler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,YAAY,EAAE,cAAc;IAC5B,aAAa,EAAE,eAAe;IAC9B,gBAAgB,EAAE,kBAAkB;IACpC,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,iBAAiB,EAAE,mBAAmB;IACtC,WAAW,EAAE,aAAa;IAC1B,aAAa,EAAE,eAAe;IAC9B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,YAAY;CAChB,CAAC"}
|
package/dist/rest/index.d.ts
CHANGED
|
@@ -108,10 +108,12 @@ export type { ClientOptions, HttpClientOptions, PaginatedResponse, LamlPaginated
|
|
|
108
108
|
export { BaseResource } from './base/BaseResource.js';
|
|
109
109
|
export { CrudResource } from './base/CrudResource.js';
|
|
110
110
|
export { CrudWithAddresses } from './base/CrudWithAddresses.js';
|
|
111
|
-
export {
|
|
111
|
+
export { PhoneCallHandler } from './callHandler.js';
|
|
112
|
+
export { FabricNamespace, FabricResource, FabricResourcePUT, CallFlowsResource, ConferenceRoomsResource, SubscribersResource, CxmlApplicationsResource, AutoMaterializedWebhookResource, SwmlWebhooksResource, CxmlWebhooksResource, GenericResources, FabricAddresses, FabricTokens } from './namespaces/fabric.js';
|
|
112
113
|
export { CallingNamespace } from './namespaces/calling.js';
|
|
113
114
|
export { DatasphereNamespace, DatasphereDocuments } from './namespaces/datasphere.js';
|
|
114
115
|
export { PhoneNumbersResource } from './namespaces/phone-numbers.js';
|
|
116
|
+
export type { SetSwmlWebhookExtra, SetCxmlWebhookParams, SetCallFlowParams, SetRelayTopicParams } from './namespaces/phone-numbers.js';
|
|
115
117
|
export { AddressesResource } from './namespaces/addresses.js';
|
|
116
118
|
export { QueuesResource } from './namespaces/queues.js';
|
|
117
119
|
export { RecordingsResource } from './namespaces/recordings.js';
|
package/dist/rest/index.js
CHANGED
|
@@ -170,8 +170,10 @@ export { paginate, paginateAll } from './pagination.js';
|
|
|
170
170
|
export { BaseResource } from './base/BaseResource.js';
|
|
171
171
|
export { CrudResource } from './base/CrudResource.js';
|
|
172
172
|
export { CrudWithAddresses } from './base/CrudWithAddresses.js';
|
|
173
|
+
// Call-handler enum (for phoneNumbers.update call_handler field)
|
|
174
|
+
export { PhoneCallHandler } from './callHandler.js';
|
|
173
175
|
// Namespaces
|
|
174
|
-
export { FabricNamespace, FabricResource, FabricResourcePUT, CallFlowsResource, ConferenceRoomsResource, SubscribersResource, CxmlApplicationsResource, GenericResources, FabricAddresses, FabricTokens } from './namespaces/fabric.js';
|
|
176
|
+
export { FabricNamespace, FabricResource, FabricResourcePUT, CallFlowsResource, ConferenceRoomsResource, SubscribersResource, CxmlApplicationsResource, AutoMaterializedWebhookResource, SwmlWebhooksResource, CxmlWebhooksResource, GenericResources, FabricAddresses, FabricTokens } from './namespaces/fabric.js';
|
|
175
177
|
export { CallingNamespace } from './namespaces/calling.js';
|
|
176
178
|
export { DatasphereNamespace, DatasphereDocuments } from './namespaces/datasphere.js';
|
|
177
179
|
export { PhoneNumbersResource } from './namespaces/phone-numbers.js';
|
package/dist/rest/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rest/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,aAAa;AACb,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,MAAM,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,UAAU;IACrB,aAAa;IACb,6EAA6E;IACpE,MAAM,CAAkB;IAEjC,cAAc;IACd,oEAAoE;IAC3D,OAAO,CAAmB;IAEnC,uBAAuB;IACvB,kDAAkD;IACzC,YAAY,CAAuB;IAC5C,0BAA0B;IACjB,SAAS,CAAoB;IACtC,8CAA8C;IACrC,MAAM,CAAiB;IAChC,+BAA+B;IACtB,UAAU,CAAqB;IACxC,oDAAoD;IAC3C,YAAY,CAAuB;IAC5C,sDAAsD;IAC7C,eAAe,CAA0B;IAClD,2DAA2D;IAClD,UAAU,CAAqB;IACxC,2CAA2C;IAClC,MAAM,CAAiB;IAChC,gCAAgC;IACvB,UAAU,CAAqB;IACxC,8CAA8C;IACrC,eAAe,CAA0B;IAClD,oEAAoE;IAC3D,GAAG,CAAc;IAC1B,uEAAuE;IAC9D,QAAQ,CAAoB;IAErC,iBAAiB;IACjB,8DAA8D;IACrD,UAAU,CAAsB;IAEzC,YAAY;IACZ,uEAAuE;IAC9D,KAAK,CAAiB;IAE/B,OAAO;IACP,yDAAyD;IAChD,IAAI,CAAgB;IAE7B,qBAAqB;IACrB,2CAA2C;IAClC,OAAO,CAAmB;IAEnC,gBAAgB;IAChB,6BAA6B;IACpB,MAAM,CAAiB;IAChC,2BAA2B;IAClB,IAAI,CAAe;IAE5B,wCAAwC;IACxC,sFAAsF;IAC7E,MAAM,CAAkB;IAEjC;;;;;;;;OAQG;IACH,YAAY,UAAyB,EAAE;QACrC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC;QAC9E,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;QACzE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC;QAEnE,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,yCAAyC;gBACzC,0DAA0D;gBAC1D,mEAAmE,CACpE,CAAC;QACJ,CAAC;QAED,iDAAiD;QACjD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC;QAEnE,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC;YAC1B,OAAO;YACP,OAAO;YACP,KAAK;YACL,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC,CAAC;QAEH,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAEhD,aAAa;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QAExC,cAAc;QACd,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAE1C,uBAAuB;QACvB,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAE5C,iBAAiB;QACjB,IAAI,CAAC,UAAU,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAEhD,YAAY;QACZ,IAAI,CAAC,KAAK,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QAEtC,OAAO;QACP,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;QAEpC,qBAAqB;QACrB,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAE1C,gBAAgB;QAChB,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;QAEnC,wCAAwC;QACxC,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF;AAED,yBAAyB;AAEzB,SAAS;AACT,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAKxD,eAAe;AACf,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,aAAa;AACb,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rest/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,aAAa;AACb,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,MAAM,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,UAAU;IACrB,aAAa;IACb,6EAA6E;IACpE,MAAM,CAAkB;IAEjC,cAAc;IACd,oEAAoE;IAC3D,OAAO,CAAmB;IAEnC,uBAAuB;IACvB,kDAAkD;IACzC,YAAY,CAAuB;IAC5C,0BAA0B;IACjB,SAAS,CAAoB;IACtC,8CAA8C;IACrC,MAAM,CAAiB;IAChC,+BAA+B;IACtB,UAAU,CAAqB;IACxC,oDAAoD;IAC3C,YAAY,CAAuB;IAC5C,sDAAsD;IAC7C,eAAe,CAA0B;IAClD,2DAA2D;IAClD,UAAU,CAAqB;IACxC,2CAA2C;IAClC,MAAM,CAAiB;IAChC,gCAAgC;IACvB,UAAU,CAAqB;IACxC,8CAA8C;IACrC,eAAe,CAA0B;IAClD,oEAAoE;IAC3D,GAAG,CAAc;IAC1B,uEAAuE;IAC9D,QAAQ,CAAoB;IAErC,iBAAiB;IACjB,8DAA8D;IACrD,UAAU,CAAsB;IAEzC,YAAY;IACZ,uEAAuE;IAC9D,KAAK,CAAiB;IAE/B,OAAO;IACP,yDAAyD;IAChD,IAAI,CAAgB;IAE7B,qBAAqB;IACrB,2CAA2C;IAClC,OAAO,CAAmB;IAEnC,gBAAgB;IAChB,6BAA6B;IACpB,MAAM,CAAiB;IAChC,2BAA2B;IAClB,IAAI,CAAe;IAE5B,wCAAwC;IACxC,sFAAsF;IAC7E,MAAM,CAAkB;IAEjC;;;;;;;;OAQG;IACH,YAAY,UAAyB,EAAE;QACrC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC;QAC9E,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;QACzE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC;QAEnE,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,yCAAyC;gBACzC,0DAA0D;gBAC1D,mEAAmE,CACpE,CAAC;QACJ,CAAC;QAED,iDAAiD;QACjD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC;QAEnE,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC;YAC1B,OAAO;YACP,OAAO;YACP,KAAK;YACL,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC,CAAC;QAEH,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAEhD,aAAa;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QAExC,cAAc;QACd,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAE1C,uBAAuB;QACvB,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAE5C,iBAAiB;QACjB,IAAI,CAAC,UAAU,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAEhD,YAAY;QACZ,IAAI,CAAC,KAAK,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QAEtC,OAAO;QACP,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;QAEpC,qBAAqB;QACrB,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAE1C,gBAAgB;QAChB,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;QAEnC,wCAAwC;QACxC,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF;AAED,yBAAyB;AAEzB,SAAS;AACT,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAKxD,eAAe;AACf,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,iEAAiE;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,aAAa;AACb,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACrT,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAErE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,iBAAiB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACjI,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACnL,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtG,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC"}
|
|
@@ -113,8 +113,43 @@ export declare class CxmlApplicationsResource extends FabricResourcePUT {
|
|
|
113
113
|
constructor(http: HttpClient, basePath: string);
|
|
114
114
|
create(): Promise<never>;
|
|
115
115
|
}
|
|
116
|
+
/**
|
|
117
|
+
* Fabric webhook resource that is normally auto-materialized by the
|
|
118
|
+
* corresponding `phoneNumbers.set*Webhook` helper.
|
|
119
|
+
*
|
|
120
|
+
* Creating directly produces an orphan Fabric resource that isn't bound to
|
|
121
|
+
* any phone number — the API's binding model configures the webhook on the
|
|
122
|
+
* phone number, and the server materializes the Fabric resource as a
|
|
123
|
+
* side-effect. `create` remains for backwards compatibility but emits a
|
|
124
|
+
* one-time deprecation warning on first call.
|
|
125
|
+
*
|
|
126
|
+
* See the porting-sdk's `phone-binding.md` for the full model.
|
|
127
|
+
*/
|
|
128
|
+
export declare class AutoMaterializedWebhookResource extends FabricResource {
|
|
129
|
+
/** Label used in the deprecation warning (subclasses override). */
|
|
130
|
+
protected _autoHelperName: string;
|
|
131
|
+
private static _warned;
|
|
132
|
+
constructor(http: HttpClient, basePath: string);
|
|
133
|
+
/**
|
|
134
|
+
* @deprecated Creating a webhook Fabric resource directly produces an
|
|
135
|
+
* orphan that is not bound to any phone number. Use the
|
|
136
|
+
* `phoneNumbers.setSwmlWebhook` / `setCxmlWebhook` helper instead — it
|
|
137
|
+
* updates the phone number and the server auto-materializes the
|
|
138
|
+
* resource. Kept for backwards compatibility.
|
|
139
|
+
*/
|
|
140
|
+
create(body?: any): Promise<any>;
|
|
141
|
+
}
|
|
142
|
+
/** Auto-materialized SWML webhook — normally created via `phoneNumbers.setSwmlWebhook`. */
|
|
143
|
+
export declare class SwmlWebhooksResource extends AutoMaterializedWebhookResource {
|
|
144
|
+
protected _autoHelperName: string;
|
|
145
|
+
}
|
|
146
|
+
/** Auto-materialized cXML webhook — normally created via `phoneNumbers.setCxmlWebhook`. */
|
|
147
|
+
export declare class CxmlWebhooksResource extends AutoMaterializedWebhookResource {
|
|
148
|
+
protected _autoHelperName: string;
|
|
149
|
+
}
|
|
116
150
|
/** Generic resource operations across all fabric resource types. */
|
|
117
151
|
export declare class GenericResources extends BaseResource {
|
|
152
|
+
private static _assignPhoneRouteWarned;
|
|
118
153
|
constructor(http: HttpClient, basePath: string);
|
|
119
154
|
/**
|
|
120
155
|
* List all fabric resources regardless of specific type.
|
|
@@ -152,8 +187,19 @@ export declare class GenericResources extends BaseResource {
|
|
|
152
187
|
/**
|
|
153
188
|
* Assign a phone route to a fabric resource.
|
|
154
189
|
*
|
|
190
|
+
* @deprecated For the common cases — SWML webhooks, cXML webhooks, AI
|
|
191
|
+
* agents — this endpoint **does not work**. Bindings for those are
|
|
192
|
+
* configured on the phone number via {@link PhoneNumbersResource.setSwmlWebhook}
|
|
193
|
+
* / `setCxmlWebhook` / `setAiAgent`, and the Fabric resource is
|
|
194
|
+
* auto-materialized by the server. Calling this method against
|
|
195
|
+
* `swml_webhook`, `cxml_webhook`, or `ai_agent` resource IDs returns
|
|
196
|
+
* `404` or `422`. The endpoint (`POST /api/fabric/resources/{id}/phone_routes`)
|
|
197
|
+
* applies only to a narrow set of legacy resource types listed in
|
|
198
|
+
* `rest-apis/relay-rest/openapi.yaml`. Emits a one-time deprecation
|
|
199
|
+
* warning on first call; kept for backwards compatibility.
|
|
200
|
+
*
|
|
155
201
|
* @param resourceId - Unique identifier of the resource.
|
|
156
|
-
* @param body - Phone route payload
|
|
202
|
+
* @param body - Phone route payload.
|
|
157
203
|
* @returns The phone-route assignment record.
|
|
158
204
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
159
205
|
*/
|
|
@@ -264,14 +310,22 @@ export declare class FabricNamespace {
|
|
|
264
310
|
readonly cxmlScripts: FabricResourcePUT;
|
|
265
311
|
/** cXML application read / update / delete (no create). */
|
|
266
312
|
readonly cxmlApplications: CxmlApplicationsResource;
|
|
267
|
-
/**
|
|
268
|
-
|
|
313
|
+
/**
|
|
314
|
+
* SWML webhook CRUD. **Auto-materialized** as a side-effect of
|
|
315
|
+
* {@link PhoneNumbersResource.setSwmlWebhook}; direct `create` produces
|
|
316
|
+
* an orphan resource and emits a deprecation warning.
|
|
317
|
+
*/
|
|
318
|
+
readonly swmlWebhooks: SwmlWebhooksResource;
|
|
269
319
|
/** AI Agent CRUD — the platform-managed agent registration resource. */
|
|
270
320
|
readonly aiAgents: FabricResource;
|
|
271
321
|
/** SIP Gateway CRUD. */
|
|
272
322
|
readonly sipGateways: FabricResource;
|
|
273
|
-
/**
|
|
274
|
-
|
|
323
|
+
/**
|
|
324
|
+
* cXML webhook CRUD. **Auto-materialized** as a side-effect of
|
|
325
|
+
* {@link PhoneNumbersResource.setCxmlWebhook}; direct `create` produces
|
|
326
|
+
* an orphan resource and emits a deprecation warning.
|
|
327
|
+
*/
|
|
328
|
+
readonly cxmlWebhooks: CxmlWebhooksResource;
|
|
275
329
|
/** Generic operations across all resource types (list, get, delete, phone route assignment). */
|
|
276
330
|
readonly resources: GenericResources;
|
|
277
331
|
/** Read-only access to the unified fabric address table. */
|
|
@@ -147,8 +147,54 @@ export class CxmlApplicationsResource extends FabricResourcePUT {
|
|
|
147
147
|
throw new Error('cXML applications cannot be created via this API');
|
|
148
148
|
}
|
|
149
149
|
}
|
|
150
|
+
/**
|
|
151
|
+
* Fabric webhook resource that is normally auto-materialized by the
|
|
152
|
+
* corresponding `phoneNumbers.set*Webhook` helper.
|
|
153
|
+
*
|
|
154
|
+
* Creating directly produces an orphan Fabric resource that isn't bound to
|
|
155
|
+
* any phone number — the API's binding model configures the webhook on the
|
|
156
|
+
* phone number, and the server materializes the Fabric resource as a
|
|
157
|
+
* side-effect. `create` remains for backwards compatibility but emits a
|
|
158
|
+
* one-time deprecation warning on first call.
|
|
159
|
+
*
|
|
160
|
+
* See the porting-sdk's `phone-binding.md` for the full model.
|
|
161
|
+
*/
|
|
162
|
+
export class AutoMaterializedWebhookResource extends FabricResource {
|
|
163
|
+
/** Label used in the deprecation warning (subclasses override). */
|
|
164
|
+
_autoHelperName = 'phoneNumbers.set*Webhook';
|
|
165
|
+
static _warned = new WeakSet();
|
|
166
|
+
constructor(http, basePath) {
|
|
167
|
+
super(http, basePath);
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* @deprecated Creating a webhook Fabric resource directly produces an
|
|
171
|
+
* orphan that is not bound to any phone number. Use the
|
|
172
|
+
* `phoneNumbers.setSwmlWebhook` / `setCxmlWebhook` helper instead — it
|
|
173
|
+
* updates the phone number and the server auto-materializes the
|
|
174
|
+
* resource. Kept for backwards compatibility.
|
|
175
|
+
*/
|
|
176
|
+
async create(body = {}) {
|
|
177
|
+
if (!AutoMaterializedWebhookResource._warned.has(this)) {
|
|
178
|
+
AutoMaterializedWebhookResource._warned.add(this);
|
|
179
|
+
console.warn(`[signalwire] Creating a webhook Fabric resource directly produces ` +
|
|
180
|
+
`an orphan not bound to any phone number. Use ${this._autoHelperName} ` +
|
|
181
|
+
`instead; it updates the phone number and the server auto-materializes ` +
|
|
182
|
+
`the resource. See porting-sdk's phone-binding.md.`);
|
|
183
|
+
}
|
|
184
|
+
return super.create(body);
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
/** Auto-materialized SWML webhook — normally created via `phoneNumbers.setSwmlWebhook`. */
|
|
188
|
+
export class SwmlWebhooksResource extends AutoMaterializedWebhookResource {
|
|
189
|
+
_autoHelperName = 'phoneNumbers.setSwmlWebhook(sid, url)';
|
|
190
|
+
}
|
|
191
|
+
/** Auto-materialized cXML webhook — normally created via `phoneNumbers.setCxmlWebhook`. */
|
|
192
|
+
export class CxmlWebhooksResource extends AutoMaterializedWebhookResource {
|
|
193
|
+
_autoHelperName = 'phoneNumbers.setCxmlWebhook(sid, { url })';
|
|
194
|
+
}
|
|
150
195
|
/** Generic resource operations across all fabric resource types. */
|
|
151
196
|
export class GenericResources extends BaseResource {
|
|
197
|
+
static _assignPhoneRouteWarned = new WeakSet();
|
|
152
198
|
constructor(http, basePath) {
|
|
153
199
|
super(http, basePath);
|
|
154
200
|
}
|
|
@@ -196,12 +242,31 @@ export class GenericResources extends BaseResource {
|
|
|
196
242
|
/**
|
|
197
243
|
* Assign a phone route to a fabric resource.
|
|
198
244
|
*
|
|
245
|
+
* @deprecated For the common cases — SWML webhooks, cXML webhooks, AI
|
|
246
|
+
* agents — this endpoint **does not work**. Bindings for those are
|
|
247
|
+
* configured on the phone number via {@link PhoneNumbersResource.setSwmlWebhook}
|
|
248
|
+
* / `setCxmlWebhook` / `setAiAgent`, and the Fabric resource is
|
|
249
|
+
* auto-materialized by the server. Calling this method against
|
|
250
|
+
* `swml_webhook`, `cxml_webhook`, or `ai_agent` resource IDs returns
|
|
251
|
+
* `404` or `422`. The endpoint (`POST /api/fabric/resources/{id}/phone_routes`)
|
|
252
|
+
* applies only to a narrow set of legacy resource types listed in
|
|
253
|
+
* `rest-apis/relay-rest/openapi.yaml`. Emits a one-time deprecation
|
|
254
|
+
* warning on first call; kept for backwards compatibility.
|
|
255
|
+
*
|
|
199
256
|
* @param resourceId - Unique identifier of the resource.
|
|
200
|
-
* @param body - Phone route payload
|
|
257
|
+
* @param body - Phone route payload.
|
|
201
258
|
* @returns The phone-route assignment record.
|
|
202
259
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
203
260
|
*/
|
|
204
261
|
async assignPhoneRoute(resourceId, body) {
|
|
262
|
+
if (!GenericResources._assignPhoneRouteWarned.has(this)) {
|
|
263
|
+
GenericResources._assignPhoneRouteWarned.add(this);
|
|
264
|
+
console.warn('[signalwire] assignPhoneRoute does not bind phone numbers to ' +
|
|
265
|
+
'swml_webhook / cxml_webhook / ai_agent resources — those are ' +
|
|
266
|
+
'configured via phoneNumbers.setSwmlWebhook / setCxmlWebhook / ' +
|
|
267
|
+
'setAiAgent. This method applies only to a narrow set of legacy ' +
|
|
268
|
+
"resource types. See porting-sdk's phone-binding.md.");
|
|
269
|
+
}
|
|
205
270
|
return this._http.post(this._path(resourceId, 'phone_routes'), body);
|
|
206
271
|
}
|
|
207
272
|
/**
|
|
@@ -332,13 +397,21 @@ export class FabricNamespace {
|
|
|
332
397
|
/** cXML application read / update / delete (no create). */
|
|
333
398
|
cxmlApplications;
|
|
334
399
|
// PATCH-update resources
|
|
335
|
-
/**
|
|
400
|
+
/**
|
|
401
|
+
* SWML webhook CRUD. **Auto-materialized** as a side-effect of
|
|
402
|
+
* {@link PhoneNumbersResource.setSwmlWebhook}; direct `create` produces
|
|
403
|
+
* an orphan resource and emits a deprecation warning.
|
|
404
|
+
*/
|
|
336
405
|
swmlWebhooks;
|
|
337
406
|
/** AI Agent CRUD — the platform-managed agent registration resource. */
|
|
338
407
|
aiAgents;
|
|
339
408
|
/** SIP Gateway CRUD. */
|
|
340
409
|
sipGateways;
|
|
341
|
-
/**
|
|
410
|
+
/**
|
|
411
|
+
* cXML webhook CRUD. **Auto-materialized** as a side-effect of
|
|
412
|
+
* {@link PhoneNumbersResource.setCxmlWebhook}; direct `create` produces
|
|
413
|
+
* an orphan resource and emits a deprecation warning.
|
|
414
|
+
*/
|
|
342
415
|
cxmlWebhooks;
|
|
343
416
|
// Special resources
|
|
344
417
|
/** Generic operations across all resource types (list, get, delete, phone route assignment). */
|
|
@@ -360,10 +433,13 @@ export class FabricNamespace {
|
|
|
360
433
|
this.cxmlScripts = new FabricResourcePUT(http, `${base}/cxml_scripts`);
|
|
361
434
|
this.cxmlApplications = new CxmlApplicationsResource(http, `${base}/cxml_applications`);
|
|
362
435
|
// PATCH-update resources
|
|
363
|
-
|
|
436
|
+
// swmlWebhooks and cxmlWebhooks are normally auto-materialized by
|
|
437
|
+
// phoneNumbers.setSwmlWebhook / setCxmlWebhook. Direct create still
|
|
438
|
+
// works for backcompat but emits a deprecation warning.
|
|
439
|
+
this.swmlWebhooks = new SwmlWebhooksResource(http, `${base}/swml_webhooks`);
|
|
364
440
|
this.aiAgents = new FabricResource(http, `${base}/ai_agents`);
|
|
365
441
|
this.sipGateways = new FabricResource(http, `${base}/sip_gateways`);
|
|
366
|
-
this.cxmlWebhooks = new
|
|
442
|
+
this.cxmlWebhooks = new CxmlWebhooksResource(http, `${base}/cxml_webhooks`);
|
|
367
443
|
// Special resources
|
|
368
444
|
this.resources = new GenericResources(http, base);
|
|
369
445
|
this.addresses = new FabricAddresses(http, '/api/fabric/addresses');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fabric.js","sourceRoot":"","sources":["../../../src/rest/namespaces/fabric.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,sEAAsE;AACtE,MAAM,OAAO,cAAe,SAAQ,iBAAiB;IACnD,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;CACF;AAED,iDAAiD;AACjD,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IACnC,aAAa,GAAoB,KAAK,CAAC;IAE1D,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;CACF;AAED,4FAA4F;AAC5F,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IACtD,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACM,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,MAAoB;QACnE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,UAAU,YAAY,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,MAAoB;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,UAAU,WAAW,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,OAAY,EAAE;QACpD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,UAAU,WAAW,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC;CACF;AAED,iFAAiF;AACjF,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IAC5D,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACM,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,MAAoB;QACnE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,UAAU,YAAY,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;CACF;AAED,gDAAgD;AAChD,MAAM,OAAO,mBAAoB,SAAQ,iBAAiB;IACxD,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,YAAoB,EAAE,MAAoB;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CAAC,YAAoB,EAAE,IAAS;QACrD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,YAAoB,EAAE,UAAkB;QAC3D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CAAC,YAAoB,EAAE,UAAkB,EAAE,IAAS;QACzE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CAAC,YAAoB,EAAE,UAAkB;QAC9D,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC;IAClF,CAAC;CACF;AAED,sEAAsE;AACtE,MAAM,OAAO,wBAAyB,SAAQ,iBAAiB;IAC7D,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAEQ,KAAK,CAAC,MAAM;QACnB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;CACF;AAED,oEAAoE;AACpE,MAAM,OAAO,gBAAiB,SAAQ,YAAY;
|
|
1
|
+
{"version":3,"file":"fabric.js","sourceRoot":"","sources":["../../../src/rest/namespaces/fabric.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,sEAAsE;AACtE,MAAM,OAAO,cAAe,SAAQ,iBAAiB;IACnD,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;CACF;AAED,iDAAiD;AACjD,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IACnC,aAAa,GAAoB,KAAK,CAAC;IAE1D,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;CACF;AAED,4FAA4F;AAC5F,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IACtD,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACM,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,MAAoB;QACnE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,UAAU,YAAY,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,MAAoB;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,UAAU,WAAW,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,OAAY,EAAE;QACpD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,UAAU,WAAW,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC;CACF;AAED,iFAAiF;AACjF,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IAC5D,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACM,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,MAAoB;QACnE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,UAAU,YAAY,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;CACF;AAED,gDAAgD;AAChD,MAAM,OAAO,mBAAoB,SAAQ,iBAAiB;IACxD,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,YAAoB,EAAE,MAAoB;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CAAC,YAAoB,EAAE,IAAS;QACrD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,YAAoB,EAAE,UAAkB;QAC3D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CAAC,YAAoB,EAAE,UAAkB,EAAE,IAAS;QACzE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CAAC,YAAoB,EAAE,UAAkB;QAC9D,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC;IAClF,CAAC;CACF;AAED,sEAAsE;AACtE,MAAM,OAAO,wBAAyB,SAAQ,iBAAiB;IAC7D,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAEQ,KAAK,CAAC,MAAM;QACnB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,+BAAgC,SAAQ,cAAc;IACjE,mEAAmE;IACzD,eAAe,GAAW,0BAA0B,CAAC;IACvD,MAAM,CAAC,OAAO,GAAG,IAAI,OAAO,EAAU,CAAC;IAE/C,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACM,KAAK,CAAC,MAAM,CAAC,OAAY,EAAE;QAClC,IAAI,CAAC,+BAA+B,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACvD,+BAA+B,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClD,OAAO,CAAC,IAAI,CACV,oEAAoE;gBACpE,gDAAgD,IAAI,CAAC,eAAe,GAAG;gBACvE,wEAAwE;gBACxE,mDAAmD,CACpD,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;;AAGH,2FAA2F;AAC3F,MAAM,OAAO,oBAAqB,SAAQ,+BAA+B;IACpD,eAAe,GAAG,uCAAuC,CAAC;CAC9E;AAED,2FAA2F;AAC3F,MAAM,OAAO,oBAAqB,SAAQ,+BAA+B;IACpD,eAAe,GAAG,2CAA2C,CAAC;CAClF;AAED,oEAAoE;AACpE,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IACxC,MAAM,CAAC,uBAAuB,GAAG,IAAI,OAAO,EAAU,CAAC;IAE/D,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,MAAoB;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CAAC,UAAkB;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,UAAkB;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,MAAoB;QAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,gBAAgB,CAAC,UAAkB,EAAE,IAAS;QAClD,IAAI,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACxD,gBAAgB,CAAC,uBAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACnD,OAAO,CAAC,IAAI,CACV,+DAA+D;gBAC/D,+DAA+D;gBAC/D,gEAAgE;gBAChE,iEAAiE;gBACjE,qDAAqD,CACtD,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,cAAc,CAAC,EAAE,IAAI,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,uBAAuB,CAAC,UAAkB,EAAE,IAAS;QACzD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,qBAAqB,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;;AAGH,kCAAkC;AAClC,MAAM,OAAO,eAAgB,SAAQ,YAAY;IAC/C,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,MAAoB;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CAAC,SAAiB;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/C,CAAC;CACF;AAED,2DAA2D;AAC3D,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CAAC,OAAY,EAAE;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,sBAAsB,CAAC,OAAY,EAAE;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CAAC,OAAY,EAAE;QACpC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAY,EAAE;QACnC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAY,EAAE;QACnC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,eAAe;IAC1B,uBAAuB;IACvB,wDAAwD;IAC/C,WAAW,CAAoB;IACxC,8DAA8D;IACrD,iBAAiB,CAAoB;IAC9C,0DAA0D;IACjD,SAAS,CAAoB;IACtC,iDAAiD;IACxC,eAAe,CAA0B;IAClD,iCAAiC;IACxB,oBAAoB,CAAoB;IACjD,2DAA2D;IAClD,WAAW,CAAsB;IAC1C,mCAAmC;IAC1B,YAAY,CAAoB;IACzC,+BAA+B;IACtB,WAAW,CAAoB;IACxC,2DAA2D;IAClD,gBAAgB,CAA2B;IAEpD,yBAAyB;IACzB;;;;OAIG;IACM,YAAY,CAAuB;IAC5C,wEAAwE;IAC/D,QAAQ,CAAiB;IAClC,wBAAwB;IACf,WAAW,CAAiB;IACrC;;;;OAIG;IACM,YAAY,CAAuB;IAE5C,oBAAoB;IACpB,gGAAgG;IACvF,SAAS,CAAmB;IACrC,4DAA4D;IACnD,SAAS,CAAkB;IACpC,6DAA6D;IACpD,MAAM,CAAe;IAE9B,YAAY,IAAgB;QAC1B,MAAM,IAAI,GAAG,uBAAuB,CAAC;QAErC,uBAAuB;QACvB,IAAI,CAAC,WAAW,GAAG,IAAI,iBAAiB,CAAC,IAAI,EAAE,GAAG,IAAI,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,IAAI,EAAE,GAAG,IAAI,qBAAqB,CAAC,CAAC;QACnF,IAAI,CAAC,SAAS,GAAG,IAAI,iBAAiB,CAAC,IAAI,EAAE,GAAG,IAAI,aAAa,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAuB,CAAC,IAAI,EAAE,GAAG,IAAI,mBAAmB,CAAC,CAAC;QACrF,IAAI,CAAC,oBAAoB,GAAG,IAAI,iBAAiB,CAAC,IAAI,EAAE,GAAG,IAAI,wBAAwB,CAAC,CAAC;QACzF,IAAI,CAAC,WAAW,GAAG,IAAI,mBAAmB,CAAC,IAAI,EAAE,GAAG,IAAI,cAAc,CAAC,CAAC;QACxE,IAAI,CAAC,YAAY,GAAG,IAAI,iBAAiB,CAAC,IAAI,EAAE,GAAG,IAAI,gBAAgB,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,iBAAiB,CAAC,IAAI,EAAE,GAAG,IAAI,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,gBAAgB,GAAG,IAAI,wBAAwB,CAAC,IAAI,EAAE,GAAG,IAAI,oBAAoB,CAAC,CAAC;QAExF,yBAAyB;QACzB,kEAAkE;QAClE,oEAAoE;QACpE,wDAAwD;QACxD,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,IAAI,EAAE,GAAG,IAAI,gBAAgB,CAAC,CAAC;QAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,cAAc,CAAC,IAAI,EAAE,GAAG,IAAI,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,IAAI,cAAc,CAAC,IAAI,EAAE,GAAG,IAAI,eAAe,CAAC,CAAC;QACpE,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,IAAI,EAAE,GAAG,IAAI,gBAAgB,CAAC,CAAC;QAE5E,oBAAoB;QACpB,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,IAAI,eAAe,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF"}
|
|
@@ -1,12 +1,58 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Phone Numbers namespace — list, search, purchase, get, update, release.
|
|
2
|
+
* Phone Numbers namespace — list, search, purchase, get, update, release, bind.
|
|
3
3
|
*/
|
|
4
4
|
import type { HttpClient } from '../HttpClient.js';
|
|
5
5
|
import type { QueryParams } from '../types.js';
|
|
6
6
|
import { CrudResource } from '../base/CrudResource.js';
|
|
7
|
+
/** Optional companion fields for {@link PhoneNumbersResource.setSwmlWebhook}. */
|
|
8
|
+
export interface SetSwmlWebhookExtra {
|
|
9
|
+
[key: string]: unknown;
|
|
10
|
+
}
|
|
11
|
+
/** Parameters for {@link PhoneNumbersResource.setCxmlWebhook}. */
|
|
12
|
+
export interface SetCxmlWebhookParams {
|
|
13
|
+
/** Primary cXML document URL. Serialized as `call_request_url`. */
|
|
14
|
+
url: string;
|
|
15
|
+
/** Fallback URL if the primary request fails. Serialized as `call_fallback_url`. */
|
|
16
|
+
fallbackUrl?: string;
|
|
17
|
+
/** Status callback URL for call status updates. Serialized as `call_status_callback_url`. */
|
|
18
|
+
statusCallbackUrl?: string;
|
|
19
|
+
/** Any additional wire-level fields are passed through verbatim. */
|
|
20
|
+
[key: string]: unknown;
|
|
21
|
+
}
|
|
22
|
+
/** Parameters for {@link PhoneNumbersResource.setCallFlow}. */
|
|
23
|
+
export interface SetCallFlowParams {
|
|
24
|
+
/** Call Flow resource ID. Serialized as `call_flow_id`. */
|
|
25
|
+
flowId: string;
|
|
26
|
+
/**
|
|
27
|
+
* Optional pinned version — `"working_copy"` or `"current_deployed"`
|
|
28
|
+
* (server default when omitted). Serialized as `call_flow_version`.
|
|
29
|
+
*/
|
|
30
|
+
version?: string;
|
|
31
|
+
/** Any additional wire-level fields are passed through verbatim. */
|
|
32
|
+
[key: string]: unknown;
|
|
33
|
+
}
|
|
34
|
+
/** Parameters for {@link PhoneNumbersResource.setRelayTopic}. */
|
|
35
|
+
export interface SetRelayTopicParams {
|
|
36
|
+
/** RELAY topic name. Serialized as `call_relay_topic`. */
|
|
37
|
+
topic: string;
|
|
38
|
+
/**
|
|
39
|
+
* Optional status callback URL for RELAY topic delivery updates.
|
|
40
|
+
* Serialized as `call_relay_topic_status_callback_url`.
|
|
41
|
+
*/
|
|
42
|
+
statusCallbackUrl?: string;
|
|
43
|
+
/** Any additional wire-level fields are passed through verbatim. */
|
|
44
|
+
[key: string]: unknown;
|
|
45
|
+
}
|
|
7
46
|
/**
|
|
8
47
|
* Phone number management.
|
|
9
48
|
*
|
|
49
|
+
* Supports the standard CRUD surface plus typed helpers for binding an
|
|
50
|
+
* inbound call to a handler (SWML webhook, cXML webhook, AI agent, call
|
|
51
|
+
* flow, RELAY application/topic). The binding model is: set `call_handler`
|
|
52
|
+
* + the handler-specific companion field on the phone number; the server
|
|
53
|
+
* auto-materializes the matching Fabric resource. See
|
|
54
|
+
* {@link PhoneCallHandler} for the enum of valid `call_handler` values.
|
|
55
|
+
*
|
|
10
56
|
* `create` and `update` accept an untyped body object (`body: any = {}`).
|
|
11
57
|
* No `PhoneNumberCreateParams` / `PhoneNumberUpdateParams` interfaces are
|
|
12
58
|
* defined because the Python reference SDK uses bare `**kwargs` with no
|
|
@@ -37,6 +83,11 @@ export declare class PhoneNumbersResource extends CrudResource {
|
|
|
37
83
|
/**
|
|
38
84
|
* Update a phone number resource by ID. Body is optional to match Python `**kwargs`.
|
|
39
85
|
*
|
|
86
|
+
* Setting `call_handler` + the matching companion field (see
|
|
87
|
+
* {@link PhoneCallHandler}) on the phone number auto-materializes the
|
|
88
|
+
* matching Fabric resource on the server; prefer the `set*` helpers
|
|
89
|
+
* below for the common cases.
|
|
90
|
+
*
|
|
40
91
|
* @param resourceId - Unique phone-number resource ID.
|
|
41
92
|
* @param body - Partial update payload. Defaults to `{}`.
|
|
42
93
|
* @returns The updated phone-number resource.
|
|
@@ -57,4 +108,93 @@ export declare class PhoneNumbersResource extends CrudResource {
|
|
|
57
108
|
* ```
|
|
58
109
|
*/
|
|
59
110
|
search(params?: QueryParams): Promise<any>;
|
|
111
|
+
/**
|
|
112
|
+
* Route inbound calls to an SWML webhook URL.
|
|
113
|
+
*
|
|
114
|
+
* Your backend returns an SWML document per call. The server
|
|
115
|
+
* auto-creates a `swml_webhook` Fabric resource keyed off this URL —
|
|
116
|
+
* you do **not** need to call `fabric.swmlWebhooks.create` or
|
|
117
|
+
* `fabric.resources.assignPhoneRoute`.
|
|
118
|
+
*
|
|
119
|
+
* @param resourceId - Unique phone-number resource ID.
|
|
120
|
+
* @param url - Your backend's SWML endpoint.
|
|
121
|
+
* @param extra - Additional wire-level fields (e.g. `name`) merged into
|
|
122
|
+
* the PUT body.
|
|
123
|
+
* @returns The updated phone-number resource.
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* ```ts
|
|
127
|
+
* await client.phoneNumbers.setSwmlWebhook('pn-1', 'https://example.com/swml');
|
|
128
|
+
* ```
|
|
129
|
+
*/
|
|
130
|
+
setSwmlWebhook(resourceId: string, url: string, extra?: SetSwmlWebhookExtra): Promise<any>;
|
|
131
|
+
/**
|
|
132
|
+
* Route inbound calls to a cXML (Twilio-compat / LAML) webhook.
|
|
133
|
+
*
|
|
134
|
+
* Despite the wire value `laml_webhooks` being plural, this creates a
|
|
135
|
+
* single `cxml_webhook` Fabric resource. `fallbackUrl` is used when the
|
|
136
|
+
* primary URL fails; `statusCallbackUrl` receives call status updates.
|
|
137
|
+
*
|
|
138
|
+
* @param resourceId - Unique phone-number resource ID.
|
|
139
|
+
* @param params - URL and optional fallback/status URLs plus any extra
|
|
140
|
+
* wire-level fields.
|
|
141
|
+
* @returns The updated phone-number resource.
|
|
142
|
+
*
|
|
143
|
+
* @example
|
|
144
|
+
* ```ts
|
|
145
|
+
* await client.phoneNumbers.setCxmlWebhook('pn-1', {
|
|
146
|
+
* url: 'https://example.com/voice.xml',
|
|
147
|
+
* fallbackUrl: 'https://example.com/fallback.xml',
|
|
148
|
+
* });
|
|
149
|
+
* ```
|
|
150
|
+
*/
|
|
151
|
+
setCxmlWebhook(resourceId: string, params: SetCxmlWebhookParams): Promise<any>;
|
|
152
|
+
/**
|
|
153
|
+
* Route inbound calls to an existing cXML application by ID.
|
|
154
|
+
*
|
|
155
|
+
* @param resourceId - Unique phone-number resource ID.
|
|
156
|
+
* @param applicationId - cXML application ID.
|
|
157
|
+
* @param extra - Additional wire-level fields merged into the body.
|
|
158
|
+
* @returns The updated phone-number resource.
|
|
159
|
+
*/
|
|
160
|
+
setCxmlApplication(resourceId: string, applicationId: string, extra?: Record<string, unknown>): Promise<any>;
|
|
161
|
+
/**
|
|
162
|
+
* Route inbound calls to an AI Agent Fabric resource by ID.
|
|
163
|
+
*
|
|
164
|
+
* @param resourceId - Unique phone-number resource ID.
|
|
165
|
+
* @param agentId - AI agent Fabric resource ID.
|
|
166
|
+
* @param extra - Additional wire-level fields merged into the body.
|
|
167
|
+
* @returns The updated phone-number resource.
|
|
168
|
+
*/
|
|
169
|
+
setAiAgent(resourceId: string, agentId: string, extra?: Record<string, unknown>): Promise<any>;
|
|
170
|
+
/**
|
|
171
|
+
* Route inbound calls to a Call Flow by ID.
|
|
172
|
+
*
|
|
173
|
+
* `version` accepts `"working_copy"` or `"current_deployed"` (server
|
|
174
|
+
* default when omitted).
|
|
175
|
+
*
|
|
176
|
+
* @param resourceId - Unique phone-number resource ID.
|
|
177
|
+
* @param params - Flow ID and optional pinned version plus any extra
|
|
178
|
+
* wire-level fields.
|
|
179
|
+
* @returns The updated phone-number resource.
|
|
180
|
+
*/
|
|
181
|
+
setCallFlow(resourceId: string, params: SetCallFlowParams): Promise<any>;
|
|
182
|
+
/**
|
|
183
|
+
* Route inbound calls to a named RELAY application.
|
|
184
|
+
*
|
|
185
|
+
* @param resourceId - Unique phone-number resource ID.
|
|
186
|
+
* @param name - RELAY application name.
|
|
187
|
+
* @param extra - Additional wire-level fields merged into the body.
|
|
188
|
+
* @returns The updated phone-number resource.
|
|
189
|
+
*/
|
|
190
|
+
setRelayApplication(resourceId: string, name: string, extra?: Record<string, unknown>): Promise<any>;
|
|
191
|
+
/**
|
|
192
|
+
* Route inbound calls to a RELAY topic (client subscription).
|
|
193
|
+
*
|
|
194
|
+
* @param resourceId - Unique phone-number resource ID.
|
|
195
|
+
* @param params - Topic name and optional status-callback URL plus any
|
|
196
|
+
* extra wire-level fields.
|
|
197
|
+
* @returns The updated phone-number resource.
|
|
198
|
+
*/
|
|
199
|
+
setRelayTopic(resourceId: string, params: SetRelayTopicParams): Promise<any>;
|
|
60
200
|
}
|