/*
  Сервис получения trunk-конфигурации для определенного города
*/
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/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 = "KEYAPISDIALV1";
option php_namespace = "Keyapis\\Device\\V1";
option ruby_package = "Keyapis::Device::V1";
option optimize_for = LITE_RUNTIME;

// Сервис получения trunk-конфигурации для определенного города
service TrunkConfigService {
  // Метод получения trunk-конфигурации.
  // Метод доступен для: admin, bti, service, ltp_first
  rpc GetTrunkConfig(GetTrunkConfigRequest) returns (GetTrunkConfigResponse) {
    option (google.api.http) = {
      get: "/device/internal/api/v1/trunk_config/{id}"
    };
  }

  // Метод получения списка trunk-конфигураций.
  // Метод доступен для: admin, bti, service, ltp_first
  rpc GetTrunkConfigList(GetTrunkConfigListRequest) returns (stream GetTrunkConfigListResponse) {
    option (google.api.http) = {
      get: "/device/internal/api/v1/trunk_config/list"
    };
  }

  // Метод получения количества trunk-конфигураций.
  // Метод доступен для: admin, bti, service, ltp_first
  rpc GetTrunkConfigCount(GetTrunkConfigCountRequest) returns (GetTrunkConfigCountResponse) {
    option (google.api.http) = {
      get: "/device/internal/api/v1/trunk_config/count"
    };
  }

  // Метод создания trunk-конфигурации.
  // Поддерживает создание и обновление.
  // Метод доступен для: admin, bti, service, ltp_first
  rpc PostTrunkConfig(PostTrunkConfigRequest) returns (PostTrunkConfigResponse) {
    option (google.api.http) = {
      post: "/device/internal/api/v1/trunk_config"
      body: "*"
    };
  }

  // Метод архивации trunk-конфигурации.
  // Метод доступен для: admin, service, device_admin
  rpc DeleteTrunkConfig(DeleteTrunkConfigRequest) returns (DeleteTrunkConfigResponse) {
    option (google.api.http) = {
      delete: "/device/internal/api/v1/trunk_config/{id}"
    };
  }

  // Метод разархивации trunk-конфигурации.
  // Метод доступен для: admin, service, device_admin
  rpc PostTrunkConfigRestore(PostTrunkConfigRestoreRequest) returns (PostTrunkConfigRestoreResponse) {
    option (google.api.http) = {
      post: "/device/internal/api/v1/trunk_config/restore/{id}"
    };
  }
}

// Trunk-конфигурация.
// # Описание модели
message TrunkConfig {
  // Идентификатор.
  // # Тип: Guid
  string id = 1;
  // ОРПОН Города
  int64 city_orpon_id = 2 [(google.api.field_behavior) = REQUIRED];
  // Тип Trunk-аккаунта
  Device.SipTrunk.SipType device_sip_trunk_sip_type = 3 [(google.api.field_behavior) = REQUIRED];
  // IP-адрес.
  // # Диапазон: 7..15
  string ip_address = 4 [(google.api.field_behavior) = REQUIRED];
  // Порт.
  // # Диапазон: 0..65535
  int32 port = 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;
  // Дата удаления.
  // # Тип: DateTime?
  google.protobuf.Timestamp deleted_at = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Ошибка сохранения.
  // Эти проверки выполняются при работе с базой данных и сторонними сервисами
  message SavingError {
    // Конфликт версий.
    // Причины:
    // - В базе хранится другая версия строки, значения changed_at оличаются
    message Conflict {}
    // Причина ошибки
    oneof reason {
      // Конфликт версий
      Conflict conflict = 1;
    }
  }
}

// Фильтр для Trunk-конфигураций
message TrunkConfigFilter {
  // Фильтр по ОРПОН идентификаторам города
  repeated int64 city_orpon_ids = 1;
  // Фильтр по IP-адресам
  repeated string ip_addresses = 2;
  // Показывать удаленные
  google.protobuf.BoolValue show_deleted = 3;
}

// Постраничный вывод
message TrunkConfigPaging {
  // Справочник типов значений сортировки.
  // # Тип: byte
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // По идентификатору
    ID = 1;
    // Дата последнего изменения
    CHANGED_AT = 2;
    // Дата создания
    CREATED_AT = 3;
  }
  // Тип значения сортировки.
  // Если значение не передано, то будет взято значение по умолчанию.
  // # По умолчанию: 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;
}

// Запрос сохранения Trunk-конфигурации по идентификатору
message PostTrunkConfigRequest {
  // Trunk-конфигурации
  TrunkConfig data = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос сохранения Trunk-конфигурации по идентификатору
message PostTrunkConfigResponse {
  // Ошибка запроса сохранения Trunk-конфигурации
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
      // Ошибка сохранения
      TrunkConfig.SavingError saving = 2;
    }
  }
  // Тип результата
  oneof type {
    // Профиль шифрования
    TrunkConfig data = 1;
    // Ошибка
    Error error = 2;
  }
}
// Запрос на получение Trunk-конфигурации
message GetTrunkConfigRequest {
  // Идентификатор трубки.
  // # Тип: Guid
  string id = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос Trunk-конфигурации
message GetTrunkConfigResponse {
  // Ошибка запроса получения баннера
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Trunk-конфигурация
    TrunkConfig data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос на получение списка Trunk-конфигураций
message GetTrunkConfigListRequest {
  // Фильтр
  TrunkConfigFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Стандартный постраничный вывод
    TrunkConfigPaging paging = 2;
  }
}

// Ответ на запрос списка Trunk-конфигураций
message GetTrunkConfigListResponse {
  // Ошибка запроса получения списка Trunk-конфигураций
  message Error {
    // Ошибка валидации
    ValidationError validation_error = 1;
  }
  // Тип результата
  oneof type {
    // Trunk-конфигурация
    TrunkConfig data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос на получение количества Trunk-конфигураций
message GetTrunkConfigCountRequest {
  // Фильтр
  TrunkConfigFilter filter = 1;
}

// Ответ на запрос количества Trunk-конфигураций
message GetTrunkConfigCountResponse {
  // Ошибка запроса получения количества Trunk-конфигураций
  message Error {
    // Ошибка валидации
    ValidationError validation_error = 1;
  }
  // Тип результата
  oneof type {
    // Всего Trunk-конфигураций
    int32 data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос удаления Trunk-конфигурации
message DeleteTrunkConfigRequest {
  // Идентификатор.
  // # Тип: Guid
  string id = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления Trunk-конфигурации
message DeleteTrunkConfigResponse {
  // Ошибка запроса восстановления Trunk-конфигурации
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}

// Запрос разархивации Trunk-конфигурации по идентификатору
message PostTrunkConfigRestoreRequest {
  // Идентификатор.
  // # Тип: Guid
  string id = 1 [(google.api.field_behavior) = REQUIRED];
}
// Отвест на запрос разархивации Trunk-конфигурации по идентификатору
message PostTrunkConfigRestoreResponse {
  // Ошибка запроса разархивации Trunk-конфигурации
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}