@digisglobal/omnivox-sdk 0.7.0 → 0.8.0

package/dist/index.d.ts

@@ -138,6 +138,8 @@ type CannedResponsesModule = ReturnType<typeof createCannedResponsesModule>;
  * Exposes the Phase-2 templates surface via two submodules:
  *
  * whatsapp (WABA-scoped):
+ *   - list(tenantId, wabaId, opts)                  → GET   /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates
+ *   - getById(tenantId, wabaId, templateId)         → GET   /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/:templateId
  *   - authorDraft(tenantId, wabaId, input)          → POST  /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates
  *   - importApproved(tenantId, wabaId)              → POST  /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/import
  *   - update(tenantId, wabaId, templateId, input)   → PATCH /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/:templateId
@@ -172,11 +174,55 @@ interface UpdateWhatsAppTemplateInput {
     body?: string;
     [key: string]: unknown;
 }
-/** A WhatsApp template version history event. */
+/**
+ * A single status-event row attached to a template version, as returned nested
+ * under each version in the history response (`versions[].statusEvents[]`).
+ * These are the raw Meta callback events (plus synthetic import events).
+ */
 interface WhatsAppTemplateHistoryEvent {
-    version: number;
+    id: string;
+    templateVersionId: string;
+    eventName: string;
+    reason: string | null;
+    createdAt: string;
+    [key: string]: unknown;
+}
+/**
+ * A single template version within the history response, carrying its own
+ * ordered list of status events.
+ */
+interface WhatsAppTemplateHistoryVersion {
+    id: string;
+    templateId: string;
+    versionNumber: number;
+    language: string;
+    category: string;
+    body: string;
     status: string;
+    sendability: string;
+    placeholderSnapshot: unknown;
+    supersedesVersionId: string | null;
+    providerTemplateId: string | null;
+    submittedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    statusEvents: WhatsAppTemplateHistoryEvent[];
+    [key: string]: unknown;
+}
+/**
+ * The full history for a single WhatsApp template, as returned by
+ * `whatsapp.history`. This is a single OBJECT (not an array): template-level
+ * fields plus a `versions` array ordered by `versionNumber` ascending, each
+ * version carrying its own `statusEvents`. The "current" version is the one
+ * with the highest `versionNumber`.
+ */
+interface WhatsAppTemplateHistory {
+    id: string;
+    whatsAppBusinessAccountId: string;
+    name: string;
+    createdAt: string;
     updatedAt: string;
+    versions: WhatsAppTemplateHistoryVersion[];
     [key: string]: unknown;
 }
 /** A WhatsApp template item returned by the API. */
@@ -187,23 +233,67 @@ interface WhatsAppTemplateItem {
     status?: string;
     [key: string]: unknown;
 }
