@postpaybr/protos 1.1.0

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@postpaybr/protos",
+  "version": "1.1.0",
+  "type": "module",
+  "main": "src/typescript/index.ts",
+  "types": "src/typescript/index.ts",
+  "files": [
+    "src/**/*.proto",
+    "src/typescript"
+  ],
+  "exports": {
+    ".": "./src/typescript/index.ts",
+    "./*.proto": "./src/*.proto",
+    "./typescript/*": "./src/typescript/*"
+  },
+  "scripts": {
+    "generate:proto": "cross-var npx protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=src/typescript -I=src --ts_proto_opt=nestJs=true src/%npm_config_proto%.proto"
+  },
+  "dependencies": {
+    "@nestjs/microservices": "^11.1.13",
+    "@postpaybr/contracts": "latest"
+  },
+  "devDependencies": {
+    "cross-var": "^1.1.0",
+    "ts-proto": "^2.11.2",
+    "typescript": "^5.2.0"
+  }
+}

package/src/account-entry.proto

@@ -0,0 +1,86 @@
+syntax = "proto3";
+
+package accountEntry;
+
+service AccountEntryService {
+  rpc createAccountEntry(CreateAccountEntryRequest) returns (CreateAccountEntryResponse);
+  rpc createAccountEntries(CreateAccountEntriesRequest) returns (CreateAccountEntriesResponse);
+  rpc getEntriesByTransfer(GetEntriesByTransferRequest) returns (GetEntriesByTransferResponse);
+  rpc getEntriesByPeriod(GetEntriesByPeriodRequest) returns (GetEntriesByPeriodResponse);
+
+}
+
+message CreateAccountEntryRequest {
+  double amount = 1;
+  string type = 2;
+  string description = 3;
+  string bankAccountId = 4;
+  string recipientId = 5;
+  optional string transferId = 6;
+  optional string chargeId = 7;
+}
+
+message CreateAccountEntryResponse {
+  AccountEntry accountEntry = 1;
+}
+
+message CreateAccountEntriesRequest {
+  repeated CreateAccountEntryRequest entries = 1;
+}
+
+message CreateAccountEntriesResponse {
+  repeated AccountEntry accountEntries = 1;
+}
+
+message GetEntriesByTransferRequest {
+  string transferId = 1;
+}
+
+message GetEntriesByTransferResponse {
+  repeated AccountEntry accountEntries = 1;
+}
+
+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 GetEntriesByPeriodRequest {
+  string recipientId = 1;
+  TableFilterParams filter = 2;
+}
+
+message GetEntriesByPeriodResponse {
+  repeated AccountEntry accountEntries = 1;
+}
+
+message AccountEntry {
+  string id = 1;
+  double amount = 2;
+  string type = 3;
+  string description = 4;
+  string bankAccountId = 5;
+  string recipientId = 6;
+  optional string transferId = 7;
+  optional string chargeId = 8;
+  string createdAt = 9;
+}
+
+message Charge {
+  string id = 1;
+  double amount = 2;
+  string paymentMethod = 3;
+  string txid = 4;
+  string gatewayId = 5;
+  string metadata = 6;
+}
+
+message DailyBalance {
+  string date = 1;
+  double balance = 2;
+}
+

package/src/address.proto

