/*
  Спецификация архивных записей камеры
*/
syntax = "proto3";

package keyapis.vc.v1;

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

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

// Сервис архивных записей камеры
service CameraArchiveService {
  // Метод получения доступных дней с видеоархивом камеры.
  // При обращении к ВН берется идентификатор пользователя из токена.
  // Метод доступен для: admin, service, bti, mrf, ltp_first, master, owner, employee, seller, external_seller
  rpc GetCameraArchiveCalendar (GetCameraArchiveCalendarRequest) returns (GetCameraArchiveCalendarResponse) {
    option (google.api.http) = {get: "/vc/api/v1/camera_archive/{camera_uid}/calendar"};
  }
  // Метод получения доступных интервалов видеоархива камеры.
  // При обращении к ВН берется идентификатор пользователя из токена.
  // Метод доступен для: admin, service, bti, mrf, ltp_first, master, owner, employee, seller, external_seller
  rpc GetCameraArchiveIntervals (GetCameraArchiveIntervalsRequest) returns (GetCameraArchiveIntervalsResponse) {
    option (google.api.http) = {get: "/vc/api/v1/camera_archive/{camera_uid}/intervals"};
  }
}

// Календарь с датами, в которые есть записи
message CameraArchiveCalendar {
    // Идентификатор камеры
    string camera_uid = 1;
    // Список дней, за которые есть записи.
    // Строки в формате "YYYY-MM-DD"
    repeated string dates = 2;
}

// Запрос получения дней, в которых есть записи на камере
message GetCameraArchiveCalendarRequest {
  // Идентификатор камеры
  string camera_uid = 1 [(google.api.field_behavior) = REQUIRED];
  // Смещение таймзоны в минутах.
  // # Диапазон: -720..840
  google.protobuf.Int32Value utc_offset = 2;
}

// Ответ запрос на получения дней, в которых есть записи на камере
message GetCameraArchiveCalendarResponse {
  // Ошибка запроса
  message Error {
    // Ошибка в сервисе ВН
    message VcError {
      // Текст ошибки
      string text = 1;
    }
    // Отсутствует идентификатор пользователя в Видеоплатформе 
    message VcUserNotFound {}
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
      // Ошибка в сервисе ВН
      VcError vc_error = 2;
      // Отсутствует идентификатор пользователя в Видеоплатформе 
      VcUserNotFound vc_user_not_found = 3;
    }
  }
  // Тип ответа
  oneof type {
    // Календарь с датами, в которые есть записи
    CameraArchiveCalendar data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос получения дней, в которых есть записи на камере
message GetCameraArchiveIntervalsRequest {
  // Идентификатор камеры
  string camera_uid = 1 [(google.api.field_behavior) = REQUIRED];
  // Время с которого нужно получить интервалы архива unixtime
  google.protobuf.DoubleValue timestamp_since = 2;
  // Время по которое нужно получить интервалы архива unixtime
  google.protobuf.DoubleValue timestamp_till = 3;
}

// Интервал
message Interval {
  // Начало интервала unixtime
  double timestamp_begin = 1;
  // Конец интервала unixtime
  double timestamp_end = 2;
}

// Интервалы видеоархива камеры
message CameraArchiveIntervals {
    // Идентификатор камеры
    string camera_uid = 1;
    // Список интервалов видеоархива камеры
    repeated Interval intervals = 2;
}

// Ответ запрос на получения дней, в которых есть записи на камере
message GetCameraArchiveIntervalsResponse {
  // Ошибка запроса
  message Error {
    // Ошибка в сервисе ВН
    message VcError {
      // Текст ошибки
      string text = 1;
    }
    // Отсутствует идентификатор пользователя в Видеоплатформе 
    message VcUserNotFound {}
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
      // Ошибка в сервисе ВН
      VcError vc_error = 2;
      // Отсутствует идентификатор пользователя в Видеоплатформе 
      VcUserNotFound vc_user_not_found = 3;
    }
  }
  // Тип ответа
  oneof type {
    // Интервалы видеоархива камеры
    CameraArchiveIntervals data = 1;
    // Ошибка
    Error error = 2;
  }
}