@in.pulse-crm/sdk 1.5.2 → 1.6.0

package/dist/customer.d.ts

@@ -0,0 +1,109 @@
+import { AxiosInstance } from "axios";
+export interface Customer {
+    CODIGO: number;
+    RAZAO: string;
+    FANTASIA: string;
+    PESSOA: 'FIS' | 'JUR' | null;
+    ATIVO: 'SIM' | 'NAO' | null;
+    CPF_CNPJ: string;
+    IE_RG: string;
+    GRUPO: number;
+    END_RUA: string;
+    CIDADE: string;
+    BAIRRO: string;
+    ESTADO: string;
+    CEP: string;
+    COMPLEMENTO: string;
+    AREA1: number;
+    AREA2: number;
+    AREA3: number;
+    AREAFAX: number;
+    FONE1: string;
+    FONE2: string;
+    FONE3: string;
+    FAX: string;
+    DESC_FONE1: string;
+    DESC_FONE2: string;
+    DESC_FONE3: string;
+    DESCFAX: string;
+    EMAIL: string;
+    WEBSITE: string;
+    DATACAD: Date;
+    STATUS_CAD: string;
+    OBS_ADMIN: string;
+    OBS_OPERADOR: string;
+    ORIGEM: number;
+    OPERADOR: number;
+    COD_MIDIA: number;
+    COD_ERP: string;
+    BLOCK_COMPRAS: 'SIM' | 'NAO' | null;
+    COD_UNIDADE: number;
+    SALDO_DISPONIVEL: number;
+    SALDO_LIMITE: number;
+    POTENCIAL: number;
+    DATA_ULT_COMPRA: Date;
+    SEGMENTO: number;
+    ULTI_RESULTADO: Date;
+    DT_AGENDAMENTO: Date;
+    COD_CAMPANHA: number;
+    COD_RESULTADO: number;
+    CONTATO_MAIL: string;
+    ATUALIZADOR: 'CADASTRO' | 'ATUALIZAÇÃO' | null;
+    OPERADOR_LOGIN: string;
+    OBS_FONE1: string;
+    OBS_FONE2: string;
+    OBS_FONE3: string;
+    NR_FUNCIONARIOS: number;
+    EMAIL2: string;
+    OBS_CLIENTES: string;
+    VENCIMENTO_LIMITE_CREDITO: Date;
+    PERIODO_RECOMPRA: number;
+    DT_ULTIMO_ORCAMENTO_VENDA: Date;
+    POSSUI_ORCAMENTO: 'S' | 'N' | null;
+    POSSUI_VENDA: 'S' | 'N' | null;
+    CODIGOPRINCIPAL: number;
+    SETOR: number;
+}
+export type CreateCustomerDTO = Pick<Customer, "RAZAO" | "FANTASIA" | "CPF_CNPJ" | "PESSOA" | "CIDADE" | "ESTADO" | "COD_ERP">;
+export type UpdateCustomerDTO = Partial<CreateCustomerDTO>;
+declare class CustomerSDK {
+    private readonly httpClient;
+    /**
+     * Cria uma instância do SDK de usuários.
+     * @param httpClient - A instância do cliente HTTP a ser usada para fazer requisições à API.
+     */
+    constructor(httpClient: AxiosInstance);
+    /**
+     * Cria um novo cliente.
+     * @param data - Os dados do cliente a serem criados.
+     * @returns Uma Promise que resolve para o cliente criado.
+     */
+    createCustomer(data: CreateCustomerDTO): Promise<any>;
+    /**
+     * Obtém um cliente pelo ID.
+     * @param customerId - O ID do cliente a ser obtido.
+     * @returns Uma Promise que resolve para o cliente obtido.
+     */
+    getCustomerById(customerId: number): Promise<any>;
+    /**
+     * Atualiza um cliente existente.
+     * @param customerId - O ID do cliente a ser atualizado.
+     * @param data - Os dados atualizados do cliente.
+     * @returns Uma Promise que resolve para o cliente atualizado.
+     */
+    updateCustomer(customerId: number, data: UpdateCustomerDTO): Promise<any>;
+    /**
+     * Obtém todos os clientes.
+     *
+     * @param filters - Filtros opcionais para a busca de clientes.
+     * @todo Implementar tipagem para os filtros.
+     * @returns Uma Promise que resolve para uma lista de clientes.
+     */
+    getAllCustomers(filters: Record<string, string>): Promise<any>;
+    /**
+     * Define o token de autenticação para as requisições.
+     * @param token - O token de autenticação a ser definido.
+     */
+    setAuth(token: string): void;
+}
+export default CustomerSDK;