@@ -0,0 +1,64 @@
+syntax = "proto3";
+
+package address;
+
+service AddressService {
+  rpc CreateAddress(CreateAddressDto) returns (Address);
+  rpc getAddressesByAccountId(getAddressesByAccountIdRequest) returns (AddressList);
+  rpc GetAddressById(GetAddressByIdRequest) returns (Address);
+  rpc UpdateAddress(UpdateAddressRequest) returns (Address);
+}
+
+message Address {
+  string id = 1;
+  string zipCode = 3;
+  string street = 4;
+  string number = 5;
+  optional string complement = 6;
+  string neighborhood = 7;
+  string city = 8;
+  string state = 9;
+  optional string nickname = 10;
+  optional string reference = 11;
+  optional string accountId = 12;
+}
+
+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 reference = 9;
+  optional string accountId = 10;
+}
+
+message getAddressesByAccountIdRequest {
+  string accountId = 1;
+}
+
+message GetAddressByIdRequest {
+  string accountId = 1;
+  string id = 2;
+}
+
+message AddressList {
+  repeated Address addresses = 1;
+}
+
+message UpdateAddressRequest {
+  string id = 1;
+  optional string state = 2;
+  optional string city = 3;
+  optional string zipCode = 4;
+  optional string neighborhood = 5;
+  optional string street = 6;
+  optional string number = 7;
+  optional string nickname = 8;
+  optional string complement = 9;
+  optional string reference = 10;
+  optional string accountId = 11;
+}

package/src/admin-card-verification.proto

@@ -0,0 +1,90 @@
+syntax = "proto3";
+
+package adminCardVerification;
+
+service AdminCardVerificationService {
+  rpc initiateCardVerification(CreateCardVerificationRequest) returns (CardVerificationResponse);
+  rpc updateVerificationStatus(UpdateVerificationStatusRequest) returns (CardVerificationResponse);
+  rpc getVerificationsWithCardDetails(GetVerificationsWithCardDetailsRequest) returns (GetAllVerificationsWithDetailsResponse);
+  rpc getVerificationDetailsById(GetVerificationDetailsByIdRequest) returns (VerificationDetailsResponse);
+
+}
+
+message CreateCardVerificationRequest {
+  string customerId = 1;
+  string cardId = 2;
+  string selfieWithCardUrl = 3;
+  string challenge = 4;
+}
+
+message UpdateVerificationStatusRequest {
+  string id = 1;
+  string status = 2;
+  repeated string rejectionReasons = 3;
+  optional string customRejectionReason = 4;
+  optional string reviewerId = 5;
+}
+
+message CardVerificationResponse {
+  string id = 1;
+  string cardId = 2;
+  string selfieWithCardUrl = 3;
+  repeated string rejectionReasons = 4;
+  string customRejectionReason = 5;
+  repeated VerificationHistory histories = 6;
+  string challenge = 7;
+}
+
+message GetVerificationsWithCardDetailsRequest {
+  string status = 1;
+  optional int32 offset = 2;          
+  optional int32 limit = 3;
+}
+
+message GetAllVerificationsWithDetailsResponse {
+  repeated VerificationWithDetails verifications = 1;
+}
+
+message VerificationWithDetails {
+  string id = 1;
+  string customerName = 2;
+  string cardNumber = 3;
+  string createdAt = 4;
+  string reviewedBy = 5;
+  string status = 6;
+}
+
+message VerificationHistory {
+  string id = 1;
+  string status = 2;
+  string reviewerId = 3;
+  string createdAt = 4;
+}
+
+message GetVerificationDetailsByIdRequest {
+  string id = 1;
+}
+
+message VerificationDetailsResponse {
+  string id = 1;
+  string cardNumber = 2;
+  string cardName = 3;
+  string selfieWithCardUrl = 4;
+  string selfieWithDocumentUrl = 5;
+  string challenge = 6;
+  string status = 7;
+  repeated VerificationHistoryWithAdmin histories = 8;
+  repeated string rejectionReasons = 9;
+  string customRejectionReason = 10;
+}
+
+message VerificationHistoryWithAdmin {
+  string id = 1;
+  string status = 2;
+  string reviewerId = 3;
+  string createdAt = 4;
+  string reviewedBy = 5;
+}
+
+message Empty {}
+

package/src/administrator.proto

