@talqing/sdk 0.4.5 → 0.5.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 +294 -44
- package/dist/cjs/gen/sdk.gen.d.ts.map +1 -1
- package/dist/cjs/gen/sdk.gen.js +623 -64
- package/dist/cjs/gen/sdk.gen.js.map +1 -1
- package/dist/cjs/gen/types.gen.d.ts +4618 -2599
- 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 +294 -44
- package/dist/esm/gen/sdk.gen.d.ts.map +1 -1
- package/dist/esm/gen/sdk.gen.js +611 -60
- package/dist/esm/gen/sdk.gen.js.map +1 -1
- package/dist/esm/gen/types.gen.d.ts +4618 -2599
- 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 +751 -95
- package/src/gen/types.gen.ts +4908 -2748
|
@@ -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, ChatsCreateErrors, ChatsCreateResults, ChatsDeleteErrors, ChatsDeleteResults, ChatsEndErrors, ChatsEndResults, ChatsGetErrors, ChatsGetResults, ChatsItemsListErrors, ChatsItemsListResults, ChatsListErrors, ChatsListResults, ChatsMessagesCreateErrors, ChatsMessagesCreateResults, ChatsTokensCreateErrors, ChatsTokensCreateResults, ConversationsEventsResult, ConversationsEventsResults, ConversationsGetErrors, ConversationsGetResults, ConversationsItemsListErrors, ConversationsItemsListResults, ConversationsListErrors, ConversationsListResults, ConversationsSessionsListErrors, ConversationsSessionsListResults, ConversationsSnapshotErrors, ConversationsSnapshotResults, 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,99 @@ export declare class Catalog extends HeyApiClient {
|
|
|
736
748
|
private _voices?;
|
|
737
749
|
get voices(): Voices;
|
|
738
750
|
}
|
|
751
|
+
export declare class Items extends HeyApiClient {
|
|
752
|
+
/**
|
|
753
|
+
* List Chat Items
|
|
754
|
+
*
|
|
755
|
+
* The messages, tool calls and handoffs of one chat.
|
|
756
|
+
*/
|
|
757
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
758
|
+
chat_id: string;
|
|
759
|
+
limit?: number;
|
|
760
|
+
offset?: number;
|
|
761
|
+
order?: string;
|
|
762
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsItemsListResults, ChatsItemsListErrors, ThrowOnError, 'data'>;
|
|
763
|
+
}
|
|
739
764
|
export declare class Messages extends HeyApiClient {
|
|
740
765
|
/**
|
|
741
|
-
* Create
|
|
766
|
+
* Create Chat Message
|
|
742
767
|
*
|
|
743
|
-
* Send a message
|
|
768
|
+
* Send a message and get the agent's reply back on this request.
|
|
744
769
|
*
|
|
745
|
-
*
|
|
746
|
-
*
|
|
747
|
-
|
|
770
|
+
* A newer message supersedes one still being answered: the older request
|
|
771
|
+
* returns `status: canceled` with `superseded_by_item_id`.
|
|
772
|
+
*/
|
|
773
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
774
|
+
chat_id: string;
|
|
775
|
+
chatMessageRequest: ChatMessageRequest;
|
|
776
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsMessagesCreateResults, ChatsMessagesCreateErrors, ThrowOnError, 'data'>;
|
|
777
|
+
}
|
|
778
|
+
export declare class Tokens extends HeyApiClient {
|
|
779
|
+
/**
|
|
780
|
+
* Create Chat Token
|
|
748
781
|
*
|
|
749
|
-
*
|
|
750
|
-
* item — poll `list_conversation_items` for the agent's reply.
|
|
782
|
+
* Mint a one-hour browser token for this chat. Mint another to refresh.
|
|
751
783
|
*/
|
|
752
784
|
create<ThrowOnError extends boolean = false>(parameters: {
|
|
753
|
-
|
|
754
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
785
|
+
chat_id: string;
|
|
786
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsTokensCreateResults, ChatsTokensCreateErrors, ThrowOnError, 'data'>;
|
|
755
787
|
}
|
|
756
|
-
export declare class
|
|
788
|
+
export declare class Chats extends HeyApiClient {
|
|
789
|
+
/**
|
|
790
|
+
* List Chats
|
|
791
|
+
*
|
|
792
|
+
* List chats, newest first.
|
|
793
|
+
*/
|
|
794
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
795
|
+
limit?: number;
|
|
796
|
+
offset?: number;
|
|
797
|
+
agent_id?: string | null;
|
|
798
|
+
contact_key?: string | null;
|
|
799
|
+
status?: 'open' | 'ended' | 'all';
|
|
800
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsListResults, ChatsListErrors, ThrowOnError, 'data'>;
|
|
801
|
+
/**
|
|
802
|
+
* Create Chat
|
|
803
|
+
*
|
|
804
|
+
* Start a chat with a text agent. Send it messages with `create_chat_message`.
|
|
805
|
+
*
|
|
806
|
+
* It stays open until the agent's `end_call` tool or `end_chat` ends it. Starting
|
|
807
|
+
* one ends the contact's open chat with the same agent.
|
|
808
|
+
*/
|
|
809
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
810
|
+
createChatRequest: CreateChatRequest;
|
|
811
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsCreateResults, ChatsCreateErrors, ThrowOnError, 'data'>;
|
|
812
|
+
/**
|
|
813
|
+
* Delete Chat
|
|
814
|
+
*
|
|
815
|
+
* Erase an ended chat's content; the chat and its cost stay. Cannot be undone.
|
|
816
|
+
*/
|
|
817
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
818
|
+
chat_id: string;
|
|
819
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsDeleteResults, ChatsDeleteErrors, ThrowOnError, 'data'>;
|
|
820
|
+
/**
|
|
821
|
+
* Get Chat
|
|
822
|
+
*
|
|
823
|
+
* Read one chat: its status, cost so far and, once ended, its analysis.
|
|
824
|
+
*/
|
|
825
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
826
|
+
chat_id: string;
|
|
827
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsGetResults, ChatsGetErrors, ThrowOnError, 'data'>;
|
|
828
|
+
/**
|
|
829
|
+
* End Chat
|
|
830
|
+
*
|
|
831
|
+
* End a chat. Its analysis and `session.completed` webhook follow.
|
|
832
|
+
*/
|
|
833
|
+
end<ThrowOnError extends boolean = false>(parameters: {
|
|
834
|
+
chat_id: string;
|
|
835
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ChatsEndResults, ChatsEndErrors, ThrowOnError, 'data'>;
|
|
836
|
+
private _items?;
|
|
837
|
+
get items(): Items;
|
|
838
|
+
private _messages?;
|
|
839
|
+
get messages(): Messages;
|
|
840
|
+
private _tokens?;
|
|
841
|
+
get tokens(): Tokens;
|
|
842
|
+
}
|
|
843
|
+
export declare class Items2 extends HeyApiClient {
|
|
757
844
|
/**
|
|
758
845
|
* List Conversation Items
|
|
759
846
|
*
|
|
@@ -777,10 +864,10 @@ export declare class Sessions extends HeyApiClient {
|
|
|
777
864
|
*
|
|
778
865
|
* The agent sessions behind a conversation, newest first.
|
|
779
866
|
*
|
|
780
|
-
* A thread can be handled many times — each phone call
|
|
781
|
-
*
|
|
782
|
-
*
|
|
783
|
-
*
|
|
867
|
+
* A thread can be handled many times — each phone call and each chat is one
|
|
868
|
+
* session, recording which agent version ran and how it finished. Use it to
|
|
869
|
+
* find out *which* version answered; a session's id is its `get_call` or
|
|
870
|
+
* `get_chat` id.
|
|
784
871
|
*/
|
|
785
872
|
list<ThrowOnError extends boolean = false>(parameters: {
|
|
786
873
|
conversation_id: string;
|
|
@@ -794,8 +881,8 @@ export declare class Conversations extends HeyApiClient {
|
|
|
794
881
|
*
|
|
795
882
|
* List conversations across every channel, most recently active first.
|
|
796
883
|
*
|
|
797
|
-
* One conversation is one
|
|
798
|
-
*
|
|
884
|
+
* One conversation is one thread — a web chat, a Telegram thread, or a single
|
|
885
|
+
* phone call — with `surface` saying which. Several of them
|
|
799
886
|
* can belong to the same person: pass `contact_key` to list only theirs.
|
|
800
887
|
*/
|
|
801
888
|
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
@@ -803,23 +890,8 @@ export declare class Conversations extends HeyApiClient {
|
|
|
803
890
|
offset?: number;
|
|
804
891
|
agent_id?: string | null;
|
|
805
892
|
contact_key?: string | null;
|
|
893
|
+
status?: 'active' | 'inactive' | 'all';
|
|
806
894
|
}, 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
895
|
/**
|
|
824
896
|
* Get Conversation
|
|
825
897
|
*
|
|
@@ -877,10 +949,8 @@ export declare class Conversations extends HeyApiClient {
|
|
|
877
949
|
snapshot<ThrowOnError extends boolean = false>(parameters: {
|
|
878
950
|
conversation_id: string;
|
|
879
951
|
}, options?: Options<never, ThrowOnError>): RequestResult<ConversationsSnapshotResults, ConversationsSnapshotErrors, ThrowOnError, 'data'>;
|
|
880
|
-
private _messages?;
|
|
881
|
-
get messages(): Messages;
|
|
882
952
|
private _items?;
|
|
883
|
-
get items():
|
|
953
|
+
get items(): Items2;
|
|
884
954
|
private _sessions?;
|
|
885
955
|
get sessions(): Sessions;
|
|
886
956
|
}
|
|
@@ -1202,6 +1272,16 @@ export declare class Batches2 extends HeyApiClient {
|
|
|
1202
1272
|
create<ThrowOnError extends boolean = false>(parameters: {
|
|
1203
1273
|
createEmailBatchRequest: CreateEmailBatchRequest;
|
|
1204
1274
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBatchesCreateResults, EmailBatchesCreateErrors, ThrowOnError, 'data'>;
|
|
1275
|
+
/**
|
|
1276
|
+
* Delete Email Batch
|
|
1277
|
+
*
|
|
1278
|
+
* Delete a batch, its rows and its sends for good. **The record of what was sent goes too.**
|
|
1279
|
+
*
|
|
1280
|
+
* Refused while it is still drafting or a send has not finished; cancel those first.
|
|
1281
|
+
*/
|
|
1282
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1283
|
+
batch_id: string;
|
|
1284
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBatchesDeleteResults, EmailBatchesDeleteErrors, ThrowOnError, 'data'>;
|
|
1205
1285
|
/**
|
|
1206
1286
|
* Get Email Batch
|
|
1207
1287
|
*
|
|
@@ -1232,8 +1312,7 @@ export declare class Batches2 extends HeyApiClient {
|
|
|
1232
1312
|
/**
|
|
1233
1313
|
* Cancel Email Batch
|
|
1234
1314
|
*
|
|
1235
|
-
* Stop drafting for good.
|
|
1236
|
-
* record of what was sent to whom.
|
|
1315
|
+
* Stop drafting for good.
|
|
1237
1316
|
*
|
|
1238
1317
|
* Rows already drafted are **not** touched and neither is any send: cancelling
|
|
1239
1318
|
* stops drafting, and drafts already produced are still worth reviewing and
|
|
@@ -1696,8 +1775,8 @@ export declare class Secrets extends HeyApiClient {
|
|
|
1696
1775
|
/**
|
|
1697
1776
|
* Delete Secret
|
|
1698
1777
|
*
|
|
1699
|
-
* Delete a secret permanently.
|
|
1700
|
-
*
|
|
1778
|
+
* Delete a secret permanently. Refused with 409 while a tool, integration or
|
|
1779
|
+
* carrier account references it. Organization admins only.
|
|
1701
1780
|
*/
|
|
1702
1781
|
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1703
1782
|
secret_id: string;
|
|
@@ -2343,6 +2422,173 @@ export declare class Webhooks extends HeyApiClient {
|
|
|
2343
2422
|
webhook_id: string;
|
|
2344
2423
|
}, options?: Options<never, ThrowOnError>): RequestResult<WebhooksTestResults, WebhooksTestErrors, ThrowOnError, 'data'>;
|
|
2345
2424
|
}
|
|
2425
|
+
export declare class Recipients3 extends HeyApiClient {
|
|
2426
|
+
/**
|
|
2427
|
+
* List Whatsapp Batch Recipients
|
|
2428
|
+
*
|
|
2429
|
+
* A batch's rows in upload order, each with its rendered message.
|
|
2430
|
+
*
|
|
2431
|
+
* `status` may repeat; a row matching any of them is returned.
|
|
2432
|
+
*/
|
|
2433
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
2434
|
+
batch_id: string;
|
|
2435
|
+
limit?: number;
|
|
2436
|
+
offset?: number;
|
|
2437
|
+
status?: Array<'ready' | 'skipped' | 'sending' | 'queued' | 'sent' | 'delivered' | 'read' | 'undelivered' | 'failed' | 'replied'> | null;
|
|
2438
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsListResults, WhatsappBatchesRecipientsListErrors, ThrowOnError, 'data'>;
|
|
2439
|
+
/**
|
|
2440
|
+
* Restore Whatsapp Batch Recipients
|
|
2441
|
+
*
|
|
2442
|
+
* Put rows a person skipped back. A row skipped for its cells returns when they are fixed.
|
|
2443
|
+
*/
|
|
2444
|
+
restore<ThrowOnError extends boolean = false>(parameters: {
|
|
2445
|
+
batch_id: string;
|
|
2446
|
+
selectRecipientsRequest: SelectRecipientsRequest;
|
|
2447
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsRestoreResults, WhatsappBatchesRecipientsRestoreErrors, ThrowOnError, 'data'>;
|
|
2448
|
+
/**
|
|
2449
|
+
* Skip Whatsapp Batch Recipients
|
|
2450
|
+
*
|
|
2451
|
+
* Take ready rows out of the send. Reversible with restore.
|
|
2452
|
+
*/
|
|
2453
|
+
skip<ThrowOnError extends boolean = false>(parameters: {
|
|
2454
|
+
batch_id: string;
|
|
2455
|
+
selectRecipientsRequest: SelectRecipientsRequest;
|
|
2456
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsSkipResults, WhatsappBatchesRecipientsSkipErrors, ThrowOnError, 'data'>;
|
|
2457
|
+
/**
|
|
2458
|
+
* Patch Whatsapp Batch Recipient
|
|
2459
|
+
*
|
|
2460
|
+
* Edit cells on a row not yet sent, its phone included. An empty value clears the edit.
|
|
2461
|
+
*/
|
|
2462
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
2463
|
+
batch_id: string;
|
|
2464
|
+
recipient_id: string;
|
|
2465
|
+
patchWhatsAppRecipientRequest: PatchWhatsAppRecipientRequest;
|
|
2466
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsUpdateResults, WhatsappBatchesRecipientsUpdateErrors, ThrowOnError, 'data'>;
|
|
2467
|
+
}
|
|
2468
|
+
export declare class Batches3 extends HeyApiClient {
|
|
2469
|
+
/**
|
|
2470
|
+
* List Whatsapp Batches
|
|
2471
|
+
*
|
|
2472
|
+
* List WhatsApp batches, newest first.
|
|
2473
|
+
*/
|
|
2474
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2475
|
+
limit?: number;
|
|
2476
|
+
offset?: number;
|
|
2477
|
+
status?: 'draft' | 'scheduled' | 'sending' | 'paused' | 'completed' | 'canceled' | 'failed' | null;
|
|
2478
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesListResults, WhatsappBatchesListErrors, ThrowOnError, 'data'>;
|
|
2479
|
+
/**
|
|
2480
|
+
* Create Whatsapp Batch
|
|
2481
|
+
*
|
|
2482
|
+
* Create a WhatsApp batch: one approved template, sent once per CSV row. Sends nothing yet.
|
|
2483
|
+
*
|
|
2484
|
+
* Only message people who opted in to hear from you on WhatsApp. A row with an
|
|
2485
|
+
* invalid or repeated phone, or a blank or line-broken mapped cell, is kept and
|
|
2486
|
+
* skipped with the reason. Replies go to the sender's assigned agent, which
|
|
2487
|
+
* sees the row's cells as `{{userdata.<column>}}`.
|
|
2488
|
+
*/
|
|
2489
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
2490
|
+
createWhatsAppBatchRequest: CreateWhatsAppBatchRequest;
|
|
2491
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesCreateResults, WhatsappBatchesCreateErrors, ThrowOnError, 'data'>;
|
|
2492
|
+
/**
|
|
2493
|
+
* Delete Whatsapp Batch
|
|
2494
|
+
*
|
|
2495
|
+
* Delete a batch and its rows for good. A live batch must be canceled first.
|
|
2496
|
+
*
|
|
2497
|
+
* The conversations it started stay; its delivery and reply counts do not.
|
|
2498
|
+
*/
|
|
2499
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
2500
|
+
batch_id: string;
|
|
2501
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesDeleteResults, WhatsappBatchesDeleteErrors, ThrowOnError, 'data'>;
|
|
2502
|
+
/**
|
|
2503
|
+
* Get Whatsapp Batch
|
|
2504
|
+
*
|
|
2505
|
+
* One batch: its template, schedule and per-status counts, `replied` included.
|
|
2506
|
+
*/
|
|
2507
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
2508
|
+
batch_id: string;
|
|
2509
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesGetResults, WhatsappBatchesGetErrors, ThrowOnError, 'data'>;
|
|
2510
|
+
/**
|
|
2511
|
+
* Patch Whatsapp Batch
|
|
2512
|
+
*
|
|
2513
|
+
* Edit a batch. Pacing and the window reach a live send within minutes.
|
|
2514
|
+
*
|
|
2515
|
+
* `variable_map` changes only before sending, `start_at` only before it begins;
|
|
2516
|
+
* a finished batch takes `name` alone.
|
|
2517
|
+
*/
|
|
2518
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
2519
|
+
batch_id: string;
|
|
2520
|
+
patchWhatsAppBatchRequest: PatchWhatsAppBatchRequest;
|
|
2521
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesUpdateResults, WhatsappBatchesUpdateErrors, ThrowOnError, 'data'>;
|
|
2522
|
+
/**
|
|
2523
|
+
* Cancel Whatsapp Batch
|
|
2524
|
+
*
|
|
2525
|
+
* Stop for good. Messages already sent stay sent, and replies are still answered.
|
|
2526
|
+
*/
|
|
2527
|
+
cancel<ThrowOnError extends boolean = false>(parameters: {
|
|
2528
|
+
batch_id: string;
|
|
2529
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesCancelResults, WhatsappBatchesCancelErrors, ThrowOnError, 'data'>;
|
|
2530
|
+
/**
|
|
2531
|
+
* Pause Whatsapp Batch
|
|
2532
|
+
*
|
|
2533
|
+
* Stop sending before the next message. Nothing is lost.
|
|
2534
|
+
*/
|
|
2535
|
+
pause<ThrowOnError extends boolean = false>(parameters: {
|
|
2536
|
+
batch_id: string;
|
|
2537
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesPauseResults, WhatsappBatchesPauseErrors, ThrowOnError, 'data'>;
|
|
2538
|
+
/**
|
|
2539
|
+
* Resume Whatsapp Batch
|
|
2540
|
+
*
|
|
2541
|
+
* Carry on sending from where the batch stopped.
|
|
2542
|
+
*/
|
|
2543
|
+
resume<ThrowOnError extends boolean = false>(parameters: {
|
|
2544
|
+
batch_id: string;
|
|
2545
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesResumeResults, WhatsappBatchesResumeErrors, ThrowOnError, 'data'>;
|
|
2546
|
+
/**
|
|
2547
|
+
* Send Whatsapp Batch
|
|
2548
|
+
*
|
|
2549
|
+
* Send every ready row. **This messages real people and cannot be undone.**
|
|
2550
|
+
*
|
|
2551
|
+
* `start_at` schedules it, `window` holds it to business hours, and
|
|
2552
|
+
* `send_daily_cap` (default 250, Meta's lowest tier) and `send_gap_seconds`
|
|
2553
|
+
* pace it.
|
|
2554
|
+
*/
|
|
2555
|
+
send<ThrowOnError extends boolean = false>(parameters: {
|
|
2556
|
+
batch_id: string;
|
|
2557
|
+
sendWhatsAppBatchRequest: SendWhatsAppBatchRequest;
|
|
2558
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesSendResults, WhatsappBatchesSendErrors, ThrowOnError, 'data'>;
|
|
2559
|
+
private _recipients?;
|
|
2560
|
+
get recipients(): Recipients3;
|
|
2561
|
+
}
|
|
2562
|
+
export declare class Templates extends HeyApiClient {
|
|
2563
|
+
/**
|
|
2564
|
+
* List Whatsapp Templates
|
|
2565
|
+
*
|
|
2566
|
+
* List a WhatsApp sender's approved templates, read live from its BSP.
|
|
2567
|
+
*
|
|
2568
|
+
* One with `unsupported_reason` set cannot be sent from a batch.
|
|
2569
|
+
*/
|
|
2570
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
2571
|
+
integration_id: string;
|
|
2572
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappTemplatesListResults, WhatsappTemplatesListErrors, ThrowOnError, 'data'>;
|
|
2573
|
+
}
|
|
2574
|
+
export declare class TwilioSenders extends HeyApiClient {
|
|
2575
|
+
/**
|
|
2576
|
+
* List Twilio Whatsapp Senders
|
|
2577
|
+
*
|
|
2578
|
+
* List the WhatsApp senders on a Twilio account, before connecting one. Stores nothing.
|
|
2579
|
+
*/
|
|
2580
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
2581
|
+
twilioSendersRequest: TwilioSendersRequest;
|
|
2582
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappTwilioSendersListResults, WhatsappTwilioSendersListErrors, ThrowOnError, 'data'>;
|
|
2583
|
+
}
|
|
2584
|
+
export declare class Whatsapp extends HeyApiClient {
|
|
2585
|
+
private _batches?;
|
|
2586
|
+
get batches(): Batches3;
|
|
2587
|
+
private _templates?;
|
|
2588
|
+
get templates(): Templates;
|
|
2589
|
+
private _twilioSenders?;
|
|
2590
|
+
get twilioSenders(): TwilioSenders;
|
|
2591
|
+
}
|
|
2346
2592
|
export declare class TalqingApi extends HeyApiClient {
|
|
2347
2593
|
static readonly __registry: HeyApiRegistry<TalqingApi>;
|
|
2348
2594
|
constructor(args?: {
|
|
@@ -2370,6 +2616,8 @@ export declare class TalqingApi extends HeyApiClient {
|
|
|
2370
2616
|
get calls(): Calls;
|
|
2371
2617
|
private _catalog?;
|
|
2372
2618
|
get catalog(): Catalog;
|
|
2619
|
+
private _chats?;
|
|
2620
|
+
get chats(): Chats;
|
|
2373
2621
|
private _conversations?;
|
|
2374
2622
|
get conversations(): Conversations;
|
|
2375
2623
|
private _copilot?;
|
|
@@ -2394,6 +2642,8 @@ export declare class TalqingApi extends HeyApiClient {
|
|
|
2394
2642
|
get tools(): Tools2;
|
|
2395
2643
|
private _webhooks?;
|
|
2396
2644
|
get webhooks(): Webhooks;
|
|
2645
|
+
private _whatsapp?;
|
|
2646
|
+
get whatsapp(): Whatsapp;
|
|
2397
2647
|
}
|
|
2398
2648
|
export {};
|
|
2399
2649
|
//# sourceMappingURL=sdk.gen.d.ts.map
|