@postpaybr/protos 1.1.0

package/src/tax.proto

@@ -0,0 +1,323 @@
+syntax = "proto3";
+
+package tax;
+
+service TaxService {
+  rpc CreateTax (TaxPayloadRequest) returns (TaxEntity);
+  rpc GetTaxesGroupedByPayerLocation  (LocationDetailsDto) returns (GroupedPropertyDetails);
+  rpc GetTaxesGroupedByDocumentId (TaxByDocumentIdRequest) returns (GroupedPropertyDetails);
+  rpc getTaxesByDocumentId  (TaxByDocumentIdRequest) returns (TaxDetails);
+  rpc getTaxesByDocumentIdAndType (TaxByDocumentIdAndTypeRequest) returns (TaxDetail);
+  rpc groupTaxesByDocumentId (TaxesRequest) returns (TaxDetails);
+  rpc getTaxDetailsById (TaxByIdRequest) returns (TaxEntity); 
+
+  rpc getTaxDescription (TaxByIdRequest) returns (TaxDescriptionResponse);
+  rpc updateTaxReceiptId (UpdateTaxReceiptIdRequest) returns (TaxEntity);
+  rpc updateTaxStatus (UpdateTaxStatusRequest) returns (TaxEntity);
+  rpc GetAllTaxes (GetAllTaxesRequest) returns (GetAllTaxesResponse);
+  rpc GetCompleteTaxDetailsById (TaxByIdRequest) returns (CompleteTaxDetailsResponse);
+}
+
+message Payer {
+  optional string id = 1;
+  string name = 2;
+  string document = 3;
+  optional string phone = 4;
+}
+
+message LocationDetailsDto {
+  string document = 1;
+  int32 city = 2;
+  int32 state = 3;
+  int32 year = 4;
+}
+
+message completeTax {
+  string id = 1;
+  string type = 2;
+  string status = 3;
+  string description = 4;
+  double amount = 5;
+  int32 year = 6;
+  string dueAt = 7;
+  string documentId = 8;
+  string code = 9;
+  bool isSingleQuota = 10;
+  optional int32 quota = 11;
+  double discountAmount = 12;
+  double fee = 13;
+  double fine = 14;
+}
+
+message TaxPayload {
+  completeTax tax = 1;
+  Payer payer = 2;
+  Location location = 3;
+  string metaType = 4;
+  Meta meta = 5;
+}
+
+message Tax {
+  string id = 1;
+  string type = 2;
+  string description = 4;
+  int32 year = 6;
+  string documentId = 8;
+}
+
+message Location {
+  int32 state = 1;
+  int32 city = 2;
+  string recipientId = 3;
+}
+
+message Meta {
+  optional Address address = 1;   
+  optional string licensePlate = 2;   
+  optional string model = 3;           
+  optional int32 yearManufacture = 4; 
+  optional string renavam = 5;        
+}
+
+message Address {
+  string street = 1;
+  string number = 2;
+  string complement = 3;
+  string neighborhood = 4;
+  string city = 5;
+  string state = 6;
+  string zipCode = 7;
+}
+
+message Property {
+  optional string documentId = 1;
+  optional Address address = 2;
+}
+
+message TaxDetail {
+  Tax tax = 1;
+  Payer payer = 2;
+  Location location = 3;
+  string metaType = 4;
+  Meta meta = 5;
+  repeated TaxItem items = 6;
+}
+
+message TaxItem {
+  string id = 1;
+  string code = 2;
+  int32 quota = 3;
+  string dueAt = 4;
+  double amount = 5;
+  bool isSingleQuota = 6;
+  string status = 7;
+  double discountPercentage = 8;
+  double discountAmount = 9;
+  double fee = 10;
+  double fine = 11;
+}
+
+message PropertyDetail {
+  Property property = 1;
+  Payer payer = 2;
+  repeated string taxTypes = 3;
+  optional double pendingTaxesAmount = 4;
+  optional double paidTaxesAmount = 5;
+  optional double overdueTaxesAmount = 6;
+  optional string lastPaidTaxDate = 7;
+  optional string nextDueDate = 8;
+  repeated TaxDueDate nearDueTaxesDates = 9;
+  repeated TaxDueDate overdueTaxesDates = 10;
+  optional string receiptId = 11;
+}
+
+message TaxDueDate {
+  string id = 1;
+  string dueDate = 2;
+} 
+
+message TaxPayloadRequest {
+  TaxPayload data = 1;
+  Payer payer = 2;
+}
+
+message TaxByDocumentIdRequest {
+  string documentId = 1;
+}
+
+message TaxByDocumentIdAndTypeRequest {
+  string documentId = 1;
+  string type = 2;
+}
+
+message TaxByIdRequest {
+  string id = 1;
+}
+
+message GroupedPropertyDetails {
+  repeated PropertyDetail properties = 1;
+}
+
+message TaxDetails {
+  repeated TaxDetail taxes = 1;
+}
+
+message TaxEntity {
+  string id = 1;
+  string type = 2;
+  string status = 3;
+  string description = 4;
+  double amount = 5;
+  int32 year = 6;
+  string dueAt = 7;
+  string documentId = 8;
+  string code = 9;
+  bool isSingleQuota = 10;
+  int32 quota = 11;
+  double fee = 12;
+  double fine = 13;
+  double discountPercentage = 14;
+  double discountAmount = 15;
+  int32 state = 16;
+  int32 city = 17;
+  string recipientId = 18;
+  string metaType = 19;
+  optional Meta meta = 20;
+  
+  optional PayerEntity payer = 21;  
+  OrderItemEntity orderItem = 22;  
+  optional Receipt receipt = 23;
+}
+
+message Charge {
+  string id = 1;
+  double amount = 2;
+  string paymentMethod = 3;
+  string status = 4;
+  optional string dueAt = 5;
+  optional string txid = 6;
+  optional string brcode = 7;
+  optional int32 installmentNumber = 8;
+  optional double installmentValue = 9;
+  string createdAt = 10;
+}
+
+message PayerEntity {
+  string id = 1;
+  string name = 2;
+  string document = 3;
+  string phone = 4;
+  repeated Tax taxes = 5;
+}
+
+message Receipt {
+  string id = 1;
+  double amount = 2;
+  string protocol = 3;
+  optional string txid = 4;
+  string createdAt = 5;
+}
+
+message OrderItemEntity {
+  string id = 1;
+  Recipient recipient = 2;
+  Tax tax = 3;
+  Order order = 4;
+}
+
+message Order {
+  string id = 1;
+  double totalAmount = 2;
+  string status = 3;
+  string createdAt = 4;
+  repeated OrderItemEntity items = 5;
+  repeated Charge charges = 6;
+  Customer customer = 7;
+}
+
+message Customer {
+  string id = 1;
+  string firstName = 2;
+  string lastName = 3;
+  string document = 4;
+  string email = 5;
+  bool isEmailVerified = 6;
+  string phone = 7;
+}
+
+message Recipient {
+  string id = 1;
+  string code = 2;
+}
+
+message TaxesRequest {
+  repeated TaxEntity taxes = 1;
+}
+
+
+message TaxDescriptionResponse {
+  string description = 1;
+}
+
+message UpdateTaxReceiptIdRequest {
+  string id = 1;
+  string receiptId = 2;
+}
+
+message UpdateTaxStatusRequest {
+  string id = 1;
+  string status = 2;
+}
+
+message GetAllTaxesRequest {
+  optional GetAllTaxesDto data = 1;
+  PaginationFilterDto pagination = 2;
+  DateFilterDto date = 3;
+}
+
+message GetAllTaxesDto {
+  optional string recipientId = 1;
+  repeated string types = 2;
+  repeated string statuses = 3;
+}
+
+message PaginationFilterDto {
+  optional int32 limit = 1;
+  optional int32 offset = 2;
+}
+
+message DateFilterDto {
+  optional string startDate = 1;
+  optional string endDate = 2;
+}
+
+message GetAllTaxesResponse {
+  repeated TaxEntity taxes = 1;
+  int32 count = 2;
+}
+
+message CompleteTaxDetailsResponse {
+  TaxEntity tax = 1;
+  optional ChargeDetails charge = 2;
+}
+
+message ChargeDetails {
+  string id = 1;
+  double amount = 2;
+  string paymentMethod = 3;
+  string status = 4;
+  string dueAt = 5;
+  optional string txid = 6;
+  optional string brcode = 7;
+  optional int32 installmentNumber = 8;
+  optional double installmentValue = 9;
+  double fee = 10;
+  double baseFee = 11;
+  double feePercentage = 12;
+  double discountPercentage = 13;
+  double discountAmount = 14;
+  string createdAt = 15;
+  string gatewayId = 16;
+  optional string failureReason = 17;
+  optional string failureDetails = 18;
+}

