cecon-interfaces
Version:
Interfaces de Projetos Cecon
98 lines • 11.9 kB
JavaScript
/**
* Interface para o contato do pagador
*/
import { EFirebankWithdrawDetailsKey } from '../../enums';
/**
* Interface para o endereço do pagador
*/
export class FirebankPaymentPostAddressEntity {
/** Cidade do endereço do cliente/pagador */
city = '';
/** País do endereço do cliente/pagador */
country = '';
/** Bairro do endereço do cliente/pagador */
neighboor = '';
/** Número do endereço do cliente/pagador */
number = '';
/** Estado do endereço do cliente/pagador */
state = '';
/** Rua/logradouro do endereço do cliente/pagador */
street = '';
/** CEP do endereço do cliente/pagador */
zipCode = '';
}
export class FirebankPaymentPostContactEntity {
/** E-mail de contato do cliente/pagador */
mail = '';
/** Telefone de contato do cliente/pagador */
phone = '';
}
/**
* Interface principal para o pagamento
*/
export class FirebankPaymentPostEntity {
/** Informações do pagador */
payer = new FirebankPaymentPostPayerEntity();
/** Lista de beneficiários a receber um valor pré-configurado após a cobrança ser efetivamente paga */
splits = [];
/** Informações da transação */
transaction = new FirebankPaymentPostTransactionEntity();
/** Tipo da operação. Sempre enviar "PIX" como valor padrão */
type = 'PIX';
}
/**
* Interface para o pagador
*/
export class FirebankPaymentPostPayerEntity {
/** Endereço do pagador */
address = new FirebankPaymentPostAddressEntity();
/** Informações de contato do pagador */
contact = new FirebankPaymentPostContactEntity();
/** Documentação do cliente/pagador, CPF ou CNPJ */
document = '';
/** Nome do cliente/pagador */
fullName = '';
}
/**
* Interface para o split (beneficiário)
*/
export class 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.
*/
amount = 0;
/** CPF ou CNPJ do beneficiário */
document = '';
/** Identificador único para que possa ser usado em caso de alteração/cancelamento do pagamento split */
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.
*/
percent = 0;
/** Chave PIX do beneficiário */
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)
*/
pixKeyType = EFirebankWithdrawDetailsKey.RANDOM_KEY;
}
/**
* Interface para a transação
*/
export class FirebankPaymentPostTransactionEntity {
/** Descrição da cobrança */
description = '';
/** Data de expiração da cobrança */
dueDate = '';
/** Identificador único para ser usado como rastreio das cobranças no envio do Webhook */
externalId = '';
/** Valor da transação. Aceita valores quebrados, separados por ponto, como 123.45, representando R$123,45 */
value = 0;
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"payment-post.entity.js","sourceRoot":"","sources":["../../../../../src/firebank/entities/payment/payment-post.entity.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAU1D;;GAEG;AACH,MAAM,OAAO,gCAAgC;IAC3C,4CAA4C;IACrC,IAAI,GAAY,EAAE,CAAC;IAE1B,0CAA0C;IACnC,OAAO,GAAY,EAAE,CAAC;IAE7B,4CAA4C;IACrC,SAAS,GAAY,EAAE,CAAC;IAE/B,4CAA4C;IACrC,MAAM,GAAY,EAAE,CAAC;IAE5B,4CAA4C;IACrC,KAAK,GAAY,EAAE,CAAC;IAE3B,oDAAoD;IAC7C,MAAM,GAAY,EAAE,CAAC;IAE5B,yCAAyC;IAClC,OAAO,GAAY,EAAE,CAAC;CAC9B;AAED,MAAM,OAAO,gCAAgC;IAC3C,2CAA2C;IACpC,IAAI,GAAY,EAAE,CAAC;IAE1B,6CAA6C;IACtC,KAAK,GAAY,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,OAAO,yBAAyB;IACpC,6BAA6B;IACtB,KAAK,GAAmC,IAAI,8BAA8B,EAAE,CAAC;IAEpF,sGAAsG;IAC/F,MAAM,GAAqC,EAAE,CAAC;IAErD,+BAA+B;IACxB,WAAW,GAAyC,IAAI,oCAAoC,EAAE,CAAC;IAEtG,8DAA8D;IACvD,IAAI,GAAU,KAAK,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,OAAO,8BAA8B;IACzC,0BAA0B;IACnB,OAAO,GAAsC,IAAI,gCAAgC,EAAE,CAAC;IAE3F,wCAAwC;IACjC,OAAO,GAAsC,IAAI,gCAAgC,EAAE,CAAC;IAE3F,mDAAmD;IAC5C,QAAQ,GAAW,EAAE,CAAC;IAE7B,8BAA8B;IACvB,QAAQ,GAAW,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,OAAO,8BAA8B;IACzC;;;;OAIG;IACI,MAAM,GAAW,CAAC,CAAC;IAE1B,kCAAkC;IAC3B,QAAQ,GAAW,EAAE,CAAC;IAE7B,wGAAwG;IACjG,UAAU,GAAW,EAAE,CAAC;IAE/B;;;;;OAKG;IACI,OAAO,GAAW,CAAC,CAAC;IAE3B,gCAAgC;IACzB,MAAM,GAAW,EAAE,CAAC;IAE3B;;;OAGG;IACI,UAAU,GAAgC,2BAA2B,CAAC,UAAU,CAAC;CACzF;AAED;;GAEG;AACH,MAAM,OAAO,oCAAoC;IAC/C,4BAA4B;IACrB,WAAW,GAAY,EAAE,CAAC;IAEjC,oCAAoC;IAC7B,OAAO,GAAY,EAAE,CAAC;IAE7B,yFAAyF;IAClF,UAAU,GAAY,EAAE,CAAC;IAEhC,6GAA6G;IACtG,KAAK,GAAW,CAAC,CAAC;CAC1B","sourcesContent":["/**\r\n * Interface para o contato do pagador\r\n */\r\nimport { EFirebankWithdrawDetailsKey } from '../../enums';\r\nimport {\r\n  IFirebankPaymentPost,\r\n  IFirebankPaymentPostAddress,\r\n  IFirebankPaymentPostContact,\r\n  IFirebankPaymentPostPayer,\r\n  IFirebankPaymentPostSplit,\r\n  IFirebankPaymentPostTransaction,\r\n} from '../../interfaces';\r\n\r\n/**\r\n * Interface para o endereço do pagador\r\n */\r\nexport class FirebankPaymentPostAddressEntity implements IFirebankPaymentPostAddress {\r\n  /** Cidade do endereço do cliente/pagador */\r\n  public city?: string = '';\r\n\r\n  /** País do endereço do cliente/pagador */\r\n  public country?: string = '';\r\n\r\n  /** Bairro do endereço do cliente/pagador */\r\n  public neighboor?: string = '';\r\n\r\n  /** Número do endereço do cliente/pagador */\r\n  public number?: string = '';\r\n\r\n  /** Estado do endereço do cliente/pagador */\r\n  public state?: string = '';\r\n\r\n  /** Rua/logradouro do endereço do cliente/pagador */\r\n  public street?: string = '';\r\n\r\n  /** CEP do endereço do cliente/pagador */\r\n  public zipCode?: string = '';\r\n}\r\n\r\nexport class FirebankPaymentPostContactEntity implements IFirebankPaymentPostContact {\r\n  /** E-mail de contato do cliente/pagador */\r\n  public mail?: string = '';\r\n\r\n  /** Telefone de contato do cliente/pagador */\r\n  public phone?: string = '';\r\n}\r\n\r\n/**\r\n * Interface principal para o pagamento\r\n */\r\nexport class FirebankPaymentPostEntity implements IFirebankPaymentPost {\r\n  /** Informações do pagador */\r\n  public payer: FirebankPaymentPostPayerEntity = new FirebankPaymentPostPayerEntity();\r\n\r\n  /** Lista de beneficiários a receber um valor pré-configurado após a cobrança ser efetivamente paga */\r\n  public splits: FirebankPaymentPostSplitEntity[] = [];\r\n\r\n  /** Informações da transação */\r\n  public transaction: FirebankPaymentPostTransactionEntity = new FirebankPaymentPostTransactionEntity();\r\n\r\n  /** Tipo da operação. Sempre enviar \"PIX\" como valor padrão */\r\n  public type: 'PIX' = 'PIX';\r\n}\r\n\r\n/**\r\n * Interface para o pagador\r\n */\r\nexport class FirebankPaymentPostPayerEntity implements IFirebankPaymentPostPayer {\r\n  /** Endereço do pagador */\r\n  public address?: FirebankPaymentPostAddressEntity = new FirebankPaymentPostAddressEntity();\r\n\r\n  /** Informações de contato do pagador */\r\n  public contact?: FirebankPaymentPostContactEntity = new FirebankPaymentPostContactEntity();\r\n\r\n  /** Documentação do cliente/pagador, CPF ou CNPJ */\r\n  public document: string = '';\r\n\r\n  /** Nome do cliente/pagador */\r\n  public fullName: string = '';\r\n}\r\n\r\n/**\r\n * Interface para o split (beneficiário)\r\n */\r\nexport class FirebankPaymentPostSplitEntity implements IFirebankPaymentPostSplit {\r\n  /**\r\n   * Valor fixo a ser enviado.\r\n   * Este valor pode ser somado automaticamente com o valor percentual (percent).\r\n   * Este valor não pode ser maior do que o valor líquido recebido pela cobrança.\r\n   */\r\n  public amount: number = 0;\r\n\r\n  /** CPF ou CNPJ do beneficiário */\r\n  public document: string = '';\r\n\r\n  /** Identificador único para que possa ser usado em caso de alteração/cancelamento do pagamento split */\r\n  public externalId: string = '';\r\n\r\n  /**\r\n   * Valor em percentual a ser enviado. Por exemplo: caso a cobrança seja de R$10,00 (dez reais)\r\n   * e seja informado o valor \"10\" no campo percent, então será considerado 10% sobre R$10,00, que é R$1,00.\r\n   * Este valor pode ser somado automaticamente com o valor fixo (amount).\r\n   * Este valor não pode ser maior do que o valor líquido recebido pela cobrança.\r\n   */\r\n  public percent: number = 0;\r\n\r\n  /** Chave PIX do beneficiário */\r\n  public pixKey: string = '';\r\n\r\n  /**\r\n   * Tipo da chave PIX do beneficiário.\r\n   * Podendo ser dos tipos: \"RANDOM_KEY\" (chave-aleatória), \"DOCUMENT\" (CPF ou CNPJ) ou \"EMAIL\" (e-mail)\r\n   */\r\n  public pixKeyType: EFirebankWithdrawDetailsKey = EFirebankWithdrawDetailsKey.RANDOM_KEY;\r\n}\r\n\r\n/**\r\n * Interface para a transação\r\n */\r\nexport class FirebankPaymentPostTransactionEntity implements IFirebankPaymentPostTransaction {\r\n  /** Descrição da cobrança */\r\n  public description?: string = '';\r\n\r\n  /** Data de expiração da cobrança */\r\n  public dueDate?: string = '';\r\n\r\n  /** Identificador único para ser usado como rastreio das cobranças no envio do Webhook */\r\n  public externalId?: string = '';\r\n\r\n  /** Valor da transação. Aceita valores quebrados, separados por ponto, como 123.45, representando R$123,45 */\r\n  public value: number = 0;\r\n}\r\n"]}