ixc-orm 1.5.0 → 1.6.0

package/README.md

@@ -62,11 +62,11 @@ Você não precisará se preocupar em criar uma classe `Boleto` que herde da cla
 nem encadear chamadas `where`. Basta seguir o exemplo abaixo:
 
 ```typescript
-import { RecursoIXC } from 'ixc-orm';
+import { Recurso } from 'ixc-orm';
 
-const id_fatura = 45852;
+const id_contrato = 45852;
 
-const response = await RecursoIXC('get_boleto', { id_fatura })
+const response = await Recurso.desbloqueioDeConfianca(id_contrato);
 ```
 
 > Dos recursos disponibilizados pela API do **IXC Provedor**, esta biblioteca já implementou os seguintes recursos:\

package/dist/index.d.ts

@@ -1,4 +1,9 @@
 import IXCClient from './IXCClient';
-import RecursoIXC from './recursos';
+import RecursoIXC, { Recurso } from './recursos';
 import { IXCOperator, IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods, IXCResponse, IXCSortOrder } from './types';
-export { IXCClient, IXCOperator, IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods, IXCResponse, IXCSortOrder, RecursoIXC };
+export { IXCClient, IXCOperator, IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods, IXCResponse, IXCSortOrder, Recurso, 
+/**
+ * @property RecursoIXC
+ * @deprecated Acesse os recursos através da constante {@link Recurso}
+ */
+RecursoIXC, };

package/dist/index.js

@@ -1,15 +1,49 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RecursoIXC = exports.IXCSortOrder = exports.IXCRequestMethods = exports.IXCOperator = exports.IXCClient = void 0;
+exports.RecursoIXC = exports.Recurso = exports.IXCSortOrder = exports.IXCRequestMethods = exports.IXCOperator = exports.IXCClient = void 0;
 const path_1 = __importDefault(require("path"));
 const dotenv_1 = __importDefault(require("dotenv"));
 const IXCClient_1 = __importDefault(require("./IXCClient"));
 exports.IXCClient = IXCClient_1.default;
-const recursos_1 = __importDefault(require("./recursos"));
+const recursos_1 = __importStar(require("./recursos"));
 exports.RecursoIXC = recursos_1.default;
+Object.defineProperty(exports, "Recurso", { enumerable: true, get: function () { return recursos_1.Recurso; } });
 const types_1 = require("./types");
 Object.defineProperty(exports, "IXCOperator", { enumerable: true, get: function () { return types_1.IXCOperator; } });
 Object.defineProperty(exports, "IXCRequestMethods", { enumerable: true, get: function () { return types_1.IXCRequestMethods; } });

package/dist/recursos/index.d.ts

@@ -1,19 +1,54 @@
-import cliente_contrato from './cliente_contrato_btn_lib_temp_24722';
+import cliente_contrato_btn_lib_temp_24722 from './cliente_contrato_btn_lib_temp_24722';
 import desbloqueio_confianca from './desbloqueio_confianca';
 import get_boleto from './get_boleto';
+/**
+ * @deprecated Acesse os recursos através da constante {@link Recurso}
+ */
 declare const recursos: {
-    cliente_contrato: typeof cliente_contrato;
+    cliente_contrato: typeof cliente_contrato_btn_lib_temp_24722;
     desbloqueio_confianca: typeof desbloqueio_confianca;
     get_boleto: typeof get_boleto;
 };
 type Recursos = typeof recursos;
 /**
- * Uma função que simplifica a execução de recursos específicos da API do IXC\
- * Para encontrar todos os recursos, acesse: {@link https://wikiapiprovedor.ixcsoft.com.br/}
- *
- * @param recurso O nome do recurso a ser executado
- * @param args Os argumentos que devem ser passado para o manipulador do recurso
- * @returns Promise<IXCResponse | IXCRecursoResponse>
+ * Disponibiliza, de forma simples e direta, o acesso a todos os recursos da API do IXC\
+ * **ATENÇÃO** --- Nem todos os recursos da API do IXC foram implementados por esta biblioteca
+ */
+export declare const Recurso: {
+    /**
+     * Solicita ao IXC que desbloqueie o contrato de um cliente bloqueado, que já solicitou
+     * a liberação temporária dentro de um período de 30 dias. Este recurso só funciona, caso
+     * a opção de desbloqueio de confiança esteja ativada, no contrato do cliente, dentro do IXC.
+     *
+     * @description Corresponde ao recurso `desbloqueio_confianca`
+     *
+     * @param id_contrato O ID do contrato do cliente que deverá ser desbloqueado
+     * @returns Um objeto **IXCResponse** contendo a resposta enviada pelo IXC
+     */
+    desbloqueioDeConfianca: typeof desbloqueio_confianca;
+    /**
+     * Obtém um arquivo PDF codificado em base64 do boleto de uma determinada fatura.
+     *
+     * @description Corresponde ao recurso `get_boleto`
+     *
+     * @param id_fatura O ID da fatura
+     * @returns Um **IXCResponse**, caso a requisição falhe, ou um **IXCRecursoResponse**
+     * contendo o conteúdo do boleto, caso a requisição seja bem-sucedida
+     */
+    getArquivoBoleto: typeof get_boleto;
+    /**
+     * Solicita ao IXC que libere, por 72 horas, o contrato de um cliente bloqueado, que não tenha
+     * solicitado outra liberação temporária dentro de um período de 30 dias
+     *
+     * @description Corresponde ao recurso `cliente_contrato_btn_lib_temp_24722`
+     *
+     * @param id_contrato O ID do contrato do cliente que deverá ser liberado
+     * @returns Um objeto **IXCResponse** contendo a resposta enviada pelo IXC
+     */
+    liberacaoTemporaria: typeof cliente_contrato_btn_lib_temp_24722;
+};
+/**
+ * @deprecated Acesse os recursos através da constante {@link Recurso}
  */
 export default function RecursoIXC<T extends keyof Recursos>(recurso: T, args: Parameters<Recursos[T]>[0]): Promise<import("..").IXCResponse | import("../types").IXCRecursoResponse>;
 export {};

