@talqing/sdk 0.4.5 → 0.6.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/README.md +15 -12
- package/dist/cjs/gen/index.d.ts +1 -1
- package/dist/cjs/gen/index.d.ts.map +1 -1
- package/dist/cjs/gen/sdk.gen.d.ts +334 -44
- package/dist/cjs/gen/sdk.gen.d.ts.map +1 -1
- package/dist/cjs/gen/sdk.gen.js +719 -68
- package/dist/cjs/gen/sdk.gen.js.map +1 -1
- package/dist/cjs/gen/types.gen.d.ts +5009 -2767
- package/dist/cjs/gen/types.gen.d.ts.map +1 -1
- package/dist/esm/gen/index.d.ts +1 -1
- package/dist/esm/gen/index.d.ts.map +1 -1
- package/dist/esm/gen/sdk.gen.d.ts +334 -44
- package/dist/esm/gen/sdk.gen.d.ts.map +1 -1
- package/dist/esm/gen/sdk.gen.js +708 -66
- package/dist/esm/gen/sdk.gen.js.map +1 -1
- package/dist/esm/gen/types.gen.d.ts +5009 -2767
- package/dist/esm/gen/types.gen.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/gen/index.ts +1 -1
- package/src/gen/sdk.gen.ts +842 -78
- package/src/gen/types.gen.ts +5254 -2847
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type ServerSentEventsResult, type TDataShape } from './client/index.js';
|
|
2
|
-
import type { AddRecipientsRequest, AddVoiceRequest, AgentsCreateErrors, AgentsCreateResults, AgentsDeleteErrors, AgentsDeleteResults, AgentsGetErrors, AgentsGetResults, AgentsListErrors, AgentsListResults, AgentsPublishErrors, AgentsPublishResults, AgentsUpdateErrors, AgentsUpdateResults, AgentsValidateErrors, AgentsValidateResults, AgentsVersionsGetErrors, AgentsVersionsGetResults, AgentsVersionsRollbackErrors, AgentsVersionsRollbackResults, AssignPhoneNumberRequest, BackfillAnalysisRequest, BillingCreditsCheckoutErrors, BillingCreditsCheckoutResults, BillingCreditsGetErrors, BillingCreditsGetResults, BillingCreditsLedgerErrors, BillingCreditsLedgerResults, BuildKBRequest, CallsAnalysisBackfillErrors, CallsAnalysisBackfillResults, CallsAnalysisPreviewErrors, CallsAnalysisPreviewResults, CallsBatchesCancelErrors, CallsBatchesCancelResults, CallsBatchesCreateErrors, CallsBatchesCreateResults, CallsBatchesGetErrors, CallsBatchesGetResults, CallsBatchesListErrors, CallsBatchesListResults, CallsBatchesPauseErrors, CallsBatchesPauseResults, CallsBatchesRecipientsAddErrors, CallsBatchesRecipientsAddResults, CallsBatchesRecipientsListErrors, CallsBatchesRecipientsListResults, CallsBatchesResumeErrors, CallsBatchesResumeResults, CallsBatchesUpdateErrors, CallsBatchesUpdateResults, CallsDeleteErrors, CallsDeleteResults, CallsGetErrors, CallsGetResults, CallsListErrors, CallsListResults, CallsOutboundErrors, CallsOutboundResults, CallsRecordingDeleteErrors, CallsRecordingDeleteResults, CallsRecordingGetErrors, CallsRecordingGetResults, CallsScreenRecordingGetErrors, CallsScreenRecordingGetResults, CallsStatsErrors, CallsStatsResults, CallsTokenErrors, CallsTokenResults, CatalogAvatarsListErrors, CatalogAvatarsListResults, CatalogGetErrors, CatalogGetResults, CatalogModelsHostsErrors, CatalogModelsHostsResults, CatalogModelsSearchErrors, CatalogModelsSearchResults, CatalogVoicesElevenlabsAddErrors, CatalogVoicesElevenlabsAddResults, CatalogVoicesElevenlabsSettingsErrors, CatalogVoicesElevenlabsSettingsResults, CatalogVoicesListErrors, CatalogVoicesListResults, ConversationsCreateErrors, ConversationsCreateResults, ConversationsEventsResult, ConversationsEventsResults, ConversationsGetErrors, ConversationsGetResults, ConversationsItemsListErrors, ConversationsItemsListResults, ConversationsListErrors, ConversationsListResults, ConversationsMessagesCreateErrors, ConversationsMessagesCreateResults, ConversationsSessionsListErrors, ConversationsSessionsListResults, ConversationsSnapshotErrors, ConversationsSnapshotResults, ConversationsUpdateErrors, ConversationsUpdateResults, CopilotAgentsSendErrors, CopilotAgentsSendResults, CopilotAgentsStreamResult, CopilotAgentsStreamResults, CopilotKnowledgeSendErrors, CopilotKnowledgeSendResults, CopilotKnowledgeStreamResult, CopilotKnowledgeStreamResults, CopilotTasksSendErrors, CopilotTasksSendResults, CopilotTasksStreamResult, CopilotTasksStreamResults, CopilotToolsSendErrors, CopilotToolsSendResults, CopilotToolsStreamResult, CopilotToolsStreamResults, CreateAgentRequest, CreateCallBatchRequest, CreateEmailBatchRequest, CreateEmailSendRequest, CreateIntegrationRequest, CreateIntegrationTriggerRequest, CreateKBRequest, CreateSecretRequest, CreateStreamConnectionRequest, CreateTaskRequest, CreateTelephonyAccountRequest, CreateTextConversationRequest, CreateToolRequest, CreateWebhookRequest, CreditCheckoutRequest, EmailBatchesCancelErrors, EmailBatchesCancelResults, EmailBatchesCreateErrors, EmailBatchesCreateResults, EmailBatchesGetErrors, EmailBatchesGetResults, EmailBatchesListErrors, EmailBatchesListResults, EmailBatchesPauseErrors, EmailBatchesPauseResults, EmailBatchesRecipientsListErrors, EmailBatchesRecipientsListResults, EmailBatchesRecipientsRedraftErrors, EmailBatchesRecipientsRedraftResults, EmailBatchesRecipientsRestoreErrors, EmailBatchesRecipientsRestoreResults, EmailBatchesRecipientsSkipErrors, EmailBatchesRecipientsSkipResults, EmailBatchesRecipientsUpdateErrors, EmailBatchesRecipientsUpdateResults, EmailBatchesResumeErrors, EmailBatchesResumeResults, EmailBatchesSendsCancelErrors, EmailBatchesSendsCancelResults, EmailBatchesSendsCreateErrors, EmailBatchesSendsCreateResults, EmailBatchesSendsGetErrors, EmailBatchesSendsGetResults, EmailBatchesSendsListErrors, EmailBatchesSendsListResults, EmailBatchesSendsPauseErrors, EmailBatchesSendsPauseResults, EmailBatchesSendsResumeErrors, EmailBatchesSendsResumeResults, EmailBatchesSendsUpdateErrors, EmailBatchesSendsUpdateResults, EmailBatchesUpdateErrors, EmailBatchesUpdateResults, EmailSendersListErrors, EmailSendersListResults, HealthErrors, HealthResults, ImportPhoneNumbersRequest, IntegrationsCatalogErrors, IntegrationsCatalogResults, IntegrationsCreateErrors, IntegrationsCreateResults, IntegrationsDeleteErrors, IntegrationsDeleteResults, IntegrationsGetErrors, IntegrationsGetResults, IntegrationsListErrors, IntegrationsListResults, IntegrationsMcpToolsListErrors, IntegrationsMcpToolsListResults, IntegrationsTriggersCreateErrors, IntegrationsTriggersCreateResults, IntegrationsTriggersDeleteErrors, IntegrationsTriggersDeleteResults, IntegrationsTriggersListErrors, IntegrationsTriggersListResults, IntegrationsTriggersUpdateErrors, IntegrationsTriggersUpdateResults, IntegrationsUpdateErrors, IntegrationsUpdateResults, KnowledgeBuildErrors, KnowledgeBuildResults, KnowledgeCreateErrors, KnowledgeCreateResults, KnowledgeDeleteErrors, KnowledgeDeleteResults, KnowledgeEventsResult, KnowledgeEventsResults, KnowledgeGetErrors, KnowledgeGetResults, KnowledgeListErrors, KnowledgeListResults, KnowledgeNodesDeleteErrors, KnowledgeNodesDeleteResults, KnowledgeNodesGetErrors, KnowledgeNodesGetResults, KnowledgeNodesUpdateErrors, KnowledgeNodesUpdateResults, KnowledgePagesListErrors, KnowledgePagesListResults, KnowledgePromptErrors, KnowledgePromptResults, KnowledgeRegenerateTocErrors, KnowledgeRegenerateTocResults, ObservabilityGetErrors, ObservabilityGetResults, OutboundCallRequest, PatchCallBatchRequest, PatchConversationRequest, PatchEmailBatchRequest, PatchEmailRecipientRequest, PatchEmailSendRequest, PatchIntegrationRequest, PatchIntegrationTriggerRequest, PatchNodeRequest, PatchPhoneNumberRequest, PatchStreamConnectionRequest, PatchTaskRequest, PatchTelephonyAccountRequest, PatchToolRequest, PatchWebhookRequest, PreviewAnalysisRequest, ProviderKeysDeleteErrors, ProviderKeysDeleteResults, ProviderKeysListErrors, ProviderKeysListResults, ProviderKeysSetErrors, ProviderKeysSetResults, PublishToolRequest, RedraftRequest, RunTaskRequest, RunToolRequest, SchemasFunctionsGetErrors, SchemasFunctionsGetResults, SchemasGetErrors, SchemasGetResults, SecretsCreateErrors, SecretsCreateResults, SecretsDeleteErrors, SecretsDeleteResults, SecretsListErrors, SecretsListResults, SelectRecipientsRequest, SendMessageRequest, SetProviderKeyRequest, TasksCreateErrors, TasksCreateResults, TasksDeleteErrors, TasksDeleteResults, TasksGetErrors, TasksGetResults, TasksListErrors, TasksListResults, TasksPublishErrors, TasksPublishResults, TasksRunsCreateErrors, TasksRunsCreateResults, TasksRunsGetErrors, TasksRunsGetResults, TasksRunsListErrors, TasksRunsListResults, TasksUpdateErrors, TasksUpdateResults, TasksValidateErrors, TasksValidateResults, TasksVersionsGetErrors, TasksVersionsGetResults, TasksVersionsRollbackErrors, TasksVersionsRollbackResults, TelephonyAccountsCreateErrors, TelephonyAccountsCreateResults, TelephonyAccountsDeleteErrors, TelephonyAccountsDeleteResults, TelephonyAccountsGetErrors, TelephonyAccountsGetResults, TelephonyAccountsListErrors, TelephonyAccountsListResults, TelephonyAccountsProvisionErrors, TelephonyAccountsProvisionResults, TelephonyAccountsRemoteNumbersErrors, TelephonyAccountsRemoteNumbersResults, TelephonyAccountsUpdateErrors, TelephonyAccountsUpdateResults, TelephonyPhoneNumbersAssignErrors, TelephonyPhoneNumbersAssignResults, TelephonyPhoneNumbersGetErrors, TelephonyPhoneNumbersGetResults, TelephonyPhoneNumbersImportErrors, TelephonyPhoneNumbersImportResults, TelephonyPhoneNumbersListErrors, TelephonyPhoneNumbersListResults, TelephonyPhoneNumbersProvisionErrors, TelephonyPhoneNumbersProvisionResults, TelephonyPhoneNumbersUnassignErrors, TelephonyPhoneNumbersUnassignResults, TelephonyPhoneNumbersUpdateErrors, TelephonyPhoneNumbersUpdateResults, TelephonyProvidersListErrors, TelephonyProvidersListResults, TelephonyStreamsCreateErrors, TelephonyStreamsCreateResults, TelephonyStreamsDeleteErrors, TelephonyStreamsDeleteResults, TelephonyStreamsGetErrors, TelephonyStreamsGetResults, TelephonyStreamsListErrors, TelephonyStreamsListResults, TelephonyStreamsUpdateErrors, TelephonyStreamsUpdateResults, TextMessageRequest, TokenRequest, ToolsCreateErrors, ToolsCreateResults, ToolsDeleteErrors, ToolsDeleteResults, ToolsGetErrors, ToolsGetResults, ToolsListErrors, ToolsListResults, ToolsPublishErrors, ToolsPublishResults, ToolsRunErrors, ToolsRunResults, ToolsUpdateErrors, ToolsUpdateResults, ToolsValidateErrors, ToolsValidateResults, ToolsVersionsGetErrors, ToolsVersionsGetResults, ToolsVersionsRollbackErrors, ToolsVersionsRollbackResults, UpdateAgentRequest, WebhooksCreateErrors, WebhooksCreateResults, WebhooksDeleteErrors, WebhooksDeleteResults, WebhooksDeliveriesErrors, WebhooksDeliveriesResults, WebhooksEventTypesErrors, WebhooksEventTypesResults, WebhooksListErrors, WebhooksListResults, WebhooksRotateSecretErrors, WebhooksRotateSecretResults, WebhooksTestErrors, WebhooksTestResults, WebhooksUpdateErrors, WebhooksUpdateResults } from './types.gen.js';
|
|
2
|
+
import type { AddRecipientsRequest, AddVoiceRequest, AgentsCreateErrors, AgentsCreateResults, AgentsDeleteErrors, AgentsDeleteResults, AgentsGetErrors, AgentsGetResults, AgentsListErrors, AgentsListResults, AgentsPublishErrors, AgentsPublishResults, AgentsUpdateErrors, AgentsUpdateResults, AgentsValidateErrors, AgentsValidateResults, AgentsVersionsGetErrors, AgentsVersionsGetResults, AgentsVersionsRollbackErrors, AgentsVersionsRollbackResults, AssignPhoneNumberRequest, BackfillAnalysisRequest, BillingCreditsCheckoutErrors, BillingCreditsCheckoutResults, BillingCreditsGetErrors, BillingCreditsGetResults, BillingCreditsLedgerErrors, BillingCreditsLedgerResults, BuildKBRequest, CallsAnalysisBackfillErrors, CallsAnalysisBackfillResults, CallsAnalysisPreviewErrors, CallsAnalysisPreviewResults, CallsBatchesCancelErrors, CallsBatchesCancelResults, CallsBatchesCreateErrors, CallsBatchesCreateResults, CallsBatchesDeleteErrors, CallsBatchesDeleteResults, CallsBatchesGetErrors, CallsBatchesGetResults, CallsBatchesListErrors, CallsBatchesListResults, CallsBatchesPauseErrors, CallsBatchesPauseResults, CallsBatchesRecipientsAddErrors, CallsBatchesRecipientsAddResults, CallsBatchesRecipientsListErrors, CallsBatchesRecipientsListResults, CallsBatchesResumeErrors, CallsBatchesResumeResults, CallsBatchesUpdateErrors, CallsBatchesUpdateResults, CallsDeleteErrors, CallsDeleteResults, CallsGetErrors, CallsGetResults, CallsListErrors, CallsListResults, CallsOutboundErrors, CallsOutboundResults, CallsRecordingDeleteErrors, CallsRecordingDeleteResults, CallsRecordingGetErrors, CallsRecordingGetResults, CallsScreenRecordingGetErrors, CallsScreenRecordingGetResults, CallsStatsErrors, CallsStatsResults, CallsTokenErrors, CallsTokenResults, CatalogAvatarsListErrors, CatalogAvatarsListResults, CatalogGetErrors, CatalogGetResults, CatalogModelsHostsErrors, CatalogModelsHostsResults, CatalogModelsSearchErrors, CatalogModelsSearchResults, CatalogVoicesElevenlabsAddErrors, CatalogVoicesElevenlabsAddResults, CatalogVoicesElevenlabsSettingsErrors, CatalogVoicesElevenlabsSettingsResults, CatalogVoicesListErrors, CatalogVoicesListResults, ChatMessageRequest, ChatsAnalysisPreviewErrors, ChatsAnalysisPreviewResults, ChatsAnalysisRerunErrors, ChatsAnalysisRerunResults, ChatsCreateErrors, ChatsCreateResults, ChatsDeleteErrors, ChatsDeleteResults, ChatsDetailErrors, ChatsDetailResults, ChatsEndErrors, ChatsEndResults, ChatsGetErrors, ChatsGetResults, ChatsItemsListErrors, ChatsItemsListResults, ChatsListErrors, ChatsListResults, ChatsMessagesCreateErrors, ChatsMessagesCreateResults, ChatsTokensCreateErrors, ChatsTokensCreateResults, ConversationsEventsResult, ConversationsEventsResults, ConversationsGetErrors, ConversationsGetResults, ConversationsItemsListErrors, ConversationsItemsListResults, ConversationsListErrors, ConversationsListResults, ConversationsSessionsListErrors, ConversationsSessionsListResults, ConversationsSnapshotErrors, ConversationsSnapshotResults, ConversationsTraceErrors, ConversationsTraceResults, ConversationsUpdateErrors, ConversationsUpdateResults, CopilotAgentsSendErrors, CopilotAgentsSendResults, CopilotAgentsStreamResult, CopilotAgentsStreamResults, CopilotKnowledgeSendErrors, CopilotKnowledgeSendResults, CopilotKnowledgeStreamResult, CopilotKnowledgeStreamResults, CopilotTasksSendErrors, CopilotTasksSendResults, CopilotTasksStreamResult, CopilotTasksStreamResults, CopilotToolsSendErrors, CopilotToolsSendResults, CopilotToolsStreamResult, CopilotToolsStreamResults, CreateAgentRequest, CreateCallBatchRequest, CreateChatRequest, CreateEmailBatchRequest, CreateEmailSendRequest, CreateIntegrationRequest, CreateIntegrationTriggerRequest, CreateKBRequest, CreateSecretRequest, CreateStreamConnectionRequest, CreateTaskRequest, CreateTelephonyAccountRequest, CreateToolRequest, CreateWebhookRequest, CreateWhatsAppBatchRequest, CreditCheckoutRequest, EmailBatchesCancelErrors, EmailBatchesCancelResults, EmailBatchesCreateErrors, EmailBatchesCreateResults, EmailBatchesDeleteErrors, EmailBatchesDeleteResults, EmailBatchesGetErrors, EmailBatchesGetResults, EmailBatchesListErrors, EmailBatchesListResults, EmailBatchesPauseErrors, EmailBatchesPauseResults, EmailBatchesRecipientsListErrors, EmailBatchesRecipientsListResults, EmailBatchesRecipientsRedraftErrors, EmailBatchesRecipientsRedraftResults, EmailBatchesRecipientsRestoreErrors, EmailBatchesRecipientsRestoreResults, EmailBatchesRecipientsSkipErrors, EmailBatchesRecipientsSkipResults, EmailBatchesRecipientsUpdateErrors, EmailBatchesRecipientsUpdateResults, EmailBatchesResumeErrors, EmailBatchesResumeResults, EmailBatchesSendsCancelErrors, EmailBatchesSendsCancelResults, EmailBatchesSendsCreateErrors, EmailBatchesSendsCreateResults, EmailBatchesSendsGetErrors, EmailBatchesSendsGetResults, EmailBatchesSendsListErrors, EmailBatchesSendsListResults, EmailBatchesSendsPauseErrors, EmailBatchesSendsPauseResults, EmailBatchesSendsResumeErrors, EmailBatchesSendsResumeResults, EmailBatchesSendsUpdateErrors, EmailBatchesSendsUpdateResults, EmailBatchesUpdateErrors, EmailBatchesUpdateResults, EmailSendersListErrors, EmailSendersListResults, HealthErrors, HealthResults, ImportPhoneNumbersRequest, IntegrationsCatalogErrors, IntegrationsCatalogResults, IntegrationsCreateErrors, IntegrationsCreateResults, IntegrationsDeleteErrors, IntegrationsDeleteResults, IntegrationsGetErrors, IntegrationsGetResults, IntegrationsListErrors, IntegrationsListResults, IntegrationsMcpToolsListErrors, IntegrationsMcpToolsListResults, IntegrationsTriggersCreateErrors, IntegrationsTriggersCreateResults, IntegrationsTriggersDeleteErrors, IntegrationsTriggersDeleteResults, IntegrationsTriggersListErrors, IntegrationsTriggersListResults, IntegrationsTriggersUpdateErrors, IntegrationsTriggersUpdateResults, IntegrationsUpdateErrors, IntegrationsUpdateResults, KnowledgeBuildErrors, KnowledgeBuildResults, KnowledgeCreateErrors, KnowledgeCreateResults, KnowledgeDeleteErrors, KnowledgeDeleteResults, KnowledgeEventsResult, KnowledgeEventsResults, KnowledgeGetErrors, KnowledgeGetResults, KnowledgeListErrors, KnowledgeListResults, KnowledgeNodesDeleteErrors, KnowledgeNodesDeleteResults, KnowledgeNodesGetErrors, KnowledgeNodesGetResults, KnowledgeNodesUpdateErrors, KnowledgeNodesUpdateResults, KnowledgePagesListErrors, KnowledgePagesListResults, KnowledgePromptErrors, KnowledgePromptResults, KnowledgeRegenerateTocErrors, KnowledgeRegenerateTocResults, ObservabilityGetErrors, ObservabilityGetResults, OutboundCallRequest, PatchCallBatchRequest, PatchConversationRequest, PatchEmailBatchRequest, PatchEmailRecipientRequest, PatchEmailSendRequest, PatchIntegrationRequest, PatchIntegrationTriggerRequest, PatchNodeRequest, PatchPhoneNumberRequest, PatchStreamConnectionRequest, PatchTaskRequest, PatchTelephonyAccountRequest, PatchToolRequest, PatchWebhookRequest, PatchWhatsAppBatchRequest, PatchWhatsAppRecipientRequest, PreviewAnalysisRequest, ProviderKeysDeleteErrors, ProviderKeysDeleteResults, ProviderKeysListErrors, ProviderKeysListResults, ProviderKeysSetErrors, ProviderKeysSetResults, PublishToolRequest, RedraftRequest, RunTaskRequest, RunToolRequest, SchemasFunctionsGetErrors, SchemasFunctionsGetResults, SchemasGetErrors, SchemasGetResults, SecretsCreateErrors, SecretsCreateResults, SecretsDeleteErrors, SecretsDeleteResults, SecretsListErrors, SecretsListResults, SelectRecipientsRequest, SendMessageRequest, SendWhatsAppBatchRequest, SetProviderKeyRequest, TasksCreateErrors, TasksCreateResults, TasksDeleteErrors, TasksDeleteResults, TasksGetErrors, TasksGetResults, TasksListErrors, TasksListResults, TasksPublishErrors, TasksPublishResults, TasksRunsCreateErrors, TasksRunsCreateResults, TasksRunsGetErrors, TasksRunsGetResults, TasksRunsListErrors, TasksRunsListResults, TasksUpdateErrors, TasksUpdateResults, TasksValidateErrors, TasksValidateResults, TasksVersionsGetErrors, TasksVersionsGetResults, TasksVersionsRollbackErrors, TasksVersionsRollbackResults, TelephonyAccountsCreateErrors, TelephonyAccountsCreateResults, TelephonyAccountsDeleteErrors, TelephonyAccountsDeleteResults, TelephonyAccountsGetErrors, TelephonyAccountsGetResults, TelephonyAccountsListErrors, TelephonyAccountsListResults, TelephonyAccountsProvisionErrors, TelephonyAccountsProvisionResults, TelephonyAccountsRemoteNumbersErrors, TelephonyAccountsRemoteNumbersResults, TelephonyAccountsUpdateErrors, TelephonyAccountsUpdateResults, TelephonyPhoneNumbersAssignErrors, TelephonyPhoneNumbersAssignResults, TelephonyPhoneNumbersGetErrors, TelephonyPhoneNumbersGetResults, TelephonyPhoneNumbersImportErrors, TelephonyPhoneNumbersImportResults, TelephonyPhoneNumbersListErrors, TelephonyPhoneNumbersListResults, TelephonyPhoneNumbersProvisionErrors, TelephonyPhoneNumbersProvisionResults, TelephonyPhoneNumbersUnassignErrors, TelephonyPhoneNumbersUnassignResults, TelephonyPhoneNumbersUpdateErrors, TelephonyPhoneNumbersUpdateResults, TelephonyProvidersListErrors, TelephonyProvidersListResults, TelephonyStreamsCreateErrors, TelephonyStreamsCreateResults, TelephonyStreamsDeleteErrors, TelephonyStreamsDeleteResults, TelephonyStreamsGetErrors, TelephonyStreamsGetResults, TelephonyStreamsListErrors, TelephonyStreamsListResults, TelephonyStreamsUpdateErrors, TelephonyStreamsUpdateResults, TokenRequest, ToolsCreateErrors, ToolsCreateResults, ToolsDeleteErrors, ToolsDeleteResults, ToolsGetErrors, ToolsGetResults, ToolsListErrors, ToolsListResults, ToolsPublishErrors, ToolsPublishResults, ToolsRunErrors, ToolsRunResults, ToolsUpdateErrors, ToolsUpdateResults, ToolsValidateErrors, ToolsValidateResults, ToolsVersionsGetErrors, ToolsVersionsGetResults, ToolsVersionsRollbackErrors, ToolsVersionsRollbackResults, TwilioSendersRequest, UpdateAgentRequest, WebhooksCreateErrors, WebhooksCreateResults, WebhooksDeleteErrors, WebhooksDeleteResults, WebhooksDeliveriesErrors, WebhooksDeliveriesResults, WebhooksEventTypesErrors, WebhooksEventTypesResults, WebhooksListErrors, WebhooksListResults, WebhooksRotateSecretErrors, WebhooksRotateSecretResults, WebhooksTestErrors, WebhooksTestResults, WebhooksUpdateErrors, WebhooksUpdateResults, WhatsappBatchesCancelErrors, WhatsappBatchesCancelResults, WhatsappBatchesCreateErrors, WhatsappBatchesCreateResults, WhatsappBatchesDeleteErrors, WhatsappBatchesDeleteResults, WhatsappBatchesGetErrors, WhatsappBatchesGetResults, WhatsappBatchesListErrors, WhatsappBatchesListResults, WhatsappBatchesPauseErrors, WhatsappBatchesPauseResults, WhatsappBatchesRecipientsListErrors, WhatsappBatchesRecipientsListResults, WhatsappBatchesRecipientsRestoreErrors, WhatsappBatchesRecipientsRestoreResults, WhatsappBatchesRecipientsSkipErrors, WhatsappBatchesRecipientsSkipResults, WhatsappBatchesRecipientsUpdateErrors, WhatsappBatchesRecipientsUpdateResults, WhatsappBatchesResumeErrors, WhatsappBatchesResumeResults, WhatsappBatchesSendErrors, WhatsappBatchesSendResults, WhatsappBatchesUpdateErrors, WhatsappBatchesUpdateResults, WhatsappTemplatesListErrors, WhatsappTemplatesListResults, WhatsappTwilioSendersListErrors, WhatsappTwilioSendersListResults } from './types.gen.js';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -86,7 +86,7 @@ export declare class Agents extends HeyApiClient {
|
|
|
86
86
|
/**
|
|
87
87
|
* Delete Agent
|
|
88
88
|
*
|
|
89
|
-
* Delete an agent and its
|
|
89
|
+
* Delete an agent and its versions permanently; 409 while anything still points at it.
|
|
90
90
|
*/
|
|
91
91
|
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
92
92
|
agent_id: string;
|
|
@@ -333,13 +333,25 @@ export declare class Batches extends HeyApiClient {
|
|
|
333
333
|
*
|
|
334
334
|
* Two things you would otherwise learn from an invoice:
|
|
335
335
|
*
|
|
336
|
-
* - **
|
|
336
|
+
* - **Voicemail is answered and billed** unless the agent has
|
|
337
|
+
* `voicemail_detection` on; then it hangs up (optionally after a message),
|
|
338
|
+
* and the recipient is retried like a missed call.
|
|
337
339
|
* - **Calls run your agent's current published version.** Republishing changes
|
|
338
340
|
* every call placed after that moment.
|
|
339
341
|
*/
|
|
340
342
|
create<ThrowOnError extends boolean = false>(parameters: {
|
|
341
343
|
createCallBatchRequest: CreateCallBatchRequest;
|
|
342
344
|
}, options?: Options<never, ThrowOnError>): RequestResult<CallsBatchesCreateResults, CallsBatchesCreateErrors, ThrowOnError, 'data'>;
|
|
345
|
+
/**
|
|
346
|
+
* Delete Call Batch
|
|
347
|
+
*
|
|
348
|
+
* Delete a finished batch and its recipient list for good. Its calls stay.
|
|
349
|
+
*
|
|
350
|
+
* Refused while it is live or a call of it is still in progress; cancel it first.
|
|
351
|
+
*/
|
|
352
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
353
|
+
batch_id: string;
|
|
354
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<CallsBatchesDeleteResults, CallsBatchesDeleteErrors, ThrowOnError, 'data'>;
|
|
343
355
|
/**
|
|
344
356
|
* Get Call Batch
|
|
345
357
|
*
|
|
@@ -369,7 +381,7 @@ export declare class Batches extends HeyApiClient {
|
|
|
369
381
|
/**
|
|
370
382
|
* Cancel Call Batch
|
|
371
383
|
*
|
|
372
|
-
* Stop a batch for good. There is no undo
|
|
384
|
+
* Stop a batch for good. There is no undo.
|
|
373
385
|
*
|
|
374
386
|
* Everyone not yet called immediately reads as `canceled`. Calls already
|
|
375
387
|
* ringing or in progress are **not** dropped — they run to their natural end,
|
|
@@ -487,7 +499,7 @@ export declare class Calls extends HeyApiClient {
|
|
|
487
499
|
start?: string | null;
|
|
488
500
|
end?: string | null;
|
|
489
501
|
agent_id?: string | null;
|
|
490
|
-
type?: 'WEB' | 'SIP_INBOUND' | 'SIP_OUTBOUND' | 'STREAM' | null;
|
|
502
|
+
type?: 'WEB' | 'SIP_INBOUND' | 'SIP_OUTBOUND' | 'STREAM' | 'WHATSAPP_INBOUND' | null;
|
|
491
503
|
status?: string | null;
|
|
492
504
|
outcome?: string | null;
|
|
493
505
|
contact_key?: string | null;
|
|
@@ -736,24 +748,130 @@ export declare class Catalog extends HeyApiClient {
|
|
|
736
748
|
private _voices?;
|
|
737
749
|
get voices(): Voices;
|
|
738
750
|
}
|
|
751
|
+
export declare class Analysis2 extends HeyApiClient {
|
|
752
|
+
/**
|
|
753
|
+
* Rerun Chat Analysis
|
|
754
|
+
*
|
|
755
|
+
* Analyse an ended chat again with its agent's saved definition.
|
|
756
|
+
*
|
|
757
|
+
* A real model call: the workspace is charged and the chat re-priced.
|
|
758
|
+
*/
|
|
759
|
+
rerun<ThrowOnError extends boolean = false>(parameters: {
|
|
760
|
+
chat_id: string;
|
|
761
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsAnalysisRerunResults, ChatsAnalysisRerunErrors, ThrowOnError, 'data'>;
|
|
762
|
+
/**
|
|
763
|
+
* Preview Chat Analysis
|
|
764
|
+
*
|
|
765
|
+
* Try an analysis definition against an ended chat. Nothing is saved; costs one model call.
|
|
766
|
+
*/
|
|
767
|
+
preview<ThrowOnError extends boolean = false>(parameters: {
|
|
768
|
+
chat_id: string;
|
|
769
|
+
previewAnalysisRequest: PreviewAnalysisRequest;
|
|
770
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsAnalysisPreviewResults, ChatsAnalysisPreviewErrors, ThrowOnError, 'data'>;
|
|
771
|
+
}
|
|
772
|
+
export declare class Items extends HeyApiClient {
|
|
773
|
+
/**
|
|
774
|
+
* List Chat Items
|
|
775
|
+
*
|
|
776
|
+
* The messages, tool calls and handoffs of one chat.
|
|
777
|
+
*/
|
|
778
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
779
|
+
chat_id: string;
|
|
780
|
+
limit?: number;
|
|
781
|
+
offset?: number;
|
|
782
|
+
order?: string;
|
|
783
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsItemsListResults, ChatsItemsListErrors, ThrowOnError, 'data'>;
|
|
784
|
+
}
|
|
739
785
|
export declare class Messages extends HeyApiClient {
|
|
740
786
|
/**
|
|
741
|
-
* Create
|
|
787
|
+
* Create Chat Message
|
|
742
788
|
*
|
|
743
|
-
* Send a message
|
|
789
|
+
* Send a message and get the agent's reply back on this request.
|
|
744
790
|
*
|
|
745
|
-
*
|
|
746
|
-
*
|
|
747
|
-
|
|
791
|
+
* A newer message supersedes one still being answered: the older request
|
|
792
|
+
* returns `status: canceled` with `superseded_by_item_id`.
|
|
793
|
+
*/
|
|
794
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
795
|
+
chat_id: string;
|
|
796
|
+
chatMessageRequest: ChatMessageRequest;
|
|
797
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsMessagesCreateResults, ChatsMessagesCreateErrors, ThrowOnError, 'data'>;
|
|
798
|
+
}
|
|
799
|
+
export declare class Tokens extends HeyApiClient {
|
|
800
|
+
/**
|
|
801
|
+
* Create Chat Token
|
|
748
802
|
*
|
|
749
|
-
*
|
|
750
|
-
* item — poll `list_conversation_items` for the agent's reply.
|
|
803
|
+
* Mint a one-hour browser token for this chat. Mint another to refresh.
|
|
751
804
|
*/
|
|
752
805
|
create<ThrowOnError extends boolean = false>(parameters: {
|
|
753
|
-
|
|
754
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
806
|
+
chat_id: string;
|
|
807
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsTokensCreateResults, ChatsTokensCreateErrors, ThrowOnError, 'data'>;
|
|
755
808
|
}
|
|
756
|
-
export declare class
|
|
809
|
+
export declare class Chats extends HeyApiClient {
|
|
810
|
+
/**
|
|
811
|
+
* List Chats
|
|
812
|
+
*
|
|
813
|
+
* List chats, newest first.
|
|
814
|
+
*/
|
|
815
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
816
|
+
limit?: number;
|
|
817
|
+
offset?: number;
|
|
818
|
+
agent_id?: string | null;
|
|
819
|
+
contact_key?: string | null;
|
|
820
|
+
status?: 'open' | 'ended' | 'all';
|
|
821
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsListResults, ChatsListErrors, ThrowOnError, 'data'>;
|
|
822
|
+
/**
|
|
823
|
+
* Create Chat
|
|
824
|
+
*
|
|
825
|
+
* Start a chat with a text agent. Send it messages with `create_chat_message`.
|
|
826
|
+
*
|
|
827
|
+
* It stays open until the agent's `end_call` tool or `end_chat` ends it. Starting
|
|
828
|
+
* one ends the contact's open chat with the same agent.
|
|
829
|
+
*/
|
|
830
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
831
|
+
createChatRequest: CreateChatRequest;
|
|
832
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsCreateResults, ChatsCreateErrors, ThrowOnError, 'data'>;
|
|
833
|
+
/**
|
|
834
|
+
* Delete Chat
|
|
835
|
+
*
|
|
836
|
+
* Erase an ended chat's content; the chat and its cost stay. Cannot be undone.
|
|
837
|
+
*/
|
|
838
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
839
|
+
chat_id: string;
|
|
840
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsDeleteResults, ChatsDeleteErrors, ThrowOnError, 'data'>;
|
|
841
|
+
/**
|
|
842
|
+
* Get Chat
|
|
843
|
+
*
|
|
844
|
+
* Read one chat: its status, cost so far and, once ended, its analysis.
|
|
845
|
+
*/
|
|
846
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
847
|
+
chat_id: string;
|
|
848
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsGetResults, ChatsGetErrors, ThrowOnError, 'data'>;
|
|
849
|
+
/**
|
|
850
|
+
* Get Chat Detail
|
|
851
|
+
*
|
|
852
|
+
* One chat with its health snapshot, cost lines, vars and event trace.
|
|
853
|
+
*/
|
|
854
|
+
detail<ThrowOnError extends boolean = false>(parameters: {
|
|
855
|
+
chat_id: string;
|
|
856
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsDetailResults, ChatsDetailErrors, ThrowOnError, 'data'>;
|
|
857
|
+
/**
|
|
858
|
+
* End Chat
|
|
859
|
+
*
|
|
860
|
+
* End a chat. Its analysis and `session.completed` webhook follow.
|
|
861
|
+
*/
|
|
862
|
+
end<ThrowOnError extends boolean = false>(parameters: {
|
|
863
|
+
chat_id: string;
|
|
864
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsEndResults, ChatsEndErrors, ThrowOnError, 'data'>;
|
|
865
|
+
private _analysis?;
|
|
866
|
+
get analysis(): Analysis2;
|
|
867
|
+
private _items?;
|
|
868
|
+
get items(): Items;
|
|
869
|
+
private _messages?;
|
|
870
|
+
get messages(): Messages;
|
|
871
|
+
private _tokens?;
|
|
872
|
+
get tokens(): Tokens;
|
|
873
|
+
}
|
|
874
|
+
export declare class Items2 extends HeyApiClient {
|
|
757
875
|
/**
|
|
758
876
|
* List Conversation Items
|
|
759
877
|
*
|
|
@@ -777,10 +895,9 @@ export declare class Sessions extends HeyApiClient {
|
|
|
777
895
|
*
|
|
778
896
|
* The agent sessions behind a conversation, newest first.
|
|
779
897
|
*
|
|
780
|
-
* A thread can be handled many times — each phone call
|
|
781
|
-
*
|
|
782
|
-
*
|
|
783
|
-
* the matching `session_id` for `get_call`.
|
|
898
|
+
* A thread can be handled many times — each phone call and each chat is one
|
|
899
|
+
* session, recording which agent version ran, how it finished and what its
|
|
900
|
+
* analysis concluded. A session's id is its `get_call` or `get_chat` id.
|
|
784
901
|
*/
|
|
785
902
|
list<ThrowOnError extends boolean = false>(parameters: {
|
|
786
903
|
conversation_id: string;
|
|
@@ -794,8 +911,8 @@ export declare class Conversations extends HeyApiClient {
|
|
|
794
911
|
*
|
|
795
912
|
* List conversations across every channel, most recently active first.
|
|
796
913
|
*
|
|
797
|
-
* One conversation is one
|
|
798
|
-
*
|
|
914
|
+
* One conversation is one thread — a web chat, a Telegram thread, or a single
|
|
915
|
+
* phone call — with `surface` saying which. Several of them
|
|
799
916
|
* can belong to the same person: pass `contact_key` to list only theirs.
|
|
800
917
|
*/
|
|
801
918
|
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
@@ -803,23 +920,8 @@ export declare class Conversations extends HeyApiClient {
|
|
|
803
920
|
offset?: number;
|
|
804
921
|
agent_id?: string | null;
|
|
805
922
|
contact_key?: string | null;
|
|
923
|
+
status?: 'active' | 'inactive' | 'all';
|
|
806
924
|
}, options?: Options<never, ThrowOnError>): RequestResult<ConversationsListResults, ConversationsListErrors, ThrowOnError, 'data'>;
|
|
807
|
-
/**
|
|
808
|
-
* Create Text Conversation
|
|
809
|
-
*
|
|
810
|
-
* Open a text conversation with a published text agent.
|
|
811
|
-
*
|
|
812
|
-
* `contact_key` is your own stable id for the person you are talking to —
|
|
813
|
-
* unique in the workspace, and how you reach them again. `userdata` seeds what
|
|
814
|
-
* the agent knows about them, readable as `{{userdata.field}}` from the
|
|
815
|
-
* agent's tools.
|
|
816
|
-
*
|
|
817
|
-
* Creating the conversation does not send anything; call `create_text_message`
|
|
818
|
-
* to say something.
|
|
819
|
-
*/
|
|
820
|
-
create<ThrowOnError extends boolean = false>(parameters: {
|
|
821
|
-
createTextConversationRequest: CreateTextConversationRequest;
|
|
822
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<ConversationsCreateResults, ConversationsCreateErrors, ThrowOnError, 'data'>;
|
|
823
925
|
/**
|
|
824
926
|
* Get Conversation
|
|
825
927
|
*
|
|
@@ -877,10 +979,18 @@ export declare class Conversations extends HeyApiClient {
|
|
|
877
979
|
snapshot<ThrowOnError extends boolean = false>(parameters: {
|
|
878
980
|
conversation_id: string;
|
|
879
981
|
}, options?: Options<never, ThrowOnError>): RequestResult<ConversationsSnapshotResults, ConversationsSnapshotErrors, ThrowOnError, 'data'>;
|
|
880
|
-
|
|
881
|
-
|
|
982
|
+
/**
|
|
983
|
+
* List Conversation Trace
|
|
984
|
+
*
|
|
985
|
+
* What the platform did during this conversation's sessions, oldest first.
|
|
986
|
+
*/
|
|
987
|
+
trace<ThrowOnError extends boolean = false>(parameters: {
|
|
988
|
+
conversation_id: string;
|
|
989
|
+
after?: string | null;
|
|
990
|
+
before?: string | null;
|
|
991
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ConversationsTraceResults, ConversationsTraceErrors, ThrowOnError, 'data'>;
|
|
882
992
|
private _items?;
|
|
883
|
-
get items():
|
|
993
|
+
get items(): Items2;
|
|
884
994
|
private _sessions?;
|
|
885
995
|
get sessions(): Sessions;
|
|
886
996
|
}
|
|
@@ -1202,6 +1312,16 @@ export declare class Batches2 extends HeyApiClient {
|
|
|
1202
1312
|
create<ThrowOnError extends boolean = false>(parameters: {
|
|
1203
1313
|
createEmailBatchRequest: CreateEmailBatchRequest;
|
|
1204
1314
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBatchesCreateResults, EmailBatchesCreateErrors, ThrowOnError, 'data'>;
|
|
1315
|
+
/**
|
|
1316
|
+
* Delete Email Batch
|
|
1317
|
+
*
|
|
1318
|
+
* Delete a batch, its rows and its sends for good. **The record of what was sent goes too.**
|
|
1319
|
+
*
|
|
1320
|
+
* Refused while it is still drafting or a send has not finished; cancel those first.
|
|
1321
|
+
*/
|
|
1322
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1323
|
+
batch_id: string;
|
|
1324
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBatchesDeleteResults, EmailBatchesDeleteErrors, ThrowOnError, 'data'>;
|
|
1205
1325
|
/**
|
|
1206
1326
|
* Get Email Batch
|
|
1207
1327
|
*
|
|
@@ -1232,8 +1352,7 @@ export declare class Batches2 extends HeyApiClient {
|
|
|
1232
1352
|
/**
|
|
1233
1353
|
* Cancel Email Batch
|
|
1234
1354
|
*
|
|
1235
|
-
* Stop drafting for good.
|
|
1236
|
-
* record of what was sent to whom.
|
|
1355
|
+
* Stop drafting for good.
|
|
1237
1356
|
*
|
|
1238
1357
|
* Rows already drafted are **not** touched and neither is any send: cancelling
|
|
1239
1358
|
* stops drafting, and drafts already produced are still worth reviewing and
|
|
@@ -1696,8 +1815,8 @@ export declare class Secrets extends HeyApiClient {
|
|
|
1696
1815
|
/**
|
|
1697
1816
|
* Delete Secret
|
|
1698
1817
|
*
|
|
1699
|
-
* Delete a secret permanently.
|
|
1700
|
-
*
|
|
1818
|
+
* Delete a secret permanently. Refused with 409 while a tool, integration or
|
|
1819
|
+
* carrier account references it. Organization admins only.
|
|
1701
1820
|
*/
|
|
1702
1821
|
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1703
1822
|
secret_id: string;
|
|
@@ -2343,6 +2462,173 @@ export declare class Webhooks extends HeyApiClient {
|
|
|
2343
2462
|
webhook_id: string;
|
|
2344
2463
|
}, options?: Options<never, ThrowOnError>): RequestResult<WebhooksTestResults, WebhooksTestErrors, ThrowOnError, 'data'>;
|
|
2345
2464
|
}
|
|
2465
|
+
export declare class Recipients3 extends HeyApiClient {
|
|
2466
|
+
/**
|
|
2467
|
+
* List Whatsapp Batch Recipients
|
|
2468
|
+
*
|
|
2469
|
+
* A batch's rows in upload order, each with its rendered message.
|
|
2470
|
+
*
|
|
2471
|
+
* `status` may repeat; a row matching any of them is returned.
|
|
2472
|
+
*/
|
|
2473
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
2474
|
+
batch_id: string;
|
|
2475
|
+
limit?: number;
|
|
2476
|
+
offset?: number;
|
|
2477
|
+
status?: Array<'ready' | 'skipped' | 'sending' | 'queued' | 'sent' | 'delivered' | 'read' | 'undelivered' | 'failed' | 'replied'> | null;
|
|
2478
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsListResults, WhatsappBatchesRecipientsListErrors, ThrowOnError, 'data'>;
|
|
2479
|
+
/**
|
|
2480
|
+
* Restore Whatsapp Batch Recipients
|
|
2481
|
+
*
|
|
2482
|
+
* Put rows a person skipped back. A row skipped for its cells returns when they are fixed.
|
|
2483
|
+
*/
|
|
2484
|
+
restore<ThrowOnError extends boolean = false>(parameters: {
|
|
2485
|
+
batch_id: string;
|
|
2486
|
+
selectRecipientsRequest: SelectRecipientsRequest;
|
|
2487
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsRestoreResults, WhatsappBatchesRecipientsRestoreErrors, ThrowOnError, 'data'>;
|
|
2488
|
+
/**
|
|
2489
|
+
* Skip Whatsapp Batch Recipients
|
|
2490
|
+
*
|
|
2491
|
+
* Take ready rows out of the send. Reversible with restore.
|
|
2492
|
+
*/
|
|
2493
|
+
skip<ThrowOnError extends boolean = false>(parameters: {
|
|
2494
|
+
batch_id: string;
|
|
2495
|
+
selectRecipientsRequest: SelectRecipientsRequest;
|
|
2496
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsSkipResults, WhatsappBatchesRecipientsSkipErrors, ThrowOnError, 'data'>;
|
|
2497
|
+
/**
|
|
2498
|
+
* Patch Whatsapp Batch Recipient
|
|
2499
|
+
*
|
|
2500
|
+
* Edit cells on a row not yet sent, its phone included. An empty value clears the edit.
|
|
2501
|
+
*/
|
|
2502
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
2503
|
+
batch_id: string;
|
|
2504
|
+
recipient_id: string;
|
|
2505
|
+
patchWhatsAppRecipientRequest: PatchWhatsAppRecipientRequest;
|
|
2506
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsUpdateResults, WhatsappBatchesRecipientsUpdateErrors, ThrowOnError, 'data'>;
|
|
2507
|
+
}
|
|
2508
|
+
export declare class Batches3 extends HeyApiClient {
|
|
2509
|
+
/**
|
|
2510
|
+
* List Whatsapp Batches
|
|
2511
|
+
*
|
|
2512
|
+
* List WhatsApp batches, newest first.
|
|
2513
|
+
*/
|
|
2514
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2515
|
+
limit?: number;
|
|
2516
|
+
offset?: number;
|
|
2517
|
+
status?: 'draft' | 'scheduled' | 'sending' | 'paused' | 'completed' | 'canceled' | 'failed' | null;
|
|
2518
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesListResults, WhatsappBatchesListErrors, ThrowOnError, 'data'>;
|
|
2519
|
+
/**
|
|
2520
|
+
* Create Whatsapp Batch
|
|
2521
|
+
*
|
|
2522
|
+
* Create a WhatsApp batch: one approved template, sent once per CSV row. Sends nothing yet.
|
|
2523
|
+
*
|
|
2524
|
+
* Only message people who opted in to hear from you on WhatsApp. A row with an
|
|
2525
|
+
* invalid or repeated phone, or a blank or line-broken mapped cell, is kept and
|
|
2526
|
+
* skipped with the reason. Replies go to the sender's assigned agent, which
|
|
2527
|
+
* sees the row's cells as `{{userdata.<column>}}`.
|
|
2528
|
+
*/
|
|
2529
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
2530
|
+
createWhatsAppBatchRequest: CreateWhatsAppBatchRequest;
|
|
2531
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesCreateResults, WhatsappBatchesCreateErrors, ThrowOnError, 'data'>;
|
|
2532
|
+
/**
|
|
2533
|
+
* Delete Whatsapp Batch
|
|
2534
|
+
*
|
|
2535
|
+
* Delete a batch and its rows for good. A live batch must be canceled first.
|
|
2536
|
+
*
|
|
2537
|
+
* The conversations it started stay; its delivery and reply counts do not.
|
|
2538
|
+
*/
|
|
2539
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
2540
|
+
batch_id: string;
|
|
2541
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesDeleteResults, WhatsappBatchesDeleteErrors, ThrowOnError, 'data'>;
|
|
2542
|
+
/**
|
|
2543
|
+
* Get Whatsapp Batch
|
|
2544
|
+
*
|
|
2545
|
+
* One batch: its template, schedule and per-status counts, `replied` included.
|
|
2546
|
+
*/
|
|
2547
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
2548
|
+
batch_id: string;
|
|
2549
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesGetResults, WhatsappBatchesGetErrors, ThrowOnError, 'data'>;
|
|
2550
|
+
/**
|
|
2551
|
+
* Patch Whatsapp Batch
|
|
2552
|
+
*
|
|
2553
|
+
* Edit a batch. Pacing and the window reach a live send within minutes.
|
|
2554
|
+
*
|
|
2555
|
+
* `variable_map` changes only before sending, `start_at` only before it begins;
|
|
2556
|
+
* a finished batch takes `name` alone.
|
|
2557
|
+
*/
|
|
2558
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
2559
|
+
batch_id: string;
|
|
2560
|
+
patchWhatsAppBatchRequest: PatchWhatsAppBatchRequest;
|
|
2561
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesUpdateResults, WhatsappBatchesUpdateErrors, ThrowOnError, 'data'>;
|
|
2562
|
+
/**
|
|
2563
|
+
* Cancel Whatsapp Batch
|
|
2564
|
+
*
|
|
2565
|
+
* Stop for good. Messages already sent stay sent, and replies are still answered.
|
|
2566
|
+
*/
|
|
2567
|
+
cancel<ThrowOnError extends boolean = false>(parameters: {
|
|
2568
|
+
batch_id: string;
|
|
2569
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesCancelResults, WhatsappBatchesCancelErrors, ThrowOnError, 'data'>;
|
|
2570
|
+
/**
|
|
2571
|
+
* Pause Whatsapp Batch
|
|
2572
|
+
*
|
|
2573
|
+
* Stop sending before the next message. Nothing is lost.
|
|
2574
|
+
*/
|
|
2575
|
+
pause<ThrowOnError extends boolean = false>(parameters: {
|
|
2576
|
+
batch_id: string;
|
|
2577
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesPauseResults, WhatsappBatchesPauseErrors, ThrowOnError, 'data'>;
|
|
2578
|
+
/**
|
|
2579
|
+
* Resume Whatsapp Batch
|
|
2580
|
+
*
|
|
2581
|
+
* Carry on sending from where the batch stopped.
|
|
2582
|
+
*/
|
|
2583
|
+
resume<ThrowOnError extends boolean = false>(parameters: {
|
|
2584
|
+
batch_id: string;
|
|
2585
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesResumeResults, WhatsappBatchesResumeErrors, ThrowOnError, 'data'>;
|
|
2586
|
+
/**
|
|
2587
|
+
* Send Whatsapp Batch
|
|
2588
|
+
*
|
|
2589
|
+
* Send every ready row. **This messages real people and cannot be undone.**
|
|
2590
|
+
*
|
|
2591
|
+
* `start_at` schedules it, `window` holds it to business hours, and
|
|
2592
|
+
* `send_daily_cap` (default 250, Meta's lowest tier) and `send_gap_seconds`
|
|
2593
|
+
* pace it.
|
|
2594
|
+
*/
|
|
2595
|
+
send<ThrowOnError extends boolean = false>(parameters: {
|
|
2596
|
+
batch_id: string;
|
|
2597
|
+
sendWhatsAppBatchRequest: SendWhatsAppBatchRequest;
|
|
2598
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesSendResults, WhatsappBatchesSendErrors, ThrowOnError, 'data'>;
|
|
2599
|
+
private _recipients?;
|
|
2600
|
+
get recipients(): Recipients3;
|
|
2601
|
+
}
|
|
2602
|
+
export declare class Templates extends HeyApiClient {
|
|
2603
|
+
/**
|
|
2604
|
+
* List Whatsapp Templates
|
|
2605
|
+
*
|
|
2606
|
+
* List a WhatsApp sender's approved templates, read live from its BSP.
|
|
2607
|
+
*
|
|
2608
|
+
* One with `unsupported_reason` set cannot be sent from a batch.
|
|
2609
|
+
*/
|
|
2610
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
2611
|
+
integration_id: string;
|
|
2612
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappTemplatesListResults, WhatsappTemplatesListErrors, ThrowOnError, 'data'>;
|
|
2613
|
+
}
|
|
2614
|
+
export declare class TwilioSenders extends HeyApiClient {
|
|
2615
|
+
/**
|
|
2616
|
+
* List Twilio Whatsapp Senders
|
|
2617
|
+
*
|
|
2618
|
+
* List the WhatsApp senders on a Twilio account, before connecting one. Stores nothing.
|
|
2619
|
+
*/
|
|
2620
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
2621
|
+
twilioSendersRequest: TwilioSendersRequest;
|
|
2622
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappTwilioSendersListResults, WhatsappTwilioSendersListErrors, ThrowOnError, 'data'>;
|
|
2623
|
+
}
|
|
2624
|
+
export declare class Whatsapp extends HeyApiClient {
|
|
2625
|
+
private _batches?;
|
|
2626
|
+
get batches(): Batches3;
|
|
2627
|
+
private _templates?;
|
|
2628
|
+
get templates(): Templates;
|
|
2629
|
+
private _twilioSenders?;
|
|
2630
|
+
get twilioSenders(): TwilioSenders;
|
|
2631
|
+
}
|
|
2346
2632
|
export declare class TalqingApi extends HeyApiClient {
|
|
2347
2633
|
static readonly __registry: HeyApiRegistry<TalqingApi>;
|
|
2348
2634
|
constructor(args?: {
|
|
@@ -2370,6 +2656,8 @@ export declare class TalqingApi extends HeyApiClient {
|
|
|
2370
2656
|
get calls(): Calls;
|
|
2371
2657
|
private _catalog?;
|
|
2372
2658
|
get catalog(): Catalog;
|
|
2659
|
+
private _chats?;
|
|
2660
|
+
get chats(): Chats;
|
|
2373
2661
|
private _conversations?;
|
|
2374
2662
|
get conversations(): Conversations;
|
|
2375
2663
|
private _copilot?;
|
|
@@ -2394,6 +2682,8 @@ export declare class TalqingApi extends HeyApiClient {
|
|
|
2394
2682
|
get tools(): Tools2;
|
|
2395
2683
|
private _webhooks?;
|
|
2396
2684
|
get webhooks(): Webhooks;
|
|
2685
|
+
private _whatsapp?;
|
|
2686
|
+
get whatsapp(): Whatsapp;
|
|
2397
2687
|
}
|
|
2398
2688
|
export {};
|
|
2399
2689
|
//# sourceMappingURL=sdk.gen.d.ts.map
|