@zavudev/sdk 0.58.1 → 0.59.1

package/src/v2/v2.ts

@@ -0,0 +1,315 @@
+// Generated by zavu-codegen from apps/docs/api-reference/v2/openapi.json. Do not edit: run `bun run codegen`.
+
+import { APIResource } from '../core/resource';
+import * as API from './resources/index';
+import {
+  Messages,
+  type MessageSendParams,
+  type MessageSendResponse,
+  type ChannelTypeRequest,
+  type EmailAttachmentInput,
+  type Message,
+  type MessageContent,
+  type MessageType,
+  type Routing,
+  type SendMessageResponse,
+  type MessageListParams,
+  type MessagesCursor,
+  type ChannelType,
+  type MessageStatus,
+  type MessageRetrieveResponse,
+} from './resources/messages';
+import {
+  Conversations,
+  type ConversationListParams,
+  type Conversation,
+  type ConversationsCursor,
+  type ConversationRetrieveResponse,
+  type ConversationListMessagesParams,
+  type ConversationMarkAsReadResponse,
+} from './resources/conversations';
+import {
+  Contacts,
+  type ContactListParams,
+  type Contact,
+  type ContactsCursor,
+  type ContactChannel,
+  type ContactCreateParams,
+  type ContactCreateResponse,
+  type ContactChannelInput,
+  type ContactRetrieveResponse,
+  type ContactUpdateParams,
+  type ContactUpdateResponse,
+} from './resources/contacts';
+import {
+  Channels,
+  type ChannelListParams,
+  type ChannelEntry,
+  type ChannelEntriesCursor,
+  type ChannelConnectParams,
+  type ChannelConnectResponse,
+  type ChannelRetrieveResponse,
+  type ActivatableChannel,
+  type ChannelActivateResponse,
+  type ChannelDeactivateResponse,
+} from './resources/channels';
+import {
+  Templates,
+  type TemplateListParams,
+  type Template,
+  type TemplatesCursor,
+  type WhatsAppCategory,
+  type TemplateCreateParams,
+  type TemplateCreateResponse,
+  type TemplateRetrieveResponse,
+  type TemplateSubmitParams,
+  type TemplateSubmitResponse,
+} from './resources/templates';
+import {
+  Campaigns,
+  type CampaignListParams,
+  type Broadcast,
+  type BroadcastsCursor,
+  type BroadcastChannel,
+  type BroadcastContent,
+  type BroadcastMessageType,
+  type BroadcastStatus,
+  type CampaignCreateParams,
+  type CampaignCreateResponse,
+  type CampaignRetrieveResponse,
+  type CampaignSendParams,
+  type CampaignSendResponse,
+  type CampaignProgressResponse,
+  type BroadcastProgress,
+  type CampaignCancelResponse,
+} from './resources/campaigns/campaigns';
+import {
+  Webhook,
+  type WebhookRetrieveResponse,
+  type ProjectWebhookV2,
+  type SenderWebhookV1,
+  type WebhookSetParams,
+  type WebhookSetResponse,
+  type WebhookEvent,
+  type WebhookSignatureVersion,
+  type WebhookRotateSecretResponse,
+} from './resources/webhook';
+import {
+  Agents,
+  type AgentListParams,
+  type Agent,
+  type AgentsCursor,
+  type AgentProvider,
+  type AgentVoiceConfig,
+  type AgentCreateParams,
+  type AgentCreateResponse,
+  type AgentRetrieveResponse,
+  type AgentUpdateParams,
+  type AgentUpdateResponse,
+  type AgentTestParams,
+  type AgentTestResponse,
+} from './resources/agents/agents';
+import {
+  Numbers,
+  type NumberSearchAvailableParams,
+  type NumberSearchAvailableResponse,
+  type AvailablePhoneNumber,
+  type PhoneNumberType,
+  type NumberPurchaseParams,
+  type NumberPurchaseResponse,
+  type ErrorBody,
+  type OwnedPhoneNumber,
+} from './resources/numbers';
+import {
+  EmailDomains,
+  type EmailDomainListResponse,
+  type EmailDomain,
+  type EmailDomainCreateParams,
+  type EmailDomainCreateResponse,
+  type EmailDomainRetrieveResponse,
+  type EmailDomainVerifyResponse,
+} from './resources/email-domains';
+import {
+  Functions,
+  type FunctionListParams,
+  type ZavuFunction,
+  type ZavuFunctionsCursor,
+  type FunctionRetrieveResponse,
+  type FunctionUpdateParams,
+  type FunctionUpdateResponse,
+} from './resources/functions';
+
+export class V2 extends APIResource {
+  messages: API.Messages = new API.Messages(this._client);
+  conversations: API.Conversations = new API.Conversations(this._client);
+  contacts: API.Contacts = new API.Contacts(this._client);
+  channels: API.Channels = new API.Channels(this._client);
+  templates: API.Templates = new API.Templates(this._client);
+  campaigns: API.Campaigns = new API.Campaigns(this._client);
+  webhook: API.Webhook = new API.Webhook(this._client);
+  agents: API.Agents = new API.Agents(this._client);
+  numbers: API.Numbers = new API.Numbers(this._client);
+  emailDomains: API.EmailDomains = new API.EmailDomains(this._client);
+  functions: API.Functions = new API.Functions(this._client);
+}
+
+V2.Messages = Messages;
+V2.Conversations = Conversations;
+V2.Contacts = Contacts;
+V2.Channels = Channels;
+V2.Templates = Templates;
+V2.Campaigns = Campaigns;
+V2.Webhook = Webhook;
+V2.Agents = Agents;
+V2.Numbers = Numbers;
+V2.EmailDomains = EmailDomains;
+V2.Functions = Functions;
+
+export declare namespace V2 {
+  export {
+    Messages as Messages,
+    type MessageSendParams as MessageSendParams,
+    type MessageSendResponse as MessageSendResponse,
+    type ChannelTypeRequest as ChannelTypeRequest,
+    type EmailAttachmentInput as EmailAttachmentInput,
+    type Message as Message,
+    type MessageContent as MessageContent,
+    type MessageType as MessageType,
+    type Routing as Routing,
+    type SendMessageResponse as SendMessageResponse,
+    type MessageListParams as MessageListParams,
+    type MessagesCursor as MessagesCursor,
+    type ChannelType as ChannelType,
+    type MessageStatus as MessageStatus,
+    type MessageRetrieveResponse as MessageRetrieveResponse,
+  };
+
+  export {
+    Conversations as Conversations,
+    type ConversationListParams as ConversationListParams,
+    type Conversation as Conversation,
+    type ConversationsCursor as ConversationsCursor,
+    type ConversationRetrieveResponse as ConversationRetrieveResponse,
+    type ConversationListMessagesParams as ConversationListMessagesParams,
+    type ConversationMarkAsReadResponse as ConversationMarkAsReadResponse,
+  };
+
+  export {
+    Contacts as Contacts,
+    type ContactListParams as ContactListParams,
+    type Contact as Contact,
+    type ContactsCursor as ContactsCursor,
+    type ContactChannel as ContactChannel,
+    type ContactCreateParams as ContactCreateParams,
+    type ContactCreateResponse as ContactCreateResponse,
+    type ContactChannelInput as ContactChannelInput,
+    type ContactRetrieveResponse as ContactRetrieveResponse,
+    type ContactUpdateParams as ContactUpdateParams,
+    type ContactUpdateResponse as ContactUpdateResponse,
+  };
+
+  export {
+    Channels as Channels,
+    type ChannelListParams as ChannelListParams,
+    type ChannelEntry as ChannelEntry,
+    type ChannelEntriesCursor as ChannelEntriesCursor,
+    type ChannelConnectParams as ChannelConnectParams,
+    type ChannelConnectResponse as ChannelConnectResponse,
+    type ChannelRetrieveResponse as ChannelRetrieveResponse,
+    type ActivatableChannel as ActivatableChannel,
+    type ChannelActivateResponse as ChannelActivateResponse,
+    type ChannelDeactivateResponse as ChannelDeactivateResponse,
+  };
+
+  export {
+    Templates as Templates,
+    type TemplateListParams as TemplateListParams,
+    type Template as Template,
+    type TemplatesCursor as TemplatesCursor,
+    type WhatsAppCategory as WhatsAppCategory,
+    type TemplateCreateParams as TemplateCreateParams,
+    type TemplateCreateResponse as TemplateCreateResponse,
+    type TemplateRetrieveResponse as TemplateRetrieveResponse,
+    type TemplateSubmitParams as TemplateSubmitParams,
+    type TemplateSubmitResponse as TemplateSubmitResponse,
+  };
+
+  export {
+    Campaigns as Campaigns,
+    type CampaignListParams as CampaignListParams,
+    type Broadcast as Broadcast,
+    type BroadcastsCursor as BroadcastsCursor,
+    type BroadcastChannel as BroadcastChannel,
+    type BroadcastContent as BroadcastContent,
+    type BroadcastMessageType as BroadcastMessageType,
+    type BroadcastStatus as BroadcastStatus,
+    type CampaignCreateParams as CampaignCreateParams,
+    type CampaignCreateResponse as CampaignCreateResponse,
+    type CampaignRetrieveResponse as CampaignRetrieveResponse,
+    type CampaignSendParams as CampaignSendParams,
+    type CampaignSendResponse as CampaignSendResponse,
+    type CampaignProgressResponse as CampaignProgressResponse,
+    type BroadcastProgress as BroadcastProgress,
+    type CampaignCancelResponse as CampaignCancelResponse,
+  };
+
+  export {
+    Webhook as Webhook,
+    type WebhookRetrieveResponse as WebhookRetrieveResponse,
+    type ProjectWebhookV2 as ProjectWebhookV2,
+    type SenderWebhookV1 as SenderWebhookV1,
+    type WebhookSetParams as WebhookSetParams,
+    type WebhookSetResponse as WebhookSetResponse,
+    type WebhookEvent as WebhookEvent,
+    type WebhookSignatureVersion as WebhookSignatureVersion,
+    type WebhookRotateSecretResponse as WebhookRotateSecretResponse,
+  };
+
+  export {
+    Agents as Agents,
+    type AgentListParams as AgentListParams,
+    type Agent as Agent,
+    type AgentsCursor as AgentsCursor,
+    type AgentProvider as AgentProvider,
+    type AgentVoiceConfig as AgentVoiceConfig,
+    type AgentCreateParams as AgentCreateParams,
+    type AgentCreateResponse as AgentCreateResponse,
+    type AgentRetrieveResponse as AgentRetrieveResponse,
+    type AgentUpdateParams as AgentUpdateParams,
+    type AgentUpdateResponse as AgentUpdateResponse,
+    type AgentTestParams as AgentTestParams,
+    type AgentTestResponse as AgentTestResponse,
+  };
+
+  export {
+    Numbers as Numbers,
+    type NumberSearchAvailableParams as NumberSearchAvailableParams,
+    type NumberSearchAvailableResponse as NumberSearchAvailableResponse,
+    type AvailablePhoneNumber as AvailablePhoneNumber,
+    type PhoneNumberType as PhoneNumberType,
+    type NumberPurchaseParams as NumberPurchaseParams,
+    type NumberPurchaseResponse as NumberPurchaseResponse,
+    type ErrorBody as ErrorBody,
+    type OwnedPhoneNumber as OwnedPhoneNumber,
+  };
+
+  export {
+    EmailDomains as EmailDomains,
+    type EmailDomainListResponse as EmailDomainListResponse,
+    type EmailDomain as EmailDomain,
+    type EmailDomainCreateParams as EmailDomainCreateParams,
+    type EmailDomainCreateResponse as EmailDomainCreateResponse,
+    type EmailDomainRetrieveResponse as EmailDomainRetrieveResponse,
+    type EmailDomainVerifyResponse as EmailDomainVerifyResponse,
+  };
+
+  export {
+    Functions as Functions,
+    type FunctionListParams as FunctionListParams,
+    type ZavuFunction as ZavuFunction,
+    type ZavuFunctionsCursor as ZavuFunctionsCursor,
+    type FunctionRetrieveResponse as FunctionRetrieveResponse,
+    type FunctionUpdateParams as FunctionUpdateParams,
+    type FunctionUpdateResponse as FunctionUpdateResponse,
+  };
+}

