@postpaybr/protos 1.1.0

package/src/context.proto

@@ -0,0 +1,174 @@
+syntax = "proto3";
+
+package context;
+
+service ContextService {
+  rpc GetContext(GetContextRequest) returns (GetContextResponse);
+  rpc ClearContext(ClearContextRequest) returns (ClearContextResponse);
+  rpc PostLocation(PostLocationRequest) returns (ClearContextResponse);
+  rpc PostTaxes(PostTaxesRequest) returns (ClearContextResponse);
+  rpc PostPaymentDetail(PostPaymentDetailRequest) returns (ClearContextResponse);
+  rpc PostPushToken(PostPushTokenRequest) returns (ClearContextResponse);
+  rpc Checkout(CheckoutRequest) returns (CheckoutResponse);
+
+  rpc PostPaymentDate(PostPaymentDateRequest) returns (ClearContextResponse);
+}
+
+message LocationDetails {
+  string document = 1;     
+  int32 state = 2;         
+  int32 city = 3;          
+  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;
+  string city = 3;
+  string neighborhood = 4;
+  string number = 5;
+  string state = 6;
+  string zipCode = 7;
+}
+
+message Meta {
+  optional MetaAddress address = 1;   
+  optional string licensePlate = 2;   
+  optional string model = 3;           
+  optional int32 yearManufacture = 4; 
+  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;
+  string metaType = 4;
+  Meta meta = 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;
+  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;
+  optional int32 installments = 4;
+  optional double installmentValue = 5;
+}
+
+message Context {
+  repeated TaxDetail taxes = 1;
+  optional LocationDetails location = 2;
+  optional PaymentDetails paymentDetails = 3;
+  optional string pushToken = 4;
+}
+
+message GetContextRequest {
+  string customerId = 1;
+}
+
+message GetContextResponse {
+  Context context = 1;
+}
+
+message ClearContextRequest {
+  string customerId = 1;
+}
+
+message ClearContextResponse {
+  bool success = 1;
+}
+
+message PostLocationRequest {
+  string customerId = 1;
+  LocationDetails location = 2;
+}
+
+message PostTaxesRequest {
+  string customerId = 1;
+  repeated TaxDetail taxes = 2;
+}
+
+message PostPaymentDetailRequest {
+  string customerId = 1;
+  PaymentDetails paymentDetails = 2;
+}
+
+message PostPushTokenRequest {
+  string customerId = 1;
+  string pushToken = 2;
+}
+
+message CheckoutRequest {
+  string customerId = 1;
+}
+
+message Order {
+  string id = 1;
+  double totalAmount = 2;
+  string status = 3;
+  string createdAt = 4;
+}
+
+message CheckoutResponse {
+  Order order = 1;
+  string orderType = 2;
+  optional string chargeId = 3;
+}
+
+
+message PostPaymentDateRequest {
+  string customerId = 1;
+  PaymentSchedule paymentSchedule = 2;
+}

package/src/customer.proto

