/*
  Сервис связей помещений и пользователей
*/
syntax = "proto3";

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "keyapis/access_control/v1/keyapis_access_control_access_control_v1.proto";


package keyapis.access_control.v1;

option java_package = "ru.keyapis.access_control.v1";
option java_outer_classname = "KeyapisAccessControlV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_access_control_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.AccessControl.V1";
option objc_class_prefix = "KEYAPISACCESSCONTROLV1";
option php_namespace = "Keyapis\\AccessControl\\V1";
option ruby_package = "Keyapis::AccessControl::V1";
option optimize_for = LITE_RUNTIME;

// Сервис управления доступом пользователей
service RoomUserService {
  // Метод получения списка связей помещений и пользователей.
  // Метод доступен для: admin, service, bti, ltp_first
  rpc GetRoomUserList(GetRoomUserListRequest) returns (stream GetRoomUserListResponse) {
    option (google.api.http) = {
      get: "/access_control/api/v1/room/user/list"
    };
  }
  // Метод получения количества связей помещений и пользователей.
  // Метод доступен для: admin, service, bti, ltp_first
  rpc GetRoomUserCount(GetRoomUserCountRequest) returns (GetRoomUserCountResponse) {
    option (google.api.http) = {
      get: "/access_control/api/v1/room/user/count"
    };
  }
}

// Связь помещения и пользователя
message RoomUser {
  // ОРПОН дома
  int64 orpon = 1 [(google.api.field_behavior) = REQUIRED];
  // Номер квартиры.
  // # Диапазон: 1..4
  string room_number = 2 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор пользователя.
  // # Диапазон: 1..2147483647
  int32 user_id = 3 [(google.api.field_behavior) = REQUIRED];
}

// Запрос получения списка связей помещений и пользователей
message GetRoomUserListRequest {
  // Фильтр
  RoomUserFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Стандартный постраничный вывод
    RoomUserPaging paging = 2;
  }
}

// Ответ на запрос получения списка связей помещений и пользователей
message GetRoomUserListResponse {
  // Ошибка
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Связь помещения и пользователя
    RoomUser data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос получения количества связей помещений и пользователей
message GetRoomUserCountRequest {
  // Фильтр
  RoomUserFilter filter = 1;
}

// Ответ на запрос получения количества связей помещений и пользователей
message GetRoomUserCountResponse {
  // Тип результата
  oneof type {
    // Количество
    int32 data = 1;
  }
}

// Фильтр по связям помещений и пользователей
message RoomUserFilter {
  // По ОРПОНам
  repeated int64 orpons = 1;
  // По номерам квартир
  repeated string room_numbers = 2;
  // По идентификаторам пользователей
  repeated int32 user_ids = 3;
}

// Постраничный вывод
message RoomUserPaging {
  // Справочник типов значений сортировки.
  // # Тип: byte
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // По идентификатору
    USER_ID = 1;
    // По ОРПОНу и номеру
    ORPON_THEN_NUMBER = 2;
  }
  // Тип значения сортировки.
  // Если значение не передано, то будет взято значение по умолчанию.
  // # По умолчанию: USER_ID
  OrderByType order_by_type = 1;
  // Справочник типов направлений сортировки.
  // # Тип: byte
  enum DirectionType {
    // Значение не указано
    DIRECTION_TYPE_UNKNOWN = 0;
    // От большего к меньшему
    DESC = 1;
    // От меньшего к большему
    ASC = 2;
  }
  // Тип направления сортировки.
  // # По умолчанию: DESC
  DirectionType direction_type = 2;
  // Количество записей на страницу.
  // Если значение 0 (не передано), то будет взято значение по умолчанию.
  // # Диапазон: 0..100.
  // # По умолчанию: 20
  int32 limit = 3;
  // Сдвиг.
  // # Диапазон: 0..2147483647
  int32 offset = 4;
}