@@ -0,0 +1,192 @@
+syntax = "proto3";
+
+package administrator;
+
+service AdministratorService {
+  rpc CreateAdministrator(CreateAdministratorRequest) returns (AdministratorResponse);
+  rpc GetAdministratorById(GetAdministratorByIdRequest) returns (AdministratorResponse);
+  rpc UpdateAdministrator(UpdateAdministratorRequest) returns (AdministratorResponse);
+  rpc GetAllAdministrators(GetAllAdministratorsRequest) returns (GetAllAdministratorsResponse);
+  rpc ValidateAndSignIn(ValidateAndSignInRequest) returns (ValidateAndSignInResponse);
+  rpc VerifyTwoFactorAuthentication(VerifyTwoFactorAuthenticationRequest) returns (VerifyTwoFactorAuthenticationResponse);
+  rpc RefreshAccessToken(RefreshTokenRequest) returns (RefreshTokenResponse);
+  rpc handleAdministratorChangePassword(handleAdministratorChangePasswordRequest) returns (handleAdministratorChangePasswordResponse);
+  rpc ResendVerificationEmail(ResendVerificationEmailRequest) returns (Void);
+  rpc ChangeAdministratorStatus(ChangeAdministratorStatusRequest) returns (ChangeAdministratorStatusResponse);
+  rpc initiateAdministratorChangePassword(initiateAdministratorChangePasswordRequest) returns (initiateAdministratorChangePasswordResponse);
+  rpc GetAdministratorName(GetAdministratorNameRequest) returns (GetAdministratorNameResponse);
+
+  rpc GetAdministratorsByRecipient(GetAdministratorsByRecipientRequest) returns (GetAdministratorsByRecipientResponse);
+}
+
+message CreateAdministratorRequest {
+  string firstName = 1;
+  string lastName = 2;
+  string email = 3;
+  repeated string roleIds = 4;
+  string recipientId = 5;
+}
+
+message GetAdministratorByIdRequest {
+  string id = 1;
+}
+
+message AdministratorResponse {
+  string id = 1;
+  string firstName = 2;
+  string lastName = 3;
+  string document = 4;
+  string email = 5;
+  bool isAccessRestricted = 6;
+  repeated Role roles = 7;
+  optional string status = 8;
+  bool isSuperAdmin = 9;
+  string recipientId = 10;
+  string userId = 11;
+  optional bool twoFactorEnabled = 12;
+}
+
+message UpdateAdministratorRequest {
+  string id = 1;
+  optional string firstName = 2;
+  optional string lastName = 3;
+  optional string email = 4;
+  repeated string roleIds = 5;
+  optional string document = 6;
+  optional string status = 7;
+}
+
+message Role {
+  string id = 1; 
+  string code = 2; 
+  string description = 3;
+  repeated string permissions = 4;
+}
+
+message GetAllAdministratorsRequest {}
+
+message GetAllAdministratorsResponse {
+  repeated AdministratorResponse administrators = 1;
+}
+
+message ValidateAndSignInRequest {
+  string email = 1;
+  string password = 2;
+}
+
+message Tokens {
+  string accessToken = 1;
+  string refreshToken = 2;
+}
+
+message UserInfo {
+  string id = 1;
+  string email = 2;
+  string name = 3;
+}
+
+message ValidateAndSignInResponse {
+  oneof response {
+    SuccessResponse success = 1;
+    TwoFactorRequiredResponse twoFactorRequired = 2;
+  }
+}
+
+message SuccessResponse {
+  Tokens tokens = 1;
+  AdministratorResponse administrator = 2;
+  Recipient recipient = 3;
+}
+
+message TwoFactorRequiredResponse {
+  string administratorId = 1;
+  UserInfo user = 2;
+}
+
+message VerifyTwoFactorAuthenticationRequest {
+  string administratorId = 1;
+  string token = 2;
+}
+
+message VerifyTwoFactorAuthenticationResponse {
+  Tokens tokens = 1;
+  AdministratorResponse administrator = 2;
+  Recipient recipient = 3;
+}
+
+message Recipient {
+  string id = 1;
+  string code = 2;
+  string commercialName = 3;
+  string socialReason = 4;
+  string holderType = 5;
+  string document = 6;
+  string cnaeId = 7;
+  string legalType = 8;
+  string contactName = 10;
+  string contactEmail = 11;
+  string contactPhone = 12;
+  bool isAutomaticAnticipationEnabled = 13;
+  string foundation = 14;
+  optional string avatarUrl = 15;
+  bool isActive = 16;
+}
+
+message RefreshTokenRequest {
+  string refreshToken = 1;
+}
+
+message RefreshTokenResponse {
+  string accessToken = 1;
+  string refreshToken = 2;
+  bool isAccessRestricted = 3;
+}
+
+message handleAdministratorChangePasswordRequest {
+  string administratorId = 1;
+  string newPassword = 2;
+}
+
+message handleAdministratorChangePasswordResponse {
+  bool isFirstChangePassword = 1;
+}
+
+message ResendVerificationEmailRequest {
+  string administratorId = 1;
+}
+
+message Void {}
+
+message ChangeAdministratorStatusRequest {
+  string administratorId = 1;
+  string status = 2;
+}
+
+message ChangeAdministratorStatusResponse {
+  bool success = 1;
+}
+
+message initiateAdministratorChangePasswordRequest {
+  string email = 1;
+}
+
+message initiateAdministratorChangePasswordResponse {
+  bool success = 1;
+}
+
+
+message GetAdministratorNameRequest {
+  string id = 1;
+}
+
+message GetAdministratorNameResponse {
+  string name = 1;
+}
+
+message GetAdministratorsByRecipientRequest {
+  string recipientId = 1;
+}
+
+message GetAdministratorsByRecipientResponse {
+  repeated AdministratorResponse administrators = 1;
+}

