@in.pulse-crm/sdk 2.14.7 → 2.15.0

package/src/types/whatsapp.types.ts

@@ -46,6 +46,143 @@ export interface PaginatedContactsResponse {
 	};
 }
 
+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;
@@ -71,6 +208,7 @@ export interface WppMessage {
 	wwebjsIdStanza: string | null;
 	sentAt: Date;
 	userId: number | null;
+	agentId: number | null;
 	billingCategory: string | null;
 	clientId: number | null;
 }
@@ -89,6 +227,7 @@ export interface WppChat {
 	userName?: string;
 	walletId?: number;
 	botId?: number;
+	agentId?: number | null;
 	resultId?: number;
 	sectorId?: number;
 	type: WppChatType;
@@ -191,6 +330,86 @@ export interface CreateScheduleDTO {
 	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/src/whatsapp.client.ts

@@ -6,17 +6,25 @@ import {
 	AppNotification,
 	AutomaticResponseRule,
 	AutomaticResponseRuleDTO,
+	CustomerProfileManualOverrides,
+	CustomerProfileSummaryBatchRequest,
+	CustomerProfileSummaryFilters,
+	CustomerProfileSummaryPayload,
 	CreateScheduleDTO,
 	ForwardMessagesData,
 	PaginatedContactsResponse,
 	PaginatedNotificationsResponse,
 	SendFileMessageData,
 	SendMessageData,
+	UnifiedSchedule,
+	UnifiedScheduleFilters,
+	UnifiedSchedulesResponse,
 	WppChatsAndMessages,
 	WppChatWithDetailsAndMessages,
 	WppContact,
 	WppMessage,
 	WppSchedule,
+	UpdateCustomerProfileManualOverridesInput,
 	WppWallet,
 } from "./types/whatsapp.types";
 
@@ -155,6 +163,57 @@ export default class WhatsappClient extends ApiClient {
 		return res.data;
 	}
 
+	public async getCustomerProfileSummary(customerId: number) {
+		const { data: res } = await this.ax.get<DataResponse<CustomerProfileSummaryPayload>>(
+			`/api/whatsapp/customers/${customerId}/profile-tags/summary`,
+		);
+		return res.data;
+	}
+
+	public async getCustomerProfileManualOverrides(customerId: number) {
+		const { data: res } = await this.ax.get<DataResponse<CustomerProfileManualOverrides | null>>(
+			`/api/whatsapp/customers/${customerId}/profile-tags/manual-overrides`,
+		);
+		return res.data;
+	}
+
+	public async updateCustomerProfileManualOverrides(
+		customerId: number,
+		data: UpdateCustomerProfileManualOverridesInput,
+	) {
+		const { data: res } = await this.ax.put<DataResponse<CustomerProfileSummaryPayload>>(
+			`/api/whatsapp/customers/${customerId}/profile-tags/manual-overrides`,
+			data,
+		);
+		return res.data;
+	}
+
+	public async getCustomerProfileSummaries(data: CustomerProfileSummaryBatchRequest) {
+		const { data: res } = await this.ax.post<DataResponse<CustomerProfileSummaryPayload[]>>(
+			`/api/whatsapp/customers/profile-tags/summary/batch`,
+			data,
+		);
+		return res.data;
+	}
+
+	public async findCustomerIdsByProfileFilters(filters: CustomerProfileSummaryFilters) {
+		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<DataResponse<number[]>>(url);
+		return res.data;
+	}
+
 	public async getContactsWithCustomer(filters?: {
 		name?: string;
 		phone?: string;
@@ -353,6 +412,26 @@ export default class WhatsappClient extends ApiClient {
 		return response.data;
 	}
 
+	public async getUnifiedSchedules(filters?: UnifiedScheduleFilters) {
+		let baseUrl = `/api/whatsapp/schedules/unified`;
+		const params = new URLSearchParams(
+			Object.entries(filters ?? {}).reduce<Record<string, string>>((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<UnifiedSchedulesResponse>(baseUrl);
+		return response.data;
+	}
+
 	/**
 	 * Cria um novo agendamento.
 	 * @param scheduleData - Os dados do agendamento, keys de wppSchedule.