ixc-orm 1.10.3 → 1.10.5

package/CHANGELOG.md

@@ -1,5 +1,6 @@
 # 🔄 CHANGELOG
-- [v1.10.2 - 20 de novembro de 2025](#v1102)
+- [v1.10.5 - 20 de dezembro de 2025](#v1105)
+- [v1.10.4 - 20 de novembro de 2025](#v1104)
 - [v1.9.0 - 09 de outubro de 2025](#v190)
 - [v1.8.0 - 18 de outubro de 2025](#v180)
 - [v1.7.1 - 18 de outubro de 2025](#v171)
@@ -10,13 +11,18 @@
 - [v1.4.3 - 15 de agosto de 2025](#v143)
 - [v1.4.1 - 14 de agosto de 2025](#v141)
 
+
 ## 🚀 Novidades
 
-### v1.10.2
-* **Melhoria:** O recurso `Recurso.getArquivoBoleto()`, que obtém um arquivo PDF de um boleto, passou a utilizar o 'RequestEmitter' da API para executar a requisição. A resposta desse recurso será uma Promise contendo a instância de um objeto do tipo `IxcResponse`.
+
+### v1.10.5
+* **Correção:** Removida a utilização da biblioteca nativa DOMParser, que quebrava ao tentar extrair a mensagem de erro de uma resposta do IXC Provedor.
+
+### v1.10.4
+* **Melhoria:** O recurso `Recurso.getArquivoBoleto()`, que obtém um arquivo PDF de um boleto, passou a utilizar o 'RequestEmitter' da API para executar a requisição. A resposta desse recurso será uma Promise contendo a instância de um objeto do tipo <a href="https://github.com/SousaFelipe/ixc-orm/blob/main/src/IxcResponse.ts">IxcResponse</a>.
 
 ### v1.9.0
-* **Melhoria:** Novo recurso para remoção de MAC de um PPPoE, através do recurso `radusuarios_25452`, que é disponibilizado pela própria API do IXC Provedor. Para utilizar o recurso, invocar o método assícrono `Recurso.limparMAC({ id_login: number });`. O método irá retornar a instãncia de um <a href="https://github.com/SousaFelipe/ixc-orm/blob/main/src/IxcResponse.ts">IxcResponse</a>.
+* **Melhoria:** Novo recurso para remoção de MAC de um PPPoE, através do recurso `radusuarios_25452`, que é disponibilizado pela própria API do IXC Provedor. Para utilizar o recurso, invocar o método assícrono `Recurso.limparMAC({ id_login: number });`. O método irá retornar a instância de um <a href="https://github.com/SousaFelipe/ixc-orm/blob/main/src/IxcResponse.ts">IxcResponse</a>.
 
 ### v1.8.0
 * **Melhoria:** O processo de carregamento do ambiente consegue detectar se as variáveis já foram carregas por um container Docker e interrompe o carregamento através do `.env`, evitando que a aplicação encerre o processo com erro..

package/README.md

@@ -33,7 +33,7 @@ yarn add ixc-orm
 Para configurar a comunicação da biblioteca com seu servidor IXC Provedor, é necessário adicionar as seguintes variáveis de ambiente a um arquivo `.env`, que esteja localizado no diretório raiz do seu projeto.
 
 > [!NOTE]\
-> Versão 1.10.2 `stable`
+> Versão 1.10.5 `stable`
 
 - **IXC_ACCESS_TOKEN** Um token de API gerado dentro do IXC Provedor.
 - **IXC_SERVER_DOMAIN** O domínio do seu servidor IXC Provedor.
@@ -60,7 +60,7 @@ services:
 As classes que representarão os diferentes tipos de registros no seu **IXC Provedor**, deverão herdar da classe `IxcOrm` (nova versão), como no exemplo a seguir:
 
 > [!NOTE]\
-> Versão 1.10.2 `stable`
+> Versão 1.10.5 `stable`
 
 ```typescript
 import { IxcOrm } from 'ixc-orm';
@@ -76,7 +76,7 @@ class Contrato extends IxcOrm {
 Após instanciar um objeto com o tipo que você criou (`Contrato, como no exemplo a cima`), você poderá acessar os métodos de construção da query de busca.
 
 > [!NOTE]\
-> Versão 1.10.2 `stable`
+> Versão 1.10.5 `stable`
 
 ```typescript
 import { IxcResponse, Sort } from 'ixc-orm';
@@ -104,16 +104,22 @@ const id_contrato = 45852;
 const response = await Recurso.desbloqueioDeConfianca({ id_contrato });
 ```
 
-> Dos recursos disponibilizados pela API do **IXC Provedor**, essa biblioteca já possui as implementações de:\
-> `cliente_contrato_ativar_cliente`, `cliente_contrato_btn_lib_temp_24722`, `desbloqueio_confianca`, `get_boleto` e `radusuarios_25452`.\
-> Obs: Os nomes dos recursos estão de acordo com a API do **IXC Provedor** a fim de facilitar o estudo através da sua própria documentação oficial.
+
+### Recursos disponíveis:
+
+| Recurso IXC | Método da biblioteca | Descrição
+| :---------- | :--------- | :---------- |
+| ativaContrato({ id_contrato }) | cliente_contrato_ativar_cliente | Ativa um contrato que esteja com o status de `pré-contrato` |
+| desbloqueioDeConfianca({ id_contrato }) | desbloqueio_confianca | Solicita liberação de um cliente que já tenha sido desbloqueado |
+| getArquivoBoleto({ id_fatura }) | get_boleto | Obtém uma string base64 com o conteúdo do PDF da fatura de um cliente |
+| limparMAC({ id_login }) | radusuarios_25452 | Remove o endereço de MAC do login de um cliente |
+| liberacaoTemporaria({ id_contrato }) | cliente_contrato_btn_lib_temp_24722 | Desbloqueia, por 72 horas, o contrato de um cliente bloqueado |
 
 
 # Contribuições
 
 Contribuições são sempre bem-vindas!\
 Se você conhece uma maneira melhor de fazer algo, por favor, me avise!
-Caso contrário, é sempre melhor fazer um PR na branch main.
 
 At.te,\
 <b>Felipe S. Carmo</b>.

package/dist/IXCClient.d.ts

@@ -0,0 +1,67 @@
+import { IXCOptions, IXCQuery, IXCResponse, IXCSortOrder } from './types';
+export default abstract class IXCClient {
+    protected table: string;
+    protected params: IXCQuery[];
+    protected options: IXCOptions;
+    /**
+     * @param table O nome da tabela correspondente ao banco de dados do seu servidor IXC
+     * @see {@link https://wikiapiprovedor.ixcsoft.com.br/index.php}
+     */
+    constructor(table: string);
+    /**
+     * Incrementa o array de parâmetros que serão trasformados no corpo de uma requisição
+     * e passados como filtro grid da API do IXC
+     *
+     * @param whereClauses Um array de strings, no formato [coluna, operador, valor]\
+     * `Obs`: se você passar um array no formato [coluna, valor] o operador será considerado como '='\
+     * Os operadores válidos são: =, !=, >, <, >=, <=, LIKE
+     * @returns A própria instância
+     */
+    where(whereClauses: string[]): IXCClient;
+    /**
+     * Define como a API do IXC ordenará os dados retornados
+     *
+     * @param column A coluna que será usada para ordenar a busca
+     * @param order A ordem da busca ('asc'ou 'desc')
+     * @returns A própria instância
+     */
+    orderBy(column: string, order: keyof typeof IXCSortOrder): IXCClient;
+    /**
+     * Envia uma requisição GET para a API do IXC, com o header `ixcsoft` definico como `listar`\
+     * A `query` dessa requisição não será enviada para o IXC com o parâmetro `grid_param`\
+     * Ou seja, esta requisição executa uma busca simples, em vez do filtro de grid
+     *
+     * @param id O identificador numérico do registro que será buscado no IXC
+     * @returns Promise<IXCResponse>
+     */
+    find(id: any): Promise<IXCResponse>;
+    /**
+     * Envia uma requisição GET para a API do IXC, com o header `ixcsoft` definico como `listar`
+     * Preenche o corpo da requisição com os dados passados pela função `where` no formado JSON
+     *
+     * @param pg O número da página que será solicitada ao IXC `padão = 1`
+     * @param rows A quantidade de linhas (registros) por página `padrão = 20`
+     * @returns Promise<IXCResponse>
+     */
+    get(pg?: number, rows?: number): Promise<IXCResponse>;
+    /**
+     * Envia uma requisição do tipo `POST` para a API do IXC, com o header `ixcsoft` vazio
+     *
+     * @param body Um objeto no formado "chave: valor" contendo as informações do novo registro
+     * a ser inserido no banco de dados do seu servidor IXC
+     * @returns Promise<IXCResponse>
+     */
+    post(body?: {
+        [key: string]: any;
+    }): Promise<IXCResponse>;
+    /**
+     * Envia uma requisição do tipo `PUT` para a API do IXC, com o header `ixcsoft` vazio
+     *
+     * @param id O id do registro que será alterado
+     * @param body Um objeto no formado "chave : valor" contendo as colunas que serão alteradas
+     * @returns Promise<IXCResponse>
+     */
+    put(id: number, body?: {
+        [key: string]: any;
+    }): Promise<IXCResponse>;
+}

package/dist/IXCClient.js

@@ -0,0 +1,238 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        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 });
+const request_1 = require("./request");
+const types_1 = require("./types");
+const response_1 = require("./response");
+class IXCClient {
+    /**
+     * @param table O nome da tabela correspondente ao banco de dados do seu servidor IXC
+     * @see {@link https://wikiapiprovedor.ixcsoft.com.br/index.php}
+     */
+    constructor(table) {
+        this.table = table;
+        this.params = [];
+        this.options = {
+            page: 1,
+            rowsPerPage: 20,
+            sortName: 'id',
+            sortOrder: 'asc'
+        };
+    }
+    /**
+     * Incrementa o array de parâmetros que serão trasformados no corpo de uma requisição
+     * e passados como filtro grid da API do IXC
+     *
+     * @param whereClauses Um array de strings, no formato [coluna, operador, valor]\
+     * `Obs`: se você passar um array no formato [coluna, valor] o operador será considerado como '='\
+     * Os operadores válidos são: =, !=, >, <, >=, <=, LIKE
+     * @returns A própria instância
+     */
+    where(whereClauses) {
+        if (whereClauses.length > 3) {
+            throw new Error(`> As cláusulas não podem conter mais de 3 elementos.`);
+        }
+        const [alwaysColumn, operatorOrValue, valueOrUndefined] = whereClauses;
+        const availableOperators = Object.keys(types_1.IXCOperator);
+        if (whereClauses.length > 2 && !availableOperators.includes(operatorOrValue)) {
+            throw new Error(`> O operador ${operatorOrValue}, não faz parte dos operadores válidos: ${availableOperators}.`);
+        }
+        this.params.push({
+            TB: alwaysColumn,
+            OP: valueOrUndefined ? operatorOrValue : '=',
+            P: valueOrUndefined ? valueOrUndefined : operatorOrValue
+        });
+        return this;
+    }
+    /**
+     * Define como a API do IXC ordenará os dados retornados
+     *
+     * @param column A coluna que será usada para ordenar a busca
+     * @param order A ordem da busca ('asc'ou 'desc')
+     * @returns A própria instância
+     */
+    orderBy(column, order) {
+        this.options.sortName = column;
+        this.options.sortOrder = order;
+        return this;
+    }
+    /**
+     * Envia uma requisição GET para a API do IXC, com o header `ixcsoft` definico como `listar`\
+     * A `query` dessa requisição não será enviada para o IXC com o parâmetro `grid_param`\
+     * Ou seja, esta requisição executa uma busca simples, em vez do filtro de grid
+     *
+     * @param id O identificador numérico do registro que será buscado no IXC
+     * @returns Promise<IXCResponse>
+     */
+    find(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const params = {
+                TB: 'id',
+                OP: '=',
+                P: id
+            };
+            const opts = {
+                page: 1,
+                rowsPerPage: 1,
+            };
+            const axios = (0, request_1.createAxiosInstance)('GET');
+            const data = (0, request_1.createRequestPayload)(this.table, params, opts);
+            try {
+                const response = yield axios.get(this.table, { data });
+                if (response.status === 200) {
+                    return response.data;
+                }
+                return (0, response_1.createResponse)({
+                    error: true,
+                    message: (_a = response.data) === null || _a === void 0 ? void 0 : _a.message
+                });
+            }
+            catch (error) {
+                console.error(error);
+                return (0, response_1.createResponse)({
+                    error: true,
+                    message: ((_b = error.response) === null || _b === void 0 ? void 0 : _b.statusText) || error.message || 'Erro desconhecido'
+                });
+            }
+            finally {
+                this.params = [];
+                this.options = {
+                    page: 1,
+                    rowsPerPage: 20,
+                    sortName: 'id',
+                    sortOrder: 'asc'
+                };
+            }
+        });
+    }
+    /**
+     * Envia uma requisição GET para a API do IXC, com o header `ixcsoft` definico como `listar`
+     * Preenche o corpo da requisição com os dados passados pela função `where` no formado JSON
+     *
+     * @param pg O número da página que será solicitada ao IXC `padão = 1`
+     * @param rows A quantidade de linhas (registros) por página `padrão = 20`
+     * @returns Promise<IXCResponse>
+     */
+    get(pg, rows) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const _c = this.options, { page, rowsPerPage } = _c, rest = __rest(_c, ["page", "rowsPerPage"]);
+            const opts = Object.assign({ page: pg !== null && pg !== void 0 ? pg : page, rowsPerPage: rows !== null && rows !== void 0 ? rows : rowsPerPage }, rest);
+            const axios = (0, request_1.createAxiosInstance)('GET');
+            const data = (0, request_1.createRequestPayload)(this.table, this.params, opts);
+            try {
+                const response = yield axios.get(this.table, { data });
+                if (response.status === 200) {
+                    return response.data;
+                }
+                return (0, response_1.createResponse)({
+                    error: true,
+                    message: (_a = response.data) === null || _a === void 0 ? void 0 : _a.message
+                });
+            }
+            catch (error) {
+                console.error(error);
+                return (0, response_1.createResponse)({
+                    error: true,
+                    message: ((_b = error.response) === null || _b === void 0 ? void 0 : _b.statusText) || error.message || 'Erro desconhecido'
+                });
+            }
+            finally {
+                this.params = [];
+                this.options = {
+                    page: 1,
+                    rowsPerPage: 20,
+                    sortName: 'id',
+                    sortOrder: 'asc'
+                };
+            }
+        });
+    }
+    /**
+     * Envia uma requisição do tipo `POST` para a API do IXC, com o header `ixcsoft` vazio
+     *
+     * @param body Um objeto no formado "chave: valor" contendo as informações do novo registro
+     * a ser inserido no banco de dados do seu servidor IXC
+     * @returns Promise<IXCResponse>
+     */
+    post(body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const axios = (0, request_1.createAxiosInstance)('POST');
+            try {
+                const response = yield axios.post(this.table, { data: body });
+                if (response.status === 200) {
+                    return response.data;
+                }
+                return (0, response_1.createResponse)({
+                    error: true,
+                    message: (_a = response.data) === null || _a === void 0 ? void 0 : _a.message
+                });
+            }
+            catch (error) {
+                console.error(error);
+                return (0, response_1.createResponse)({
+                    error: true,
+                    message: ((_b = error.response) === null || _b === void 0 ? void 0 : _b.statusText) || error.message || 'Erro desconhecido'
+                });
+            }
+            finally {
+                this.params = [];
+            }
+        });
+    }
+    /**
+     * Envia uma requisição do tipo `PUT` para a API do IXC, com o header `ixcsoft` vazio
+     *
+     * @param id O id do registro que será alterado
+     * @param body Um objeto no formado "chave : valor" contendo as colunas que serão alteradas
+     * @returns Promise<IXCResponse>
+     */
+    put(id, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const axios = (0, request_1.createAxiosInstance)('PUT');
+            try {
+                const response = yield axios.put(`${this.table}/${id}`, { data: body });
+                if (response.status === 200) {
+                    return response.data;
+                }
+                return (0, response_1.createResponse)({
+                    error: true,
+                    message: (_a = response.data) === null || _a === void 0 ? void 0 : _a.message
+                });
+            }
+            catch (error) {
+                console.error(error);
+                return (0, response_1.createResponse)({
+                    error: true,
+                    message: ((_b = error.response) === null || _b === void 0 ? void 0 : _b.statusText) || error.message || 'Erro desconhecido'
+                });
+            }
+            finally {
+                this.params = [];
+            }
+        });
+    }
+}
+exports.default = IXCClient;

package/dist/IxcOrm.d.ts

@@ -0,0 +1,81 @@
+import { Sort } from './api/Ordering';
+import RequestEmitter from './api/RequestEmitter';
+export default abstract class IxcOrm extends RequestEmitter {
+    private ordering;
+    private pagination;
+    private parameters;
+    private parameterStub;
+    /**
+     * Método construtor da classe.
+     *
+     * @param table Representa o o nome da tabela que será manipulada, no IXC Provedor.
+     */
+    protected constructor(table: string);
+    /**
+     * Inicia um novo objeto de parâmetro de busca do filtro da grid.
+     *
+     * @param column O nome da coluna onde o filtro de busca será executado.
+     * @returns A própria instância.
+     */
+    where(column: string): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**L**) = LIKE.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    like(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**=**) = EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    exactly(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**<**) = LESS_THAN.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    lessThan(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**<=**) = LESS_THAN_EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    lessThanEquals(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**>**) = GREATER_THAN.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    greaterThan(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**>=**) = GREATER_THAN_EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    greaterThanEquals(value: string | number): IxcOrm;
+    /**
+     * Define o número da página e a quantidade de registros por página que serão retornados pelo IXc Provedor.
+     *
+     * @param page A página a ser buscada.
+     * @param rows A quantidade de registros por página.
+     * @returns A própria instância.
+     */
+    paginate(page: number, rows: number): this;
+    /**
+     * Define o tipo de ordenação dos registros retornados pela API do IXC Provedor.
+     *
+     * @param sort **ASC** ou **DESC**.
+     * @param column A coluna que será utilizada para ordenar os registros.
+     * @returns A própria instância.
+     */
+    orderBy(column: string, sort: Sort): this;
+    private createQueryObject;
+    private addParamToGridAndResetStub;
+}

package/dist/IxcOrm.js

@@ -0,0 +1,186 @@
+"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 });
+const Operators_1 = __importDefault(require("./api/Operators"));
+const Ordering_1 = __importStar(require("./api/Ordering"));
+const Pagination_1 = __importDefault(require("./api/Pagination"));
+const Parameter_1 = __importDefault(require("./api/Parameter"));
+const RequestEmitter_1 = __importDefault(require("./api/RequestEmitter"));
+class IxcOrm extends RequestEmitter_1.default {
+    /**
+     * Método construtor da classe.
+     *
+     * @param table Representa o o nome da tabela que será manipulada, no IXC Provedor.
+     */
+    constructor(table) {
+        super(table);
+        this.ordering = Ordering_1.default.ascBy(table, "id");
+        this.pagination = Pagination_1.default.defaults();
+        this.parameters = [];
+        this.parameterStub = new Parameter_1.default(table);
+    }
+    /**
+     * Inicia um novo objeto de parâmetro de busca do filtro da grid.
+     *
+     * @param column O nome da coluna onde o filtro de busca será executado.
+     * @returns A própria instância.
+     */
+    where(column) {
+        this.parameterStub.withType(column);
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**L**) = LIKE.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    like(value) {
+        this.parameterStub.withOperator(Operators_1.default.LIKE);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**=**) = EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    exactly(value) {
+        this.parameterStub.withOperator(Operators_1.default.EQUALS);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**<**) = LESS_THAN.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    lessThan(value) {
+        this.parameterStub.withOperator(Operators_1.default.LESS_THAN);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**<=**) = LESS_THAN_EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    lessThanEquals(value) {
+        this.parameterStub.withOperator(Operators_1.default.LESS_THAN_EQUALS);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**>**) = GREATER_THAN.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    greaterThan(value) {
+        this.parameterStub.withOperator(Operators_1.default.GREATER_THAN);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**>=**) = GREATER_THAN_EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    greaterThanEquals(value) {
+        this.parameterStub.withOperator(Operators_1.default.GREATER_THAN_EQUALS);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Define o número da página e a quantidade de registros por página que serão retornados pelo IXc Provedor.
+     *
+     * @param page A página a ser buscada.
+     * @param rows A quantidade de registros por página.
+     * @returns A própria instância.
+     */
+    paginate(page, rows) {
+        this.pagination = new Pagination_1.default(page, rows);
+        return this;
+    }
+    /**
+     * Define o tipo de ordenação dos registros retornados pela API do IXC Provedor.
+     *
+     * @param sort **ASC** ou **DESC**.
+     * @param column A coluna que será utilizada para ordenar os registros.
+     * @returns A própria instância.
+     */
+    orderBy(column, sort) {
+        this.ordering = (sort === Ordering_1.Sort.ASC)
+            ? Ordering_1.default.ascBy(super.getTable(), column)
+            : Ordering_1.default.descBy(super.getTable(), column);
+        return this;
+    }
+    createQueryObject() {
+        return {
+            qtype: super.getTable(),
+            query: "",
+            oper: "",
+            page: this.pagination.getPage(),
+            rp: this.pagination.getRows(),
+            sortname: this.ordering.getSortName(),
+            sortorder: this.ordering.getSortOrder().toString(),
+            grid_param: JSON.stringify(this.parameters)
+        };
+    }
+    addParamToGridAndResetStub() {
+        this.parameters.push(this.parameterStub.toJsonObject());
+        this.parameterStub = new Parameter_1.default(super.getTable());
+    }
+}
+exports.default = IxcOrm;