package/src/anticipation.proto

@@ -0,0 +1,86 @@
+syntax = "proto3";
+
+package anticipation;
+
+service AnticipationService {
+  rpc simulateAnticipations (SimulateAnticipationsRequest) returns (SimulationResponse);
+  rpc createAnticipations (CreateAnticipationsRequest) returns (AnticipationResponse);
+  rpc getAnticipationsByRecipient (GetAnticipationsByRecipientRequest) returns (GetAnticipationsResponse);
+  rpc getAnticipation (GetAnticipationRequest) returns (Anticipation);
+  rpc updateAnticipationStatus (UpdateAnticipationStatusRequest) returns (AnticipationResponse);
+  rpc updateAnticipation (UpdateAnticipationRequest) returns (Anticipation);
+}
+
+message SimulateAnticipationsRequest {
+  repeated string payableIds = 1;
+}
+
+message CreateAnticipationsRequest {
+  repeated string payableIds = 1;
+}
+
+message GetAnticipationsByRecipientRequest {
+  string recipientId = 1;
+}
+
+message GetAnticipationRequest {
+  string id = 1;
+}
+
+message UpdateAnticipationStatusRequest {
+  string anticipationId = 1;
+  string status = 2;
+}
+
+message SimulationResponse {
+  int32 payableCount = 1;
+  double totalAmount = 2;
+  string recipientId = 3;
+}
+
+message AnticipationResponse {
+  bool success = 1;
+}
+
+message GetAnticipationsResponse {
+  repeated Anticipation anticipations = 1;
+}
+
+message Anticipation {
+  string id = 1;
+  double amount = 2;
+  double fee = 4;
+  double baseFee = 5;
+  double feePercentage = 6;
+  string status = 7;
+  optional string externalId = 8;
+  optional int32 anticipatedDays = 9;
+  string createdAt = 10;
+  string updatedAt = 11;
+  Payable payable = 12;
+}
+
+message Payable {
+  string id = 1;
+  double amount = 2;
+  int32 installment = 3;
+  string status = 4;
+  string dueAt = 5;
+  string createdAt = 6;
+  bool isAnticipated = 7;
+  string processedAt = 8;
+  string chargeId = 9;
+  string recipientId = 10;
+}
+
+message UpdateAnticipationRequest {
+  string payableId = 1;
+  optional string externalId = 2;
+  optional string status = 3;
+  optional double amount = 4;
+  optional double netAmount = 5;
+  optional double fee = 6;
+  optional double baseFee = 7;
+  optional double feePercentage = 8;
+  optional int32 anticipatedDays = 9;
+}

