/*
   Сервис предоставляет возможность управлять шаблонами приборов телеметрии
*/
syntax = "proto3";

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/wrappers.proto";
import "google/protobuf/timestamp.proto";

package keyapis.telemetry_control.v1;

option java_package = "ru.keyapis.telemetry_control.v1";
option java_outer_classname = "KeyapisTelemetryControlV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_telemetry_control_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.TelemetryControl.V1";
option objc_class_prefix = "KEYAPISTELEMETRYCONTROLV1";
option php_namespace = "Keyapis\\TelemetryControl\\V1";
option ruby_package = "Keyapis::TelemetryControl::V1";
option optimize_for = LITE_RUNTIME;

// Сервис управления шаблонами приборов телеметрии.
// Авторизация:
//   - Authorization: Bearer token
service TemplateService {
  // Метод получения шаблона ПУ.
  // Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений
  rpc GetTemplateDevice(GetTemplateDeviceRequest) returns (GetTemplateDeviceResponse) {
    option (google.api.http) = {
      get: "/telemetry_control/api/v1/template/device/{id}"
    };
  }
  // Метод получения списка шаблонов ПУ.
  // Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений
  rpc GetTemplateDeviceList(GetTemplateDeviceListRequest) returns (stream GetTemplateDeviceListResponse) {
    option (google.api.http) = {
      get: "/telemetry_control/api/v1/template/device/list"
    };
  }
  // Метод получения количества шаблонов ПУ.
  // Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений
  rpc GetTemplateDeviceCount(GetTemplateDeviceCountRequest) returns (GetTemplateDeviceCountResponse) {
    option (google.api.http) = {
      get: "/telemetry_control/api/v1/template/device/count"
    };
  }
  // Метод сохранения шаблона ПУ.
  // Поддерживает создание и обновление.
  // Метод доступен для: Token: admin, service, application. Без учета разрешений
  rpc PostTemplateDevice(PostTemplateDeviceRequest) returns (PostTemplateDeviceResponse) {
    option (google.api.http) = {
      post: "/telemetry_control/api/v1/template/device"
      body: "*"
    };
  }
  // Метод удаления шаблона ПУ.
  // Метод доступен для: Token: admin, service, application. Без учета разрешений
  rpc DeleteTemplateDevice(DeleteTemplateDeviceRequest) returns (DeleteTemplateDeviceResponse) {
    option (google.api.http) = {
      delete: "/telemetry_control/api/v1/template/device/{id}"
    };
  }
  // Метод получения шаблона индикатора.
  // Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений
  rpc GetTemplateIndicator(GetTemplateIndicatorRequest) returns (GetTemplateIndicatorResponse) {
    option (google.api.http) = {
      get: "/telemetry_control/api/v1/template/indicator/{id}"
    };
  }
  // Метод получения списка шаблонов индикаторов.
  // Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений
  rpc GetTemplateIndicatorList(GetTemplateIndicatorListRequest) returns (stream GetTemplateIndicatorListResponse) {
    option (google.api.http) = {
      get: "/telemetry_control/api/v1/template/indicator/list"
    };
  }
  // Метод получения количества шаблонов индикаторов.
  // Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений
  rpc GetTemplateIndicatorCount(GetTemplateIndicatorCountRequest) returns (GetTemplateIndicatorCountResponse) {
    option (google.api.http) = {
      get: "/telemetry_control/api/v1/template/indicator/count"
    };
  }
  // Метод сохранения шаблонов индикатора.
  // Поддерживает создание и обновление.
  // Метод доступен для: Token: admin, service, application. Без учета разрешений
  rpc PostTemplateIndicator(PostTemplateIndicatorRequest) returns (PostTemplateIndicatorResponse) {
    option (google.api.http) = {
      post: "/telemetry_control/api/v1/template/indicator"
      body: "*"
    };
  }
  // Метод удаления шаблона шаблона индикатора.
  // Метод доступен для: Token: admin, service, application. Без учета разрешений
  rpc DeleteTemplateIndicator(DeleteTemplateIndicatorRequest) returns (DeleteTemplateIndicatorResponse) {
    option (google.api.http) = {
      delete: "/telemetry_control/api/v1/template/indicator/{id}"
    };
  }
}