+/**
+ * A single WhatsApp template together with its current (latest) version, as
+ * returned by `whatsapp.getById`. Unlike the flat list item, language/status
+ * and other version-scoped fields live under `currentVersion` — reading them at
+ * the top level would be `undefined` at runtime.
+ */
+interface WhatsAppTemplateDetail {
+    id: string;
+    whatsAppBusinessAccountId: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+    currentVersion: {
+        versionNumber: number;
+        language: string;
+        category?: string;
+        body?: string;
+        status: string;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+/** Pagination + filter options for the WhatsApp templates list. */
+interface WhatsAppTemplateListOpts {
+    /** Narrow to templates whose current version has this status (e.g. "APPROVED"). */
+    status?: string;
+    /** Case-insensitive contains-match on template name. */
+    q?: string;
+    page: number;
+    pageSize: number;
+}
+/** A single template upserted by an import-approved call. */
+interface ImportedTemplateResult {
+    name: string;
+    language: string;
+    category: string;
+    version: Omit<WhatsAppTemplateHistoryVersion, 'statusEvents'>;
+    created: boolean;
+}
 /** Import-approved result. */
 interface ImportApprovedResult {
-    imported: number;
-    [key: string]: unknown;
+    imported: ImportedTemplateResult[];
 }
 /** Submit result. */
 interface SubmitResult {
     status: string;
     [key: string]: unknown;
 }
-/** Input for creating an Email template. */
+/**
+ * Input for creating an Email template.
+ *
+ * `variableSchema` is a name→sample-value map (variable name → default/sample
+ * value). Preview substitutes those values; the API contract stores the same
+ * shape.
+ */
 interface CreateEmailTemplateInput {
     name: string;
     subject: string;
     htmlBody?: string;
     textBody?: string;
-    variableSchema?: Record<string, unknown>;
+    variableSchema?: Record<string, string>;
     [key: string]: unknown;
 }
 /** Input for partially updating an Email template. */
@@ -212,7 +302,7 @@ interface PatchEmailTemplateInput {
     subject?: string;
     htmlBody?: string;
     textBody?: string;
-    variableSchema?: Record<string, unknown>;
+    variableSchema?: Record<string, string>;
     [key: string]: unknown;
 }
 /** An Email template item returned by the API. */
@@ -222,7 +312,7 @@ interface EmailTemplateItem {
     subject: string;
     htmlBody?: string;
     textBody?: string;
-    variableSchema?: Record<string, unknown>;
+    variableSchema?: Record<string, string>;
     [key: string]: unknown;
 }
 /** Paginated list response. */
@@ -239,6 +329,8 @@ interface TemplatesPagedList<T> {
 interface EmailTemplateListOpts {
     page: number;
     pageSize: number;
+    /** Case-insensitive contains-match on template name. */
+    q?: string;
     [key: string]: unknown;
 }
 /**
@@ -250,6 +342,18 @@ declare function createTemplatesModule(options: TemplatesModuleOptions): {
      * WhatsApp template submodule — WABA-scoped operations.
      */
     whatsapp: {
+        /**
+         * List a WhatsApp Business Account's templates (paginated, optionally status-filtered and name-searchable).
+         * Calls GET /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates.
+         */
+        list(tenantId: string, wabaId: string, opts: WhatsAppTemplateListOpts): Promise<TemplatesPagedList<WhatsAppTemplateItem>>;
+        /**
+         * Get a single template together with its current (latest) version.
+         * Language/status and other version-scoped fields are nested under
+         * `currentVersion` — not at the top level (see WhatsAppTemplateDetail).
+         * Calls GET /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/:templateId.
+         */
+        getById(tenantId: string, wabaId: string, templateId: string): Promise<WhatsAppTemplateDetail>;
         /**
          * Author a new DRAFT template (version 1) under a WhatsApp Business Account.
          * Calls POST /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates.
@@ -266,10 +370,14 @@ declare function createTemplatesModule(options: TemplatesModuleOptions): {
          */
         update(tenantId: string, wabaId: string, templateId: string, input: UpdateWhatsAppTemplateInput): Promise<WhatsAppTemplateItem>;
         /**
-         * List all versions and status events for a template in chronological order.
+         * Get the full version + status-event history for a template.
+         *
+         * Returns a single OBJECT (see WhatsAppTemplateHistory) — template-level
+         * fields plus a `versions` array ordered by versionNumber ascending, each
+         * version carrying its own `statusEvents`. NOT a flat array of events.
          * Calls GET /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/:templateId/history.
          */
-        history(tenantId: string, wabaId: string, templateId: string): Promise<WhatsAppTemplateHistoryEvent[]>;
+        history(tenantId: string, wabaId: string, templateId: string): Promise<WhatsAppTemplateHistory>;
         /**
          * Submit a DRAFT template version to Meta for review and approval (DRAFT → PENDING_APPROVAL).
          * Calls POST /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/:templateId/submit.
@@ -469,6 +577,11 @@ interface LobbyEntry {
     id: string;
     [key: string]: unknown;
 }
+/** Result of picking up a lobby entry — the created/reused conversation + entry ids. */
+interface PickupResult {
+    conversationId: string;
+    entryId: string;
+}
 /** Paginated list response. */
 interface PagedList$3<T> {
     data: T[];
@@ -543,12 +656,10 @@ declare function createConversationsModule(options: ConversationsModuleOptions):
     get(id: string): Promise<ConversationItem>;
     /**
      * Pick up a lobby entry (atomic 4-step transaction).
-     * Returns the resulting conversation.
+     * Returns the resulting conversation + entry ids.
      * Calls POST /api/v1/conversations/lobby/:entryId/pickup.
      */
-    pickup(entryId: string, input: PickupInput): Promise<{
-        data: ConversationItem;
-    }>;
+    pickup(entryId: string, input: PickupInput): Promise<PickupResult>;
     /**
      * List APPROVED + SENDABLE WhatsApp templates eligible to re-open an
      * expired 24-hour customer-service window for the given conversation.
@@ -842,24 +953,20 @@ interface CreateApiKeyInput {
 }
 /** Response from tenants.apiKeys.create() — includes raw key shown once. */
 interface CreateApiKeyResponse {
-    data: {
-        id: string;
-        label: string;
-        prefix: string;
-        scopes: string[];
-        status: 'ACTIVE' | 'REVOKED';
-        lastUsedAt: string | null;
-        createdAt: string;
-        /** Raw key value — shown once and never again. */
-        raw: string;
-    };
+    id: string;
+    label: string;
+    prefix: string;
+    scopes: string[];
+    status: 'ACTIVE' | 'REVOKED';
+    lastUsedAt: string | null;
+    createdAt: string;
+    /** Raw key value — shown once and never again. */
+    raw: string;
 }
 /** Response from tenants.apiKeys.revoke(). */
 interface RevokeApiKeyResponse {
-    data: {
-        id: string;
-        status: 'REVOKED';
-    };
+    id: string;
+    status: 'REVOKED';
 }
 /** Paginated list response. */
 interface PagedList<T> {
@@ -1173,9 +1280,7 @@ declare function createOmnivoxClient(options: OmnivoxClientOptions): {
         assign(id: string, input: AssignInput): Promise<ConversationItem>;
         listLobby(opts?: LobbyListOpts): Promise<PagedList$3<LobbyEntry>>;
         get(id: string): Promise<ConversationItem>;
-        pickup(entryId: string, input: PickupInput): Promise<{
-            data: ConversationItem;
-        }>;
+        pickup(entryId: string, input: PickupInput): Promise<PickupResult>;
         whatsappRecoveryOptions(id: string): Promise<WhatsAppRecoveryOption[]>;
     };
     messages: {
@@ -1187,10 +1292,12 @@ declare function createOmnivoxClient(options: OmnivoxClientOptions): {
     };
     templates: {
         whatsapp: {
+            list(tenantId: string, wabaId: string, opts: WhatsAppTemplateListOpts): Promise<TemplatesPagedList<WhatsAppTemplateItem>>;
+            getById(tenantId: string, wabaId: string, templateId: string): Promise<WhatsAppTemplateDetail>;
             authorDraft(tenantId: string, wabaId: string, input: AuthorDraftInput): Promise<WhatsAppTemplateItem>;
             importApproved(tenantId: string, wabaId: string): Promise<ImportApprovedResult>;
             update(tenantId: string, wabaId: string, templateId: string, input: UpdateWhatsAppTemplateInput): Promise<WhatsAppTemplateItem>;
-            history(tenantId: string, wabaId: string, templateId: string): Promise<WhatsAppTemplateHistoryEvent[]>;
+            history(tenantId: string, wabaId: string, templateId: string): Promise<WhatsAppTemplateHistory>;
             submit(tenantId: string, wabaId: string, templateId: string): Promise<SubmitResult>;
         };
         email: {
@@ -1215,6 +1322,10 @@ declare function createOmnivoxClient(options: OmnivoxClientOptions): {
     whatsappBusinessAccounts: {
         list(tenantId: string): Promise<WhatsAppBusinessAccountItem[]>;
         get(tenantId: string, wabaRowId: string): Promise<WhatsAppBusinessAccountItem>;
+        create(tenantId: string, body: CreateWhatsAppBusinessAccountBody): Promise<WhatsAppBusinessAccountItem>;
+        update(tenantId: string, wabaRowId: string, body: {
+            name: string;
+        }): Promise<WhatsAppBusinessAccountItem>;
     };
     /**
      * Creates a WebSocket client connected to the `/ws/chat` namespace.
@@ -1574,12 +1685,15 @@ type AttachmentsModule = ReturnType<typeof createAttachmentsModule>;
 /**
  * WhatsApp Business Accounts module — hand-written typed wrapper over the generated client.
  *
- * Exposes the WABA read surface (WABA-as-identity, tenant-scoped):
- *   - list(tenantId)           → GET /api/v1/tenants/:id/whatsapp-business-accounts
- *   - get(tenantId, wabaRowId) → GET /api/v1/tenants/:id/whatsapp-business-accounts/:wabaRowId
+ * Exposes the WABA surface (WABA-as-identity, tenant-scoped):
+ *   - list(tenantId)                    → GET   /api/v1/tenants/:id/whatsapp-business-accounts
+ *   - get(tenantId, wabaRowId)          → GET   /api/v1/tenants/:id/whatsapp-business-accounts/:wabaRowId
+ *   - create(tenantId, body)            → POST  /api/v1/tenants/:id/whatsapp-business-accounts
+ *   - update(tenantId, wabaRowId, body) → PATCH /api/v1/tenants/:id/whatsapp-business-accounts/:wabaRowId
  *
- * The Console's WhatsApp templates page uses this to let an admin pick a WABA
+ * The Console's WhatsApp templates page uses list/get to let an admin pick a WABA
  * before authoring templates (`sdk.templates.whatsapp.*` requires a `wabaId`).
+ * The Console's Channels screen uses create/update to onboard and rename a WABA.
  *
  * Never re-exports symbols from _generated/.
  * Contains no business logic — typed transport only.
@@ -1606,9 +1720,24 @@ interface WhatsAppBusinessAccountItem {
     /** ISO 8601 last-updated timestamp. */
     updatedAt: string;
 }
+/**
+ * POST body to create a WhatsApp Business Account.
+ * Mirrors `apps/api/src/channels/schemas/save-waba.schema.ts` `CreateWabaSchema`.
+ * The `secret` block is written to the SecretsProvider and never echoed back
+ * (ADR-0011) — the response is a {@link WhatsAppBusinessAccountItem}.
+ */
+interface CreateWhatsAppBusinessAccountBody {
+    wabaId: string;
+    name: string;
+    secret: {
+        accessToken: string;
+        appSecret: string;
+        webhookVerifyToken: string;
+    };
+}
 /**
  * Creates the WhatsApp Business Accounts module — a thin typed wrapper over
- * the generated client. Covers the WABA read surface (list + get by row id).
+ * the generated client. Covers the WABA surface (list/get/create/update).
  */
 declare function createWhatsAppBusinessAccountsModule(options: WhatsAppBusinessAccountsModuleOptions): {
     /**
@@ -1630,8 +1759,35 @@ declare function createWhatsAppBusinessAccountsModule(options: WhatsAppBusinessA
      * const waba = await sdk.whatsappBusinessAccounts.get('ten_acmecorp', 'waba_row_001')
      */
     get(tenantId: string, wabaRowId: string): Promise<WhatsAppBusinessAccountItem>;
+    /**
+     * Create a WhatsApp Business Account — writes the secret to the
+     * SecretsProvider and the non-secret row to the DB; returns the
+     * non-secret view (no `secretRef` exposed).
+     * Calls POST /api/v1/tenants/:id/whatsapp-business-accounts.
+     *
+     * @example
+     * const waba = await sdk.whatsappBusinessAccounts.create('ten_acmecorp', {
+     *   wabaId: '123456789012345',
+     *   name: 'Acme WhatsApp',
+     *   secret: { accessToken, appSecret, webhookVerifyToken },
+     * })
+     */
+    create(tenantId: string, body: CreateWhatsAppBusinessAccountBody): Promise<WhatsAppBusinessAccountItem>;
+    /**
+     * Rename a WhatsApp Business Account (name only — secret material is
+     * immutable through this endpoint).
+     * Calls PATCH /api/v1/tenants/:id/whatsapp-business-accounts/:wabaRowId.
+     *
+     * @example
+     * await sdk.whatsappBusinessAccounts.update('ten_acmecorp', 'waba_row_001', {
+     *   name: 'Renamed WhatsApp',
+     * })
+     */
+    update(tenantId: string, wabaRowId: string, body: {
+        name: string;
+    }): Promise<WhatsAppBusinessAccountItem>;
 };
 /** Return type of createWhatsAppBusinessAccountsModule. */
 type WhatsAppBusinessAccountsModule = ReturnType<typeof createWhatsAppBusinessAccountsModule>;
 
-export { type AddIdentityInput, type AgentItem, type AgentsModule, type AgentsModuleOptions, type ApiKeyItem, type AssignInput, type AttachmentUploadResult, type AttachmentUrlResult, type AttachmentsModule, type AttachmentsModuleOptions, type AuthMeAgent, type AuthMeModule, type AuthMeModuleOptions, type AuthMeResponse, type AuthMeTenant, type AuthorDraftInput, type BasicEmailChannelConfig, type BasicEmailChannelSecret, type CannedResponseItem, type CannedResponseListOpts, type CannedResponseSearchOpts, type CannedResponsesModule, type CannedResponsesModuleOptions, type Channel, type ChannelListItem, type ChannelStatus, type ChannelType, type ChannelsModule, type ChannelsModuleOptions, type ContactChannel, type ContactConversationSummary, type ContactFieldDefinition, type ContactFieldValue, type ContactFieldValueInput, type ContactIdentity, type ContactIdentityInput, type ContactItem, type ContactSearchOpts, type ContactTag, type ContactsMetadata, type ContactsModule, type ContactsModuleOptions, type ConversationItem, type ConversationListOpts, type ConversationsModule, type ConversationsModuleOptions, type CreateAgentInput, type CreateApiKeyInput, type CreateApiKeyResponse, type CreateCannedResponseInput, type CreateChannelBody, type CreateContactInput, type CreateEmailChannelBody, type CreateEmailTemplateInput, type CreateWhatsAppChannelBody, type CredentialsMode, type EmailChannelConfig, type EmailChannelSecret, type EmailImapConfig, type EmailSmtpConfig, type EmailTemplateItem, type EmailTemplateListOpts, type ImportApprovedResult, type LobbyEntry, type LobbyListOpts, type MessageItem, type MessageListOpts, type MessageReadUpdatePayload, type MessageStatusPayload, type MessagesModule, type MessagesModuleOptions, type OAuth2CertificateEmailChannelSecret, type OAuth2ClientSecretEmailChannelSecret, type OAuth2EmailChannelConfig, type OAuth2EmailChannelSecret, type OmnivoxClient, type OmnivoxClientOptions, OmnivoxRequestError, type PageOpts, type PageParams, type PagedResponse, type ParticipantPayload, type PatchContactInput, type PatchEmailTemplateInput, type PickupInput, type ReopenOrCreateInput, type RevokeApiKeyResponse, type SendMessageInput, type SendTemplateInput, type SubmitResult, type TemplatesModule, type TemplatesModuleOptions, type TenantsModule, type TenantsModuleOptions, type TokenProvider, type TypingIndicatorPayload, type UpdateCannedResponseInput, type UpdateChannelBody, type UpdateStatusInput, type UpdateWhatsAppTemplateInput, type WhatsAppBusinessAccountItem, type WhatsAppBusinessAccountsModule, type WhatsAppBusinessAccountsModuleOptions, type WhatsAppChannelConfig, type WhatsAppRecoveryOption, type WhatsAppTemplateHistoryEvent, type WhatsAppTemplateItem, type WsAuth, type WsClient, type WsClientInstance, type WsClientOptions, type WsConnectionState, type WsEventPayloads, buildPageParams, createAgentsModule, createApiKeyTokenProvider, createAttachmentsModule, createAuthMeModule, createCannedResponsesModule, createChannelsModule, createContactsModule, createConversationsModule, createMessagesModule, createOmnivoxClient, createSessionTokenProvider, createTemplatesModule, createTenantsModule, createWhatsAppBusinessAccountsModule, createWsClient, iteratePages };
+export { type AddIdentityInput, type AgentItem, type AgentsModule, type AgentsModuleOptions, type ApiKeyItem, type AssignInput, type AttachmentUploadResult, type AttachmentUrlResult, type AttachmentsModule, type AttachmentsModuleOptions, type AuthMeAgent, type AuthMeModule, type AuthMeModuleOptions, type AuthMeResponse, type AuthMeTenant, type AuthorDraftInput, type BasicEmailChannelConfig, type BasicEmailChannelSecret, type CannedResponseItem, type CannedResponseListOpts, type CannedResponseSearchOpts, type CannedResponsesModule, type CannedResponsesModuleOptions, type Channel, type ChannelListItem, type ChannelStatus, type ChannelType, type ChannelsModule, type ChannelsModuleOptions, type ContactChannel, type ContactConversationSummary, type ContactFieldDefinition, type ContactFieldValue, type ContactFieldValueInput, type ContactIdentity, type ContactIdentityInput, type ContactItem, type ContactSearchOpts, type ContactTag, type ContactsMetadata, type ContactsModule, type ContactsModuleOptions, type ConversationItem, type ConversationListOpts, type ConversationsModule, type ConversationsModuleOptions, type CreateAgentInput, type CreateApiKeyInput, type CreateApiKeyResponse, type CreateCannedResponseInput, type CreateChannelBody, type CreateContactInput, type CreateEmailChannelBody, type CreateEmailTemplateInput, type CreateWhatsAppBusinessAccountBody, type CreateWhatsAppChannelBody, type CredentialsMode, type EmailChannelConfig, type EmailChannelSecret, type EmailImapConfig, type EmailSmtpConfig, type EmailTemplateItem, type EmailTemplateListOpts, type ImportApprovedResult, type ImportedTemplateResult, type LobbyEntry, type LobbyListOpts, type MessageItem, type MessageListOpts, type MessageReadUpdatePayload, type MessageStatusPayload, type MessagesModule, type MessagesModuleOptions, type OAuth2CertificateEmailChannelSecret, type OAuth2ClientSecretEmailChannelSecret, type OAuth2EmailChannelConfig, type OAuth2EmailChannelSecret, type OmnivoxClient, type OmnivoxClientOptions, OmnivoxRequestError, type PageOpts, type PageParams, type PagedResponse, type ParticipantPayload, type PatchContactInput, type PatchEmailTemplateInput, type PickupInput, type ReopenOrCreateInput, type RevokeApiKeyResponse, type SendMessageInput, type SendTemplateInput, type SubmitResult, type TemplatesModule, type TemplatesModuleOptions, type TenantsModule, type TenantsModuleOptions, type TokenProvider, type TypingIndicatorPayload, type UpdateCannedResponseInput, type UpdateChannelBody, type UpdateStatusInput, type UpdateWhatsAppTemplateInput, type WhatsAppBusinessAccountItem, type WhatsAppBusinessAccountsModule, type WhatsAppBusinessAccountsModuleOptions, type WhatsAppChannelConfig, type WhatsAppRecoveryOption, type WhatsAppTemplateDetail, type WhatsAppTemplateHistory, type WhatsAppTemplateHistoryEvent, type WhatsAppTemplateHistoryVersion, type WhatsAppTemplateItem, type WhatsAppTemplateListOpts, type WsAuth, type WsClient, type WsClientInstance, type WsClientOptions, type WsConnectionState, type WsEventPayloads, buildPageParams, createAgentsModule, createApiKeyTokenProvider, createAttachmentsModule, createAuthMeModule, createCannedResponsesModule, createChannelsModule, createContactsModule, createConversationsModule, createMessagesModule, createOmnivoxClient, createSessionTokenProvider, createTemplatesModule, createTenantsModule, createWhatsAppBusinessAccountsModule, createWsClient, iteratePages };