package/src/v2.ts

@@ -0,0 +1,3 @@
+// Generated by zavu-codegen from apps/docs/api-reference/v2/openapi.json. Do not edit: run `bun run codegen`.
+
+export * from './v2/index';

package/src/version.ts

@@ -1,3 +1,3 @@
 // Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
-export const VERSION = '0.58.1'; // x-release-please-version
+export const VERSION = '0.59.1'; // x-release-please-version

package/types.d.mts

@@ -302,7 +302,7 @@ export interface DocumentUpdateRequest {
     title?: string;
     content?: string;
 }
-export interface Error {
+export interface ErrorBody {
     code: string;
     message: string;
     details?: {
@@ -381,25 +381,42 @@ export interface MessageContent {
     /** Message ID to react to. */
     reactToMessageId?: string;
     /**
-     * Zavu message ID of the quoted message this message replies to. Present on
-     * inbound messages that quote an earlier message. Omitted when the quoted message
-     * is not found in Zavu (e.g. an old or unknown message) — use
-     * replyToProviderMessageId in that case.
+     * Zavu message ID of the quoted message this message replies to.
+     *
+     * **When sending:** set it to make the message a quoted reply to an earlier
+     * message in the same conversation, such as the `data.messageId` of a
+     * `message.inbound` webhook. Supported on WhatsApp (every message type except
+     * `reaction`) and Telegram. The quoted message must belong to this project
+     * (otherwise `404`), must have gone out on the same channel as this send, must
+     * belong to the conversation `to` addresses, must have been sent or received by
+     * the sender this message goes out from (pass it in `Zavu-Sender`), and must have
+     * a `providerMessageId`. A failed message and a Telegram button tap cannot be
+     * quoted. Any other case returns `400` instead of sending the message unquoted.
+     * The stored message then carries the rest of the `replyTo*` fields.
+     *
+     * **When receiving:** present on inbound messages that quote an earlier message.
+     * Omitted when the quoted message is not found in Zavu (e.g. an old or unknown
+     * message) — use replyToProviderMessageId in that case.
      */
     replyToMessageId?: string;
     /**
-     * Provider message ID (WhatsApp WAMID) of the quoted message. Present whenever an
-     * inbound message is a reply, even if the quoted message is not stored in Zavu.
+     * Provider message ID (WhatsApp WAMID, or Telegram message ID) of the quoted
+     * message. Present whenever an inbound WhatsApp message is a reply, even if the
+     * quoted message is not stored in Zavu, and on outbound quoted replies. Read-only:
+     * to quote when sending, set replyToMessageId.
      */
     replyToProviderMessageId?: string;
-    /** Sender of the quoted message (phone number in E.164 format). */
+    /**
+     * Sender of the quoted message (phone number in E.164 format, or the Telegram chat
+     * ID). Read-only.
+     */
     replyToFrom?: string;
     /**
-     * Truncated snippet of the quoted message's text, for display. Empty when the
-     * quoted message has no text (e.g. media).
+     * Truncated snippet (up to 200 characters) of the quoted message's text, for
+     * display. Empty when the quoted message has no text (e.g. media). Read-only.
      */
     replyToText?: string;
-    /** Type of the quoted message (text, image, video, etc.). */
+    /** Type of the quoted message (text, image, video, etc.). Read-only. */
     replyToMessageType?: string;
     /** Template ID for template messages. */
     templateId?: string;
@@ -3813,7 +3830,7 @@ export interface SendMessageError429 {
     details?: {
         [key: string]: unknown;
     };
-    error?: Error;
+    error?: ErrorBody;
 }
 export type ListMessagesStatus = 'queued' | 'sending' | 'sent' | 'delivered' | 'failed' | 'received';
 export type ListMessagesChannel = 'sms' | 'sms_oneway' | 'whatsapp' | 'email' | 'telegram' | 'instagram' | 'messenger' | 'voice';