/*
  Сервис реализует функционал управления трубками аналоговых трубок
*/
syntax = "proto3";

import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/descriptor.proto";
import "keyapis/device/v1/keyapis_device_device_v1.proto"; 

package keyapis.device.v1;

option java_package = "ru.keyapis.device.v1";
option java_outer_classname = "KeyapisDeviceV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_device_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.Device.V1";
option objc_class_prefix = "KEYAPISDEVICEV1";
option php_namespace = "Keyapis\\Device\\V1";
option ruby_package = "Keyapis::Device::V1";
option optimize_for = LITE_RUNTIME;

// Сервис трубок аналоговых трубок
service CmsPhoneService {
  // Метод получения аналоговой трубки по идентификатору.
  // Метод доступен для: admin, service, owner, employee, bti, ltp_first
  rpc GetCmsPhone(GetCmsPhoneRequest) returns (GetCmsPhoneResponse) {
    option (google.api.http) = {
      get : "/device/api/v1/cms_phone/{id}"
    };
  }
  // Метод получения списка аналоговых трубок.
  // Метод доступен для: admin, service, owner, employee, bti, ltp_first
  rpc GetCmsPhoneList(GetCmsPhoneListRequest) returns (stream GetCmsPhoneListResponse) {
    option (google.api.http) = {
      get : "/device/api/v1/cms_phone/list"
    };
  }
  // Метод получения количества аналоговых трубок.
  // Метод доступен для: admin, service, owner, employee, bti, ltp_first
  rpc GetCmsPhoneCount(GetCmsPhoneCountRequest) returns (GetCmsPhoneCountResponse) {
    option (google.api.http) = {
      get : "/device/api/v1/cms_phone/count"
    };
  }
  // Метод удаления аналоговой трубки.
  // Метод доступен для: admin, service
  rpc DeleteCmsPhone(DeleteCmsPhoneRequest) returns (DeleteCmsPhoneResponse) {
    option (google.api.http) = {
      delete: "/device/api/v1/cms_phone/{id}"
    };
  }
  // Метод удаления аналоговой трубки по идентификатору устройсва.
  // Метод доступен для: admin, service
  rpc DeleteCmsPhoneDeviceId(DeleteCmsPhoneDeviceIdRequest) returns (DeleteCmsPhoneDeviceIdResponse) {
    option (google.api.http) = {
      delete: "/device/api/v1/cms_phone/device_id/{device_id}"
    };
  }
  // Метод удаления аналоговой трубки по идентификатору ОРПОН.
  // Метод доступен для: admin, service
  rpc DeleteCmsPhoneOrponId(DeleteCmsPhoneOrponIdRequest) returns (DeleteCmsPhoneOrponIdResponse) {
    option (google.api.http) = {
      delete: "/device/api/v1/cms_phone/orpon_id/{orpon_id}"
    };
  }
  // Метод удаления аналоговой трубки по идентификатору ОРПОН и номеру квартиры.
  // Метод доступен для: admin, service
  rpc DeleteCmsPhoneOrponIdRoomNumber(DeleteCmsPhoneOrponIdRoomNumberRequest) returns (DeleteCmsPhoneOrponIdRoomNumberResponse) {
    option (google.api.http) = {
      delete: "/device/api/v1/cms_phone/orpon_id/{orpon_id}/room_number/{room_number}"
    };
  }
  // Метод для принудительного обновления статуса аналоговых трубок.
  // Метод доступен для: admin, service, bti, ltp_first
  rpc PostCmsPhoneRefresh(PostCmsPhoneRefreshRequest) returns (PostCmsPhoneRefreshResponse) {
    option (google.api.http) = {
      post: "/device/api/v1/cms_phone/refresh",
      body: "*"
    };
  }
  // Метод удаления аналоговой трубки по идентификатору ОРПОН, номеру квартиры и идентификатору устройства.
  // Метод доступен для: admin, service
  rpc DeleteCmsPhoneOrponRoomNumberDeviceId(DeleteCmsPhoneOrponRoomNumberDeviceIdRequest) returns (DeleteCmsPhoneOrponRoomNumberDeviceIdResponse) {
    option (google.api.http) = {
      delete: "/device/api/v1/cms_phone/orpon/{orpon}/room_number/{room_number}/device_id/{device_id}"
    };
  }
}

