@digisglobal/omnivox-sdk 0.7.0 → 0.8.0

package/dist/index.cjs

@@ -226,9 +226,15 @@ var getChannelsControllerVerifyUrl = (id, channelId) => {
 var getWhatsAppBusinessAccountsControllerListUrl = (id) => {
   return `/api/v1/tenants/${id}/whatsapp-business-accounts`;
 };
+var getWhatsAppBusinessAccountsControllerCreateUrl = (id) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts`;
+};
 var getWhatsAppBusinessAccountsControllerFindOneUrl = (id, wabaRowId) => {
   return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaRowId}`;
 };
+var getWhatsAppBusinessAccountsControllerUpdateNameUrl = (id, wabaRowId) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaRowId}`;
+};
 var getAgentsControllerCreateUrl = () => {
   return `/api/v1/agents`;
 };
@@ -248,12 +254,25 @@ var getAgentsControllerFindOneUrl = (id) => {
 var getTemplatesControllerAuthorDraftUrl = (id, wabaId) => {
   return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates`;
 };
+var getTemplatesControllerListUrl = (id, wabaId, params) => {
+  const normalizedParams = new URLSearchParams();
+  Object.entries(params || {}).forEach(([key, value]) => {
+    if (value !== void 0) {
+      normalizedParams.append(key, value === null ? "null" : String(value));
+    }
+  });
+  const stringifiedParams = normalizedParams.toString();
+  return stringifiedParams.length > 0 ? `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates?${stringifiedParams}` : `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates`;
+};
 var getTemplatesControllerImportApprovedUrl = (id, wabaId) => {
   return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates/import`;
 };
 var getTemplatesControllerForkDraftUrl = (id, wabaId, templateId) => {
   return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates/${templateId}`;
 };
+var getTemplatesControllerGetByIdUrl = (id, wabaId, templateId) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates/${templateId}`;
+};
 var getTemplatesControllerGetHistoryUrl = (id, wabaId, templateId) => {
   return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates/${templateId}/history`;
 };
@@ -399,7 +418,7 @@ function createTenantsModule(options) {
           url,
           buildInit("POST", { body: JSON.stringify(body) })
         );
-        return parseResponse(res);
+        return parseEnvelopedResponse(res);
       },
       /**
        * Revoke an existing API key immediately.
@@ -409,7 +428,7 @@ function createTenantsModule(options) {
         const path = getApiKeysControllerRevokeUrl(tenantId, keyId);
         const url = `${baseUrl}${path}`;
         const res = await fetch(url, buildInit("DELETE"));
-        return parseResponse(res);
+        return parseEnvelopedResponse(res);
       }
     }
   };
@@ -438,7 +457,7 @@ function createAgentsModule(options) {
       const path = getAgentsControllerCreateUrl();
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * List agents for the authenticated tenant (paginated, sorted deterministically).
@@ -460,7 +479,7 @@ function createAgentsModule(options) {
       const path = getAgentsControllerFindOneUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("GET"));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     }
   };
 }
@@ -490,7 +509,7 @@ function createChannelsModule(options) {
       const path = getChannelsControllerCreateUrl(tenantId);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", body));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Get a single channel by id (config + name/status/isDefault/type +
@@ -501,7 +520,7 @@ function createChannelsModule(options) {
       const path = getChannelsControllerFindOneUrl(tenantId, channelId);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("GET"));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Update a channel (name/status/isDefault/config; Email may rotate secret).
@@ -511,7 +530,7 @@ function createChannelsModule(options) {
       const path = getChannelsControllerUpdateUrl(tenantId, channelId);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("PATCH", body));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Verify a channel through its adapter; on success sets lastVerifiedAt.
@@ -549,7 +568,7 @@ function createContactsModule(options) {
       const path = getContactsControllerCreateUrl();
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Search contacts by display name or raw identifier.
@@ -576,7 +595,7 @@ function createContactsModule(options) {
       const path = getContactsControllerGetDetailUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("GET"));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Return the tenant's tag catalog and custom-field definitions.
@@ -586,7 +605,7 @@ function createContactsModule(options) {
       const path = getContactsControllerGetMetadataUrl();
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("GET"));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Partially update a contact.
@@ -596,7 +615,7 @@ function createContactsModule(options) {
       const path = getContactsControllerPatchUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("PATCH", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Add a channel identity to an existing contact.
@@ -606,7 +625,7 @@ function createContactsModule(options) {
       const path = getContactsControllerAddIdentityUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     }
   };
 }
@@ -635,7 +654,7 @@ function createConversationsModule(options) {
       const path = getConversationsControllerReopenOrCreateUrl();
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * List conversations with optional filters (paginated, sorted deterministically).
@@ -663,7 +682,7 @@ function createConversationsModule(options) {
       const path = getConversationsControllerUpdateStatusUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("PATCH", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Assign a conversation to an agent.
@@ -673,7 +692,7 @@ function createConversationsModule(options) {
       const path = getConversationsControllerAssignUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("PATCH", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * List lobby entries awaiting pickup (paginated, sorted by receivedAt DESC).
@@ -695,18 +714,18 @@ function createConversationsModule(options) {
       const path = getConversationsControllerFindOneUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("GET"));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * 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.
      */
     async pickup(entryId, input) {
       const path = getConversationsControllerPickupLobbyEntryUrl(entryId);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * List APPROVED + SENDABLE WhatsApp templates eligible to re-open an
@@ -718,7 +737,7 @@ function createConversationsModule(options) {
       const path = getConversationsControllerGetWhatsAppRecoveryOptionsUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("GET"));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     }
   };
 }
