@postpaybr/protos 1.1.10 → 1.1.14

package/src/protos/payment-card.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package paymentCard;
 
+import "common.proto";
+
 service PaymentCard {
   rpc CreatePayment (CreatePaymentRequest) returns (CreatePaymentResponse);
   rpc ProcessScheduledPayment (ProcessScheduledPaymentRequest) returns (ProcessScheduledPaymentResponse);
@@ -11,99 +13,14 @@ service PaymentCard {
 
 message CreatePaymentRequest {
   string customerId = 1;
-  repeated TaxPayload taxes = 2;
-  PaymentDetails payment = 3;
+  repeated common.TaxPayload taxes = 2;
+  common.PaymentDetails payment = 3;
   optional bool closed = 4;
   optional string ip = 5;
   optional string sessionId = 6;
   string pushToken = 7;
 }
 
-message TaxPayload {
-  Tax tax = 1;
-  Payer payer = 2;
-  Location location = 3;
-  string metaType = 4;
-  Meta meta = 5;
-}
-
-message Tax {
-  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 Payer {
-  optional string id = 1;
-  string name = 2;
-  string document = 3;
-  optional string phone = 4;
-}
-
-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 PaymentDetails {
-  string method = 1;
-  double amount = 2;
-  optional double discountPercentage = 3;
-  double fee = 4;
-  optional double discountAmount = 5;
-  optional string gatewayId = 6;
-  optional Card card = 7;
-  PaymentSchedule paymentSchedule = 8;
-  double baseFee = 9;
-  double feePercentage = 10;
-  optional string chargeId = 11;
-  optional bool isRetry = 12;
-  optional string orderId = 13;
-}
-
-message PaymentSchedule {
-  string type = 1;
-  optional string date = 2;
-}
-
-message Card {
-  string id = 1;
-  string shadowNumber = 2;
-  string brand = 3;
-  optional int32 installments = 4;
-  optional double installmentValue = 5;
-}
-
 message CreatePaymentResponse {
   Order order = 1;
   string orderType = 2;
@@ -111,9 +28,9 @@ message CreatePaymentResponse {
 
 message ProcessScheduledPaymentRequest {
   string customerId = 1;
-  TaxPayload tax = 2;
+  common.TaxPayload tax = 2;
   Charge charge = 3;
-  PaymentDetails payment = 4;
+  common.PaymentDetails payment = 4;
 }
 
 message ProcessScheduledPaymentResponse {}
@@ -202,7 +119,7 @@ message Order {
 message OrderItemEntity {
   string id = 1;
   Recipient recipient = 2;
-  Tax tax = 3;
+  common.Tax tax = 3;
   Order order = 4;
 }
 message Customer {

package/src/protos/payment-gateway.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package paymentGateway;
 
+import "common.proto";
+
 service PaymentGatewayService {
   rpc getById(GetByIdRequest) returns (PaymentGatewayResponse);
   rpc getByGatewayId(GetByGatewayIdRequest) returns (PaymentGatewayResponse);
@@ -9,7 +11,7 @@ service PaymentGatewayService {
   rpc getGatewaysByMethodSupport(GetGatewaysByMethodSupportRequest) returns (PaymentGatewayListResponse);
   rpc createGateway(CreateGatewayRequest) returns (PaymentGatewayResponse);
   rpc updateGateway(UpdateGatewayRequest) returns (PaymentGatewayResponse);
-  rpc deactivateGateway(DeactivateGatewayRequest) returns (Void);
+  rpc deactivateGateway(DeactivateGatewayRequest) returns (common.Void);
 
 }
 
@@ -77,18 +79,6 @@ message DeactivateGatewayRequest {
   string id = 1;
 }
 
-message Void {}
-
-
-message TableFilterParams {
-  optional int32 pageIndex = 1;
-  optional int32 pageSize = 2;
-  repeated string statuses = 3;
-  optional string globalFilter = 4;
-  optional string startDate = 5;
-  optional string endDate = 6;
-}
-
 message GetAllGatewaysRequest {
-  TableFilterParams filter = 1;
+  common.TableFilterParams filter = 1;
 }

package/src/protos/payment-pix.proto

@@ -2,114 +2,24 @@ syntax = "proto3";
 
 package paymentPix;
 
+import "common.proto";
+
 service PaymentPix {
   rpc CreatePayment (CreatePaymentRequest) returns (CreatePaymentResponse);
 }
 
 message CreatePaymentRequest {
   string customerId = 1;
-  repeated TaxPayload taxes = 2;
-  PaymentDetails payment = 3;
+  repeated common.TaxPayload taxes = 2;
+  common.PaymentDetails payment = 3;
   optional bool closed = 4;
   optional string ip = 5;
   optional string sessionId = 6;
   string pushToken = 7;
 }
 
-message TaxPayload {
-  Tax tax = 1;
-  Payer payer = 2;
-  Location location = 3;
-  string metaType = 4;
-  Meta meta = 5;
-}
-
-message Tax {
-  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 Payer {
-  optional string id = 1;
-  string name = 2;
-  string document = 3;
-  optional string phone = 4;
-}
-
-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 PaymentDetails {
-  string method = 1;
-  double amount = 2;
-  optional double discountPercentage = 3;
-  double fee = 4;
-  optional double discountAmount = 5;
-  optional string gatewayId = 6;
-  optional Card card = 7;
-  PaymentSchedule paymentSchedule = 8;
-  double baseFee = 9;
-  double feePercentage = 10;
-  optional string chargeId = 11;
-  optional bool isRetry = 12;
-  optional string orderId = 13;
-}
-
-message PaymentSchedule {
-  string type = 1;
-  optional string date = 2;
-}
-
-message Card {
-  string id = 1;
-  string shadowNumber = 2;
-  string brand = 3;
-  optional int32 installments = 4;
-  optional double installmentValue = 5;
-}
-
-message Order {
-  string id = 1;
-  double totalAmount = 2;
-  string status = 3;
-  string createdAt = 4;
-}
-
 message CreatePaymentResponse {
-  Order order = 1;
+  common.Order order = 1;
   string orderType = 2;
   string chargeId = 3;
 }

package/src/protos/receipt.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package receipt;
 
+import "common.proto";
+
 service ReceiptService {
   rpc createReceipt (CreateReceiptRequest) returns (ReceiptResponse);
   rpc getReceipt (GetReceiptRequest) returns (ReceiptDetailResponse);
@@ -26,8 +28,8 @@ message GetReceiptRequest {
 
 message GetAllReceiptsRequest {
   string customerId = 1;
-  DateFilter dateFilter = 2;
-  PaginationFilter pagination = 3;
+  common.DateFilter dateFilter = 2;
+  common.PaginationFilter pagination = 3;
 }
 
 message UpdateTxidRequest {
@@ -109,43 +111,15 @@ message CreateReceiptDto {
   string txid = 5;
 }
 
-message DateFilter {
-  optional string startDate = 1;
-  optional string endDate = 2;
-}
-
-message PaginationFilter {
-  optional int32 limit = 1;
-  optional int32 offset = 2;
-}
-
 message TaxDetail {
   reducedTax tax = 1;
   Payer payer = 2;
-  LocationInfo location = 3;
+  common.Location location = 3;
   string metaType = 4;
-  Meta meta = 5;
+  common.Meta meta = 5;
   repeated TaxItem items = 6;
 }
 
-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 reducedTax {
   string id = 1;
   string type = 2;
@@ -154,12 +128,6 @@ message reducedTax {
   string documentId = 5;
 }
 
-message LocationInfo {
-  int32 state = 1;
-  int32 city = 2;
-  string recipientId = 3;
-}
-
 message TaxItem {
   string id = 1;
   string code = 2;
@@ -193,16 +161,11 @@ message IndividualPayment {
   string propertyDetail = 5;
   int32 installmentNumber = 6;
   double installmentValue = 7;
-  optional ChargeScheduleDetail schedule = 8;
+  optional common.ChargeScheduleDetail schedule = 8;
   string taxType = 9;
   string status = 10;
 }
 
-message ChargeScheduleDetail {
-  string executionDate = 2;
-  bool isExecuted = 3;
-}
-
 message deleteReceiptByChargeIdRequest {
   string chargeId = 1;
 }

package/src/protos/recipient-payment-gateway.proto

@@ -2,12 +2,14 @@ syntax = "proto3";
 
 package recipientPaymentGateway;
 
+import "common.proto";
+
 service RecipientPaymentGatewayService {
   rpc CreateRecipientPaymentGateway(CreateRecipientPaymentGatewayRequest) returns (RecipientPaymentGatewayResponse);
-  rpc DeleteRecipientPaymentGateway(DeleteRecipientPaymentGatewayRequest) returns (Void);
+  rpc DeleteRecipientPaymentGateway(DeleteRecipientPaymentGatewayRequest) returns (common.Void);
   rpc GetGatewayByRecipientAndType(GetGatewayByRecipientAndTypeRequest) returns (RecipientPaymentGatewayResponse);
   rpc GetAvailableGateways(GetAvailableGatewaysRequest) returns (PaymentGatewayListResponse);
-  rpc ListGatewayIdentifications(Void) returns (GatewayIdentificationListResponse);
+  rpc ListGatewayIdentifications(common.Void) returns (GatewayIdentificationListResponse);
 
   rpc GetRecipientPaymentGatewaysByRecipientId(GetRecipientPaymentGatewaysByRecipientIdRequest) returns (RecipientPaymentGatewayListResponse);
 }
@@ -83,19 +85,7 @@ message GetAvailableGatewaysRequest {
   string method = 1;
 }
 
-message Void {}
-
-
-message TableFilterParams {
-  optional int32 pageIndex = 1;
-  optional int32 pageSize = 2;
-  repeated string statuses = 3;
-  optional string globalFilter = 4;
-  optional string startDate = 5;
-  optional string endDate = 6;
-}
-
 message GetRecipientPaymentGatewaysByRecipientIdRequest {
   string recipientId = 1;
-  TableFilterParams filter = 2;
+  common.TableFilterParams filter = 2;
 }

package/src/protos/recipient.proto

@@ -2,13 +2,15 @@ syntax = "proto3";
 
 package recipient;
 
+import "common.proto";
+
 service RecipientService {
   rpc CreateRecipient (CreateRecipientRequest) returns (RecipientResponse);
   rpc UpdateRecipient (UpdateRecipientRequest) returns (RecipientResponse);
   rpc GetRecipientById (GetRecipientByIdRequest) returns (RecipientResponse);
   rpc GetRecipientByCode (GetRecipientByCodeRequest) returns (RecipientResponse);
   rpc GetRecipientNameById (GetRecipientNameByIdRequest) returns (RecipientNameResponse);
-  rpc GetAllRecipients (Void) returns (GetAllRecipientsResponse);
+  rpc GetAllRecipients (common.Void) returns (GetAllRecipientsResponse);
   rpc GetRecipientFees (GetRecipientFeesRequest) returns (RecipientFeesResponse);
   rpc GetRecipientGateways (GetRecipientGatewaysRequest) returns (RecipientGatewaysResponse);
   rpc UpdateRecipientAvatar (UpdateRecipientAvatarRequest) returns (RecipientResponse);
@@ -59,8 +61,6 @@ message RecipientNameResponse {
   string name = 1;
 }
 
-message Void {}
-
 message GetAllRecipientsResponse {
   repeated Recipient recipients = 1;
 }
@@ -107,14 +107,9 @@ message RecipientGatewaysResponse {
   repeated RecipientGateway gateways = 1;
 }
 
-message ImageData {
-  string mimetype = 1;
-  bytes buffer = 2;
-}
-
 message UpdateRecipientAvatarRequest {
   string id = 1;
-  ImageData avatar = 2;
+  common.ImageData avatar = 2;
 }
 
 message GetRecipientDetailsByIdRequest {

package/src/protos/role.proto

@@ -2,12 +2,14 @@ syntax = "proto3";
 
 package role;
 
+import "common.proto";
+
 service RoleService {
-  rpc CreateRole (CreateRoleRequest) returns (Role);
+  rpc CreateRole (CreateRoleRequest) returns (common.Role);
   rpc DeleteRole (DeleteRoleRequest) returns (DeleteRoleResponse);
-  rpc GetRoleById (GetRoleByIdRequest) returns (Role);
+  rpc GetRoleById (GetRoleByIdRequest) returns (common.Role);
   rpc GetAllRoles (GetAllRolesRequest) returns (GetAllRolesResponse);
-  rpc UpdateRole (Role) returns (Role);
+  rpc UpdateRole (common.Role) returns (common.Role);
   rpc GetPermissionGroups (GetPermissionGroupsRequest) returns (GetPermissionGroupsResponse);
 
 }
@@ -30,17 +32,10 @@ message GetRoleByIdRequest {
   string id = 1; 
 }
 
-message Role {
-  string id = 1; 
-  string code = 2; 
-  string description = 3;
-  repeated string permissions = 4;
-}
-
 message GetAllRolesRequest {} 
 
 message GetAllRolesResponse {
-  repeated Role roles = 1;
+  repeated common.Role roles = 1;
 }
 
 message GetPermissionGroupsRequest {}

package/src/protos/tax.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package tax;
 
+import "common.proto";
+
 service TaxService {
   rpc CreateTax (TaxPayloadRequest) returns (TaxEntity);
   rpc GetTaxesGroupedByPayerLocation  (LocationDetailsDto) returns (GroupedPropertyDetails);
@@ -18,13 +20,6 @@ service TaxService {
   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;
@@ -51,10 +46,10 @@ message completeTax {
 
 message TaxPayload {
   completeTax tax = 1;
-  Payer payer = 2;
-  Location location = 3;
+  common.Payer payer = 2;
+  common.Location location = 3;
   string metaType = 4;
-  Meta meta = 5;
+  common.Meta meta = 5;
 }
 
 message Tax {
@@ -65,41 +60,17 @@ message Tax {
   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;
+  optional common.Address address = 2;
 }
 
 message TaxDetail {
   Tax tax = 1;
-  Payer payer = 2;
-  Location location = 3;
+  common.Payer payer = 2;
+  common.Location location = 3;
   string metaType = 4;
-  Meta meta = 5;
+  common.Meta meta = 5;
   repeated TaxItem items = 6;
 }
 
@@ -119,7 +90,7 @@ message TaxItem {
 
 message PropertyDetail {
   Property property = 1;
-  Payer payer = 2;
+  common.Payer payer = 2;
   repeated string taxTypes = 3;
   optional double pendingTaxesAmount = 4;
   optional double paidTaxesAmount = 5;
@@ -138,7 +109,7 @@ message TaxDueDate {
 
 message TaxPayloadRequest {
   TaxPayload data = 1;
-  Payer payer = 2;
+  common.Payer payer = 2;
 }
 
 message TaxByDocumentIdRequest {
@@ -182,7 +153,7 @@ message TaxEntity {
   int32 city = 17;
   string recipientId = 18;
   string metaType = 19;
-  optional Meta meta = 20;
+  optional common.Meta meta = 20;
   
   optional PayerEntity payer = 21;  
   OrderItemEntity orderItem = 22;  

package/src/protos/user.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package user;
 
+import "common.proto";
+
 service UserService {
   // Change Password Methods
   rpc CreateChangePassword(CreateChangePasswordRequest) returns (CreateChangePasswordResponse);
@@ -128,7 +130,7 @@ message User {
   string id = 1;
   string password = 2;
   string status = 3;
-  repeated Role roles = 4;
+  repeated common.Role roles = 4;
   string accountId = 5;
   string accountType = 6;
   repeated Device devices = 7;
@@ -142,13 +144,6 @@ message User {
   string twoFactorEnabledAt = 15;
 }
 
-message Role {
-  string id = 1;
-  string code = 2;
-  string description = 3;
-  repeated string permissions = 4;
-}
-
 message UserWithDevices {
   User user = 1;
   repeated Device devices = 2;
@@ -176,7 +171,7 @@ message GetUserRolesRequest {
 }
 
 message GetUserRolesResponse {
-  repeated Role roles = 1;
+  repeated common.Role roles = 1;
 }
 
 message UpdateUserRolesRequest {