@@ -0,0 +1,234 @@
+syntax = "proto3";
+
+package customer;
+
+service CustomerService {
+  rpc CreateCustomer (CreateCustomerRequest) returns (CreateCustomerResponse);
+  rpc CheckCustomerExists (CheckCustomerExistsRequest) returns (CheckCustomerExistsResponse);
+  rpc GetCustomerById (GetCustomerByIdRequest) returns (GetCustomerByIdResponse);
+  rpc GetCustomerByEmail (GetCustomerByEmailRequest) returns (GetCustomerByEmailResponse);
+  rpc GetVerifiedCustomerByDocument (GetVerifiedCustomerByDocumentRequest) returns (GetVerifiedCustomerByDocumentResponse);
+  rpc GetProfile (GetProfileRequest) returns (GetProfileResponse);
+  rpc UpdateCustomer (UpdateCustomerRequest) returns (UpdateCustomerResponse);
+  rpc updateIsEmailVerifiedStatus (updateIsEmailVerifiedStatusRequest) returns (updateIsEmailVerifiedStatusResponse);
+  rpc ChangePin (ChangePinRequest) returns (ChangePinResponse);
+  rpc CheckIsValidPin (CheckIsValidPinRequest) returns (CheckIsValidPinResponse);
+  rpc ValidateAndSignIn (ValidateAndSignInRequest) returns (ValidateAndSignInResponse);
+  rpc ValidateAndRefreshToken (ValidateAndRefreshTokenRequest) returns (ValidateAndRefreshTokenResponse);
+
+  rpc GetCustomersWithFilters (GetCustomersWithFiltersRequest) returns (GetCustomersWithFiltersResponse);
+  rpc InitiateDocumentVerification(InitiateDocumentVerificationRequest) returns (DocumentVerificationResponse);
+}
+
+message CreateCustomerRequest {
+  CustomerSignUp customer = 1;
+  UserSignUp user = 2;
+}
+
+message CreateCustomerResponse {
+  bool success = 1;
+}
+
+message CheckCustomerExistsRequest {
+  optional string document = 1;
+  optional string email = 2;
+  optional string phone = 3;
+  optional bool throwError = 4;
+}
+
+message CheckCustomerExistsResponse {
+  bool exists = 1;
+}
+
+message GetCustomerByIdRequest {
+  string id = 1;
+}
+
+message GetCustomerByIdResponse {
+  Customer customer = 1;
+}
+
+message GetCustomerByEmailRequest {
+  string email = 1;
+}
+
+message GetCustomerByEmailResponse {
+  Customer customer = 1;
+}
+
+message GetVerifiedCustomerByDocumentRequest {
+  string document = 1;
+}
+
+message GetVerifiedCustomerByDocumentResponse {
+  Customer customer = 1;
+}
+
+message GetProfileRequest {
+  string customerId = 1;
+}
+
+message GetProfileResponse {
+  string id = 1;
+  string firstName = 2;
+  string email = 3;
+  string phone = 4;
+  string document = 5;
+}
+
+message UpdateCustomerRequest {
+  string customerId = 1;
+  optional string phone = 2;
+  optional string firstName = 3;
+  optional string email = 4;
+}
+
+message UpdateCustomerResponse {
+  string firstName = 1;
+  string phone = 2;
+  string email = 3;
+}
+
+message updateIsEmailVerifiedStatusRequest {
+  string customerId = 1;
+  bool verified = 2;
+}
+
+message updateIsEmailVerifiedStatusResponse {}
+
+message ChangePinRequest {
+  string customerId = 1;
+  string pin = 2;
+}
+
+message ChangePinResponse {
+  bool success = 1;
+}
+
+message CheckIsValidPinRequest {
+  string customerId = 1;
+  string pin = 2;
+}
+
+message CheckIsValidPinResponse {
+  bool isValid = 1;
+}
+
+message ValidateAndRefreshTokenRequest {
+  string refreshToken = 1;
+}
+
+message ValidateAndRefreshTokenResponse {
+  string accessToken = 1;
+  string refreshToken = 2;
+  ReducedCustomer customer = 3;
+}
+
+message ValidateAndSignInRequest {
+  string document = 1;
+  string password = 2;
+}
+
+message ValidateAndSignInResponse {
+  string accessToken = 1;
+  string refreshToken = 2;
+  ReducedCustomer customer = 3;
+}
+
+message ReducedCustomer {
+  string id = 1;
+  string firstName = 2;
+  string email = 3;
+  string lastName = 4;
+  string phone = 5;
+  string document = 6;
+}
+
+message Customer {
+  string id = 1;
+  string firstName = 2;
+  string lastName = 3;
+  string document = 4;
+  string email = 5;
+  bool isEmailVerified = 6;
+  string phone = 7;
+  string pin = 8;
+  int32 pinAttempts = 9;
+}
+
+message CustomerSignUp {
+  string firstName = 1;
+  string lastName = 2;
+  string document = 3;
+  string email = 4;
+  bool isEmailVerified = 5;
+  string phone = 6;
+  string pin = 7;
+}
+
+message User {
+  string id = 1;
+  string password = 2;
+  Role role = 3;
+  repeated Device devices = 4;
+}
+
+message UserSignUp {
+  string password = 1;
+  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;
+}
+
+
+message GetCustomersWithFiltersRequest {
+  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 GetCustomersWithFiltersResponse {
+  repeated CustomerWithStatus customers = 1;
+}
+
+message CustomerWithStatus {
+  string id = 1;
+  string name = 2;
+  string document = 3;
+  string email = 4;
+  string phone = 5;
+  string userStatus = 6;
+}
+
+message ImageData {
+  string mimetype = 1;
+  bytes buffer = 2;
+}
+
+message InitiateDocumentVerificationRequest {
+  string customerId = 1;
+  ImageData documentFront = 2;
+  ImageData selfieWithDocument = 3;
+}
+
+message DocumentVerificationResponse {
+  string id = 1;
+  string documentFrontUrl = 2;
+  string selfieWithDocumentUrl = 3;
+  string reviewDeadline = 4;
+  repeated string rejectionReasons = 5;
+  string customRejectionReason = 6;
+}

package/src/daily-balance.proto

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package dailyBalance;
+
+service DailyBalanceService {
+  rpc getBalanceHistory(GetBalanceHistoryRequest) returns (GetBalanceHistoryResponse);
+  rpc getCurrentBalance(getCurrentBalanceRequest) returns (getCurrentBalanceResponse);
+}
+
+message GetBalanceHistoryRequest {
+  string recipientId = 1;
+  string startDate = 2;
+  string endDate = 3;
+}
+
+message DailyBalance {
+  string date = 1;
+  double balance = 2;
+}
+
+message GetBalanceHistoryResponse {
+  repeated DailyBalance dailyBalances = 1;
+}
+
+message getCurrentBalanceRequest {
+  string recipientId = 1;
+}
+
+message getCurrentBalanceResponse {
+  double balance = 1;
+  string lastUpdate = 2;
+}

package/src/document-verification.proto

@@ -0,0 +1,111 @@
+syntax = "proto3";
+
+package documentVerification;
+
+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 undoLastStatusChange(UndoLastStatusChangeRequest) returns (DocumentVerificationResponse);
+}
+
+message UpdateDocumentVerificationStatusRequest {
+  string id = 1;
+  string status = 2;
+  repeated string rejectionReasons = 3;
+  optional string customRejectionReason = 4;
+  optional string reviewerId = 5;
+  string actedById = 6;
+}
+
+message DocumentVerificationResponse {
+  string id = 1;
+  string documentFrontUrl = 2;
+  string selfieWithDocumentUrl = 3;
+  repeated string rejectionReasons = 4;
+  string customRejectionReason = 5;
+}
+
+message GetVerificationsWithDetailsRequest {
+  string status = 1;
+  optional int32 offset = 2;
+  optional int32 limit = 3;
+  optional string startDate = 4;
+  optional string endDate = 5;
+  repeated string reviewerIds = 6;
+}
+
+message GetDocumentVerificationsWithDetailsResponse {
+  repeated DocumentVerificationWithDetails data = 1;
+  int32 total = 2;
+  int32 currentCount = 3;
+  string order = 4;
+}
+
+message DocumentVerificationWithDetails {
+  string id = 1;
+  string customerName = 2;
+  string document = 3;
+  string createdAt = 4;
+  string reviewDeadline = 5;
+  string latestHistoryCreatedAt = 6;
+  string status = 7;
+  Reviewer lastReviewer = 8;
+}
+
+message GetVerificationDetailsByIdRequest {
+  string id = 1;
+}
+
+message DocumentVerificationDetailsResponse {
+  string id = 1;
+  string document = 2;
+  string customerName = 3;
+  string createdAt = 4;
+  string currentStatus = 5;
+  optional string documentFrontUrl = 6;
+  optional string selfieWithDocumentUrl = 7;
+  optional string elapsedBusinessTime = 8;
+  optional Reviewer lastReviewer = 9;
+  repeated VerificationHistoryWithDetails histories = 10;
+  repeated string rejectionReasons = 11;
+  optional string customRejectionReason = 12;
+  optional string finalDecisionAt = 13;
+}
+
+message Reviewer {
+  string id = 1;
+  string name = 2;
+}
+
+message VerificationHistoryWithDetails {
+  string id = 1;
+  string status = 2;
+  string createdAt = 3;
+  string reviewedBy = 4;
+  string actedBy = 5;
+}
+
+message Empty {}
+
+
+message CountResponse {
+  int32 count = 1;
+}
+
+message Reviewers {
+  string id = 1;
+  string name = 2;
+}
+
+message GetDistinctReviewersResponse {
+  repeated Reviewers reviewers = 1;
+}
+
+message UndoLastStatusChangeRequest {
+  string verificationId = 1;
+  string actedById = 2;
+}

