@postpaybr/protos 1.1.0

package/src/location.proto

@@ -0,0 +1,40 @@
+syntax = "proto3";
+
+package location;
+
+service LocationService {
+  rpc GetCities (GetCitiesRequest) returns (GetCitiesResponse);
+  rpc GetStates (GetStatesRequest) returns (GetStatesResponse);
+
+}
+
+message State {
+  string id = 1;
+  string code = 2;
+  string name = 3;
+  int32 nationalCode = 4;
+  repeated City cities = 5;
+}
+
+message City {
+  string id = 1;
+  string name = 2;
+  int32 nationalCode = 3;
+  bool active = 4;
+  State state = 5;
+}
+
+message GetCitiesRequest {
+  int32 nationalCode = 1;
+}
+
+message GetCitiesResponse {
+  repeated City cities = 1;
+}
+
+message GetStatesRequest {}
+
+message GetStatesResponse {
+  repeated State states = 1;
+}
+

package/src/notification.proto

@@ -0,0 +1,207 @@
+syntax = "proto3";
+
+package notification;
+
+service NotificationService {
+  rpc CreateNotification(CreateNotificationRequest) returns (NotificationResponse);
+  rpc GetNotificationById(GetNotificationByIdRequest) returns (NotificationResponse);
+  rpc GetAllNotifications(GetAllNotificationsRequest) returns (NotificationsResponse);
+  rpc CountUnreadNotifications(CountUnreadNotificationsRequest) returns (CountUnreadNotificationsResponse);
+  rpc MarkAsRead(MarkAsReadRequest) returns (MarkAsReadResponse);
+
+  rpc CreateSecurityNotification(CreateSecurityNotificationRequest) returns (NotificationResponse);
+  rpc CreatePasswordChangedNotification(CreatePasswordChangedNotificationRequest) returns (NotificationResponse);
+  rpc CreateMaintenanceNotification(CreateMaintenanceNotificationRequest) returns (NotificationResponse);
+  rpc CreateTermsUpdatedNotification(CreateTermsUpdatedNotificationRequest) returns (NotificationResponse);
+  rpc CreateProfileUpdatedNotification(CreateProfileUpdatedNotificationRequest) returns (NotificationResponse);
+  rpc GetNotificationStatus(GetNotificationStatusRequest) returns (GetNotificationStatusResponse); 
+}
+
+message GetAllNotificationsDto {
+  string recipientId = 1;
+  string recipientType = 2;
+  repeated int32 severities = 3; 
+  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;
+  string newValue = 3;
+}
+
+message ChangePoint {
+  string title = 1;
+  string description = 2;
+}
+
+message NotificationMetadata {
+  optional string actionLabel = 1;
+  optional string url = 2;
+  
+  optional string deviceInfo = 3;
+  optional string location = 4;
+  optional string eventDate = 5;
+  optional string securityAction = 6;
+  
+  repeated NotificationChange changes = 7;
+
+  optional string startDate = 8;
+  optional string endDate = 9;
+  optional string impactDescription = 10;
+  
+  optional string updateReason = 11;
+  repeated ChangePoint changePoints = 12;
+  
+  optional string userId = 13;
+  optional string scheduledPaymentDate = 14;
+  optional double paymentAmount = 15;
+  optional string paymentStatus = 16;
+  optional string paymentMethod = 17;
+  optional string chargeId = 18;
+  optional string receiptId = 19;
+  optional string taxId = 20;
+  
+  map<string, string> params = 21;
+  optional string actionButtonVariant = 22;
+  optional string callToAction = 23;
+}
+
+message Notification {
+  string id = 1;
+  string title = 2;
+  string description = 3;
+  bool isRead = 4;
+  int32 severity = 5;
+  string createdAt = 6;
+  string updatedAt = 7;
+  string category = 8;
+  string recipientType = 9;
+  string recipientId = 10;
+  optional string imageUrl = 11;
+  optional string imageType = 12;
+  optional NotificationMetadata meta = 13;
+}
+
+message CreateNotificationRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+  string title = 3;
+  string description = 4;
+  optional int32 severity = 5;
+  optional string category = 6;
+  optional NotificationMetadata meta = 7;
+  optional bool isRead = 8;
+  optional string imageUrl = 9;
+  optional string imageType = 10;
+}
+
+message NotificationResponse {
+  Notification notification = 1;
+}
+
+message GetNotificationByIdRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+  string id = 3;
+}
+
+message GetAllNotificationsRequest {
+  GetAllNotificationsDto data = 1;
+  DateFilter dateFilter = 2;
+  PaginationFilter pagination = 3;
+}
+
+message NotificationsResponse {
+  repeated Notification notifications = 1;
+  int32 count = 2;
+}
+
+message CountUnreadNotificationsRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+}
+
+message CountUnreadNotificationsResponse {
+  int32 countNotRead = 1;
+}
+
+message MarkAsReadRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+  string notificationId = 3;
+}
+
+message MarkAsReadResponse {
+  bool success = 1;
+}
+
+
+message CreateSecurityNotificationRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+  optional string deviceInfo = 3;
+  optional string location = 4;
+  string eventDate = 5;
+  optional string imageUrl = 6;
+  optional string imageType = 7;
+}
+
+message CreatePasswordChangedNotificationRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+  optional string deviceInfo = 3;
+  optional string location = 4;
+  string eventDate = 5;
+  optional string imageUrl = 6;
+  optional string imageType = 7;
+}
+
+message CreateMaintenanceNotificationRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+  string startDate = 3;
+  string endDate = 4;
+  string impactDescription = 5;
+  optional string imageUrl = 6;
+  optional string imageType = 7;
+}
+
+message CreateTermsUpdatedNotificationRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+  string updateReason = 3;
+  repeated ChangePoint changePoints = 4;
+  optional string imageUrl = 5;
+  optional string imageType = 6;
+}
+
+message CreateProfileUpdatedNotificationRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+  repeated NotificationChange changes = 3;
+  optional string imageUrl = 4;
+  optional string imageType = 5;
+}
+
+message GetNotificationStatusRequest {
+  string recipientId = 1;
+  string recipientType = 2;
+}
+
+message GetNotificationStatusResponse {
+  bool hasCritical = 1;
+  bool hasUpdates = 2;
+  bool allCriticalRead = 3;
+  bool allUpdatesRead = 4;
+}

