ixc-orm 1.10.5 → 1.10.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,4 +1,5 @@
1
1
  # 🔄 CHANGELOG
2
+ - [v1.10.6 - 23 de dezembro de 2025](#v1106)
2
3
  - [v1.10.5 - 20 de dezembro de 2025](#v1105)
3
4
  - [v1.10.4 - 20 de novembro de 2025](#v1104)
4
5
  - [v1.9.0 - 09 de outubro de 2025](#v190)
@@ -14,6 +15,8 @@
14
15
 
15
16
  ## 🚀 Novidades
16
17
 
18
+ ### v1.10.6
19
+ * **Correção:** Removido o bug que ocorria ao tentar utilizar o recurso `liberacaoTemporaria({ id_contrato })` sem que as antigas variáveis de ambiente estivessem definidas.
17
20
 
18
21
  ### v1.10.5
19
22
  * **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.
package/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  <div align="center">
2
-
2
+
3
3
  # IXC-ORM
4
4
 
5
5
  ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)
@@ -30,13 +30,10 @@ yarn add ixc-orm
30
30
 
31
31
  ## Como utilizar
32
32
 
33
- 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.
34
-
35
- > [!NOTE]\
36
- > Versão 1.10.5 `stable`
33
+ Para configurar a comunicação da biblioteca com o seu IXC Provedor, será necessário adicionar as seguintes variáveis de ambiente a um arquivo `.env`, que esteja localizado no diretório raiz do seu projeto.
37
34
 
38
35
  - **IXC_ACCESS_TOKEN** Um token de API gerado dentro do IXC Provedor.
39
- - **IXC_SERVER_DOMAIN** O domínio do seu servidor IXC Provedor.
36
+ - **IXC_SERVER_DOMAIN** O domínio do seu IXC Provedor.
40
37
 
41
38
  ```ini
42
39
  IXC_ACCESS_TOKEN=conteúdo-do-token-gerado-dentro-do-ixc
@@ -48,8 +45,10 @@ Você também poderá configurar para que o Docker carregue as variáveis, ao in
48
45
  ```yaml
49
46
  services:
50
47
  sua-aplicacao:
51
- build: .
52
- image: sua-imagem-docker
48
+ build:
49
+ context: .
50
+ dockerfile: Dockerfile
51
+ image: sua-imagem-docker:0.0.0
53
52
  environment:
54
53
  - IXC_ACCESS_TOKEN=${IXC_ACCESS_TOKEN}
55
54
  - IXC_SERVER_DOMAIN=${IXC_SERVER_DOMAIN}
@@ -57,10 +56,7 @@ services:
57
56
  ```
58
57
 
59
58
 
60
- 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:
61
-
62
- > [!NOTE]\
63
- > Versão 1.10.5 `stable`
59
+ As classes que representarão os diferentes tipos de registros no seu **IXC Provedor**, deverão herdar da classe `IxcOrm`, como no exemplo a seguir:
64
60
 
65
61
  ```typescript
66
62
  import { IxcOrm } from 'ixc-orm';
@@ -73,10 +69,7 @@ class Contrato extends IxcOrm {
73
69
  ```
74
70
 
75
71
 
76
- 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.
77
-
78
- > [!NOTE]\
79
- > Versão 1.10.5 `stable`
72
+ Após instanciar um objeto com o tipo criado (**Contrato**, como no exemplo a cima), você poderá acessar os métodos de construção da query de busca, da seguinte forma:
80
73
 
81
74
  ```typescript
82
75
  import { IxcResponse, Sort } from 'ixc-orm';
@@ -95,7 +88,7 @@ const contratos = response.registros();
95
88
 
96
89
  ## Recursos da API do IXC Provedor
97
90
 
98
- Existem alguns `endpoints` que a API do IXC Provedor disponibiliza, a fim de "encurtar o caminho" para chegar até algumas informações. Como por exemplo, obter o arquivo PDF de uma fatura. Para isso, você não precisará se preocupar em criar uma classe `Boleto` que herde da classe `IxcOrm`, por exemplo, nem encadear chamadas de filtros. Basta fazer como no exemplo a seguir:
91
+ Existem alguns `endpoints` que a API do IXC Provedor disponibiliza, a fim de "encurtar o caminho" para chegar até algumas informações ou executar determinadas ações. Como por exemplo, obter o arquivo PDF de uma fatura! Para isso, você não precisará se preocupar em criar uma classe `Boleto` que herde da classe `IxcOrm`, por exemplo, nem encadear chamadas de filtros. Basta fazer como no exemplo a seguir:
99
92
 
100
93
  ```typescript
101
94
  import { Recurso } from 'ixc-orm';
@@ -107,7 +100,7 @@ const response = await Recurso.desbloqueioDeConfianca({ id_contrato });
107
100
 
108
101
  ### Recursos disponíveis:
109
102
 
110
- | Recurso IXC | Método da biblioteca | Descrição
103
+ | Método da biblioteca | Recurso IXC | Descrição
111
104
  | :---------- | :--------- | :---------- |
112
105
  | ativaContrato({ id_contrato }) | cliente_contrato_ativar_cliente | Ativa um contrato que esteja com o status de `pré-contrato` |
113
106
  | desbloqueioDeConfianca({ id_contrato }) | desbloqueio_confianca | Solicita liberação de um cliente que já tenha sido desbloqueado |
@@ -119,7 +112,8 @@ const response = await Recurso.desbloqueioDeConfianca({ id_contrato });
119
112
  # Contribuições
120
113
 
121
114
  Contribuições são sempre bem-vindas!\
122
- Se você conhece uma maneira melhor de fazer algo, por favor, me avise!
115
+ Se você conhece uma maneira melhor de fazer algo, por favor, me avise!\
116
+ Ou sinta-se a vontade para criar um novo PR!
123
117
 
124
118
  At.te,\
125
119
  <b>Felipe S. Carmo</b>.
@@ -1,4 +1,4 @@
1
- import { IXCResponse } from '../types';
1
+ import IxcResponse from '../IxcResponse';
2
2
  export default function cliente_contrato(args: {
3
3
  id_contrato?: string | number;
4
- }): Promise<IXCResponse>;
4
+ }): Promise<IxcResponse>;
@@ -13,16 +13,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
13
13
  };
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
15
  exports.default = cliente_contrato;
16
- const recurso_1 = __importDefault(require("./recurso"));
16
+ const RequestEmitter_1 = __importDefault(require("../api/RequestEmitter"));
17
17
  const src = 'cliente_contrato_btn_lib_temp_24722';
18
18
  function cliente_contrato(args) {
19
19
  return __awaiter(this, void 0, void 0, function* () {
20
20
  const { id_contrato } = args;
21
- return yield (0, recurso_1.default)({
22
- src,
23
- data: {
24
- id_contrato
25
- }
21
+ const requestEmitter = new RequestEmitter_1.default(src);
22
+ requestEmitter.setupQuery({
23
+ id: id_contrato
26
24
  });
25
+ return yield requestEmitter.sendRequestToResource();
27
26
  });
28
27
  }
@@ -7,7 +7,6 @@ import radusuarios_25452 from './radusuarios_25452';
7
7
  * @deprecated Acesse os recursos através da constante {@link Recurso}
8
8
  */
9
9
  declare const recursos: {
10
- cliente_contrato: typeof cliente_contrato_btn_lib_temp_24722;
11
10
  desbloqueio_confianca: typeof desbloqueio_confianca;
12
11
  get_boleto: typeof get_boleto;
13
12
  };
@@ -23,7 +23,6 @@ const radusuarios_25452_1 = __importDefault(require("./radusuarios_25452"));
23
23
  * @deprecated Acesse os recursos através da constante {@link Recurso}
24
24
  */
25
25
  const recursos = {
26
- cliente_contrato: cliente_contrato_btn_lib_temp_24722_1.default,
27
26
  desbloqueio_confianca: desbloqueio_confianca_1.default,
28
27
  get_boleto: get_boleto_1.default
29
28
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ixc-orm",
3
- "version": "1.10.5",
3
+ "version": "1.10.6",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "license": "MIT",