package/src/email.proto

@@ -0,0 +1,76 @@
+syntax = "proto3";
+
+package email;
+
+service EmailService {
+  rpc SendVerificationEmail(SendVerificationEmailRequest) returns (SendVerificationEmailResponse);
+  rpc CheckVerificationEmail(CheckVerificationEmailRequest) returns (CheckVerificationEmailResponse);
+  rpc SendMessageEmail(SendMessageEmailRequest) returns (SendMessageEmailResponse);
+  rpc SendRecoveryPasswordEmail(SendRecoveryPasswordEmailRequest) returns (SendRecoveryPasswordEmailResponse);
+  rpc checkRecoveryPasswordToken(CheckRecoveryPasswordTokenRequest) returns (CheckRecoveryPasswordTokenResponse);
+  rpc GetEmailVerificationByToken(GetEmailVerificationByTokenRequest) returns (GetEmailVerificationByTokenResponse);
+
+}
+
+message SendVerificationEmailRequest {
+  string email = 1;
+  optional string customerId = 2;
+  string template = 3;
+  string subject = 4;
+}
+
+message SendVerificationEmailResponse {
+  bool success = 1;
+}
+
+message CheckVerificationEmailRequest {
+  string token = 1;
+}
+
+message CheckVerificationEmailResponse {
+  bool success = 1;
+}
+
+message SendMessageEmailRequest {
+  string email = 1;
+  string template = 2;
+  optional string subject = 3;
+}
+
+message SendMessageEmailResponse {
+  bool success = 1;
+}
+
+message SendRecoveryPasswordEmailRequest {
+  string email = 1;
+  string customerId = 2;
+  string subject = 3;
+}
+
+message SendRecoveryPasswordEmailResponse {
+  bool success = 1;
+}
+
+message CheckRecoveryPasswordTokenRequest {
+  string token = 1;
+  string email = 2;
+}
+
+message CheckRecoveryPasswordTokenResponse {
+  bool success = 1;
+  int32 attemptsLeft = 2;
+  string message = 3;
+}
+
+message GetEmailVerificationByTokenRequest {
+  string token = 1;
+}
+
+message GetEmailVerificationByTokenResponse {
+  string recipientId = 1;
+  string recipientType = 2;
+  string token = 3;
+  string expiresAt = 4;
+  bool isVerified = 5;
+}
+

