/*
  Сервис реализует функционал управления пуш-токенами устройств.
  Используется как отдельное хранилихе пуш токенов, на первом этапе будет хранить только PWA токены
*/
syntax = "proto3";

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

package keyapis.notification.v1;

option java_package = "ru.keyapis.notification.v1";
option java_outer_classname = "KeyapisNotificationV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_notification_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.Notification.V1";
option objc_class_prefix = "KEYAPISNOTIFICATIONV1";
option php_namespace = "Keyapis\\Notification\\V1";
option ruby_package = "Keyapis::Notification::V1";
option optimize_for = LITE_RUNTIME;

// Сервис пуш-токенов устройств
service PushTokenService {
  // Метод сохранения пуш-токенов.
  // Поддерживает создание и обновление.
  // Метод доступен для: admin, master, employee, owner, service, application(notification:edit).
  // Для ролей master, employee, owner можно сохранять только собственные пуш-токены.
  // Для ролей admin, service доступны все пуш-токены
  rpc PostPushToken(PostPushTokenRequest) returns (PostPushTokenResponse) {
    option (google.api.http) = {
      post: "/notification/api/v1/push_token",
      body: "*"
    };
  }
  // Метод получения пуш-токенов.
  // Метод доступен для: admin, master, employee, owner, service, application(notification:read или notification:edit).
  // Для ролей master, employee, owner можно просматривать только собственные пуш-токены.
  // Для ролей admin, service доступны все пуш-токены
  rpc GetPushTokenList(GetPushTokenListRequest) returns (stream GetPushTokenListResponse) {
    option (google.api.http) = {
      get: "/notification/api/v1/push_token/list"
    };
  }
  // Метод получения количества пуш-токенов.
  // Метод доступен для: admin, master, employee, owner, service, application(notification:read или notification:edit).
  // Для ролей master, employee, owner можно просматривать только собственные пуш-токены.
  // Для ролей admin, service доступны все пуш-токены
  rpc GetPushTokenCount(GetPushTokenCountRequest) returns (GetPushTokenCountResponse) {
    option (google.api.http) = {
      get: "/notification/api/v1/push_token/count"
    };
  }
  // Метод удаления пуш-токена.
  // Метод доступен для: admin, master, employee, owner, service, application(notification:edit).
  // Для ролей master, employee, owner можно удалять только собственные пуш-токены.
  // Для ролей admin, service можно удалять все пуш-токены
  rpc DeletePushToken(DeletePushTokenRequest) returns (DeletePushTokenResponse) {
    option (google.api.http) = {
      delete: "/notification/api/v1/push_token/{id}"
    };
  }
  // Метод удаления пуш-токена по идентификатору устройства пользователя.
  // Метод доступен для: admin, master, employee, owner, service, application(notification:edit).
  // Для ролей master, employee, owner можно удалять только собственные пуш-токены.
  // Для ролей admin, service можно удалять все пуш-токены
  rpc DeletePushTokenUserAppId(DeletePushTokenUserAppIdRequest) returns (DeletePushTokenUserAppIdResponse) {
    option (google.api.http) = {
      delete: "/notification/api/v1/push_token/user_app_id/{user_app_id}"
    };
  }
  // Метод удаления пуш-токенов по идентификатору пользователя.
  // Метод доступен для: admin, master, employee, owner, service, application(notification:edit).
  // Для ролей master, employee, owner можно удалять только собственные пуш-токены.
  // Для ролей admin, service можно удалять все пуш-токены
  rpc DeletePushTokenUserId(DeletePushTokenUserIdRequest) returns (DeletePushTokenUserIdResponse) {
    option (google.api.http) = {
      delete: "/notification/api/v1/push_token/user_id/{user_id}"
    };
  }
}

// Пуш-токен.
// # Описание модели
message PushToken {
  // Идентификатор.
  // # Диапазон: 0..2147483647
  int32 id = 1;
  // Справочников типов пуш-токенов.
  // # Тип: byte
  enum Type {
    // Не указан
    TYPE_UNKNOWN = 0;
    // Для Mobile Firebase Cloud Messaging
    MOBILE_FCM = 1;
    // Для Mobile Huawei Messaging System
    MOBILE_HMS = 2;
    // Для Mobile Apple PushToken System для текста
    MOBILE_APNS_TEXT = 3;
    // Для Mobile Apple PushToken System для звонков
    MOBILE_APNS_CALL = 4;
    // Для PWA Firebase Cloud Messaging
    PWA_FCM = 5;
    // Для PWA Apple PushToken System
    PWA_APNS = 6;
    // Для Mobile RuStore
    MOBILE_RUSTORE = 7;
  }
  // Тип
  Type type = 2 [(google.api.field_behavior) = REQUIRED];
  // Токен.
  // # Диапазон: 16..256
  string token = 3 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор устройства пользователя.
  // # Тип: Guid
  string user_app_id = 4 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор пользователя.
  // # Диапазон: 1..2147483647
  google.protobuf.Int32Value user_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Дата и время создания.
  // # Тип: DateTime
  google.protobuf.Timestamp created_at = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Дата последнего изменения.
  // Заполняется и обновляется сервером.
  // Заполняется при создании и изменении.
  // Является версией объекта.
  // # Тип: DateTime
  google.protobuf.Timestamp changed_at = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Версия приложения.
  // # Диапазон: 3..256
  string app_version = 8 [(google.api.field_behavior) = REQUIRED];

  // Ошибка валидации пуш-токена.
  // Эти проверки выполняются до обращения в базу данных
  message ValidationError {
    // Причины:
    // - Cодержит значение не Guid
    message UserAppIdInvalid {}

    oneof reason {
      // Передан некоректный идентификатор устройства пользователя
      UserAppIdInvalid user_app_id = 1;
    }
  }

  // Ошибка сохранения пуш-токена.
  // Эти проверки выполняются при работе с базой данных и сторонними сервисами
  message SavingError {
    // Причины:
    //  - Переданный индентификатор устройства пользователя уже существует с другим токеном
    message UserAppIdExists {}
    // Конфликт версий.
    // Причины:
    // - В базе хранится другая версия строки, значения changed_at отличаются
    message Conflict {}

    oneof reason {
      // Идентификатор устройства пользователя уже используется
      UserAppIdExists user_app_id_exists = 1;
      // Конфликт версий
      Conflict conflict = 2;
    }
  }
}

