@in.pulse-crm/sdk 2.14.8 → 2.15.0

package/dist/types/customers.types.d.ts

@@ -75,3 +75,189 @@ export interface CreateCustomerDTO {
     SETOR?: number | null;
 }
 export type UpdateCustomerDTO = Partial<CreateCustomerDTO>;
+export interface CustomerLookupOption {
+    CODIGO: number;
+    NOME: string | null;
+}
+export interface CustomerContactDetail {
+    CODIGO: string;
+    NOME: string;
+    CARGO: number | null;
+    EMAIL: string | null;
+    AREA_DIRETO: string | null;
+    AREA_CEL: string | null;
+    AREA_RESI: string | null;
+    FONE_DIRETO: string | null;
+    CELULAR: string | null;
+    FONE_RESIDENCIAL: string | null;
+    ANIVERSARIO: string | null;
+    TIME_FUTEBOL: string | null;
+    SEXO: "M" | "F" | null;
+    FILHOS: number;
+    CLIENTE: number | null;
+    TRATAMENTO: string | null;
+}
+export interface CustomerPurchaseItemDetail {
+    purchaseCode: number;
+    productCode: string | null;
+    description: string | null;
+    quantity: number | null;
+    unit: string | null;
+    unitValue: number | null;
+    discount: number | null;
+}
+export interface CustomerPurchaseDetail {
+    CODIGO: number;
+    CLIENTE: number;
+    DATA: string;
+    VALOR: number;
+    DESCRICAO: string | null;
+    FORMA_PGTO: string | null;
+    OPERADOR: number | null;
+    FATURADO: "S" | "N" | null;
+    TIPO: string | null;
+    SITUACAO: "F" | "C" | null;
+    CLIENTEATIVO: number | null;
+    items: CustomerPurchaseItemDetail[];
+}
+export interface CustomerScheduleDetail {
+    CODIGO: number;
+    CLIENTE: number;
+    CAMPANHA: number;
+    DT_RESULTADO: string;
+    DT_AGENDAMENTO: string;
+    RESULTADO: number;
+    CONCLUIDO: "SIM" | "NAO" | null;
+    FONE1: string;
+    FONE2: string;
+    FONE3: string;
+    ORDEM: number;
+    OPERADOR: number;
+    OPERADOR_LIGACAO: number;
+    DATA_HORA_LIG: string;
+    DATA_HORA_FIM: string;
+    TELEFONE_LIGADO: string;
+    AGENDA: number;
+    DESC_FONE1: string | null;
+    DESC_FONE2: string | null;
+    DESC_FONE3: string | null;
+    FIDELIZA: "S" | "N" | null;
+    MANUAL: "S" | "N" | null;
+}
+export interface CustomerTelephonySchedule extends CustomerScheduleDetail {
+    CAMPANHA_NOME: string | null;
+    OPERADOR_NOME: string | null;
+    OPERADOR_LIGACAO_NOME: string | null;
+    CLIENTE_RAZAO: string | null;
+    CLIENTE_FANTASIA: string | null;
+}
+export interface FinishTelephonyScheduleDTO {
+    resultId: number;
+    scheduleDate?: string;
+    startedAt?: string;
+    finishedAt?: string;
+    dialedPhone?: string;
+}
+export interface CustomerCallHistoryDetail {
+    CODIGO: number;
+    OPERADOR: number;
+    CLIENTE: number;
+    RESULTADO: number;
+    EXCEDEU: "SIM" | "NAO" | null;
+    TEMPO_EXCEDIDO: string;
+    FONE_RECEPTIVO: string;
+    LIGACAO_RECEBIDA: string;
+    LIGACAO_FINALIZADA: string;
+    TIPO_ACAO: string;
+    OBS: string | null;
+}
+export interface CustomerFullDetail {
+    customer: Customer;
+    campaign: {
+        fullName: string | null;
+        firstName: string | null;
+    };
+    wallet: {
+        fullName: string | null;
+        firstName: string | null;
+    };
+    address: {
+        END_RUA: string | null;
+        CIDADE: string | null;
+        BAIRRO: string | null;
+        ESTADO: string | null;
+        CEP: string | null;
+        COMPLEMENTO: string | null;
+    };
+    origin: {
+        group: {
+            code: number | null;
+            description: string | null;
+        };
+        origin: {
+            code: number | null;
+            description: string | null;
+        };
+        media: {
+            code: number | null;
+            name: string | null;
+        };
+        operator: {
+            code: number | null;
+            name: string | null;
+        };
+        segment: {
+            code: number | null;
+            name: string | null;
+        };
+        emails: {
+            EMAIL: string | null;
+            EMAIL2: string | null;
+            CONTATO_MAIL: string | null;
+        };
+        WEBSITE: string | null;
+        NR_FUNCIONARIOS: number | null;
+        customName: string | null;
+    };
+    contacts: CustomerContactDetail[];
+    observations: {
+        OBS_ADMIN: string | null;
+        OBS_OPERADOR: string | null;
+    };
+    callHistory: CustomerCallHistoryDetail[];
+    phones: {
+        AREA1: number | null;
+        FONE1: string | null;
+        DESC_FONE1: string | null;
+        AREA2: number | null;
+        FONE2: string | null;
+        DESC_FONE2: string | null;
+        AREA3: number | null;
+        FONE3: string | null;
+        DESC_FONE3: string | null;
+        AREAFAX: number | null;
+        FAX: string | null;
+        DESCFAX: string | null;
+        campaignPhones: Array<{
+            area: number | null;
+            phone: string | null;
+            description: string | null;
+        }>;
+    };
+    purchases: CustomerPurchaseDetail[];
+    schedules: CustomerScheduleDetail[];
+    metadata: {
+        editableTabs: {
+            main: boolean;
+            address: boolean;
+            contacts: boolean;
+            observations: boolean;
+            phones: boolean;
+        };
+        purchaseItems: {
+            mapped: boolean;
+            tableName: string | null;
+        };
+        customNameFieldMapped: boolean;
+    };
+}

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./ai.types";
 export * from "./auth.types";
 export * from "./customers.types";
 export * from "./files.types";