// Аналоговая трубка.
// # Описание модели
message CmsPhone {
  // Идентификатор.
  // # Диапазон: 0..2147483647
  int32 id = 1;
  // ОРПОН Дома.
  // # Диапазон: 0..2147483647
  int64 orpon_id = 2 [(google.api.field_behavior) = REQUIRED];
  // Номер квартиры.
  // # Диапазон: 1..5
  string room = 3 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор устройства.
  // # Диапазон: 0..2147483647
  int32 device_id = 4 [(google.api.field_behavior) = REQUIRED];
  // Справочник статусов аналоговой трубки.
  // # Тип: byte
  enum StatusType {
    // Значение не указано
    STATUS_TYPE_UNKNOWN = 0;
    // Ожидает активации
    PENDING_ACTIVE = 1;
    // Активна
    ACTIVE = 2;
    // Ожидает блокировки
    PENDING_BLOCKED = 3;
    // Заблокирована
    BLOCKED = 4;
  }
  // Статус аналоговой трубки
  StatusType status_type = 5 [(google.api.field_behavior) = REQUIRED];
  // Дата создания.
  // # Тип: DateTime
  google.protobuf.Timestamp created_at = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Дата последнего изменения.
  // Заполняется и обновляется сервером.
  // Заполняется при создании и изменении.
  // Является версией объекта.
  // # Тип: DateTime
  google.protobuf.Timestamp changed_at = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Счетчик попыток обновления.
  // # Диапазон: 0..2147483647
  int32 retry_count = 8 [(google.api.field_behavior) = REQUIRED];
  // Ошибка сохранения.
  // Эти проверки выполняются при работе с базой данных и сторонними сервисами
  message SavingError {
    // Конфликт версий.
    // Причины:
    // - В базе хранится другая версия строки, значения changed_at оличаются
    message Conflict {}

    // Причина ошибки
    oneof reason {
      // Конфликт версий
      Conflict conflict = 1;
    }
  }
}

// Фильтр по аналоговой трубким
message CmsPhoneFilter {
  // По идентификаторам устройства
  repeated int32 device_ids = 1;
  // По статусам аналоговой трубки
  repeated CmsPhone.StatusType status_types = 2;
  // По идентификаторам ОРПОН (дома)
  repeated int64 orpon_ids = 3;
  // По номерам квартиры
  repeated string rooms = 4;
}
// Постраничный вывод
message CmsPhonePaging {
  // Справочник типов значений сортировки.
  // # Тип: byte
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // По идентификатору
    ID = 1;
    // По статусу доступности
    STATUS = 2;
    // Дата последнего изменения
    CHANGED_AT = 3;
    // Дата создания
    CREATED_AT = 4;
  }
  // Тип значения сортировки.
  // Если значение не передано, то будет взято значение по умолчанию.
  // # По умолчанию: CHANGED_AT
  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 GetCmsPhoneListRequest {
  // Фильтр
  CmsPhoneFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Стандартный постраничный вывод
    CmsPhonePaging paging = 2;
  }
}
// Ответ на получение списка аналоговых трубок
message GetCmsPhoneListResponse {
  // Ошибка запроса получения списка аналоговых трубок
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Пресет
    CmsPhone data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос получения аналоговой трубки
message GetCmsPhoneRequest {
  // Идентификатор
  int32 id = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос получения аналоговой трубки
message GetCmsPhoneResponse {
  // Ошибка запроса получения баннера
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Аналоговая трубка
    CmsPhone data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос получения количества аналоговых трубок
message GetCmsPhoneCountRequest {
  // Фильтр
  CmsPhoneFilter filter = 1;
}
// Ответ на запрос получения количества аналоговых трубок
message GetCmsPhoneCountResponse {
  // Ошибка запроса получения количества аналоговых трубок
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Всего устройтсв
    int32 data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос удаления аналоговой трубки
message DeleteCmsPhoneRequest {
  // Идентификатор аналоговой трубки
  int32 id = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления аналоговой трубки
message DeleteCmsPhoneResponse {}
// Запрос удаления аналоговых трубок по идентификатору устройства
message DeleteCmsPhoneDeviceIdRequest {
  // Идентификатор устройства
  int32 device_id = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления аналоговых трубок по идентификатору устройства
message DeleteCmsPhoneDeviceIdResponse {}
// Запрос удаления аналоговых трубок по идентификатору ОРПОН
message DeleteCmsPhoneOrponIdRequest {
  // Идентификатор ОРПОН
  int64 orpon_id = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления аналоговых трубок по идентификатору ОРПОН
message DeleteCmsPhoneOrponIdResponse {}
// Запрос удаления аналоговых трубок по идентификатору ОРПОН и номеру квартиры
message DeleteCmsPhoneOrponIdRoomNumberRequest {
  // Идентификатор ОРПОН
  int64 orpon_id = 1 [(google.api.field_behavior) = REQUIRED];
  // Номер квартиры
  string room_number = 2 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления аналоговых трубок по идентификатору ОРПОН и номеру квартиры
message DeleteCmsPhoneOrponIdRoomNumberResponse {}

// Запрос на принудительное обновление статуса аналоговой трубки
message PostCmsPhoneRefreshRequest {
  // Идентификатор
  repeated int32 ids = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос на принудительное обновление статуса аналоговой трубки
message PostCmsPhoneRefreshResponse {}

// Запрос удаления аналоговых трубок по идентификатору ОРПОН, номеру квартиры и идентификатору устройства
message DeleteCmsPhoneOrponRoomNumberDeviceIdRequest {
  // Идентификатор ОРПОН
  int64 orpon = 1 [(google.api.field_behavior) = REQUIRED];
  // Номер квартиры
  string room_number = 2 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор устройства
  int32 device_id = 3 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления аналоговых трубок по идентификатору ОРПОН, номеру квартиры и идентификатору устройства
message DeleteCmsPhoneOrponRoomNumberDeviceIdResponse {}