telnyx 6.53.0 → 6.55.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.
- package/CHANGELOG.md +16 -0
- package/client.d.mts +4 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -5
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/ai/ai.d.mts +12 -10
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +12 -10
- package/resources/ai/ai.d.ts.map +1 -1
- package/resources/ai/ai.js.map +1 -1
- package/resources/ai/ai.mjs.map +1 -1
- package/resources/ai/assistants/assistants.d.mts +322 -110
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +322 -110
- package/resources/ai/assistants/assistants.d.ts.map +1 -1
- package/resources/ai/assistants/assistants.js.map +1 -1
- package/resources/ai/assistants/assistants.mjs.map +1 -1
- package/resources/ai/assistants/canary-deploys.d.mts +241 -70
- package/resources/ai/assistants/canary-deploys.d.mts.map +1 -1
- package/resources/ai/assistants/canary-deploys.d.ts +241 -70
- package/resources/ai/assistants/canary-deploys.d.ts.map +1 -1
- package/resources/ai/assistants/index.d.mts +2 -2
- package/resources/ai/assistants/index.d.mts.map +1 -1
- package/resources/ai/assistants/index.d.ts +2 -2
- package/resources/ai/assistants/index.d.ts.map +1 -1
- package/resources/ai/assistants/index.js.map +1 -1
- package/resources/ai/assistants/index.mjs.map +1 -1
- package/resources/ai/assistants/scheduled-events.d.mts +43 -0
- package/resources/ai/assistants/scheduled-events.d.mts.map +1 -1
- package/resources/ai/assistants/scheduled-events.d.ts +43 -0
- package/resources/ai/assistants/scheduled-events.d.ts.map +1 -1
- package/resources/ai/assistants/versions.d.mts +212 -6
- package/resources/ai/assistants/versions.d.mts.map +1 -1
- package/resources/ai/assistants/versions.d.ts +212 -6
- package/resources/ai/assistants/versions.d.ts.map +1 -1
- package/resources/ai/index.d.mts +2 -2
- package/resources/ai/index.d.mts.map +1 -1
- package/resources/ai/index.d.ts +2 -2
- package/resources/ai/index.d.ts.map +1 -1
- package/resources/ai/index.js.map +1 -1
- package/resources/ai/index.mjs +1 -1
- package/resources/ai/index.mjs.map +1 -1
- package/resources/ai/openai/openai.d.mts +9 -2
- package/resources/ai/openai/openai.d.mts.map +1 -1
- package/resources/ai/openai/openai.d.ts +9 -2
- package/resources/ai/openai/openai.d.ts.map +1 -1
- package/resources/ai/openai/openai.js.map +1 -1
- package/resources/ai/openai/openai.mjs.map +1 -1
- package/resources/calls/actions.d.mts +119 -41
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +119 -41
- package/resources/calls/actions.d.ts.map +1 -1
- package/resources/calls/calls.d.mts +2 -2
- package/resources/calls/calls.d.mts.map +1 -1
- package/resources/calls/calls.d.ts +2 -2
- package/resources/calls/calls.d.ts.map +1 -1
- package/resources/calls/calls.js.map +1 -1
- package/resources/calls/calls.mjs.map +1 -1
- package/resources/calls/index.d.mts +1 -1
- package/resources/calls/index.d.mts.map +1 -1
- package/resources/calls/index.d.ts +1 -1
- package/resources/calls/index.d.ts.map +1 -1
- package/resources/calls/index.js.map +1 -1
- package/resources/calls/index.mjs.map +1 -1
- package/resources/conferences/actions.d.mts +11 -1
- package/resources/conferences/actions.d.mts.map +1 -1
- package/resources/conferences/actions.d.ts +11 -1
- package/resources/conferences/actions.d.ts.map +1 -1
- package/resources/index.d.mts +2 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/networks/networks.d.mts +2 -25
- package/resources/networks/networks.d.mts.map +1 -1
- package/resources/networks/networks.d.ts +2 -25
- package/resources/networks/networks.d.ts.map +1 -1
- package/resources/networks/networks.js.map +1 -1
- package/resources/networks/networks.mjs.map +1 -1
- package/resources/public-internet-gateways.d.mts +6 -116
- package/resources/public-internet-gateways.d.mts.map +1 -1
- package/resources/public-internet-gateways.d.ts +6 -116
- package/resources/public-internet-gateways.d.ts.map +1 -1
- package/resources/public-internet-gateways.js.map +1 -1
- package/resources/public-internet-gateways.mjs.map +1 -1
- package/resources/shared.d.mts +0 -10
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +0 -10
- package/resources/shared.d.ts.map +1 -1
- package/resources/uac-connections/index.d.mts +1 -1
- package/resources/uac-connections/index.d.mts.map +1 -1
- package/resources/uac-connections/index.d.ts +1 -1
- package/resources/uac-connections/index.d.ts.map +1 -1
- package/resources/uac-connections/index.js.map +1 -1
- package/resources/uac-connections/index.mjs.map +1 -1
- package/resources/uac-connections/uac-connections.d.mts +1861 -211
- package/resources/uac-connections/uac-connections.d.mts.map +1 -1
- package/resources/uac-connections/uac-connections.d.ts +1861 -211
- package/resources/uac-connections/uac-connections.d.ts.map +1 -1
- package/resources/uac-connections/uac-connections.js +1 -1
- package/resources/uac-connections/uac-connections.js.map +1 -1
- package/resources/uac-connections/uac-connections.mjs +1 -1
- package/resources/uac-connections/uac-connections.mjs.map +1 -1
- package/resources/virtual-cross-connects.d.mts +237 -161
- package/resources/virtual-cross-connects.d.mts.map +1 -1
- package/resources/virtual-cross-connects.d.ts +237 -161
- package/resources/virtual-cross-connects.d.ts.map +1 -1
- package/resources/virtual-cross-connects.js.map +1 -1
- package/resources/virtual-cross-connects.mjs.map +1 -1
- package/resources/wireguard-interfaces.d.mts +6 -117
- package/resources/wireguard-interfaces.d.mts.map +1 -1
- package/resources/wireguard-interfaces.d.ts +6 -117
- package/resources/wireguard-interfaces.d.ts.map +1 -1
- package/resources/wireguard-interfaces.js.map +1 -1
- package/resources/wireguard-interfaces.mjs.map +1 -1
- package/src/client.ts +5 -21
- package/src/resources/ai/ai.ts +11 -20
- package/src/resources/ai/assistants/assistants.ts +350 -131
- package/src/resources/ai/assistants/canary-deploys.ts +266 -75
- package/src/resources/ai/assistants/index.ts +0 -10
- package/src/resources/ai/assistants/scheduled-events.ts +56 -0
- package/src/resources/ai/assistants/versions.ts +234 -6
- package/src/resources/ai/index.ts +1 -12
- package/src/resources/ai/openai/openai.ts +13 -2
- package/src/resources/calls/actions.ts +192 -76
- package/src/resources/calls/calls.ts +0 -4
- package/src/resources/calls/index.ts +0 -2
- package/src/resources/conferences/actions.ts +13 -1
- package/src/resources/index.ts +3 -13
- package/src/resources/networks/networks.ts +4 -31
- package/src/resources/public-internet-gateways.ts +6 -144
- package/src/resources/shared.ts +0 -12
- package/src/resources/uac-connections/index.ts +2 -6
- package/src/resources/uac-connections/uac-connections.ts +2377 -378
- package/src/resources/virtual-cross-connects.ts +249 -176
- package/src/resources/wireguard-interfaces.ts +8 -145
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -2,7 +2,7 @@ import { APIResource } from "../../../core/resource.mjs";
|
|
|
2
2
|
import * as Shared from "../../shared.mjs";
|
|
3
3
|
import * as ChatAPI from "../chat.mjs";
|
|
4
4
|
import * as CanaryDeploysAPI from "./canary-deploys.mjs";
|
|
5
|
-
import { CanaryDeploy, CanaryDeployCreateParams, CanaryDeployResponse, CanaryDeployUpdateParams, CanaryDeploys
|
|
5
|
+
import { CanaryDeploy, CanaryDeployCreateParams, CanaryDeployResponse, CanaryDeployUpdateParams, CanaryDeploys } from "./canary-deploys.mjs";
|
|
6
6
|
import * as ScheduledEventsAPI from "./scheduled-events.mjs";
|
|
7
7
|
import { ConversationChannelType, EventStatus, ScheduledEventCreateParams, ScheduledEventDeleteParams, ScheduledEventListParams, ScheduledEventListResponse, ScheduledEventListResponsesDefaultFlatPagination, ScheduledEventResponse, ScheduledEventRetrieveParams, ScheduledEvents, ScheduledPhoneCallEventResponse, ScheduledSMSEventResponse } from "./scheduled-events.mjs";
|
|
8
8
|
import * as TagsAPI from "./tags.mjs";
|
|
@@ -184,43 +184,6 @@ export interface Assistant {
|
|
|
184
184
|
*/
|
|
185
185
|
tools?: Array<Shared.BookAppointmentTool | Shared.CheckAvailabilityTool | WebhookTool | HangupTool | TransferTool | Shared.CallControlRetrievalTool>;
|
|
186
186
|
}
|
|
187
|
-
/**
|
|
188
|
-
* Reference to a connected integration attached to an assistant. Discover
|
|
189
|
-
* available integrations with `/ai/integrations` and connected integrations with
|
|
190
|
-
* `/ai/integrations/connections`.
|
|
191
|
-
*/
|
|
192
|
-
export interface AssistantIntegration {
|
|
193
|
-
/**
|
|
194
|
-
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
195
|
-
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
196
|
-
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
197
|
-
* connection-level `id` from `/ai/integrations/connections`.
|
|
198
|
-
*/
|
|
199
|
-
integration_id: string;
|
|
200
|
-
/**
|
|
201
|
-
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
202
|
-
* empty, all tools allowed by the connected integration are available to the
|
|
203
|
-
* assistant.
|
|
204
|
-
*/
|
|
205
|
-
allowed_list?: Array<string>;
|
|
206
|
-
}
|
|
207
|
-
/**
|
|
208
|
-
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
209
|
-
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
210
|
-
* ID.
|
|
211
|
-
*/
|
|
212
|
-
export interface AssistantMcpServer {
|
|
213
|
-
/**
|
|
214
|
-
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
215
|
-
* by the `/ai/mcp_servers` endpoints.
|
|
216
|
-
*/
|
|
217
|
-
id: string;
|
|
218
|
-
/**
|
|
219
|
-
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
220
|
-
* uses the MCP server's configured `allowed_tools`.
|
|
221
|
-
*/
|
|
222
|
-
allowed_tools?: Array<string>;
|
|
223
|
-
}
|
|
224
187
|
/**
|
|
225
188
|
* The handoff tool allows the assistant to hand off control of the conversation to
|
|
226
189
|
* another AI assistant. By default, this will happen transparently to the end
|
|
@@ -280,7 +243,7 @@ export declare namespace AssistantTool {
|
|
|
280
243
|
* variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
281
244
|
* variables webhook and resolves to an array of target objects at runtime.
|
|
282
245
|
*/
|
|
283
|
-
targets: Array<Transfer.
|
|
246
|
+
targets: Array<Transfer.UnionMember0> | string;
|
|
284
247
|
/**
|
|
285
248
|
* Custom headers to be added to the SIP INVITE for the transfer command.
|
|
286
249
|
*/
|
|
@@ -305,7 +268,7 @@ export declare namespace AssistantTool {
|
|
|
305
268
|
warm_transfer_instructions?: string;
|
|
306
269
|
}
|
|
307
270
|
namespace Transfer {
|
|
308
|
-
interface
|
|
271
|
+
interface UnionMember0 {
|
|
309
272
|
/**
|
|
310
273
|
* The destination number or SIP URI of the call.
|
|
311
274
|
*/
|
|
@@ -456,7 +419,7 @@ export declare namespace AssistantTool {
|
|
|
456
419
|
* omitted or null, the invite tool can still be configured and targets may be
|
|
457
420
|
* supplied dynamically at runtime.
|
|
458
421
|
*/
|
|
459
|
-
targets?: Array<Invite.
|
|
422
|
+
targets?: Array<Invite.UnionMember0> | string | null;
|
|
460
423
|
/**
|
|
461
424
|
* Configuration for voicemail detection (AMD - Answering Machine Detection) on the
|
|
462
425
|
* invited call.
|
|
@@ -474,7 +437,7 @@ export declare namespace AssistantTool {
|
|
|
474
437
|
*/
|
|
475
438
|
value?: string;
|
|
476
439
|
}
|
|
477
|
-
interface
|
|
440
|
+
interface UnionMember0 {
|
|
478
441
|
/**
|
|
479
442
|
* The destination number or SIP URI of the call.
|
|
480
443
|
*/
|
|
@@ -815,7 +778,7 @@ export interface InferenceEmbedding {
|
|
|
815
778
|
* `/ai/integrations/connections`. Each item references a catalog integration by
|
|
816
779
|
* `integration_id`.
|
|
817
780
|
*/
|
|
818
|
-
integrations?: Array<
|
|
781
|
+
integrations?: Array<InferenceEmbedding.Integration>;
|
|
819
782
|
/**
|
|
820
783
|
* Settings for interruptions and how the assistant decides the user has finished
|
|
821
784
|
* speaking. These timings are most relevant when using non turn-taking
|
|
@@ -824,7 +787,7 @@ export interface InferenceEmbedding {
|
|
|
824
787
|
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
825
788
|
* `eager_eot_threshold`).
|
|
826
789
|
*/
|
|
827
|
-
interruption_settings?:
|
|
790
|
+
interruption_settings?: InferenceEmbedding.InterruptionSettings;
|
|
828
791
|
/**
|
|
829
792
|
* This is only needed when using third-party inference providers selected by
|
|
830
793
|
* `model`. The `identifier` for an integration secret
|
|
@@ -838,7 +801,7 @@ export interface InferenceEmbedding {
|
|
|
838
801
|
* MCP servers attached to the assistant. Create MCP servers with
|
|
839
802
|
* `/ai/mcp_servers`, then reference them by `id` here.
|
|
840
803
|
*/
|
|
841
|
-
mcp_servers?: Array<
|
|
804
|
+
mcp_servers?: Array<InferenceEmbedding.McpServer>;
|
|
842
805
|
messaging_settings?: MessagingSettings;
|
|
843
806
|
observability_settings?: Observability;
|
|
844
807
|
/**
|
|
@@ -887,26 +850,108 @@ export interface InferenceEmbedding {
|
|
|
887
850
|
*/
|
|
888
851
|
widget_settings?: WidgetSettings;
|
|
889
852
|
}
|
|
890
|
-
|
|
891
|
-
* Settings for interruptions and how the assistant decides the user has finished
|
|
892
|
-
* speaking. These timings are most relevant when using non turn-taking
|
|
893
|
-
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
894
|
-
* behavior is controlled by the transcription end-of-turn settings under
|
|
895
|
-
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
896
|
-
* `eager_eot_threshold`).
|
|
897
|
-
*/
|
|
898
|
-
export interface InferenceEmbeddingInterruptionSettings {
|
|
853
|
+
export declare namespace InferenceEmbedding {
|
|
899
854
|
/**
|
|
900
|
-
*
|
|
855
|
+
* Reference to a connected integration attached to an assistant. Discover
|
|
856
|
+
* available integrations with `/ai/integrations` and connected integrations with
|
|
857
|
+
* `/ai/integrations/connections`.
|
|
901
858
|
*/
|
|
902
|
-
|
|
859
|
+
interface Integration {
|
|
860
|
+
/**
|
|
861
|
+
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
862
|
+
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
863
|
+
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
864
|
+
* connection-level `id` from `/ai/integrations/connections`.
|
|
865
|
+
*/
|
|
866
|
+
integration_id: string;
|
|
867
|
+
/**
|
|
868
|
+
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
869
|
+
* empty, all tools allowed by the connected integration are available to the
|
|
870
|
+
* assistant.
|
|
871
|
+
*/
|
|
872
|
+
allowed_list?: Array<string>;
|
|
873
|
+
}
|
|
903
874
|
/**
|
|
904
|
-
*
|
|
905
|
-
*
|
|
906
|
-
* turn-taking models like `deepgram/flux`, end-of-turn
|
|
907
|
-
* transcription end-of-turn settings under
|
|
875
|
+
* Settings for interruptions and how the assistant decides the user has finished
|
|
876
|
+
* speaking. These timings are most relevant when using non turn-taking
|
|
877
|
+
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
878
|
+
* behavior is controlled by the transcription end-of-turn settings under
|
|
879
|
+
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
880
|
+
* `eager_eot_threshold`).
|
|
908
881
|
*/
|
|
909
|
-
|
|
882
|
+
interface InterruptionSettings {
|
|
883
|
+
/**
|
|
884
|
+
* Whether users can interrupt the assistant while it is speaking.
|
|
885
|
+
*/
|
|
886
|
+
enable?: boolean;
|
|
887
|
+
/**
|
|
888
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
889
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
890
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
891
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
892
|
+
*/
|
|
893
|
+
start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
|
|
894
|
+
}
|
|
895
|
+
namespace InterruptionSettings {
|
|
896
|
+
/**
|
|
897
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
898
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
899
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
900
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
901
|
+
*/
|
|
902
|
+
interface StartSpeakingPlan {
|
|
903
|
+
/**
|
|
904
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
905
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
906
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
907
|
+
* `eager_eot_threshold`.
|
|
908
|
+
*/
|
|
909
|
+
transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
|
|
910
|
+
/**
|
|
911
|
+
* Minimum seconds to wait before the assistant starts speaking.
|
|
912
|
+
*/
|
|
913
|
+
wait_seconds?: number;
|
|
914
|
+
}
|
|
915
|
+
namespace StartSpeakingPlan {
|
|
916
|
+
/**
|
|
917
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
918
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
919
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
920
|
+
* `eager_eot_threshold`.
|
|
921
|
+
*/
|
|
922
|
+
interface TranscriptionEndpointingPlan {
|
|
923
|
+
/**
|
|
924
|
+
* Seconds to wait after the transcript ends without punctuation.
|
|
925
|
+
*/
|
|
926
|
+
on_no_punctuation_seconds?: number;
|
|
927
|
+
/**
|
|
928
|
+
* Seconds to wait after the transcript ends with a number.
|
|
929
|
+
*/
|
|
930
|
+
on_number_seconds?: number;
|
|
931
|
+
/**
|
|
932
|
+
* Seconds to wait after the transcript ends with punctuation.
|
|
933
|
+
*/
|
|
934
|
+
on_punctuation_seconds?: number;
|
|
935
|
+
}
|
|
936
|
+
}
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
940
|
+
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
941
|
+
* ID.
|
|
942
|
+
*/
|
|
943
|
+
interface McpServer {
|
|
944
|
+
/**
|
|
945
|
+
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
946
|
+
* by the `/ai/mcp_servers` endpoints.
|
|
947
|
+
*/
|
|
948
|
+
id: string;
|
|
949
|
+
/**
|
|
950
|
+
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
951
|
+
* uses the MCP server's configured `allowed_tools`.
|
|
952
|
+
*/
|
|
953
|
+
allowed_tools?: Array<string>;
|
|
954
|
+
}
|
|
910
955
|
}
|
|
911
956
|
export interface InferenceEmbeddingWebhookToolParams {
|
|
912
957
|
type: 'webhook';
|
|
@@ -1167,25 +1212,6 @@ export interface RetrievalTool {
|
|
|
1167
1212
|
retrieval: ChatAPI.BucketIDs;
|
|
1168
1213
|
type: 'retrieval';
|
|
1169
1214
|
}
|
|
1170
|
-
/**
|
|
1171
|
-
* Controls when the assistant starts speaking after the user stops. These
|
|
1172
|
-
* thresholds primarily apply to non turn-taking transcription models. For
|
|
1173
|
-
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1174
|
-
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1175
|
-
*/
|
|
1176
|
-
export interface StartSpeakingPlan {
|
|
1177
|
-
/**
|
|
1178
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1179
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1180
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1181
|
-
* `eager_eot_threshold`.
|
|
1182
|
-
*/
|
|
1183
|
-
transcription_endpointing_plan?: TranscriptionEndpointingPlan;
|
|
1184
|
-
/**
|
|
1185
|
-
* Minimum seconds to wait before the assistant starts speaking.
|
|
1186
|
-
*/
|
|
1187
|
-
wait_seconds?: number;
|
|
1188
|
-
}
|
|
1189
1215
|
export interface TelephonySettings {
|
|
1190
1216
|
/**
|
|
1191
1217
|
* Default Texml App used for voice calls with your assistant. This will be created
|
|
@@ -1329,26 +1355,6 @@ export declare namespace TelephonySettings {
|
|
|
1329
1355
|
}
|
|
1330
1356
|
}
|
|
1331
1357
|
}
|
|
1332
|
-
/**
|
|
1333
|
-
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1334
|
-
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1335
|
-
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1336
|
-
* `eager_eot_threshold`.
|
|
1337
|
-
*/
|
|
1338
|
-
export interface TranscriptionEndpointingPlan {
|
|
1339
|
-
/**
|
|
1340
|
-
* Seconds to wait after the transcript ends without punctuation.
|
|
1341
|
-
*/
|
|
1342
|
-
on_no_punctuation_seconds?: number;
|
|
1343
|
-
/**
|
|
1344
|
-
* Seconds to wait after the transcript ends with a number.
|
|
1345
|
-
*/
|
|
1346
|
-
on_number_seconds?: number;
|
|
1347
|
-
/**
|
|
1348
|
-
* Seconds to wait after the transcript ends with punctuation.
|
|
1349
|
-
*/
|
|
1350
|
-
on_punctuation_seconds?: number;
|
|
1351
|
-
}
|
|
1352
1358
|
export interface TranscriptionSettings {
|
|
1353
1359
|
/**
|
|
1354
1360
|
* Integration secret identifier for the transcription provider API key. Currently
|
|
@@ -1446,10 +1452,10 @@ export declare namespace TransferTool {
|
|
|
1446
1452
|
* variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
1447
1453
|
* variables webhook and resolves to an array of target objects at runtime.
|
|
1448
1454
|
*/
|
|
1449
|
-
targets: Array<Transfer.
|
|
1455
|
+
targets: Array<Transfer.UnionMember0> | string;
|
|
1450
1456
|
}
|
|
1451
1457
|
namespace Transfer {
|
|
1452
|
-
interface
|
|
1458
|
+
interface UnionMember0 {
|
|
1453
1459
|
/**
|
|
1454
1460
|
* The destination number or SIP URI of the call.
|
|
1455
1461
|
*/
|
|
@@ -1810,7 +1816,7 @@ export interface AssistantCreateParams {
|
|
|
1810
1816
|
* `/ai/integrations/connections`. Each item references a catalog integration by
|
|
1811
1817
|
* `integration_id`.
|
|
1812
1818
|
*/
|
|
1813
|
-
integrations?: Array<
|
|
1819
|
+
integrations?: Array<AssistantCreateParams.Integration>;
|
|
1814
1820
|
/**
|
|
1815
1821
|
* Settings for interruptions and how the assistant decides the user has finished
|
|
1816
1822
|
* speaking. These timings are most relevant when using non turn-taking
|
|
@@ -1819,7 +1825,7 @@ export interface AssistantCreateParams {
|
|
|
1819
1825
|
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
1820
1826
|
* `eager_eot_threshold`).
|
|
1821
1827
|
*/
|
|
1822
|
-
interruption_settings?:
|
|
1828
|
+
interruption_settings?: AssistantCreateParams.InterruptionSettings;
|
|
1823
1829
|
/**
|
|
1824
1830
|
* This is only needed when using third-party inference providers selected by
|
|
1825
1831
|
* `model`. The `identifier` for an integration secret
|
|
@@ -1833,7 +1839,7 @@ export interface AssistantCreateParams {
|
|
|
1833
1839
|
* MCP servers attached to the assistant. Create MCP servers with
|
|
1834
1840
|
* `/ai/mcp_servers`, then reference them by `id` here.
|
|
1835
1841
|
*/
|
|
1836
|
-
mcp_servers?: Array<
|
|
1842
|
+
mcp_servers?: Array<AssistantCreateParams.McpServer>;
|
|
1837
1843
|
messaging_settings?: MessagingSettings;
|
|
1838
1844
|
/**
|
|
1839
1845
|
* ID of the model to use when `external_llm` is not set. You can use the
|
|
@@ -1878,6 +1884,109 @@ export interface AssistantCreateParams {
|
|
|
1878
1884
|
*/
|
|
1879
1885
|
widget_settings?: WidgetSettings;
|
|
1880
1886
|
}
|
|
1887
|
+
export declare namespace AssistantCreateParams {
|
|
1888
|
+
/**
|
|
1889
|
+
* Reference to a connected integration attached to an assistant. Discover
|
|
1890
|
+
* available integrations with `/ai/integrations` and connected integrations with
|
|
1891
|
+
* `/ai/integrations/connections`.
|
|
1892
|
+
*/
|
|
1893
|
+
interface Integration {
|
|
1894
|
+
/**
|
|
1895
|
+
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
1896
|
+
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
1897
|
+
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
1898
|
+
* connection-level `id` from `/ai/integrations/connections`.
|
|
1899
|
+
*/
|
|
1900
|
+
integration_id: string;
|
|
1901
|
+
/**
|
|
1902
|
+
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
1903
|
+
* empty, all tools allowed by the connected integration are available to the
|
|
1904
|
+
* assistant.
|
|
1905
|
+
*/
|
|
1906
|
+
allowed_list?: Array<string>;
|
|
1907
|
+
}
|
|
1908
|
+
/**
|
|
1909
|
+
* Settings for interruptions and how the assistant decides the user has finished
|
|
1910
|
+
* speaking. These timings are most relevant when using non turn-taking
|
|
1911
|
+
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
1912
|
+
* behavior is controlled by the transcription end-of-turn settings under
|
|
1913
|
+
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
1914
|
+
* `eager_eot_threshold`).
|
|
1915
|
+
*/
|
|
1916
|
+
interface InterruptionSettings {
|
|
1917
|
+
/**
|
|
1918
|
+
* Whether users can interrupt the assistant while it is speaking.
|
|
1919
|
+
*/
|
|
1920
|
+
enable?: boolean;
|
|
1921
|
+
/**
|
|
1922
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
1923
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
1924
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1925
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1926
|
+
*/
|
|
1927
|
+
start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
|
|
1928
|
+
}
|
|
1929
|
+
namespace InterruptionSettings {
|
|
1930
|
+
/**
|
|
1931
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
1932
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
1933
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1934
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
1935
|
+
*/
|
|
1936
|
+
interface StartSpeakingPlan {
|
|
1937
|
+
/**
|
|
1938
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1939
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1940
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1941
|
+
* `eager_eot_threshold`.
|
|
1942
|
+
*/
|
|
1943
|
+
transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
|
|
1944
|
+
/**
|
|
1945
|
+
* Minimum seconds to wait before the assistant starts speaking.
|
|
1946
|
+
*/
|
|
1947
|
+
wait_seconds?: number;
|
|
1948
|
+
}
|
|
1949
|
+
namespace StartSpeakingPlan {
|
|
1950
|
+
/**
|
|
1951
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
1952
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1953
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1954
|
+
* `eager_eot_threshold`.
|
|
1955
|
+
*/
|
|
1956
|
+
interface TranscriptionEndpointingPlan {
|
|
1957
|
+
/**
|
|
1958
|
+
* Seconds to wait after the transcript ends without punctuation.
|
|
1959
|
+
*/
|
|
1960
|
+
on_no_punctuation_seconds?: number;
|
|
1961
|
+
/**
|
|
1962
|
+
* Seconds to wait after the transcript ends with a number.
|
|
1963
|
+
*/
|
|
1964
|
+
on_number_seconds?: number;
|
|
1965
|
+
/**
|
|
1966
|
+
* Seconds to wait after the transcript ends with punctuation.
|
|
1967
|
+
*/
|
|
1968
|
+
on_punctuation_seconds?: number;
|
|
1969
|
+
}
|
|
1970
|
+
}
|
|
1971
|
+
}
|
|
1972
|
+
/**
|
|
1973
|
+
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
1974
|
+
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
1975
|
+
* ID.
|
|
1976
|
+
*/
|
|
1977
|
+
interface McpServer {
|
|
1978
|
+
/**
|
|
1979
|
+
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
1980
|
+
* by the `/ai/mcp_servers` endpoints.
|
|
1981
|
+
*/
|
|
1982
|
+
id: string;
|
|
1983
|
+
/**
|
|
1984
|
+
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
1985
|
+
* uses the MCP server's configured `allowed_tools`.
|
|
1986
|
+
*/
|
|
1987
|
+
allowed_tools?: Array<string>;
|
|
1988
|
+
}
|
|
1989
|
+
}
|
|
1881
1990
|
export interface AssistantRetrieveParams {
|
|
1882
1991
|
call_control_id?: string;
|
|
1883
1992
|
fetch_dynamic_variables_from_webhook?: boolean;
|
|
@@ -1934,7 +2043,7 @@ export interface AssistantUpdateParams {
|
|
|
1934
2043
|
* `/ai/integrations/connections`. Each item references a catalog integration by
|
|
1935
2044
|
* `integration_id`.
|
|
1936
2045
|
*/
|
|
1937
|
-
integrations?: Array<
|
|
2046
|
+
integrations?: Array<AssistantUpdateParams.Integration>;
|
|
1938
2047
|
/**
|
|
1939
2048
|
* Settings for interruptions and how the assistant decides the user has finished
|
|
1940
2049
|
* speaking. These timings are most relevant when using non turn-taking
|
|
@@ -1943,7 +2052,7 @@ export interface AssistantUpdateParams {
|
|
|
1943
2052
|
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
1944
2053
|
* `eager_eot_threshold`).
|
|
1945
2054
|
*/
|
|
1946
|
-
interruption_settings?:
|
|
2055
|
+
interruption_settings?: AssistantUpdateParams.InterruptionSettings;
|
|
1947
2056
|
/**
|
|
1948
2057
|
* This is only needed when using third-party inference providers selected by
|
|
1949
2058
|
* `model`. The `identifier` for an integration secret
|
|
@@ -1957,7 +2066,7 @@ export interface AssistantUpdateParams {
|
|
|
1957
2066
|
* MCP servers attached to the assistant. Create MCP servers with
|
|
1958
2067
|
* `/ai/mcp_servers`, then reference them by `id` here.
|
|
1959
2068
|
*/
|
|
1960
|
-
mcp_servers?: Array<
|
|
2069
|
+
mcp_servers?: Array<AssistantUpdateParams.McpServer>;
|
|
1961
2070
|
messaging_settings?: MessagingSettings;
|
|
1962
2071
|
/**
|
|
1963
2072
|
* ID of the model to use when `external_llm` is not set. You can use the
|
|
@@ -2012,6 +2121,109 @@ export interface AssistantUpdateParams {
|
|
|
2012
2121
|
*/
|
|
2013
2122
|
widget_settings?: WidgetSettings;
|
|
2014
2123
|
}
|
|
2124
|
+
export declare namespace AssistantUpdateParams {
|
|
2125
|
+
/**
|
|
2126
|
+
* Reference to a connected integration attached to an assistant. Discover
|
|
2127
|
+
* available integrations with `/ai/integrations` and connected integrations with
|
|
2128
|
+
* `/ai/integrations/connections`.
|
|
2129
|
+
*/
|
|
2130
|
+
interface Integration {
|
|
2131
|
+
/**
|
|
2132
|
+
* Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
2133
|
+
* at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
2134
|
+
* entries returned by `/ai/integrations/connections`). It is **not** the
|
|
2135
|
+
* connection-level `id` from `/ai/integrations/connections`.
|
|
2136
|
+
*/
|
|
2137
|
+
integration_id: string;
|
|
2138
|
+
/**
|
|
2139
|
+
* Optional per-assistant allowlist of integration tool names. When omitted or
|
|
2140
|
+
* empty, all tools allowed by the connected integration are available to the
|
|
2141
|
+
* assistant.
|
|
2142
|
+
*/
|
|
2143
|
+
allowed_list?: Array<string>;
|
|
2144
|
+
}
|
|
2145
|
+
/**
|
|
2146
|
+
* Settings for interruptions and how the assistant decides the user has finished
|
|
2147
|
+
* speaking. These timings are most relevant when using non turn-taking
|
|
2148
|
+
* transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
2149
|
+
* behavior is controlled by the transcription end-of-turn settings under
|
|
2150
|
+
* `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
2151
|
+
* `eager_eot_threshold`).
|
|
2152
|
+
*/
|
|
2153
|
+
interface InterruptionSettings {
|
|
2154
|
+
/**
|
|
2155
|
+
* Whether users can interrupt the assistant while it is speaking.
|
|
2156
|
+
*/
|
|
2157
|
+
enable?: boolean;
|
|
2158
|
+
/**
|
|
2159
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
2160
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
2161
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
2162
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
2163
|
+
*/
|
|
2164
|
+
start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
|
|
2165
|
+
}
|
|
2166
|
+
namespace InterruptionSettings {
|
|
2167
|
+
/**
|
|
2168
|
+
* Controls when the assistant starts speaking after the user stops. These
|
|
2169
|
+
* thresholds primarily apply to non turn-taking transcription models. For
|
|
2170
|
+
* turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
2171
|
+
* transcription end-of-turn settings under `transcription.settings` instead.
|
|
2172
|
+
*/
|
|
2173
|
+
interface StartSpeakingPlan {
|
|
2174
|
+
/**
|
|
2175
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
2176
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
2177
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
2178
|
+
* `eager_eot_threshold`.
|
|
2179
|
+
*/
|
|
2180
|
+
transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
|
|
2181
|
+
/**
|
|
2182
|
+
* Minimum seconds to wait before the assistant starts speaking.
|
|
2183
|
+
*/
|
|
2184
|
+
wait_seconds?: number;
|
|
2185
|
+
}
|
|
2186
|
+
namespace StartSpeakingPlan {
|
|
2187
|
+
/**
|
|
2188
|
+
* Endpointing thresholds used to decide when the user has finished speaking.
|
|
2189
|
+
* Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
2190
|
+
* `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
2191
|
+
* `eager_eot_threshold`.
|
|
2192
|
+
*/
|
|
2193
|
+
interface TranscriptionEndpointingPlan {
|
|
2194
|
+
/**
|
|
2195
|
+
* Seconds to wait after the transcript ends without punctuation.
|
|
2196
|
+
*/
|
|
2197
|
+
on_no_punctuation_seconds?: number;
|
|
2198
|
+
/**
|
|
2199
|
+
* Seconds to wait after the transcript ends with a number.
|
|
2200
|
+
*/
|
|
2201
|
+
on_number_seconds?: number;
|
|
2202
|
+
/**
|
|
2203
|
+
* Seconds to wait after the transcript ends with punctuation.
|
|
2204
|
+
*/
|
|
2205
|
+
on_punctuation_seconds?: number;
|
|
2206
|
+
}
|
|
2207
|
+
}
|
|
2208
|
+
}
|
|
2209
|
+
/**
|
|
2210
|
+
* Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
2211
|
+
* servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
2212
|
+
* ID.
|
|
2213
|
+
*/
|
|
2214
|
+
interface McpServer {
|
|
2215
|
+
/**
|
|
2216
|
+
* ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
2217
|
+
* by the `/ai/mcp_servers` endpoints.
|
|
2218
|
+
*/
|
|
2219
|
+
id: string;
|
|
2220
|
+
/**
|
|
2221
|
+
* Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
2222
|
+
* uses the MCP server's configured `allowed_tools`.
|
|
2223
|
+
*/
|
|
2224
|
+
allowed_tools?: Array<string>;
|
|
2225
|
+
}
|
|
2226
|
+
}
|
|
2015
2227
|
export interface AssistantChatParams {
|
|
2016
2228
|
/**
|
|
2017
2229
|
* The message content sent by the client to the assistant
|
|
@@ -2053,9 +2265,9 @@ export interface AssistantSendSMSParams {
|
|
|
2053
2265
|
text?: string;
|
|
2054
2266
|
}
|
|
2055
2267
|
export declare namespace Assistants {
|
|
2056
|
-
export { type Assistant as Assistant, type
|
|
2268
|
+
export { type Assistant as Assistant, type AssistantTool as AssistantTool, type AssistantsList as AssistantsList, type AudioVisualizerConfig as AudioVisualizerConfig, type EnabledFeatures as EnabledFeatures, type ExternalLlm as ExternalLlm, type ExternalLlmReq as ExternalLlmReq, type FallbackConfig as FallbackConfig, type FallbackConfigReq as FallbackConfigReq, type HangupTool as HangupTool, type HangupToolParams as HangupToolParams, type ImportMetadata as ImportMetadata, type InferenceEmbedding as InferenceEmbedding, type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams, type InsightSettings as InsightSettings, type MessagingSettings as MessagingSettings, type Observability as Observability, type ObservabilityReq as ObservabilityReq, type PostConversationSettings as PostConversationSettings, type PostConversationSettingsReq as PostConversationSettingsReq, type PrivacySettings as PrivacySettings, type RetrievalTool as RetrievalTool, type TelephonySettings as TelephonySettings, type TranscriptionSettings as TranscriptionSettings, type TranscriptionSettingsConfig as TranscriptionSettingsConfig, type TransferTool as TransferTool, type VoiceSettings as VoiceSettings, type WebhookTool as WebhookTool, type WidgetSettings as WidgetSettings, type AssistantDeleteResponse as AssistantDeleteResponse, type AssistantChatResponse as AssistantChatResponse, type AssistantGetTexmlResponse as AssistantGetTexmlResponse, type AssistantSendSMSResponse as AssistantSendSMSResponse, type AssistantCreateParams as AssistantCreateParams, type AssistantRetrieveParams as AssistantRetrieveParams, type AssistantUpdateParams as AssistantUpdateParams, type AssistantChatParams as AssistantChatParams, type AssistantImportsParams as AssistantImportsParams, type AssistantSendSMSParams as AssistantSendSMSParams, };
|
|
2057
2269
|
export { Tests as Tests, type AssistantTest as AssistantTest, type TelnyxConversationChannel as TelnyxConversationChannel, type AssistantTestsDefaultFlatPagination as AssistantTestsDefaultFlatPagination, type TestCreateParams as TestCreateParams, type TestUpdateParams as TestUpdateParams, type TestListParams as TestListParams, };
|
|
2058
|
-
export { CanaryDeploys as CanaryDeploys, type CanaryDeploy as CanaryDeploy, type CanaryDeployResponse as CanaryDeployResponse, type
|
|
2270
|
+
export { CanaryDeploys as CanaryDeploys, type CanaryDeploy as CanaryDeploy, type CanaryDeployResponse as CanaryDeployResponse, type CanaryDeployCreateParams as CanaryDeployCreateParams, type CanaryDeployUpdateParams as CanaryDeployUpdateParams, };
|
|
2059
2271
|
export { ScheduledEvents as ScheduledEvents, type ConversationChannelType as ConversationChannelType, type EventStatus as EventStatus, type ScheduledEventResponse as ScheduledEventResponse, type ScheduledPhoneCallEventResponse as ScheduledPhoneCallEventResponse, type ScheduledSMSEventResponse as ScheduledSMSEventResponse, type ScheduledEventListResponse as ScheduledEventListResponse, type ScheduledEventListResponsesDefaultFlatPagination as ScheduledEventListResponsesDefaultFlatPagination, type ScheduledEventCreateParams as ScheduledEventCreateParams, type ScheduledEventRetrieveParams as ScheduledEventRetrieveParams, type ScheduledEventListParams as ScheduledEventListParams, type ScheduledEventDeleteParams as ScheduledEventDeleteParams, };
|
|
2060
2272
|
export { Tools as Tools, type ToolAddResponse as ToolAddResponse, type ToolRemoveResponse as ToolRemoveResponse, type ToolTestResponse as ToolTestResponse, type ToolAddParams as ToolAddParams, type ToolRemoveParams as ToolRemoveParams, type ToolTestParams as ToolTestParams, };
|
|
2061
2273
|
export { Versions as Versions, type UpdateAssistant as UpdateAssistant, type VersionRetrieveParams as VersionRetrieveParams, type VersionUpdateParams as VersionUpdateParams, type VersionDeleteParams as VersionDeleteParams, type VersionPromoteParams as VersionPromoteParams, };
|