package/src/transfer.proto

@@ -0,0 +1,206 @@
+syntax = "proto3";
+
+package transfer;
+
+service TransferService {
+  rpc updateTransferStatus (UpdateTransferStatusRequest) returns (UpdateTransferStatusResponse);
+}
+
+message UpdateTransferStatusRequest {
+  string transferId = 1;
+  string status = 2;
+  map<string, string> responsePayload = 3;
+}
+
+message UpdateTransferStatusResponse {
+  bool success = 1;
+}
+
+message Transfer {
+  string id = 1;
+  double amount = 2;
+  string type = 3;
+  string recipientId = 4;
+  string chargeId = 5;
+  string description = 6;
+  string status = 7;
+  string processedAt = 8;
+  string gatewayId = 9;
+  string bankAccountId = 10;
+  map<string, string> requestPayload = 11;
+  map<string, string> responsePayload = 12;
+  string createdAt = 13;
+  string updatedAt = 14;
+}
+
+message BankAccount {
+  string id = 1;
+  string recipientId = 2;
+  string bankCode = 3;
+  string branch = 4;
+  string account = 5;
+  string accountType = 6;
+  string pixKey = 7;
+  string pixKeyType = 8;
+  double balance = 9;
+  repeated string transfers = 10;
+  bool isMain = 11;
+  string createdAt = 12;
+  string updatedAt = 13;
+}
+
+message Recipient {
+  string id = 1;
+  string code = 2;
+  string commercialName = 3;
+  string socialReason = 4;
+  string holderType = 5;
+  string document = 6;
+  string cnaeId = 7;
+  string legalType = 8;
+  string foundation = 9;
+  string contactName = 10;
+  string contactEmail = 11;
+  string contactPhone = 12;
+  bool isAutomaticAnticipationEnabled = 13;
+  string avatarUrl = 14;
+  bool isActive = 15;
+  string providerStatus = 16;
+  repeated string administrators = 17;
+  repeated string payableIds = 19;
+  string addressId = 20;
+  string createdAt = 21;
+  string updatedAt = 22;
+}
+
+message Charge {
+  string id = 1;
+  double amount = 2;
+  string paymentMethod = 3;
+  string status = 4;
+  string type = 5;
+  string dueAt = 6;
+  string txid = 7;
+  string endToEndId = 8;
+  string brcode = 9;
+  string pushToken = 10;
+  int32 installmentNumber = 11;
+  double installmentValue = 12;
+  double fee = 13;
+  double baseFee = 14;
+  double feePercentage = 15;
+  bool isScheduled = 16;
+  double discountPercentage = 17;
+  double discountAmount = 18;
+  string createdAt = 19;
+  string gatewayId = 20;
+  string cardId = 21;
+  string orderId = 22;
+  string orderScheduleId = 23;
+  repeated string payableIds = 24;
+  string taxId = 25;
+  string metadata = 26;
+}
+
+message Payable {
+  string id = 1;
+  double amount = 2;
+  int32 installment = 3;
+  string status = 4;
+  string dueAt = 5;
+  bool isAnticipated = 6;
+  string processedAt = 7;
+  string createdAt = 8;
+  string chargeId = 9;
+  string recipientId = 10;
+}
+
+message BankTransferData {
+  string pixKey = 1;
+  double amount = 2;
+  string chargeId = 3;
+  Recipient recipient = 4;
+  string routingKey = 5;
+  string gatewayId = 6;
+  repeated Payable payables = 7;
+  string bankAccountId = 8;
+}
+
+message UpdateBankAccountBalanceRequest {
+  string bankAccountId = 1;
+  double amount = 2;
+  string operation = 3;
+}
+
+message UpdateBankAccountBalanceResponse {
+  bool success = 1;
+  double newBalance = 2;
+}
+
+message GetMainAccountRequest {}
+
+message GetMainAccountResponse {
+  BankAccount bankAccount = 1;
+}
+
+message GetBankAccountByRecipientIdRequest {
+  string recipientId = 1;
+}
+
+message GetBankAccountByRecipientIdResponse {
+  repeated BankAccount bankAccount = 1;
+}
+
+message GetRecipientByIdRequest {
+  string id = 1;
+}
+
+message GetRecipientByIdResponse {
+  Recipient recipient = 1;
+}
+
+message GetLiquidatedChargesForTransferRequest {}
+
+message GetLiquidatedChargesForTransferResponse {
+  repeated Charge charges = 1;
+}
+
+message UpdatePayablesStatusRequest {
+  repeated string payableIds = 1;
+  string status = 2;
+}
+
+message UpdatePayablesStatusResponse {
+  bool success = 1;
+  int32 affected = 2;
+}
+
+message GetPayableByIdRequest {
+  string payableId = 1;
+}
+
+message GetPayableByIdResponse {
+  Payable payable = 1;
+}
+
+message RoutingInfoRequest {
+  string method = 1;
+  string recipientId = 2;
+  string operationType = 3;
+}
+
+message RoutingInfoResponse {
+  string gatewayId = 1;
+  string pixKey = 2;
+  string routingKey = 3;
+}
+
+message CreatePaymentPixRequest {
+  BankTransferData data = 1;
+  string routingKey = 2;
+}
+
+message CreatePaymentPixResponse {
+  bool success = 1;
+  string paymentId = 2;
+}

