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

import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/descriptor.proto";
import "google/protobuf/wrappers.proto";
import "keyapis/multiapp/v1/keyapis_multiapp_app_v1.proto";

package keyapis.multiapp.v1;

option java_package = "ru.keyapis.multiapp.v1";
option java_outer_classname = "KeyapisMultiappV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_multiapp_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.Multiapp.V1";
option objc_class_prefix = "KEYAPISMULTIAPPV1";
option php_namespace = "Keyapis\\Multiapp\\V1";
option ruby_package = "Keyapis::Multiapp::V1";
option optimize_for = LITE_RUNTIME;

// Сервис уведомлений
service NotificationService {
  // Метод отправки уведомления уведомления.
  // Метод доступен для: partner.
  // Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization
  rpc PostNotification(PostNotificationRequest) returns (PostNotificationResponse) {
    option (google.api.http) = {
      post: "/multiapp/api/v1/notification"
      body: "*"
    };
  }
}

// Уведомление
message Notification {
  // Идентификатор приложения.
  // # Тип: Guid
  string app_id = 1 [(google.api.field_behavior) = REQUIRED];
  // ОРПОН.
  // # Диапазон 1..9223372036854775807
  int64 orpon = 2 [(google.api.field_behavior) = REQUIRED];
  // Номер квартиры.
  // # Диапазон: 1..150
  repeated string room_numbers = 3 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор шаблона.
  // # Тип: Guid
  string template_id = 4 [(google.api.field_behavior) = REQUIRED];
  // Значения для подстановки в текст шаблона
  map<string, string> values = 5 [(google.api.field_behavior) = REQUIRED];
  // Полезная нагрузка
  map<string, string> payload = 6;
}

// Запрос сохранения уведомления
message PostNotificationRequest {
  // Уведомление
  Notification data = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос сохранения уведомления
message PostNotificationResponse {
  // Ошибка запроса сохранения уведомления
  message Error {
    // Значения для подстановки не соответствуют шаблону уведомления
    message ValuesError {}
    // Приложение находится в статусе "Заблокировано"
    message AppBlockedError {}
    // Ошибка свзяанная с назначениями приложения.
    // Причины:
    // - Приложение назначено не только по ОРПОНу или ОРПОНу и номеру квартиры;
    // - Приложение не назначено на переданные orpon и room_number
    message AppAssignmentError {}
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
      // Значения для подстановки не соответствуют шаблону уведомления
      ValuesError values = 2;
      // Приложение находится в статусе "Заблокировано"
      AppBlockedError app_blocked = 3;
      // Ошибка связанная с назначениями приложения
      AppAssignmentError app_assignment = 4;
    }
  }
  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}