@postpaybr/protos 1.1.0

package/src/receipt.proto

@@ -0,0 +1,212 @@
+syntax = "proto3";
+
+package receipt;
+
+service ReceiptService {
+  rpc createReceipt (CreateReceiptRequest) returns (ReceiptResponse);
+  rpc getReceipt (GetReceiptRequest) returns (ReceiptDetailResponse);
+  rpc getAllReceipts (GetAllReceiptsRequest) returns (ReceiptsListResponse);
+  rpc updateTxidByChargeId (UpdateTxidRequest) returns (ReceiptsResponse);
+  rpc getPaymentSummaryPreview (PaymentSummaryPreviewRequest) returns (PaymentSummaryPreviewResponse);
+  rpc getReceiptsByTaxIds (ReceiptsByTaxIdsRequest) returns (ReceiptsResponse);
+  rpc getReceiptsByTaxIdsExcludingSeeded (ReceiptsByTaxIdsRequest) returns (ReceiptsResponse);
+  rpc getReceiptById (GetReceiptByIdRequest) returns (ReceiptResponse);
+  rpc deleteReceiptByChargeId (deleteReceiptByChargeIdRequest) returns (DeleteReceiptsResponse); 
+}
+
+message CreateReceiptRequest {
+  string customerId = 1;
+  CreateReceiptDto data = 2;
+}
+
+message GetReceiptRequest {
+  string customerId = 1;
+  string id = 2;
+}
+
+message GetAllReceiptsRequest {
+  string customerId = 1;
+  DateFilter dateFilter = 2;
+  PaginationFilter pagination = 3;
+}
+
+message UpdateTxidRequest {
+  string chargeId = 1;
+  string txid = 2;
+}
+
+message PaymentSummaryPreviewRequest {
+  string customerId = 1;
+  string orderId = 2;
+  string orderType = 3;
+}
+
+message ReceiptsByTaxIdsRequest {
+  repeated string taxIds = 1;
+}
+
+message GetReceiptByIdRequest {
+  string id = 1;
+}
+
+message ReceiptResponse {
+  string id = 1;
+  double amount = 2;
+  string protocol = 3;
+  string txid = 4;
+  string createdAt = 5;
+  string payableId = 6;
+  string customerId = 7;
+  string taxId = 8;
+  optional string chargeId = 12;
+  optional bool isNfseIssued = 13;
+  map<string, string> metadata = 14;
+}
+
+message ReceiptDetailResponse {
+  string id = 1;
+  string createdAt = 2;
+  string method = 3;
+  double discountPercentage = 4;
+  double discountAmount = 5;
+  double fee = 6;
+  double fine = 7;
+  double amount = 8;
+  string protocol = 9;
+  string txid = 10;
+  TaxDetail tax = 11;
+}
+
+message ReceiptsListResponse {
+  repeated ReceiptListItem receipts = 1;
+  int32 count = 2;
+}
+
+message ReceiptListItem {
+  string id = 1;
+  string recipient = 2;
+  string paymentDate = 3;
+  double amount = 4;
+  string method = 5;
+  string taxType = 6;
+}
+
+message ReceiptsResponse {
+  repeated ReceiptResponse receipts = 1;
+}
+
+message PaymentSummaryPreviewResponse {
+  PaymentSummary summary = 1;
+  repeated IndividualPayment paymentsMade = 2;
+  repeated IndividualPayment scheduledPayments = 3;
+}
+
+message CreateReceiptDto {
+  double amount = 1;
+  string protocol = 2;
+  string chargeId = 3;
+  string taxId = 4;
+  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;
+  string metaType = 4;
+  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;
+  string description = 3;
+  int32 year = 4;
+  string documentId = 5;
+}
+
+message LocationInfo {
+  int32 state = 1;
+  int32 city = 2;
+  string recipientId = 3;
+}
+
+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 Payer {
+  string name = 2;
+  string document = 3;
+}
+
+message PaymentSummary {
+  optional double totalPaymentsMade = 1;
+  optional double totalScheduledPayments = 2;
+  string timestamp = 3;
+}
+
+message IndividualPayment {
+  string id = 1;
+  string createdAt = 2;
+  string paymentMethod = 3;
+  string propertyDocument = 4;
+  string propertyDetail = 5;
+  int32 installmentNumber = 6;
+  double installmentValue = 7;
+  optional ChargeScheduleDetail schedule = 8;
+  string taxType = 9;
+  string status = 10;
+}
+
+message ChargeScheduleDetail {
+  string executionDate = 2;
+  bool isExecuted = 3;
+}
+
+message deleteReceiptByChargeIdRequest {
+  string chargeId = 1;
+}
+
+message DeleteReceiptsResponse {
+  int32 affected = 1;
+}

