@in.pulse-crm/sdk 2.14.8 → 2.15.0

package/src/types/ai.types.ts

@@ -0,0 +1,378 @@
+import type {
+	CustomerAgeLevel,
+	CustomerInteractionLevel,
+	CustomerProfileSummaryLevel,
+	CustomerPurchaseInterestLevel,
+	CustomerPurchaseLevel,
+	WppContactWithCustomer,
+} from "./whatsapp.types";
+
+export interface SuggestResponseRequest {
+	chatId: number;
+}
+
+export interface SuggestResponseResponse {
+	suggestions: string[];
+}
+
+export interface SummarizeChatRequest {
+	chatId: number;
+}
+
+export interface SummarizeChatResponse {
+	summary: string;
+}
+
+export interface AnalyzeCustomerRequest {
+	customerId: number;
+}
+
+export interface AnalyzeCustomerResponse {
+	analysis: string;
+}
+
+export type SupervisorAiSessionStatus = "ACTIVE" | "ARCHIVED";
+
+export type SupervisorAiMessageRole = "USER" | "ASSISTANT";
+
+export type SupervisorAiReportFormat = "csv" | "pdf" | "txt";
+
+export interface SupervisorAiContextInput {
+	chatId?: number;
+	customerId?: number;
+	dateFrom?: string;
+	dateTo?: string;
+	operatorIds?: number[];
+	sectorIds?: number[];
+	includeMetrics?: boolean;
+}
+
+export interface SupervisorAiSource {
+	type: "action" | "chat" | "contact" | "customer" | "metrics" | "session" | "sql";
+	label: string;
+	entityId?: number;
+	metadata?: Record<string, unknown>;
+}
+
+export interface SupervisorAiReportPreview {
+	title: string;
+	summary: string;
+	columns: string[];
+	rows: Array<Record<string, string | number | boolean | null>>;
+	availableFormats: SupervisorAiReportFormat[];
+}
+
+export interface SupervisorAiMessageMetadata {
+	context?: SupervisorAiContextInput;
+	sources?: SupervisorAiSource[];
+	reportPreview?: SupervisorAiReportPreview | null;
+}
+
+export interface SupervisorAiSession {
+	id: number;
+	instance: string;
+	userId: number;
+	title: string;
+	status: SupervisorAiSessionStatus;
+	createdAt: string;
+	updatedAt: string;
+	lastMessageAt: string | null;
+}
+
+export interface SupervisorAiMessage {
+	id: number;
+	sessionId: number;
+	role: SupervisorAiMessageRole;
+	content: string;
+	metadata: SupervisorAiMessageMetadata | null;
+	createdAt: string;
+}
+
+export interface CreateSupervisorAiSessionRequest {
+	title?: string;
+}
+
+export interface SupervisorAiFileContext {
+	name: string;
+	content: string;
+}
+
+export interface SendSupervisorAiMessageRequest {
+	message: string;
+	context?: SupervisorAiContextInput;
+	model?: string;
+	fileContext?: SupervisorAiFileContext[];
+}
+
+export interface SendSupervisorAiMessageResponse {
+	session: SupervisorAiSession;
+	userMessage: SupervisorAiMessage;
+	assistantMessage: SupervisorAiMessage;
+	sources: SupervisorAiSource[];
+	reportPreview: SupervisorAiReportPreview | null;
+}
+
+export interface SupervisorAiSessionDetail {
+	session: SupervisorAiSession;
+	messages: SupervisorAiMessage[];
+}
+
+export interface AiFeatureModels {
+	suggest_response?: string;
+	summarize_chat?: string;
+	analyze_customer?: string;
+	supervisor_chat?: string;
+}
+
+export interface AiTenantConfig {
+	instance: string;
+	model: string;
+	temperature: number;
+	maxTokens: number;
+	enabled: boolean;
+	monthlyBudgetUsd?: number | null;
+	availableModels?: string[] | null;
+	featureModels?: AiFeatureModels | null;
+	operatorBudgets?: Record<string, number> | null;
+}
+
+export interface AiFeatureUsageStat {
+	feature: string;
+	callCount: number;
+	inputTokens: number;
+	outputTokens: number;
+	estimatedCostUsd: number;
+}
+
+export interface AiOperatorUsageStat {
+	operatorId: number;
+	callCount: number;
+	inputTokens: number;
+	outputTokens: number;
+	estimatedCostUsd: number;
+}
+
+export interface AiUsageSummary {
+	period: string;
+	totalInputTokens: number;
+	totalOutputTokens: number;
+	estimatedCostUsd: number;
+	byFeature: AiFeatureUsageStat[];
+	byOperator: AiOperatorUsageStat[];
+}
+
+export interface AiAgentConfig {
+	instance: string;
+	enabled: boolean;
+	model: string;
+	systemPrompt: string;
+	maxMessagesPerChat: number;
+	conditions: unknown;
+}
+
+// ─── AI Agents (full CRUD) ────────────────────────────────────────────────────
+
+export type AiAgentTriggerType = "MESSAGE_DURING_HOURS" | "RESPONSE_TIMEOUT" | "KEYWORD" | "ALWAYS";
+
+export type AiAgentProactiveFrequency = "DAILY" | "WEEKDAYS" | "CUSTOM_DAYS";
+
+export type AiAgentProactiveEntryMessageMode = "AI_TEXT" | "WABA_TEMPLATE";
+
+export type AiAgentActionType =
+	| "REPLY"
+	| "SEND_TEMPLATE"
+	| "SEND_FILE"
+	| "ESCALATE"
+	| "CLOSE_CHAT"
+	| "UPDATE_CRM"
+	| "SCHEDULE"
+	| "IGNORED";
+
+export type AiAgentChatSessionStatus = "ACTIVE" | "PAUSED" | "FINISHED";
+
+export interface AiAgentTrigger {
+	id: number;
+	agentId: number;
+	type: AiAgentTriggerType;
+	config: Record<string, unknown>;
+}
+
+export interface AiAgentAudienceDefinition {
+	id: number;
+	agentId: number;
+	filtersJson: Record<string, unknown>;
+	manualIncludeJson: Record<string, unknown>;
+	manualExcludeJson: Record<string, unknown>;
+}
+
+export interface AiAgentKnowledgeEntry {
+	id: number;
+	agentId: number;
+	title: string;
+	content: string;
+	fileId: number | null;
+	fileName: string | null;
+	fileType: string | null;
+	fileSize: number | null;
+	order: number;
+}
+
+export interface AiAgentProactiveSchedule {
+	frequency: AiAgentProactiveFrequency;
+	timezone: string;
+	startTime: string;
+	daysOfWeek: number[];
+}
+
+export interface AiAgentProactiveConfig {
+	enabled: boolean;
+	schedule: AiAgentProactiveSchedule;
+	batchSize: number;
+	entryMessageMode: AiAgentProactiveEntryMessageMode;
+	skipContactsWithOpenChat: boolean;
+}
+
+export interface AiAgent {
+	id: number;
+	instance: string;
+	name: string;
+	description: string | null;
+	enabled: boolean;
+	systemPrompt: string;
+	model: string;
+	temperature: number;
+	maxTokens: number;
+	maxTurnsPerChat: number;
+	cooldownSeconds: number;
+	allowedActions: AiAgentActionType[];
+	proactiveConfig: AiAgentProactiveConfig | null;
+	templateName: string | null;
+	templateLanguage: string | null;
+	templateVariableMapping: Record<string, string> | null;
+	escalateToWalletId: number | null;
+	escalateToUserId: number | null;
+	escalateToUserIds: number[];
+	createdAt: string;
+	updatedAt: string;
+	triggers: AiAgentTrigger[];
+	audience: AiAgentAudienceDefinition | null;
+	knowledgeEntries: AiAgentKnowledgeEntry[];
+}
+
+export interface AiAgentChatSession {
+	id: number;
+	agentId: number;
+	chatId: number;
+	instance: string;
+	status: AiAgentChatSessionStatus;
+	turnCount: number;
+	startedAt: string;
+	finishedAt: string | null;
+	lastRepliedAt: string | null;
+}
+
+export interface AiAgentActionLog {
+	id: number;
+	agentId: number;
+	sessionId: number | null;
+	chatId: number;
+	instance: string;
+	actionType: AiAgentActionType;
+	success: boolean;
+	errorMessage: string | null;
+	payload: Record<string, unknown> | null;
+	createdAt: string;
+}
+
+export interface AiAgentAudienceFilters {
+	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 AiAgentManualList {
+	contactIds?: number[];
+	phones?: string[];
+	customerIds?: number[];
+}
+
+export interface AiAgentAudienceInput {
+	filters?: AiAgentAudienceFilters;
+	manualInclude?: AiAgentManualList;
+	manualExclude?: AiAgentManualList;
+}
+
+export interface AiAgentTriggerInput {
+	type: AiAgentTriggerType;
+	config?: {
+		timeoutMinutes?: number;
+		keywords?: string[];
+		startTime?: string;
+		endTime?: string;
+		timezone?: string;
+	};
+}
+
+export interface AiAgentKnowledgeEntryInput {
+	title: string;
+	content: string;
+	fileId?: number;
+	fileName?: string;
+	fileType?: string;
+	fileSize?: number;
+	order?: number;
+}
+
+export interface CreateAiAgentInput {
+	name: string;
+	description?: string;
+	enabled?: boolean;
+	systemPrompt: string;
+	model?: string;
+	temperature?: number;
+	maxTokens?: number;
+	maxTurnsPerChat?: number;
+	allowedActions: AiAgentActionType[];
+	proactiveConfig?: AiAgentProactiveConfig | null;
+	templateName?: string;
+	templateLanguage?: string;
+	templateVariableMapping?: Record<string, string>;
+	escalateToWalletId?: number;
+	escalateToUserId?: number;
+	escalateToUserIds?: number[];
+	triggers?: AiAgentTriggerInput[];
+	knowledgeEntries?: AiAgentKnowledgeEntryInput[];
+	audience?: AiAgentAudienceInput;
+}
+
+export type UpdateAiAgentInput = Partial<CreateAiAgentInput>;
+
+export interface AiAgentActionLogFilters {
+	agentId?: number;
+	chatId?: number;
+	actionType?: string;
+	success?: boolean;
+	dateFrom?: Date;
+	dateTo?: Date;
+	page?: number;
+	perPage?: number;
+}
+
+export interface PaginatedActionLogs {
+	data: AiAgentActionLog[];
+	page: { totalRows: number; current: number };
+}
+
+export interface AiAgentAudiencePreview {
+	data: WppContactWithCustomer[];
+	page: { totalRows: number; current: number };
+}

package/src/types/customers.types.ts

@@ -76,3 +76,183 @@ 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/src/types/index.ts

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

package/src/types/response.types.ts

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

package/src/types/socket-events.types.ts

@@ -4,6 +4,7 @@ import {
 	SocketServerInternalChatRoom,
 	SocketServerReportsRoom,
 	SocketServerRoom,
+	SocketServerUserRoom,
 } from "./socket-rooms.types";
 import { MessageResponse } from "./response.types";
 import { WppMessage, WppMessageStatus } from "./whatsapp.types";
@@ -32,6 +33,7 @@ export enum SocketEventType {
 	InternalMessageEdit = "internal_message_edit",
 	InternalMessageDelete = "internal_message_delete",
 	InternalMessageStatus = "internal_message_status",
+	TelephonyCallReceived = "telephony_call_received",
 }
 
 export interface EmitSocketEventFn {
@@ -125,6 +127,11 @@ export interface EmitSocketEventFn {
 		room: SocketServerRoom,
 		data: InternalChatFinishedEventData,
 	): Promise<MessageResponse>;
+	(
+		type: SocketEventType.TelephonyCallReceived,
+		room: SocketServerUserRoom,
+		data: TelephonyCallReceivedEventData,
+	): Promise<MessageResponse>;
 }
 
 export interface ListenSocketEventFn {
@@ -200,6 +207,10 @@ export interface ListenSocketEventFn {
 		type: SocketEventType.WppMessageDelete,
 		callback: (data: WppMessageDeleteEventData) => void,
 	): void;
+	(
+		type: SocketEventType.TelephonyCallReceived,
+		callback: (data: TelephonyCallReceivedEventData) => void,
+	): void;
 }
 
 export interface UnlistenSocketEventFn {
@@ -306,3 +317,14 @@ export type ReportStatusEventData = {
 			progress: number;
 		}
 	);
+
+export interface TelephonyCallReceivedEventData {
+	uniqueid: string;
+	callerNumber: string;
+	callerName: string | null;
+	ramal: string;
+	operatorId: number | null;
+	instance: string;
+	receivedAt: string;
+	receptiveCallId: number | null;
+}