syntax = "proto3";

package corruption.v1;

import "common.proto";

option go_package = "github.com/corruption/api/v1";
option java_multiple_files = true;
option java_outer_classname = "MariaIrregularityProto";
option java_package = "com.corruption.api.v1";

// Maria Irregularity service definition
service MariaIrregularityService {
  // Get a list of Maria irregularities with pagination
  rpc ListMariaIrregularities(ListMariaIrregularitiesRequest) returns (ListMariaIrregularitiesResponse) {}
  
  // Get a single Maria irregularity by ID
  rpc GetMariaIrregularity(GetMariaIrregularityRequest) returns (GetMariaIrregularityResponse) {}
}

// Request message for ListMariaIrregularities
message ListMariaIrregularitiesRequest {
  // Pagination parameters
  PaginationRequest pagination = 1;
  
  // Optional filter by public institution ID
  optional int32 public_institution_id = 2;
}

// Response message for ListMariaIrregularities
message ListMariaIrregularitiesResponse {
  // List of Maria irregularities
  repeated MariaIrregularity maria_irregularities = 1;
  
  // Pagination metadata
  PaginationResponse pagination = 2;
}

// Request message for GetMariaIrregularity
message GetMariaIrregularityRequest {
  // The ID of the Maria irregularity to retrieve
  int32 id = 1;
}

// Response message for GetMariaIrregularity
message GetMariaIrregularityResponse {
  // The requested Maria irregularity
  MariaIrregularity maria_irregularity = 1;
}

// Maria Irregularity message
message MariaIrregularity {
  // The unique identifier for the Maria irregularity
  int32 id = 1;
  
  // The Maria.do ID
  string maria_id = 2;
  
  // The name of the institution as reported by Maria.do
  string institution_name = 3;
  
  // The number of irregularities found
  int32 irregularities = 4;
  
  // The overvaluation percentage
  double overvaluation_percent = 5;
  
  // The processed amount
  double processed_amount = 6;
  
  // The tender amount
  double tender_amount = 7;
  
  // The currency used
  string currency = 8;
  
  // The date of the irregularity
  string date = 9;
  
  // The description of the irregularity
  string description = 10;
  
  // The institution ID from Maria.do
  string institution_id = 11;
  
  // The file name
  string file_name = 12;
  
  // The processed S3 URL
  string processed_s3_url = 13;
  
  // The public institution ID
  int32 public_institution_id = 14;
  
  // The name of the associated public institution
  string public_institution_name = 15;
  
  // Creation timestamp
  Timestamp created_at = 16;
  
  // Last update timestamp
  Timestamp updated_at = 17;
}