// Запрос сохранения шаблона ПУ
message PostTemplateDeviceRequest {
  // Шаблон ПУ
  TemplateDevice data = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос сохранения шаблона ПУ
message PostTemplateDeviceResponse {
  // Ошибка запроса сохранения шаблона ПУ
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      TemplateDevice.ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Шаблон ПУ
    TemplateDevice data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос удаления шаблона ПУ
message DeleteTemplateDeviceRequest {
  // Идентификатор
  int32 id = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления шаблона ПУ
message DeleteTemplateDeviceResponse {}

// Запрос получения шаблона ПУ
message GetTemplateDeviceRequest {
  // Идентификатор шаблона ПУ
  int32 id = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос получения шаблона ПУ
message GetTemplateDeviceResponse {
  // Тип результата
  oneof type {
    // Шаблон ПУ
    TemplateDevice data = 1;
  }
}

// Запрос получения списка шаблонов ПУ
message GetTemplateDeviceListRequest {
  // Фильтр
  TemplateDeviceFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Пагинация
    TemplateDevicePaging paging = 2;
  }
}

// Пагинация
message TemplateDevicePaging {
  // Ошибка валидации постраничной пагинации по шаблонам ПУ.
  // Эти проверки выполняются до обращения в базу данных
  message ValidationError {
    // Причины:
    // - Значение количества < 0 или > 100
    message LimitInvalid {}
    // Причины:
    // - Значение сдвига < 0
    message OffsetInvalid {}

    // Причина ошибки
    oneof reason {
      // Количество передано некорректно
      LimitInvalid limit = 1;
      // Сдвиг передан некорректно
      OffsetInvalid offset = 2;
    }
  }
  // Справочник типов значений сортировки
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // По идентификатору
    ID = 1;
    // По типу энергоресурса
    METRIC_TYPE = 2;
    // По модели счетчика
    MODEL = 3;
  }
  // Тип значения сортировки.
  // По умолчанию: ID
  OrderByType order_by_type = 1;
  // Справочник типов направлений сортировки
  enum DirectionType {
    // Значение не указано
    DIRECTION_TYPE_UNKNOWN = 0;
    // От большего к меньшему
    DESC = 1;
    // От меньшего к большему
    ASC = 2;
  }
  // Тип направления сортировки.
  // По умолчанию: DESC
  DirectionType direction_type = 2;
  // Количество.
  // Минимальное значение: 1.
  // Максимальное значение: 100.
  // По умолчанию: 20.
  // Если значение 0 (не передано) то выставляем значение по умолчанию
  int32 limit = 3;
  // Сдвиг.
  // По умолчанию: 0
  int32 offset = 4;
}

// Фильтр для запроса шаблонов приборов учета.
// При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ.
// При передаче нескольких разных параметров фильтра они работают в выборке через И
message TemplateDeviceFilter {
  // Ошибки валидации.
  // Эти проверки выполняются до обращения в базу данных
  message ValidationError {
    // Путь к полю в формате наименования protobuf
    string path = 1 [(google.api.field_behavior) = REQUIRED];
    // Валидационное сообщение
    string message = 2 [(google.api.field_behavior) = REQUIRED];
  }
  // По типу энергоресурса
  repeated TemplateDevice.MetricType metric_types = 1;
  // По ID модели счетчика
  repeated int32 model_ids = 2;
  // По типу тарифного плана. Для ПУ электроэнергии
  repeated TemplateDevice.PlanType plan_types = 3;
  // По посреднику получения показаний
  repeated TemplateIndicator.VendorType indicator_vendor_types = 4;
}

// Ответ на запрос получения списка шаблонов приборов учета
message GetTemplateDeviceListResponse {
  // Ошибка запроса получения списка шаблонов приборов учета
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка фильтрации
      TemplateDeviceFilter.ValidationError template_device_filter_validation = 1;
      // Ошибка пагинации  по страницам
      TemplateDevicePaging.ValidationError template_device_paging_validation = 2;
    }
  }
  // Тип результата
  oneof type {
    // Шаблон ПУ
    TemplateDevice data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос получения количества шаблонов приборов учета
message GetTemplateDeviceCountRequest {
  // Фильтр по шаблонам приборов учета
  TemplateDeviceFilter filter = 1;
}

// Ответ на запрос получения количества шаблонов приборов учета
message GetTemplateDeviceCountResponse {
  // Ошибка запроса получения количества шаблонов приборов учета
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка фильтрации
      TemplateDeviceFilter.ValidationError template_device_filter_validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Всего шаблонов приборов учета
    int32 data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Шаблон ПУ
message TemplateDevice {
  // Ошибки валидации.
  // Эти проверки выполняются до обращения в базу данных
  message ValidationError {
    // Путь к полю в формате наименования protobuf
    string path = 1 [(google.api.field_behavior) = REQUIRED];
    // Валидационное сообщение
    string message = 2 [(google.api.field_behavior) = REQUIRED];
  }
  // Идентификатор
  int32 id = 1;
  // Дата создания
  google.protobuf.Timestamp created_at = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Дата последнего изменения.
  // Заполняется и обновляется сервером.
  // Заполняется при создании и изменении
  google.protobuf.Timestamp changed_at = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Справочние типов энергоресурсов
  enum MetricType {
    // Значение не указано
    METRIC_TYPE_UNKNOWN = 0;
    // Горячая вода
    HOT_WATER = 1;
    // Холодная вода
    COLD_WATER = 2;
    // Теплоэнергия
    HEAT = 3;
    // Газ
    GAS = 4;
    // Электроэнергия
    ELECTRICITY = 5;
  }
  // Тип энергоресурса
  MetricType metric_type = 4 [(google.api.field_behavior) = REQUIRED];
  // ID Модели счетчика
  int32 model_id = 5;
  // Шаблоны индикаторов
  repeated int32 indicator_template_ids = 6;
  // Тип тарифного плана
  enum PlanType {
    // Значение не указано
    PLAN_TYPE_UNKNOWN = 0;
    // Однотарифный
    SINGLE = 1;
    // Двухтарифный
    DOUBLE = 2;
    // Трёхтарифный
    TRIPLE = 3;
  }
  // Тип тарифного плана.
  // Для ПУ электроэнергии
  PlanType plan_type = 7;
  // Посредник получения показаний
  TemplateIndicator.VendorType indicator_vendor_type = 8;
}


// Запрос получения шаблона шаблона индикатора
message GetTemplateIndicatorRequest {
  // Идентификатор шаблона индикатора
  int32 id = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос получения шаблона индикатора
message GetTemplateIndicatorResponse {
  // Тип результата
  oneof type {
    // Шаблон ндикатора
    TemplateIndicator data = 1;
  }
}

// Запрос получения списка шаблонов индикаторов
message GetTemplateIndicatorListRequest {
  // Фильтр
  TemplateIndicatorFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Пагинация
    TemplateIndicatorPaging paging = 2;
  }
}

// Пагинация
message TemplateIndicatorPaging {
  // Ошибка валидации постраничной пагинации по шаблонам индикатора.
  // Эти проверки выполняются до обращения в базу данных
  message ValidationError {
    // Причины:
    // - Значение количества < 0 или > 100
    message LimitInvalid {}
    // Причины:
    // - Значение сдвига < 0
    message OffsetInvalid {}

    // Причина ошибки
    oneof reason {
      // Количество передано некорректно
      LimitInvalid limit = 1;
      // Сдвиг передан некорректно
      OffsetInvalid offset = 2;
    }
  }
  // Справочник типов значений сортировки
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // По идентификатору
    ID = 1;
    // По типу измерений
    SIGN_TYPE = 2;
    // По типу архивности показаний
    ARCHIVE_TYPE = 3;
  }
  // Тип значения сортировки.
  // По умолчанию: ID
  OrderByType order_by_type = 1;
  // Справочник типов направлений сортировки
  enum DirectionType {
    // Значение не указано
    DIRECTION_TYPE_UNKNOWN = 0;
    // От большего к меньшему
    DESC = 1;
    // От меньшего к большему
    ASC = 2;
  }
  // Тип направления сортировки.
  // По умолчанию: DESC
  DirectionType direction_type = 2;
  // Количество.
  // Минимальное значение: 1.
  // Максимальное значение: 100.
  // По умолчанию: 20.
  // Если значение 0 (не передано) то выставляем значение по умолчанию
  int32 limit = 3;
  // Сдвиг.
  // По умолчанию: 0
  int32 offset = 4;
}

// Фильтр для запроса шаблонов индикаторов.
// При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ.
// При передаче нескольких разных параметров фильтра они работают в выборке через И
message TemplateIndicatorFilter {
  // Ошибки валидации.
  // Эти проверки выполняются до обращения в базу данных
  message ValidationError {
    // Путь к полю в формате наименования protobuf
    string path = 1 [(google.api.field_behavior) = REQUIRED];
    // Валидационное сообщение
    string message = 2 [(google.api.field_behavior) = REQUIRED];
  }
  // По типу измерений
  repeated TemplateIndicator.SignType sign_types = 1;
  // По типу архивности показаний
  repeated TemplateIndicator.ArchiveType archive_types = 2;
  // По флагу видимости индикатора для клиента ФЛ
  google.protobuf.BoolValue is_individual = 3;
  // По шаблонному названию индикатора.
  // Поиск производится по подстроке
  google.protobuf.StringValue title = 4;
  // По посреднику получения показаний
  repeated TemplateIndicator.VendorType indicator_vendor_types = 5;
}

// Ответ на запрос получения списка шаблонов индикаторов
message GetTemplateIndicatorListResponse {
  // Ошибка запроса получения списка шаблонов индикаторов
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка фильтрации
      TemplateIndicatorFilter.ValidationError template_indicator_filter_validation = 1;
      // Ошибка пагинации  по страницам
      TemplateIndicatorPaging.ValidationError template_indicator_paging_validation = 2;
    }
  }
  // Тип результата
  oneof type {
    // Шаблон индикатора
    TemplateIndicator data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос получения количества шаблонов индикаторов
message GetTemplateIndicatorCountRequest {
  // Фильтр по шаблонам индикаторов
  TemplateIndicatorFilter filter = 1;
}

// Ответ на запрос получения количества шаблонов индикаторов
message GetTemplateIndicatorCountResponse {
  // Ошибка запроса получения количества шаблонов индикаторов
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка фильтрации
      TemplateIndicatorFilter.ValidationError template_indicator_filter_validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Всего шаблонов индикаторов
    int32 data = 1;
    // Ошибка
    Error error = 2;
  }
}


// Запрос сохранения шаблона индикатора
message PostTemplateIndicatorRequest {
  // Шаблон индикатора
  TemplateIndicator data = 1 [(google.api.field_behavior) = REQUIRED];
}

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

// Запрос удаления шаблона индикатора
message DeleteTemplateIndicatorRequest {
  // Идентификатор
  int32 id = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления шаблона индикатора
message DeleteTemplateIndicatorResponse {}

// Шаблон индикатора
message TemplateIndicator {
  // Посредники получения показаний
  enum VendorType {
    // Значение не указано
    VENDOR_TYPE_UNKNOWN = 0;
    // Энвайро
    ENVIRO = 1;
    // Лартех
    LARTECH = 2;
    // РТК
    RTK = 3;
  }
  // Ошибки валидации.
  // Эти проверки выполняются до обращения в базу данных
  message ValidationError {
    // Путь к полю в формате наименования protobuf
    string path = 1 [(google.api.field_behavior) = REQUIRED];
    // Валидационное сообщение
    string message = 2 [(google.api.field_behavior) = REQUIRED];
  }
  // Идентификатор
  int32 id = 1;
  // Дата создания
  google.protobuf.Timestamp created_at = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Дата последнего изменения.
  // Заполняется и обновляется сервером.
  // Заполняется при создании и изменении
  google.protobuf.Timestamp changed_at = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Шаблонное название индикатора
  string title = 4 [(google.api.field_behavior) = REQUIRED];
  // Справочник типов единиц измерений
  enum UnitType {
    // Значение не указано
    UNIT_TYPE_UNKNOWN = 0;
    // Процент
    PERCENT = 1;
    // Градус по Цельсию
    C = 2;
    // Ватт
    WT = 3;
    // Гигакалория
    GKAL = 4;
    // Количество
    VALUE = 5;
    // Киловaтт-час
    KWH = 6;
    // Килограмм на квадратный сантиметр
    KG_CM2 = 7;
    // Килограмм-сила на квадратный сантиметр
    KGF_CM2 = 8;
    // Кубический метр
    M3 = 9;
    // Кубический метр в час
    M3_H = 10;
    // Мегапаскаль
    MPA = 11;
    // Миллисекунда
    MS = 12;
    // Флаг состояния
    BOOLEAN = 13;
    // Тонна
    T = 14;
    // Тонна в час
    T_H = 15;
    // Час
    H = 16;
    // Безразмерная величина
    NON_MEASURABLE = 17;
    // Импульс
    IMP = 18;
    // Джоуль
    J = 19;
    // Килоджоуль
    KJ = 20;
    // Гигаджоуль
    GJ = 21;
    // Ватт-час
    WTH = 22;
    // Киловатт
    KWT = 23;
    // Минута
    MIN = 24;
    // Секунда
    S = 25;
  }
  // Тип единицы измерения, в которой интерпретировано, получаемое измерение
  UnitType unit_type = 5 [(google.api.field_behavior) = REQUIRED];
  // Справочник типов измерений
  enum SignType {
    // Значение не указано
    SIGN_TYPE_UNKNOWN = 0;
    // Абсолютный показатель
    ABSOLUTE_DS = 1;
    // Абсолютный расход ресурса
    ABSOLUTE_RC = 2;
    // Интервальный показатель состояния
    INTERVAL_DS = 3;
    // Интервальный расход ресурса
    INTERVAL_RC = 4;
    // Текущее состояние
    CURRENT_DS = 5;
    // Текущее состояние ресурса
    CURRENT_RS = 6;
    // Объём
    VOLUME = 7;
    // Параметр конфигурации
    PARAMETER = 8;
    // Флаг состояния
    FLAG = 9;
  }
  // Тип измерения
  SignType sign_type = 6 [(google.api.field_behavior) = REQUIRED];
  // Справочник типа архивности показаний.
  // Используется для указания за какой период произошло измерение.
  // По умолчанию CURRENT
  enum ArchiveType {
    // Значение не указано
    ARCHIVE_TYPE_UNKNOWN = 0;
    // Текущие показания
    CURRENT = 1;
    // За 30 мин
    HALFHOUR = 2;
    // За час
    HOUR = 3;
    // За суток
    DAY = 4;
    // За месяц
    MONTH = 5;
    // За год
    YEAR = 6;
  }
  // Тип архивности показаний
  ArchiveType archive_type = 7;
  // Тип единицы измерения для отображения измерения.
  // При UNIT_TYPE_UNKNOWN отображаемые единицы совпадают с единицами источников значений, преобразования единиц не происходит.
  // Применяется после коэффициента
  UnitType presentation_unit_type = 8;
  // Код для совместимости с поставщиком метрик
  google.protobuf.StringValue compatibility_code = 9;
  // Флаг видимости индикатора для клиента ФЛ
  bool is_individual = 10;
  // Коэффициент, на который умножается отображаемое значение.
  // Применяется перед преобразованием единиц измерений к presentation_unit_type и после применения поправки
  google.protobuf.FloatValue coefficient = 11;
  // Величина поправки к отображаемому значению.
  // Применяется перед применением коэффициента
  google.protobuf.FloatValue shift = 12;
  // Количество возвращаемых десятичных знаков при округлении итогового значения.
  // При пустом параметре округления не происходит.
  // Применяется после преобразования единиц измерения
  google.protobuf.Int32Value round_decimal_digits = 13;
  // Ожидаемая частота поступления показаний в днях
  int32 metric_expected_freq = 14;
  // Посредник получения показаний
  TemplateIndicator.VendorType indicator_vendor_type = 15;
}