@@ -746,7 +765,7 @@ function createMessagesModule(options) {
       const path = getMessagesControllerSendUrl();
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * List messages in a conversation (newest first, paginated).
@@ -774,7 +793,7 @@ function createMessagesModule(options) {
       const path = getMessagesControllerGetByIdUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("GET"));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Soft-delete a message (sets deletedAt; row preserved).
@@ -796,7 +815,7 @@ function createMessagesModule(options) {
       const path = getMessagesControllerSendTemplateUrl();
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     }
   };
 }
@@ -820,6 +839,38 @@ function createTemplatesModule(options) {
      * 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.
+       */
+      async list(tenantId, wabaId, opts) {
+        const { page, pageSize } = buildPageParams(opts);
+        const path = getTemplatesControllerListUrl(tenantId, wabaId, {
+          page,
+          pageSize,
+          ...opts.status ? { status: opts.status } : {},
+          ...opts.q ? { q: opts.q } : {}
+        });
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("GET"));
+        return parseResponse(res);
+      },
+      /**
+       * 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.
+       */
+      async getById(tenantId, wabaId, templateId) {
+        const path = getTemplatesControllerGetByIdUrl(
+          tenantId,
+          wabaId,
+          templateId
+        );
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("GET"));
+        return parseEnvelopedResponse(res);
+      },
       /**
        * Author a new DRAFT template (version 1) under a WhatsApp Business Account.
        * Calls POST /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates.
@@ -855,7 +906,11 @@ function createTemplatesModule(options) {
         return parseEnvelopedResponse(res);
       },
       /**
-       * 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.
        */
       async history(tenantId, wabaId, templateId) {
@@ -903,7 +958,11 @@ function createTemplatesModule(options) {
        */
       async list(opts) {
         const { page, pageSize } = buildPageParams(opts);
-        const path = getEmailTemplatesControllerListUrl({ page, pageSize });
+        const path = getEmailTemplatesControllerListUrl({
+          page,
+          pageSize,
+          ...opts.q ? { q: opts.q } : {}
+        });
         const url = `${baseUrl}${path}`;
         const res = await fetch(url, buildInit("GET"));
         return parseResponse(res);
@@ -995,7 +1054,7 @@ function createCannedResponsesModule(options) {
       const path = getCannedResponsesControllerCreateUrl();
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Partially update a canned response — title, body, and/or keywords.
@@ -1005,7 +1064,7 @@ function createCannedResponsesModule(options) {
       const path = getCannedResponsesControllerPatchUrl(id);
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("PATCH", input));
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Delete a canned response by id.
@@ -1050,7 +1109,7 @@ function createAttachmentsModule(options) {
         },
         body: form
       });
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     },
     /**
      * Get a short-lived presigned download URL for a stored attachment.
@@ -1068,7 +1127,7 @@ function createAttachmentsModule(options) {
           ...options.getHeaders()
         }
       });
-      return parseResponse(res);
+      return parseEnvelopedResponse(res);
     }
   };
 }
@@ -1076,14 +1135,15 @@ function createAttachmentsModule(options) {
 // src/whatsapp-business-accounts/whatsapp-business-accounts.ts
 function createWhatsAppBusinessAccountsModule(options) {
   const baseUrl = options.baseUrl;
-  function buildInit(method) {
+  function buildInit(method, body) {
     return {
       method,
       credentials: options.getCredentials(),
       headers: {
         "Content-Type": "application/json",
         ...options.getHeaders()
-      }
+      },
+      ...body !== void 0 ? { body: JSON.stringify(body) } : {}
     };
   }
   return {
@@ -1118,6 +1178,44 @@ function createWhatsAppBusinessAccountsModule(options) {
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("GET"));
       return parseEnvelopedResponse(res);
+    },
+    /**
+     * 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 },
+     * })
+     */
+    async create(tenantId, body) {
+      const path = getWhatsAppBusinessAccountsControllerCreateUrl(tenantId);
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("POST", body));
+      return parseEnvelopedResponse(res);
+    },
+    /**
+     * 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',
+     * })
+     */
+    async update(tenantId, wabaRowId, body) {
+      const path = getWhatsAppBusinessAccountsControllerUpdateNameUrl(
+        tenantId,
+        wabaRowId
+      );
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("PATCH", body));
+      return parseEnvelopedResponse(res);
     }
   };
 }