@in.pulse-crm/sdk 2.0.7 → 2.0.9

package/.prettierrc

@@ -1,4 +1,4 @@
-{
-	"tabWidth": 4,
-	"useTabs": true
-}
+{
+	"tabWidth": 4,
+	"useTabs": true
+}

package/dist/customers.client.d.ts

@@ -1,5 +1,6 @@
 import ApiClient from "./api-client";
-import { CreateCustomerDTO, UpdateCustomerDTO } from "./types/customers.types";
+import { RequestFilters } from "./types";
+import { CreateCustomerDTO, Customer, UpdateCustomerDTO } from "./types/customers.types";
 declare class CustomersClient extends ApiClient {
     /**
      * Cria um novo cliente.
@@ -27,7 +28,7 @@ declare class CustomersClient extends ApiClient {
      * @todo Implementar tipagem para os filtros.
      * @returns Uma Promise que resolve para uma lista de clientes.
      */
-    getAllCustomers(filters: Record<string, string>): Promise<any>;
+    getCustomers(filters?: RequestFilters<Customer>): Promise<any>;
     /**
      * Define o token de autenticação para as requisições.
      * @param token - O token de autenticação a ser definido.

package/dist/customers.client.js

@@ -40,7 +40,7 @@ class CustomersClient extends api_client_1.default {
      * @todo Implementar tipagem para os filtros.
      * @returns Uma Promise que resolve para uma lista de clientes.
      */
-    async getAllCustomers(filters) {
+    async getCustomers(filters) {
         let baseUrl = `/api/customers`;
         const params = new URLSearchParams(filters);
         if (params.toString()) {
@@ -54,7 +54,8 @@ class CustomersClient extends api_client_1.default {
      * @param token - O token de autenticação a ser definido.
      */
     setAuth(token) {
-        this.httpClient.defaults.headers.common["Authorization"] = `Bearer ${token}`;
+        this.httpClient.defaults.headers.common["Authorization"] =
+            `Bearer ${token}`;
     }
 }
 exports.default = CustomersClient;

package/dist/files.client.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import ApiClient from "./api-client";
 import { File, UploadFileOptions } from "./types/files.types";
 declare class FilesClient extends ApiClient {

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

@@ -2,8 +2,8 @@ export interface Customer {
     CODIGO: number;
     RAZAO: string;
     FANTASIA: string;
-    PESSOA: 'FIS' | 'JUR' | null;
-    ATIVO: 'SIM' | 'NAO' | null;
+    PESSOA: "FIS" | "JUR" | null;
+    ATIVO: "SIM" | "NAO" | null;
     CPF_CNPJ: string;
     IE_RG: string;
     GRUPO: number;
@@ -35,7 +35,7 @@ export interface Customer {
     OPERADOR: number;
     COD_MIDIA: number;
     COD_ERP: string;
-    BLOCK_COMPRAS: 'SIM' | 'NAO' | null;
+    BLOCK_COMPRAS: "SIM" | "NAO" | null;
     COD_UNIDADE: number;
     SALDO_DISPONIVEL: number;
     SALDO_LIMITE: number;
@@ -47,7 +47,7 @@ export interface Customer {
     COD_CAMPANHA: number;
     COD_RESULTADO: number;
     CONTATO_MAIL: string;
-    ATUALIZADOR: 'CADASTRO' | 'ATUALIZAÇÃO' | null;
+    ATUALIZADOR: "CADASTRO" | "ATUALIZAÇÃO" | null;
     OPERADOR_LOGIN: string;
     OBS_FONE1: string;
     OBS_FONE2: string;
@@ -58,8 +58,8 @@ export interface Customer {
     VENCIMENTO_LIMITE_CREDITO: Date;
     PERIODO_RECOMPRA: number;
     DT_ULTIMO_ORCAMENTO_VENDA: Date;
-    POSSUI_ORCAMENTO: 'S' | 'N' | null;
-    POSSUI_VENDA: 'S' | 'N' | null;
+    POSSUI_ORCAMENTO: "S" | "N" | null;
+    POSSUI_VENDA: "S" | "N" | null;
     CODIGOPRINCIPAL: number;
     SETOR: number;
 }

package/dist/types/files.types.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 export interface UploadFileOptions {
     /**
      * Nome da instância onde o arquivo está armazenado.

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ export * from "./auth.types";
 export * from "./customers.types";
 export * from "./files.types";
 export * from "./reports.types";
+export * from "./request.types";
 export * from "./response.types";
 export * from "./socket-events.types";
 export * from "./socket-rooms.types";

package/dist/types/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./auth.types"), exports);
 __exportStar(require("./customers.types"), exports);
 __exportStar(require("./files.types"), exports);
 __exportStar(require("./reports.types"), exports);
+__exportStar(require("./request.types"), exports);
 __exportStar(require("./response.types"), exports);
 __exportStar(require("./socket-events.types"), exports);
 __exportStar(require("./socket-rooms.types"), exports);

package/dist/types/request.types.d.ts

@@ -0,0 +1,5 @@
+export type RequestFilters<T> = {
+    page?: string;
+    perPage?: string;
+    sortBy?: keyof T;
+} & Partial<Record<keyof T, string>>;

package/dist/types/request.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

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

package/src/customers.client.ts

@@ -1,66 +1,77 @@
 import ApiClient from "./api-client";
-import { CreateCustomerDTO, UpdateCustomerDTO } from "./types/customers.types";
+import { RequestFilters } from "./types";
+import {
+	CreateCustomerDTO,
+	Customer,
+	UpdateCustomerDTO,
+} from "./types/customers.types";
 
 class CustomersClient extends ApiClient {
-    /**
-     * 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(`/api/customers`, data);
+	/**
+	 * 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(`/api/customers`, data);
 
-        return response.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(`/api/customers/${customerId}`);
-        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(
+			`/api/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(`/api/customers/${customerId}`, data);
-        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(
+			`/api/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 = `/api/customers`;
-        const params = new URLSearchParams(filters);
+	/**
+	 * 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 getCustomers(filters?: RequestFilters<Customer>) {
+		let baseUrl = `/api/customers`;
+		const params = new URLSearchParams(filters);
 
-        if (params.toString()) {
-            baseUrl += `?${params.toString()}`;
-        }
+		if (params.toString()) {
+			baseUrl += `?${params.toString()}`;
+		}
 
-        const response = await this.httpClient.get(`/api/customers`);
+		const response = await this.httpClient.get(`/api/customers`);
 
-        return response.data;
-    }
+		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}`;
-    }
+	/**
+	 * 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 CustomersClient;
+export default CustomersClient;

package/src/types/customers.types.ts

@@ -1,68 +1,77 @@
 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;
+	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>;
+export type CreateCustomerDTO = Pick<
+	Customer,
+	| "RAZAO"
+	| "FANTASIA"
+	| "CPF_CNPJ"
+	| "PESSOA"
+	| "CIDADE"
+	| "ESTADO"
+	| "COD_ERP"
+>;
+export type UpdateCustomerDTO = Partial<CreateCustomerDTO>;

package/src/types/index.ts

@@ -2,8 +2,8 @@ export * from "./auth.types";
 export * from "./customers.types";
 export * from "./files.types";
 export * from "./reports.types";
+export * from "./request.types";
 export * from "./response.types";
 export * from "./socket-events.types";
 export * from "./socket-rooms.types";
 export * from "./user.types";
-

package/src/types/request.types.ts

@@ -0,0 +1,5 @@
+export type RequestFilters<T> = {
+	page?: string;
+	perPage?: string;
+	sortBy?: keyof T;
+} & Partial<Record<keyof T, string>>;

package/tsconfig.json

@@ -1,17 +1,17 @@
-{
-	"compilerOptions": {
-		"target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
-		"module": "commonjs" /* Specify what module code is generated. */,
-		"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
-		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-		"strict": true /* Enable all strict type-checking options. */,
-		"skipLibCheck": true /* Skip type checking all .d.ts files. */,
-		"noUnusedLocals": false,
-		"outDir": "./dist", /* Redirect output structure to the directory. */
-		"declaration": true
-	},
-	"include": [
-		"src/index.ts",
-		"src/**/*.{ts}"
-	]
+{
+	"compilerOptions": {
+		"target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+		"module": "commonjs" /* Specify what module code is generated. */,
+		"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+		"strict": true /* Enable all strict type-checking options. */,
+		"skipLibCheck": true /* Skip type checking all .d.ts files. */,
+		"noUnusedLocals": false,
+		"outDir": "./dist", /* Redirect output structure to the directory. */
+		"declaration": true
+	},
+	"include": [
+		"src/index.ts",
+		"src/**/*.{ts}"
+	]
 }