package/src/recipient-payment-gateway.proto

@@ -0,0 +1,101 @@
+syntax = "proto3";
+
+package recipientPaymentGateway;
+
+service RecipientPaymentGatewayService {
+  rpc CreateRecipientPaymentGateway(CreateRecipientPaymentGatewayRequest) returns (RecipientPaymentGatewayResponse);
+  rpc DeleteRecipientPaymentGateway(DeleteRecipientPaymentGatewayRequest) returns (Void);
+  rpc GetGatewayByRecipientAndType(GetGatewayByRecipientAndTypeRequest) returns (RecipientPaymentGatewayResponse);
+  rpc GetAvailableGateways(GetAvailableGatewaysRequest) returns (PaymentGatewayListResponse);
+  rpc ListGatewayIdentifications(Void) returns (GatewayIdentificationListResponse);
+
+  rpc GetRecipientPaymentGatewaysByRecipientId(GetRecipientPaymentGatewaysByRecipientIdRequest) returns (RecipientPaymentGatewayListResponse);
+}
+
+message RecipientPaymentGateway {
+  string id = 1;
+  string recipientId = 2;
+  string paymentGatewayId = 3;
+  string type = 4;
+  bool isPixEnabled = 5;
+  bool isCreditCardEnabled = 6;
+  bool isDebitCardEnabled = 7;
+  bool isAutomaticAnticipationEnabled = 8;
+  bool isManualAnticipationEnabled = 9;
+  string createdAt = 10;
+  string updatedAt = 11;
+  string gatewayId = 12;
+}
+
+message PaymentGateway {
+  string id = 1;
+  string name = 2;
+  string gatewayId = 3;
+  bool supportsPix = 4;
+  bool supportsCreditCard = 5;
+  bool supportsDebitCard = 6;
+  bool supportsAutomaticAnticipation = 7;
+  bool supportsManualAnticipation = 8;
+  bool isActive = 9;
+  string createdAt = 10;
+  string updatedAt = 11;
+}
+
+message RecipientPaymentGatewayResponse {
+  RecipientPaymentGateway recipientPaymentGateway = 1;
+}
+
+message RecipientPaymentGatewayListResponse {
+ repeated RecipientPaymentGateway recipientPaymentGateways = 1;
+}
+
+
+message PaymentGatewayListResponse {
+  repeated PaymentGateway gateways = 1;
+}
+
+message GatewayIdentificationListResponse {
+  repeated string gateways = 1;
+}
+
+message CreateRecipientPaymentGatewayRequest {
+  string recipientId = 1;
+  string paymentGatewayId = 2;
+  string type = 3;
+  bool isPixEnabled = 4;
+  bool isCreditCardEnabled = 5;
+  bool isDebitCardEnabled = 6;
+  bool isAutomaticAnticipationEnabled = 7;
+  bool isManualAnticipationEnabled = 8;
+}
+
+message DeleteRecipientPaymentGatewayRequest {
+  string id = 1;
+}
+
+message GetGatewayByRecipientAndTypeRequest {
+  string recipientId = 1;
+  string method = 2;
+  string type = 3;
+}
+
+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;
+}

package/src/recipient.proto

