cecon-interfaces 1.8.13 → 1.8.14

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.
Files changed (73) hide show
  1. package/dist/esm2022/firebank/entities/index.mjs +4 -0
  2. package/dist/esm2022/firebank/entities/payment/callback-error.entity.mjs +10 -0
  3. package/dist/esm2022/firebank/entities/payment/callback.entity.mjs +28 -0
  4. package/dist/esm2022/firebank/entities/payment/index.mjs +4 -0
  5. package/dist/esm2022/firebank/entities/payment/payment-post.entity.mjs +98 -0
  6. package/dist/esm2022/firebank/entities/transaction/index.mjs +2 -0
  7. package/dist/esm2022/firebank/entities/transaction/transaction.entity.mjs +76 -0
  8. package/dist/esm2022/firebank/entities/withdraw/index.mjs +2 -0
  9. package/dist/esm2022/firebank/entities/withdraw/withdraw-post.entity.mjs +18 -0
  10. package/dist/esm2022/firebank/enums/index.mjs +3 -0
  11. package/dist/esm2022/firebank/enums/transaction-status.enum.mjs +7 -0
  12. package/dist/esm2022/firebank/enums/withdraw-detais-key.enum.mjs +7 -0
  13. package/dist/esm2022/firebank/index.mjs +4 -0
  14. package/dist/esm2022/firebank/interfaces/index.mjs +4 -0
  15. package/dist/esm2022/firebank/interfaces/payment/i-callback-error.mjs +2 -0
  16. package/dist/esm2022/firebank/interfaces/payment/i-callback.mjs +2 -0
  17. package/dist/esm2022/firebank/interfaces/payment/i-payment-post.mjs +5 -0
  18. package/dist/esm2022/firebank/interfaces/payment/index.mjs +2 -0
  19. package/dist/esm2022/firebank/interfaces/transaction/i-transaction.mjs +2 -0
  20. package/dist/esm2022/firebank/interfaces/transaction/index.mjs +2 -0
  21. package/dist/esm2022/firebank/interfaces/withdraw/i-withdraw-post.mjs +2 -0
  22. package/dist/esm2022/firebank/interfaces/withdraw/index.mjs +2 -0
  23. package/dist/esm2022/index.mjs +2 -1
  24. package/dist/fesm2022/cecon-interfaces.mjs +242 -1
  25. package/dist/fesm2022/cecon-interfaces.mjs.map +1 -1
  26. package/dist/firebank/entities/index.d.ts +3 -0
  27. package/dist/firebank/entities/index.js +19 -0
  28. package/dist/firebank/entities/payment/callback-error.entity.d.ts +10 -0
  29. package/dist/firebank/entities/payment/callback-error.entity.js +16 -0
  30. package/dist/firebank/entities/payment/callback.entity.d.ts +28 -0
  31. package/dist/firebank/entities/payment/callback.entity.js +34 -0
  32. package/dist/firebank/entities/payment/index.d.ts +3 -0
  33. package/dist/firebank/entities/payment/index.js +19 -0
  34. package/dist/firebank/entities/payment/payment-post.entity.d.ts +98 -0
  35. package/dist/firebank/entities/payment/payment-post.entity.js +124 -0
  36. package/dist/firebank/entities/transaction/index.d.ts +1 -0
  37. package/dist/firebank/entities/transaction/index.js +17 -0
  38. package/dist/firebank/entities/transaction/transaction.entity.d.ts +77 -0
  39. package/dist/firebank/entities/transaction/transaction.entity.js +122 -0
  40. package/dist/firebank/entities/withdraw/index.d.ts +1 -0
  41. package/dist/firebank/entities/withdraw/index.js +17 -0
  42. package/dist/firebank/entities/withdraw/withdraw-post.entity.d.ts +18 -0
  43. package/dist/firebank/entities/withdraw/withdraw-post.entity.js +32 -0
  44. package/dist/firebank/enums/index.d.ts +2 -0
  45. package/dist/firebank/enums/index.js +7 -0
  46. package/dist/firebank/enums/transaction-status.enum.d.ts +5 -0
  47. package/dist/firebank/enums/transaction-status.enum.js +9 -0
  48. package/dist/firebank/enums/withdraw-detais-key.enum.d.ts +5 -0
  49. package/dist/firebank/enums/withdraw-detais-key.enum.js +9 -0
  50. package/dist/firebank/index.d.ts +3 -0
  51. package/dist/firebank/index.js +19 -0
  52. package/dist/firebank/interfaces/index.d.ts +3 -0
  53. package/dist/firebank/interfaces/index.js +19 -0
  54. package/dist/firebank/interfaces/payment/i-callback-error.d.ts +9 -0
  55. package/dist/firebank/interfaces/payment/i-callback-error.js +2 -0
  56. package/dist/firebank/interfaces/payment/i-callback.d.ts +27 -0
  57. package/dist/firebank/interfaces/payment/i-callback.js +2 -0
  58. package/dist/firebank/interfaces/payment/i-payment-post.d.ts +97 -0
  59. package/dist/firebank/interfaces/payment/i-payment-post.js +5 -0
  60. package/dist/firebank/interfaces/payment/index.d.ts +3 -0
  61. package/dist/firebank/interfaces/payment/index.js +2 -0
  62. package/dist/firebank/interfaces/transaction/i-transaction.d.ts +92 -0
  63. package/dist/firebank/interfaces/transaction/i-transaction.js +2 -0
  64. package/dist/firebank/interfaces/transaction/index.d.ts +1 -0
  65. package/dist/firebank/interfaces/transaction/index.js +17 -0
  66. package/dist/firebank/interfaces/withdraw/i-withdraw-post.d.ts +16 -0
  67. package/dist/firebank/interfaces/withdraw/i-withdraw-post.js +2 -0
  68. package/dist/firebank/interfaces/withdraw/index.d.ts +1 -0
  69. package/dist/firebank/interfaces/withdraw/index.js +2 -0
  70. package/dist/index.d.ts +1 -0
  71. package/dist/index.js +1 -0
  72. package/dist/package.json +1 -1
  73. package/package.json +1 -1
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.EFirebankWithdrawDetailsKey = exports.EFirebankTransactionStatus = void 0;
4
+ var transaction_status_enum_1 = require("./transaction-status.enum");
5
+ Object.defineProperty(exports, "EFirebankTransactionStatus", { enumerable: true, get: function () { return transaction_status_enum_1.EFirebankTransactionStatus; } });
6
+ var withdraw_detais_key_enum_1 = require("./withdraw-detais-key.enum");
7
+ Object.defineProperty(exports, "EFirebankWithdrawDetailsKey", { enumerable: true, get: function () { return withdraw_detais_key_enum_1.EFirebankWithdrawDetailsKey; } });
@@ -0,0 +1,5 @@
1
+ export declare enum EFirebankTransactionStatus {
2
+ WAITING_CONFIRMATION = "WAITING_CONFIRMATION",
3
+ SUCCESS = "SUCCESS",
4
+ FAILED = "FAILED"
5
+ }
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.EFirebankTransactionStatus = void 0;
4
+ var EFirebankTransactionStatus;
5
+ (function (EFirebankTransactionStatus) {
6
+ EFirebankTransactionStatus["WAITING_CONFIRMATION"] = "WAITING_CONFIRMATION";
7
+ EFirebankTransactionStatus["SUCCESS"] = "SUCCESS";
8
+ EFirebankTransactionStatus["FAILED"] = "FAILED";
9
+ })(EFirebankTransactionStatus || (exports.EFirebankTransactionStatus = EFirebankTransactionStatus = {}));
@@ -0,0 +1,5 @@
1
+ export declare enum EFirebankWithdrawDetailsKey {
2
+ RANDOM_KEY = "RANDOM_KEY",
3
+ DOCUMENT = "DOCUMENT",
4
+ EMAIL = "EMAIL"
5
+ }
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.EFirebankWithdrawDetailsKey = void 0;
4
+ var EFirebankWithdrawDetailsKey;
5
+ (function (EFirebankWithdrawDetailsKey) {
6
+ EFirebankWithdrawDetailsKey["RANDOM_KEY"] = "RANDOM_KEY";
7
+ EFirebankWithdrawDetailsKey["DOCUMENT"] = "DOCUMENT";
8
+ EFirebankWithdrawDetailsKey["EMAIL"] = "EMAIL";
9
+ })(EFirebankWithdrawDetailsKey || (exports.EFirebankWithdrawDetailsKey = EFirebankWithdrawDetailsKey = {}));
@@ -0,0 +1,3 @@
1
+ export * from './enums';
2
+ export * from './entities';
3
+ export * from './interfaces';
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./enums"), exports);
18
+ __exportStar(require("./entities"), exports);
19
+ __exportStar(require("./interfaces"), exports);
@@ -0,0 +1,3 @@
1
+ export * from './payment';
2
+ export * from './transaction';
3
+ export * from './withdraw';
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./payment"), exports);
18
+ __exportStar(require("./transaction"), exports);
19
+ __exportStar(require("./withdraw"), exports);
@@ -0,0 +1,9 @@
1
+ export interface IFirebankCallbackError {
2
+ businessTransactionId: string | null;
3
+ createdDate: string;
4
+ endToEndId: string;
5
+ pixKey: string | null;
6
+ status: string;
7
+ transactionId: string;
8
+ value: number;
9
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,27 @@
1
+ import { EDocType } from '../../../general';
2
+ export interface IFirebankCallback {
3
+ businessTransactionId: string | null;
4
+ createdDate: string;
5
+ endToEndId: string;
6
+ payerBankAccount: string;
7
+ payerBankAccountDigit: string;
8
+ payerBankBranch: string;
9
+ payerBankCode: string;
10
+ payerBankISPB: string;
11
+ payerBankName: string;
12
+ payerDocumentNumber: EDocType;
13
+ payerName: string;
14
+ pixKey: string;
15
+ receiverBankAccount: string;
16
+ receiverBankBranch: string;
17
+ receiverBankCode: string;
18
+ receiverBankISPB: string;
19
+ receiverBankName: string;
20
+ receiverDocumentNumber: EDocType;
21
+ receiverName: string;
22
+ receiverToBankAccountDigit: string;
23
+ status: string;
24
+ transactionId: string;
25
+ value: number;
26
+ voucherUrl: string;
27
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,97 @@
1
+ /**
2
+ * Interface para o contato do pagador
3
+ */
4
+ import { EFirebankWithdrawDetailsKey } from "../../enums";
5
+ /**
6
+ * Interface principal para o pagamento
7
+ */
8
+ export interface IFirebankPaymentPost {
9
+ /** Informações do pagador */
10
+ payer: IFirebankPaymentPostPayer;
11
+ /** Lista de beneficiários a receber um valor pré-configurado após a cobrança ser efetivamente paga */
12
+ splits?: IFirebankPaymentPostSplit[];
13
+ /** Informações da transação */
14
+ transaction: IFirebankPaymentPostTransaction;
15
+ /** Tipo da operação. Sempre enviar "PIX" como valor padrão */
16
+ type: 'PIX';
17
+ }
18
+ /**
19
+ * Interface para o endereço do pagador
20
+ */
21
+ export interface IFirebankPaymentPostAddress {
22
+ /** Cidade do endereço do cliente/pagador */
23
+ city?: string;
24
+ /** País do endereço do cliente/pagador */
25
+ country?: string;
26
+ /** Bairro do endereço do cliente/pagador */
27
+ neighboor?: string;
28
+ /** Número do endereço do cliente/pagador */
29
+ number?: string;
30
+ /** Estado do endereço do cliente/pagador */
31
+ state?: string;
32
+ /** Rua/logradouro do endereço do cliente/pagador */
33
+ street?: string;
34
+ /** CEP do endereço do cliente/pagador */
35
+ zipCode?: string;
36
+ }
37
+ export interface IFirebankPaymentPostContact {
38
+ /** E-mail de contato do cliente/pagador */
39
+ mail?: string;
40
+ /** Telefone de contato do cliente/pagador */
41
+ phone?: string;
42
+ }
43
+ /**
44
+ * Interface para o pagador
45
+ */
46
+ export interface IFirebankPaymentPostPayer {
47
+ /** Endereço do pagador */
48
+ address?: IFirebankPaymentPostAddress;
49
+ /** Informações de contato do pagador */
50
+ contact?: IFirebankPaymentPostContact;
51
+ /** Documentação do cliente/pagador, CPF ou CNPJ */
52
+ document: string;
53
+ /** Nome do cliente/pagador */
54
+ fullName: string;
55
+ }
56
+ /**
57
+ * Interface para o split (beneficiário)
58
+ */
59
+ export interface IFirebankPaymentPostSplit {
60
+ /**
61
+ * Valor fixo a ser enviado.
62
+ * Este valor pode ser somado automaticamente com o valor percentual (percent).
63
+ * Este valor não pode ser maior do que o valor líquido recebido pela cobrança.
64
+ */
65
+ amount: number;
66
+ /** CPF ou CNPJ do beneficiário */
67
+ document: string;
68
+ /** Identificador único para que possa ser usado em caso de alteração/cancelamento do pagamento split */
69
+ externalId: string;
70
+ /**
71
+ * Valor em percentual a ser enviado. Por exemplo: caso a cobrança seja de R$10,00 (dez reais)
72
+ * e seja informado o valor "10" no campo percent, então será considerado 10% sobre R$10,00, que é R$1,00.
73
+ * Este valor pode ser somado automaticamente com o valor fixo (amount).
74
+ * Este valor não pode ser maior do que o valor líquido recebido pela cobrança.
75
+ */
76
+ percent: number;
77
+ /** Chave PIX do beneficiário */
78
+ pixKey: string;
79
+ /**
80
+ * Tipo da chave PIX do beneficiário.
81
+ * Podendo ser dos tipos: "RANDOM_KEY" (chave-aleatória), "DOCUMENT" (CPF ou CNPJ) ou "EMAIL" (e-mail)
82
+ */
83
+ pixKeyType: EFirebankWithdrawDetailsKey;
84
+ }
85
+ /**
86
+ * Interface para a transação
87
+ */
88
+ export interface IFirebankPaymentPostTransaction {
89
+ /** Descrição da cobrança */
90
+ description?: string;
91
+ /** Data de expiração da cobrança */
92
+ dueDate?: string;
93
+ /** Identificador único para ser usado como rastreio das cobranças no envio do Webhook */
94
+ externalId?: string;
95
+ /** Valor da transação. Aceita valores quebrados, separados por ponto, como 123.45, representando R$123,45 */
96
+ value: number;
97
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * Interface para o contato do pagador
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,3 @@
1
+ export { IFirebankCallback } from './i-callback';
2
+ export { IFirebankCallbackError } from './i-callback-error';
3
+ export { IFirebankPaymentPost, IFirebankPaymentPostAddress, IFirebankPaymentPostContact, IFirebankPaymentPostPayer, IFirebankPaymentPostSplit, IFirebankPaymentPostTransaction, } from './i-payment-post';
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,92 @@
1
+ export interface IFirebankTransaction {
2
+ _id: string;
3
+ businessId: string;
4
+ createdAt: string;
5
+ history: IFirebankTransactionHistory[];
6
+ negotiator: IFirebankTransactionNegotiator;
7
+ operation: IFirebankTransactionOperation;
8
+ splits: null;
9
+ updatedAt: Date;
10
+ }
11
+ export interface IFirebankTransactionCalendario {
12
+ criacao: string;
13
+ expiracao: number;
14
+ }
15
+ export interface IFirebankTransactionChave {
16
+ chave: string;
17
+ infoAdicionais: string[];
18
+ pixCopiaECola: string;
19
+ solicitacaoPagador: string;
20
+ status: string;
21
+ txid: string;
22
+ }
23
+ export interface IFirebankTransactionDevedor {
24
+ cpf: string;
25
+ nome: string;
26
+ }
27
+ export interface IFirebankTransactionHistory {
28
+ createdAt: string;
29
+ error: string[];
30
+ info: IFirebankTransactionInfo;
31
+ status: string;
32
+ }
33
+ export interface IFirebankTransactionHistoryProviderResponse {
34
+ createdAt: Date;
35
+ providerResponse: IFirebankTransactionProviderResponse;
36
+ }
37
+ export interface IFirebankTransactionInfo {
38
+ finishedTransaction: boolean;
39
+ transactionWithError: boolean;
40
+ }
41
+ export interface IFirebankTransactionLoc {
42
+ criacao: string;
43
+ id: number;
44
+ location: string;
45
+ tipoCob: string;
46
+ }
47
+ export interface IFirebankTransactionNegotiator {
48
+ clientType: string;
49
+ document: string;
50
+ fullName: string;
51
+ }
52
+ export interface IFirebankTransactionOperation {
53
+ chargeTableID: string;
54
+ externalID: string | null;
55
+ fee: number;
56
+ info: IFirebankTransactionInfo;
57
+ method: string;
58
+ provider: string;
59
+ providerSecondaryId: string;
60
+ result: number;
61
+ status: string;
62
+ type: string;
63
+ value: number;
64
+ }
65
+ export interface IFirebankTransactionProviderResponse {
66
+ pixCode: string;
67
+ providerSecondaryId: string;
68
+ responseBody: IFirebankTransactionResponseBody;
69
+ success: boolean;
70
+ }
71
+ export interface IFirebankTransactionResponseBody {
72
+ calendario: IFirebankTransactionCalendario;
73
+ chave: string;
74
+ devedor: IFirebankTransactionDevedor;
75
+ infoAdicionais: string[];
76
+ loc: IFirebankTransactionLoc;
77
+ pixCopiaECola: string;
78
+ revisao: number;
79
+ solicitacaoPagador: string;
80
+ status: string;
81
+ txid: string;
82
+ valor: IFirebankTransactionValor;
83
+ }
84
+ export interface IFirebankTransactionSplits {
85
+ createdAt: string;
86
+ splits: null;
87
+ updatedAt: Date;
88
+ }
89
+ export interface IFirebankTransactionValor {
90
+ modalidadeAlteracao: number;
91
+ original: string;
92
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1 @@
1
+ export * from './i-transaction';
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./i-transaction"), exports);
@@ -0,0 +1,16 @@
1
+ export interface IFirebankWithdrawPost {
2
+ details: IFirebankWithdrawPostDetails;
3
+ externalId: string;
4
+ type: string;
5
+ value: number;
6
+ }
7
+ export interface IFirebankWithdrawPostDetails {
8
+ document: string;
9
+ key: string;
10
+ keyType: string;
11
+ name: string;
12
+ }
13
+ export interface IFirebankWithdrawPostResponse {
14
+ status: string;
15
+ transactionId: string;
16
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1 @@
1
+ export { IFirebankWithdrawPost, IFirebankWithdrawPostDetails, IFirebankWithdrawPostResponse } from './i-withdraw-post';
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/dist/index.d.ts CHANGED
@@ -67,3 +67,4 @@ export * from './viacep';
67
67
  export * from './voucher';
68
68
  export * from './wa-server';
69
69
  export * from './withdraw';
70
+ export * from './firebank';
package/dist/index.js CHANGED
@@ -83,3 +83,4 @@ __exportStar(require("./viacep"), exports);
83
83
  __exportStar(require("./voucher"), exports);
84
84
  __exportStar(require("./wa-server"), exports);
85
85
  __exportStar(require("./withdraw"), exports);
86
+ __exportStar(require("./firebank"), exports);
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cecon-interfaces",
3
- "version": "1.8.13",
3
+ "version": "1.8.14",
4
4
  "description": "Interfaces de Projetos Cecon",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cecon-interfaces",
3
- "version": "1.8.13",
3
+ "version": "1.8.14",
4
4
  "description": "Interfaces de Projetos Cecon",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",