package/dist/customer.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class CustomerSDK {
+    httpClient;
+    /**
+     * Cria uma instância do SDK de usuários.
+     * @param httpClient - A instância do cliente HTTP a ser usada para fazer requisições à API.
+     */
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Cria um novo cliente.
+     * @param data - Os dados do cliente a serem criados.
+     * @returns Uma Promise que resolve para o cliente criado.
+     */
+    async createCustomer(data) {
+        const response = await this.httpClient.post(`/customers`, data);
+        return response.data;
+    }
+    /**
+     * Obtém um cliente pelo ID.
+     * @param customerId - O ID do cliente a ser obtido.
+     * @returns Uma Promise que resolve para o cliente obtido.
+     */
+    async getCustomerById(customerId) {
+        const response = await this.httpClient.get(`/customers/${customerId}`);
+        return response.data;
+    }
+    /**
+     * Atualiza um cliente existente.
+     * @param customerId - O ID do cliente a ser atualizado.
+     * @param data - Os dados atualizados do cliente.
+     * @returns Uma Promise que resolve para o cliente atualizado.
+     */
+    async updateCustomer(customerId, data) {
+        const response = await this.httpClient.patch(`/customers/${customerId}`, data);
+        return response.data;
+    }
+    /**
+     * Obtém todos os clientes.
+     *
+     * @param filters - Filtros opcionais para a busca de clientes.
+     * @todo Implementar tipagem para os filtros.
+     * @returns Uma Promise que resolve para uma lista de clientes.
+     */
+    async getAllCustomers(filters) {
+        let baseUrl = `/customers`;
+        const params = new URLSearchParams(filters);
+        if (params.toString()) {
+            baseUrl += `?${params.toString()}`;
+        }
+        const response = await this.httpClient.get(`/customers`);
+        return response.data;
+    }
+    /**
+     * Define o token de autenticação para as requisições.
+     * @param token - O token de autenticação a ser definido.
+     */
+    setAuth(token) {
+        this.httpClient.defaults.headers.common["Authorization"] = `Bearer ${token}`;
+    }
+}
+exports.default = CustomerSDK;

package/dist/index.d.ts

@@ -2,10 +2,11 @@ import AuthSDK, { LoginData, SessionData } from "./auth";
 import FileSDK, { File, FileDirType } from "./file";
 import InstanceSDK from "./instance";
 import UserSDK, { CreateUserDTO, UpdateUserDTO, User, UserRole } from "./user";
+import CustomerSDK, { Customer, CreateCustomerDTO, UpdateCustomerDTO } from "./customer";
 import { DataResponse, ErrorResponse, PaginatedResponse, QueryResponse } from "./response";
 import ReportSDK, { ChatsReport, ChatsReportFormat, GenerateChatsReportOptions } from "./report";
 import SocketClientSDK from "./socket-client";
 import SocketServerSDK from "./socket-server";
 import { EmitFunction, ChatsReportStatusData, SocketServerAdminRoom, SocketServerMonitorRoom, SocketServerReportsRoom, SocketServerRoom, ChatId, QRCode, SocketEventType } from "./types/socket-server.types";
 import { SocketClientChatRoom, SocketClientAdminRoom, SocketClientMonitorRoom, SocketClientReportsRoom, SocketClientRoom } from "./types/socket-client.types";
