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

import "google/api/annotations.proto";
import "google/api/field_behavior.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 RoomDeviceService {
  // Метод создания связи помещения и устройства.
  // Метод доступен для: admin, service
  rpc PutRoomDeviceAttach(PutRoomDeviceAttachRequest) returns (PutRoomDeviceAttachResponse) {
    option (google.api.http) = {
      put: "/access_control/api/v1/room/{room_device.orpon}/{room_device.room_number}/device/{room_device.device_id}/attach"
    };
  }
  // Метод удаления связи помещения и устройства.
  // Метод доступен для: admin, service
  rpc PutRoomDeviceDetach(PutRoomDeviceDetachRequest) returns (PutRoomDeviceDetachResponse) {
    option (google.api.http) = {
      put: "/access_control/api/v1/room/{room_device.orpon}/{room_device.room_number}/device/{room_device.device_id}/detach"
    };
  }
  // Метод получения списка связок помещение-устройство.
  // Метод доступен для: admin, service, bti, ltp_first
  rpc GetRoomDeviceList(GetRoomDeviceListRequest) returns (stream GetRoomDeviceListResponse) {
    option (google.api.http) = {
      get: "/access_control/api/v1/room/device/list"
    };
  }
  // Метод получения количества связок помещение-устройство.
  // Метод доступен для: admin, service, bti, ltp_first
  rpc GetRoomDeviceCount(GetRoomDeviceCountRequest) returns (GetRoomDeviceCountResponse) {
    option (google.api.http) = {
      get: "/access_control/api/v1/room/device/count"
    };
  }
}

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

// Запрос создания связи квартиры и устройства
message PutRoomDeviceAttachRequest {
  // Связь квартиры и устройства
  RoomDevice room_device = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос сохранения связи квартиры и устройства
message PutRoomDeviceAttachResponse {
  // Ошибка запроса на создание связи квартиры и устройства
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}

// Запрос удаления связи квартиры и устройства
message PutRoomDeviceDetachRequest {
  // Связь квартиры и устройства
  RoomDevice room_device = 1 [(google.api.field_behavior) = REQUIRED];
}

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

// Фильтр связок помещение-устройство
message RoomDeviceFilter {
  // По идентификаторам квартирограмм
  repeated int32 flatgramm_ids = 1;
  // По ОРПОН
  repeated int64 orpons = 2;
  // По номерам квартир
  repeated string room_numbers = 3;
  // По идентификаторам привязанных устройств
  repeated int32 device_ids = 4;
}

// Постраничный вывод
message RoomDevicePaging {
  // Справочник типов значений сортировки.
  // # Тип: byte
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // По ОРПОНу и номеру подъезда
    ORPON_THEN_ENTRANCE_NUMBER = 1;
    // По идентификатору устройства
    DEVICE_ID = 2;
  }
  // Тип значения сортировки.
  // Если значение не передано, то будет взято значение по умолчанию.
  // # По умолчанию: ORPON_THEN_ENTRANCE_NUMBER
  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;
}

// Запрос на получение связок помещение-устройство
message GetRoomDeviceListRequest {
  // Фильтр по связкам помещение-устройство
  RoomDeviceFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Стандартный постраничный вывод
    RoomDevicePaging paging = 2;
  }
}
// Ответ на запрос на получение списка связок помещение-устройство
message GetRoomDeviceListResponse {
  // Ошибка запроса на получение списка связок помещение-устройство
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Связка помещение-устройство
    RoomDevice data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос получения количества домов
message GetRoomDeviceCountRequest {
  // Фильтр
  RoomDeviceFilter filter = 1 [(google.api.field_behavior) = REQUIRED];
}

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