package/dist/types/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ai.types"), exports);
 __exportStar(require("./auth.types"), exports);
 __exportStar(require("./customers.types"), exports);
 __exportStar(require("./files.types"), exports);

package/dist/types/response.types.d.ts

@@ -17,6 +17,14 @@ export interface PaginatedResponse<T> {
         totalRows: number;
     };
 }
+export interface FlexiblePaginatedResponse<T> {
+    message: string;
+    data: Array<T>;
+    page: {
+        current: number;
+        totalRows: number;
+    };
+}
 export interface QueryResponse<T> {
     result: T;
 }

package/dist/types/socket-events.types.d.ts

@@ -1,4 +1,4 @@
-import { SocketServerAdminRoom, SocketServerChatRoom, SocketServerInternalChatRoom, SocketServerReportsRoom, SocketServerRoom } from "./socket-rooms.types";
+import { SocketServerAdminRoom, SocketServerChatRoom, SocketServerInternalChatRoom, SocketServerReportsRoom, SocketServerRoom, SocketServerUserRoom } from "./socket-rooms.types";
 import { MessageResponse } from "./response.types";
 import { WppMessage, WppMessageStatus } from "./whatsapp.types";
 import { InternalChat, InternalChatMember, InternalMessage } from "./internal.types";
@@ -20,7 +20,8 @@ export declare enum SocketEventType {
     InternalMessage = "internal_message",
     InternalMessageEdit = "internal_message_edit",
     InternalMessageDelete = "internal_message_delete",
-    InternalMessageStatus = "internal_message_status"
+    InternalMessageStatus = "internal_message_status",
+    TelephonyCallReceived = "telephony_call_received"
 }
 export interface EmitSocketEventFn {
     (type: SocketEventType.WwebjsQr, room: SocketServerAdminRoom, data: WWEBJSQrEventData): Promise<MessageResponse>;
@@ -41,6 +42,7 @@ export interface EmitSocketEventFn {
     (type: SocketEventType.InternalMessageStatus, room: SocketServerInternalChatRoom, data: InternalMessageStatusEventData): Promise<MessageResponse>;
     (type: SocketEventType.InternalChatStarted, room: SocketServerRoom, data: InternalChatStartedEventData): Promise<MessageResponse>;
     (type: SocketEventType.InternalChatFinished, room: SocketServerRoom, data: InternalChatFinishedEventData): Promise<MessageResponse>;
+    (type: SocketEventType.TelephonyCallReceived, room: SocketServerUserRoom, data: TelephonyCallReceivedEventData): Promise<MessageResponse>;
 }
 export interface ListenSocketEventFn {
     (type: SocketEventType.WwebjsQr, callback: (data: WWEBJSQrEventData) => void): void;
@@ -61,6 +63,7 @@ export interface ListenSocketEventFn {
     (type: SocketEventType.InternalMessageStatus, callback: (data: InternalMessageStatusEventData) => void): void;
     (type: SocketEventType.WppMessageEdit, callback: (data: WppMessageEditEventData) => void): void;
     (type: SocketEventType.WppMessageDelete, callback: (data: WppMessageDeleteEventData) => void): void;
+    (type: SocketEventType.TelephonyCallReceived, callback: (data: TelephonyCallReceivedEventData) => void): void;
 }
 export interface UnlistenSocketEventFn {
     (type: SocketEventType): void;
@@ -157,3 +160,13 @@ export type ReportStatusEventData = {
     isFailed: false;
     progress: number;
 });
+export interface TelephonyCallReceivedEventData {
+    uniqueid: string;
+    callerNumber: string;
+    callerName: string | null;
+    ramal: string;
+    operatorId: number | null;
+    instance: string;
+    receivedAt: string;
+    receptiveCallId: number | null;
+}

package/dist/types/socket-events.types.js

@@ -21,4 +21,5 @@ var SocketEventType;
     SocketEventType["InternalMessageEdit"] = "internal_message_edit";
     SocketEventType["InternalMessageDelete"] = "internal_message_delete";
     SocketEventType["InternalMessageStatus"] = "internal_message_status";
+    SocketEventType["TelephonyCallReceived"] = "telephony_call_received";
 })(SocketEventType || (exports.SocketEventType = SocketEventType = {}));

