cecon-interfaces/dist/firebank/entities/payment/payment-post.entity.js

Interfaces de Projetos Cecon

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.FirebankPaymentPostTransactionEntity = exports.FirebankPaymentPostSplitEntity = exports.FirebankPaymentPostPayerEntity = exports.FirebankPaymentPostEntity = exports.FirebankPaymentPostContactEntity = exports.FirebankPaymentPostAddressEntity = void 0;
/**
 * Interface para o contato do pagador
 */
var enums_1 = require("../../enums");
/**
 * Interface para o endereço do pagador
 */
var FirebankPaymentPostAddressEntity = /** @class */ (function () {
    function FirebankPaymentPostAddressEntity() {
        /** Cidade do endereço do cliente/pagador */
        this.city = '';
        /** País do endereço do cliente/pagador */
        this.country = '';
        /** Bairro do endereço do cliente/pagador */
        this.neighboor = '';
        /** Número do endereço do cliente/pagador */
        this.number = '';
        /** Estado do endereço do cliente/pagador */
        this.state = '';
        /** Rua/logradouro do endereço do cliente/pagador */
        this.street = '';
        /** CEP do endereço do cliente/pagador */
        this.zipCode = '';
    }
    return FirebankPaymentPostAddressEntity;
}());
exports.FirebankPaymentPostAddressEntity = FirebankPaymentPostAddressEntity;
var FirebankPaymentPostContactEntity = /** @class */ (function () {
    function FirebankPaymentPostContactEntity() {
        /** E-mail de contato do cliente/pagador */
        this.mail = '';
        /** Telefone de contato do cliente/pagador */
        this.phone = '';
    }
    return FirebankPaymentPostContactEntity;
}());
exports.FirebankPaymentPostContactEntity = FirebankPaymentPostContactEntity;
/**
 * Interface principal para o pagamento
 */
var FirebankPaymentPostEntity = /** @class */ (function () {
    function FirebankPaymentPostEntity() {
        /** Informações do pagador */
        this.payer = new FirebankPaymentPostPayerEntity();
        /** Lista de beneficiários a receber um valor pré-configurado após a cobrança ser efetivamente paga */
        this.splits = [];
        /** Informações da transação */
        this.transaction = new FirebankPaymentPostTransactionEntity();
        /** Tipo da operação. Sempre enviar "PIX" como valor padrão */
        this.type = 'PIX';
    }
    return FirebankPaymentPostEntity;
}());
exports.FirebankPaymentPostEntity = FirebankPaymentPostEntity;
/**
 * Interface para o pagador
 */
var FirebankPaymentPostPayerEntity = /** @class */ (function () {
    function FirebankPaymentPostPayerEntity() {
        /** Endereço do pagador */
        this.address = new FirebankPaymentPostAddressEntity();
        /** Informações de contato do pagador */
        this.contact = new FirebankPaymentPostContactEntity();
        /** Documentação do cliente/pagador, CPF ou CNPJ */
        this.document = '';
        /** Nome do cliente/pagador */
        this.fullName = '';
    }
    return FirebankPaymentPostPayerEntity;
}());
exports.FirebankPaymentPostPayerEntity = FirebankPaymentPostPayerEntity;
/**
 * Interface para o split (beneficiário)
 */
var FirebankPaymentPostSplitEntity = /** @class */ (function () {
    function FirebankPaymentPostSplitEntity() {
        /**
         * Valor fixo a ser enviado.
         * Este valor pode ser somado automaticamente com o valor percentual (percent).
         * Este valor não pode ser maior do que o valor líquido recebido pela cobrança.
         */
        this.amount = 0;
        /** CPF ou CNPJ do beneficiário */
        this.document = '';
        /** Identificador único para que possa ser usado em caso de alteração/cancelamento do pagamento split */
        this.externalId = '';
        /**
         * Valor em percentual a ser enviado. Por exemplo: caso a cobrança seja de R$10,00 (dez reais)
         * e seja informado o valor "10" no campo percent, então será considerado 10% sobre R$10,00, que é R$1,00.
         * Este valor pode ser somado automaticamente com o valor fixo (amount).
         * Este valor não pode ser maior do que o valor líquido recebido pela cobrança.
         */
        this.percent = 0;
        /** Chave PIX do beneficiário */
        this.pixKey = '';
        /**
         * Tipo da chave PIX do beneficiário.
         * Podendo ser dos tipos: "RANDOM_KEY" (chave-aleatória), "DOCUMENT" (CPF ou CNPJ) ou "EMAIL" (e-mail)
         */
        this.pixKeyType = enums_1.EFirebankWithdrawDetailsKey.RANDOM_KEY;
    }
    return FirebankPaymentPostSplitEntity;
}());
exports.FirebankPaymentPostSplitEntity = FirebankPaymentPostSplitEntity;
/**
 * Interface para a transação
 */
var FirebankPaymentPostTransactionEntity = /** @class */ (function () {
    function FirebankPaymentPostTransactionEntity() {
        /** Descrição da cobrança */
        this.description = '';
        /** Data de expiração da cobrança */
        this.dueDate = '';
        /** Identificador único para ser usado como rastreio das cobranças no envio do Webhook */
        this.externalId = '';
        /** Valor da transação. Aceita valores quebrados, separados por ponto, como 123.45, representando R$123,45 */
        this.value = 0;
    }
    return FirebankPaymentPostTransactionEntity;
}());
exports.FirebankPaymentPostTransactionEntity = FirebankPaymentPostTransactionEntity;