// Фильтр по пуш-токенам
message PushTokenFilter {
  // По типам пуш-токенов
  repeated PushToken.Type types = 1;
  // По идентификаторам устройств пользователя.
  // # Тип: Guid
  repeated string user_app_ids = 2;
  // По идентификаторам пользователя
  repeated int32 user_ids = 3;
  // От даты создания включительно (>=)
  google.protobuf.Timestamp begin_created_at = 4;
  // До даты создания (<)
  google.protobuf.Timestamp end_created_at = 5;
  // От даты изменения включительно (>=)
  google.protobuf.Timestamp begin_changed_at = 6;
  // До даты изменения (<)
  google.protobuf.Timestamp end_changed_at = 7;

  // Ошибки валидации фильтра по фильтру пуш-токенов.
  // Эти проверки выполняются до обращения в базу данных
  message ValidationError {
    // Причины:
    // - Cодержит значение не Guid
    message UserAppIdsInvalid {}

    oneof reason {
      // Идентификаторы устройств пользователя переданы некоректно
      UserAppIdsInvalid user_app_ids = 1;
    }
  }
}

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

    // Причина ошибки
    oneof reason {
      // Количество передано некорректно
      LimitInvalid limit = 1;
      // Сдвиг передан некорректно
      OffsetInvalid offset = 2;
    }
  } 
}

// Запрос на создание/изменение пуш-токена
message PostPushTokenRequest {
  // Пуш-токен
  PushToken data = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос на создание/изменение пуш-токена
message PostPushTokenResponse {
  // Ошибка запроса сохранения пуш-токена
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации пуш-токена
      PushToken.ValidationError push_token_validation = 1 [deprecated = true, (google.api.field_visibility).restriction = "DEPRECATED"];
      // Ошибка сохранения пуш-токена
      PushToken.SavingError push_token_saving = 2;
      // Ошибка валидации пуш-токена
      ValidationError validation = 3;
    }
  }
  // Тип ответа
  oneof type {
    // Пуш-токен
    PushToken data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос на получение пуш-токенов пользователя
message GetPushTokenListRequest {
  // Фильтр
  PushTokenFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Стандартный постраничный вывод
    PushTokenPaging paging = 2;
  }
}

// Запрос получения количества пуш-токенов
message GetPushTokenCountRequest {
  // Фильтр
  PushTokenFilter filter = 1;
}
// Ответ на запрос получения количества пуш-токенов
message GetPushTokenCountResponse {
  // Ошибка запроса получения количества пуш-токенов
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка фильтрации
      PushTokenFilter.ValidationError push_token_filter_validation = 1 [deprecated = true, (google.api.field_visibility).restriction = "DEPRECATED"];  
      // Ошибка валидации
      ValidationError validation = 2;
    }
  }
  // Тип результата
  oneof type {
    // Всего пуш-токенов
    int32 data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Ответ на получение списка пуш-токенов
message GetPushTokenListResponse {
  // Ошибка запроса получения списка пуш-токенов
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка фильтрации
      PushTokenFilter.ValidationError push_token_filter_validation = 1 [deprecated = true, (google.api.field_visibility).restriction = "DEPRECATED"];
      // Ошибка пагинации по страницам
      PushTokenPaging.ValidationError push_token_paging_validation = 2 [deprecated = true, (google.api.field_visibility).restriction = "DEPRECATED"];
      // Ошибка валидации
      ValidationError validation = 3;
    }
  }
  // Тип результата
  oneof type {
    // Пуш-токен
    PushToken data = 1;
    // Ошибка
    Error error = 2;
  }
}
// Запрос удаления пуш-токена
message DeletePushTokenRequest {
  // Идентификатор.
  // # Диапазон: 0..2147483647
  int32 id = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления пуш-токена
message DeletePushTokenResponse {
  // Ошибка удаления пуш-токена
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип ответа
  oneof type {
    // Ошибка
    Error error = 1;
  }
}

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

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

// Ошибки валидации.
// Эти проверки выполняются до обращения в базу данных
message ValidationError {
  // Путь к полю в формате наименования прото
  string path = 1 [(google.api.field_behavior) = REQUIRED];
  // Валидационное сообщение
  string message = 2 [(google.api.field_behavior) = REQUIRED];
}