import type { RequestInit, RequestInfo } from "./internal/builtin-types.js"; import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js"; export type { Logger, LogLevel } from "./internal/utils/log.js"; import * as Opts from "./internal/request-options.js"; import * as Errors from "./core/error.js"; import * as Pagination from "./core/pagination.js"; import { type CursorParams, CursorResponse } from "./core/pagination.js"; import * as Uploads from "./core/uploads.js"; import * as API from "./resources/index.js"; import { APIPromise } from "./core/api-promise.js"; import { Address, AddressCreateParams, AddressCreateResponse, AddressListParams, AddressRetrieveResponse, AddressStatus, Addresses, AddressesCursor } from "./resources/addresses.js"; import { AgentTemplateListResponse, AgentTemplateRetrieveResponse, AgentTemplates } from "./resources/agent-templates.js"; import { Balance, BalanceRetrieveResponse } from "./resources/balance.js"; import { CallCreateParams, CallCreateResponse, CallHangupResponse, CallListParams, CallListResponse, CallListResponsesCursor, CallRetrieveResponse, Calls } from "./resources/calls.js"; import { ConversationListMessagesParams, ConversationListParams, ConversationListResponse, ConversationListResponsesCursor, ConversationMarkAsReadResponse, ConversationRetrieveResponse, Conversations } from "./resources/conversations.js"; import { EmailDomainCreateParams, EmailDomainCreateResponse, EmailDomainListResponse, EmailDomainRetrieveResponse, EmailDomainVerifyResponse, EmailDomains } from "./resources/email-domains.js"; import { Introspect, IntrospectValidateEmailParams, IntrospectValidateEmailResponse, IntrospectValidatePhoneParams, IntrospectValidatePhoneResponse, LineType } from "./resources/introspect.js"; import { Invitation, InvitationCancelResponse, InvitationCreateParams, InvitationCreateResponse, InvitationListParams, InvitationRetrieveResponse, Invitations, InvitationsCursor } from "./resources/invitations.js"; import { Me, MeRetrieveResponse } from "./resources/me.js"; import { Channel, Message, MessageContent, MessageListAttachmentsResponse, MessageListParams, MessageReactParams, MessageResponse, MessageSendParams, MessageShowTypingParams, MessageShowTypingResponse, MessageStatus, MessageType, Messages, MessagesCursor } from "./resources/messages.js"; import { AvailablePhoneNumber, OwnedPhoneNumber, OwnedPhoneNumberPricing, OwnedPhoneNumbersCursor, PhoneNumberCapabilities, PhoneNumberListParams, PhoneNumberPricing, PhoneNumberPurchaseParams, PhoneNumberPurchaseResponse, PhoneNumberRequirementsParams, PhoneNumberRequirementsResponse, PhoneNumberRetrieveResponse, PhoneNumberSearchAvailableParams, PhoneNumberSearchAvailableResponse, PhoneNumberStatus, PhoneNumberType, PhoneNumberUpdateParams, PhoneNumberUpdateResponse, PhoneNumbers, Requirement, RequirementAcceptanceCriteria, RequirementFieldType, RequirementType } from "./resources/phone-numbers.js"; import { RegulatoryDocument, RegulatoryDocumentCreateParams, RegulatoryDocumentCreateResponse, RegulatoryDocumentListParams, RegulatoryDocumentRetrieveResponse, RegulatoryDocumentUploadURLResponse, RegulatoryDocuments, RegulatoryDocumentsCursor } from "./resources/regulatory-documents.js"; import { Template, TemplateCreateParams, TemplateListParams, TemplateSubmitParams, TemplateSyncParams, TemplateSyncResponse, Templates, TemplatesCursor, WhatsappCategory } from "./resources/templates.js"; import { URLEscalateParams, URLEscalateResponse, URLListVerifiedParams, URLRetrieveDetailsResponse, URLSubmitForVerificationParams, URLSubmitForVerificationResponse, URLs, VerifiedURL, VerifiedURLsCursor } from "./resources/urls.js"; import { AgentCreateParams, AgentCreateResponse, AgentListParams, AgentListVoicesParams, AgentListVoicesResponse, AgentRetrieveResponse, AgentTestParams, AgentTestResponse, AgentUpdateParams, AgentUpdateResponse, Agents } from "./resources/agents/agents.js"; import { Broadcast, BroadcastCancelResponse, BroadcastChannel, BroadcastContact, BroadcastContactStatus, BroadcastContent, BroadcastCreateParams, BroadcastCreateResponse, BroadcastEscalateReviewResponse, BroadcastListParams, BroadcastMessageType, BroadcastProgress, BroadcastRescheduleParams, BroadcastRescheduleResponse, BroadcastRetrieveResponse, BroadcastRetryReviewResponse, BroadcastSendParams, BroadcastSendResponse, BroadcastStatus, BroadcastUpdateParams, BroadcastUpdateResponse, Broadcasts, BroadcastsCursor } from "./resources/broadcasts/broadcasts.js"; import { Contact, ContactChannel, ContactCreateParams, ContactListParams, ContactMergeParams, ContactUpdateParams, Contacts, ContactsCursor } from "./resources/contacts/contacts.js"; import { FunctionCreateParams, FunctionCreateResponse, FunctionDeleteResponse, FunctionDeployParams, FunctionDeployResponse, FunctionGetDeploymentResponse, FunctionListDeploymentsParams, FunctionListDeploymentsResponse, FunctionListEventTypesResponse, FunctionRetrieveResponse, FunctionRollbackDeploymentParams, FunctionRollbackDeploymentResponse, FunctionTailLogsParams, FunctionTailLogsResponse, FunctionUpdateParams, FunctionUpdateResponse, Functions } from "./resources/functions/functions.js"; import { Number10dlc } from "./resources/number-10dlc/number-10dlc.js"; import { Sender, SenderCreateParams, SenderListParams, SenderUpdateParams, SenderUpdateProfileParams, SenderUpdateProfileResponse, SenderUploadProfilePictureParams, SenderUploadProfilePictureResponse, SenderWebhook, Senders, SendersCursor, WebhookEvent, WebhookSecretResponse, WhatsappBusinessProfile, WhatsappBusinessProfileResponse, WhatsappBusinessProfileVertical } from "./resources/senders/senders.js"; import { SubAccount, SubAccountCreateParams, SubAccountCreateResponse, SubAccountDeactivateResponse, SubAccountGetBalanceResponse, SubAccountListParams, SubAccountRetrieveResponse, SubAccountUpdateParams, SubAccountUpdateResponse, SubAccounts, SubAccountsCursor } from "./resources/sub-accounts/sub-accounts.js"; import { type Fetch } from "./internal/builtin-types.js"; import { HeadersLike, NullableHeaders } from "./internal/headers.js"; import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js"; import { type LogLevel, type Logger } from "./internal/utils/log.js"; export interface ClientOptions { /** * Defaults to process.env['ZAVUDEV_API_KEY']. */ apiKey?: string | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['ZAVUDEV_BASE_URL']. */ baseURL?: string | null | undefined; /** * The maximum amount of time (in milliseconds) that the client should wait for a response * from the server before timing out a single request. * * Note that request timeouts are retried by default, so in a worst-case scenario you may wait * much longer than this timeout before the promise succeeds or fails. * * @unit milliseconds */ timeout?: number | undefined; /** * Additional `RequestInit` options to be passed to `fetch` calls. * Properties will be overridden by per-request `fetchOptions`. */ fetchOptions?: MergedRequestInit | undefined; /** * Specify a custom `fetch` function implementation. * * If not provided, we expect that `fetch` is defined globally. */ fetch?: Fetch | undefined; /** * The maximum number of times that the client will retry a request in case of a * temporary failure, like a network error or a 5XX error from the server. * * @default 2 */ maxRetries?: number | undefined; /** * Default headers to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * header to `null` in request options. */ defaultHeaders?: HeadersLike | undefined; /** * Default query parameters to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * param to `undefined` in request options. */ defaultQuery?: Record | undefined; /** * Set the log level. * * Defaults to process.env['ZAVUDEV_LOG'] or 'warn' if it isn't set. */ logLevel?: LogLevel | undefined; /** * Set the logger. * * Defaults to globalThis.console. */ logger?: Logger | undefined; } /** * API Client for interfacing with the Zavudev API. */ export declare class Zavudev { #private; apiKey: string; baseURL: string; maxRetries: number; timeout: number; logger: Logger; logLevel: LogLevel | undefined; fetchOptions: MergedRequestInit | undefined; private fetch; protected idempotencyHeader?: string; private _options; /** * API Client for interfacing with the Zavudev API. * * @param {string | undefined} [opts.apiKey=process.env['ZAVUDEV_API_KEY'] ?? undefined] * @param {string} [opts.baseURL=process.env['ZAVUDEV_BASE_URL'] ?? https://api.zavu.dev] - Override the default base URL for the API. * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls. * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request. * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Record} opts.defaultQuery - Default query parameters to include with every request to the API. */ constructor({ baseURL, apiKey, ...opts }?: ClientOptions); /** * Create a new client instance re-using the same options given to the current client with optional overriding. */ withOptions(options: Partial): this; protected defaultQuery(): Record | undefined; protected validateHeaders({ values, nulls }: NullableHeaders): void; protected authHeaders(opts: FinalRequestOptions): Promise; protected stringifyQuery(query: object | Record): string; private getUserAgent; protected defaultIdempotencyKey(): string; protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError; buildURL(path: string, query: Record | null | undefined, defaultBaseURL?: string | undefined): string; /** * Used as a callback for mutating the given `FinalRequestOptions` object. */ protected prepareOptions(options: FinalRequestOptions): Promise; /** * Used as a callback for mutating the given `RequestInit` object. * * This is useful for cases where you want to add certain headers based off of * the request properties, e.g. `method` or `url`. */ protected prepareRequest(request: RequestInit, { url, options }: { url: string; options: FinalRequestOptions; }): Promise; get(path: string, opts?: PromiseOrValue): APIPromise; post(path: string, opts?: PromiseOrValue): APIPromise; patch(path: string, opts?: PromiseOrValue): APIPromise; put(path: string, opts?: PromiseOrValue): APIPromise; delete(path: string, opts?: PromiseOrValue): APIPromise; private methodRequest; request(options: PromiseOrValue, remainingRetries?: number | null): APIPromise; private makeRequest; getAPIList = Pagination.AbstractPage>(path: string, Page: new (...args: any[]) => PageClass, opts?: PromiseOrValue): Pagination.PagePromise; requestAPIList = Pagination.AbstractPage>(Page: new (...args: ConstructorParameters) => PageClass, options: PromiseOrValue): Pagination.PagePromise; fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise; private shouldRetry; private retryRequest; private calculateDefaultRetryTimeoutMillis; buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: { retryCount?: number; }): Promise<{ req: FinalizedRequestInit; url: string; timeout: number; }>; private buildHeaders; private _makeAbort; private buildBody; static Zavudev: typeof Zavudev; static DEFAULT_TIMEOUT: number; static ZavudevError: typeof Errors.ZavudevError; static APIError: typeof Errors.APIError; static APIConnectionError: typeof Errors.APIConnectionError; static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError; static APIUserAbortError: typeof Errors.APIUserAbortError; static NotFoundError: typeof Errors.NotFoundError; static ConflictError: typeof Errors.ConflictError; static RateLimitError: typeof Errors.RateLimitError; static BadRequestError: typeof Errors.BadRequestError; static AuthenticationError: typeof Errors.AuthenticationError; static InternalServerError: typeof Errors.InternalServerError; static PermissionDeniedError: typeof Errors.PermissionDeniedError; static UnprocessableEntityError: typeof Errors.UnprocessableEntityError; static toFile: typeof Uploads.toFile; messages: API.Messages; templates: API.Templates; senders: API.Senders; contacts: API.Contacts; broadcasts: API.Broadcasts; introspect: API.Introspect; phoneNumbers: API.PhoneNumbers; addresses: API.Addresses; regulatoryDocuments: API.RegulatoryDocuments; invitations: API.Invitations; urls: API.URLs; balance: API.Balance; subAccounts: API.SubAccounts; number10dlc: API.Number10dlc; me: API.Me; functions: API.Functions; conversations: API.Conversations; calls: API.Calls; agentTemplates: API.AgentTemplates; emailDomains: API.EmailDomains; agents: API.Agents; } export declare namespace Zavudev { export type RequestOptions = Opts.RequestOptions; export import Cursor = Pagination.Cursor; export { type CursorParams as CursorParams, type CursorResponse as CursorResponse }; export { Messages as Messages, type Channel as Channel, type Message as Message, type MessageContent as MessageContent, type MessageResponse as MessageResponse, type MessageStatus as MessageStatus, type MessageType as MessageType, type MessageListAttachmentsResponse as MessageListAttachmentsResponse, type MessageShowTypingResponse as MessageShowTypingResponse, type MessagesCursor as MessagesCursor, type MessageListParams as MessageListParams, type MessageReactParams as MessageReactParams, type MessageSendParams as MessageSendParams, type MessageShowTypingParams as MessageShowTypingParams, }; export { Templates as Templates, type Template as Template, type WhatsappCategory as WhatsappCategory, type TemplateSyncResponse as TemplateSyncResponse, type TemplatesCursor as TemplatesCursor, type TemplateCreateParams as TemplateCreateParams, type TemplateListParams as TemplateListParams, type TemplateSubmitParams as TemplateSubmitParams, type TemplateSyncParams as TemplateSyncParams, }; export { Senders as Senders, type Sender as Sender, type SenderWebhook as SenderWebhook, type WebhookEvent as WebhookEvent, type WebhookSecretResponse as WebhookSecretResponse, type WhatsappBusinessProfile as WhatsappBusinessProfile, type WhatsappBusinessProfileResponse as WhatsappBusinessProfileResponse, type WhatsappBusinessProfileVertical as WhatsappBusinessProfileVertical, type SenderUpdateProfileResponse as SenderUpdateProfileResponse, type SenderUploadProfilePictureResponse as SenderUploadProfilePictureResponse, type SendersCursor as SendersCursor, type SenderCreateParams as SenderCreateParams, type SenderUpdateParams as SenderUpdateParams, type SenderListParams as SenderListParams, type SenderUpdateProfileParams as SenderUpdateProfileParams, type SenderUploadProfilePictureParams as SenderUploadProfilePictureParams, }; export { Contacts as Contacts, type Contact as Contact, type ContactChannel as ContactChannel, type ContactsCursor as ContactsCursor, type ContactCreateParams as ContactCreateParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactMergeParams as ContactMergeParams, }; export { Broadcasts as Broadcasts, type Broadcast as Broadcast, type BroadcastChannel as BroadcastChannel, type BroadcastContact as BroadcastContact, type BroadcastContactStatus as BroadcastContactStatus, type BroadcastContent as BroadcastContent, type BroadcastMessageType as BroadcastMessageType, type BroadcastProgress as BroadcastProgress, type BroadcastStatus as BroadcastStatus, type BroadcastCreateResponse as BroadcastCreateResponse, type BroadcastRetrieveResponse as BroadcastRetrieveResponse, type BroadcastUpdateResponse as BroadcastUpdateResponse, type BroadcastCancelResponse as BroadcastCancelResponse, type BroadcastEscalateReviewResponse as BroadcastEscalateReviewResponse, type BroadcastRescheduleResponse as BroadcastRescheduleResponse, type BroadcastRetryReviewResponse as BroadcastRetryReviewResponse, type BroadcastSendResponse as BroadcastSendResponse, type BroadcastsCursor as BroadcastsCursor, type BroadcastCreateParams as BroadcastCreateParams, type BroadcastUpdateParams as BroadcastUpdateParams, type BroadcastListParams as BroadcastListParams, type BroadcastRescheduleParams as BroadcastRescheduleParams, type BroadcastSendParams as BroadcastSendParams, }; export { Introspect as Introspect, type LineType as LineType, type IntrospectValidateEmailResponse as IntrospectValidateEmailResponse, type IntrospectValidatePhoneResponse as IntrospectValidatePhoneResponse, type IntrospectValidateEmailParams as IntrospectValidateEmailParams, type IntrospectValidatePhoneParams as IntrospectValidatePhoneParams, }; export { PhoneNumbers as PhoneNumbers, type AvailablePhoneNumber as AvailablePhoneNumber, type OwnedPhoneNumber as OwnedPhoneNumber, type OwnedPhoneNumberPricing as OwnedPhoneNumberPricing, type PhoneNumberCapabilities as PhoneNumberCapabilities, type PhoneNumberPricing as PhoneNumberPricing, type PhoneNumberStatus as PhoneNumberStatus, type PhoneNumberType as PhoneNumberType, type Requirement as Requirement, type RequirementAcceptanceCriteria as RequirementAcceptanceCriteria, type RequirementFieldType as RequirementFieldType, type RequirementType as RequirementType, type PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse, type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberPurchaseResponse as PhoneNumberPurchaseResponse, type PhoneNumberRequirementsResponse as PhoneNumberRequirementsResponse, type PhoneNumberSearchAvailableResponse as PhoneNumberSearchAvailableResponse, type OwnedPhoneNumbersCursor as OwnedPhoneNumbersCursor, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, type PhoneNumberListParams as PhoneNumberListParams, type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams, type PhoneNumberRequirementsParams as PhoneNumberRequirementsParams, type PhoneNumberSearchAvailableParams as PhoneNumberSearchAvailableParams, }; export { Addresses as Addresses, type Address as Address, type AddressStatus as AddressStatus, type AddressCreateResponse as AddressCreateResponse, type AddressRetrieveResponse as AddressRetrieveResponse, type AddressesCursor as AddressesCursor, type AddressCreateParams as AddressCreateParams, type AddressListParams as AddressListParams, }; export { RegulatoryDocuments as RegulatoryDocuments, type RegulatoryDocument as RegulatoryDocument, type RegulatoryDocumentCreateResponse as RegulatoryDocumentCreateResponse, type RegulatoryDocumentRetrieveResponse as RegulatoryDocumentRetrieveResponse, type RegulatoryDocumentUploadURLResponse as RegulatoryDocumentUploadURLResponse, type RegulatoryDocumentsCursor as RegulatoryDocumentsCursor, type RegulatoryDocumentCreateParams as RegulatoryDocumentCreateParams, type RegulatoryDocumentListParams as RegulatoryDocumentListParams, }; export { Invitations as Invitations, type Invitation as Invitation, type InvitationCreateResponse as InvitationCreateResponse, type InvitationRetrieveResponse as InvitationRetrieveResponse, type InvitationCancelResponse as InvitationCancelResponse, type InvitationsCursor as InvitationsCursor, type InvitationCreateParams as InvitationCreateParams, type InvitationListParams as InvitationListParams, }; export { URLs as URLs, type VerifiedURL as VerifiedURL, type URLEscalateResponse as URLEscalateResponse, type URLRetrieveDetailsResponse as URLRetrieveDetailsResponse, type URLSubmitForVerificationResponse as URLSubmitForVerificationResponse, type VerifiedURLsCursor as VerifiedURLsCursor, type URLEscalateParams as URLEscalateParams, type URLListVerifiedParams as URLListVerifiedParams, type URLSubmitForVerificationParams as URLSubmitForVerificationParams, }; export { Balance as Balance, type BalanceRetrieveResponse as BalanceRetrieveResponse }; export { SubAccounts as SubAccounts, type SubAccount as SubAccount, type SubAccountCreateResponse as SubAccountCreateResponse, type SubAccountRetrieveResponse as SubAccountRetrieveResponse, type SubAccountUpdateResponse as SubAccountUpdateResponse, type SubAccountDeactivateResponse as SubAccountDeactivateResponse, type SubAccountGetBalanceResponse as SubAccountGetBalanceResponse, type SubAccountsCursor as SubAccountsCursor, type SubAccountCreateParams as SubAccountCreateParams, type SubAccountUpdateParams as SubAccountUpdateParams, type SubAccountListParams as SubAccountListParams, }; export { Number10dlc as Number10dlc }; export { Me as Me, type MeRetrieveResponse as MeRetrieveResponse }; export { Functions as Functions, type FunctionCreateResponse as FunctionCreateResponse, type FunctionRetrieveResponse as FunctionRetrieveResponse, type FunctionUpdateResponse as FunctionUpdateResponse, type FunctionDeleteResponse as FunctionDeleteResponse, type FunctionDeployResponse as FunctionDeployResponse, type FunctionGetDeploymentResponse as FunctionGetDeploymentResponse, type FunctionListDeploymentsResponse as FunctionListDeploymentsResponse, type FunctionListEventTypesResponse as FunctionListEventTypesResponse, type FunctionRollbackDeploymentResponse as FunctionRollbackDeploymentResponse, type FunctionTailLogsResponse as FunctionTailLogsResponse, type FunctionCreateParams as FunctionCreateParams, type FunctionUpdateParams as FunctionUpdateParams, type FunctionDeployParams as FunctionDeployParams, type FunctionListDeploymentsParams as FunctionListDeploymentsParams, type FunctionRollbackDeploymentParams as FunctionRollbackDeploymentParams, type FunctionTailLogsParams as FunctionTailLogsParams, }; export { Conversations as Conversations, type ConversationRetrieveResponse as ConversationRetrieveResponse, type ConversationListResponse as ConversationListResponse, type ConversationMarkAsReadResponse as ConversationMarkAsReadResponse, type ConversationListResponsesCursor as ConversationListResponsesCursor, type ConversationListParams as ConversationListParams, type ConversationListMessagesParams as ConversationListMessagesParams, }; export { Calls as Calls, type CallCreateResponse as CallCreateResponse, type CallRetrieveResponse as CallRetrieveResponse, type CallListResponse as CallListResponse, type CallHangupResponse as CallHangupResponse, type CallListResponsesCursor as CallListResponsesCursor, type CallCreateParams as CallCreateParams, type CallListParams as CallListParams, }; export { AgentTemplates as AgentTemplates, type AgentTemplateRetrieveResponse as AgentTemplateRetrieveResponse, type AgentTemplateListResponse as AgentTemplateListResponse, }; export { EmailDomains as EmailDomains, type EmailDomainCreateResponse as EmailDomainCreateResponse, type EmailDomainRetrieveResponse as EmailDomainRetrieveResponse, type EmailDomainListResponse as EmailDomainListResponse, type EmailDomainVerifyResponse as EmailDomainVerifyResponse, type EmailDomainCreateParams as EmailDomainCreateParams, }; export { Agents as Agents, type AgentCreateResponse as AgentCreateResponse, type AgentRetrieveResponse as AgentRetrieveResponse, type AgentUpdateResponse as AgentUpdateResponse, type AgentListVoicesResponse as AgentListVoicesResponse, type AgentTestResponse as AgentTestResponse, type AgentCreateParams as AgentCreateParams, type AgentUpdateParams as AgentUpdateParams, type AgentListParams as AgentListParams, type AgentListVoicesParams as AgentListVoicesParams, type AgentTestParams as AgentTestParams, }; } //# sourceMappingURL=client.d.ts.map