package/dist/recursos/index.js

@@ -12,25 +12,62 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Recurso = void 0;
 exports.default = RecursoIXC;
 const cliente_contrato_btn_lib_temp_24722_1 = __importDefault(require("./cliente_contrato_btn_lib_temp_24722"));
 const desbloqueio_confianca_1 = __importDefault(require("./desbloqueio_confianca"));
 const get_boleto_1 = __importDefault(require("./get_boleto"));
+/**
+ * @deprecated Acesse os recursos através da constante {@link Recurso}
+ */
 const recursos = {
     cliente_contrato: cliente_contrato_btn_lib_temp_24722_1.default,
     desbloqueio_confianca: desbloqueio_confianca_1.default,
     get_boleto: get_boleto_1.default
 };
 /**
- * Uma função que simplifica a execução de recursos específicos da API do IXC\
- * Para encontrar todos os recursos, acesse: {@link https://wikiapiprovedor.ixcsoft.com.br/}
- *
- * @param recurso O nome do recurso a ser executado
- * @param args Os argumentos que devem ser passado para o manipulador do recurso
- * @returns Promise<IXCResponse | IXCRecursoResponse>
+ * Disponibiliza, de forma simples e direta, o acesso a todos os recursos da API do IXC\
+ * **ATENÇÃO** --- Nem todos os recursos da API do IXC foram implementados por esta biblioteca
+ */
+exports.Recurso = {
+    /**
+     * Solicita ao IXC que desbloqueie o contrato de um cliente bloqueado, que já solicitou
+     * a liberação temporária dentro de um período de 30 dias. Este recurso só funciona, caso
+     * a opção de desbloqueio de confiança esteja ativada, no contrato do cliente, dentro do IXC.
+     *
+     * @description Corresponde ao recurso `desbloqueio_confianca`
+     *
+     * @param id_contrato O ID do contrato do cliente que deverá ser desbloqueado
+     * @returns Um objeto **IXCResponse** contendo a resposta enviada pelo IXC
+     */
+    desbloqueioDeConfianca: desbloqueio_confianca_1.default,
+    /**
+     * Obtém um arquivo PDF codificado em base64 do boleto de uma determinada fatura.
+     *
+     * @description Corresponde ao recurso `get_boleto`
+     *
+     * @param id_fatura O ID da fatura
+     * @returns Um **IXCResponse**, caso a requisição falhe, ou um **IXCRecursoResponse**
+     * contendo o conteúdo do boleto, caso a requisição seja bem-sucedida
+     */
+    getArquivoBoleto: get_boleto_1.default,
+    /**
+     * Solicita ao IXC que libere, por 72 horas, o contrato de um cliente bloqueado, que não tenha
+     * solicitado outra liberação temporária dentro de um período de 30 dias
+     *
+     * @description Corresponde ao recurso `cliente_contrato_btn_lib_temp_24722`
+     *
+     * @param id_contrato O ID do contrato do cliente que deverá ser liberado
+     * @returns Um objeto **IXCResponse** contendo a resposta enviada pelo IXC
+     */
+    liberacaoTemporaria: cliente_contrato_btn_lib_temp_24722_1.default,
+};
+/**
+ * @deprecated Acesse os recursos através da constante {@link Recurso}
  */
 function RecursoIXC(recurso, args) {
     return __awaiter(this, void 0, void 0, function* () {
+        console.warn('Esta função será removida na próxima versão! Acesse os recursos através da constante "Recurso".');
         const handler = recursos[recurso];
         return yield handler(args);
     });

package/dist/recursos/recurso.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = recurso;
 const request_1 = require("../request");
@@ -19,14 +30,13 @@ function recurso(_a) {
             const response = yield axios.get(src, { data });
             if (response.status === 200) {
                 const { data } = response;
-                if ((data === null || data === void 0 ? void 0 : data.type) === 'success' || (data === null || data === void 0 ? void 0 : data.tipo) === 'sucesso') {
-                    return (0, response_1.createResponse)({
-                        message: data.message || data.mensagem,
-                    });
+                const { message, mensagem } = data, rest = __rest(data, ["message", "mensagem"]);
+                if (rest.type === 'success' || rest.tipo === 'sucesso') {
+                    return (0, response_1.createResponse)(Object.assign(Object.assign({}, rest), { message: message || mensagem }));
                 }
                 return (0, response_1.createResponse)({
                     error: true,
-                    message: data.message || data.mensagem
+                    message: message || mensagem
                 });
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ixc-orm",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -28,11 +28,11 @@
     "url": "https://github.com/SousaFelipe/ixc-orm/issues"
   },
   "dependencies": {
-    "axios": "^1.11.0",
-    "dotenv": "^17.2.1"
+    "axios": "^1.12.2",
+    "dotenv": "^17.2.2"
   },
   "devDependencies": {
-    "@types/node": "^24.3.0",
+    "@types/node": "^24.5.2",
     "nodemon": "^3.1.10",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.2"