@in.pulse-crm/sdk 2.11.3 → 2.11.5

package/src/types/whatsapp.types.ts

@@ -1,232 +1,245 @@
-import { Customer } from "./customers.types";
-
-export interface WppContact {
-	id: number;
-	name: string;
-	phone: string;
-	customerId?: number;
-	avatarUrl?: string;
-	instance: string;
-	isBlocked: boolean;
-	isOnlyAdmin: boolean;
-	lastOutOfHoursReplySentAt?: Date | null;
-}
-
-export interface WppContactWithCustomer {
-	id: number;
-	name: string;
-	phone: string;
-	customerId?: number;
-	avatarUrl?: string;
-	instance: string;
-	isBlocked: boolean;
-	isOnlyAdmin: boolean;
-	customer: Customer | null;
-	chatingWith: string | null;
-	lastOutOfHoursReplySentAt?: Date | null;
-}
-
-export interface WppMessage {
-	id: number;
-	instance: string;
-	wwebjsId: string | null;
-	wabaId: string | null;
-	gupshupId: string | null;
-	gupshupRequestId: string | null;
-	from: string;
-	to: string;
-	type: string;
-	quotedId: number | null;
-	chatId: number | null;
-	contactId: number | null;
-	body: string;
-	timestamp: string;
-	status: WppMessageStatus;
-	isForwarded: boolean;
-	isEdited: boolean;
-	fileId: number | null;
-	fileName: string | null;
-	fileType: string | null;
-	fileSize: string | null;
-	wwebjsIdStanza: string | null;
-	sentAt: Date;
-	userId: number | null;
-	billingCategory: string | null;
-}
-export interface ForwardMessagesData {
-	sourceType: "whatsapp" | "internal";
-	messageIds: number[];
-	whatsappTargets?: Array<{ id: string; isGroup: boolean }>;
-	internalTargets?: Array<{ id: number }>;
-}
-
-export interface WppChat {
-	id: number;
-	instance: string;
-	contactId?: number;
-	userId?: number;
-	userName?: string;
-	walletId?: number;
-	botId?: number;
-	resultId?: number;
-	sectorId?: number;
-	type: WppChatType;
-	priority: WppChatPriority;
-	avatarUrl?: string;
-	isFinished: boolean;
-	startedAt: Date;
-	finishedAt?: Date | null;
-	finishedBy?: number | null;
-	isSchedule: boolean;
-}
-
-export interface WppSector {
-	id: number;
-	name: string;
-	instanceName: string;
-	wppInstanceId?: number;
-	startChats: boolean;
-	receiveChats: boolean;
-}
-
-export interface WppWallet {
-	instance: string;
-	id: number;
-	name: string;
-	userIds: number[];
-}
-
-// Enums
-export type WppMessageStatus =
-	| "PENDING"
-	| "SENT"
-	| "RECEIVED"
-	| "READ"
-	| "DOWNLOADED"
-	| "ERROR"
-	| "REVOKED";
-
-export enum WppChatType {
-	RECEPTIVE = "RECEPTIVE",
-	ACTIVE = "ACTIVE",
-}
-
-export enum WppChatPriority {
-	LOW = "LOW",
-	NORMAL = "NORMAL",
-	HIGH = "HIGH",
-	VERY_HIGH = "VERY_HIGH",
-	URGENCY = "URGENCY",
-}
-
-export type WppChatWithDetails = WppChat & {
-	contact: WppContact | null;
-	customer: Customer | null;
-	schedule: WppSchedule | null;
-};
-export type WppChatsAndMessages = {
-	chats: WppChatWithDetails[];
-	messages: WppMessage[];
-};
-export type WppChatWithDetailsAndMessages = WppChatWithDetails & {
-	messages: WppMessage[];
-};
-
-export interface SendMessageData {
-	sendAsChatOwner?: boolean;
-	sendAsAudio?: boolean;
-	sendAsDocument?: boolean;
-	contactId: number;
-	quotedId?: number | null;
-	chatId?: number | null;
-	text?: string | null;
-	file?: File;
-	fileId?: number;
-}
-export interface MonitorChat {
-	id: string;
-	erpCode: string;
-	companyName: string;
-	contactName: string;
-	whatsappNumber: string;
-	sectorName: string;
-	attendantName: string;
-	startDate: string;
-	endDate: string;
-	result: string;
-}
-
-export interface CreateScheduleDTO {
-	contactId: number;
-	date: Date;
-	scheduledFor: number;
-	sectorId: number;
-}
-
-export interface WppSchedule {
-	id: number;
-	instance: string;
-	sectorId: number;
-	description: string | null;
-	contactId: number;
-	scheduleDate: string;
-	scheduledBy: number;
-	scheduledFor: number;
-	scheduledAt: string;
-	chatId: number | null;
-	contact: WppContact;
-}
-export type NotificationType =
-	| "CHAT_AUTO_FINISHED"
-	| "CHAT_TRANSFERRED"
-	| "CHAT_REASSIGNED"
-	| "ALERT"
-	| "INFO"
-	| "WARNING"
-	| "ERROR";
-
-export interface AppNotification {
-	id: number;
-	title: string;
-	description: string;
-	read: boolean;
-	instance: string;
-	userId: number | null;
-	chatId: number | null;
-	type: NotificationType;
-	createdAt: string;
-}
-
-export interface PaginatedNotificationsResponse {
-	notifications: AppNotification[];
-	totalCount: number;
-}
-export interface AutomaticResponseSchedule {
-	id?: number;
-	dayOfWeek: number;
-	startTime: string;
-	endTime: string;
-}
-
-export interface AutomaticResponseRule {
-	id: number;
-	name: string;
-	message: string;
-	isEnabled: boolean;
-	isGlobal: boolean;
-	cooldownSeconds: number;
-	fileId: number | null;
-	schedules: AutomaticResponseSchedule[];
-	userAssignments: { userId: number }[];
-}
-
-export interface AutomaticResponseRuleDTO {
-	name: string;
-	message: string;
-	isEnabled: boolean;
-	isGlobal: boolean;
-	cooldownSeconds: number;
-	fileId?: number | null;
-	userIds: number[];
-	schedules: Omit<AutomaticResponseSchedule, "id">[];
-}
+import { Customer } from "./customers.types";
+
+export interface WppContact {
+	id: number;
+	name: string;
+	phone: string;
+	customerId?: number;
+	avatarUrl?: string;
+	instance: string;
+	isBlocked: boolean;
+	isOnlyAdmin: boolean;
+	lastOutOfHoursReplySentAt?: Date | null;
+}
+
+export interface WppContactWithCustomer {
+	id: number;
+	name: string;
+	phone: string;
+	customerId?: number;
+	avatarUrl?: string;
+	instance: string;
+	isBlocked: boolean;
+	isOnlyAdmin: boolean;
+	customer: Customer | null;
+	chatingWith: string | null;
+	lastOutOfHoursReplySentAt?: Date | null;
+}
+
+export interface WppMessage {
+	id: number;
+	instance: string;
+	wwebjsId: string | null;
+	wabaId: string | null;
+	gupshupId: string | null;
+	gupshupRequestId: string | null;
+	from: string;
+	to: string;
+	type: string;
+	quotedId: number | null;
+	chatId: number | null;
+	contactId: number | null;
+	body: string;
+	timestamp: string;
+	status: WppMessageStatus;
+	isForwarded: boolean;
+	isEdited: boolean;
+	fileId: number | null;
+	fileName: string | null;
+	fileType: string | null;
+	fileSize: string | null;
+	wwebjsIdStanza: string | null;
+	sentAt: Date;
+	userId: number | null;
+	billingCategory: string | null;
+}
+export interface ForwardMessagesData {
+	sourceType: "whatsapp" | "internal";
+	messageIds: number[];
+	whatsappTargets?: Array<{ id: string; isGroup: boolean }>;
+	internalTargets?: Array<{ id: number }>;
+}
+
+export interface WppChat {
+	id: number;
+	instance: string;
+	contactId?: number;
+	userId?: number;
+	userName?: string;
+	walletId?: number;
+	botId?: number;
+	resultId?: number;
+	sectorId?: number;
+	type: WppChatType;
+	priority: WppChatPriority;
+	avatarUrl?: string;
+	isFinished: boolean;
+	startedAt: Date;
+	finishedAt?: Date | null;
+	finishedBy?: number | null;
+	isSchedule: boolean;
+}
+
+export interface WppSector {
+	id: number;
+	name: string;
+	instanceName: string;
+	wppInstanceId?: number;
+	startChats: boolean;
+	receiveChats: boolean;
+}
+
+export interface WppWallet {
+	instance: string;
+	id: number;
+	name: string;
+	userIds: number[];
+}
+
+// Enums
+export type WppMessageStatus =
+	| "PENDING"
+	| "SENT"
+	| "RECEIVED"
+	| "READ"
+	| "DOWNLOADED"
+	| "ERROR"
+	| "REVOKED";
+
+export enum WppChatType {
+	RECEPTIVE = "RECEPTIVE",
+	ACTIVE = "ACTIVE",
+}
+
+export enum WppChatPriority {
+	LOW = "LOW",
+	NORMAL = "NORMAL",
+	HIGH = "HIGH",
+	VERY_HIGH = "VERY_HIGH",
+	URGENCY = "URGENCY",
+}
+
+export type WppChatWithDetails = WppChat & {
+	contact: WppContact | null;
+	customer: Customer | null;
+	schedule: WppSchedule | null;
+};
+export type WppChatsAndMessages = {
+	chats: WppChatWithDetails[];
+	messages: WppMessage[];
+};
+export type WppChatWithDetailsAndMessages = WppChatWithDetails & {
+	messages: WppMessage[];
+};
+
+export interface SendMessageData {
+	sendAsChatOwner?: boolean;
+	sendAsAudio?: boolean;
+	sendAsDocument?: boolean;
+	contactId: number;
+	quotedId?: number | null;
+	chatId?: number | null;
+	text?: string | null;
+	file?: File;
+	fileId?: number;
+}
+export interface MonitorChat {
+	id: string;
+	erpCode: string;
+	companyName: string;
+	contactName: string;
+	whatsappNumber: string;
+	sectorName: string;
+	attendantName: string;
+	startDate: string;
+	endDate: string;
+	result: string;
+}
+
+export interface CreateScheduleDTO {
+	contactId: number;
+	date: Date;
+	scheduledFor: number;
+	sectorId: number;
+}
+
+export interface WppSchedule {
+	id: number;
+	instance: string;
+	sectorId: number;
+	description: string | null;
+	contactId: number;
+	scheduleDate: string;
+	scheduledBy: number;
+	scheduledFor: number;
+	scheduledAt: string;
+	chatId: number | null;
+	contact: WppContact;
+}
+export type NotificationType =
+	| "CHAT_AUTO_FINISHED"
+	| "CHAT_TRANSFERRED"
+	| "CHAT_REASSIGNED"
+	| "ALERT"
+	| "INFO"
+	| "WARNING"
+	| "ERROR";
+
+export interface AppNotification {
+	id: number;
+	title: string;
+	description: string;
+	read: boolean;
+	instance: string;
+	userId: number | null;
+	chatId: number | null;
+	type: NotificationType;
+	createdAt: string;
+}
+
+export interface PaginatedNotificationsResponse {
+	notifications: AppNotification[];
+	totalCount: number;
+}
+export type Frequency = 'ONCE' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY';
+
+export interface AutomaticResponseSchedule {
+  id?: number;
+
+  frequency: Frequency;          
+  daysOfWeek?: number[] | null;  
+  dayOfMonth?: number | null;    
+  month?: number | null;         
+
+  startDate?: string | null;     
+  endDate?: string | null;      
+
+  startTime: string;            
+  endTime: string;               
+  timezone?: string | null;      
+
+  dayOfWeek?: number | null;    
+}
+
+export interface AutomaticResponseRule {
+  id: number;
+  name: string;
+  message: string;
+  isEnabled: boolean;
+  isGlobal: boolean;
+  cooldownSeconds: number;
+  fileId: number | null;
+  schedules: AutomaticResponseSchedule[];
+  userAssignments: { userId: number }[];
+}
+
+export interface AutomaticResponseRuleDTO {
+  name: string;
+  message: string;
+  isEnabled: boolean;
+  isGlobal: boolean;
+  cooldownSeconds: number;
+  fileId?: number | null;
+  userIds: number[]; 
+  schedules: Omit<AutomaticResponseSchedule, "id">[];
+}