package/dist/types/whatsapp.types.d.ts

@@ -44,6 +44,102 @@ export interface PaginatedContactsResponse {
         hasPrev: boolean;
     };
 }
+export type CustomerInteractionLevel = "sem_interacao" | "pouca_interacao" | "interacao_media" | "interacao_alta";
+export type CustomerPurchaseLevel = "sem_compras" | "poucas_compras" | "compras_medias" | "muitas_compras";
+export type CustomerAgeLevel = "sem_data_cadastro" | "cliente_novo" | "ate_6_meses" | "ate_12_meses" | "mais_de_12_meses";
+export type CustomerPurchaseInterestLevel = "nao_analisado" | "baixo_interesse" | "interesse_moderado" | "alto_interesse" | "pronto_para_compra";
+export interface CustomerProfileManualOverrides {
+    profileLevel: CustomerProfileSummaryLevel | null;
+    purchaseInterestLevel: CustomerPurchaseInterestLevel | null;
+    updatedAt: string;
+    updatedByUserId: number;
+    updatedByName: string;
+}
+export interface UpdateCustomerProfileManualOverridesInput {
+    profileLevel?: CustomerProfileSummaryLevel | null;
+    purchaseInterestLevel?: CustomerPurchaseInterestLevel | null;
+}
+export interface CustomerPurchaseInterestPayload {
+    level: CustomerPurchaseInterestLevel;
+    label: string;
+    color: string;
+    reasons: string[];
+    source: "placeholder_rules" | "manual_override";
+}
+export type CustomerProfileSummaryLevel = "potencial_de_compra" | "consolidado" | "precisa_mais_interacao" | "em_observacao";
+export interface CustomerInteractionTagMetrics {
+    windowDays: number;
+    contactCount: number;
+    chatCount90d: number;
+    messageCount90d: number;
+    recentActiveDays90d: number;
+    lastInteractionAt: string | null;
+    allTimeMessageCount: number;
+    allTimeChatCount: number;
+    activeContactCount: number;
+    reasons: string[];
+}
+export interface CustomerPurchaseTagMetrics {
+    windowMonths: number;
+    allTimePurchaseCount: number;
+    purchaseCount12m: number;
+    totalPurchaseValue12m: number;
+    lastPurchaseAt: string | null;
+    daysSinceLastPurchase: number | null;
+    reasons: string[];
+}
+export interface CustomerAgeTagMetrics {
+    newCustomerWindowDays: number;
+    registeredAt: string | null;
+    customerAgeDays: number | null;
+    customerAgeMonths: number | null;
+    reasons: string[];
+}
+export type CustomerProfileTagMetadata = CustomerInteractionTagMetrics | CustomerPurchaseTagMetrics | CustomerAgeTagMetrics;
+export interface CustomerProfileTagPayload<TMetadata = CustomerProfileTagMetadata> {
+    id: number;
+    instance: string;
+    customerId: number;
+    tagType: string;
+    tagValue: string;
+    label: string;
+    color: string;
+    calculatedAt: string;
+    metadata: TMetadata | null;
+}
+export interface CustomerProfileSummaryPayload {
+    instance: string;
+    customerId: number;
+    profileLevel: CustomerProfileSummaryLevel;
+    label: string;
+    color: string;
+    profileSource: "automatic" | "manual_override";
+    reasons: string[];
+    purchaseInterest: CustomerPurchaseInterestPayload;
+    manualOverrides: CustomerProfileManualOverrides | null;
+    tags: {
+        interaction: CustomerProfileTagPayload<CustomerInteractionTagMetrics>;
+        purchase: CustomerProfileTagPayload<CustomerPurchaseTagMetrics>;
+        age: CustomerProfileTagPayload<CustomerAgeTagMetrics>;
+    };
+}
+export interface CustomerProfileSummaryFilters {
+    profileLevel?: CustomerProfileSummaryLevel;
+    interactionLevel?: CustomerInteractionLevel;
+    purchaseLevel?: CustomerPurchaseLevel;
+    ageLevel?: CustomerAgeLevel;
+    purchaseInterestLevel?: CustomerPurchaseInterestLevel;
+    state?: string;
+    city?: string;
+    activeCustomer?: "SIM" | "NAO";
+    searchTerm?: string;
+    segmentIds?: number[];
+    campaignIds?: number[];
+    operatorIds?: number[];
+}
+export interface CustomerProfileSummaryBatchRequest {
+    customerIds: number[];
+}
 export interface WppMessage {
     id: number;
     instance: string;
@@ -69,6 +165,7 @@ export interface WppMessage {
     wwebjsIdStanza: string | null;
     sentAt: Date;
     userId: number | null;
+    agentId: number | null;
     billingCategory: string | null;
     clientId: number | null;
 }
@@ -91,6 +188,7 @@ export interface WppChat {
     userName?: string;
     walletId?: number;
     botId?: number;
+    agentId?: number | null;
     resultId?: number;
     sectorId?: number;
     type: WppChatType;
@@ -174,6 +272,77 @@ export interface CreateScheduleDTO {
     scheduledFor: number;
     sectorId: number;
 }
+export type UnifiedScheduleChannel = "WHATSAPP" | "TELEFONIA";
+export type UnifiedScheduleRepurchaseStatus = "green" | "yellow" | "red" | "neutral";
+export interface UnifiedScheduleRepurchaseMetrics {
+    averageRepurchaseDays: number | null;
+    daysSinceLastPurchase: number | null;
+    nextRepurchaseDate: string | null;
+    proximityRatio: number | null;
+    semaphoreStatus: UnifiedScheduleRepurchaseStatus;
+    overdueDays: number | null;
+}
+export interface UnifiedScheduleCampaignFilterOption {
+    id: string;
+    label: string;
+}
+export interface UnifiedScheduleFilterMetadata {
+    customerCampaigns: UnifiedScheduleCampaignFilterOption[];
+}
+export interface UnifiedSchedulePagination {
+    current: number;
+    perPage: number;
+    totalRows: number;
+    totalPages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+}
+export interface UnifiedScheduleFilters extends CustomerProfileSummaryFilters {
+    page?: string;
+    perPage?: string;
+    channels?: string;
+    customerCampaignIds?: string;
+    repurchaseStatuses?: string;
+    userId?: string;
+    sectorId?: string;
+}
+export interface UnifiedSchedule {
+    id: string;
+    channel: UnifiedScheduleChannel;
+    scheduleId: number;
+    scheduleAt: string;
+    scheduledBy: number | null;
+    scheduledFor: number | null;
+    description: string | null;
+    contactName: string | null;
+    contactPhone: string | null;
+    customerId: number | null;
+    customerName: string | null;
+    customerFantasyName: string | null;
+    customerCampaignId: number | null;
+    customerCampaignName: string | null;
+    customerOriginId: number | null;
+    customerOriginDescription: string | null;
+    telephonyCampaignId: number | null;
+    telephonyCampaignName: string | null;
+    profileSummary: CustomerProfileSummaryPayload | null;
+    repurchase: UnifiedScheduleRepurchaseMetrics | null;
+    meta: {
+        wppContactId?: number;
+        wppChatId?: number | null;
+        telephonyRecordId?: number;
+    };
+}
+export interface UnifiedSchedulesResponse {
+    message: string;
+    data: UnifiedSchedule[];
+    page: {
+        current: number;
+        totalRows: number;
+    };
+    pagination: UnifiedSchedulePagination;
+    filters: UnifiedScheduleFilterMetadata;
+}
 export interface WppSchedule {
     id: number;
     instance: string;

package/dist/whatsapp.client.d.ts

@@ -1,7 +1,7 @@
 import ApiClient from "./api-client";
 import { RequestFilters } from "./types";
 import { DataResponse, MessageResponse } from "./types/response.types";
-import { AppNotification, AutomaticResponseRule, AutomaticResponseRuleDTO, CreateScheduleDTO, ForwardMessagesData, PaginatedContactsResponse, PaginatedNotificationsResponse, SendFileMessageData, SendMessageData, WppChatsAndMessages, WppChatWithDetailsAndMessages, WppContact, WppMessage, WppSchedule, WppWallet } from "./types/whatsapp.types";
+import { AppNotification, AutomaticResponseRule, AutomaticResponseRuleDTO, CustomerProfileManualOverrides, CustomerProfileSummaryBatchRequest, CustomerProfileSummaryFilters, CustomerProfileSummaryPayload, CreateScheduleDTO, ForwardMessagesData, PaginatedContactsResponse, PaginatedNotificationsResponse, SendFileMessageData, SendMessageData, UnifiedScheduleFilters, UnifiedSchedulesResponse, WppChatsAndMessages, WppChatWithDetailsAndMessages, WppContact, WppMessage, WppSchedule, UpdateCustomerProfileManualOverridesInput, WppWallet } from "./types/whatsapp.types";
 interface FetchMessagesFilters {
     minDate: string;
     maxDate: string;
@@ -22,6 +22,11 @@ export default class WhatsappClient extends ApiClient {
         name: string;
     }[]>;
     getCustomerContacts(customerId: number): Promise<WppContact[]>;
+    getCustomerProfileSummary(customerId: number): Promise<CustomerProfileSummaryPayload>;
+    getCustomerProfileManualOverrides(customerId: number): Promise<CustomerProfileManualOverrides | null>;
+    updateCustomerProfileManualOverrides(customerId: number, data: UpdateCustomerProfileManualOverridesInput): Promise<CustomerProfileSummaryPayload>;
+    getCustomerProfileSummaries(data: CustomerProfileSummaryBatchRequest): Promise<CustomerProfileSummaryPayload[]>;
+    findCustomerIdsByProfileFilters(filters: CustomerProfileSummaryFilters): Promise<number[]>;
     getContactsWithCustomer(filters?: {
         name?: string;
         phone?: string;
@@ -69,6 +74,7 @@ export default class WhatsappClient extends ApiClient {
      * @returns Uma Promise que resolve para um array de objetos wppSchedule.
      */
     getSchedules(userId?: string, sectorId?: string, filters?: RequestFilters<WppSchedule>): Promise<any>;
+    getUnifiedSchedules(filters?: UnifiedScheduleFilters): Promise<UnifiedSchedulesResponse>;
     /**
      * Cria um novo agendamento.
      * @param scheduleData - Os dados do agendamento, keys de wppSchedule.

package/dist/whatsapp.client.js

@@ -79,6 +79,41 @@ class WhatsappClient extends api_client_1.default {
         const { data: res } = await this.ax.get(url);
         return res.data;
     }
+    async getCustomerProfileSummary(customerId) {
+        const { data: res } = await this.ax.get(`/api/whatsapp/customers/${customerId}/profile-tags/summary`);
+        return res.data;
+    }
+    async getCustomerProfileManualOverrides(customerId) {
+        const { data: res } = await this.ax.get(`/api/whatsapp/customers/${customerId}/profile-tags/manual-overrides`);
+        return res.data;
+    }
+    async updateCustomerProfileManualOverrides(customerId, data) {
+        const { data: res } = await this.ax.put(`/api/whatsapp/customers/${customerId}/profile-tags/manual-overrides`, data);
+        return res.data;
+    }
+    async getCustomerProfileSummaries(data) {
+        const { data: res } = await this.ax.post(`/api/whatsapp/customers/profile-tags/summary/batch`, data);
+        return res.data;
+    }
+    async findCustomerIdsByProfileFilters(filters) {
+        const params = new URLSearchParams();
+        if (filters.profileLevel)
+            params.append("profileLevel", filters.profileLevel);
+        if (filters.interactionLevel)
+            params.append("interactionLevel", filters.interactionLevel);
+        if (filters.purchaseLevel)
+            params.append("purchaseLevel", filters.purchaseLevel);
+        if (filters.ageLevel)
+            params.append("ageLevel", filters.ageLevel);
+        if (filters.purchaseInterestLevel)
+            params.append("purchaseInterestLevel", filters.purchaseInterestLevel);
+        const queryString = params.toString();
+        const url = queryString
+            ? `/api/whatsapp/customers/profile-tags/customer-ids?${queryString}`
+            : `/api/whatsapp/customers/profile-tags/customer-ids`;
+        const { data: res } = await this.ax.get(url);
+        return res.data;
+    }
     async getContactsWithCustomer(filters) {
         let url = `/api/whatsapp/contacts/customer`;
         if (filters) {
@@ -235,6 +270,20 @@ class WhatsappClient extends api_client_1.default {
         const response = await this.ax.get(baseUrl);
         return response.data;
     }
+    async getUnifiedSchedules(filters) {
+        let baseUrl = `/api/whatsapp/schedules/unified`;
+        const params = new URLSearchParams(Object.entries(filters ?? {}).reduce((acc, [key, value]) => {
+            if (value !== undefined && value !== null) {
+                acc[key] = String(value);
+            }
+            return acc;
+        }, {}));
+        if (params.toString()) {
+            baseUrl += `?${params.toString()}`;
+        }
+        const response = await this.ax.get(baseUrl);
+        return response.data;
+    }
     /**
      * Cria um novo agendamento.
      * @param scheduleData - Os dados do agendamento, keys de wppSchedule.

package/package.json

@@ -1,14 +1,16 @@
 {
 	"name": "@in.pulse-crm/sdk",
-	"version": "2.14.8",
+	"version": "2.15.0",
 	"description": "SDKs for abstraction of api consumption of in.pulse-crm application",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"module": "./dist/index.js",
 	"exports": {
 		".": {
+			"types": "./dist/index.d.ts",
 			"import": "./dist/index.js",
-			"require": "./dist/index.js"
+			"require": "./dist/index.js",
+			"default": "./dist/index.js"
 		}
 	},
 	"scripts": {