@postpaybr/protos 1.1.11 → 1.1.16

package/src/protos/charge.proto

@@ -2,6 +2,9 @@ syntax = "proto3";
 
 package charge;
 
+import "common.proto";
+import "tax.proto";
+
 service ChargeService {
   rpc createCharge (CreateChargeRequest) returns (ChargeResponse);
   rpc updateCharge (UpdateChargeRequest) returns (ChargeResponse);
@@ -36,16 +39,6 @@ service ChargeService {
   rpc getOrderPaymentSummary (GetOrderPaymentSummaryRequest) returns (GetOrderPaymentSummaryResponse);
 }
 
-message DateFilter {
-  optional string startDate = 1;
-  optional string endDate = 2;
-}
-
-message PaginationFilter {
-  optional int32 limit = 1;
-  optional int32 offset = 2;
-}
-
 message Charge {
   string id = 1;
   double amount = 2;
@@ -85,6 +78,7 @@ message ChargeSchedule {
   Charge charge = 6;
 }
 
+
 message CreateChargeRequest {
   double amount = 1;
   string paymentMethod = 2;
@@ -189,6 +183,7 @@ message ScheduledChargeDetail {
   optional CardDetails card = 10;
 }
 
+
 message CardDetails {
   string id = 1;
   string brand = 2;
@@ -227,13 +222,8 @@ message getChargeAdministratorDetailsResponse {
   optional string failureReason = 21;
   optional string failureDetails = 22;
   repeated ChargeSplit splits = 23;
-  optional TaxPayload tax = 24;
-  optional ChargeScheduleDetail schedule = 25;
-}
-
-message ChargeScheduleDetail {
-  string executionDate = 2;
-  bool isExecuted = 3;
+  optional tax.TaxPayload tax = 24;
+  optional common.ChargeScheduleDetail schedule = 25;
 }
 
 message ChargeSplit {
@@ -267,66 +257,12 @@ message Tax {
   int32 city = 17;
   string recipientId = 18;
   string metaType = 19;
-  Meta meta = 20;
-  Payer payer = 21;
+  common.Meta meta = 20;
+  common.Payer payer = 21;
   OrderItemEntity orderItem = 22;
   optional Receipt receipt = 23;
 }
 
-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;
-}
-
-message Location {
-  int32 state = 1;
-  int32 city = 2;
-  string recipientId = 3;
-}
-
-message TaxPayload {
-  completeTax tax = 1;
-  Payer payer = 2;
-  Location location = 3;
-  string metaType = 4;
-  Meta meta = 5;
-}
-
-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 Payer {
-  string id = 1;
-  string name = 2;
-  string document = 3;
-  string phone = 4;
-  repeated Tax taxes = 5;
-}
-
 message Order {
   string id = 1;
   double totalAmount = 2;
@@ -454,15 +390,15 @@ message ChargeClientDetailsResponse {
   optional CardDetails card = 16;
   double discountPercentage = 17;
   double discountAmount = 18;
-  optional TaxPayload tax = 19;
-  optional ChargeScheduleDetail schedule = 20;
+  optional tax.TaxPayload tax = 19;
+  optional common.ChargeScheduleDetail schedule = 20;
   optional string orderId = 21;
 }
 
 message GetChargesHistoryRequest {
   ChargeHistoryFilter data = 1;
-  PaginationFilter pagination = 2;
-  DateFilter date = 3;
+  common.PaginationFilter pagination = 2;
+  common.DateFilter date = 3;
 }
 
 message ChargeHistoryFilter {
@@ -483,7 +419,7 @@ message ChargeCardItem {
   string propertyDetail = 5;
   int32 installmentNumber = 6;
   double installmentValue = 7;
-  optional ChargeScheduleDetail schedule = 8;
+  optional common.ChargeScheduleDetail schedule = 8;
   string taxType = 9;
   string status = 10;
 }

package/src/protos/common.proto

@@ -0,0 +1,152 @@
+syntax = "proto3";
+
+package common;
+
+
+import "tax.proto";
+
+message Void {}
+
+message Empty {}
+
+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 DailyBalance {
+  string date = 1;
+  double balance = 2;
+}
+
+message DateFilter {
+  optional string startDate = 1;
+  optional string endDate = 2;
+}
+
+message PaginationFilter {
+  optional int32 limit = 1;
+  optional int32 offset = 2;
+}
+
+message Role {
+  string id = 1;
+  string code = 2;
+  string description = 3;
+  repeated string permissions = 4;
+}
+
+message Address {
+  string street = 1;
+  string number = 2;
+  string complement = 3;
+  string neighborhood = 4;
+  string city = 5;
+  string state = 6;
+  string zipCode = 7;
+}
+
+message Location {
+  int32 state = 1;
+  int32 city = 2;
+  string recipientId = 3;
+}
+
+message Payer {
+  optional string id = 1;
+  string name = 2;
+  string document = 3;
+  optional string phone = 4;
+}
+
+
+message FullPayer {
+  string id = 1;
+  string name = 2;
+  string document = 3;
+  string phone = 4;
+  repeated TaxEntity taxes = 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 Meta {
+  optional Address address = 1;
+  optional string licensePlate = 2;
+  optional string model = 3;
+  optional int32 yearManufacture = 4;
+  optional string renavam = 5;
+}
+
+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 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 TaxPayload {
+  Tax tax = 1;
+  Payer payer = 2;
+  Location location = 3;
+  string metaType = 4;
+  Meta meta = 5;
+}
+
+message ChargeScheduleDetail {
+  string executionDate = 2;
+  bool isExecuted = 3;
+}
+
+message Order {
+  string id = 1;
+  double totalAmount = 2;
+  string status = 3;
+  string createdAt = 4;
+}
+
+message ImageData {
+  string mimetype = 1;
+  bytes buffer = 2;
+}

package/src/protos/context.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package context;
 
+import "common.proto";
+
 service ContextService {
   rpc GetContext(GetContextRequest) returns (GetContextResponse);
   rpc ClearContext(ClearContextRequest) returns (ClearContextResponse);
@@ -21,30 +23,6 @@ message LocationDetails {
   int32 year = 4;          
 }
 
-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 MetaAddress {
   string street = 1;
   string complement = 2;
@@ -63,16 +41,10 @@ message Meta {
   optional string renavam = 5;        
 }
 
-message TaxLocation {
-  int32 state = 1;
-  int32 city = 2;
-  string recipientId = 3;
-}
-
 message TaxDetail {
-  Tax tax = 1;
-  Payer payer = 2;
-  TaxLocation location = 3;
+  common.Tax tax = 1;
+  common.Payer payer = 2;
+  common.Location location = 3;
   string metaType = 4;
   Meta meta = 5;
 }
@@ -85,7 +57,7 @@ message PaymentDetails {
   optional double discountAmount = 5;
   optional string gatewayId = 6;
   optional Card card = 7;
-  PaymentSchedule paymentSchedule = 8;
+  common.PaymentSchedule paymentSchedule = 8;
   double baseFee = 9;
   double feePercentage = 10;
   optional string chargeId = 11;
@@ -94,15 +66,10 @@ message PaymentDetails {
   optional bool keepData = 14;
 }
 
-message PaymentSchedule {
-  string type = 1;
-  optional string date = 2;
-}
-
 message Card {
   string id = 1;
   string shadowNumber = 2;
-  optional string brand = 3;
+  string brand = 3;
   optional int32 installments = 4;
   optional double installmentValue = 5;
 }
@@ -154,21 +121,13 @@ message CheckoutRequest {
   string customerId = 1;
 }
 
-message Order {
-  string id = 1;
-  double totalAmount = 2;
-  string status = 3;
-  string createdAt = 4;
-}
-
 message CheckoutResponse {
-  Order order = 1;
+  common.Order order = 1;
   string orderType = 2;
   optional string chargeId = 3;
 }
 
-
 message PostPaymentDateRequest {
   string customerId = 1;
-  PaymentSchedule paymentSchedule = 2;
+  common.PaymentSchedule paymentSchedule = 2;
 }

package/src/protos/customer.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package customer;
 
+import "common.proto";
+
 service CustomerService {
   rpc CreateCustomer (CreateCustomerRequest) returns (CreateCustomerResponse);
   rpc CheckCustomerExists (CheckCustomerExistsRequest) returns (CheckCustomerExistsResponse);
@@ -169,7 +171,7 @@ message CustomerSignUp {
 message User {
   string id = 1;
   string password = 2;
-  Role role = 3;
+  common.Role role = 3;
   repeated Device devices = 4;
 }
 
@@ -178,16 +180,9 @@ message UserSignUp {
   repeated Device devices = 2;
 }
 
-message Role {
-  string id = 1;
-  string code = 2;
-  string description = 3;
-  repeated string permissions = 4;
-}
-
 message Device {
   optional string token = 1;
-  string expoPushToken = 2;
+  optional string expoPushToken = 2;
 }
 
 
@@ -213,15 +208,10 @@ message CustomerWithStatus {
   string userStatus = 6;
 }
 
-message ImageData {
-  string mimetype = 1;
-  bytes buffer = 2;
-}
-
 message InitiateDocumentVerificationRequest {
   string customerId = 1;
-  ImageData documentFront = 2;
-  ImageData selfieWithDocument = 3;
+  common.ImageData documentFront = 2;
+  common.ImageData selfieWithDocument = 3;
 }
 
 message DocumentVerificationResponse {

package/src/protos/daily-balance.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package dailyBalance;
 
+import "common.proto";
+
 service DailyBalanceService {
   rpc getBalanceHistory(GetBalanceHistoryRequest) returns (GetBalanceHistoryResponse);
   rpc getCurrentBalance(getCurrentBalanceRequest) returns (getCurrentBalanceResponse);
@@ -13,13 +15,8 @@ message GetBalanceHistoryRequest {
   string endDate = 3;
 }
 
-message DailyBalance {
-  string date = 1;
-  double balance = 2;
-}
-
 message GetBalanceHistoryResponse {
-  repeated DailyBalance dailyBalances = 1;
+  repeated common.DailyBalance dailyBalances = 1;
 }
 
 message getCurrentBalanceRequest {

package/src/protos/document-verification.proto

@@ -2,13 +2,15 @@ syntax = "proto3";
 
 package documentVerification;
 
+import "common.proto";
+
 service DocumentVerificationService {
   rpc updateVerificationStatus(UpdateDocumentVerificationStatusRequest) returns (DocumentVerificationResponse);
   rpc getDocumentVerificationsWithDetails(GetVerificationsWithDetailsRequest) returns (GetDocumentVerificationsWithDetailsResponse);
   rpc getDocumentVerificationDetailsById(GetVerificationDetailsByIdRequest) returns (DocumentVerificationDetailsResponse);
 
-  rpc countPendingOrInProgressVerifications(Empty) returns (CountResponse);
-  rpc getDistinctReviewers(Empty) returns (GetDistinctReviewersResponse);
+  rpc countPendingOrInProgressVerifications(common.Empty) returns (CountResponse);
+  rpc getDistinctReviewers(common.Empty) returns (GetDistinctReviewersResponse);
   rpc undoLastStatusChange(UndoLastStatusChangeRequest) returns (DocumentVerificationResponse);
 }
 
@@ -89,9 +91,6 @@ message VerificationHistoryWithDetails {
   string actedBy = 5;
 }
 
-message Empty {}
-
-
 message CountResponse {
   int32 count = 1;
 }
@@ -108,4 +107,4 @@ message GetDistinctReviewersResponse {
 message UndoLastStatusChangeRequest {
   string verificationId = 1;
   string actedById = 2;
-}
+}

package/src/protos/expo-push.proto

@@ -2,8 +2,10 @@ syntax = "proto3";
 
 package expoPush;
 
+import "common.proto";
+
 service ExpoPushService {
-  rpc SendNotification (NotificationDto) returns (Empty);
+  rpc SendNotification (NotificationDto) returns (common.Empty);
 
 }
 
@@ -23,5 +25,3 @@ message DataValue {
   }
 }
 
-message Empty {}
-

package/src/protos/fee.proto

@@ -2,10 +2,12 @@ syntax = "proto3";
 
 package fee;
 
+import "common.proto";
+
 service FeeService {
   rpc CreateFee(CreateFeeDto) returns (FeeEntity);
   rpc UpdateRecipientFee(UpdateFeeDto) returns (FeeEntity);
-  rpc GetAllDefaultFees(Void) returns (FeeEntityList);
+  rpc GetAllDefaultFees(common.Void) returns (FeeEntityList);
   rpc GetFeeForRecipientAndMethod(GetFeeRequest) returns (FeeEntity);
 
 }
@@ -61,5 +63,3 @@ message FeeEntityList {
   repeated FeeEntity fees = 1;
 }
 
-message Void {}
-

package/src/protos/notification.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package notification;
 
+import "common.proto";
+
 service NotificationService {
   rpc CreateNotification(CreateNotificationRequest) returns (NotificationResponse);
   rpc GetNotificationById(GetNotificationByIdRequest) returns (NotificationResponse);
@@ -24,16 +26,6 @@ message GetAllNotificationsDto {
   optional bool isRead = 4;
 }
 
-message DateFilter {
-  optional string startDate = 1;
-  optional string endDate = 2;
-}
-
-message PaginationFilter {
-  optional int32 limit = 1;
-  optional int32 offset = 2;
-}
-
 message NotificationChange {
   string field = 1;
   string oldValue = 2;
@@ -118,8 +110,8 @@ message GetNotificationByIdRequest {
 
 message GetAllNotificationsRequest {
   GetAllNotificationsDto data = 1;
-  DateFilter dateFilter = 2;
-  PaginationFilter pagination = 3;
+  common.DateFilter dateFilter = 2;
+  common.PaginationFilter pagination = 3;
 }
 
 message NotificationsResponse {

package/src/protos/order.proto

@@ -2,16 +2,18 @@ syntax = "proto3";
 
 package order;
 
+import "common.proto";
+
 service OrderService {
   rpc CreateOrder(CreateOrderRequest) returns (Order);
   rpc GetOrderById(GetOrderByIdRequest) returns (Order);
   rpc GetAllOrders(GetAllOrdersRequest) returns (GetAllOrdersResponse);
-  rpc CreateOrderItems(CreateOrderItemsRequest) returns (Void);
+  rpc CreateOrderItems(CreateOrderItemsRequest) returns (common.Void);
   rpc GetReceiptsByOrderId(GetReceiptsByOrderIdRequest) returns (GetReceiptsByOrderIdResponse);
   rpc updateOrderStatus(updateOrderStatusRequest) returns (Order);
 
   rpc GetOrderCustomerName(GetOrderByIdRequest) returns (GetOrderCustomerNameResponse);
-  rpc updateOrderWithChargeId(updateOrderWithChargeIdRequest) returns (Void);
+  rpc updateOrderWithChargeId(updateOrderWithChargeIdRequest) returns (common.Void);
   rpc updateOrderAmountAndStatus (UpdateOrderAmountAndStatusRequest) returns (Order);
   rpc GetDetailedOrder(GetOrderByIdRequest) returns (DetailedOrderResponse);
 }
@@ -31,18 +33,8 @@ message GetAllOrdersRequest {
   optional string recipientId = 1;
   repeated string statuses = 2;
   optional string orderType = 3;
-  PaginationFilter pagination = 4;
-  DateFilter date = 5;
-}
-
-message PaginationFilter {
-  optional int32 limit = 1;
-  optional int32 offset = 2;
-}
-
-message DateFilter {
-  optional string startDate = 1;
-  optional string endDate = 2;
+  common.PaginationFilter pagination = 4;
+  common.DateFilter date = 5;
 }
 
 message GetAllOrdersResponse {
@@ -77,8 +69,6 @@ message HealthCheckResponse {
   map<string, string> details = 2;
 }
 
-message Void {}
-
 message Order {
   string id = 1;
   double totalAmount = 2;

package/src/protos/payable.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package payable;
 
+import "common.proto";
+
 service PayableService {
   rpc CreatePayable (CreatePayableRequest) returns (PayableResponse);
   rpc GetPayablesByChargeId (GetPayablesByChargeIdRequest) returns (GetPayablesByChargeIdResponse);
@@ -48,7 +50,7 @@ message Payable {
   string dueAt = 5;
   string createdAt = 6;
   bool isAnticipated = 7;
-  Anticipation anticipation = 8;
+  optional Anticipation anticipation = 8;
   optional string chargeId = 9;
   optional string recipientId = 10;
   optional string processedAt = 11;
@@ -119,7 +121,7 @@ message DeletePayableResponse {
 message GetAllPayablesRequest {
   optional GetAllPayablesData data = 1;
   PaginationFilter pagination = 2;
-  DateFilter date = 3;
+  common.DateFilter date = 3;
 }
 
 message GetAllPayablesData {
@@ -133,10 +135,7 @@ message PaginationFilter {
   int32 offset = 2;
 }
 
-message DateFilter {
-  optional string startDate = 1;
-  optional string endDate = 2;
-}
+
 
 message GetAllPayablesResponse {
   repeated PayableWithDetails payables = 1;