@nubea-ecomm/wapo-sdk 0.1.0 → 0.2.0

package/README.md

@@ -1,11 +1,17 @@
 # @nubea-ecomm/wapo-sdk
 
+[![Wapo SDK version](https://img.shields.io/npm/v/%40nubea-ecomm%2Fwapo-sdk?label=Wapo%20SDK&color=171717)](https://www.npmjs.com/package/@nubea-ecomm/wapo-sdk)
+
 Typed JavaScript and TypeScript client for the public Wapo messaging API.
 
 ## Install
 
+Choose the command for your package manager:
+
 ```bash
 npm install @nubea-ecomm/wapo-sdk
+# or: pnpm add @nubea-ecomm/wapo-sdk
+# or: yarn add @nubea-ecomm/wapo-sdk
 ```
 
 Node.js 18 or newer is required. Modern browsers with `fetch` and

package/dist/admin-client.d.ts

@@ -1,6 +1,11 @@
 import { Transport } from './transport.js';
 import type { UserRole, ApiKey, Page, Project, ConsoleUser, WhatsAppSettings } from './types.js';
 export declare class WapoAdminClient extends Transport {
+    emailSettings(): Promise<{
+        data: {
+            smtp_configured: boolean;
+        };
+    }>;
     whatsappSettings(): Promise<{
         data: WhatsAppSettings;
     }>;
@@ -8,7 +13,7 @@ export declare class WapoAdminClient extends Transport {
     createUser(input: {
         name: string;
         email: string;
-        password: string;
+        password?: string;
         role?: UserRole;
         all_projects?: boolean;
         project_ids?: string[];

package/dist/admin-client.js

@@ -1,5 +1,8 @@
 import { Transport } from './transport.js';
 export class WapoAdminClient extends Transport {
+    emailSettings() {
+        return this.request('GET', '/admin/v1/settings/email');
+    }
     whatsappSettings() {
         return this.request('GET', '/admin/v1/settings/whatsapp');
     }

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { Transport } from './transport.js';
-import type { ApiKey, MessageTemplate, TemplateInput, ProjectSettings, Connection, Conversation, Customer, CustomerInput, Message, Page, SetupLink, SetupLinkInput, Webhook } from './types.js';
+import type { ApiKey, MessageTemplate, TemplateInput, ProjectSettings, NotificationSettings, Connection, BusinessProfile, BusinessProfileInput, Contact, ContactInput, Conversation, Customer, CustomerInput, Message, Page, SetupLink, SetupLinkInput, Webhook } from './types.js';
 export declare class WapoClient extends Transport {
     project(): Promise<{
         data: ProjectSettings;
@@ -10,6 +10,12 @@ export declare class WapoClient extends Transport {
     }): Promise<{
         data: ProjectSettings;
     }>;
+    notificationSettings(): Promise<{
+        data: NotificationSettings;
+    }>;
+    updateNotificationSettings(input: Omit<NotificationSettings, 'smtp_configured' | 'project_users'>): Promise<{
+        data: NotificationSettings;
+    }>;
     me(): Promise<{
         data: {
             project_id: string;
@@ -47,6 +53,30 @@ export declare class WapoClient extends Transport {
         data: Connection;
     }>;
     deleteConnection(id: string): Promise<unknown>;
+    businessProfile(connectionId: string): Promise<{
+        data: BusinessProfile;
+    }>;
+    updateBusinessProfile(connectionId: string, input: BusinessProfileInput): Promise<{
+        data: BusinessProfile;
+    }>;
+    listContacts(options?: {
+        after?: string;
+        search?: string;
+        connection_id?: string;
+        marketing_status?: 'stopped' | 'resumed';
+    }): Promise<Page<Contact>>;
+    contact(id: string): Promise<{
+        data: Contact;
+    }>;
+    createContact(input: ContactInput): Promise<{
+        data: Contact;
+    }>;
+    updateContact(id: string, input: Partial<Pick<ContactInput, 'display_name' | 'email' | 'properties'>> & {
+        use_provider_name?: true;
+    }): Promise<{
+        data: Contact;
+    }>;
+    eraseContact(id: string): Promise<unknown>;
     listMessages(connectionId?: string): Promise<Page<Message>>;
     sendText(connectionId: string, to: string, text: string, idempotencyKey: string): Promise<{
         data: Message;

package/dist/client.js

@@ -7,6 +7,12 @@ export class WapoClient extends Transport {
     updateProject(input) {
         return this.request('PATCH', '/v1/project', input);
     }
+    notificationSettings() {
+        return this.request('GET', '/v1/notification-settings');
+    }
+    updateNotificationSettings(input) {
+        return this.request('PATCH', '/v1/notification-settings', input);
+    }
     me() {
         return this.request('GET', '/v1/me');
     }
@@ -40,6 +46,36 @@ export class WapoClient extends Transport {
     deleteConnection(id) {
         return this.request('DELETE', `/v1/connections/${encode(id)}`);
     }
+    businessProfile(connectionId) {
+        return this.request('GET', `/v1/connections/${encode(connectionId)}/business-profile`);
+    }
+    updateBusinessProfile(connectionId, input) {
+        return this.request('PATCH', `/v1/connections/${encode(connectionId)}/business-profile`, input);
+    }
+    listContacts(options = {}) {
+        const query = new URLSearchParams();
+        if (options.after)
+            query.set('after', options.after);
+        if (options.search)
+            query.set('search', options.search);
+        if (options.connection_id)
+            query.set('connection_id', options.connection_id);
+        if (options.marketing_status)
+            query.set('marketing_status', options.marketing_status);
+        return this.request('GET', `/v1/contacts${query.size ? `?${query.toString()}` : ''}`);
+    }
+    contact(id) {
+        return this.request('GET', `/v1/contacts/${encode(id)}`);
+    }
+    createContact(input) {
+        return this.request('POST', '/v1/contacts', input);
+    }
+    updateContact(id, input) {
+        return this.request('PATCH', `/v1/contacts/${encode(id)}`, input);
+    }
+    eraseContact(id) {
+        return this.request('DELETE', `/v1/contacts/${encode(id)}`);
+    }
     listMessages(connectionId) {
         return this.request('GET', `/v1/messages${connectionId ? `?connection_id=${encode(connectionId)}` : ''}`);
     }

package/dist/types.d.ts

@@ -33,6 +33,55 @@ export interface Connection {
     credential_status?: 'valid' | 'expired';
     access_token_expires_at?: string;
 }
+export type BusinessVertical = 'ALCOHOL' | 'APPAREL' | 'AUTO' | 'BEAUTY' | 'EDU' | 'ENTERTAIN' | 'EVENT_PLAN' | 'FINANCE' | 'GOVT' | 'GROCERY' | 'HEALTH' | 'HOTEL' | 'NONPROFIT' | 'ONLINE_GAMBLING' | 'OTC_DRUGS' | 'OTHER' | 'PHYSICAL_GAMBLING' | 'PROF_SERVICES' | 'RESTAURANT' | 'RETAIL' | 'TRAVEL';
+export interface BusinessProfile {
+    about?: string;
+    address?: string;
+    description?: string;
+    email?: string;
+    profile_picture_url?: string;
+    websites?: string[];
+    vertical?: BusinessVertical;
+}
+export interface BusinessProfileInput extends Omit<BusinessProfile, 'profile_picture_url'> {
+    profile_picture_handle?: string;
+}
+export type ContactProperty = string | number | boolean | null;
+export interface MarketingPreference {
+    status: 'stopped' | 'resumed';
+    marketing_allowed: boolean;
+    detail: string;
+    source: '' | 'meta_webhook' | 'meta_delivery_error' | 'meta_synchronous_error';
+    sequence: number;
+    last_event_at?: string;
+}
+export interface Contact {
+    id: string;
+    connection_id: string;
+    customer_id?: string;
+    wa_id: string;
+    phone_number: string;
+    business_scoped_user_id?: string;
+    parent_business_scoped_user_id?: string;
+    username?: string;
+    profile_name?: string;
+    display_name: string;
+    display_name_source: 'local' | 'meta' | 'username' | 'phone';
+    email?: string;
+    properties: Record<string, ContactProperty>;
+    phone_number_id: string;
+    connection_name?: string;
+    marketing_preference: MarketingPreference;
+    created_at: string;
+    updated_at: string;
+}
+export interface ContactInput {
+    connection_id: string;
+    phone_number: string;
+    display_name: string;
+    email?: string;
+    properties?: Record<string, ContactProperty>;
+}
 export interface Message {
     id: string;
     connection_id: string;
@@ -134,6 +183,7 @@ export interface ConsoleUser {
     language: 'es' | 'pt' | 'en';
     avatar_variant: number;
     active: boolean;
+    invitation_pending?: boolean;
     created_at: string;
 }
 export interface WhatsAppSettings {
@@ -150,6 +200,19 @@ export interface ProjectSettings extends Project {
         theme: 'light' | 'dark';
     };
 }
+export interface NotificationSettings {
+    recipients: string[];
+    whatsapp_disconnected: boolean;
+    customer_needs_attention: boolean;
+    daily_stats: boolean;
+    weekly_stats: boolean;
+    smtp_configured: boolean;
+    project_users: Array<{
+        id: string;
+        name: string;
+        email: string;
+    }>;
+}
 export interface LogEntry {
     id: string;
     source: 'api' | 'meta' | 'messages' | 'webhooks' | 'events';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nubea-ecomm/wapo-sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Typed JavaScript and TypeScript client for the Wapo messaging API",
   "type": "module",
   "license": "Apache-2.0",