/*
  Сервис управления коллекциями камер
*/
syntax = "proto3";

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/wrappers.proto";
import "google/protobuf/timestamp.proto";
import "keyapis/vc/v1/keyapis_vc_camera_v1.proto";

package keyapis.vc.v1;

option java_package = "ru.keyapis.vc.v1";
option java_outer_classname = "KeyapisVcV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_vc_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.Vc.V1";
option objc_class_prefix = "KEYAPISVCV1";
option php_namespace = "Keyapis\\Vc\\V1";
option ruby_package = "Keyapis::Vc::V1";
option optimize_for = LITE_RUNTIME;

// Сервис управления коллекциями камер
service CameraCollectionService {
  // Метод получения коллекции камер.
  // Для owner, employee возвращаются только коллекции камер c COMPANY_ID из токена.
  // Метод доступен для: admin, service, bti, owner, employee
  rpc GetCameraCollection(GetCameraCollectionRequest) returns (GetCameraCollectionResponse) {
    option (google.api.http) = {
      get: "/vc/api/v1/camera_collection/{id}"
    };
  }
  // Метод получения списка коллекций камер.
  // Для owner, employee возвращаются только коллекции камер c COMPANY_ID из токена.
  // Метод доступен для: admin, service, bti, owner, employee
  rpc GetCameraCollectionList(GetCameraCollectionListRequest) returns (stream GetCameraCollectionListResponse) {
    option (google.api.http) = {
      get: "/vc/api/v1/camera_collection/list"
    };
  }
  // Метод получения количества коллекций камер.
  // Для owner, employee возвращаются только коллекции камер c COMPANY_ID из токена.
  // Метод доступен для: admin, service, bti, owner, employee
  rpc GetCameraCollectionCount(GetCameraCollectionCountRequest) returns (GetCameraCollectionCountResponse) {
    option (google.api.http) = {
      get: "/vc/api/v1/camera_collection/count"
    };
  }
  // Метод создания и изменения коллекции камер.
  // При изменении коллекции массив external_camera_ids заменяется полностью.
  // Для owner, employee сравнивается COMPANY_ID из токена и company_id коллекции, при несовпадении ошибка доступа.
  // Метод доступен для: admin, service, bti, owner, employee
  rpc SaveCameraCollection(SaveCameraCollectionRequest) returns (SaveCameraCollectionResponse) {
    option (google.api.http) = {
      post: "/vc/api/v1/camera_collection"
      body: "*"
    };
  }
  // Метод удаления коллекции камер.
  // Проставляет в поле deleted_at текущую дату.
  // Для owner, employee сравнивается COMPANY_ID из токена и company_id коллекции, при несовпадении ошибка доступа.
  // Метод доступен для: admin, service, bti, owner, employee
  rpc DeleteCameraCollection(DeleteCameraCollectionRequest) returns (DeleteCameraCollectionResponse) {
    option (google.api.http) = {
      delete: "/vc/api/v1/camera_collection/{id}"
    };
  }
  // Метод восстановления удаленной коллекции камер.
  // Проставляет null в поле deleted_at.
  // Для owner, employee сравнивается COMPANY_ID из токена и company_id коллекции, при несовпадении ошибка доступа.
  // Метод доступен для: admin, service, bti, owner, employee
  rpc PostCameraCollectionRestore(PostCameraCollectionRestoreRequest) returns (PostCameraCollectionRestoreResponse) {
    option (google.api.http) = {
      post: "/vc/api/v1/camera_collection/restore/{id}"
    };
  }
}


// Запрос получения количества коллекций камер
message GetCameraCollectionCountRequest {
  // Фильтр
  CameraCollectionFilter filter = 1;
}

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

// Запрос получения коллекции камер
message GetCameraCollectionRequest {
  // Идентификатор коллекции камер.
  // Тип: Guid
  string id = 1 [(google.api.field_behavior) = REQUIRED];
}

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

// Запрос получения списка коллекций камер
message GetCameraCollectionListRequest {
  // Фильтр
  CameraCollectionFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Постраничный вывод
    CameraCollectionPaging paging = 2;
  }
}

// Фильтр коллекций камер
message CameraCollectionFilter {
  // По тексту.
  // Если значение не передано то поиск по нему не производится.
  // # Диапазон: 3..64.
  // # Поиск производится по полям:
  // # - Наименование.
  // # - Описание.
  // # - Теги коллекции
  string text = 1;
  // По тегам.
  // Диапазон: 0..10
  repeated string tags = 2;
  // По компаниям.
  // Диапазон: 0..10
  repeated int64 company_ids = 3;
  // Показывать удаленные.
  // Если поле не передано, по умолчанию false, фильтр исключает удаленные
  google.protobuf.BoolValue is_deleted = 4;
}

// Постраничный вывод
message CameraCollectionPaging {
  // Справочник типов значений сортировки.
  // Тип: byte
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // По идентификатору
    ID = 1;
    // По имени
    NAME = 2;
    // По времени изменения
    CHANGED_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;
}

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

// Запрос на создание коллекции камер
message SaveCameraCollectionRequest {
  // Коллекция камер
  CameraCollection data = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос на создание коллекции камер
message SaveCameraCollectionResponse {
  // Ошибка запроса создания
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
      // Ошибка сохранения
      CameraCollection.SavingError saving = 2;
    }
  }
  // Тип ответа
  oneof type {
    // Коллекция камер
    CameraCollection data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Коллекция камер
message CameraCollection {
  // Идентификатор коллекции камер.
  // Тип: Guid
  string id = 1;
  // Наименование.
  // Диапазон: 3..256
  string name = 2 [(google.api.field_behavior) = REQUIRED];
  // Дата изменения коллекции камер.
  // Поле используется при редактировании и создании для контроля актуальности изменяемой версии
  google.protobuf.Timestamp changed_at = 3 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор компании
  int64 company_id = 4 [(google.api.field_behavior) = REQUIRED];
  // Дата удаления коллекции камер.
  // Поле изменяется через методы Delete и Restore
  google.protobuf.Timestamp deleted_at = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Описание.
  // Диапазон: 0..256
  string description = 6;
  // Теги коллекции.
  // Диапазон: 0..10
  repeated string tags = 7;
  // Привязанные к коллекции камеры
  repeated string external_camera_ids = 8;
  // Ошибка сохранения
  message SavingError {
    // Конфликт версий.
    // Причины:
    // - В базе хранится другая версия строки, значения changed_at отличаются
    message Conflict {}
    // Попытка сохранить коллекцию камер с company_id не своей компании.
    // Для ролей owner, employee сохранение разрешено только с company_id своей компании
    message WrongCompanyId {}
    // Причина ошибки
    oneof reason {
      // Конфликт версий
      Conflict conflict = 1;
      // Попытка сохранить коллекцию камер с company_id не своей компании
      WrongCompanyId wrong_company_id = 2;
    }
  }
}

// Запрос удаления коллекции камер
message DeleteCameraCollectionRequest {
  // Идентификатор коллекции камер.
  // Тип: Guid
  string id = 1 [(google.api.field_behavior) = REQUIRED];
}

// Запрос восстановления удаленной коллекции камер
message PostCameraCollectionRestoreRequest {
  // Идентификатор коллекции камер.
  // Тип: Guid
  string id = 1 [(google.api.field_behavior) = REQUIRED];
}

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

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