@zavudev/sdk 0.31.0 → 0.43.0

package/src/resources/senders/agent/tools.ts

@@ -155,7 +155,7 @@ export interface AgentTool {
 
   name: string;
 
-  parameters: AgentTool.Parameters;
+  parameters: ToolParameters;
 
   updatedAt: string;
 
@@ -165,21 +165,19 @@ export interface AgentTool {
   webhookUrl: string;
 }
 
-export namespace AgentTool {
-  export interface Parameters {
-    properties: { [key: string]: Parameters.Properties };
+export interface ToolParameters {
+  properties: { [key: string]: ToolParameters.Properties };
 
-    required: Array<string>;
+  required: Array<string>;
 
-    type: 'object';
-  }
+  type: 'object';
+}
 
-  export namespace Parameters {
-    export interface Properties {
-      description?: string;
+export namespace ToolParameters {
+  export interface Properties {
+    description?: string;
 
-      type?: string;
-    }
+    type?: string;
   }
 }
 
@@ -204,7 +202,7 @@ export interface ToolCreateParams {
 
   name: string;
 
-  parameters: ToolCreateParams.Parameters;
+  parameters: ToolParameters;
 
   /**
    * Must be HTTPS.
@@ -219,24 +217,6 @@ export interface ToolCreateParams {
   webhookSecret?: string;
 }
 
-export namespace ToolCreateParams {
-  export interface Parameters {
-    properties: { [key: string]: Parameters.Properties };
-
-    required: Array<string>;
-
-    type: 'object';
-  }
-
-  export namespace Parameters {
-    export interface Properties {
-      description?: string;
-
-      type?: string;
-    }
-  }
-}
-
 export interface ToolRetrieveParams {
   senderId: string;
 }
@@ -265,7 +245,7 @@ export interface ToolUpdateParams {
   /**
    * Body param
    */
-  parameters?: ToolUpdateParams.Parameters;
+  parameters?: ToolParameters;
 
   /**
    * Body param
@@ -278,24 +258,6 @@ export interface ToolUpdateParams {
   webhookUrl?: string;
 }
 
-export namespace ToolUpdateParams {
-  export interface Parameters {
-    properties: { [key: string]: Parameters.Properties };
-
-    required: Array<string>;
-
-    type: 'object';
-  }
-
-  export namespace Parameters {
-    export interface Properties {
-      description?: string;
-
-      type?: string;
-    }
-  }
-}
-
 export interface ToolListParams extends CursorParams {
   enabled?: boolean;
 }
@@ -319,6 +281,7 @@ export interface ToolTestParams {
 export declare namespace Tools {
   export {
     type AgentTool as AgentTool,
+    type ToolParameters as ToolParameters,
     type ToolCreateResponse as ToolCreateResponse,
     type ToolRetrieveResponse as ToolRetrieveResponse,
     type ToolUpdateResponse as ToolUpdateResponse,

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,42 @@ 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)
+ *
+ * **Custom domain events:**
+ *
+ * - `domain.verified`: A custom email domain passed verification (DKIM, and
+ *   SPF/DMARC/MAIL FROM if enhanced records are enabled)
+ * - `domain.failed`: A custom email domain failed verification or is partially
+ *   verified
  */
 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'
+  | 'domain.verified'
+  | 'domain.failed';
 
 export interface WebhookSecretResponse {
   /**
@@ -501,6 +536,7 @@ export interface SenderUploadProfilePictureParams {
 }
 
 Senders.AgentResource = AgentResource;
+Senders.WhatsappSync = WhatsappSync;
 
 export declare namespace Senders {
   export {
@@ -532,4 +568,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,129 @@
+// 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. Requires a parent project API key; sub-account API
+   * keys receive HTTP 403.
+   *
+   * @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. Requires a parent project API key; sub-account API
+   * keys receive HTTP 403.
+   *
+   * @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. Requires a parent project API key; sub-account API
+   * keys receive HTTP 403.
+   *
+   * @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';