@@ -0,0 +1,237 @@
+syntax = "proto3";
+
+package recipient;
+
+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 GetRecipientFees (GetRecipientFeesRequest) returns (RecipientFeesResponse);
+  rpc GetRecipientGateways (GetRecipientGatewaysRequest) returns (RecipientGatewaysResponse);
+  rpc UpdateRecipientAvatar (UpdateRecipientAvatarRequest) returns (RecipientResponse);
+  rpc GetRecipientDetailsById (GetRecipientDetailsByIdRequest) returns (RecipientDetailsResponse);
+
+  rpc IsAutomaticAnticipationEnabled (IsAutomaticAnticipationEnabledRequest) returns (IsAutomaticAnticipationEnabledResponse);
+  rpc GetExternalRecipientId (GetExternalRecipientIdRequest) returns (GetExternalRecipientIdResponse);
+}
+
+message Recipient {
+  string id = 1;
+  string code = 2;
+  string commercialName = 3;
+  string socialReason = 4;
+  string holderType = 5;
+  string document = 6;
+  string cnaeId = 7;
+  string avatarUrl = 8;
+  string legalType = 9;
+  string foundation = 10;
+  string contactName = 11;
+  string contactEmail = 12;
+  string contactPhone = 13;
+  string createdAt = 14;
+  string updatedAt = 15;
+  string addressId = 16;
+  bool isActive = 17;
+  string providerStatus = 18;
+}
+
+message RecipientResponse {
+  Recipient recipient = 1;
+}
+
+message GetRecipientByIdRequest {
+  string id = 1;
+}
+
+message GetRecipientByCodeRequest {
+  string code = 1;
+}
+
+message GetRecipientNameByIdRequest {
+  string id = 1;
+}
+
+message RecipientNameResponse {
+  string name = 1;
+}
+
+message Void {}
+
+message GetAllRecipientsResponse {
+  repeated Recipient recipients = 1;
+}
+
+message GetRecipientFeesRequest {
+  string id = 1;
+}
+
+message Fee {
+  string id = 1;
+  string method = 2;
+  string type = 3;
+  double base = 4;
+  double percentage = 5;
+  double promotionalBase = 6;
+  double promotionalPercentage = 7;
+  string description = 8;
+  int32 installment = 9;
+  bool isDefault = 10;
+  string brand = 11;
+}
+
+message RecipientFeesResponse {
+  repeated Fee fees = 1;
+}
+
+message GetRecipientGatewaysRequest {
+  string id = 1;
+}
+
+message RecipientGateway {
+  string id = 1;
+  string type = 2;
+  bool isAutomaticAnticipationEnabled = 3;
+  bool isManualAnticipationEnabled = 4;
+  bool isPixEnabled = 5;
+  bool isCreditCardEnabled = 6;
+  bool isDebitCardEnabled = 7;
+  string createdAt = 8;
+  string updatedAt = 9;
+}
+
+message RecipientGatewaysResponse {
+  repeated RecipientGateway gateways = 1;
+}
+
+message ImageData {
+  string mimetype = 1;
+  bytes buffer = 2;
+}
+
+message UpdateRecipientAvatarRequest {
+  string id = 1;
+  ImageData avatar = 2;
+}
+
+message GetRecipientDetailsByIdRequest {
+  string id = 1;
+}
+
+message Address {
+  string id = 1;
+  string zipCode = 2;
+  string street = 3;
+  string number = 4;
+  string complement = 5;
+  string neighborhood = 6;
+  string city = 7;
+  string state = 8;
+  string nickname = 9;
+  string reference = 10;
+}
+
+message BankAccount {
+  string id = 1;
+  int32 bankCompeCode = 2;
+  string agency = 3;
+  string account = 4;
+  string digitAccount = 5;
+  double balance = 6;
+  string pixKey = 7;
+  string holderType = 8;
+  string accountType = 9;
+}
+
+message Representative {
+  string id = 1;
+  string name = 2;
+  string email = 3;
+  string phone = 4;
+  string document = 5;
+  string birthDate = 6;
+}
+
+message RecipientDetailsResponse {
+  Recipient recipient = 1;
+  Address address = 2;
+  BankAccount bankAccount = 3;
+  Representative representative = 4;
+}
+
+message CreateRecipientRequest {
+  string code = 1;
+  string commercialName = 2;
+  string socialReason = 3;
+  string holderType = 4;
+  string document = 5;
+  string cnaeId = 6;
+  string legalType = 7;
+  string contactName = 8;
+  string contactEmail = 9;
+  string contactPhone = 10;
+  string foundation = 11;
+  CreateAddressDto address = 12;  
+  CreateBankAccountDto bankAccount = 13;  
+  CreateRepresentativeDto representative = 14;
+}
+
+message CreateAddressDto {
+  string state = 1;
+  string city = 2;
+  string zipCode = 3;
+  string neighborhood = 4;
+  string street = 5;
+  string number = 6;
+  optional string nickname = 7;
+  optional string complement = 8;
+  optional string recipientId = 10;
+  optional string reference = 11;
+}
+
+message CreateBankAccountDto {
+  int32 bankCompeCode = 1;
+  string holderType = 2;
+  string agency = 3;
+  string account = 4;
+  string digitAccount = 5;
+  string accountType = 6;
+  optional string pixKey = 7;
+  optional double balance = 8;
+}
+
+message CreateRepresentativeDto {
+  string name = 1;
+  string email = 2;
+  string phone = 3;
+  string document = 4;
+  string birthDate = 5;
+}
+
+
+message UpdateRecipientRequest {
+  string id = 1;
+  CreateRecipientRequest data = 2;
+}
+
+
+message IsAutomaticAnticipationEnabledRequest {
+  string recipientId = 1;
+  string gatewayId = 2;
+}
+
+message IsAutomaticAnticipationEnabledResponse {
+  bool isEnabled = 1;
+}
+
+message GetExternalRecipientIdRequest {
+  string recipientId = 1;
+  string gatewayId = 2;
+}
+
+message GetExternalRecipientIdResponse {
+  string externalRecipientId = 1;
+}