-export { AuthSDK, LoginData, SessionData, FileSDK, File, FileDirType, InstanceSDK, UserSDK, CreateUserDTO, UpdateUserDTO, User, UserRole, DataResponse, ErrorResponse, PaginatedResponse, QueryResponse, ReportSDK, ChatsReport, ChatsReportFormat as ChatsReportFileFormat, GenerateChatsReportOptions, SocketClientSDK, SocketClientChatRoom as SocketChatRoom, SocketClientAdminRoom, SocketClientMonitorRoom, SocketClientReportsRoom, SocketClientRoom, SocketServerSDK, EmitFunction, SocketEventType, ChatsReportStatusData, SocketServerAdminRoom, SocketServerMonitorRoom, SocketServerReportsRoom, SocketServerRoom, ChatId, QRCode, };
+export { AuthSDK, LoginData, SessionData, FileSDK, File, FileDirType, InstanceSDK, UserSDK, CreateUserDTO, UpdateUserDTO, User, UserRole, CustomerSDK, Customer, CreateCustomerDTO, UpdateCustomerDTO, DataResponse, ErrorResponse, PaginatedResponse, QueryResponse, ReportSDK, ChatsReport, ChatsReportFormat as ChatsReportFileFormat, GenerateChatsReportOptions, SocketClientSDK, SocketClientChatRoom as SocketChatRoom, SocketClientAdminRoom, SocketClientMonitorRoom, SocketClientReportsRoom, SocketClientRoom, SocketServerSDK, EmitFunction, SocketEventType, ChatsReportStatusData, SocketServerAdminRoom, SocketServerMonitorRoom, SocketServerReportsRoom, SocketServerRoom, ChatId, QRCode, };

package/dist/index.js

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SocketServerSDK = exports.SocketClientSDK = exports.ReportSDK = exports.UserRole = exports.UserSDK = exports.InstanceSDK = exports.FileDirType = exports.FileSDK = exports.AuthSDK = void 0;
+exports.SocketServerSDK = exports.SocketClientSDK = exports.ReportSDK = exports.CustomerSDK = exports.UserRole = exports.UserSDK = exports.InstanceSDK = exports.FileDirType = exports.FileSDK = exports.AuthSDK = void 0;
 const auth_1 = __importDefault(require("./auth"));
 exports.AuthSDK = auth_1.default;
 const file_1 = __importStar(require("./file"));
@@ -47,6 +47,8 @@ exports.InstanceSDK = instance_1.default;
 const user_1 = __importStar(require("./user"));
 exports.UserSDK = user_1.default;
 Object.defineProperty(exports, "UserRole", { enumerable: true, get: function () { return user_1.UserRole; } });
+const customer_1 = __importDefault(require("./customer"));
+exports.CustomerSDK = customer_1.default;
 const report_1 = __importDefault(require("./report"));
 exports.ReportSDK = report_1.default;
 const socket_client_1 = __importDefault(require("./socket-client"));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@in.pulse-crm/sdk",
-	"version": "1.5.2",
+	"version": "1.6.0",
 	"description": "SDKs for abstraction of api consumption of in.pulse-crm application",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",

package/src/customer.ts

