@postpaybr/protos 1.1.0

package/src/typescript/payer.ts

@@ -0,0 +1,68 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.6.0
+//   protoc               v3.20.3
+// source: payer.proto
+
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'payer';
+
+export interface PayerDto {
+  id?: string | undefined;
+  name: string;
+  document: string;
+  phone?: string | undefined;
+}
+
+export interface Payer {
+  id: string;
+  name: string;
+  document: string;
+  phone: string;
+}
+
+export const PAYER_PACKAGE_NAME = 'payer';
+
+export interface PayerServiceClient {
+  findOrCreatePayer(request: PayerDto): Observable<Payer>;
+}
+
+export interface PayerServiceController {
+  findOrCreatePayer(
+    request: PayerDto,
+  ): Promise<Payer> | Observable<Payer> | Payer;
+}
+
+export function PayerServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = ['findOrCreatePayer'];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('PayerService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('PayerService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const PAYER_SERVICE_NAME = 'PayerService';

package/src/typescript/payment-calculator.ts

@@ -0,0 +1,252 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.0
+//   protoc               v6.32.0
+// source: payment-calculator.proto
+
+/* eslint-disable */
+import {
+  brandType,
+  Meta,
+  MetaType,
+  PaymentMethods,
+  PaymentScheduleType,
+  TaxStatus,
+  TaxTypes,
+} from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'paymentCalculator';
+
+export interface CalculateInstallmentsRequest {
+  customerId: string;
+  count: number;
+}
+
+export interface CalculateInstallmentsResponse {
+  installments: Installment[];
+}
+
+export interface Installment {
+  installment: number;
+  amount: number;
+  fee: number;
+  totalAmount: number;
+  baseAmount: number;
+}
+
+export interface GetPaymentMethodsRequest {
+  customerId: string;
+  paymentSchedule: PaymentSchedule | undefined;
+}
+
+export interface GetPaymentMethodsResponse {
+  methods: PaymentDetails[];
+}
+
+export interface PaymentDetails {
+  method: PaymentMethods;
+  amount: number;
+  fee: number;
+  discountPercentage?: number | undefined;
+  discountAmount?: number | undefined;
+  card?: CardDetails | undefined;
+  paymentSchedule: PaymentSchedule | undefined;
+  baseFee: number;
+  feePercentage: number;
+  chargeId?: string | undefined;
+  isRetry?: boolean | undefined;
+  orderId?: string | undefined;
+}
+
+export interface CardDetails {
+  id: string;
+  shadowNumber: string;
+  brand: brandType;
+  installments?: number | undefined;
+  installmentValue?: number | undefined;
+  nickname?: string | undefined;
+}
+
+export interface GetPrincipalMethodRequest {
+  customerId: string;
+  paymentSchedule: PaymentSchedule | undefined;
+}
+
+export interface GetPrincipalMethodResponse {
+  principalMethod: PaymentDetails | undefined;
+}
+
+export interface CalculatePostpayFeeRequest {
+  taxes: TaxDetail[];
+  paymentDetails: PaymentDetails | undefined;
+}
+
+export interface CalculatePostpayFeeResponse {
+  totalPostpayFee: number;
+}
+
+export interface TaxDetail {
+  tax: Tax | undefined;
+  payer: Payer | undefined;
+  location: LocationInfo | undefined;
+  metaType: MetaType;
+  meta: Meta | undefined;
+}
+
+export interface Tax {
+  id: string;
+  type: TaxTypes;
+  status: TaxStatus;
+  description: string;
+  amount: number;
+  year: number;
+  dueAt: string;
+  documentId: string;
+  code: string;
+  isSingleQuota: boolean;
+  quota?: number | undefined;
+  fee: number;
+  fine: number;
+  discountAmount: number;
+}
+
+export interface LocationInfo {
+  state: number;
+  city: number;
+  recipientId: string;
+}
+
+export interface Payer {
+  id?: string | undefined;
+  name: string;
+  document: string;
+  phone?: string | undefined;
+}
+
+export interface PaymentSchedule {
+  type: PaymentScheduleType;
+  date?: string | undefined;
+}
+
+export interface CalculateIndividualTaxFeesRequest {
+  taxes: TaxDetail[];
+  recipientId: string;
+  method: PaymentMethods;
+  brand?: brandType | undefined;
+  installment: number;
+}
+
+export interface CalculateIndividualTaxFeesResponse {
+  feesPerTax: IndividualFeePerTax[];
+  totalFee: number;
+  totalAmount: number;
+  baseFee: number;
+  feePercentage: number;
+}
+
+export interface IndividualFeePerTax {
+  taxId: string;
+  amount: number;
+  fee: number;
+  totalAmount: number;
+}
+
+export const PAYMENT_CALCULATOR_PACKAGE_NAME = 'paymentCalculator';
+
+export interface PaymentCalculatorServiceClient {
+  calculateInstallments(
+    request: CalculateInstallmentsRequest,
+  ): Observable<CalculateInstallmentsResponse>;
+
+  getPaymentMethods(
+    request: GetPaymentMethodsRequest,
+  ): Observable<GetPaymentMethodsResponse>;
+
+  getPrincipalMethod(
+    request: GetPrincipalMethodRequest,
+  ): Observable<GetPrincipalMethodResponse>;
+
+  calculatePostpayFee(
+    request: CalculatePostpayFeeRequest,
+  ): Observable<CalculatePostpayFeeResponse>;
+
+  calculateIndividualTaxFees(
+    request: CalculateIndividualTaxFeesRequest,
+  ): Observable<CalculateIndividualTaxFeesResponse>;
+}
+
+export interface PaymentCalculatorServiceController {
+  calculateInstallments(
+    request: CalculateInstallmentsRequest,
+  ):
+    | Promise<CalculateInstallmentsResponse>
+    | Observable<CalculateInstallmentsResponse>
+    | CalculateInstallmentsResponse;
+
+  getPaymentMethods(
+    request: GetPaymentMethodsRequest,
+  ):
+    | Promise<GetPaymentMethodsResponse>
+    | Observable<GetPaymentMethodsResponse>
+    | GetPaymentMethodsResponse;
+
+  getPrincipalMethod(
+    request: GetPrincipalMethodRequest,
+  ):
+    | Promise<GetPrincipalMethodResponse>
+    | Observable<GetPrincipalMethodResponse>
+    | GetPrincipalMethodResponse;
+
+  calculatePostpayFee(
+    request: CalculatePostpayFeeRequest,
+  ):
+    | Promise<CalculatePostpayFeeResponse>
+    | Observable<CalculatePostpayFeeResponse>
+    | CalculatePostpayFeeResponse;
+
+  calculateIndividualTaxFees(
+    request: CalculateIndividualTaxFeesRequest,
+  ):
+    | Promise<CalculateIndividualTaxFeesResponse>
+    | Observable<CalculateIndividualTaxFeesResponse>
+    | CalculateIndividualTaxFeesResponse;
+}
+
+export function PaymentCalculatorServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'calculateInstallments',
+      'getPaymentMethods',
+      'getPrincipalMethod',
+      'calculatePostpayFee',
+      'calculateIndividualTaxFees',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('PaymentCalculatorService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('PaymentCalculatorService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const PAYMENT_CALCULATOR_SERVICE_NAME = 'PaymentCalculatorService';

package/src/typescript/payment-card.ts

@@ -0,0 +1,290 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.0
+//   protoc               v3.20.3
+// source: payment-card.proto
+
+/* eslint-disable */
+import { HolderType, RecipientLegalType } from '@postpaybr/contracts/enums';
+import {
+  brandType,
+  ChargeMetadata,
+  ChargeStatus,
+  ChargeType,
+  FailureReason,
+  GatewayIdentification,
+  Meta,
+  MetaType,
+  PaymentMethods,
+  PaymentScheduleType,
+  TaxStatus,
+  TaxTypes,
+} from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'paymentCard';
+
+export interface CreatePaymentRequest {
+  customerId: string;
+  taxes: TaxPayload[];
+  payment: PaymentDetails | undefined;
+  closed?: boolean | undefined;
+  ip?: string | undefined;
+  sessionId?: string | undefined;
+  pushToken: string;
+}
+
+export interface TaxPayload {
+  tax: Tax | undefined;
+  payer: Payer | undefined;
+  location: Location | undefined;
+  metaType: MetaType;
+  meta: Meta | undefined;
+}
+
+export interface Tax {
+  id: string;
+  type: TaxTypes;
+  status: TaxStatus;
+  description: string;
+  amount: number;
+  year: number;
+  dueAt: string;
+  documentId: string;
+  code: string;
+  isSingleQuota: boolean;
+  quota?: number | undefined;
+  fee: number;
+  fine: number;
+  discountAmount: number;
+}
+
+export interface Payer {
+  id?: string | undefined;
+  name: string;
+  document: string;
+  phone?: string | undefined;
+}
+
+export interface Location {
+  state: number;
+  city: number;
+  recipientId: string;
+}
+
+export interface PaymentDetails {
+  method: PaymentMethods;
+  amount: number;
+  discountPercentage?: number | undefined;
+  fee: number;
+  discountAmount?: number | undefined;
+  gatewayId?: GatewayIdentification | undefined;
+  card?: Card | undefined;
+  paymentSchedule: PaymentSchedule | undefined;
+  baseFee: number;
+  feePercentage: number;
+  chargeId?: string | undefined;
+  isRetry?: boolean | undefined;
+  orderId?: string | undefined;
+}
+
+export interface PaymentSchedule {
+  type: PaymentScheduleType;
+  date?: string | undefined;
+}
+
+export interface Card {
+  id: string;
+  shadowNumber: string;
+  brand: brandType;
+  installments?: number | undefined;
+  installmentValue?: number | undefined;
+}
+
+export interface CreatePaymentResponse {
+  order: Order | undefined;
+  orderType: TaxTypes;
+}
+
+export interface ProcessScheduledPaymentRequest {
+  customerId: string;
+  tax: TaxPayload;
+  charge: Charge | undefined;
+  payment: PaymentDetails | undefined;
+}
+
+export interface ProcessScheduledPaymentResponse {}
+
+export interface CreateVerificationPaymentRequest {
+  customerId: string;
+  card: CardDetails | undefined;
+  value: number;
+  cardVerificationId?: string | undefined;
+}
+
+export interface CardDetails {
+  id?: string;
+  vaultToken: string;
+  vaultTokenCvv: string;
+}
+
+export interface CreateVerificationPaymentResponse {}
+
+export interface Charge {
+  id: string;
+  amount: number;
+  paymentMethod: PaymentMethods;
+  status: ChargeStatus;
+  dueAt: string;
+  txid: string;
+  brcode: string;
+  pushToken: string;
+  installmentNumber: number;
+  installmentValue: number;
+  fee: number;
+  baseFee: number;
+  feePercentage: number;
+  isScheduled: boolean;
+  discountPercentage: number;
+  discountAmount: number;
+  createdAt: Date;
+  gatewayId: GatewayIdentification;
+  cardId: string;
+  orderId: string;
+  orderScheduleId: string;
+  payableIds: string[];
+  taxId?: string;
+  recipientId?: string;
+  chargeSchedule?: ChargeSchedule | undefined;
+  endToEndId: string;
+  type: ChargeType;
+  metadata: ChargeMetadata | undefined;
+}
+
+export interface ChargeSchedule {
+  id: string;
+  executionDate: Date;
+  isExecuted: boolean;
+  createdAt: Date;
+  updatedAt: Date;
+  charge: Charge | undefined;
+}
+
+export interface Recipient {
+  id: string;
+  code: string;
+  commercialName: string;
+  socialReason: string;
+  holderType: HolderType;
+  document: string;
+  cnaeId: string;
+  legalType: RecipientLegalType;
+  contactName: string;
+  contactEmail: string;
+  contactPhone: string;
+  isAutomaticAnticipationEnabled: boolean;
+  foundation: string;
+  avatarUrl?: string | undefined;
+}
+
+export interface Order {
+  id: string;
+  totalAmount: number;
+  status: string;
+  createdAt: Date;
+  items: OrderItemEntity[];
+  charges: Charge[];
+  customer: Customer | undefined;
+}
+
+export interface OrderItemEntity {
+  id: string;
+  recipient: Recipient | undefined;
+  tax: Tax | undefined;
+  order: Order | undefined;
+}
+
+export interface Customer {
+  id: string;
+  firstName: string;
+  lastName: string;
+  document: string;
+  email: string;
+  isEmailVerified: boolean;
+  phone: string;
+}
+
+export const PAYMENT_CARD_PACKAGE_NAME = 'paymentCard';
+
+export interface PaymentCardClient {
+  createPayment(
+    request: CreatePaymentRequest,
+  ): Observable<CreatePaymentResponse>;
+
+  processScheduledPayment(
+    request: ProcessScheduledPaymentRequest,
+  ): Observable<ProcessScheduledPaymentResponse>;
+
+  createVerificationPayment(
+    request: CreateVerificationPaymentRequest,
+  ): Observable<CreateVerificationPaymentResponse>;
+}
+
+export interface PaymentCardController {
+  createPayment(
+    request: CreatePaymentRequest,
+  ):
+    | Promise<CreatePaymentResponse>
+    | Observable<CreatePaymentResponse>
+    | CreatePaymentResponse;
+
+  processScheduledPayment(
+    request: ProcessScheduledPaymentRequest,
+  ):
+    | Promise<ProcessScheduledPaymentResponse>
+    | Observable<ProcessScheduledPaymentResponse>
+    | ProcessScheduledPaymentResponse;
+
+  createVerificationPayment(
+    request: CreateVerificationPaymentRequest,
+  ):
+    | Promise<CreateVerificationPaymentResponse>
+    | Observable<CreateVerificationPaymentResponse>
+    | CreateVerificationPaymentResponse;
+}
+
+export function PaymentCardControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'createPayment',
+      'processScheduledPayment',
+      'createVerificationPayment',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('PaymentCard', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('PaymentCard', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const PAYMENT_CARD_SERVICE_NAME = 'PaymentCard';