/*
  Сервис реализует устаревший функционал управления услугами.
  Услуги это составные части привилегии на квартиру, сейчас считаются устаревшими, использовать нужно привилегии, сделаны тут для совместимости
*/
syntax = "proto3";

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

package keyapis.subscription.v1;

option java_package = "ru.keyapis.subscription.v1";
option java_outer_classname = "KeyapisSubscriptionV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_subscription_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.Subscription.V1";
option objc_class_prefix = "KEYAPISSUBSCRIPTIONV1";
option php_namespace = "Keyapis\\Subscription\\V1";
option ruby_package = "Keyapis::Subscription::V1";
option optimize_for = LITE_RUNTIME;

// Сервис услуг
service ServiceService {
  // Метод получения услуг квартиры.
  // Вернёт все услуги на квартире и недоступные по адресу как неактивные.
  // Метод доступен для: admin, master, service, application(subscription:read или subscription:edit)
  rpc GetServiceList(GetServiceListRequest) returns (stream GetServiceListResponse) {
    option (google.api.http) = {
      get: "/subscription/api/v1/service/{orpon}/{flat_number}/list"
    };
  }
  // Метод получения списка услуг.
  // Вернёт все услуги на квартире и недоступные по адресу как неактивные.
  // Метод доступен для: admin, service
  rpc GetServicePrivilegeList(GetServicePrivilegeListRequest) returns (stream GetServicePrivilegeListResponse) {
    option (google.api.http) = {
      get: "/subscription/api/v1/service/privilege/list"
    };
  }
  // Метод получения количества услуг.
  // Вернёт все услуги на квартире и недоступные по адресу как неактивные.
  // Метод доступен для: admin, service
  rpc GetServicePrivilegeCount(GetServicePrivilegeCountRequest) returns (GetServicePrivilegeCountResponse) {
    option (google.api.http) = {
      get: "/subscription/api/v1/service/privilege/count"
    };
  }
  // Метод получения справочника видов услуг.
  // Метод доступен для: admin, service
  rpc GetServiceKindList(GetServiceKindListRequest) returns (stream GetServiceKindListResponse) {
    option (google.api.http) = {
      get: "/subscription/api/v1/service/kind/list"
    };
  }
}

// Услуга.
// TODO: deprecated
message Sevice {
  // Название услуги на английском
  string name = 1;
  // Доступна ли услуга на квартире.
  // Вернётся true если статусы привилегии:
  // - PROMO;
  // - PAID;
  // - TURNS_OFF.
  // Вернётся false если статусы привилегии:
  // - NOT_PAID;
  // - CAN_BE_PAID;
  // - STATE_TYPE_UNKNOWN;
  // - Не найден (нет на кваритре, но есть в справочнике привилегий)
  bool is_active = 2;
}

// Услуга
message Service {
  // Название услуги на английском
  string name = 1;
  // Доступна ли услуга на квартире.
  // Вернётся true если статусы привилегии:
  // - PROMO;
  // - PAID;
  // - TURNS_OFF.
  // Вернётся false если статусы привилегии:
  // - NOT_PAID;
  // - CAN_BE_PAID;
  // - STATE_TYPE_UNKNOWN;
  // - Не найден (нет на кваритре, но есть в справочнике привилегий)
  bool is_active = 2;
  // ОРПОН дома
  google.protobuf.Int64Value orpon = 3;
  // Номер квартиры
  google.protobuf.StringValue flat_number = 4;
}

// Элемент справочника видов услуг
message ServiceKind {
  // Идентификатор услуги
  int32 id = 1;
  // Категория услуги.
  // Аналогично V1ServiceDto.type
  string category = 2;
  // Название услуги на английском
  string name = 3;
  // Название услуги 
  string title = 4;
  // Описание услуги
  google.protobuf.StringValue description = 5;
  // Идентификатор родительской услуги
  google.protobuf.Int32Value parent_id = 6;
}

// Запрос получения списка услуг квартиры
message GetServiceListRequest {
  // ОРПОН.
  // Идентификатор дома
  int64 orpon = 1 [(google.api.field_behavior) = REQUIRED];
  // Номер квартиры
  string flat_number = 2 [(google.api.field_behavior) = REQUIRED];
}
// Результат запроса получения списка услуг квартиры
message GetServiceListResponse {
  // Тип результата
  oneof type {
    // Услуга
    Sevice data = 1;
  }
}

// Запрос получения списка услуг
message GetServicePrivilegeListRequest {
  // Фильтр
  ServicePrivilegeFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Стандартный постраничный вывод
    ServicePrivilegePaging paging = 2;
  }
}
// Результат запроса получения списка услуг
message GetServicePrivilegeListResponse {
  // Тип результата
  oneof type {
    // Услуга
    Service data = 1;
  }
}

// Запрос получения количества услуг
message GetServicePrivilegeCountRequest {
  // Фильтр
  ServicePrivilegeFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Стандартный постраничный вывод
    ServicePrivilegePaging paging = 2;
  }
}
// Результат запроса получения количества услуг
message GetServicePrivilegeCountResponse {
  // Тип результата
  oneof type {
    // Количество
    int32 data = 1;
  }
}

// Фильтр услуг
message ServicePrivilegeFilter {
  // По ОРПОН
  repeated int64 orpons = 1;
  // По номеру квартиры
  repeated string flat_numbers = 2;
}

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

// Результат запроса получения справочника видов услуг
message GetServiceKindListResponse {
  // Тип результата
  oneof type {
    // Элемент справочника услуг
    ServiceKind data = 1;
  }
}