@talqing/sdk 0.8.0 → 0.9.1
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/LICENSE +1 -1
- package/README.md +7 -17
- package/dist/cjs/client.js +1 -1
- package/dist/cjs/client.js.map +1 -1
- 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 +106 -248
- package/dist/cjs/gen/sdk.gen.d.ts.map +1 -1
- package/dist/cjs/gen/sdk.gen.js +234 -462
- package/dist/cjs/gen/sdk.gen.js.map +1 -1
- package/dist/cjs/gen/types.gen.d.ts +647 -1236
- package/dist/cjs/gen/types.gen.d.ts.map +1 -1
- package/dist/esm/client.js +1 -1
- package/dist/esm/client.js.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 +106 -248
- package/dist/esm/gen/sdk.gen.d.ts.map +1 -1
- package/dist/esm/gen/sdk.gen.js +227 -453
- package/dist/esm/gen/sdk.gen.js.map +1 -1
- package/dist/esm/gen/types.gen.d.ts +647 -1236
- package/dist/esm/gen/types.gen.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/gen/index.ts +1 -1
- package/src/gen/sdk.gen.ts +308 -563
- package/src/gen/types.gen.ts +645 -1274
|
@@ -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 { AddEmailRecipientsRequest, AddRecipientsRequest, AddVoiceRequest, AddWhatsAppRecipientsRequest, 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, EmailBatchesRecipientsAddErrors, EmailBatchesRecipientsAddResults, 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, WhatsappBatchesRecipientsAddErrors, WhatsappBatchesRecipientsAddResults, WhatsappBatchesRecipientsListErrors, WhatsappBatchesRecipientsListResults, WhatsappBatchesRecipientsRestoreErrors, WhatsappBatchesRecipientsRestoreResults, WhatsappBatchesRecipientsSkipErrors, WhatsappBatchesRecipientsSkipResults, WhatsappBatchesRecipientsUpdateErrors, WhatsappBatchesRecipientsUpdateResults, WhatsappBatchesResumeErrors, WhatsappBatchesResumeResults, WhatsappBatchesSendErrors, WhatsappBatchesSendResults, WhatsappBatchesUpdateErrors, WhatsappBatchesUpdateResults, WhatsappTemplatesListErrors, WhatsappTemplatesListResults, WhatsappTwilioSendersListErrors, WhatsappTwilioSendersListResults } from './types.gen.js';
|
|
2
|
+
import type { AddEmailRecipientsRequest, AddRecipientsRequest, AddVoiceRequest, AddWhatsAppRecipientsRequest, 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, CallsAnalysisBackfillErrors, CallsAnalysisBackfillResults, CallsAnalysisPreviewErrors, CallsAnalysisPreviewResults, CallsBatchesCancelErrors, CallsBatchesCancelResults, CallsBatchesCreateErrors, CallsBatchesCreateResults, CallsBatchesDeleteErrors, CallsBatchesDeleteResults, CallsBatchesGetErrors, CallsBatchesGetResults, CallsBatchesListErrors, CallsBatchesListResults, CallsBatchesPauseErrors, CallsBatchesPauseResults, CallsBatchesRecipientsAddErrors, CallsBatchesRecipientsAddResults, CallsBatchesRecipientsDeleteErrors, CallsBatchesRecipientsDeleteResults, 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, CopilotTasksSendErrors, CopilotTasksSendResults, CopilotTasksStreamResult, CopilotTasksStreamResults, CopilotToolsSendErrors, CopilotToolsSendResults, CopilotToolsStreamResult, CopilotToolsStreamResults, CreateAgentRequest, CreateCallBatchRequest, CreateChatRequest, CreateEmailBatchRequest, CreateEmailSendRequest, CreateFaqEntriesRequest, CreateIntegrationRequest, CreateIntegrationTriggerRequest, CreateSecretRequest, CreateStreamConnectionRequest, CreateTaskRequest, CreateTelephonyAccountRequest, CreateToolRequest, CreateWebhookRequest, CreateWhatsAppBatchRequest, CreditCheckoutRequest, DeleteRecipientsRequest, EmailBatchesCancelErrors, EmailBatchesCancelResults, EmailBatchesCreateErrors, EmailBatchesCreateResults, EmailBatchesDeleteErrors, EmailBatchesDeleteResults, EmailBatchesGetErrors, EmailBatchesGetResults, EmailBatchesListErrors, EmailBatchesListResults, EmailBatchesPauseErrors, EmailBatchesPauseResults, EmailBatchesRecipientsAddErrors, EmailBatchesRecipientsAddResults, EmailBatchesRecipientsDeleteErrors, EmailBatchesRecipientsDeleteResults, EmailBatchesRecipientsListErrors, EmailBatchesRecipientsListResults, EmailBatchesRecipientsRedraftErrors, EmailBatchesRecipientsRedraftResults, EmailBatchesRecipientsUpdateErrors, EmailBatchesRecipientsUpdateResults, EmailBatchesResumeErrors, EmailBatchesResumeResults, EmailBatchesSendsCancelErrors, EmailBatchesSendsCancelResults, EmailBatchesSendsCreateErrors, EmailBatchesSendsCreateResults, EmailBatchesSendsGetErrors, EmailBatchesSendsGetResults, EmailBatchesSendsListErrors, EmailBatchesSendsListResults, EmailBatchesSendsPauseErrors, EmailBatchesSendsPauseResults, EmailBatchesSendsResumeErrors, EmailBatchesSendsResumeResults, EmailBatchesSendsUpdateErrors, EmailBatchesSendsUpdateResults, EmailBatchesUpdateErrors, EmailBatchesUpdateResults, EmailSendersListErrors, EmailSendersListResults, FaqDefinition, FaqsCreateErrors, FaqsCreateResults, FaqsDeleteErrors, FaqsDeleteResults, FaqsEntriesCreateErrors, FaqsEntriesCreateResults, FaqsEntriesDeleteErrors, FaqsEntriesDeleteResults, FaqsEntriesUpdateErrors, FaqsEntriesUpdateResults, FaqsGetErrors, FaqsGetResults, FaqsListErrors, FaqsListResults, FaqsUpdateErrors, FaqsUpdateResults, 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, ObservabilityGetErrors, ObservabilityGetResults, OutboundCallRequest, PatchCallBatchRequest, PatchConversationRequest, PatchEmailBatchRequest, PatchEmailRecipientRequest, PatchEmailSendRequest, PatchIntegrationRequest, PatchIntegrationTriggerRequest, 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, 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, UpdateFaqEntryRequest, UpdateFaqRequest, 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, WhatsappBatchesRecipientsAddErrors, WhatsappBatchesRecipientsAddResults, WhatsappBatchesRecipientsDeleteErrors, WhatsappBatchesRecipientsDeleteResults, WhatsappBatchesRecipientsListErrors, WhatsappBatchesRecipientsListResults, 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
|
|
@@ -152,20 +152,10 @@ export declare class Credits extends HeyApiClient {
|
|
|
152
152
|
/**
|
|
153
153
|
* Get Credits
|
|
154
154
|
*
|
|
155
|
-
* This workspace's credit balance
|
|
156
|
-
* top-up costs.
|
|
155
|
+
* This workspace's credit balance, what it buys, and what a top-up costs.
|
|
157
156
|
*
|
|
158
157
|
* Readable by every role: a VIEWER can start a web call, so a VIEWER must be
|
|
159
158
|
* able to see why one was refused.
|
|
160
|
-
*
|
|
161
|
-
* This is also where credit the control plane could not deliver lands. Anything
|
|
162
|
-
* it has issued for this workspace here — a purchase, a signup grant, a
|
|
163
|
-
* reversal — that this region has not written yet is applied before the balance
|
|
164
|
-
* is read. That is the backstop for a failed push, and it is a reconcile on
|
|
165
|
-
* demand rather than a timer: the moment someone cares is the moment this page
|
|
166
|
-
* loads, whether they arrived from the payment processor or from the "out of
|
|
167
|
-
* credits" banner. It costs nothing when there is nothing to apply, which is
|
|
168
|
-
* almost always.
|
|
169
159
|
*/
|
|
170
160
|
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
171
161
|
topup?: string | null;
|
|
@@ -177,11 +167,6 @@ export declare class Credits extends HeyApiClient {
|
|
|
177
167
|
*
|
|
178
168
|
* Organization admins only — spending the workspace's money is an admin act,
|
|
179
169
|
* the same as storing a secret or a provider key.
|
|
180
|
-
*
|
|
181
|
-
* The credit lands in THIS region, and that is decided by which region's API
|
|
182
|
-
* you called rather than by anything in the request. A slug in a body could be
|
|
183
|
-
* pointed at the other region, where the money would then be stuck: balances
|
|
184
|
-
* are per region and there is no transfer between them.
|
|
185
170
|
*/
|
|
186
171
|
checkout<ThrowOnError extends boolean = false>(parameters: {
|
|
187
172
|
creditCheckoutRequest: CreditCheckoutRequest;
|
|
@@ -189,7 +174,7 @@ export declare class Credits extends HeyApiClient {
|
|
|
189
174
|
/**
|
|
190
175
|
* List Credit Ledger
|
|
191
176
|
*
|
|
192
|
-
* Every movement of this
|
|
177
|
+
* Every movement of this workspace's balance, newest first, with what caused each.
|
|
193
178
|
*/
|
|
194
179
|
ledger<ThrowOnError extends boolean = false>(parameters?: {
|
|
195
180
|
limit?: number;
|
|
@@ -296,6 +281,15 @@ export declare class Recipients extends HeyApiClient {
|
|
|
296
281
|
batch_id: string;
|
|
297
282
|
addRecipientsRequest: AddRecipientsRequest;
|
|
298
283
|
}, options?: Options<never, ThrowOnError>): RequestResult<CallsBatchesRecipientsAddResults, CallsBatchesRecipientsAddErrors, ThrowOnError, 'data'>;
|
|
284
|
+
/**
|
|
285
|
+
* Delete Call Batch Recipients
|
|
286
|
+
*
|
|
287
|
+
* Remove rows that were never dialled. Not reversible; a dialled row is refused in `rejected`.
|
|
288
|
+
*/
|
|
289
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
290
|
+
batch_id: string;
|
|
291
|
+
deleteRecipientsRequest: DeleteRecipientsRequest;
|
|
292
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<CallsBatchesRecipientsDeleteResults, CallsBatchesRecipientsDeleteErrors, ThrowOnError, 'data'>;
|
|
299
293
|
}
|
|
300
294
|
export declare class Batches extends HeyApiClient {
|
|
301
295
|
/**
|
|
@@ -1023,32 +1017,6 @@ export declare class Agents2 extends HeyApiClient {
|
|
|
1023
1017
|
agent_id: string;
|
|
1024
1018
|
}, options?: Options<never, ThrowOnError, CopilotAgentsStreamResult>): Promise<ServerSentEventsResult<CopilotAgentsStreamResults>>;
|
|
1025
1019
|
}
|
|
1026
|
-
export declare class Knowledge extends HeyApiClient {
|
|
1027
|
-
/**
|
|
1028
|
-
* Knowledge Copilot Send Message
|
|
1029
|
-
*
|
|
1030
|
-
* Say something to KnowledgeCoPilot. The reply arrives on the stream, not here.
|
|
1031
|
-
*
|
|
1032
|
-
* Returns as soon as the turn is queued; watch `turn` and `message` frames
|
|
1033
|
-
* on the matching `/stream` for what it does.
|
|
1034
|
-
*/
|
|
1035
|
-
send<ThrowOnError extends boolean = false>(parameters: {
|
|
1036
|
-
kb_id: string;
|
|
1037
|
-
sendMessageRequest: SendMessageRequest;
|
|
1038
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<CopilotKnowledgeSendResults, CopilotKnowledgeSendErrors, ThrowOnError, 'data'>;
|
|
1039
|
-
/**
|
|
1040
|
-
* Knowledge Copilot Stream
|
|
1041
|
-
*
|
|
1042
|
-
* KnowledgeCoPilot's curation chat for one knowledge base.
|
|
1043
|
-
*
|
|
1044
|
-
* Frames: `snapshot` (the whole conversation, sent first and on every
|
|
1045
|
-
* reconnect), `message` (one new message), `turn` (that turn's lifecycle —
|
|
1046
|
-
* `running`, `done`, `error`, `canceled`).
|
|
1047
|
-
*/
|
|
1048
|
-
stream<ThrowOnError extends boolean = false>(parameters: {
|
|
1049
|
-
kb_id: string;
|
|
1050
|
-
}, options?: Options<never, ThrowOnError, CopilotKnowledgeStreamResult>): Promise<ServerSentEventsResult<CopilotKnowledgeStreamResults>>;
|
|
1051
|
-
}
|
|
1052
1020
|
export declare class Tasks extends HeyApiClient {
|
|
1053
1021
|
/**
|
|
1054
1022
|
* Task Copilot Send Message
|
|
@@ -1104,8 +1072,6 @@ export declare class Tools extends HeyApiClient {
|
|
|
1104
1072
|
export declare class Copilot extends HeyApiClient {
|
|
1105
1073
|
private _agents?;
|
|
1106
1074
|
get agents(): Agents2;
|
|
1107
|
-
private _knowledge?;
|
|
1108
|
-
get knowledge(): Knowledge;
|
|
1109
1075
|
private _tasks?;
|
|
1110
1076
|
get tasks(): Tasks;
|
|
1111
1077
|
private _tools?;
|
|
@@ -1140,6 +1106,15 @@ export declare class Recipients2 extends HeyApiClient {
|
|
|
1140
1106
|
batch_id: string;
|
|
1141
1107
|
addEmailRecipientsRequest: AddEmailRecipientsRequest;
|
|
1142
1108
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBatchesRecipientsAddResults, EmailBatchesRecipientsAddErrors, ThrowOnError, 'data'>;
|
|
1109
|
+
/**
|
|
1110
|
+
* Delete Email Batch Recipients
|
|
1111
|
+
*
|
|
1112
|
+
* Remove rows that were never sent. Not reversible; a sent row is refused in `rejected`.
|
|
1113
|
+
*/
|
|
1114
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1115
|
+
batch_id: string;
|
|
1116
|
+
deleteRecipientsRequest: DeleteRecipientsRequest;
|
|
1117
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBatchesRecipientsDeleteResults, EmailBatchesRecipientsDeleteErrors, ThrowOnError, 'data'>;
|
|
1143
1118
|
/**
|
|
1144
1119
|
* Patch Email Batch Recipient
|
|
1145
1120
|
*
|
|
@@ -1174,28 +1149,6 @@ export declare class Recipients2 extends HeyApiClient {
|
|
|
1174
1149
|
batch_id: string;
|
|
1175
1150
|
redraftRequest: RedraftRequest;
|
|
1176
1151
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBatchesRecipientsRedraftResults, EmailBatchesRecipientsRedraftErrors, ThrowOnError, 'data'>;
|
|
1177
|
-
/**
|
|
1178
|
-
* Restore Email Batch Recipients
|
|
1179
|
-
*
|
|
1180
|
-
* Put skipped rows back. `selection: "all_eligible"` means every row a person
|
|
1181
|
-
* skipped; an `unfillable` row is restored by filling in its cell instead.
|
|
1182
|
-
*/
|
|
1183
|
-
restore<ThrowOnError extends boolean = false>(parameters: {
|
|
1184
|
-
batch_id: string;
|
|
1185
|
-
selectRecipientsRequest: SelectRecipientsRequest;
|
|
1186
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBatchesRecipientsRestoreResults, EmailBatchesRecipientsRestoreErrors, ThrowOnError, 'data'>;
|
|
1187
|
-
/**
|
|
1188
|
-
* Skip Email Batch Recipients
|
|
1189
|
-
*
|
|
1190
|
-
* Take rows out of consideration. Reversible with `restore`.
|
|
1191
|
-
*
|
|
1192
|
-
* Accepts drafted rows and rows whose drafting failed. Takes either
|
|
1193
|
-
* `recipient_ids` or `selection: "all_eligible"`, which here means both.
|
|
1194
|
-
*/
|
|
1195
|
-
skip<ThrowOnError extends boolean = false>(parameters: {
|
|
1196
|
-
batch_id: string;
|
|
1197
|
-
selectRecipientsRequest: SelectRecipientsRequest;
|
|
1198
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<EmailBatchesRecipientsSkipResults, EmailBatchesRecipientsSkipErrors, ThrowOnError, 'data'>;
|
|
1199
1152
|
}
|
|
1200
1153
|
export declare class Sends extends HeyApiClient {
|
|
1201
1154
|
/**
|
|
@@ -1421,6 +1374,84 @@ export declare class Email extends HeyApiClient {
|
|
|
1421
1374
|
private _senders?;
|
|
1422
1375
|
get senders(): Senders;
|
|
1423
1376
|
}
|
|
1377
|
+
export declare class Entries extends HeyApiClient {
|
|
1378
|
+
/**
|
|
1379
|
+
* Create Faq Entries
|
|
1380
|
+
*
|
|
1381
|
+
* Append question/answer entries to an FAQ, all or nothing. Live at once:
|
|
1382
|
+
* agents using the FAQ read them from their next session.
|
|
1383
|
+
*/
|
|
1384
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
1385
|
+
faq_id: string;
|
|
1386
|
+
createFaqEntriesRequest: CreateFaqEntriesRequest;
|
|
1387
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<FaqsEntriesCreateResults, FaqsEntriesCreateErrors, ThrowOnError, 'data'>;
|
|
1388
|
+
/**
|
|
1389
|
+
* Delete Faq Entry
|
|
1390
|
+
*
|
|
1391
|
+
* Delete one entry from an FAQ.
|
|
1392
|
+
*/
|
|
1393
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1394
|
+
faq_id: string;
|
|
1395
|
+
entry_id: string;
|
|
1396
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<FaqsEntriesDeleteResults, FaqsEntriesDeleteErrors, ThrowOnError, 'data'>;
|
|
1397
|
+
/**
|
|
1398
|
+
* Update Faq Entry
|
|
1399
|
+
*
|
|
1400
|
+
* Change one entry's question, answer or both. Live from the next session.
|
|
1401
|
+
*/
|
|
1402
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
1403
|
+
faq_id: string;
|
|
1404
|
+
entry_id: string;
|
|
1405
|
+
updateFaqEntryRequest: UpdateFaqEntryRequest;
|
|
1406
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<FaqsEntriesUpdateResults, FaqsEntriesUpdateErrors, ThrowOnError, 'data'>;
|
|
1407
|
+
}
|
|
1408
|
+
export declare class Faqs extends HeyApiClient {
|
|
1409
|
+
/**
|
|
1410
|
+
* List Faqs
|
|
1411
|
+
*
|
|
1412
|
+
* List the workspace's FAQs by name, with how many questions each holds.
|
|
1413
|
+
*/
|
|
1414
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1415
|
+
limit?: number;
|
|
1416
|
+
offset?: number;
|
|
1417
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<FaqsListResults, FaqsListErrors, ThrowOnError, 'data'>;
|
|
1418
|
+
/**
|
|
1419
|
+
* Create Faq
|
|
1420
|
+
*
|
|
1421
|
+
* Create an FAQ, optionally with its first question/answer entries.
|
|
1422
|
+
*/
|
|
1423
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
1424
|
+
faqDefinition: FaqDefinition;
|
|
1425
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<FaqsCreateResults, FaqsCreateErrors, ThrowOnError, 'data'>;
|
|
1426
|
+
/**
|
|
1427
|
+
* Delete Faq
|
|
1428
|
+
*
|
|
1429
|
+
* Delete an FAQ and its entries. Refused with 409 while an agent or task
|
|
1430
|
+
* still attaches it.
|
|
1431
|
+
*/
|
|
1432
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1433
|
+
faq_id: string;
|
|
1434
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<FaqsDeleteResults, FaqsDeleteErrors, ThrowOnError, 'data'>;
|
|
1435
|
+
/**
|
|
1436
|
+
* Get Faq
|
|
1437
|
+
*
|
|
1438
|
+
* Get one FAQ with every entry, in the order they were added.
|
|
1439
|
+
*/
|
|
1440
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
1441
|
+
faq_id: string;
|
|
1442
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<FaqsGetResults, FaqsGetErrors, ThrowOnError, 'data'>;
|
|
1443
|
+
/**
|
|
1444
|
+
* Update Faq
|
|
1445
|
+
*
|
|
1446
|
+
* Rename an FAQ.
|
|
1447
|
+
*/
|
|
1448
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
1449
|
+
faq_id: string;
|
|
1450
|
+
updateFaqRequest: UpdateFaqRequest;
|
|
1451
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<FaqsUpdateResults, FaqsUpdateErrors, ThrowOnError, 'data'>;
|
|
1452
|
+
private _entries?;
|
|
1453
|
+
get entries(): Entries;
|
|
1454
|
+
}
|
|
1424
1455
|
export declare class McpTools extends HeyApiClient {
|
|
1425
1456
|
/**
|
|
1426
1457
|
* List Integration Mcp Tools
|
|
@@ -1573,170 +1604,6 @@ export declare class Integrations extends HeyApiClient {
|
|
|
1573
1604
|
private _triggers?;
|
|
1574
1605
|
get triggers(): Triggers;
|
|
1575
1606
|
}
|
|
1576
|
-
export declare class Nodes extends HeyApiClient {
|
|
1577
|
-
/**
|
|
1578
|
-
* Delete Node
|
|
1579
|
-
*
|
|
1580
|
-
* Drop one entry from the table of contents, permanently.
|
|
1581
|
-
*
|
|
1582
|
-
* Its children go with it, and agents can no longer retrieve any of it.
|
|
1583
|
-
*/
|
|
1584
|
-
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1585
|
-
kb_id: string;
|
|
1586
|
-
node_id: string;
|
|
1587
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgeNodesDeleteResults, KnowledgeNodesDeleteErrors, ThrowOnError, 'data'>;
|
|
1588
|
-
/**
|
|
1589
|
-
* Get Node
|
|
1590
|
-
*
|
|
1591
|
-
* Read one entry of the table of contents, with its full content.
|
|
1592
|
-
*
|
|
1593
|
-
* This is the text an agent retrieves when it fetches this node. `version` is
|
|
1594
|
-
* what `patch_node` needs for a safe edit.
|
|
1595
|
-
*/
|
|
1596
|
-
get<ThrowOnError extends boolean = false>(parameters: {
|
|
1597
|
-
kb_id: string;
|
|
1598
|
-
node_id: string;
|
|
1599
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgeNodesGetResults, KnowledgeNodesGetErrors, ThrowOnError, 'data'>;
|
|
1600
|
-
/**
|
|
1601
|
-
* Patch Node
|
|
1602
|
-
*
|
|
1603
|
-
* Correct one entry's title, summary or content by hand — the way to fix a
|
|
1604
|
-
* fact the crawl got wrong without rebuilding.
|
|
1605
|
-
*
|
|
1606
|
-
* `title` and `summary` are what the agent sees in the table of contents and
|
|
1607
|
-
* decide whether it ever fetches this node, so keep them accurate.
|
|
1608
|
-
*
|
|
1609
|
-
* Send the `version` you read from `get_node`; a mismatch is rejected rather
|
|
1610
|
-
* than overwriting someone else's edit.
|
|
1611
|
-
*/
|
|
1612
|
-
update<ThrowOnError extends boolean = false>(parameters: {
|
|
1613
|
-
kb_id: string;
|
|
1614
|
-
node_id: string;
|
|
1615
|
-
patchNodeRequest: PatchNodeRequest;
|
|
1616
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgeNodesUpdateResults, KnowledgeNodesUpdateErrors, ThrowOnError, 'data'>;
|
|
1617
|
-
}
|
|
1618
|
-
export declare class Pages extends HeyApiClient {
|
|
1619
|
-
/**
|
|
1620
|
-
* List Pages
|
|
1621
|
-
*
|
|
1622
|
-
* List the crawled pages and how each one transcribed.
|
|
1623
|
-
*
|
|
1624
|
-
* Where you look when a knowledge base is missing something: a page with a
|
|
1625
|
-
* non-`done` status and an `error` never made it in, and `content_len` of 0
|
|
1626
|
-
* means the URL yielded nothing worth indexing.
|
|
1627
|
-
*/
|
|
1628
|
-
list<ThrowOnError extends boolean = false>(parameters: {
|
|
1629
|
-
kb_id: string;
|
|
1630
|
-
limit?: number;
|
|
1631
|
-
offset?: number;
|
|
1632
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgePagesListResults, KnowledgePagesListErrors, ThrowOnError, 'data'>;
|
|
1633
|
-
}
|
|
1634
|
-
export declare class Knowledge2 extends HeyApiClient {
|
|
1635
|
-
/**
|
|
1636
|
-
* List Kbs
|
|
1637
|
-
*
|
|
1638
|
-
* List the workspace's knowledge bases with their build status.
|
|
1639
|
-
*
|
|
1640
|
-
* A knowledge base gives an agent grounded answers over crawled content. Only
|
|
1641
|
-
* one with status `ready` can be attached to an agent, through the agent
|
|
1642
|
-
* config's `kb_ids`.
|
|
1643
|
-
*/
|
|
1644
|
-
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1645
|
-
limit?: number;
|
|
1646
|
-
offset?: number;
|
|
1647
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgeListResults, KnowledgeListErrors, ThrowOnError, 'data'>;
|
|
1648
|
-
/**
|
|
1649
|
-
* Create Kb
|
|
1650
|
-
*
|
|
1651
|
-
* Start a knowledge base by crawling one or more websites.
|
|
1652
|
-
*
|
|
1653
|
-
* Returns immediately with `status: discovering` — crawling takes minutes.
|
|
1654
|
-
* Poll `get_kb` until `review`, then pass the URLs worth indexing to
|
|
1655
|
-
* `build_kb`. `max_pages` caps how many discovery may find (default 1000) and
|
|
1656
|
-
* `notes` guides how the content is transcribed and organized.
|
|
1657
|
-
*/
|
|
1658
|
-
create<ThrowOnError extends boolean = false>(parameters: {
|
|
1659
|
-
createKbRequest: CreateKBRequest;
|
|
1660
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgeCreateResults, KnowledgeCreateErrors, ThrowOnError, 'data'>;
|
|
1661
|
-
/**
|
|
1662
|
-
* Delete Kb
|
|
1663
|
-
*
|
|
1664
|
-
* Delete a knowledge base and everything crawled into it, permanently.
|
|
1665
|
-
*
|
|
1666
|
-
* Rebuilding means crawling the site again. Agents that list it in `kb_ids`
|
|
1667
|
-
* lose those grounded answers, so detach it there first.
|
|
1668
|
-
*/
|
|
1669
|
-
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1670
|
-
kb_id: string;
|
|
1671
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgeDeleteResults, KnowledgeDeleteErrors, ThrowOnError, 'data'>;
|
|
1672
|
-
/**
|
|
1673
|
-
* Get Kb
|
|
1674
|
-
*
|
|
1675
|
-
* Read one knowledge base: build status, progress and content tree.
|
|
1676
|
-
*
|
|
1677
|
-
* `status` walks `discovering` -> `review` -> `transcribing` -> `generating`
|
|
1678
|
-
* -> `ready`, with `error` set if it stopped. At `review`, `discovered` holds
|
|
1679
|
-
* the crawled URLs awaiting your selection; once ready, `tree` is the table of
|
|
1680
|
-
* contents. This is the endpoint to poll while a build runs.
|
|
1681
|
-
*/
|
|
1682
|
-
get<ThrowOnError extends boolean = false>(parameters: {
|
|
1683
|
-
kb_id: string;
|
|
1684
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgeGetResults, KnowledgeGetErrors, ThrowOnError, 'data'>;
|
|
1685
|
-
/**
|
|
1686
|
-
* Build Kb
|
|
1687
|
-
*
|
|
1688
|
-
* Index the chosen pages, then write the table of contents.
|
|
1689
|
-
*
|
|
1690
|
-
* Call this once the knowledge base reaches `review`, passing the subset of
|
|
1691
|
-
* `discovered` URLs worth indexing — the KB is only as good as that choice.
|
|
1692
|
-
* Returns as soon as the work is queued; poll `get_kb` until `ready`, which is
|
|
1693
|
-
* when it can be attached to an agent.
|
|
1694
|
-
*/
|
|
1695
|
-
build<ThrowOnError extends boolean = false>(parameters: {
|
|
1696
|
-
kb_id: string;
|
|
1697
|
-
buildKbRequest: BuildKBRequest;
|
|
1698
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgeBuildResults, KnowledgeBuildErrors, ThrowOnError, 'data'>;
|
|
1699
|
-
/**
|
|
1700
|
-
* Events
|
|
1701
|
-
*
|
|
1702
|
-
* Watch one knowledge base build: `snapshot` first, then `progress` and `status`.
|
|
1703
|
-
*
|
|
1704
|
-
* `progress` carries the per-stage counts, `status` the terminal verdict
|
|
1705
|
-
* (`ready`, or an `error`). The same state is readable at any time with
|
|
1706
|
-
* `get_kb`; this is the live view of it.
|
|
1707
|
-
*/
|
|
1708
|
-
events<ThrowOnError extends boolean = false>(parameters: {
|
|
1709
|
-
kb_id: string;
|
|
1710
|
-
}, options?: Options<never, ThrowOnError, KnowledgeEventsResult>): Promise<ServerSentEventsResult<KnowledgeEventsResults>>;
|
|
1711
|
-
/**
|
|
1712
|
-
* Get Kb Prompt
|
|
1713
|
-
*
|
|
1714
|
-
* The table of contents exactly as an agent using this KB is given it.
|
|
1715
|
-
*
|
|
1716
|
-
* Read it to judge what the agent can actually find — if a topic reads
|
|
1717
|
-
* vaguely here, the agent will not know to fetch it. `chars` is how much of
|
|
1718
|
-
* the agent's context this KB occupies.
|
|
1719
|
-
*/
|
|
1720
|
-
prompt<ThrowOnError extends boolean = false>(parameters: {
|
|
1721
|
-
kb_id: string;
|
|
1722
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgePromptResults, KnowledgePromptErrors, ThrowOnError, 'data'>;
|
|
1723
|
-
/**
|
|
1724
|
-
* Regenerate Toc
|
|
1725
|
-
*
|
|
1726
|
-
* Rewrite the table of contents from the pages already indexed.
|
|
1727
|
-
*
|
|
1728
|
-
* The repair for a knowledge base whose structure came out wrong, or whose
|
|
1729
|
-
* build failed at the last stage: it re-runs only that stage, so the site is
|
|
1730
|
-
* not crawled or transcribed again.
|
|
1731
|
-
*/
|
|
1732
|
-
regenerateToc<ThrowOnError extends boolean = false>(parameters: {
|
|
1733
|
-
kb_id: string;
|
|
1734
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<KnowledgeRegenerateTocResults, KnowledgeRegenerateTocErrors, ThrowOnError, 'data'>;
|
|
1735
|
-
private _nodes?;
|
|
1736
|
-
get nodes(): Nodes;
|
|
1737
|
-
private _pages?;
|
|
1738
|
-
get pages(): Pages;
|
|
1739
|
-
}
|
|
1740
1607
|
export declare class Observability extends HeyApiClient {
|
|
1741
1608
|
/**
|
|
1742
1609
|
* Get Observability
|
|
@@ -2503,23 +2370,14 @@ export declare class Recipients3 extends HeyApiClient {
|
|
|
2503
2370
|
addWhatsAppRecipientsRequest: AddWhatsAppRecipientsRequest;
|
|
2504
2371
|
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsAddResults, WhatsappBatchesRecipientsAddErrors, ThrowOnError, 'data'>;
|
|
2505
2372
|
/**
|
|
2506
|
-
*
|
|
2373
|
+
* Delete Whatsapp Batch Recipients
|
|
2507
2374
|
*
|
|
2508
|
-
*
|
|
2375
|
+
* Remove rows that were never sent. Not reversible; a sent row is refused in `rejected`.
|
|
2509
2376
|
*/
|
|
2510
|
-
|
|
2511
|
-
batch_id: string;
|
|
2512
|
-
selectRecipientsRequest: SelectRecipientsRequest;
|
|
2513
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsRestoreResults, WhatsappBatchesRecipientsRestoreErrors, ThrowOnError, 'data'>;
|
|
2514
|
-
/**
|
|
2515
|
-
* Skip Whatsapp Batch Recipients
|
|
2516
|
-
*
|
|
2517
|
-
* Take ready rows out of the send. Reversible with restore.
|
|
2518
|
-
*/
|
|
2519
|
-
skip<ThrowOnError extends boolean = false>(parameters: {
|
|
2377
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
2520
2378
|
batch_id: string;
|
|
2521
|
-
|
|
2522
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
2379
|
+
deleteRecipientsRequest: DeleteRecipientsRequest;
|
|
2380
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<WhatsappBatchesRecipientsDeleteResults, WhatsappBatchesRecipientsDeleteErrors, ThrowOnError, 'data'>;
|
|
2523
2381
|
/**
|
|
2524
2382
|
* Patch Whatsapp Batch Recipient
|
|
2525
2383
|
*
|
|
@@ -2690,10 +2548,10 @@ export declare class TalqingApi extends HeyApiClient {
|
|
|
2690
2548
|
get copilot(): Copilot;
|
|
2691
2549
|
private _email?;
|
|
2692
2550
|
get email(): Email;
|
|
2551
|
+
private _faqs?;
|
|
2552
|
+
get faqs(): Faqs;
|
|
2693
2553
|
private _integrations?;
|
|
2694
2554
|
get integrations(): Integrations;
|
|
2695
|
-
private _knowledge?;
|
|
2696
|
-
get knowledge(): Knowledge2;
|
|
2697
2555
|
private _observability?;
|
|
2698
2556
|
get observability(): Observability;
|
|
2699
2557
|
private _schemas?;
|