package/src/order.proto

@@ -0,0 +1,189 @@
+syntax = "proto3";
+
+package order;
+
+service OrderService {
+  rpc CreateOrder(CreateOrderRequest) returns (Order);
+  rpc GetOrderById(GetOrderByIdRequest) returns (Order);
+  rpc GetAllOrders(GetAllOrdersRequest) returns (GetAllOrdersResponse);
+  rpc CreateOrderItems(CreateOrderItemsRequest) returns (Void);
+  rpc GetReceiptsByOrderId(GetReceiptsByOrderIdRequest) returns (GetReceiptsByOrderIdResponse);
+  rpc updateOrderStatus(updateOrderStatusRequest) returns (Order);
+
+  rpc GetOrderCustomerName(GetOrderByIdRequest) returns (GetOrderCustomerNameResponse);
+  rpc updateOrderWithChargeId(updateOrderWithChargeIdRequest) returns (Void);
+  rpc updateOrderAmountAndStatus (UpdateOrderAmountAndStatusRequest) returns (Order);
+  rpc GetDetailedOrder(GetOrderByIdRequest) returns (DetailedOrderResponse);
+}
+
+message CreateOrderRequest {
+  string customerId = 1;
+  double totalAmount = 2;
+  string orderType = 3;
+}
+
+message GetOrderByIdRequest {
+  string id = 1;
+  optional string orderType = 2;
+}
+
+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;
+}
+
+message GetAllOrdersResponse {
+  repeated Order orders = 1;
+  int32 count = 2;
+}
+
+message CreateOrderItemsRequest {
+  Order order = 1;
+  repeated string taxIds = 2;
+  string orderType = 3;
+}
+
+message GetReceiptsByOrderIdRequest {
+  string orderId = 1;
+  string orderType = 3;
+}
+
+message GetReceiptsByOrderIdResponse {
+  repeated ReceiptEntity receipts = 1;
+}
+
+message updateOrderStatusRequest {
+  string orderId = 1;
+  string orderStatus = 2;
+  string orderType = 3;
+}
+
+message HealthCheckRequest {}
+message HealthCheckResponse {
+  string status = 1;
+  map<string, string> details = 2;
+}
+
+message Void {}
+
+message Order {
+  string id = 1;
+  double totalAmount = 2;
+  string status = 3;
+  string createdAt = 4;
+  string updatedAt = 5;
+  repeated string chargeIds = 6;
+  string customerId = 7;
+  repeated OrderItem items = 8;
+  OrderSchedule orderSchedule = 9;
+  optional string type = 10;
+}
+
+message OrderSchedule {
+  string id = 1;
+  double totalAmount = 2;
+  string status = 3;
+  string createdAt = 4;
+  string updatedAt = 5;
+  repeated string chargeIds = 6;
+  string customerId = 7;
+  repeated OrderItem items = 8;
+  Order order = 9;
+}
+
+message OrderItem {
+  string id = 1;
+  Order order = 2;
+  OrderSchedule orderSchedule = 3;
+  string recipientId = 4;
+  string taxId = 5;
+}
+
+message ReceiptEntity {
+  string id = 1;
+  string customerId = 2;
+  double amount = 3;
+  string protocol = 4;
+  optional string txid = 5;
+  string createdAt = 6;
+}
+
+message GetOrderCustomerNameResponse {
+  string customerName = 1;
+}
+
+message updateOrderWithChargeIdRequest {
+  string orderId = 1;
+  string chargeId = 2;
+  string orderType = 3;
+}
+
+message UpdateOrderAmountAndStatusRequest {
+  string id = 1;
+  string orderType = 2;
+  double totalAmount = 3;
+  optional string status = 4;
+}
+
+message OrderDetail {
+  string id = 1;
+  double totalAmount = 2;
+  string status = 3;
+  string createdAt = 4;
+  string updatedAt = 5;
+  repeated string chargeIds = 6;
+  string customerId = 7;
+  string type = 8;
+}
+
+message OrderPayments {
+  double totalPaid = 1;
+  double totalPending = 2;
+  optional string nextPaymentDate = 3;
+  optional string paymentMethod = 4;
+  string customerName = 5;
+}
+
+message DetailedTax {
+  string id = 1;
+  string type = 2;
+  string description = 3;
+  double amount = 4;
+  int32 year = 5;
+  string documentId = 6;
+}
+
+message DetailedRecipient {
+  string id = 1;
+  string code = 2;
+  string commercialName = 3;
+  string socialReason = 4;
+}
+
+message DetailedOrderItem {
+  string id = 1;
+  string recipientId = 2;
+  string taxId = 3;
+  optional DetailedTax taxDetails = 4;
+  optional DetailedRecipient recipientDetails = 5;
+  optional string recipientName = 6;
+}
+
+message DetailedOrderResponse {
+  OrderDetail order = 1;
+  repeated DetailedOrderItem items = 2;
+  OrderPayments payments = 3;
+}

