@zavudev/sdk 0.30.0 → 0.38.0

package/src/resources/contacts.ts

@@ -1,198 +1,3 @@
 // 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 Contacts extends APIResource {
-  /**
-   * Get contact
-   */
-  retrieve(contactID: string, options?: RequestOptions): APIPromise<Contact> {
-    return this._client.get(path`/v1/contacts/${contactID}`, options);
-  }
-
-  /**
-   * Update contact
-   */
-  update(contactID: string, body: ContactUpdateParams, options?: RequestOptions): APIPromise<Contact> {
-    return this._client.patch(path`/v1/contacts/${contactID}`, { body, ...options });
-  }
-
-  /**
-   * List contacts with their communication channels.
-   */
-  list(
-    query: ContactListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ContactsCursor, Contact> {
-    return this._client.getAPIList('/v1/contacts', Cursor<Contact>, { query, ...options });
-  }
-
-  /**
-   * Get contact by phone number
-   */
-  retrieveByPhone(phoneNumber: string, options?: RequestOptions): APIPromise<Contact> {
-    return this._client.get(path`/v1/contacts/phone/${phoneNumber}`, options);
-  }
-}
-
-export type ContactsCursor = Cursor<Contact>;
-
-export interface Contact {
-  id: string;
-
-  /**
-   * List of available messaging channels for this contact.
-   */
-  availableChannels: Array<string>;
-
-  createdAt: string;
-
-  metadata: { [key: string]: string };
-
-  /**
-   * Whether this contact has been verified.
-   */
-  verified: boolean;
-
-  /**
-   * All communication channels for this contact.
-   */
-  channels?: Array<Contact.Channel>;
-
-  countryCode?: string;
-
-  /**
-   * Preferred channel for this contact.
-   */
-  defaultChannel?: 'sms' | 'whatsapp' | 'telegram' | 'email' | 'instagram' | 'voice';
-
-  /**
-   * Display name for the contact.
-   */
-  displayName?: string;
-
-  /**
-   * DEPRECATED: Use primaryPhone instead. Primary phone number in E.164 format.
-   */
-  phoneNumber?: string;
-
-  /**
-   * Primary email address.
-   */
-  primaryEmail?: string;
-
-  /**
-   * Primary phone number in E.164 format.
-   */
-  primaryPhone?: string;
-
-  /**
-   * Contact's WhatsApp profile name. Only available for WhatsApp contacts.
-   */
-  profileName?: string | null;
-
-  /**
-   * ID of a contact suggested for merging.
-   */
-  suggestedMergeWith?: string;
-
-  updatedAt?: string;
-}
-
-export namespace Contact {
-  /**
-   * A communication channel for a contact.
-   */
-  export interface Channel {
-    id: string;
-
-    /**
-     * Channel type.
-     */
-    channel: 'sms' | 'whatsapp' | 'email' | 'telegram' | 'voice';
-
-    createdAt: string;
-
-    /**
-     * Channel identifier (phone number or email address).
-     */
-    identifier: string;
-
-    /**
-     * Whether this is the primary channel for its type.
-     */
-    isPrimary: boolean;
-
-    /**
-     * Whether this channel has been verified.
-     */
-    verified: boolean;
-
-    /**
-     * ISO country code for phone numbers.
-     */
-    countryCode?: string;
-
-    /**
-     * Optional label for the channel.
-     */
-    label?: string;
-
-    /**
-     * Last time a message was received on this channel.
-     */
-    lastInboundAt?: string;
-
-    metadata?: { [key: string]: string };
-
-    /**
-     * Delivery metrics for this channel.
-     */
-    metrics?: Channel.Metrics;
-
-    updatedAt?: string;
-  }
-
-  export namespace Channel {
-    /**
-     * Delivery metrics for this channel.
-     */
-    export interface Metrics {
-      avgDeliveryTimeMs?: number;
-
-      failureCount?: number;
-
-      lastSuccessAt?: string;
-
-      successCount?: number;
-
-      totalAttempts?: number;
-    }
-  }
-}
-
-export interface ContactUpdateParams {
-  /**
-   * Preferred channel for this contact. Set to null to clear.
-   */
-  defaultChannel?: 'sms' | 'whatsapp' | 'telegram' | 'email' | 'instagram' | 'voice' | null;
-
-  metadata?: { [key: string]: string };
-}
-
-export interface ContactListParams extends CursorParams {
-  phoneNumber?: string;
-}
-
-export declare namespace Contacts {
-  export {
-    type Contact as Contact,
-    type ContactsCursor as ContactsCursor,
-    type ContactUpdateParams as ContactUpdateParams,
-    type ContactListParams as ContactListParams,
-  };
-}
+export * from './contacts/index';