@@ -0,0 +1,140 @@
+import { AxiosInstance } from "axios";
+
+export interface Customer {
+    CODIGO: number;
+    RAZAO: string;
+    FANTASIA: string;
+    PESSOA: 'FIS' | 'JUR' | null;
+    ATIVO: 'SIM' | 'NAO' | null;
+    CPF_CNPJ: string;
+    IE_RG: string;
+    GRUPO: number;
+    END_RUA: string;
+    CIDADE: string;
+    BAIRRO: string;
+    ESTADO: string;
+    CEP: string;
+    COMPLEMENTO: string;
+    AREA1: number;
+    AREA2: number;
+    AREA3: number;
+    AREAFAX: number;
+    FONE1: string;
+    FONE2: string;
+    FONE3: string;
+    FAX: string;
+    DESC_FONE1: string;
+    DESC_FONE2: string;
+    DESC_FONE3: string;
+    DESCFAX: string;
+    EMAIL: string;
+    WEBSITE: string;
+    DATACAD: Date;
+    STATUS_CAD: string;
+    OBS_ADMIN: string;
+    OBS_OPERADOR: string;
+    ORIGEM: number;
+    OPERADOR: number;
+    COD_MIDIA: number;
+    COD_ERP: string;
+    BLOCK_COMPRAS: 'SIM' | 'NAO' | null;
+    COD_UNIDADE: number;
+    SALDO_DISPONIVEL: number;
+    SALDO_LIMITE: number;
+    POTENCIAL: number;
+    DATA_ULT_COMPRA: Date;
+    SEGMENTO: number;
+    ULTI_RESULTADO: Date;
+    DT_AGENDAMENTO: Date;
+    COD_CAMPANHA: number;
+    COD_RESULTADO: number;
+    CONTATO_MAIL: string;
+    ATUALIZADOR: 'CADASTRO' | 'ATUALIZAÇÃO' | null;
+    OPERADOR_LOGIN: string;
+    OBS_FONE1: string;
+    OBS_FONE2: string;
+    OBS_FONE3: string;
+    NR_FUNCIONARIOS: number;
+    EMAIL2: string;
+    OBS_CLIENTES: string;
+    VENCIMENTO_LIMITE_CREDITO: Date;
+    PERIODO_RECOMPRA: number;
+    DT_ULTIMO_ORCAMENTO_VENDA: Date;
+    POSSUI_ORCAMENTO: 'S' | 'N' | null;
+    POSSUI_VENDA: 'S' | 'N' | null;
+    CODIGOPRINCIPAL: number;
+    SETOR: number;
+}
+
+export type CreateCustomerDTO = Pick<Customer, "RAZAO" | "FANTASIA" | "CPF_CNPJ" | "PESSOA" | "CIDADE" | "ESTADO" | "COD_ERP">;
+export type UpdateCustomerDTO = Partial<CreateCustomerDTO>;
+
+class CustomerSDK {
+    /**
+     * Cria uma instância do SDK de usuários.
+     * @param httpClient - A instância do cliente HTTP a ser usada para fazer requisições à API.
+     */
+    constructor(private readonly httpClient: AxiosInstance) { }
+
+    /**
+     * Cria um novo cliente.
+     * @param data - Os dados do cliente a serem criados.
+     * @returns Uma Promise que resolve para o cliente criado.
+     */
+    public async createCustomer(data: CreateCustomerDTO) {
+        const response = await this.httpClient.post(`/customers`, data);
+
+        return response.data;
+    }
+
+    /**
+     * Obtém um cliente pelo ID.
+     * @param customerId - O ID do cliente a ser obtido.
+     * @returns Uma Promise que resolve para o cliente obtido.
+     */
+    public async getCustomerById(customerId: number) {
+        const response = await this.httpClient.get(`/customers/${customerId}`);
+        return response.data;
+    }
+
+    /**
+     * Atualiza um cliente existente.
+     * @param customerId - O ID do cliente a ser atualizado.
+     * @param data - Os dados atualizados do cliente.
+     * @returns Uma Promise que resolve para o cliente atualizado.
+     */
+    public async updateCustomer(customerId: number, data: UpdateCustomerDTO) {
+        const response = await this.httpClient.patch(`/customers/${customerId}`, data);
+        return response.data;
+    }
+
+    /**
+     * Obtém todos os clientes.
+     * 
+     * @param filters - Filtros opcionais para a busca de clientes.
+     * @todo Implementar tipagem para os filtros.
+     * @returns Uma Promise que resolve para uma lista de clientes.
+     */
+    public async getAllCustomers(filters: Record<string, string>) {
+        let baseUrl = `/customers`;
+        const params = new URLSearchParams(filters);
+
+        if (params.toString()) {
+            baseUrl += `?${params.toString()}`;
+        }
+
+        const response = await this.httpClient.get(`/customers`);
+
+        return response.data;
+    }
+
+    /**
+     * Define o token de autenticação para as requisições.
+     * @param token - O token de autenticação a ser definido.
+     */
+    public setAuth(token: string) {
+        this.httpClient.defaults.headers.common["Authorization"] = `Bearer ${token}`;
+    }
+}
+
+export default CustomerSDK;

package/src/index.ts

@@ -2,6 +2,7 @@ import AuthSDK, { LoginData, SessionData } from "./auth";
 import FileSDK, { File, FileDirType } from "./file";
 import InstanceSDK from "./instance";
 import UserSDK, { CreateUserDTO, UpdateUserDTO, User, UserRole } from "./user";
+import CustomerSDK, { Customer, CreateCustomerDTO, UpdateCustomerDTO } from "./customer";
 import { DataResponse, ErrorResponse, PaginatedResponse, QueryResponse } from "./response";
 import ReportSDK, { ChatsReport, ChatsReportFormat, GenerateChatsReportOptions } from "./report";
 import SocketClientSDK from "./socket-client";
@@ -46,6 +47,12 @@ export {
     User,
     UserRole,
 
+    // Customer
+    CustomerSDK,
+    Customer,
+    CreateCustomerDTO,
+    UpdateCustomerDTO,
+
     // Response
     DataResponse,
     ErrorResponse,