@zavudev/sdk 0.30.0 → 0.38.0

package/src/resources/senders/index.ts

@@ -30,3 +30,12 @@ export {
   type SenderUploadProfilePictureParams,
   type SendersCursor,
 } from './senders';
+export {
+  WhatsappSync,
+  type WhatsAppSyncContacts,
+  type WhatsAppSyncHistory,
+  type WhatsAppSyncStatus,
+  type WhatsappSyncRetrieveResponse,
+  type WhatsappSyncStartContactsSyncResponse,
+  type WhatsappSyncStartHistorySyncResponse,
+} from './whatsapp-sync';

package/src/resources/senders/senders.ts

@@ -1,6 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as WhatsappSyncAPI from './whatsapp-sync';
+import {
+  WhatsAppSyncContacts,
+  WhatsAppSyncHistory,
+  WhatsAppSyncStatus,
+  WhatsappSync,
+  WhatsappSyncRetrieveResponse,
+  WhatsappSyncStartContactsSyncResponse,
+  WhatsappSyncStartHistorySyncResponse,
+} from './whatsapp-sync';
 import * as AgentAPI from './agent/agent';
 import {
   Agent,
@@ -21,6 +31,7 @@ import { path } from '../../internal/utils/path';
 
 export class Senders extends APIResource {
   agent: AgentAPI.AgentResource = new AgentAPI.AgentResource(this._client);
+  whatsappSync: WhatsappSyncAPI.WhatsappSync = new WhatsappSyncAPI.WhatsappSync(this._client);
 
   /**
    * Create sender
@@ -291,6 +302,8 @@ export interface SenderWebhook {
  * - `message.sent`: Message accepted by the provider. `data.status` = `sent`
  * - `message.delivered`: Message delivered to recipient. `data.status` =
  *   `delivered`
+ * - `message.read`: Message was read by the recipient (WhatsApp only).
+ *   `data.status` = `read`
  * - `message.failed`: Message failed to send. `data.status` = `failed`
  *
  * **Inbound events:**
@@ -299,20 +312,33 @@ export interface SenderWebhook {
  *   delivered as `message.inbound` with `messageType='reaction'`
  * - `message.unsupported`: Received a message type that is not supported
  *
+ * **Broadcast events:**
+ *
+ * - `broadcast.status_changed`: Broadcast status changed (pending_review,
+ *   approved, rejected, sending, completed, cancelled)
+ *
  * **Other events:**
  *
  * - `conversation.new`: New conversation started with a contact
  * - `template.status_changed`: WhatsApp template approval status changed
+ *
+ * **Partner events:**
+ *
+ * - `invitation.status_changed`: A partner invitation status changed (pending,
+ *   in_progress, completed, cancelled)
  */
 export type WebhookEvent =
   | 'message.queued'
   | 'message.sent'
   | 'message.delivered'
+  | 'message.read'
   | 'message.failed'
   | 'message.inbound'
   | 'message.unsupported'
+  | 'broadcast.status_changed'
   | 'conversation.new'
-  | 'template.status_changed';
+  | 'template.status_changed'
+  | 'invitation.status_changed';
 
 export interface WebhookSecretResponse {
   /**
@@ -501,6 +527,7 @@ export interface SenderUploadProfilePictureParams {
 }
 
 Senders.AgentResource = AgentResource;
+Senders.WhatsappSync = WhatsappSync;
 
 export declare namespace Senders {
   export {
@@ -532,4 +559,14 @@ export declare namespace Senders {
     type AgentCreateParams as AgentCreateParams,
     type AgentUpdateParams as AgentUpdateParams,
   };
+
+  export {
+    WhatsappSync as WhatsappSync,
+    type WhatsAppSyncContacts as WhatsAppSyncContacts,
+    type WhatsAppSyncHistory as WhatsAppSyncHistory,
+    type WhatsAppSyncStatus as WhatsAppSyncStatus,
+    type WhatsappSyncRetrieveResponse as WhatsappSyncRetrieveResponse,
+    type WhatsappSyncStartContactsSyncResponse as WhatsappSyncStartContactsSyncResponse,
+    type WhatsappSyncStartHistorySyncResponse as WhatsappSyncStartHistorySyncResponse,
+  };
 }

package/src/resources/senders/whatsapp-sync.ts

@@ -0,0 +1,175 @@
+// 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';
+import { path } from '../../internal/utils/path';
+
+export class WhatsappSync extends APIResource {
+  /**
+   * Get the current sync status for a sender's WhatsApp coexistence account. Only
+   * available for senders connected in coexistence mode (WhatsApp Business App +
+   * Cloud API).
+   *
+   * @example
+   * ```ts
+   * const whatsappSync =
+   *   await client.senders.whatsappSync.retrieve('senderId');
+   * ```
+   */
+  retrieve(senderID: string, options?: RequestOptions): APIPromise<WhatsappSyncRetrieveResponse> {
+    return this._client.get(path`/v1/senders/${senderID}/whatsapp-sync`, options);
+  }
+
+  /**
+   * Initiate contact names sync from the WhatsApp Business App. This imports contact
+   * names stored in the app to Zavu. Only available for coexistence accounts with
+   * active status.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.senders.whatsappSync.startContactsSync(
+   *     'senderId',
+   *   );
+   * ```
+   */
+  startContactsSync(
+    senderID: string,
+    options?: RequestOptions,
+  ): APIPromise<WhatsappSyncStartContactsSyncResponse> {
+    return this._client.post(path`/v1/senders/${senderID}/whatsapp-sync/contacts`, options);
+  }
+
+  /**
+   * Initiate message history sync from the WhatsApp Business App. This sends a
+   * request to the account owner to approve sharing their conversation history. Only
+   * available for coexistence accounts with active status.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.senders.whatsappSync.startHistorySync(
+   *     'senderId',
+   *   );
+   * ```
+   */
+  startHistorySync(
+    senderID: string,
+    options?: RequestOptions,
+  ): APIPromise<WhatsappSyncStartHistorySyncResponse> {
+    return this._client.post(path`/v1/senders/${senderID}/whatsapp-sync/history`, options);
+  }
+}
+
+/**
+ * Contacts sync status details.
+ */
+export interface WhatsAppSyncContacts {
+  /**
+   * Whether contacts sync can be initiated.
+   */
+  canSync: boolean;
+
+  /**
+   * Status of WhatsApp contacts sync.
+   */
+  status: 'not_requested' | 'pending' | 'syncing' | 'completed';
+
+  /**
+   * When the sync was last requested.
+   */
+  requestedAt?: string | null;
+}
+
+/**
+ * History sync status details.
+ */
+export interface WhatsAppSyncHistory {
+  /**
+   * Whether history sync can be initiated.
+   */
+  canSync: boolean;
+
+  /**
+   * Status of WhatsApp message history sync.
+   */
+  status: 'not_requested' | 'pending' | 'syncing' | 'completed' | 'rejected';
+
+  /**
+   * When the sync was completed.
+   */
+  completedAt?: string | null;
+
+  /**
+   * When the sync was last requested.
+   */
+  requestedAt?: string | null;
+}
+
+/**
+ * WhatsApp coexistence sync status.
+ */
+export interface WhatsAppSyncStatus {
+  /**
+   * Contacts sync status details.
+   */
+  contacts: WhatsAppSyncContacts;
+
+  /**
+   * History sync status details.
+   */
+  history: WhatsAppSyncHistory;
+
+  /**
+   * Whether the account is in coexistence mode.
+   */
+  isCoexistence: boolean;
+
+  /**
+   * WhatsApp account status.
+   */
+  status: 'pending_verification' | 'pending_registration' | 'active' | 'disconnected' | 'error';
+}
+
+export interface WhatsappSyncRetrieveResponse {
+  /**
+   * WhatsApp coexistence sync status.
+   */
+  sync: WhatsAppSyncStatus;
+}
+
+export interface WhatsappSyncStartContactsSyncResponse {
+  /**
+   * Success message.
+   */
+  message: string;
+
+  /**
+   * WhatsApp coexistence sync status.
+   */
+  sync: WhatsAppSyncStatus;
+}
+
+export interface WhatsappSyncStartHistorySyncResponse {
+  /**
+   * Success message.
+   */
+  message: string;
+
+  /**
+   * WhatsApp coexistence sync status.
+   */
+  sync: WhatsAppSyncStatus;
+}
+
+export declare namespace WhatsappSync {
+  export {
+    type WhatsAppSyncContacts as WhatsAppSyncContacts,
+    type WhatsAppSyncHistory as WhatsAppSyncHistory,
+    type WhatsAppSyncStatus as WhatsAppSyncStatus,
+    type WhatsappSyncRetrieveResponse as WhatsappSyncRetrieveResponse,
+    type WhatsappSyncStartContactsSyncResponse as WhatsappSyncStartContactsSyncResponse,
+    type WhatsappSyncStartHistorySyncResponse as WhatsappSyncStartHistorySyncResponse,
+  };
+}

package/src/resources/sub-accounts/api-keys.ts

@@ -0,0 +1,126 @@
+// 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 { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class APIKeys extends APIResource {
+  /**
+   * Create sub-account API key
+   *
+   * @example
+   * ```ts
+   * const apiKey = await client.subAccounts.apiKeys.create(
+   *   'id',
+   *   { name: 'Production Key', environment: 'live' },
+   * );
+   * ```
+   */
+  create(id: string, body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKeyCreateResponse> {
+    return this._client.post(path`/v1/sub-accounts/${id}/api-keys`, { body, ...options });
+  }
+
+  /**
+   * List sub-account API keys
+   *
+   * @example
+   * ```ts
+   * const apiKeys = await client.subAccounts.apiKeys.list('id');
+   * ```
+   */
+  list(id: string, options?: RequestOptions): APIPromise<APIKeyListResponse> {
+    return this._client.get(path`/v1/sub-accounts/${id}/api-keys`, options);
+  }
+
+  /**
+   * Revoke sub-account API key
+   *
+   * @example
+   * ```ts
+   * await client.subAccounts.apiKeys.revoke('keyId', {
+   *   id: 'id',
+   * });
+   * ```
+   */
+  revoke(keyID: string, params: APIKeyRevokeParams, options?: RequestOptions): APIPromise<void> {
+    const { id } = params;
+    return this._client.delete(path`/v1/sub-accounts/${id}/api-keys/${keyID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface APIKeyCreateResponse {
+  apiKey: APIKeyCreateResponse.APIKey;
+}
+
+export namespace APIKeyCreateResponse {
+  export interface APIKey {
+    id: string;
+
+    environment: 'live' | 'test';
+
+    key: string;
+
+    name: string;
+  }
+}
+
+export interface APIKeyListResponse {
+  items: Array<APIKeyListResponse.Item>;
+}
+
+export namespace APIKeyListResponse {
+  export interface Item {
+    id: string;
+
+    createdAt: number;
+
+    environment: 'live' | 'test';
+
+    /**
+     * First characters of the key for identification.
+     */
+    keyPrefix: string;
+
+    name: string;
+
+    /**
+     * Full API key. Only returned on creation.
+     */
+    key?: string;
+
+    lastUsedAt?: number | null;
+
+    permissions?: Array<string>;
+
+    revokedAt?: number | null;
+  }
+}
+
+export interface APIKeyCreateParams {
+  name: string;
+
+  environment?: 'live' | 'test';
+
+  permissions?: Array<string>;
+}
+
+export interface APIKeyRevokeParams {
+  /**
+   * Sub-account ID.
+   */
+  id: string;
+}
+
+export declare namespace APIKeys {
+  export {
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyListResponse as APIKeyListResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyRevokeParams as APIKeyRevokeParams,
+  };
+}

package/src/resources/sub-accounts/index.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  APIKeys,
+  type APIKeyCreateResponse,
+  type APIKeyListResponse,
+  type APIKeyCreateParams,
+  type APIKeyRevokeParams,
+} from './api-keys';
+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';

package/src/resources/sub-accounts/sub-accounts.ts

@@ -0,0 +1,246 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as APIKeysAPI from './api-keys';
+import {
+  APIKeyCreateParams,
+  APIKeyCreateResponse,
+  APIKeyListResponse,
+  APIKeyRevokeParams,
+  APIKeys,
+} from './api-keys';
+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 SubAccounts extends APIResource {
+  apiKeys: APIKeysAPI.APIKeys = new APIKeysAPI.APIKeys(this._client);
+
+  /**
+   * Create a new sub-account (project) with its own API key. All charges are billed
+   * to the parent team's balance. Use creditLimit to set a spending cap. The
+   * sub-account's API key is returned only in the creation response.
+   *
+   * @example
+   * ```ts
+   * const subAccount = await client.subAccounts.create({
+   *   name: 'Client ABC',
+   * });
+   * ```
+   */
+  create(body: SubAccountCreateParams, options?: RequestOptions): APIPromise<SubAccountCreateResponse> {
+    return this._client.post('/v1/sub-accounts', { body, ...options });
+  }
+
+  /**
+   * Get sub-account
+   *
+   * @example
+   * ```ts
+   * const subAccount = await client.subAccounts.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SubAccountRetrieveResponse> {
+    return this._client.get(path`/v1/sub-accounts/${id}`, options);
+  }
+
+  /**
+   * Update sub-account
+   *
+   * @example
+   * ```ts
+   * const subAccount = await client.subAccounts.update('id');
+   * ```
+   */
+  update(
+    id: string,
+    body: SubAccountUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<SubAccountUpdateResponse> {
+    return this._client.patch(path`/v1/sub-accounts/${id}`, { body, ...options });
+  }
+
+  /**
+   * List sub-accounts for this team.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const subAccount of client.subAccounts.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: SubAccountListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SubAccountsCursor, SubAccount> {
+    return this._client.getAPIList('/v1/sub-accounts', Cursor<SubAccount>, { query, ...options });
+  }
+
+  /**
+   * Deactivate a sub-account. Remaining balance is returned to the parent team and
+   * all API keys are revoked.
+   *
+   * @example
+   * ```ts
+   * const response = await client.subAccounts.deactivate('id');
+   * ```
+   */
+  deactivate(id: string, options?: RequestOptions): APIPromise<SubAccountDeactivateResponse> {
+    return this._client.delete(path`/v1/sub-accounts/${id}`, options);
+  }
+
+  /**
+   * Get spending information for a sub-account. Returns the parent team's balance,
+   * the sub-account's total spending, and its credit limit (spending cap).
+   *
+   * @example
+   * ```ts
+   * const response = await client.subAccounts.getBalance('id');
+   * ```
+   */
+  getBalance(id: string, options?: RequestOptions): APIPromise<SubAccountGetBalanceResponse> {
+    return this._client.get(path`/v1/sub-accounts/${id}/balance`, options);
+  }
+}
+
+export type SubAccountsCursor = Cursor<SubAccount>;
+
+export interface SubAccount {
+  id: string;
+
+  createdAt: string;
+
+  name: string;
+
+  status: 'active' | 'inactive';
+
+  /**
+   * Total amount spent by this sub-account in cents.
+   */
+  totalSpent: number;
+
+  /**
+   * API key for the sub-account. Only returned on creation.
+   */
+  apiKey?: string;
+
+  /**
+   * Spending cap in cents. When reached, messages from this sub-account will be
+   * blocked.
+   */
+  creditLimit?: number | null;
+
+  /**
+   * External reference ID set by the parent account.
+   */
+  externalId?: string | null;
+
+  metadata?: { [key: string]: unknown } | null;
+}
+
+export interface SubAccountCreateResponse {
+  subAccount: SubAccount;
+}
+
+export interface SubAccountRetrieveResponse {
+  subAccount: SubAccount;
+}
+
+export interface SubAccountUpdateResponse {
+  subAccount: SubAccount;
+}
+
+export interface SubAccountDeactivateResponse {
+  /**
+   * Number of API keys revoked.
+   */
+  keysRevoked: number;
+
+  message: string;
+}
+
+export interface SubAccountGetBalanceResponse {
+  /**
+   * Team balance in cents. All charges are billed to the parent team.
+   */
+  balance: number;
+
+  currency: string;
+
+  /**
+   * Spending cap in cents (only for sub-accounts).
+   */
+  creditLimit?: number | null;
+
+  /**
+   * Whether this API key belongs to a sub-account.
+   */
+  isSubAccount?: boolean;
+
+  /**
+   * Total amount spent by this sub-account in cents (only for sub-accounts).
+   */
+  totalSpent?: number | null;
+}
+
+export interface SubAccountCreateParams {
+  /**
+   * Name of the sub-account.
+   */
+  name: string;
+
+  /**
+   * Spending cap in cents. When reached, messages from this sub-account will be
+   * blocked. Omit or set to 0 for no limit.
+   */
+  creditLimit?: number;
+
+  /**
+   * External reference ID for your own tracking.
+   */
+  externalId?: string;
+
+  metadata?: { [key: string]: unknown };
+}
+
+export interface SubAccountUpdateParams {
+  creditLimit?: number | null;
+
+  externalId?: string;
+
+  metadata?: { [key: string]: unknown };
+
+  name?: string;
+
+  status?: 'active' | 'inactive';
+}
+
+export interface SubAccountListParams extends CursorParams {}
+
+SubAccounts.APIKeys = APIKeys;
+
+export declare namespace SubAccounts {
+  export {
+    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 {
+    APIKeys as APIKeys,
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyListResponse as APIKeyListResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyRevokeParams as APIKeyRevokeParams,
+  };
+}

package/src/resources/sub-accounts.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './sub-accounts/index';