package/src/users.client.ts

@@ -1,88 +1,88 @@
-import { DataResponse, PaginatedResponse } from "./types/response.types";
-import { CreateUserDTO, UpdateUserDTO, User } from "./types/user.types";
-import ApiClient from "./api-client";
-import { RequestFilters } from "./types";
-
-/**
- * SDK para operações de usuários.
- */
-export default class UsersClient extends ApiClient {
-	/**
-	 * Obtém a lista de usuários.
-	 * @param filters - Filtros opcionais para a query.
-	 * @returns Uma resposta paginada contendo os usuários.
-	 */
-	public async getUsers(filters?: RequestFilters<User>) {
-		let baseUrl = `/api/users`;
-
-		if (filters) {
-			const params = new URLSearchParams(filters);
-			baseUrl += `?${params.toString()}`;
-		}
-
-		const response =
-			await this.ax.get<PaginatedResponse<User>>(baseUrl);
-
-		return response.data;
-	}
-
-	/**
-	 * Obtém um usuário pelo ID.
-	 * @param userId - O ID do usuário.
-	 * @returns Uma resposta contendo os dados do usuário.
-	 */
-	public async getUserById(userId: number) {
-		const { data: res } = await this.ax.get<DataResponse<User>>(
-			`/api/users/${userId}`,
-		);
-
-		return res.data;
-	}
-
-	/**
-	 * Cria um novo usuário.
-	 * @param data - Os dados para criação do usuário.
-	 * @returns Uma resposta contendo os dados do usuário criado.
-	 * @throws Um erro se a criação do usuário falhar.
-	 */
-	public async createUser(data: CreateUserDTO) {
-		try {
-			const { data: res } = await this.ax.post<
-				DataResponse<User>
-			>(`/api/users`, data);
-
-			return res.data;
-		} catch (error) {
-			throw new Error("Failed to create user", { cause: error });
-		}
-	}
-
-	/**
-	 * Atualiza um usuário existente.
-	 * @param userId - O ID do usuário.
-	 * @param data - Os dados para atualização do usuário.
-	 * @returns Uma resposta contendo os dados do usuário atualizado.
-	 * @throws Um erro se a atualização do usuário falhar.
-	 */
-	public async updateUser(userId: string, data: UpdateUserDTO) {
-		try {
-			const { data: res } = await this.ax.patch<
-				DataResponse<User>
-			>(`/api/users/${userId}`, data);
-
-			return res.data;
-		} catch (error) {
-			throw new Error("Failed to update user", { cause: error });
-		}
-	}
-
-	/**
-	 * Sets the authorization token for HTTP requests.
-	 *
-	 * @param token - The authentication token to be used in the `Authorization` header.
-	 */
-	public setAuth(token: string) {
-		this.ax.defaults.headers.common["Authorization"] =
-			`Bearer ${token}`;
-	}
-}
+import { DataResponse, PaginatedResponse } from "./types/response.types";
+import { CreateUserDTO, UpdateUserDTO, User } from "./types/user.types";
+import ApiClient from "./api-client";
+import { RequestFilters } from "./types";
+
+/**
+ * SDK para operações de usuários.
+ */
+export default class UsersClient extends ApiClient {
+	/**
+	 * Obtém a lista de usuários.
+	 * @param filters - Filtros opcionais para a query.
+	 * @returns Uma resposta paginada contendo os usuários.
+	 */
+	public async getUsers(filters?: RequestFilters<User>) {
+		let baseUrl = `/api/users`;
+
+		if (filters) {
+			const params = new URLSearchParams(filters);
+			baseUrl += `?${params.toString()}`;
+		}
+
+		const response =
+			await this.ax.get<PaginatedResponse<User>>(baseUrl);
+
+		return response.data;
+	}
+
+	/**
+	 * Obtém um usuário pelo ID.
+	 * @param userId - O ID do usuário.
+	 * @returns Uma resposta contendo os dados do usuário.
+	 */
+	public async getUserById(userId: number) {
+		const { data: res } = await this.ax.get<DataResponse<User>>(
+			`/api/users/${userId}`,
+		);
+
+		return res.data;
+	}
+
+	/**
+	 * Cria um novo usuário.
+	 * @param data - Os dados para criação do usuário.
+	 * @returns Uma resposta contendo os dados do usuário criado.
+	 * @throws Um erro se a criação do usuário falhar.
+	 */
+	public async createUser(data: CreateUserDTO) {
+		try {
+			const { data: res } = await this.ax.post<
+				DataResponse<User>
+			>(`/api/users`, data);
+
+			return res.data;
+		} catch (error) {
+			throw new Error("Failed to create user", { cause: error });
+		}
+	}
+
+	/**
+	 * Atualiza um usuário existente.
+	 * @param userId - O ID do usuário.
+	 * @param data - Os dados para atualização do usuário.
+	 * @returns Uma resposta contendo os dados do usuário atualizado.
+	 * @throws Um erro se a atualização do usuário falhar.
+	 */
+	public async updateUser(userId: string, data: UpdateUserDTO) {
+		try {
+			const { data: res } = await this.ax.patch<
+				DataResponse<User>
+			>(`/api/users/${userId}`, data);
+
+			return res.data;
+		} catch (error) {
+			throw new Error("Failed to update user", { cause: error });
+		}
+	}
+
+	/**
+	 * Sets the authorization token for HTTP requests.
+	 *
+	 * @param token - The authentication token to be used in the `Authorization` header.
+	 */
+	public setAuth(token: string) {
+		this.ax.defaults.headers.common["Authorization"] =
+			`Bearer ${token}`;
+	}
+}