package/src/expo-push.proto

@@ -0,0 +1,27 @@
+syntax = "proto3";
+
+package expoPush;
+
+service ExpoPushService {
+  rpc SendNotification (NotificationDto) returns (Empty);
+
+}
+
+message NotificationDto {
+  repeated string pushTokens = 1;
+  string title = 2;
+  optional string body = 3;
+  map<string, string> data = 4;
+}
+
+message DataValue {
+  oneof value {
+    string stringValue = 1;
+    int32 intValue = 2;
+    bool boolValue = 3;
+    double floatValue = 4;
+  }
+}
+
+message Empty {}
+

package/src/fee.proto

@@ -0,0 +1,65 @@
+syntax = "proto3";
+
+package fee;
+
+service FeeService {
+  rpc CreateFee(CreateFeeDto) returns (FeeEntity);
+  rpc UpdateRecipientFee(UpdateFeeDto) returns (FeeEntity);
+  rpc GetAllDefaultFees(Void) returns (FeeEntityList);
+  rpc GetFeeForRecipientAndMethod(GetFeeRequest) returns (FeeEntity);
+
+}
+
+message CreateFeeDto {
+  string method = 1;
+  string type = 2;
+  double base = 3;
+  optional double percentage = 4;
+  optional double promotionalBase = 5;
+  optional double promotionalPercentage = 6;
+  optional string description = 7;
+  int32 installment = 8;
+  string brand = 9;
+}
+
+message UpdateFeeDto {
+  optional string method = 1;
+  optional string type = 2;
+  optional double base = 3;
+  optional double percentage = 4;
+  optional double promotionalBase = 5;
+  optional double promotionalPercentage = 6;
+  optional string description = 7;
+  optional int32 installment = 8;
+  optional string brand = 9;
+  string recipientId = 10;
+  string feeId = 11;
+}
+
+message GetFeeRequest {
+  string recipientId = 1;
+  string method = 2;
+  optional int32 installment = 3;
+  optional string brand = 4;
+}
+
+message FeeEntity {
+  string id = 1;
+  string method = 2;
+  string type = 3;
+  double base = 4;
+  double percentage = 5;
+  double promotionalBase = 6;
+  double promotionalPercentage = 7;
+  optional string description = 8;
+  int32 installment = 9;
+  bool isDefault = 10;
+  string brand = 11;
+}
+
+message FeeEntityList {
+  repeated FeeEntity fees = 1;
+}
+
+message Void {}
+