@zavudev/sdk 0.31.0 → 0.43.0

package/src/resources/index.ts

@@ -10,6 +10,7 @@ export {
   type AddressListParams,
   type AddressesCursor,
 } from './addresses';
+export { Balance, type BalanceRetrieveResponse } from './balance';
 export {
   Broadcasts,
   type Broadcast,
@@ -24,7 +25,9 @@ export {
   type BroadcastRetrieveResponse,
   type BroadcastUpdateResponse,
   type BroadcastCancelResponse,
+  type BroadcastEscalateReviewResponse,
   type BroadcastRescheduleResponse,
+  type BroadcastRetryReviewResponse,
   type BroadcastSendResponse,
   type BroadcastCreateParams,
   type BroadcastUpdateParams,
@@ -37,16 +40,53 @@ export {
 export {
   Contacts,
   type Contact,
+  type ContactChannel,
+  type ContactCreateParams,
   type ContactUpdateParams,
   type ContactListParams,
+  type ContactMergeParams,
   type ContactsCursor,
-} from './contacts';
+} from './contacts/contacts';
+export {
+  Exports,
+  type DataExport,
+  type ExportCreateResponse,
+  type ExportRetrieveResponse,
+  type ExportCreateParams,
+  type ExportListParams,
+  type DataExportsCursor,
+} from './exports';
+export {
+  Functions,
+  type FunctionCreateResponse,
+  type FunctionRetrieveResponse,
+  type FunctionUpdateResponse,
+  type FunctionDeleteResponse,
+  type FunctionDeployResponse,
+  type FunctionGetDeploymentResponse,
+  type FunctionTailLogsResponse,
+  type FunctionCreateParams,
+  type FunctionUpdateParams,
+  type FunctionDeployParams,
+  type FunctionTailLogsParams,
+} from './functions/functions';
 export {
   Introspect,
   type LineType,
   type IntrospectValidatePhoneResponse,
   type IntrospectValidatePhoneParams,
 } from './introspect';
+export {
+  Invitations,
+  type Invitation,
+  type InvitationCreateResponse,
+  type InvitationRetrieveResponse,
+  type InvitationCancelResponse,
+  type InvitationCreateParams,
+  type InvitationListParams,
+  type InvitationsCursor,
+} from './invitations';
+export { Me, type MeRetrieveResponse } from './me';
 export {
   Messages,
   type Channel,
@@ -55,11 +95,14 @@ export {
   type MessageResponse,
   type MessageStatus,
   type MessageType,
+  type MessageShowTypingResponse,
   type MessageListParams,
   type MessageReactParams,
   type MessageSendParams,
+  type MessageShowTypingParams,
   type MessagesCursor,
 } from './messages';
+export { Number10dlc } from './number-10dlc/number-10dlc';
 export {
   PhoneNumbers,
   type AvailablePhoneNumber,
@@ -85,6 +128,7 @@ export {
   type PhoneNumberSearchAvailableParams,
   type OwnedPhoneNumbersCursor,
 } from './phone-numbers';
+export { Plan, type PlanRetrieveResponse } from './plan';
 export {
   RegulatoryDocuments,
   type RegulatoryDocument,
@@ -113,6 +157,19 @@ export {
   type SenderUploadProfilePictureParams,
   type SendersCursor,
 } from './senders/senders';
+export {
+  SubAccounts,
+  type SubAccount,
+  type SubAccountCreateResponse,
+  type SubAccountRetrieveResponse,
+  type SubAccountUpdateResponse,
+  type SubAccountDeactivateResponse,
+  type SubAccountGetBalanceResponse,
+  type SubAccountCreateParams,
+  type SubAccountUpdateParams,
+  type SubAccountListParams,
+  type SubAccountsCursor,
+} from './sub-accounts/sub-accounts';
 export {
   Templates,
   type Template,
@@ -122,3 +179,13 @@ export {
   type TemplateSubmitParams,
   type TemplatesCursor,
 } from './templates';
+export {
+  URLs,
+  type VerifiedURL,
+  type URLRetrieveDetailsResponse,
+  type URLSubmitForVerificationResponse,
+  type URLListVerifiedParams,
+  type URLSubmitForVerificationParams,
+  type VerifiedURLsCursor,
+} from './urls';
+export { Usage, type UsageRetrieveResponse } from './usage';

package/src/resources/invitations.ts

@@ -0,0 +1,188 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Invitations extends APIResource {
+  /**
+   * Create a partner invitation link for a client to connect their WhatsApp Business
+   * account. The client will complete Meta's embedded signup flow and the resulting
+   * sender will be created in your project.
+   *
+   * @example
+   * ```ts
+   * const invitation = await client.invitations.create({
+   *   clientName: 'Acme Corp',
+   * });
+   * ```
+   */
+  create(
+    body: InvitationCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InvitationCreateResponse> {
+    return this._client.post('/v1/invitations', { body, ...options });
+  }
+
+  /**
+   * Get invitation
+   *
+   * @example
+   * ```ts
+   * const invitation = await client.invitations.retrieve(
+   *   'invitationId',
+   * );
+   * ```
+   */
+  retrieve(invitationID: string, options?: RequestOptions): APIPromise<InvitationRetrieveResponse> {
+    return this._client.get(path`/v1/invitations/${invitationID}`, options);
+  }
+
+  /**
+   * List partner invitations for this project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const invitation of client.invitations.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: InvitationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<InvitationsCursor, Invitation> {
+    return this._client.getAPIList('/v1/invitations', Cursor<Invitation>, { query, ...options });
+  }
+
+  /**
+   * Cancel an active invitation. The client will no longer be able to use the
+   * invitation link.
+   *
+   * @example
+   * ```ts
+   * const response = await client.invitations.cancel(
+   *   'invitationId',
+   * );
+   * ```
+   */
+  cancel(invitationID: string, options?: RequestOptions): APIPromise<InvitationCancelResponse> {
+    return this._client.post(path`/v1/invitations/${invitationID}/cancel`, options);
+  }
+}
+
+export type InvitationsCursor = Cursor<Invitation>;
+
+export interface Invitation {
+  id: string;
+
+  /**
+   * Unique invitation token.
+   */
+  token: string;
+
+  createdAt: string;
+
+  expiresAt: string;
+
+  /**
+   * Current status of the partner invitation.
+   */
+  status: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled';
+
+  updatedAt: string;
+
+  /**
+   * Full URL to share with the client.
+   */
+  url: string;
+
+  clientEmail?: string | null;
+
+  clientName?: string | null;
+
+  clientPhone?: string | null;
+
+  completedAt?: string | null;
+
+  /**
+   * ID of a pre-assigned Zavu phone number for WhatsApp registration.
+   */
+  phoneNumberId?: string | null;
+
+  /**
+   * ID of the sender created when invitation is completed.
+   */
+  senderId?: string | null;
+
+  startedAt?: string | null;
+
+  viewedAt?: string | null;
+}
+
+export interface InvitationCreateResponse {
+  invitation: Invitation;
+}
+
+export interface InvitationRetrieveResponse {
+  invitation: Invitation;
+}
+
+export interface InvitationCancelResponse {
+  invitation: Invitation;
+}
+
+export interface InvitationCreateParams {
+  /**
+   * ISO country codes for allowed phone numbers.
+   */
+  allowedPhoneCountries?: Array<string>;
+
+  /**
+   * Email of the client being invited.
+   */
+  clientEmail?: string;
+
+  /**
+   * Name of the client being invited.
+   */
+  clientName?: string;
+
+  /**
+   * Phone number of the client in E.164 format.
+   */
+  clientPhone?: string;
+
+  /**
+   * Number of days until the invitation expires.
+   */
+  expiresInDays?: number;
+
+  /**
+   * ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+   * the client will use this number instead of their own.
+   */
+  phoneNumberId?: string;
+}
+
+export interface InvitationListParams extends CursorParams {
+  /**
+   * Current status of the partner invitation.
+   */
+  status?: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled';
+}
+
+export declare namespace Invitations {
+  export {
+    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,
+  };
+}

package/src/resources/me.ts

@@ -0,0 +1,49 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Me extends APIResource {
+  /**
+   * Returns the project, team, and API key metadata bound to the current Bearer
+   * token. Used by CLIs and SDKs to confirm which project they will operate on.
+   */
+  retrieve(options?: RequestOptions): APIPromise<MeRetrieveResponse> {
+    return this._client.get('/v1/me', options);
+  }
+}
+
+export interface MeRetrieveResponse {
+  apiKey: MeRetrieveResponse.APIKey;
+
+  isTestMode: boolean;
+
+  project: MeRetrieveResponse.Project;
+
+  team: MeRetrieveResponse.Team;
+}
+
+export namespace MeRetrieveResponse {
+  export interface APIKey {
+    id: string;
+  }
+
+  export interface Project {
+    id: string;
+
+    isSubAccount: boolean;
+
+    name: string | null;
+  }
+
+  export interface Team {
+    id: string;
+
+    name: string | null;
+  }
+}
+
+export declare namespace Me {
+  export { type MeRetrieveResponse as MeRetrieveResponse };
+}

package/src/resources/messages.ts

@@ -106,6 +106,35 @@ export class Messages extends APIResource {
       ]),
     });
   }
+
+  /**
+   * Mark an inbound WhatsApp message as read and display a typing indicator to the
+   * user while you prepare a response. The indicator is automatically dismissed when
+   * you send a reply, or after 25 seconds — whichever comes first. Only valid for
+   * inbound WhatsApp messages. Use this when a reply will take more than a couple of
+   * seconds (LLM agent, tool call, lookup) to improve the recipient's experience.
+   *
+   * @example
+   * ```ts
+   * const response = await client.messages.showTyping(
+   *   'messageId',
+   * );
+   * ```
+   */
+  showTyping(
+    messageID: string,
+    params: MessageShowTypingParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MessageShowTypingResponse> {
+    const { 'Zavu-Sender': zavuSender } = params ?? {};
+    return this._client.post(path`/v1/messages/${messageID}/typing`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(zavuSender != null ? { 'Zavu-Sender': zavuSender } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
 }
 
 export type MessagesCursor = Cursor<Message>;
@@ -200,6 +229,34 @@ export interface MessageContent {
    */
   contacts?: Array<MessageContent.Contact>;
 
+  /**
+   * Button label for cta_url messages.
+   */
+  ctaDisplayText?: string;
+
+  /**
+   * Public HTTPS URL of the header media when ctaHeaderType is 'image', 'video', or
+   * 'document'. WhatsApp fetches this URL — it must be publicly reachable and return
+   * the declared content type.
+   */
+  ctaHeaderMediaUrl?: string;
+
+  /**
+   * Header text when ctaHeaderType is 'text'.
+   */
+  ctaHeaderText?: string;
+
+  /**
+   * Optional header type for cta_url messages.
+   */
+  ctaHeaderType?: 'text' | 'image' | 'video' | 'document';
+
+  /**
+   * Destination URL opened in the device's default browser when the button is
+   * tapped. Used with messageType=cta_url. WhatsApp requires HTTPS in production.
+   */
+  ctaUrl?: string;
+
   /**
    * Emoji for reaction messages.
    */
@@ -210,6 +267,11 @@ export interface MessageContent {
    */
   filename?: string;
 
+  /**
+   * Optional footer text for cta_url messages.
+   */
+  footerText?: string;
+
   /**
    * Latitude for location messages.
    */
@@ -260,13 +322,32 @@ export interface MessageContent {
    */
   sections?: Array<MessageContent.Section>;
 
+  /**
+   * Variables for dynamic button placeholders (URL buttons and OTP buttons). Keys
+   * are the button index (0, 1, 2) in the template's `buttons` array — not the
+   * placeholder name. Values substitute the `{{1}}` placeholder inside that button's
+   * URL.
+   *
+   * **WhatsApp constraints:**
+   *
+   * - URL buttons only accept `{{1}}` — positional, numeric, no whitespace, no name.
+   *   Named placeholders like `{{token}}` are stored as literal URL text by Meta and
+   *   cannot be substituted.
+   * - At most one placeholder per URL button.
+   * - A template may have at most three buttons.
+   * - Static URL buttons (no placeholder) and `quick_reply` buttons are not included
+   *   here.
+   */
+  templateButtonVariables?: { [key: string]: string };
+
   /**
    * Template ID for template messages.
    */
   templateId?: string;
 
   /**
-   * Variables for template rendering. Keys are variable positions (1, 2, 3...).
+   * Variables for body placeholders. Keys are positions (1, 2, 3, ...) matching the
+   * order placeholders appear in the template body.
    */
   templateVariables?: { [key: string]: string };
 }
@@ -310,6 +391,7 @@ export type MessageStatus =
   | 'sending'
   | 'sent'
   | 'delivered'
+  | 'read'
   | 'failed'
   | 'received'
   | 'pending_url_verification';
@@ -329,9 +411,14 @@ export type MessageType =
   | 'contact'
   | 'buttons'
   | 'list'
+  | 'cta_url'
   | 'reaction'
   | 'template';
 
+export interface MessageShowTypingResponse {
+  success: boolean;
+}
+
 export interface MessageListParams extends CursorParams {
   /**
    * Delivery channel. Use 'auto' for intelligent routing.
@@ -364,9 +451,15 @@ export interface MessageSendParams {
   to: string;
 
   /**
-   * Body param: Delivery channel. Use 'auto' for intelligent routing. If omitted
-   * with non-text messageType, WhatsApp is used. For email recipients, defaults to
-   * 'email'.
+   * Body param: Email attachments. Only supported when channel is 'email'. Maximum
+   * 40MB total size.
+   */
+  attachments?: Array<MessageSendParams.Attachment>;
+
+  /**
+   * Body param: Delivery channel. Use 'auto' for intelligent routing. If omitted,
+   * channel is auto-selected based on sender capabilities and recipient type. For
+   * email recipients, defaults to 'email'.
    */
   channel?: Channel;
 
@@ -431,6 +524,47 @@ export interface MessageSendParams {
   'Zavu-Sender'?: string;
 }
 
+export namespace MessageSendParams {
+  /**
+   * Email attachment. Provide either `content` (base64) or `path` (URL), not both.
+   */
+  export interface Attachment {
+    /**
+     * Name of the attached file.
+     */
+    filename: string;
+
+    /**
+     * Content of the attached file as a Base64-encoded string.
+     */
+    content?: string;
+
+    /**
+     * Content ID for inline images. Reference in HTML as
+     * `<img src="cid:your_content_id">`.
+     */
+    content_id?: string;
+
+    /**
+     * MIME type of the attachment. If not set, will be derived from the filename.
+     */
+    content_type?: string;
+
+    /**
+     * URL where the attachment file is hosted. The server will fetch the file.
+     */
+    path?: string;
+  }
+}
+
+export interface MessageShowTypingParams {
+  /**
+   * Optional sender profile ID. If omitted, the project's default sender will be
+   * used.
+   */
+  'Zavu-Sender'?: string;
+}
+
 export declare namespace Messages {
   export {
     type Channel as Channel,
@@ -439,9 +573,11 @@ export declare namespace Messages {
     type MessageResponse as MessageResponse,
     type MessageStatus as MessageStatus,
     type MessageType as MessageType,
+    type MessageShowTypingResponse as MessageShowTypingResponse,
     type MessagesCursor as MessagesCursor,
     type MessageListParams as MessageListParams,
     type MessageReactParams as MessageReactParams,
     type MessageSendParams as MessageSendParams,
+    type MessageShowTypingParams as MessageShowTypingParams,
   };
 }