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

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";

package keyapis.dial.v1;

option java_package = "ru.keyapis.dial.v1";
option java_outer_classname = "KeyapisDialV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_dial_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.Dial.V1";
option objc_class_prefix = "KEYAPISDIALV1";
option php_namespace = "Keyapis\\Dial\\V1";
option ruby_package = "Keyapis::Dial::V1";
option optimize_for = LITE_RUNTIME;

// Сервис управления массовым оповещением через домофоны
service BroadcastAlertService {
    // Метод запуска массового оповещения через домофоны.
    // Метод доступен для: ApiKey
    rpc PostBroadcastAlertStart (PostBroadcastAlertStartRequest) returns (PostBroadcastAlertStartResponse) {
        option (google.api.http) = {
            post: "/dial/internal/api/v1/broadcast_alert/start"
            body: "*"
        };
    }
}

// Запрос на запуск массового оповещения через домофоны
message PostBroadcastAlertStartRequest {
    // Вызываемый номер.
    // # Паттерн: /^\+[1-9][0-9]{10}$/
    string to_number = 1 [(google.api.field_behavior) = REQUIRED];
    // Вызывающий номер.
    // # Паттерн: /^\+[1-9][0-9]{10}$/
    string from_number = 2 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос на запуск массового оповещения через домофоны
message PostBroadcastAlertStartResponse {
    // Ошибка запроса
    message Error {
        // Не найден сценарий оповещения
        message ScenarioNotFound {}
        // Причина ошибки
        oneof reason {
            // Ошибка валидации
            ValidationError validation = 1;
            // Звуковой файл не найден
            ScenarioNotFound scenario_not_found = 2;
        }
    }
    // Тип результата
    oneof type {
        // Ошибка
        Error error = 1;
    }
}

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