package/src/role.proto

@@ -0,0 +1,57 @@
+syntax = "proto3";
+
+package role;
+
+service RoleService {
+  rpc CreateRole (CreateRoleRequest) returns (Role);
+  rpc DeleteRole (DeleteRoleRequest) returns (DeleteRoleResponse);
+  rpc GetRoleById (GetRoleByIdRequest) returns (Role);
+  rpc GetAllRoles (GetAllRolesRequest) returns (GetAllRolesResponse);
+  rpc UpdateRole (Role) returns (Role);
+  rpc GetPermissionGroups (GetPermissionGroupsRequest) returns (GetPermissionGroupsResponse);
+
+}
+
+message CreateRoleRequest {
+  string code = 1; 
+  string description = 2;
+  repeated string permissions = 3;
+}
+
+message DeleteRoleRequest {
+  string id = 1;
+}
+
+message DeleteRoleResponse {
+  bool success = 1;
+}
+
+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;
+}
+
+message GetPermissionGroupsRequest {}
+
+message PermissionGroup {
+  string group = 1;
+  string description = 2;
+  repeated string permissions = 3;
+}
+
+message GetPermissionGroupsResponse {
+  repeated PermissionGroup permissionGroups = 1;
+}
+

package/src/sms.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+
+package sms;
+
+service SmsService {
+  rpc SendSmsToVerify (SendSmsToVerifyRequest) returns (SendSmsToVerifyResponse);
+  rpc VerifySmsCode (VerifySmsCodeRequest) returns (VerifySmsCodeResponse);
+
+}
+
+message SendSmsToVerifyRequest {
+  string phoneNumber = 1;
+}
+
+message SendSmsToVerifyResponse {
+  string id = 1;
+}
+
+message VerifySmsCodeRequest {
+  string id = 1;
+  int32 code = 2;
+}
+
+message VerifySmsCodeResponse {
+  bool success = 1;
+}
+
+message SmsVerifyEntity {
+  string id = 1;
+  string phoneNumber = 2;
+  string errorCodeMessage = 3;
+  int32 verificationCode = 4;
+  int32 attempts = 5;
+  bool verified = 6;
+}
+