telnyx 7.24.0 → 7.25.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 +7 -0
- package/client.d.mts +19 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +19 -4
- package/client.d.ts.map +1 -1
- package/client.js +15 -0
- package/client.js.map +1 -1
- package/client.mjs +15 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/ai/ai.d.mts +7 -6
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +7 -6
- 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 +320 -28
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +320 -28
- package/resources/ai/assistants/assistants.d.ts.map +1 -1
- package/resources/ai/assistants/assistants.js +79 -2
- package/resources/ai/assistants/assistants.js.map +1 -1
- package/resources/ai/assistants/assistants.mjs +79 -2
- package/resources/ai/assistants/assistants.mjs.map +1 -1
- package/resources/ai/assistants/deleted.d.mts +60 -0
- package/resources/ai/assistants/deleted.d.mts.map +1 -0
- package/resources/ai/assistants/deleted.d.ts +60 -0
- package/resources/ai/assistants/deleted.d.ts.map +1 -0
- package/resources/ai/assistants/deleted.js +49 -0
- package/resources/ai/assistants/deleted.js.map +1 -0
- package/resources/ai/assistants/deleted.mjs +45 -0
- package/resources/ai/assistants/deleted.mjs.map +1 -0
- package/resources/ai/assistants/index.d.mts +2 -1
- package/resources/ai/assistants/index.d.mts.map +1 -1
- package/resources/ai/assistants/index.d.ts +2 -1
- package/resources/ai/assistants/index.d.ts.map +1 -1
- package/resources/ai/assistants/index.js +3 -1
- package/resources/ai/assistants/index.js.map +1 -1
- package/resources/ai/assistants/index.mjs +1 -0
- package/resources/ai/assistants/index.mjs.map +1 -1
- package/resources/ai/assistants/versions.d.mts +36 -0
- package/resources/ai/assistants/versions.d.mts.map +1 -1
- package/resources/ai/assistants/versions.d.ts +36 -0
- package/resources/ai/assistants/versions.d.ts.map +1 -1
- package/resources/ai/chat.d.mts +7 -2
- package/resources/ai/chat.d.mts.map +1 -1
- package/resources/ai/chat.d.ts +7 -2
- package/resources/ai/chat.d.ts.map +1 -1
- package/resources/ai/embeddings/embeddings.d.mts +1 -1
- package/resources/ai/embeddings/embeddings.d.ts +1 -1
- package/resources/ai/embeddings/embeddings.js +1 -1
- package/resources/ai/embeddings/embeddings.mjs +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.map +1 -1
- package/resources/ai/memory/index.d.mts +1 -1
- package/resources/ai/memory/index.d.mts.map +1 -1
- package/resources/ai/memory/index.d.ts +1 -1
- package/resources/ai/memory/index.d.ts.map +1 -1
- package/resources/ai/memory/index.js.map +1 -1
- package/resources/ai/memory/index.mjs +1 -1
- package/resources/ai/memory/index.mjs.map +1 -1
- package/resources/ai/memory/memory.d.mts +2 -2
- package/resources/ai/memory/memory.d.mts.map +1 -1
- package/resources/ai/memory/memory.d.ts +2 -2
- package/resources/ai/memory/memory.d.ts.map +1 -1
- package/resources/ai/memory/memory.js.map +1 -1
- package/resources/ai/memory/memory.mjs +1 -1
- package/resources/ai/memory/memory.mjs.map +1 -1
- package/resources/ai/memory/namespaces/index.d.mts +1 -1
- package/resources/ai/memory/namespaces/index.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/index.d.ts +1 -1
- package/resources/ai/memory/namespaces/index.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/index.js.map +1 -1
- package/resources/ai/memory/namespaces/index.mjs +1 -1
- package/resources/ai/memory/namespaces/index.mjs.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.d.mts +60 -4
- package/resources/ai/memory/namespaces/namespaces.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.d.ts +60 -4
- package/resources/ai/memory/namespaces/namespaces.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.js +41 -3
- package/resources/ai/memory/namespaces/namespaces.js.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.mjs +41 -3
- package/resources/ai/memory/namespaces/namespaces.mjs.map +1 -1
- package/resources/ai/openai/chat.d.mts +7 -2
- package/resources/ai/openai/chat.d.mts.map +1 -1
- package/resources/ai/openai/chat.d.ts +7 -2
- package/resources/ai/openai/chat.d.ts.map +1 -1
- package/resources/ai/tools.d.mts +3 -4
- package/resources/ai/tools.d.mts.map +1 -1
- package/resources/ai/tools.d.ts +3 -4
- package/resources/ai/tools.d.ts.map +1 -1
- package/resources/ai/tools.js +5 -2
- package/resources/ai/tools.js.map +1 -1
- package/resources/ai/tools.mjs +5 -2
- package/resources/ai/tools.mjs.map +1 -1
- package/resources/calls/actions.d.mts +76 -17
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +76 -17
- package/resources/calls/actions.d.ts.map +1 -1
- package/resources/calls/actions.js +31 -0
- package/resources/calls/actions.js.map +1 -1
- package/resources/calls/actions.mjs +31 -0
- package/resources/calls/actions.mjs.map +1 -1
- package/resources/calls/calls.d.mts +48 -11
- package/resources/calls/calls.d.mts.map +1 -1
- package/resources/calls/calls.d.ts +48 -11
- package/resources/calls/calls.d.ts.map +1 -1
- package/resources/calls/calls.js +3 -0
- package/resources/calls/calls.js.map +1 -1
- package/resources/calls/calls.mjs +3 -0
- package/resources/calls/calls.mjs.map +1 -1
- package/resources/dir/dir.d.mts +220 -28
- package/resources/dir/dir.d.mts.map +1 -1
- package/resources/dir/dir.d.ts +220 -28
- package/resources/dir/dir.d.ts.map +1 -1
- package/resources/dir/dir.js +77 -13
- package/resources/dir/dir.js.map +1 -1
- package/resources/dir/dir.mjs +77 -13
- package/resources/dir/dir.mjs.map +1 -1
- package/resources/dir/index.d.mts +1 -1
- package/resources/dir/index.d.mts.map +1 -1
- package/resources/dir/index.d.ts +1 -1
- package/resources/dir/index.d.ts.map +1 -1
- package/resources/dir/index.js.map +1 -1
- package/resources/dir/index.mjs.map +1 -1
- package/resources/dir/phone-numbers.d.mts +8 -4
- package/resources/dir/phone-numbers.d.mts.map +1 -1
- package/resources/dir/phone-numbers.d.ts +8 -4
- package/resources/dir/phone-numbers.d.ts.map +1 -1
- package/resources/dir/phone-numbers.js +4 -4
- package/resources/dir/phone-numbers.mjs +4 -4
- package/resources/dir/references.d.mts +9 -6
- package/resources/dir/references.d.mts.map +1 -1
- package/resources/dir/references.d.ts +9 -6
- package/resources/dir/references.d.ts.map +1 -1
- package/resources/enterprises/dir.d.mts +17 -1
- package/resources/enterprises/dir.d.mts.map +1 -1
- package/resources/enterprises/dir.d.ts +17 -1
- package/resources/enterprises/dir.d.ts.map +1 -1
- package/resources/enterprises/enterprises.d.mts +237 -23
- package/resources/enterprises/enterprises.d.mts.map +1 -1
- package/resources/enterprises/enterprises.d.ts +237 -23
- package/resources/enterprises/enterprises.d.ts.map +1 -1
- package/resources/enterprises/enterprises.js +26 -4
- package/resources/enterprises/enterprises.js.map +1 -1
- package/resources/enterprises/enterprises.mjs +26 -4
- package/resources/enterprises/enterprises.mjs.map +1 -1
- package/resources/enterprises/index.d.mts +1 -0
- package/resources/enterprises/index.d.mts.map +1 -1
- package/resources/enterprises/index.d.ts +1 -0
- package/resources/enterprises/index.d.ts.map +1 -1
- package/resources/enterprises/index.js +3 -1
- package/resources/enterprises/index.js.map +1 -1
- package/resources/enterprises/index.mjs +1 -0
- package/resources/enterprises/index.mjs.map +1 -1
- package/resources/enterprises/reputation/loa.d.mts +61 -1
- package/resources/enterprises/reputation/loa.d.mts.map +1 -1
- package/resources/enterprises/reputation/loa.d.ts +61 -1
- package/resources/enterprises/reputation/loa.d.ts.map +1 -1
- package/resources/enterprises/verify-email.d.mts +91 -0
- package/resources/enterprises/verify-email.d.mts.map +1 -0
- package/resources/enterprises/verify-email.d.ts +91 -0
- package/resources/enterprises/verify-email.d.ts.map +1 -0
- package/resources/enterprises/verify-email.js +55 -0
- package/resources/enterprises/verify-email.js.map +1 -0
- package/resources/enterprises/verify-email.mjs +51 -0
- package/resources/enterprises/verify-email.mjs.map +1 -0
- package/resources/index.d.mts +4 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +7 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -0
- package/resources/index.mjs.map +1 -1
- package/resources/infringement-claims.d.mts +4 -0
- package/resources/infringement-claims.d.mts.map +1 -1
- package/resources/infringement-claims.d.ts +4 -0
- package/resources/infringement-claims.d.ts.map +1 -1
- package/resources/llm-token-gateway/index.d.mts +3 -0
- package/resources/llm-token-gateway/index.d.mts.map +1 -0
- package/resources/llm-token-gateway/index.d.ts +3 -0
- package/resources/llm-token-gateway/index.d.ts.map +1 -0
- package/resources/llm-token-gateway/index.js +9 -0
- package/resources/llm-token-gateway/index.js.map +1 -0
- package/resources/llm-token-gateway/index.mjs +4 -0
- package/resources/llm-token-gateway/index.mjs.map +1 -0
- package/resources/llm-token-gateway/llm-token-gateway.d.mts +10 -0
- package/resources/llm-token-gateway/llm-token-gateway.d.mts.map +1 -0
- package/resources/llm-token-gateway/llm-token-gateway.d.ts +10 -0
- package/resources/llm-token-gateway/llm-token-gateway.d.ts.map +1 -0
- package/resources/llm-token-gateway/llm-token-gateway.js +17 -0
- package/resources/llm-token-gateway/llm-token-gateway.js.map +1 -0
- package/resources/llm-token-gateway/llm-token-gateway.mjs +12 -0
- package/resources/llm-token-gateway/llm-token-gateway.mjs.map +1 -0
- package/resources/llm-token-gateway/usage.d.mts +260 -0
- package/resources/llm-token-gateway/usage.d.mts.map +1 -0
- package/resources/llm-token-gateway/usage.d.ts +260 -0
- package/resources/llm-token-gateway/usage.d.ts.map +1 -0
- package/resources/llm-token-gateway/usage.js +31 -0
- package/resources/llm-token-gateway/usage.js.map +1 -0
- package/resources/llm-token-gateway/usage.mjs +27 -0
- package/resources/llm-token-gateway/usage.mjs.map +1 -0
- package/resources/llm-token-gateway.d.mts +2 -0
- package/resources/llm-token-gateway.d.mts.map +1 -0
- package/resources/llm-token-gateway.d.ts +2 -0
- package/resources/llm-token-gateway.d.ts.map +1 -0
- package/resources/llm-token-gateway.js +6 -0
- package/resources/llm-token-gateway.js.map +1 -0
- package/resources/llm-token-gateway.mjs +3 -0
- package/resources/llm-token-gateway.mjs.map +1 -0
- package/resources/meeting-sessions/meeting-sessions.d.mts +8 -9
- package/resources/meeting-sessions/meeting-sessions.d.mts.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.d.ts +8 -9
- package/resources/meeting-sessions/meeting-sessions.d.ts.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.js +6 -6
- package/resources/meeting-sessions/meeting-sessions.js.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.mjs +6 -6
- package/resources/meeting-sessions/meeting-sessions.mjs.map +1 -1
- package/resources/porting-orders/phone-number-blocks.d.mts +1 -1
- package/resources/porting-orders/phone-number-blocks.d.mts.map +1 -1
- package/resources/porting-orders/phone-number-blocks.d.ts +1 -1
- package/resources/porting-orders/phone-number-blocks.d.ts.map +1 -1
- package/resources/porting-orders/porting-orders.d.mts +1 -1
- package/resources/porting-orders/porting-orders.d.mts.map +1 -1
- package/resources/porting-orders/porting-orders.d.ts +1 -1
- package/resources/porting-orders/porting-orders.d.ts.map +1 -1
- package/resources/porting-orders/porting-orders.js.map +1 -1
- package/resources/porting-orders/porting-orders.mjs.map +1 -1
- package/resources/porting-phone-numbers.d.mts +1 -1
- package/resources/porting-phone-numbers.d.mts.map +1 -1
- package/resources/porting-phone-numbers.d.ts +1 -1
- package/resources/porting-phone-numbers.d.ts.map +1 -1
- package/resources/requirements.d.mts +2 -2
- package/resources/requirements.d.mts.map +1 -1
- package/resources/requirements.d.ts +2 -2
- package/resources/requirements.d.ts.map +1 -1
- package/resources/spend-limits.d.mts +335 -0
- package/resources/spend-limits.d.mts.map +1 -0
- package/resources/spend-limits.d.ts +335 -0
- package/resources/spend-limits.d.ts.map +1 -0
- package/resources/spend-limits.js +91 -0
- package/resources/spend-limits.js.map +1 -0
- package/resources/spend-limits.mjs +87 -0
- package/resources/spend-limits.mjs.map +1 -0
- package/resources/terms-of-service/agreements.d.mts +12 -0
- package/resources/terms-of-service/agreements.d.mts.map +1 -1
- package/resources/terms-of-service/agreements.d.ts +12 -0
- package/resources/terms-of-service/agreements.d.ts.map +1 -1
- package/resources/terms-of-service/terms-of-service.d.mts +15 -0
- package/resources/terms-of-service/terms-of-service.d.mts.map +1 -1
- package/resources/terms-of-service/terms-of-service.d.ts +15 -0
- package/resources/terms-of-service/terms-of-service.d.ts.map +1 -1
- package/resources/terms-of-service/terms-of-service.js.map +1 -1
- package/resources/terms-of-service/terms-of-service.mjs.map +1 -1
- package/resources/text-to-speech/text-to-speech.d.mts +4 -2
- package/resources/text-to-speech/text-to-speech.d.mts.map +1 -1
- package/resources/text-to-speech/text-to-speech.d.ts +4 -2
- package/resources/text-to-speech/text-to-speech.d.ts.map +1 -1
- package/resources/webhooks.d.mts +403 -5
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +403 -5
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/whatsapp/phone-numbers/calling-routing.d.mts +89 -0
- package/resources/whatsapp/phone-numbers/calling-routing.d.mts.map +1 -0
- package/resources/whatsapp/phone-numbers/calling-routing.d.ts +89 -0
- package/resources/whatsapp/phone-numbers/calling-routing.d.ts.map +1 -0
- package/resources/whatsapp/phone-numbers/calling-routing.js +65 -0
- package/resources/whatsapp/phone-numbers/calling-routing.js.map +1 -0
- package/resources/whatsapp/phone-numbers/calling-routing.mjs +61 -0
- package/resources/whatsapp/phone-numbers/calling-routing.mjs.map +1 -0
- package/resources/whatsapp/phone-numbers/index.d.mts +1 -0
- package/resources/whatsapp/phone-numbers/index.d.mts.map +1 -1
- package/resources/whatsapp/phone-numbers/index.d.ts +1 -0
- package/resources/whatsapp/phone-numbers/index.d.ts.map +1 -1
- package/resources/whatsapp/phone-numbers/index.js +3 -1
- package/resources/whatsapp/phone-numbers/index.js.map +1 -1
- package/resources/whatsapp/phone-numbers/index.mjs +1 -0
- package/resources/whatsapp/phone-numbers/index.mjs.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.d.mts +4 -0
- package/resources/whatsapp/phone-numbers/phone-numbers.d.mts.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.d.ts +4 -0
- package/resources/whatsapp/phone-numbers/phone-numbers.d.ts.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.js +4 -0
- package/resources/whatsapp/phone-numbers/phone-numbers.js.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.mjs +4 -0
- package/resources/whatsapp/phone-numbers/phone-numbers.mjs.map +1 -1
- package/src/client.ts +55 -0
- package/src/resources/ai/ai.ts +13 -4
- package/src/resources/ai/assistants/assistants.ts +384 -28
- package/src/resources/ai/assistants/deleted.ts +86 -0
- package/src/resources/ai/assistants/index.ts +11 -0
- package/src/resources/ai/assistants/versions.ts +40 -0
- package/src/resources/ai/chat.ts +7 -2
- package/src/resources/ai/embeddings/embeddings.ts +1 -1
- package/src/resources/ai/index.ts +5 -1
- package/src/resources/ai/memory/index.ts +9 -1
- package/src/resources/ai/memory/memory.ts +13 -1
- package/src/resources/ai/memory/namespaces/index.ts +9 -1
- package/src/resources/ai/memory/namespaces/namespaces.ts +81 -3
- package/src/resources/ai/openai/chat.ts +7 -2
- package/src/resources/ai/tools.ts +6 -6
- package/src/resources/calls/actions.ts +76 -15
- package/src/resources/calls/calls.ts +49 -9
- package/src/resources/dir/dir.ts +263 -32
- package/src/resources/dir/index.ts +6 -0
- package/src/resources/dir/phone-numbers.ts +8 -4
- package/src/resources/dir/references.ts +9 -6
- package/src/resources/enterprises/dir.ts +19 -1
- package/src/resources/enterprises/enterprises.ts +250 -23
- package/src/resources/enterprises/index.ts +5 -0
- package/src/resources/enterprises/reputation/loa.ts +73 -1
- package/src/resources/enterprises/verify-email.ts +117 -0
- package/src/resources/index.ts +20 -0
- package/src/resources/infringement-claims.ts +4 -0
- package/src/resources/llm-token-gateway/index.ts +4 -0
- package/src/resources/llm-token-gateway/llm-token-gateway.ts +19 -0
- package/src/resources/llm-token-gateway/usage.ts +336 -0
- package/src/resources/llm-token-gateway.ts +3 -0
- package/src/resources/meeting-sessions/meeting-sessions.ts +8 -9
- package/src/resources/porting-orders/phone-number-blocks.ts +9 -1
- package/src/resources/porting-orders/porting-orders.ts +9 -1
- package/src/resources/porting-phone-numbers.ts +9 -1
- package/src/resources/requirements.ts +2 -2
- package/src/resources/spend-limits.ts +428 -0
- package/src/resources/terms-of-service/agreements.ts +12 -0
- package/src/resources/terms-of-service/terms-of-service.ts +15 -0
- package/src/resources/text-to-speech/text-to-speech.ts +4 -2
- package/src/resources/webhooks.ts +495 -2
- package/src/resources/whatsapp/phone-numbers/calling-routing.ts +113 -0
- package/src/resources/whatsapp/phone-numbers/index.ts +7 -0
- package/src/resources/whatsapp/phone-numbers/phone-numbers.ts +18 -0
- 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
|
@@ -5,6 +5,8 @@ import * as ChatAPI from "../chat.mjs";
|
|
|
5
5
|
import * as ToolsAPI from "../tools.mjs";
|
|
6
6
|
import * as CanaryDeploysAPI from "./canary-deploys.mjs";
|
|
7
7
|
import { CanaryDeploy, CanaryDeployCreateParams, CanaryDeployResponse, CanaryDeployUpdateParams, CanaryDeploys, Clause, RolloutSlot, RuleInput, RuleOutput, Serve } from "./canary-deploys.mjs";
|
|
8
|
+
import * as DeletedAPI from "./deleted.mjs";
|
|
9
|
+
import { Deleted, DeletedAssistant, DeletedAssistantsDefaultFlatPagination, DeletedListParams } from "./deleted.mjs";
|
|
8
10
|
import * as InstructionsAPI from "./instructions.mjs";
|
|
9
11
|
import { InstructionEnhanceParams, InstructionEnhanceResponse, Instructions } from "./instructions.mjs";
|
|
10
12
|
import * as ScheduledEventsAPI from "./scheduled-events.mjs";
|
|
@@ -31,6 +33,7 @@ export declare class Assistants extends APIResource {
|
|
|
31
33
|
versions: VersionsAPI.Versions;
|
|
32
34
|
tags: TagsAPI.Tags;
|
|
33
35
|
instructions: InstructionsAPI.Instructions;
|
|
36
|
+
deleted: DeletedAPI.Deleted;
|
|
34
37
|
/**
|
|
35
38
|
* Retrieve a list of all AI Assistants configured by the user.
|
|
36
39
|
*
|
|
@@ -72,6 +75,20 @@ export declare class Assistants extends APIResource {
|
|
|
72
75
|
/**
|
|
73
76
|
* Delete an AI Assistant by `assistant_id`.
|
|
74
77
|
*
|
|
78
|
+
* By default this performs a soft delete: the assistant moves to the Recently
|
|
79
|
+
* Deleted list and stays restorable for 30 days, after which it is permanently
|
|
80
|
+
* deleted automatically. The assistant's versions and TeXML application are
|
|
81
|
+
* preserved during the retention window.
|
|
82
|
+
*
|
|
83
|
+
* Pass `hard_delete=true` to skip the retention window and permanently delete the
|
|
84
|
+
* assistant immediately. A hard delete erases the assistant and all of its
|
|
85
|
+
* versions, and deletes its TeXML application unless phone numbers are still
|
|
86
|
+
* assigned to it. It does not delete conversations, recordings, shared tools the
|
|
87
|
+
* assistant referenced, or knowledge-base embeddings.
|
|
88
|
+
*
|
|
89
|
+
* Deletion fails with `400` if other assistants reference this one through a
|
|
90
|
+
* handoff tool or a conversation-flow edge — remove those references first.
|
|
91
|
+
*
|
|
75
92
|
* @example
|
|
76
93
|
* ```ts
|
|
77
94
|
* const assistant = await client.ai.assistants.delete(
|
|
@@ -79,7 +96,7 @@ export declare class Assistants extends APIResource {
|
|
|
79
96
|
* );
|
|
80
97
|
* ```
|
|
81
98
|
*/
|
|
82
|
-
delete(assistantID: string, options?: RequestOptions): APIPromise<AssistantDeleteResponse>;
|
|
99
|
+
delete(assistantID: string, params?: AssistantDeleteParams | null | undefined, options?: RequestOptions): APIPromise<AssistantDeleteResponse>;
|
|
83
100
|
/**
|
|
84
101
|
* Retrieve an AI Assistant configuration by `assistant_id`.
|
|
85
102
|
*
|
|
@@ -172,6 +189,52 @@ export declare class Assistants extends APIResource {
|
|
|
172
189
|
* ```
|
|
173
190
|
*/
|
|
174
191
|
sendSMS(assistantID: string, params: AssistantSendSMSParams, options?: RequestOptions): APIPromise<AssistantSendSMSResponse>;
|
|
192
|
+
/**
|
|
193
|
+
* Start a WhatsApp conversation with a customer from the business side. This
|
|
194
|
+
* endpoint:
|
|
195
|
+
*
|
|
196
|
+
* 1. Validates that `from` is a WhatsApp number on your account whose messaging
|
|
197
|
+
* profile has this assistant configured
|
|
198
|
+
* 2. Creates a new `whatsapp_chat` conversation with the provided metadata
|
|
199
|
+
* 3. Asks the assistant to pick one of its approved WhatsApp templates and fill
|
|
200
|
+
* its variables from `content`
|
|
201
|
+
* 4. Sends the template from `from` to `to`
|
|
202
|
+
* 5. Returns the conversation ID and the message ID
|
|
203
|
+
*
|
|
204
|
+
* When the customer replies, the reply is routed to the same conversation and the
|
|
205
|
+
* assistant answers within the 24-hour customer service window. The assistant
|
|
206
|
+
* needs a `whatsapp_template` tool with at least one approved template, data
|
|
207
|
+
* retention enabled and PII redaction disabled.
|
|
208
|
+
*
|
|
209
|
+
* @example
|
|
210
|
+
* ```ts
|
|
211
|
+
* const response = await client.ai.assistants.whatsapp(
|
|
212
|
+
* 'assistant_id',
|
|
213
|
+
* {
|
|
214
|
+
* content:
|
|
215
|
+
* 'Send the login verification code 482913 to the customer.',
|
|
216
|
+
* from: '+13125550001',
|
|
217
|
+
* to: '+13125550002',
|
|
218
|
+
* conversation_metadata: { order_id: 'A1' },
|
|
219
|
+
* },
|
|
220
|
+
* );
|
|
221
|
+
* ```
|
|
222
|
+
*/
|
|
223
|
+
whatsapp(assistantID: string, params: AssistantWhatsappParams, options?: RequestOptions): APIPromise<AssistantWhatsappResponse>;
|
|
224
|
+
/**
|
|
225
|
+
* Restore a soft-deleted assistant from the Recently Deleted list.
|
|
226
|
+
*
|
|
227
|
+
* The assistant becomes fully active again with its versions and TeXML application
|
|
228
|
+
* as they were at deletion time. Restoring does not re-enable numbers or
|
|
229
|
+
* connections that were released separately after the deletion.
|
|
230
|
+
*
|
|
231
|
+
* @example
|
|
232
|
+
* ```ts
|
|
233
|
+
* const inferenceEmbedding =
|
|
234
|
+
* await client.ai.assistants.restore('assistant_id');
|
|
235
|
+
* ```
|
|
236
|
+
*/
|
|
237
|
+
restore(assistantID: string, options?: RequestOptions): APIPromise<InferenceEmbedding>;
|
|
175
238
|
}
|
|
176
239
|
/**
|
|
177
240
|
* Numeric expression: applies an arithmetic operator to two sub-expressions.
|
|
@@ -1125,7 +1188,7 @@ export interface ConversationFlow {
|
|
|
1125
1188
|
export interface ConversationFlowReq {
|
|
1126
1189
|
/**
|
|
1127
1190
|
* All nodes in the flow. Must contain `start_node_id`. Each node is a prompt node
|
|
1128
|
-
* (`type: prompt`)
|
|
1191
|
+
* (`type: prompt`), a tool node (`type: tool`), or a speak node (`type: speak`).
|
|
1129
1192
|
*/
|
|
1130
1193
|
nodes: Array<FlowNodeReq | ToolNodeReq | SpeakNodeReq>;
|
|
1131
1194
|
/**
|
|
@@ -1137,6 +1200,66 @@ export interface ConversationFlowReq {
|
|
|
1137
1200
|
*/
|
|
1138
1201
|
edges?: Array<FlowEdge>;
|
|
1139
1202
|
}
|
|
1203
|
+
/**
|
|
1204
|
+
* Splits the conversation between a frontend model that talks to the caller and a
|
|
1205
|
+
* backend model that does the work. On the GPT-Live route the frontend model
|
|
1206
|
+
* cannot call tools at all — when it needs something done it raises a delegation
|
|
1207
|
+
* and waits. On the chat completion route the frontend keeps a single `delegate`
|
|
1208
|
+
* tool that returns immediately, so the conversation carries on while the backend
|
|
1209
|
+
* works. Either way the backend's answer is spoken as commentary or kept as silent
|
|
1210
|
+
* context, depending on `speak_results`. Beta feature.
|
|
1211
|
+
*/
|
|
1212
|
+
export interface DelegationSettings {
|
|
1213
|
+
/**
|
|
1214
|
+
* Whether the assistant delegates work to a backend model. Defaults to `true`: a
|
|
1215
|
+
* GPT-Live assistant with delegation disabled can hold a conversation but can
|
|
1216
|
+
* never look anything up or run a tool.
|
|
1217
|
+
*/
|
|
1218
|
+
enabled?: boolean;
|
|
1219
|
+
/**
|
|
1220
|
+
* Run the backend on your own OpenAI-compatible endpoint instead of a
|
|
1221
|
+
* Telnyx-hosted model. As above, a raw `api_key` here is rejected — reference an
|
|
1222
|
+
* integration secret with `external_llm.llm_api_key_ref` instead.
|
|
1223
|
+
*/
|
|
1224
|
+
external_llm?: ExternalLlm;
|
|
1225
|
+
/**
|
|
1226
|
+
* Extra instructions for the backend model, in addition to the assistant's own.
|
|
1227
|
+
* Use this for the business rules the backend needs and the talking model does
|
|
1228
|
+
* not.
|
|
1229
|
+
*/
|
|
1230
|
+
instructions?: string;
|
|
1231
|
+
/**
|
|
1232
|
+
* Integration secret identifier for the backend model's API key. Required for
|
|
1233
|
+
* models from providers other than Telnyx, OpenAI and Anthropic. A raw `api_key`
|
|
1234
|
+
* is rejected rather than ignored, so that no plaintext credential is stored on
|
|
1235
|
+
* the assistant.
|
|
1236
|
+
*/
|
|
1237
|
+
llm_api_key_ref?: string;
|
|
1238
|
+
/**
|
|
1239
|
+
* Who answers a delegation. `telnyx` runs the backend model on Telnyx with the
|
|
1240
|
+
* assistant's own tools, MCP servers and observability. `client` relays the
|
|
1241
|
+
* delegation to a server you host over the WebSocket configured in
|
|
1242
|
+
* `websocket_settings`: Telnyx sends a `session.delegation.created` frame and
|
|
1243
|
+
* waits for your `session.delegation.completed` answer. That answer is text only,
|
|
1244
|
+
* since the socket offers no tool vocabulary. If no socket is connected the
|
|
1245
|
+
* delegation is refused and the assistant tells the caller it cannot look things
|
|
1246
|
+
* up right now. Defaults to `telnyx`.
|
|
1247
|
+
*/
|
|
1248
|
+
mode?: 'telnyx' | 'client';
|
|
1249
|
+
/**
|
|
1250
|
+
* The backend model that answers delegations. Must be a model available for AI
|
|
1251
|
+
* Assistants. When enabling `telnyx` delegation, explicitly set this field or
|
|
1252
|
+
* `external_llm.model`; a configuration without either backend model is rejected.
|
|
1253
|
+
* Only applies when `mode` is `telnyx`.
|
|
1254
|
+
*/
|
|
1255
|
+
model?: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* Whether the backend's answer is spoken to the caller. When `true` the result is
|
|
1258
|
+
* appended as commentary and paraphrased aloud; when `false` it is kept as silent
|
|
1259
|
+
* context that informs later answers without being read out. Defaults to `true`.
|
|
1260
|
+
*/
|
|
1261
|
+
speak_results?: boolean;
|
|
1262
|
+
}
|
|
1140
1263
|
/**
|
|
1141
1264
|
* If `telephony` is enabled, the assistant will be able to make and receive calls.
|
|
1142
1265
|
* If `messaging` is enabled, the assistant will be able to send and receive
|
|
@@ -1300,9 +1423,14 @@ export interface FallbackConfigReq {
|
|
|
1300
1423
|
* Directed transition from one node to a target, gated by a condition.
|
|
1301
1424
|
*
|
|
1302
1425
|
* The target is either another node in the same flow (`NodeTarget`) or a different
|
|
1303
|
-
* assistant (`AssistantTarget`). Multiple edges may share a `start_node_id
|
|
1304
|
-
*
|
|
1305
|
-
*
|
|
1426
|
+
* assistant (`AssistantTarget`). Multiple edges may share a `start_node_id`. On
|
|
1427
|
+
* calls, `expression` conditions are evaluated before the model turn and take
|
|
1428
|
+
* precedence over `llm` conditions regardless of declaration order, while `llm`
|
|
1429
|
+
* conditions are offered to the assistant's model as transition tools and fire
|
|
1430
|
+
* when the model selects one. On chat channels, an `expression` condition that is
|
|
1431
|
+
* true when the turn begins routes before the reply is generated; all conditioned
|
|
1432
|
+
* edges that remain are considered together in declaration order after the reply,
|
|
1433
|
+
* and the first true one wins.
|
|
1306
1434
|
*/
|
|
1307
1435
|
export interface FlowEdge {
|
|
1308
1436
|
/**
|
|
@@ -1326,15 +1454,22 @@ export interface FlowEdge {
|
|
|
1326
1454
|
}
|
|
1327
1455
|
export declare namespace FlowEdge {
|
|
1328
1456
|
/**
|
|
1329
|
-
* Edge condition
|
|
1457
|
+
* Edge condition routed by the assistant's LLM from a natural-language prompt.
|
|
1330
1458
|
*
|
|
1331
|
-
*
|
|
1332
|
-
*
|
|
1333
|
-
*
|
|
1459
|
+
* How the edge is decided depends on the channel. On calls, each outgoing `llm`
|
|
1460
|
+
* condition is offered to the assistant's model as a transition tool alongside the
|
|
1461
|
+
* assistant's tools, and the edge fires when the model selects it; the platform
|
|
1462
|
+
* does not evaluate the prompt itself, and instructions that forbid or discourage
|
|
1463
|
+
* tool calls can stop these edges from firing. On chat channels, the edge prompts
|
|
1464
|
+
* are evaluated in a separate model call after the reply, which does not use the
|
|
1465
|
+
* assistant's instructions. Use this for fuzzy intents that aren't expressible as
|
|
1466
|
+
* a deterministic expression (e.g. 'user wants to escalate to a human').
|
|
1334
1467
|
*/
|
|
1335
1468
|
interface LlmCondition {
|
|
1336
1469
|
/**
|
|
1337
|
-
* Natural-language criterion the
|
|
1470
|
+
* Natural-language criterion the model routes on. On calls this is offered to the
|
|
1471
|
+
* model as the transition tool's description; on chat channels it is judged as a
|
|
1472
|
+
* statement in the post-reply evaluation call.
|
|
1338
1473
|
*/
|
|
1339
1474
|
prompt: string;
|
|
1340
1475
|
type: 'llm';
|
|
@@ -1564,7 +1699,8 @@ export interface FlowNodeReq {
|
|
|
1564
1699
|
transcription?: TranscriptionSettings;
|
|
1565
1700
|
/**
|
|
1566
1701
|
* Node kind discriminator. `prompt` (default) is an LLM-driven step; `tool` is a
|
|
1567
|
-
* standalone tool execution (see `ToolNodeReq`
|
|
1702
|
+
* standalone tool execution and `speak` a scripted message (see `ToolNodeReq` /
|
|
1703
|
+
* `SpeakNodeReq`).
|
|
1568
1704
|
*/
|
|
1569
1705
|
type?: 'prompt';
|
|
1570
1706
|
/**
|
|
@@ -1625,6 +1761,16 @@ export interface InferenceEmbedding {
|
|
|
1625
1761
|
* Conversation flow as returned by the API.
|
|
1626
1762
|
*/
|
|
1627
1763
|
conversation_flow?: ConversationFlow;
|
|
1764
|
+
/**
|
|
1765
|
+
* Splits the conversation between a frontend model that talks to the caller and a
|
|
1766
|
+
* backend model that does the work. On the GPT-Live route the frontend model
|
|
1767
|
+
* cannot call tools at all — when it needs something done it raises a delegation
|
|
1768
|
+
* and waits. On the chat completion route the frontend keeps a single `delegate`
|
|
1769
|
+
* tool that returns immediately, so the conversation carries on while the backend
|
|
1770
|
+
* works. Either way the backend's answer is spoken as commentary or kept as silent
|
|
1771
|
+
* context, depending on `speak_results`. Beta feature.
|
|
1772
|
+
*/
|
|
1773
|
+
delegation_settings?: DelegationSettings;
|
|
1628
1774
|
description?: string;
|
|
1629
1775
|
/**
|
|
1630
1776
|
* Map of dynamic variables and their values
|
|
@@ -1740,6 +1886,14 @@ export interface InferenceEmbedding {
|
|
|
1740
1886
|
*/
|
|
1741
1887
|
version_name?: string;
|
|
1742
1888
|
voice_settings?: InferenceEmbeddingVoiceSettings;
|
|
1889
|
+
/**
|
|
1890
|
+
* Streams conversation and telephony events to a WebSocket server you host, and
|
|
1891
|
+
* accepts messages injected back into the conversation. Telnyx opens the
|
|
1892
|
+
* connection as a client, once per conversation. Delivery is best effort
|
|
1893
|
+
* throughout: while the connection is down events are dropped rather than queued,
|
|
1894
|
+
* and no socket failure is ever allowed to affect the call. Beta feature.
|
|
1895
|
+
*/
|
|
1896
|
+
websocket_settings?: WebsocketSettings;
|
|
1743
1897
|
/**
|
|
1744
1898
|
* Configuration settings for the assistant's web widget.
|
|
1745
1899
|
*/
|
|
@@ -1845,9 +1999,10 @@ export interface InferenceEmbeddingVoiceSettings {
|
|
|
1845
1999
|
*/
|
|
1846
2000
|
use_speaker_boost?: boolean;
|
|
1847
2001
|
/**
|
|
1848
|
-
* The speed of the voice in the range [0.
|
|
1849
|
-
* numbers make the voice faster, smaller numbers make it slower.
|
|
1850
|
-
*
|
|
2002
|
+
* The speed of the voice in the range [0.6, 1.5]. 1.0 is the default speed. Larger
|
|
2003
|
+
* numbers make the voice faster, smaller numbers make it slower. Applies to Telnyx
|
|
2004
|
+
* `Ultra` voices; values outside this range are rejected by the synthesis engine.
|
|
2005
|
+
* Soniox voices support a speed range of 0.7 to 1.3.
|
|
1851
2006
|
*/
|
|
1852
2007
|
voice_speed?: number;
|
|
1853
2008
|
}
|
|
@@ -2578,12 +2733,22 @@ export interface ToolNode {
|
|
|
2578
2733
|
/**
|
|
2579
2734
|
* ID of the single shared (org-level) tool this node executes. When the flow
|
|
2580
2735
|
* reaches this node the tool runs as a deliberate step (no LLM turn); its outgoing
|
|
2581
|
-
* `
|
|
2582
|
-
* conversation's dynamic variables by name — a dynamic variable
|
|
2583
|
-
* one of the tool's parameters supplies that argument.
|
|
2584
|
-
* org's shared tools on write.
|
|
2736
|
+
* `llm` / `expression` edges route the flow on the tool's outcome. Arguments are
|
|
2737
|
+
* filled from the conversation's dynamic variables by name — a dynamic variable
|
|
2738
|
+
* whose name matches one of the tool's parameters supplies that argument.
|
|
2739
|
+
* Cross-validated against the org's shared tools on write.
|
|
2585
2740
|
*/
|
|
2586
2741
|
shared_tool_id: string;
|
|
2742
|
+
/**
|
|
2743
|
+
* Optional message delivered to the user verbatim immediately before the tool
|
|
2744
|
+
* executes — an announcement such as 'One moment while I look that up.' No LLM
|
|
2745
|
+
* turn and no customer turn: the message is spoken/sent, then the tool runs, in
|
|
2746
|
+
* the same deterministic step. `{{variable}}` placeholders are interpolated from
|
|
2747
|
+
* the conversation's dynamic variables (unresolved → empty string); the tool's own
|
|
2748
|
+
* result is not yet available when the message is rendered. Omit for a silent tool
|
|
2749
|
+
* step.
|
|
2750
|
+
*/
|
|
2751
|
+
message?: string;
|
|
2587
2752
|
/**
|
|
2588
2753
|
* Optional human-readable label, displayed in authoring UIs.
|
|
2589
2754
|
*/
|
|
@@ -2610,8 +2775,10 @@ export interface ToolNode {
|
|
|
2610
2775
|
*
|
|
2611
2776
|
* Unlike a prompt node, a tool node has no instructions or model — it isn't an LLM
|
|
2612
2777
|
* turn. Reaching it deterministically runs one shared tool (arguments filled from
|
|
2613
|
-
* matching dynamic variables by name), then routes
|
|
2614
|
-
* `
|
|
2778
|
+
* matching dynamic variables by name), then routes via outgoing `llm` /
|
|
2779
|
+
* `expression` edges, with exactly one `default` fallback edge required when the
|
|
2780
|
+
* node has any outgoing edges (the tool's outcome is readable as
|
|
2781
|
+
* `telnyx_last_tool_status_code` in `expression` conditions).
|
|
2615
2782
|
*/
|
|
2616
2783
|
export interface ToolNodeReq {
|
|
2617
2784
|
/**
|
|
@@ -2621,12 +2788,22 @@ export interface ToolNodeReq {
|
|
|
2621
2788
|
/**
|
|
2622
2789
|
* ID of the single shared (org-level) tool this node executes. When the flow
|
|
2623
2790
|
* reaches this node the tool runs as a deliberate step (no LLM turn); its outgoing
|
|
2624
|
-
* `
|
|
2625
|
-
* conversation's dynamic variables by name — a dynamic variable
|
|
2626
|
-
* one of the tool's parameters supplies that argument.
|
|
2627
|
-
* org's shared tools on write.
|
|
2791
|
+
* `llm` / `expression` edges route the flow on the tool's outcome. Arguments are
|
|
2792
|
+
* filled from the conversation's dynamic variables by name — a dynamic variable
|
|
2793
|
+
* whose name matches one of the tool's parameters supplies that argument.
|
|
2794
|
+
* Cross-validated against the org's shared tools on write.
|
|
2628
2795
|
*/
|
|
2629
2796
|
shared_tool_id: string;
|
|
2797
|
+
/**
|
|
2798
|
+
* Optional message delivered to the user verbatim immediately before the tool
|
|
2799
|
+
* executes — an announcement such as 'One moment while I look that up.' No LLM
|
|
2800
|
+
* turn and no customer turn: the message is spoken/sent, then the tool runs, in
|
|
2801
|
+
* the same deterministic step. `{{variable}}` placeholders are interpolated from
|
|
2802
|
+
* the conversation's dynamic variables (unresolved → empty string); the tool's own
|
|
2803
|
+
* result is not yet available when the message is rendered. Omit for a silent tool
|
|
2804
|
+
* step.
|
|
2805
|
+
*/
|
|
2806
|
+
message?: string;
|
|
2630
2807
|
/**
|
|
2631
2808
|
* Optional human-readable label, displayed in authoring UIs.
|
|
2632
2809
|
*/
|
|
@@ -2901,9 +3078,9 @@ export interface VoiceSettings {
|
|
|
2901
3078
|
*/
|
|
2902
3079
|
use_speaker_boost?: boolean;
|
|
2903
3080
|
/**
|
|
2904
|
-
* The speed of the voice in the range [0.
|
|
2905
|
-
* numbers make the voice faster, smaller numbers make it slower.
|
|
2906
|
-
*
|
|
3081
|
+
* The speed of the voice in the range [0.6, 1.5]. 1.0 is the default speed. Larger
|
|
3082
|
+
* numbers make the voice faster, smaller numbers make it slower. Applies to Telnyx
|
|
3083
|
+
* `Ultra` voices; values outside this range are rejected by the synthesis engine.
|
|
2907
3084
|
*/
|
|
2908
3085
|
voice_speed?: number;
|
|
2909
3086
|
}
|
|
@@ -3078,6 +3255,32 @@ export declare namespace WebhookTool {
|
|
|
3078
3255
|
}
|
|
3079
3256
|
}
|
|
3080
3257
|
}
|
|
3258
|
+
/**
|
|
3259
|
+
* Streams conversation and telephony events to a WebSocket server you host, and
|
|
3260
|
+
* accepts messages injected back into the conversation. Telnyx opens the
|
|
3261
|
+
* connection as a client, once per conversation. Delivery is best effort
|
|
3262
|
+
* throughout: while the connection is down events are dropped rather than queued,
|
|
3263
|
+
* and no socket failure is ever allowed to affect the call. Beta feature.
|
|
3264
|
+
*/
|
|
3265
|
+
export interface WebsocketSettings {
|
|
3266
|
+
/**
|
|
3267
|
+
* Integration secret identifier whose value Telnyx sends as an
|
|
3268
|
+
* `Authorization: Bearer <value>` header on the upgrade request. Resolved on every
|
|
3269
|
+
* connection attempt, so a rotated secret is picked up by the next reconnect.
|
|
3270
|
+
*/
|
|
3271
|
+
auth_ref?: string;
|
|
3272
|
+
/**
|
|
3273
|
+
* Whether Telnyx opens a WebSocket to `url` for each of this assistant's
|
|
3274
|
+
* conversations. Defaults to `false`.
|
|
3275
|
+
*/
|
|
3276
|
+
enabled?: boolean;
|
|
3277
|
+
/**
|
|
3278
|
+
* The `ws://` or `wss://` endpoint Telnyx connects to. Required when `enabled` is
|
|
3279
|
+
* `true`. Must be externally reachable — localhost, private IP ranges and `.local`
|
|
3280
|
+
* domains are rejected.
|
|
3281
|
+
*/
|
|
3282
|
+
url?: string;
|
|
3283
|
+
}
|
|
3081
3284
|
/**
|
|
3082
3285
|
* Configuration settings for the assistant's web widget.
|
|
3083
3286
|
*/
|
|
@@ -3143,6 +3346,16 @@ export type AssistantGetTexmlResponse = string;
|
|
|
3143
3346
|
export interface AssistantSendSMSResponse {
|
|
3144
3347
|
conversation_id?: string;
|
|
3145
3348
|
}
|
|
3349
|
+
export interface AssistantWhatsappResponse {
|
|
3350
|
+
/**
|
|
3351
|
+
* ID of the conversation created for this WhatsApp chat.
|
|
3352
|
+
*/
|
|
3353
|
+
conversation_id: string;
|
|
3354
|
+
/**
|
|
3355
|
+
* ID of the WhatsApp template message that was sent.
|
|
3356
|
+
*/
|
|
3357
|
+
message_id: string;
|
|
3358
|
+
}
|
|
3146
3359
|
export interface AssistantCreateParams {
|
|
3147
3360
|
/**
|
|
3148
3361
|
* Body param: System instructions for the assistant. These may be templated with
|
|
@@ -3172,6 +3385,16 @@ export interface AssistantCreateParams {
|
|
|
3172
3385
|
* every edge's endpoints reference real nodes.
|
|
3173
3386
|
*/
|
|
3174
3387
|
conversation_flow?: ConversationFlowReq;
|
|
3388
|
+
/**
|
|
3389
|
+
* Body param: Splits the conversation between a frontend model that talks to the
|
|
3390
|
+
* caller and a backend model that does the work. On the GPT-Live route the
|
|
3391
|
+
* frontend model cannot call tools at all — when it needs something done it raises
|
|
3392
|
+
* a delegation and waits. On the chat completion route the frontend keeps a single
|
|
3393
|
+
* `delegate` tool that returns immediately, so the conversation carries on while
|
|
3394
|
+
* the backend works. Either way the backend's answer is spoken as commentary or
|
|
3395
|
+
* kept as silent context, depending on `speak_results`. Beta feature.
|
|
3396
|
+
*/
|
|
3397
|
+
delegation_settings?: DelegationSettings;
|
|
3175
3398
|
/**
|
|
3176
3399
|
* Body param
|
|
3177
3400
|
*/
|
|
@@ -3313,6 +3536,14 @@ export interface AssistantCreateParams {
|
|
|
3313
3536
|
* Body param
|
|
3314
3537
|
*/
|
|
3315
3538
|
voice_settings?: InferenceEmbeddingVoiceSettings;
|
|
3539
|
+
/**
|
|
3540
|
+
* Body param: Streams conversation and telephony events to a WebSocket server you
|
|
3541
|
+
* host, and accepts messages injected back into the conversation. Telnyx opens the
|
|
3542
|
+
* connection as a client, once per conversation. Delivery is best effort
|
|
3543
|
+
* throughout: while the connection is down events are dropped rather than queued,
|
|
3544
|
+
* and no socket failure is ever allowed to affect the call. Beta feature.
|
|
3545
|
+
*/
|
|
3546
|
+
websocket_settings?: WebsocketSettings;
|
|
3316
3547
|
/**
|
|
3317
3548
|
* Body param: Configuration settings for the assistant's web widget.
|
|
3318
3549
|
*/
|
|
@@ -3357,6 +3588,13 @@ export interface AssistantImportsParams {
|
|
|
3357
3588
|
*/
|
|
3358
3589
|
'Idempotency-Key'?: string;
|
|
3359
3590
|
}
|
|
3591
|
+
export interface AssistantDeleteParams {
|
|
3592
|
+
/**
|
|
3593
|
+
* Permanently delete the assistant immediately instead of soft-deleting it to the
|
|
3594
|
+
* Recently Deleted list, where it stays restorable for 30 days.
|
|
3595
|
+
*/
|
|
3596
|
+
hard_delete?: boolean;
|
|
3597
|
+
}
|
|
3360
3598
|
export interface AssistantRetrieveParams {
|
|
3361
3599
|
/**
|
|
3362
3600
|
* Filter results by call control id.
|
|
@@ -3396,6 +3634,16 @@ export interface AssistantUpdateParams {
|
|
|
3396
3634
|
* every edge's endpoints reference real nodes.
|
|
3397
3635
|
*/
|
|
3398
3636
|
conversation_flow?: ConversationFlowReq;
|
|
3637
|
+
/**
|
|
3638
|
+
* Splits the conversation between a frontend model that talks to the caller and a
|
|
3639
|
+
* backend model that does the work. On the GPT-Live route the frontend model
|
|
3640
|
+
* cannot call tools at all — when it needs something done it raises a delegation
|
|
3641
|
+
* and waits. On the chat completion route the frontend keeps a single `delegate`
|
|
3642
|
+
* tool that returns immediately, so the conversation carries on while the backend
|
|
3643
|
+
* works. Either way the backend's answer is spoken as commentary or kept as silent
|
|
3644
|
+
* context, depending on `speak_results`. Beta feature.
|
|
3645
|
+
*/
|
|
3646
|
+
delegation_settings?: DelegationSettings;
|
|
3399
3647
|
description?: string;
|
|
3400
3648
|
/**
|
|
3401
3649
|
* Map of dynamic variables and their default values
|
|
@@ -3529,6 +3777,14 @@ export interface AssistantUpdateParams {
|
|
|
3529
3777
|
*/
|
|
3530
3778
|
version_name?: string;
|
|
3531
3779
|
voice_settings?: InferenceEmbeddingVoiceSettings;
|
|
3780
|
+
/**
|
|
3781
|
+
* Streams conversation and telephony events to a WebSocket server you host, and
|
|
3782
|
+
* accepts messages injected back into the conversation. Telnyx opens the
|
|
3783
|
+
* connection as a client, once per conversation. Delivery is best effort
|
|
3784
|
+
* throughout: while the connection is down events are dropped rather than queued,
|
|
3785
|
+
* and no socket failure is ever allowed to affect the call. Beta feature.
|
|
3786
|
+
*/
|
|
3787
|
+
websocket_settings?: WebsocketSettings;
|
|
3532
3788
|
/**
|
|
3533
3789
|
* Configuration settings for the assistant's web widget.
|
|
3534
3790
|
*/
|
|
@@ -3604,8 +3860,43 @@ export interface AssistantSendSMSParams {
|
|
|
3604
3860
|
*/
|
|
3605
3861
|
'Idempotency-Key'?: string;
|
|
3606
3862
|
}
|
|
3863
|
+
export interface AssistantWhatsappParams {
|
|
3864
|
+
/**
|
|
3865
|
+
* Body param: Instruction for the assistant, including the values for the template
|
|
3866
|
+
* variables, e.g. `Send the login verification code 482913 to the customer.`
|
|
3867
|
+
*/
|
|
3868
|
+
content: string;
|
|
3869
|
+
/**
|
|
3870
|
+
* Body param: WhatsApp number on your account to send from, in E.164 format. Its
|
|
3871
|
+
* messaging profile must have this assistant configured.
|
|
3872
|
+
*/
|
|
3873
|
+
from: string;
|
|
3874
|
+
/**
|
|
3875
|
+
* Body param: Customer to message, as an E.164 phone number or a WhatsApp
|
|
3876
|
+
* business-scoped user ID (BSUID).
|
|
3877
|
+
*/
|
|
3878
|
+
to: string;
|
|
3879
|
+
/**
|
|
3880
|
+
* Body param: Metadata stored on the conversation. Keys starting with `telnyx_`
|
|
3881
|
+
* and the `assistant_id` key are reserved.
|
|
3882
|
+
*/
|
|
3883
|
+
conversation_metadata?: {
|
|
3884
|
+
[key: string]: string | number | boolean;
|
|
3885
|
+
};
|
|
3886
|
+
/**
|
|
3887
|
+
* Header param: Optional opaque, unquoted key for safely retrying the same logical
|
|
3888
|
+
* request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
|
|
3889
|
+
* Generate a unique UUID v4 for each operation and reuse it only when retrying
|
|
3890
|
+
* that operation with the same request. Invalid headers—including duplicate,
|
|
3891
|
+
* empty, malformed, or overlong values—return 400 with error code 10015. A request
|
|
3892
|
+
* already in progress with the same key returns 409; reusing the key with a
|
|
3893
|
+
* different request returns 422. Only successful responses are replayed, for up to
|
|
3894
|
+
* 24 hours. Do not include sensitive data in the key.
|
|
3895
|
+
*/
|
|
3896
|
+
'Idempotency-Key'?: string;
|
|
3897
|
+
}
|
|
3607
3898
|
export declare namespace Assistants {
|
|
3608
|
-
export { type ArithmeticExpression as ArithmeticExpression, type Assistant as Assistant, type AssistantA2AAgent as AssistantA2AAgent, type AssistantIntegration as AssistantIntegration, type AssistantMcpServer as AssistantMcpServer, type AssistantTool as AssistantTool, type AssistantsList as AssistantsList, type AudioVisualizerConfig as AudioVisualizerConfig, type AuthenticationMethod as AuthenticationMethod, type BooleanOpExpression as BooleanOpExpression, type ComparisonExpression as ComparisonExpression, type ConversationFlow as ConversationFlow, type ConversationFlowReq as ConversationFlowReq, type EnabledFeatures as EnabledFeatures, type Expression as Expression, type ExternalLlm as ExternalLlm, type ExternalLlmReq as ExternalLlmReq, type FallbackConfig as FallbackConfig, type FallbackConfigReq as FallbackConfigReq, type FlowEdge as FlowEdge, type FlowNode as FlowNode, type FlowNodeReq as FlowNodeReq, type HangupTool as HangupTool, type HangupToolParams as HangupToolParams, type ImportMetadata as ImportMetadata, type InferenceEmbedding as InferenceEmbedding, type InferenceEmbeddingInterruptionSettings as InferenceEmbeddingInterruptionSettings, type InferenceEmbeddingVoiceSettings as InferenceEmbeddingVoiceSettings, type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams, type InsightSettings as InsightSettings, type MessagingSettings as MessagingSettings, type NodePosition as NodePosition, type Observability as Observability, type ObservabilityReq as ObservabilityReq, type ObservabilityStatus as ObservabilityStatus, type PostConversationSettings as PostConversationSettings, type PostConversationSettingsReq as PostConversationSettingsReq, type PrivacySettings as PrivacySettings, type PromptSyncStatus as PromptSyncStatus, type RetrievalTool as RetrievalTool, type SpeakNode as SpeakNode, type SpeakNodeReq as SpeakNodeReq, type StartSpeakingPlan as StartSpeakingPlan, type TelephonySettings as TelephonySettings, type ToolNode as ToolNode, type ToolNodeReq as ToolNodeReq, type TranscriptionEndpointingPlan as TranscriptionEndpointingPlan, 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 AssistantImportsParams as AssistantImportsParams, type AssistantRetrieveParams as AssistantRetrieveParams, type AssistantUpdateParams as AssistantUpdateParams, type AssistantChatParams as AssistantChatParams, type AssistantCloneParams as AssistantCloneParams, type AssistantSendSMSParams as AssistantSendSMSParams, };
|
|
3899
|
+
export { type ArithmeticExpression as ArithmeticExpression, type Assistant as Assistant, type AssistantA2AAgent as AssistantA2AAgent, type AssistantIntegration as AssistantIntegration, type AssistantMcpServer as AssistantMcpServer, type AssistantTool as AssistantTool, type AssistantsList as AssistantsList, type AudioVisualizerConfig as AudioVisualizerConfig, type AuthenticationMethod as AuthenticationMethod, type BooleanOpExpression as BooleanOpExpression, type ComparisonExpression as ComparisonExpression, type ConversationFlow as ConversationFlow, type ConversationFlowReq as ConversationFlowReq, type DelegationSettings as DelegationSettings, type EnabledFeatures as EnabledFeatures, type Expression as Expression, type ExternalLlm as ExternalLlm, type ExternalLlmReq as ExternalLlmReq, type FallbackConfig as FallbackConfig, type FallbackConfigReq as FallbackConfigReq, type FlowEdge as FlowEdge, type FlowNode as FlowNode, type FlowNodeReq as FlowNodeReq, type HangupTool as HangupTool, type HangupToolParams as HangupToolParams, type ImportMetadata as ImportMetadata, type InferenceEmbedding as InferenceEmbedding, type InferenceEmbeddingInterruptionSettings as InferenceEmbeddingInterruptionSettings, type InferenceEmbeddingVoiceSettings as InferenceEmbeddingVoiceSettings, type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams, type InsightSettings as InsightSettings, type MessagingSettings as MessagingSettings, type NodePosition as NodePosition, type Observability as Observability, type ObservabilityReq as ObservabilityReq, type ObservabilityStatus as ObservabilityStatus, type PostConversationSettings as PostConversationSettings, type PostConversationSettingsReq as PostConversationSettingsReq, type PrivacySettings as PrivacySettings, type PromptSyncStatus as PromptSyncStatus, type RetrievalTool as RetrievalTool, type SpeakNode as SpeakNode, type SpeakNodeReq as SpeakNodeReq, type StartSpeakingPlan as StartSpeakingPlan, type TelephonySettings as TelephonySettings, type ToolNode as ToolNode, type ToolNodeReq as ToolNodeReq, type TranscriptionEndpointingPlan as TranscriptionEndpointingPlan, type TranscriptionSettings as TranscriptionSettings, type TranscriptionSettingsConfig as TranscriptionSettingsConfig, type TransferTool as TransferTool, type VoiceSettings as VoiceSettings, type WebhookTool as WebhookTool, type WebsocketSettings as WebsocketSettings, type WidgetSettings as WidgetSettings, type AssistantDeleteResponse as AssistantDeleteResponse, type AssistantChatResponse as AssistantChatResponse, type AssistantGetTexmlResponse as AssistantGetTexmlResponse, type AssistantSendSMSResponse as AssistantSendSMSResponse, type AssistantWhatsappResponse as AssistantWhatsappResponse, type AssistantCreateParams as AssistantCreateParams, type AssistantImportsParams as AssistantImportsParams, type AssistantDeleteParams as AssistantDeleteParams, type AssistantRetrieveParams as AssistantRetrieveParams, type AssistantUpdateParams as AssistantUpdateParams, type AssistantChatParams as AssistantChatParams, type AssistantCloneParams as AssistantCloneParams, type AssistantSendSMSParams as AssistantSendSMSParams, type AssistantWhatsappParams as AssistantWhatsappParams, };
|
|
3609
3900
|
export { Tests as Tests, type AssistantTest as AssistantTest, type TelnyxConversationChannel as TelnyxConversationChannel, type AssistantTestsDefaultFlatPagination as AssistantTestsDefaultFlatPagination, type TestListParams as TestListParams, type TestCreateParams as TestCreateParams, type TestUpdateParams as TestUpdateParams, };
|
|
3610
3901
|
export { CanaryDeploys as CanaryDeploys, type CanaryDeploy as CanaryDeploy, type CanaryDeployResponse as CanaryDeployResponse, type Clause as Clause, type RolloutSlot as RolloutSlot, type RuleInput as RuleInput, type RuleOutput as RuleOutput, type Serve as Serve, type CanaryDeployCreateParams as CanaryDeployCreateParams, type CanaryDeployUpdateParams as CanaryDeployUpdateParams, };
|
|
3611
3902
|
export { ScheduledEvents as ScheduledEvents, type ConversationChannelType as ConversationChannelType, type EventStatus as EventStatus, type ScheduledCallSettings as ScheduledCallSettings, type ScheduledEventResponse as ScheduledEventResponse, type ScheduledPhoneCallEventResponse as ScheduledPhoneCallEventResponse, type ScheduledSMSEventResponse as ScheduledSMSEventResponse, type ScheduledEventListResponse as ScheduledEventListResponse, type ScheduledEventListResponsesDefaultFlatPagination as ScheduledEventListResponsesDefaultFlatPagination, type ScheduledEventListParams as ScheduledEventListParams, type ScheduledEventCreateParams as ScheduledEventCreateParams, type ScheduledEventDeleteParams as ScheduledEventDeleteParams, type ScheduledEventRetrieveParams as ScheduledEventRetrieveParams, };
|
|
@@ -3613,5 +3904,6 @@ export declare namespace Assistants {
|
|
|
3613
3904
|
export { Versions as Versions, type UpdateAssistant as UpdateAssistant, type VersionDeleteParams as VersionDeleteParams, type VersionRetrieveParams as VersionRetrieveParams, type VersionUpdateParams as VersionUpdateParams, type VersionPromoteParams as VersionPromoteParams, };
|
|
3614
3905
|
export { Tags as Tags, type TagsResponse as TagsResponse, type TagAddParams as TagAddParams, type TagRemoveParams as TagRemoveParams, };
|
|
3615
3906
|
export { Instructions as Instructions, type InstructionEnhanceResponse as InstructionEnhanceResponse, type InstructionEnhanceParams as InstructionEnhanceParams, };
|
|
3907
|
+
export { Deleted as Deleted, type DeletedAssistant as DeletedAssistant, type DeletedAssistantsDefaultFlatPagination as DeletedAssistantsDefaultFlatPagination, type DeletedListParams as DeletedListParams, };
|
|
3616
3908
|
}
|
|
3617
3909
|
//# sourceMappingURL=assistants.d.mts.map
|