package/src/two-factor.proto

@@ -0,0 +1,67 @@
+syntax = "proto3";
+
+package twoFactor;
+
+service TwoFactorService {
+  rpc EnableTwoFactor(EnableTwoFactorRequest) returns (TwoFactorResponse);
+  rpc VerifyAndEnableTwoFactor(VerifyTwoFactorRequest) returns (VerifyTwoFactorResponse);
+  rpc DisableTwoFactor(DisableTwoFactorRequest) returns (DisableTwoFactorResponse);
+  rpc VerifyTwoFactorToken(VerifyTwoFactorTokenRequest) returns (VerifyTwoFactorResponse);
+  rpc GenerateNewBackupCodes(GenerateBackupCodesRequest) returns (GenerateBackupCodesResponse);
+  rpc GetTwoFactorStatus(GetTwoFactorStatusRequest) returns (TwoFactorStatusResponse);
+}
+
+message EnableTwoFactorRequest {
+  string accountId = 1;
+  string accountType = 2;
+}
+
+message TwoFactorResponse {
+  string qrCodeUrl = 1;
+  repeated string backupCodes = 2;
+}
+
+message VerifyTwoFactorRequest {
+  string accountId = 1;
+  string accountType = 2;
+  string token = 3;
+}
+
+message VerifyTwoFactorResponse {
+  bool success = 1;
+}
+
+message DisableTwoFactorRequest {
+  string accountId = 1;
+  string accountType = 2;
+  string backupCode = 3;
+}
+
+message DisableTwoFactorResponse {
+  bool success = 1;
+}
+
+message VerifyTwoFactorTokenRequest {
+  string accountId = 1;
+  string accountType = 2;
+  string token = 3;
+}
+
+message GenerateBackupCodesRequest {
+  string accountId = 1;
+  string accountType = 2;
+}
+
+message GenerateBackupCodesResponse {
+  repeated string backupCodes = 1;
+}
+
+message GetTwoFactorStatusRequest {
+  string accountId = 1;
+  string accountType = 2;
+}
+
+message TwoFactorStatusResponse {
+  bool isEnabled = 1;
+  bool hasBackupCodes = 2;
+}