@zavudev/sdk 0.12.0 → 0.15.0

package/src/resources/senders.ts

@@ -10,6 +10,14 @@ import { path } from '../internal/utils/path';
 export class Senders extends APIResource {
   /**
    * Create sender
+   *
+   * @example
+   * ```ts
+   * const sender = await client.senders.create({
+   *   name: 'name',
+   *   phoneNumber: 'phoneNumber',
+   * });
+   * ```
    */
   create(body: SenderCreateParams, options?: RequestOptions): APIPromise<Sender> {
     return this._client.post('/v1/senders', { body, ...options });
@@ -17,6 +25,11 @@ export class Senders extends APIResource {
 
   /**
    * Get sender
+   *
+   * @example
+   * ```ts
+   * const sender = await client.senders.retrieve('senderId');
+   * ```
    */
   retrieve(senderID: string, options?: RequestOptions): APIPromise<Sender> {
     return this._client.get(path`/v1/senders/${senderID}`, options);
@@ -24,6 +37,11 @@ export class Senders extends APIResource {
 
   /**
    * Update sender
+   *
+   * @example
+   * ```ts
+   * const sender = await client.senders.update('senderId');
+   * ```
    */
   update(senderID: string, body: SenderUpdateParams, options?: RequestOptions): APIPromise<Sender> {
     return this._client.patch(path`/v1/senders/${senderID}`, { body, ...options });
@@ -31,6 +49,14 @@ export class Senders extends APIResource {
 
   /**
    * List senders
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const sender of client.senders.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: SenderListParams | null | undefined = {},
@@ -41,6 +67,11 @@ export class Senders extends APIResource {
 
   /**
    * Delete sender
+   *
+   * @example
+   * ```ts
+   * await client.senders.delete('senderId');
+   * ```
    */
   delete(senderID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/v1/senders/${senderID}`, {
@@ -49,13 +80,83 @@ export class Senders extends APIResource {
     });
   }
 
+  /**
+   * Get the WhatsApp Business profile for a sender. The sender must have a WhatsApp
+   * Business Account connected.
+   *
+   * @example
+   * ```ts
+   * const whatsappBusinessProfileResponse =
+   *   await client.senders.getProfile('senderId');
+   * ```
+   */
+  getProfile(senderID: string, options?: RequestOptions): APIPromise<WhatsappBusinessProfileResponse> {
+    return this._client.get(path`/v1/senders/${senderID}/profile`, options);
+  }
+
   /**
    * Regenerate the webhook secret for a sender. The old secret will be invalidated
    * immediately.
+   *
+   * @example
+   * ```ts
+   * const webhookSecretResponse =
+   *   await client.senders.regenerateWebhookSecret('senderId');
+   * ```
    */
   regenerateWebhookSecret(senderID: string, options?: RequestOptions): APIPromise<WebhookSecretResponse> {
     return this._client.post(path`/v1/senders/${senderID}/webhook/secret`, options);
   }
+
+  /**
+   * Update the WhatsApp Business profile for a sender. The sender must have a
+   * WhatsApp Business Account connected.
+   *
+   * @example
+   * ```ts
+   * const response = await client.senders.updateProfile(
+   *   'senderId',
+   *   {
+   *     about: 'Succulent specialists!',
+   *     description:
+   *       'We specialize in providing high-quality succulents.',
+   *     email: 'contact@example.com',
+   *     vertical: 'RETAIL',
+   *     websites: ['https://www.example.com'],
+   *   },
+   * );
+   * ```
+   */
+  updateProfile(
+    senderID: string,
+    body: SenderUpdateProfileParams,
+    options?: RequestOptions,
+  ): APIPromise<SenderUpdateProfileResponse> {
+    return this._client.patch(path`/v1/senders/${senderID}/profile`, { body, ...options });
+  }
+
+  /**
+   * Upload a new profile picture for the WhatsApp Business profile. The image will
+   * be uploaded to Meta and set as the profile picture.
+   *
+   * @example
+   * ```ts
+   * const response = await client.senders.uploadProfilePicture(
+   *   'senderId',
+   *   {
+   *     imageUrl: 'https://example.com/profile.jpg',
+   *     mimeType: 'image/jpeg',
+   *   },
+   * );
+   * ```
+   */
+  uploadProfilePicture(
+    senderID: string,
+    body: SenderUploadProfilePictureParams,
+    options?: RequestOptions,
+  ): APIPromise<SenderUploadProfilePictureResponse> {
+    return this._client.post(path`/v1/senders/${senderID}/profile/picture`, { body, ...options });
+  }
 }
 
 export type SendersCursor = Cursor<Sender>;
@@ -83,6 +184,56 @@ export interface Sender {
    * Webhook configuration for the sender.
    */
   webhook?: SenderWebhook;
+
+  /**
+   * WhatsApp Business Account information. Only present if a WABA is connected.
+   */
+  whatsapp?: Sender.Whatsapp;
+}
+
+export namespace Sender {
+  /**
+   * WhatsApp Business Account information. Only present if a WABA is connected.
+   */
+  export interface Whatsapp {
+    /**
+     * Display phone number.
+     */
+    displayPhoneNumber?: string;
+
+    /**
+     * Payment configuration status from Meta.
+     */
+    paymentStatus?: Whatsapp.PaymentStatus;
+
+    /**
+     * WhatsApp phone number ID from Meta.
+     */
+    phoneNumberId?: string;
+  }
+
+  export namespace Whatsapp {
+    /**
+     * Payment configuration status from Meta.
+     */
+    export interface PaymentStatus {
+      /**
+       * Whether template messages can be sent. Requires setupStatus=COMPLETE and
+       * methodStatus=VALID.
+       */
+      canSendTemplates?: boolean;
+
+      /**
+       * Payment method status (VALID, NONE, etc.).
+       */
+      methodStatus?: string;
+
+      /**
+       * Payment setup status (COMPLETE, NOT_STARTED, etc.).
+       */
+      setupStatus?: string;
+    }
+  }
 }
 
 /**
@@ -112,14 +263,18 @@ export interface SenderWebhook {
 }
 
 /**
- * Type of event that triggers the webhook.
+ * Type of event that triggers the webhook. Note: Reactions are delivered as
+ * message.inbound with messageType='reaction'.
  */
 export type WebhookEvent =
+  | 'message.queued'
   | 'message.sent'
   | 'message.delivered'
   | 'message.failed'
   | 'message.inbound'
-  | 'conversation.new';
+  | 'message.unsupported'
+  | 'conversation.new'
+  | 'template.status_changed';
 
 export interface WebhookSecretResponse {
   /**
@@ -128,6 +283,95 @@ export interface WebhookSecretResponse {
   secret: string;
 }
 
+/**
+ * WhatsApp Business profile information.
+ */
+export interface WhatsappBusinessProfile {
+  /**
+   * Short description of the business (max 139 characters).
+   */
+  about?: string;
+
+  /**
+   * Physical address of the business (max 256 characters).
+   */
+  address?: string;
+
+  /**
+   * Extended description of the business (max 512 characters).
+   */
+  description?: string;
+
+  /**
+   * Business email address.
+   */
+  email?: string;
+
+  /**
+   * URL of the business profile picture.
+   */
+  profilePictureUrl?: string;
+
+  /**
+   * Business category for WhatsApp Business profile.
+   */
+  vertical?: WhatsappBusinessProfileVertical;
+
+  /**
+   * Business website URLs (maximum 2).
+   */
+  websites?: Array<string>;
+}
+
+export interface WhatsappBusinessProfileResponse {
+  /**
+   * WhatsApp Business profile information.
+   */
+  profile: WhatsappBusinessProfile;
+}
+
+/**
+ * Business category for WhatsApp Business profile.
+ */
+export type WhatsappBusinessProfileVertical =
+  | 'UNDEFINED'
+  | 'OTHER'
+  | 'AUTO'
+  | 'BEAUTY'
+  | 'APPAREL'
+  | 'EDU'
+  | 'ENTERTAIN'
+  | 'EVENT_PLAN'
+  | 'FINANCE'
+  | 'GROCERY'
+  | 'GOVT'
+  | 'HOTEL'
+  | 'HEALTH'
+  | 'NONPROFIT'
+  | 'PROF_SERVICES'
+  | 'RETAIL'
+  | 'TRAVEL'
+  | 'RESTAURANT'
+  | 'NOT_A_BIZ';
+
+export interface SenderUpdateProfileResponse {
+  /**
+   * WhatsApp Business profile information.
+   */
+  profile: WhatsappBusinessProfile;
+
+  success: boolean;
+}
+
+export interface SenderUploadProfilePictureResponse {
+  /**
+   * WhatsApp Business profile information.
+   */
+  profile: WhatsappBusinessProfile;
+
+  success: boolean;
+}
+
 export interface SenderCreateParams {
   name: string;
 
@@ -169,15 +413,66 @@ export interface SenderUpdateParams {
 
 export interface SenderListParams extends CursorParams {}
 
+export interface SenderUpdateProfileParams {
+  /**
+   * Short description of the business (max 139 characters).
+   */
+  about?: string;
+
+  /**
+   * Physical address of the business (max 256 characters).
+   */
+  address?: string;
+
+  /**
+   * Extended description of the business (max 512 characters).
+   */
+  description?: string;
+
+  /**
+   * Business email address.
+   */
+  email?: string;
+
+  /**
+   * Business category for WhatsApp Business profile.
+   */
+  vertical?: WhatsappBusinessProfileVertical;
+
+  /**
+   * Business website URLs (maximum 2).
+   */
+  websites?: Array<string>;
+}
+
+export interface SenderUploadProfilePictureParams {
+  /**
+   * URL of the image to upload.
+   */
+  imageUrl: string;
+
+  /**
+   * MIME type of the image.
+   */
+  mimeType: 'image/jpeg' | 'image/png';
+}
+
 export declare namespace Senders {
   export {
     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,
   };
 }

package/src/resources/templates.ts

@@ -73,6 +73,23 @@ export class Templates extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Submit a WhatsApp template to Meta for approval. The template must be in draft
+   * status and associated with a sender that has a WhatsApp Business Account
+   * configured.
+   *
+   * @example
+   * ```ts
+   * const template = await client.templates.submit(
+   *   'templateId',
+   *   { senderId: 'sender_abc123', category: 'UTILITY' },
+   * );
+   * ```
+   */
+  submit(templateID: string, body: TemplateSubmitParams, options?: RequestOptions): APIPromise<Template> {
+    return this._client.post(path`/v1/templates/${templateID}/submit`, { body, ...options });
+  }
 }
 
 export type TemplatesCursor = Cursor<Template>;
@@ -191,6 +208,18 @@ export interface TemplateCreateParams {
 
 export interface TemplateListParams extends CursorParams {}
 
+export interface TemplateSubmitParams {
+  /**
+   * The sender ID with the WhatsApp Business Account to submit the template to.
+   */
+  senderId: string;
+
+  /**
+   * Template category. If not provided, uses the category set on the template.
+   */
+  category?: WhatsappCategory;
+}
+
 export declare namespace Templates {
   export {
     type Template as Template,
@@ -198,5 +227,6 @@ export declare namespace Templates {
     type TemplatesCursor as TemplatesCursor,
     type TemplateCreateParams as TemplateCreateParams,
     type TemplateListParams as TemplateListParams,
+    type TemplateSubmitParams as TemplateSubmitParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.12.0'; // x-release-please-version
+export const VERSION = '0.15.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.12.0";
+export declare const VERSION = "0.15.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.12.0";
+export declare const VERSION = "0.15.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.12.0'; // x-release-please-version
+exports.VERSION = '0.15.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.12.0'; // x-release-please-version
+export const VERSION = '0.15.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map