package/src/resources/exports.ts

@@ -0,0 +1,141 @@
+// 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 Exports extends APIResource {
+  /**
+   * Create a new data export job. The export will be processed asynchronously and
+   * the download URL will be available when status is 'completed'. Export links
+   * expire after 24 hours.
+   *
+   * @example
+   * ```ts
+   * const _export = await client.exports.create({
+   *   dataTypes: ['messages', 'conversations'],
+   *   dateFrom: '2024-01-01T00:00:00Z',
+   *   dateTo: '2024-12-31T23:59:59Z',
+   * });
+   * ```
+   */
+  create(body: ExportCreateParams, options?: RequestOptions): APIPromise<ExportCreateResponse> {
+    return this._client.post('/v1/exports', { body, ...options });
+  }
+
+  /**
+   * Get details of a specific data export, including download URL when completed.
+   *
+   * @example
+   * ```ts
+   * const _export = await client.exports.retrieve('exportId');
+   * ```
+   */
+  retrieve(exportID: string, options?: RequestOptions): APIPromise<ExportRetrieveResponse> {
+    return this._client.get(path`/v1/exports/${exportID}`, options);
+  }
+
+  /**
+   * List data exports for this project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const dataExport of client.exports.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: ExportListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DataExportsCursor, DataExport> {
+    return this._client.getAPIList('/v1/exports', Cursor<DataExport>, { query, ...options });
+  }
+}
+
+export type DataExportsCursor = Cursor<DataExport>;
+
+export interface DataExport {
+  id: string;
+
+  createdAt: string;
+
+  dataTypes: Array<'messages' | 'conversations' | 'webhookDeliveries' | 'agentExecutions' | 'activities'>;
+
+  /**
+   * When the export download link expires (24 hours after creation).
+   */
+  expiresAt: string;
+
+  /**
+   * Status of a data export job.
+   */
+  status: 'pending' | 'processing' | 'completed' | 'failed';
+
+  completedAt?: string | null;
+
+  dateFrom?: string | null;
+
+  dateTo?: string | null;
+
+  /**
+   * URL to download the export file. Only available when status is 'completed'.
+   */
+  downloadUrl?: string | null;
+
+  /**
+   * Error message if the export failed.
+   */
+  errorMessage?: string | null;
+
+  /**
+   * Size of the export file in bytes.
+   */
+  fileSize?: number | null;
+}
+
+export interface ExportCreateResponse {
+  export: DataExport;
+}
+
+export interface ExportRetrieveResponse {
+  export: DataExport;
+}
+
+export interface ExportCreateParams {
+  /**
+   * List of data types to include in the export.
+   */
+  dataTypes: Array<'messages' | 'conversations' | 'webhookDeliveries' | 'agentExecutions' | 'activities'>;
+
+  /**
+   * Start date for data to export (inclusive).
+   */
+  dateFrom?: string;
+
+  /**
+   * End date for data to export (inclusive).
+   */
+  dateTo?: string;
+}
+
+export interface ExportListParams extends CursorParams {
+  /**
+   * Status of a data export job.
+   */
+  status?: 'pending' | 'processing' | 'completed' | 'failed';
+}
+
+export declare namespace Exports {
+  export {
+    type DataExport as DataExport,
+    type ExportCreateResponse as ExportCreateResponse,
+    type ExportRetrieveResponse as ExportRetrieveResponse,
+    type DataExportsCursor as DataExportsCursor,
+    type ExportCreateParams as ExportCreateParams,
+    type ExportListParams as ExportListParams,
+  };
+}

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,38 @@ 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 {
   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 {
   Messages,
   type Channel,
@@ -60,6 +85,7 @@ export {
   type MessageSendParams,
   type MessagesCursor,
 } from './messages';
+export { Number10dlc } from './number-10dlc/number-10dlc';
 export {
   PhoneNumbers,
   type AvailablePhoneNumber,
@@ -85,6 +111,7 @@ export {
   type PhoneNumberSearchAvailableParams,
   type OwnedPhoneNumbersCursor,
 } from './phone-numbers';
+export { Plan, type PlanRetrieveResponse } from './plan';
 export {
   RegulatoryDocuments,
   type RegulatoryDocument,
@@ -113,6 +140,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 +162,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/messages.ts

@@ -310,6 +310,7 @@ export type MessageStatus =
   | 'sending'
   | 'sent'
   | 'delivered'
+  | 'read'
   | 'failed'
   | 'received'
   | 'pending_url_verification';
@@ -364,9 +365,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 +438,39 @@ 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 declare namespace Messages {
   export {
     type Channel as Channel,