package/src/asset.proto

@@ -0,0 +1,44 @@
+syntax = "proto3";
+
+package asset;
+
+service AssetService {
+  rpc writeFile (WriteFileRequest) returns (WriteFileResponse);
+  rpc readFile (ReadFileRequest) returns (ReadFileResponse);
+  rpc deleteFile (DeleteFileRequest) returns (DeleteFileResponse);
+  rpc fileExists (FileExistsRequest) returns (FileExistsResponse);
+}
+
+message WriteFileRequest {
+  string mimetype = 1;
+  bytes buffer = 2;
+  optional string folder = 3;
+}
+
+message WriteFileResponse {
+  string filename = 1;
+}
+
+message ReadFileRequest {
+  string identifier = 1;
+}
+
+message ReadFileResponse {
+  bytes buffer = 1;
+}
+
+message DeleteFileRequest {
+  string identifier = 1;
+}
+
+message DeleteFileResponse {
+  bool success = 1;
+}
+
+message FileExistsRequest {
+  string identifier = 1;
+}
+
+message FileExistsResponse {
+  bool exists = 1;
+}

package/src/auth.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+
+package auth;
+
+service AuthService {
+  rpc SignIn (SignInRequest) returns (SignInResponse);
+  rpc RefreshAccessToken (RefreshAccessTokenRequest) returns (RefreshAccessTokenResponse);
+
+}
+
+message SignInRequest {
+  string id = 1;
+}
+
+message SignInResponse {
+  string accessToken = 1;
+  string refreshToken = 2;
+}
+
+message RefreshAccessTokenRequest {
+  string refreshToken = 1;
+}
+
+message RefreshAccessTokenResponse {
+  string accessToken = 1;
+  string refreshToken = 2;
+  optional string accountId = 3;
+}
+

package/src/bank-account.proto

@@ -0,0 +1,62 @@
+syntax = "proto3";
+
+package bankAccount;
+
+service BankAccountService {
+  rpc CreateBankAccount(CreateBankAccountRequest) returns (BankAccountResponse);
+  rpc GetBankAccountByRecipientId(GetBankAccountByRecipientIdRequest) returns (GetBankAccountByRecipientIdResponse);
+  rpc GetMainAccount(Void) returns (MainBankAccountResponse);
+  rpc GetAllBankAccounts(Void) returns (GetAllBankAccountsResponse);
+  rpc GetBankAccount(GetBankAccountRequest) returns (BankAccountResponse);
+
+}
+
+message CreateBankAccountRequest {
+  int32 bankCompeCode = 1;
+  string agency = 2;
+  string account = 3;
+  string digitAccount = 4;
+  optional string pixKey = 5;
+  string holderType = 6;
+  string accountType = 7;
+}
+
+message GetBankAccountByRecipientIdRequest {
+  string recipientId = 1;
+}
+
+message GetBankAccountByRecipientIdResponse {
+  BankAccount bankAccount = 1;
+}
+
+message GetAllBankAccountsResponse {
+  repeated BankAccount bankAccount = 1;
+}
+
+message BankAccount {
+  string id = 1;
+  int32 bankCompeCode = 2;
+  string agency = 3;
+  string account = 4;
+  string digitAccount = 5;
+  double balance = 6;
+  optional string pixKey = 7;
+  string holderType = 8;
+  string accountType = 9;
+  string recipientId = 10;
+}
+
+message BankAccountResponse {
+  BankAccount bankAccount = 1;
+}
+
+message Void {}
+
+
+message GetBankAccountRequest {
+  string id = 1;
+}
+
+message MainBankAccountResponse {
+  BankAccount mainBankAccount = 1;
+}