@postpaybr/protos 1.1.0

package/src/typescript/payment-gateway.ts

@@ -0,0 +1,209 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.0
+//   protoc               v6.32.1
+// source: payment-gateway.proto
+
+/* eslint-disable */
+import {
+  GatewayIdentification,
+  PaymentMethods,
+} from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'paymentGateway';
+
+export interface PaymentGateway {
+  id: string;
+  name: string;
+  gatewayId: GatewayIdentification;
+  supportsPix: boolean;
+  supportsCreditCard: boolean;
+  supportsDebitCard: boolean;
+  supportsAutomaticAnticipation: boolean;
+  supportsManualAnticipation: boolean;
+  isActive: boolean;
+  description: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface PaymentGatewayResponse {
+  paymentGateway: PaymentGateway | undefined;
+}
+
+export interface PaymentGatewayListResponse {
+  gateways: PaymentGateway[];
+}
+
+export interface GetByIdRequest {
+  id: string;
+}
+
+export interface GetByGatewayIdRequest {
+  gatewayId: GatewayIdentification;
+}
+
+export interface GetGatewaysByMethodSupportRequest {
+  method: PaymentMethods;
+}
+
+export interface CreateGatewayRequest {
+  name: string;
+  gatewayId: GatewayIdentification;
+  supportsPix: boolean;
+  supportsCreditCard: boolean;
+  supportsDebitCard: boolean;
+  supportsAutomaticAnticipation: boolean;
+  supportsManualAnticipation: boolean;
+  isActive: boolean;
+  description: string;
+}
+
+export interface UpdateGatewayRequest {
+  id: string;
+  name?: string | undefined;
+  gatewayId?: GatewayIdentification | undefined;
+  supportsPix?: boolean | undefined;
+  supportsCreditCard?: boolean | undefined;
+  supportsDebitCard?: boolean | undefined;
+  supportsAutomaticAnticipation?: boolean | undefined;
+  supportsManualAnticipation?: boolean | undefined;
+  isActive?: boolean | undefined;
+  description?: string | undefined;
+}
+
+export interface DeactivateGatewayRequest {
+  id: string;
+}
+
+export interface Void {}
+
+export interface TableFilterParams {
+  pageIndex?: number | undefined;
+  pageSize?: number | undefined;
+  statuses?: string[];
+  globalFilter?: string | undefined;
+  startDate?: Date | undefined;
+  endDate?: Date | undefined;
+}
+
+export interface GetAllGatewaysRequest {
+  filter: TableFilterParams | undefined;
+}
+
+export const PAYMENT_GATEWAY_PACKAGE_NAME = 'paymentGateway';
+
+export interface PaymentGatewayServiceClient {
+  getById(request: GetByIdRequest): Observable<PaymentGatewayResponse>;
+
+  getByGatewayId(
+    request: GetByGatewayIdRequest,
+  ): Observable<PaymentGatewayResponse>;
+
+  getAllGateways(
+    request: GetAllGatewaysRequest,
+  ): Observable<PaymentGatewayListResponse>;
+
+  getGatewaysByMethodSupport(
+    request: GetGatewaysByMethodSupportRequest,
+  ): Observable<PaymentGatewayListResponse>;
+
+  createGateway(
+    request: CreateGatewayRequest,
+  ): Observable<PaymentGatewayResponse>;
+
+  updateGateway(
+    request: UpdateGatewayRequest,
+  ): Observable<PaymentGatewayResponse>;
+
+  deactivateGateway(request: DeactivateGatewayRequest): Observable<Void>;
+}
+
+export interface PaymentGatewayServiceController {
+  getById(
+    request: GetByIdRequest,
+  ):
+    | Promise<PaymentGatewayResponse>
+    | Observable<PaymentGatewayResponse>
+    | PaymentGatewayResponse;
+
+  getByGatewayId(
+    request: GetByGatewayIdRequest,
+  ):
+    | Promise<PaymentGatewayResponse>
+    | Observable<PaymentGatewayResponse>
+    | PaymentGatewayResponse;
+
+  getAllGateways(
+    request: GetAllGatewaysRequest,
+  ):
+    | Promise<PaymentGatewayListResponse>
+    | Observable<PaymentGatewayListResponse>
+    | PaymentGatewayListResponse;
+
+  getGatewaysByMethodSupport(
+    request: GetGatewaysByMethodSupportRequest,
+  ):
+    | Promise<PaymentGatewayListResponse>
+    | Observable<PaymentGatewayListResponse>
+    | PaymentGatewayListResponse;
+
+  createGateway(
+    request: CreateGatewayRequest,
+  ):
+    | Promise<PaymentGatewayResponse>
+    | Observable<PaymentGatewayResponse>
+    | PaymentGatewayResponse;
+
+  updateGateway(
+    request: UpdateGatewayRequest,
+  ):
+    | Promise<PaymentGatewayResponse>
+    | Observable<PaymentGatewayResponse>
+    | PaymentGatewayResponse;
+
+  deactivateGateway(
+    request: DeactivateGatewayRequest,
+  ): Promise<Void> | Observable<Void> | Void;
+}
+
+export function PaymentGatewayServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'getById',
+      'getByGatewayId',
+      'getAllGateways',
+      'getGatewaysByMethodSupport',
+      'createGateway',
+      'updateGateway',
+      'deactivateGateway',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('PaymentGatewayService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('PaymentGatewayService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const PAYMENT_GATEWAY_SERVICE_NAME = 'PaymentGatewayService';

package/src/typescript/payment-pix.ts

@@ -0,0 +1,170 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.6.0
+//   protoc               v3.20.3
+// source: payment-pix.proto
+
+/* eslint-disable */
+import {
+  brandType,
+  GatewayIdentification,
+  Meta,
+  MetaType,
+  PaymentMethods,
+  PaymentScheduleType,
+  TaxStatus,
+  TaxTypes,
+} from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'paymentPix';
+
+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 Address {
+  street: string;
+  number: string;
+  complement: string;
+  neighborhood: string;
+  city: string;
+  state: string;
+  zipCode: 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 Order {
+  id: string;
+  totalAmount: number;
+  status: string;
+  createdAt: Date;
+}
+
+export interface CreatePaymentResponse {
+  order: Order | undefined;
+  orderType: string;
+  chargeId: string;
+}
+
+export const PAYMENT_PIX_PACKAGE_NAME = 'paymentPix';
+
+export interface PaymentPixClient {
+  createPayment(
+    request: CreatePaymentRequest,
+  ): Observable<CreatePaymentResponse>;
+}
+
+export interface PaymentPixController {
+  createPayment(
+    request: CreatePaymentRequest,
+  ):
+    | Promise<CreatePaymentResponse>
+    | Observable<CreatePaymentResponse>
+    | CreatePaymentResponse;
+}
+
+export function PaymentPixControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = ['createPayment'];
+    for (const method of grpcMethods) {
+      1;
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('PaymentPix', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('PaymentPix', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const PAYMENT_SERVICE_PIX_SERVICE_NAME = 'PaymentPix';

package/src/typescript/receipt.ts

@@ -0,0 +1,344 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.0
+//   protoc               v3.20.3
+// source: receipt.proto
+
+/* eslint-disable */
+import {
+  ChargeStatus,
+  PaymentMethods,
+  ReceiptMetadata,
+  TaxTypes,
+} from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+import { ChargeScheduleDetail } from './charge';
+
+export const protobufPackage = 'receipt';
+
+export interface CreateReceiptRequest {
+  customerId: string;
+  data: CreateReceiptDto | undefined;
+}
+
+export interface GetReceiptRequest {
+  customerId: string;
+  id: string;
+}
+
+export interface GetAllReceiptsRequest {
+  customerId: string;
+  dateFilter: DateFilter | undefined;
+  pagination: PaginationFilter | undefined;
+}
+
+export interface UpdateTxidRequest {
+  chargeId: string;
+  txid: string;
+}
+
+export interface PaymentSummaryPreviewRequest {
+  customerId: string;
+  orderId: string;
+  orderType: string;
+}
+
+export interface ReceiptsByTaxIdsRequest {
+  taxIds: string[];
+}
+
+export interface GetReceiptByIdRequest {
+  id: string;
+}
+
+export interface ReceiptResponse {
+  id: string;
+  amount: number;
+  protocol: string;
+  txid: string;
+  createdAt: Date;
+
+  customerId: string;
+  taxId: string;
+  chargeId?: string | undefined;
+  isNfseIssued: boolean;
+  metadata?: ReceiptMetadata | undefined;
+}
+
+export interface ReceiptDetailResponse {
+  id: string;
+  createdAt: string;
+  method: string;
+  discountPercentage: number;
+  discountAmount: number;
+  fee: number;
+  fine: number;
+  amount: number;
+  protocol: string;
+  txid: string;
+  tax: TaxDetail | undefined;
+}
+
+export interface ReceiptsListResponse {
+  receipts: ReceiptListItem[];
+  count: number;
+}
+
+export interface ReceiptListItem {
+  id: string;
+  recipient: string;
+  paymentDate: Date;
+  amount: number;
+  method: string;
+  taxType: string;
+}
+
+export interface ReceiptsResponse {
+  receipts: ReceiptResponse[];
+}
+
+export interface PaymentSummaryPreviewResponse {
+  summary: PaymentSummary | undefined;
+  paymentsMade?: IndividualPayment[];
+  scheduledPayments?: IndividualPayment[];
+}
+
+export interface CreateReceiptDto {
+  amount: number;
+  protocol: string;
+  chargeId: string;
+  taxId: string;
+  txid: string;
+}
+
+export interface DateFilter {
+  startDate?: Date | undefined;
+  endDate?: Date | undefined;
+}
+
+export interface PaginationFilter {
+  limit?: number | undefined;
+  offset?: number | undefined;
+}
+
+export interface TaxDetail {
+  tax: reducedTax | undefined;
+  payer: Payer | undefined;
+  location: LocationInfo | undefined;
+  metaType: string;
+  meta: Meta | undefined;
+  items: TaxItem[];
+}
+
+export interface Meta {
+  address?: Address | undefined;
+  licensePlate?: string | undefined;
+  model?: string | undefined;
+  yearManufacture?: number | undefined;
+  renavam?: string | undefined;
+}
+
+export interface Address {
+  street: string;
+  number: string;
+  complement: string;
+  neighborhood: string;
+  city: string;
+  state: string;
+  zipCode: string;
+}
+
+export interface reducedTax {
+  id: string;
+  type: string;
+  description: string;
+  year: number;
+  documentId: string;
+}
+
+export interface LocationInfo {
+  state: number;
+  city: number;
+  recipientId: string;
+}
+
+export interface TaxItem {
+  id: string;
+  code: string;
+  quota: number;
+  dueAt: string;
+  amount: number;
+  isSingleQuota: boolean;
+  status: string;
+  discountPercentage: number;
+  discountAmount: number;
+  fee: number;
+  fine: number;
+}
+
+export interface Payer {
+  name: string;
+  document: string;
+}
+
+export interface PaymentSummary {
+  totalPaymentsMade?: number | undefined;
+  totalScheduledPayments?: number | undefined;
+  timestamp: string;
+}
+
+export interface IndividualPayment {
+  id: string;
+  createdAt: Date;
+  paymentMethod: PaymentMethods;
+  propertyDocument: string;
+  propertyDetail: string;
+  installmentNumber: number;
+  installmentValue: number;
+  schedule?: ChargeScheduleDetail | undefined;
+  taxType: TaxTypes;
+  status: ChargeStatus;
+}
+
+export interface deleteReceiptByChargeIdRequest {
+  chargeId: string;
+}
+
+export interface DeleteReceiptsResponse {
+  affected: number;
+}
+
+export const RECEIPT_PACKAGE_NAME = 'receipt';
+
+export interface ReceiptServiceClient {
+  createReceipt(request: CreateReceiptRequest): Observable<ReceiptResponse>;
+
+  getReceipt(request: GetReceiptRequest): Observable<ReceiptDetailResponse>;
+
+  getAllReceipts(
+    request: GetAllReceiptsRequest,
+  ): Observable<ReceiptsListResponse>;
+
+  updateTxidByChargeId(
+    request: UpdateTxidRequest,
+  ): Observable<ReceiptsResponse>;
+
+  getPaymentSummaryPreview(
+    request: PaymentSummaryPreviewRequest,
+  ): Observable<PaymentSummaryPreviewResponse>;
+
+  getReceiptsByTaxIds(
+    request: ReceiptsByTaxIdsRequest,
+  ): Observable<ReceiptsResponse>;
+
+  getReceiptsByTaxIdsExcludingSeeded(
+    request: ReceiptsByTaxIdsRequest,
+  ): Observable<ReceiptsResponse>;
+
+  getReceiptById(request: GetReceiptByIdRequest): Observable<ReceiptResponse>;
+
+  deleteReceiptByChargeId(
+    request: deleteReceiptByChargeIdRequest,
+  ): Observable<DeleteReceiptsResponse>;
+}
+
+export interface ReceiptServiceController {
+  createReceipt(
+    request: CreateReceiptRequest,
+  ): Promise<ReceiptResponse> | Observable<ReceiptResponse> | ReceiptResponse;
+
+  getReceipt(
+    request: GetReceiptRequest,
+  ):
+    | Promise<ReceiptDetailResponse>
+    | Observable<ReceiptDetailResponse>
+    | ReceiptDetailResponse;
+
+  getAllReceipts(
+    request: GetAllReceiptsRequest,
+  ):
+    | Promise<ReceiptsListResponse>
+    | Observable<ReceiptsListResponse>
+    | ReceiptsListResponse;
+
+  updateTxidByChargeId(
+    request: UpdateTxidRequest,
+  ):
+    | Promise<ReceiptsResponse>
+    | Observable<ReceiptsResponse>
+    | ReceiptsResponse;
+
+  getPaymentSummaryPreview(
+    request: PaymentSummaryPreviewRequest,
+  ):
+    | Promise<PaymentSummaryPreviewResponse>
+    | Observable<PaymentSummaryPreviewResponse>
+    | PaymentSummaryPreviewResponse;
+
+  getReceiptsByTaxIds(
+    request: ReceiptsByTaxIdsRequest,
+  ):
+    | Promise<ReceiptsResponse>
+    | Observable<ReceiptsResponse>
+    | ReceiptsResponse;
+
+  getReceiptsByTaxIdsExcludingSeeded(
+    request: ReceiptsByTaxIdsRequest,
+  ):
+    | Promise<ReceiptsResponse>
+    | Observable<ReceiptsResponse>
+    | ReceiptsResponse;
+
+  getReceiptById(
+    request: GetReceiptByIdRequest,
+  ): Promise<ReceiptResponse> | Observable<ReceiptResponse> | ReceiptResponse;
+
+  deleteReceiptByChargeId(
+    request: deleteReceiptByChargeIdRequest,
+  ):
+    | Promise<DeleteReceiptsResponse>
+    | Observable<DeleteReceiptsResponse>
+    | DeleteReceiptsResponse;
+}
+
+export function ReceiptServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'createReceipt',
+      'getReceipt',
+      'getAllReceipts',
+      'updateTxidByChargeId',
+      'getPaymentSummaryPreview',
+      'getReceiptsByTaxIds',
+      'getReceiptsByTaxIdsExcludingSeeded',
+      'getReceiptById',
+      'deleteReceiptByChargeId',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('ReceiptService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('ReceiptService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const RECEIPT_SERVICE_NAME = 'ReceiptService';