package/src/payable.proto

@@ -0,0 +1,246 @@
+syntax = "proto3";
+
+package payable;
+
+service PayableService {
+  rpc CreatePayable (CreatePayableRequest) returns (PayableResponse);
+  rpc GetPayablesByChargeId (GetPayablesByChargeIdRequest) returns (GetPayablesByChargeIdResponse);
+  rpc GetPayableById (GetPayableByIdRequest) returns (PayableResponse);
+  rpc GetPayablesByRecipientId (GetPayablesByRecipientIdRequest) returns (GetPayablesByRecipientIdResponse);
+
+  rpc UpdatePayablesStatus (UpdatePayablesStatusRequest) returns (UpdatePayablesStatusResponse);
+  rpc GetPayablesAvailableForAnticipation (GetPayablesAvailableForAnticipationRequest) returns (GetPayablesAvailableForAnticipationResponse);
+  rpc MarkPayableAsAnticipated (MarkPayableAsAnticipatedRequest) returns (PayableResponse);
+  rpc DeletePayable (DeletePayableRequest) returns (DeletePayableResponse);
+  rpc GetAllPayables (GetAllPayablesRequest) returns (GetAllPayablesResponse);
+  rpc GetPayablesSummary (GetPayablesSummaryRequest) returns (GetPayablesSummaryResponse);
+  rpc GetPayableDetails (GetPayableDetailsRequest) returns (GetPayableDetailsResponse);
+  rpc ForceTransfer (ForceTransferRequest) returns (PayableResponse);
+  rpc ForceAnticipation (ForceAnticipationRequest) returns (PayableResponse);
+}
+
+message CreatePayableRequest {
+  double amount = 1;
+  string chargeId = 2;
+  string recipientId = 3;
+  int32 installment = 4;
+  string dueAt = 5;
+  string status = 6;
+}
+
+message PayableResponse {
+  Payable payable = 1;
+}
+
+message GetPayablesByChargeIdRequest {
+  string chargeId = 1;
+}
+
+message GetPayablesByChargeIdResponse {
+  repeated Payable payables = 1;
+}
+
+message Payable {
+  string id = 1;
+  double amount = 2;
+  int32 installment = 3;
+  string status = 4;
+  string dueAt = 5;
+  string createdAt = 6;
+  bool isAnticipated = 7;
+  Anticipation anticipation = 8;
+  optional string chargeId = 9;
+  optional string recipientId = 10;
+  optional string processedAt = 11;
+}
+
+message Anticipation {
+  string id = 1;
+  string createdAt = 2;
+}
+
+message GetPayableByIdRequest {
+  string payableId = 1;
+}
+
+message GetPayablesByRecipientIdRequest {
+  string recipientId = 1;
+  optional string startDate = 2;
+  optional string endDate = 3;
+}
+
+message GetPayablesByRecipientIdResponse {
+  repeated RecipientPayable payables = 1;
+}
+
+message RecipientPayable {
+  string customer = 1;
+  int32 installment = 2;
+  int32 installmentNumber = 3;
+  string dueAt = 4;
+  string paymentMethod = 5;
+  double amount = 6;
+  double fee = 7;
+  double netAmount = 8;
+  string chargeId = 9;
+  string payableId = 10;
+}
+
+
+message UpdatePayablesStatusRequest {
+  repeated string payableIds = 1;
+  string status = 2;
+}
+
+message UpdatePayablesStatusResponse {
+  int32 affected = 1;
+}
+
+message GetPayablesAvailableForAnticipationRequest {
+  string recipientId = 1;
+}
+
+message GetPayablesAvailableForAnticipationResponse {
+  repeated Payable payables = 1;
+}
+
+message MarkPayableAsAnticipatedRequest {
+  string payableId = 1;
+}
+
+message DeletePayableRequest {
+  string id = 1;
+}
+
+message DeletePayableResponse {
+  int32 affected = 1;
+}
+
+message GetAllPayablesRequest {
+  optional GetAllPayablesData data = 1;
+  PaginationFilter pagination = 2;
+  DateFilter date = 3;
+}
+
+message GetAllPayablesData {
+  optional string recipientId = 1;
+  repeated string statuses = 2;
+  optional bool isAnticipated = 3;
+}
+
+message PaginationFilter {
+  int32 limit = 1;
+  int32 offset = 2;
+}
+
+message DateFilter {
+  optional string startDate = 1;
+  optional string endDate = 2;
+}
+
+message GetAllPayablesResponse {
+  repeated PayableWithDetails payables = 1;
+  int32 count = 2;
+}
+
+message PayableWithDetails {
+  string id = 1;
+  optional string customer = 2;
+  int32 installment = 3;
+  optional int32 totalInstallments = 4;
+  string dueDate = 5;
+  optional string paymentMethod = 6;
+  double amount = 7;
+  optional double fee = 8;
+  string status = 9;
+  bool isAnticipated = 10;
+  string createdAt = 11;
+  optional string processedAt = 12;
+  optional Anticipation anticipation = 13;
+  optional Transfer transfer = 14;
+  string chargeId = 15;
+  string recipientId = 16;
+}
+
+message Transfer {
+  string id = 1;
+  string status = 2;
+  string createdAt = 3;
+}
+
+message GetPayablesSummaryRequest {
+  string recipientId = 1;
+  optional string startDate = 2;
+  optional string endDate = 3;
+}
+
+message GetPayablesSummaryResponse {
+  PayablesSummary summary = 1;
+}
+
+message PayablesSummary {
+  double totalAmount = 1;
+  double pendingAmount = 2;
+  double transferredAmount = 3;
+  double anticipatedAmount = 4;
+  int32 payablesCount = 5;
+  int32 pendingCount = 6;
+  int32 transferredCount = 7;
+  int32 anticipatedCount = 8;
+}
+
+message GetPayableDetailsRequest {
+  string payableId = 1;
+}
+
+message GetPayableDetailsResponse {
+  PayableDetails payableDetails = 1;
+}
+
+message PayableDetails {
+  Payable payable = 1;
+  optional AnticipationDetails anticipation = 2;
+  optional TransferDetails transfer = 3;
+  optional ChargeDetails charge = 4;
+  optional string customer = 5;
+}
+
+message AnticipationDetails {
+  string id = 1;
+  double amount = 2;
+  double fee = 3;
+  double baseFee = 4;
+  double feePercentage = 5;
+  int32 anticipatedDays = 6;
+  string status = 7;
+  string externalId = 8;
+  string createdAt = 9;
+  string updatedAt = 10;
+}
+
+message TransferDetails {
+  string id = 1;
+  double amount = 2;
+  string status = 3;
+  string description = 4;
+  string createdAt = 5;
+  optional string processedAt = 6;
+}
+
+message ChargeDetails {
+  string id = 1;
+  double amount = 2;
+  double fee = 3;
+  int32 installmentNumber = 4;
+  string paymentMethod = 5;
+  string status = 6;
+  string createdAt = 7;
+}
+
+message ForceTransferRequest {
+  string payableId = 1;
+}
+
+message ForceAnticipationRequest {
+  string payableId = 1;
+}

package/src/payer.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package payer;
+
+service PayerService {
+  rpc FindOrCreatePayer (PayerDto) returns (Payer);
+
+}
+
+message PayerDto {
+  optional string id = 1;               
+  string name = 2;             
+  string document = 3;      
+  optional string phone = 4;            
+}
+
+
+message Payer {
+  string id = 1;               
+  string name = 2;             
+  string document = 3;         
+  string phone = 4;
+}
+