@postpaybr/protos 1.1.0

package/src/typescript/recipient-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: recipient-payment-gateway.proto
+
+/* eslint-disable */
+import {
+  GatewayIdentification,
+  PaymentGatewayType,
+  PaymentMethods,
+} from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'recipientPaymentGateway';
+
+export interface RecipientPaymentGateway {
+  id: string;
+  paymentGatewayId: string;
+  gatewayId: GatewayIdentification;
+  type: PaymentGatewayType;
+  isPixEnabled: boolean;
+  isCreditCardEnabled: boolean;
+  isDebitCardEnabled: boolean;
+  isAutomaticAnticipationEnabled: boolean;
+  isManualAnticipationEnabled: boolean;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface PaymentGateway {
+  id: string;
+  name: string;
+  gatewayId: string;
+  supportsPix: boolean;
+  supportsCreditCard: boolean;
+  supportsDebitCard: boolean;
+  supportsAutomaticAnticipation: boolean;
+  supportsManualAnticipation: boolean;
+  isActive: boolean;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface RecipientPaymentGatewayResponse {
+  recipientPaymentGateway: RecipientPaymentGateway | undefined;
+}
+
+export interface RecipientPaymentGatewayListResponse {
+  recipientPaymentGateways: RecipientPaymentGateway[] | undefined;
+}
+
+export interface PaymentGatewayListResponse {
+  gateways: PaymentGateway[];
+}
+
+export interface GatewayIdentificationListResponse {
+  gateways: string[];
+}
+
+export interface CreateRecipientPaymentGatewayRequest {
+  recipientId: string;
+  paymentGatewayId: string;
+  type: PaymentGatewayType;
+  isPixEnabled: boolean;
+  isCreditCardEnabled: boolean;
+  isDebitCardEnabled: boolean;
+  isAutomaticAnticipationEnabled: boolean;
+  isManualAnticipationEnabled: boolean;
+}
+
+export interface DeleteRecipientPaymentGatewayRequest {
+  id: string;
+}
+
+export interface GetGatewayByRecipientAndTypeRequest {
+  recipientId: string;
+  method: PaymentMethods;
+  type: PaymentGatewayType;
+}
+
+export interface GetAvailableGatewaysRequest {
+  method: PaymentMethods;
+}
+
+export interface Void {}
+
+export interface TableFilterParams {
+  pageIndex?: number | undefined;
+  pageSize?: number | undefined;
+  status?: string[];
+  globalFilter?: string | undefined;
+  startDate?: Date | undefined;
+  endDate?: Date | undefined;
+}
+
+export interface GetRecipientPaymentGatewaysByRecipientIdRequest {
+  recipientId: string;
+  filter: TableFilterParams | undefined;
+}
+
+export const RECIPIENT_PAYMENT_GATEWAY_PACKAGE_NAME = 'recipientPaymentGateway';
+
+export interface RecipientPaymentGatewayServiceClient {
+  createRecipientPaymentGateway(
+    request: CreateRecipientPaymentGatewayRequest,
+  ): Observable<RecipientPaymentGatewayResponse>;
+
+  deleteRecipientPaymentGateway(
+    request: DeleteRecipientPaymentGatewayRequest,
+  ): Observable<Void>;
+
+  getGatewayByRecipientAndType(
+    request: GetGatewayByRecipientAndTypeRequest,
+  ): Observable<RecipientPaymentGatewayResponse>;
+
+  getAvailableGateways(
+    request: GetAvailableGatewaysRequest,
+  ): Observable<PaymentGatewayListResponse>;
+
+  listGatewayIdentifications(
+    request: Void,
+  ): Observable<GatewayIdentificationListResponse>;
+
+  getRecipientPaymentGatewaysByRecipientId(
+    request: GetRecipientPaymentGatewaysByRecipientIdRequest,
+  ): Observable<RecipientPaymentGatewayListResponse>;
+}
+
+export interface RecipientPaymentGatewayServiceController {
+  createRecipientPaymentGateway(
+    request: CreateRecipientPaymentGatewayRequest,
+  ):
+    | Promise<RecipientPaymentGatewayResponse>
+    | Observable<RecipientPaymentGatewayResponse>
+    | RecipientPaymentGatewayResponse;
+
+  deleteRecipientPaymentGateway(
+    request: DeleteRecipientPaymentGatewayRequest,
+  ): Promise<Void> | Observable<Void> | Void;
+
+  getGatewayByRecipientAndType(
+    request: GetGatewayByRecipientAndTypeRequest,
+  ):
+    | Promise<RecipientPaymentGatewayResponse>
+    | Observable<RecipientPaymentGatewayResponse>
+    | RecipientPaymentGatewayResponse;
+
+  getAvailableGateways(
+    request: GetAvailableGatewaysRequest,
+  ):
+    | Promise<PaymentGatewayListResponse>
+    | Observable<PaymentGatewayListResponse>
+    | PaymentGatewayListResponse;
+
+  listGatewayIdentifications(
+    request: Void,
+  ):
+    | Promise<GatewayIdentificationListResponse>
+    | Observable<GatewayIdentificationListResponse>
+    | GatewayIdentificationListResponse;
+
+  getRecipientPaymentGatewaysByRecipientId(
+    request: GetRecipientPaymentGatewaysByRecipientIdRequest,
+  ):
+    | Promise<RecipientPaymentGatewayListResponse>
+    | Observable<RecipientPaymentGatewayListResponse>
+    | RecipientPaymentGatewayListResponse;
+}
+
+export function RecipientPaymentGatewayServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'createRecipientPaymentGateway',
+      'deleteRecipientPaymentGateway',
+      'getGatewayByRecipientAndType',
+      'getAvailableGateways',
+      'listGatewayIdentifications',
+      'getRecipientPaymentGatewaysByRecipientId',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('RecipientPaymentGatewayService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('RecipientPaymentGatewayService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const RECIPIENT_PAYMENT_GATEWAY_SERVICE_NAME =
+  'RecipientPaymentGatewayService';

package/src/typescript/recipient.ts

@@ -0,0 +1,413 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.0
+//   protoc               v6.32.1
+// source: recipient.proto
+
+/* eslint-disable */
+import {
+  BankAccountType,
+  HolderType,
+  RecipientLegalType,
+} from '@postpaybr/contracts/enums';
+import { GatewayIdentification } from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'recipient';
+
+export interface Recipient {
+  id: string;
+  code: string;
+  commercialName: string;
+  socialReason: string;
+  holderType: HolderType;
+  document: string;
+  cnaeId: string;
+  avatarUrl: string;
+  legalType: RecipientLegalType;
+  foundation: string;
+  contactName: string;
+  contactEmail: string;
+  contactPhone: string;
+  createdAt: Date;
+  updatedAt: Date;
+  addressId: string;
+  isActive: boolean;
+  providerStatus: string;
+}
+
+export interface RecipientResponse {
+  recipient: Recipient | undefined;
+}
+
+export interface GetRecipientByIdRequest {
+  id: string;
+}
+
+export interface GetRecipientByCodeRequest {
+  code: string;
+}
+
+export interface GetRecipientNameByIdRequest {
+  id: string;
+}
+
+export interface RecipientNameResponse {
+  name: string;
+}
+
+export interface Void {}
+
+export interface GetAllRecipientsResponse {
+  recipients: Recipient[];
+}
+
+export interface GetRecipientFeesRequest {
+  id: string;
+}
+
+export interface Fee {
+  id: string;
+  method: string;
+  type: string;
+  base: number;
+  percentage: number;
+  promotionalBase: number;
+  promotionalPercentage: number;
+  description: string;
+  installment: number;
+  isDefault: boolean;
+  brand: string;
+}
+
+export interface RecipientFeesResponse {
+  fees: Fee[];
+}
+
+export interface GetRecipientGatewaysRequest {
+  id: string;
+}
+
+export interface RecipientGateway {
+  id: string;
+  type: string;
+  isAutomaticAnticipationEnabled: boolean;
+  isManualAnticipationEnabled: boolean;
+  isPixEnabled: boolean;
+  isCreditCardEnabled: boolean;
+  isDebitCardEnabled: boolean;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface RecipientGatewaysResponse {
+  gateways: RecipientGateway[];
+}
+
+export interface ImageData {
+  mimetype: string;
+  buffer: Uint8Array;
+}
+
+export interface UpdateRecipientAvatarRequest {
+  id: string;
+  avatar: ImageData | undefined;
+}
+
+export interface GetRecipientDetailsByIdRequest {
+  id: string;
+}
+
+export interface Address {
+  id: string;
+  zipCode: string;
+  street: string;
+  number: string;
+  complement: string;
+  neighborhood: string;
+  city: string;
+  state: string;
+  nickname: string;
+  reference: string;
+}
+
+export interface BankAccount {
+  id: string;
+  bankCompeCode: number;
+  agency: string;
+  account: string;
+  digitAccount: string;
+  balance: number;
+  pixKey?: string;
+  holderType: HolderType;
+  accountType: BankAccountType;
+}
+
+export interface Representative {
+  id: string;
+  name: string;
+  email: string;
+  phone: string;
+  document: string;
+  birthDate: string;
+}
+
+export interface RecipientDetailsResponse {
+  recipient: Recipient | undefined;
+  address: Address | undefined;
+  bankAccount: BankAccount | undefined;
+  representative: Representative | undefined;
+}
+
+export interface CreateRecipientRequest {
+  code: string;
+  commercialName: string;
+  socialReason: string;
+  holderType: HolderType;
+  document: string;
+  cnaeId: string;
+  legalType: RecipientLegalType;
+  contactName: string;
+  contactEmail: string;
+  contactPhone: string;
+  foundation: string;
+  address: CreateAddressDto | undefined;
+  bankAccount: CreateBankAccountDto | undefined;
+  representative: CreateRepresentativeDto | undefined;
+}
+
+export interface CreateAddressDto {
+  state: string;
+  city: string;
+  zipCode: string;
+  neighborhood: string;
+  street: string;
+  number: string;
+  nickname?: string | undefined;
+  complement?: string | undefined;
+  recipientId?: string | undefined;
+  reference?: string | undefined;
+}
+
+export interface CreateBankAccountDto {
+  bankCompeCode: number;
+  holderType: HolderType;
+  agency: string;
+  account: string;
+  digitAccount: string;
+  accountType: BankAccountType;
+  pixKey?: string | undefined;
+  balance?: number;
+}
+
+export interface CreateRepresentativeDto {
+  name: string;
+  email: string;
+  phone: string;
+  document: string;
+  birthDate: string;
+}
+
+export interface UpdateRecipientRequest {
+  id: string;
+  data: CreateRecipientRequest | undefined;
+}
+
+export interface IsAutomaticAnticipationEnabledRequest {
+  recipientId: string;
+  gatewayId: GatewayIdentification;
+}
+
+export interface IsAutomaticAnticipationEnabledResponse {
+  isEnabled: boolean;
+}
+
+export interface GetExternalRecipientIdRequest {
+  recipientId: string;
+  gatewayId: GatewayIdentification;
+}
+
+export interface GetExternalRecipientIdResponse {
+  externalRecipientId: string;
+}
+
+export const RECIPIENT_PACKAGE_NAME = 'recipient';
+
+export interface RecipientServiceClient {
+  createRecipient(
+    request: CreateRecipientRequest,
+  ): Observable<RecipientResponse>;
+
+  updateRecipient(
+    request: UpdateRecipientRequest,
+  ): Observable<RecipientResponse>;
+
+  getRecipientById(
+    request: GetRecipientByIdRequest,
+  ): Observable<RecipientResponse>;
+
+  getRecipientByCode(
+    request: GetRecipientByCodeRequest,
+  ): Observable<RecipientResponse>;
+
+  getRecipientNameById(
+    request: GetRecipientNameByIdRequest,
+  ): Observable<RecipientNameResponse>;
+
+  getAllRecipients(request: Void): Observable<GetAllRecipientsResponse>;
+
+  getRecipientFees(
+    request: GetRecipientFeesRequest,
+  ): Observable<RecipientFeesResponse>;
+
+  getRecipientGateways(
+    request: GetRecipientGatewaysRequest,
+  ): Observable<RecipientGatewaysResponse>;
+
+  updateRecipientAvatar(
+    request: UpdateRecipientAvatarRequest,
+  ): Observable<RecipientResponse>;
+
+  getRecipientDetailsById(
+    request: GetRecipientDetailsByIdRequest,
+  ): Observable<RecipientDetailsResponse>;
+
+  isAutomaticAnticipationEnabled(
+    request: IsAutomaticAnticipationEnabledRequest,
+  ): Observable<IsAutomaticAnticipationEnabledResponse>;
+
+  getExternalRecipientId(
+    request: GetExternalRecipientIdRequest,
+  ): Observable<GetExternalRecipientIdResponse>;
+}
+
+export interface RecipientServiceController {
+  createRecipient(
+    request: CreateRecipientRequest,
+  ):
+    | Promise<RecipientResponse>
+    | Observable<RecipientResponse>
+    | RecipientResponse;
+
+  updateRecipient(
+    request: UpdateRecipientRequest,
+  ):
+    | Promise<RecipientResponse>
+    | Observable<RecipientResponse>
+    | RecipientResponse;
+
+  getRecipientById(
+    request: GetRecipientByIdRequest,
+  ):
+    | Promise<RecipientResponse>
+    | Observable<RecipientResponse>
+    | RecipientResponse;
+
+  getRecipientByCode(
+    request: GetRecipientByCodeRequest,
+  ):
+    | Promise<RecipientResponse>
+    | Observable<RecipientResponse>
+    | RecipientResponse;
+
+  getRecipientNameById(
+    request: GetRecipientNameByIdRequest,
+  ):
+    | Promise<RecipientNameResponse>
+    | Observable<RecipientNameResponse>
+    | RecipientNameResponse;
+
+  getAllRecipients(
+    request: Void,
+  ):
+    | Promise<GetAllRecipientsResponse>
+    | Observable<GetAllRecipientsResponse>
+    | GetAllRecipientsResponse;
+
+  getRecipientFees(
+    request: GetRecipientFeesRequest,
+  ):
+    | Promise<RecipientFeesResponse>
+    | Observable<RecipientFeesResponse>
+    | RecipientFeesResponse;
+
+  getRecipientGateways(
+    request: GetRecipientGatewaysRequest,
+  ):
+    | Promise<RecipientGatewaysResponse>
+    | Observable<RecipientGatewaysResponse>
+    | RecipientGatewaysResponse;
+
+  updateRecipientAvatar(
+    request: UpdateRecipientAvatarRequest,
+  ):
+    | Promise<RecipientResponse>
+    | Observable<RecipientResponse>
+    | RecipientResponse;
+
+  getRecipientDetailsById(
+    request: GetRecipientDetailsByIdRequest,
+  ):
+    | Promise<RecipientDetailsResponse>
+    | Observable<RecipientDetailsResponse>
+    | RecipientDetailsResponse;
+
+  isAutomaticAnticipationEnabled(
+    request: IsAutomaticAnticipationEnabledRequest,
+  ):
+    | Promise<IsAutomaticAnticipationEnabledResponse>
+    | Observable<IsAutomaticAnticipationEnabledResponse>
+    | IsAutomaticAnticipationEnabledResponse;
+
+  getExternalRecipientId(
+    request: GetExternalRecipientIdRequest,
+  ):
+    | Promise<GetExternalRecipientIdResponse>
+    | Observable<GetExternalRecipientIdResponse>
+    | GetExternalRecipientIdResponse;
+}
+
+export function RecipientServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'createRecipient',
+      'updateRecipient',
+      'getRecipientById',
+      'getRecipientByCode',
+      'getRecipientNameById',
+      'getAllRecipients',
+      'getRecipientFees',
+      'getRecipientGateways',
+      'updateRecipientAvatar',
+      'getRecipientDetailsById',
+      'isAutomaticAnticipationEnabled',
+      'getExternalRecipientId',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('RecipientService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('RecipientService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const RECIPIENT_SERVICE_NAME = 'RecipientService';