/*
Сервис управления настройками Gate режима
*/
syntax = "proto3";
package deviceapis.device.v1;
import "deviceapis/device/v1/deviceapis_device_common_v1.proto";
import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Deviceapis.Device.V1";
option go_package = "/deviceapis_device_v1";
option java_multiple_files = false;
option java_outer_classname = "DeviceapisDeviceV1Proto";
option java_package = "ru.deviceapis.device.v1";
option java_string_check_utf8 = true;
option objc_class_prefix = "DEVICEAPISDEVICEV1";
option optimize_for = LITE_RUNTIME;
option php_namespace = "Deviceapis\\Device\\V1";
option ruby_package = "Deviceapis::Device::V1";
// Сервис управления Gate режимом
service GateModeService {
    // Метод получения Gate режима
    rpc GetGateMode ( GetGateModeRequest ) returns ( GetGateModeResponse ) {
        option (google.api.http) = { get: "/device/api/v1/gate/mode" };
    }
    // Метод редактирования Gate режима
    rpc SaveGateMode ( SaveGateModeRequest ) returns ( SaveGateModeResponse ) {
        option (google.api.http) = { post: "/device/api/v1/gate/mode", body: "*" };
    }
}
// Настройки Gate режима
message GateMode {
    // Флаг включения Gate режима.
    // true=gate; false=ordinary
    bool is_gate_mode_on = 1 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "true" }
    ];
    // Дома Gate режима.
    // При редактировании массив полностью заменяется на отправленный
    repeated House houses = 2 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { max_items: 100, min_items: 1 }
    ];
}
// Запрос получения Gate режима
message GetGateModeRequest {
}
// Ответ на запрос получения Gate режима
message GetGateModeResponse {
    // Тип ответа
    oneof type {
        // Настройки Gate режима
        GateMode data = 1;
    }
}
// Дом Gate режима
message House {
    // Диапазон квартир
    message RoomRange {
        // Начало диапазона включительно
        string first_room_number = 1 [
            (google.api.field_behavior) = REQUIRED,
            (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"234\"" }
        ];
        // Конец диапазона включительно
        string last_room_number = 2 [
            (google.api.field_behavior) = REQUIRED,
            (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"1234\"" }
        ];
    }
    // Варианты подстановки номера дома и квартиры в SIP Invite
    enum InviteTemplateType {
        // Значение не указано
        INVITE_TEMPLATE_TYPE_UNKNOWN = 0;
        // 4 символа для номера дома с лидирующими нулями, 4 символа для номера квартиры с лидирующими нулями.
        // Номера дома и квартиры при звонке подставляются в виде: 00120123@sip.acme.io
        H4LZ_F4LZ = 1;
        // 4 символа для номера дома с лидирующими нулями, 4 или меньше символа для номера квартиры.
        // Номера дома и квартиры при звонке подставляются в виде: 0012123@sip.acme.io
        H4LZ_F4 = 2;
        // 4 или меньше символа для номера дома, 4 символа для номера квартиры с лидирующими нулями.
        // Номера дома и квартиры при звонке подставляются в виде: 120123@sip.acme.io
        H4_F4LZ = 3;
    }
    // Адрес дома
    string address = 1 [(google.api.field_behavior) = REQUIRED];
    // Номер дома (подъезда)
    string prefix = 2 [(google.api.field_behavior) = REQUIRED];
    // Диапазон квартир.
    // Если не задан, то устройство позволяет набор любой квартиры
    RoomRange room_range = 3;
    // Адрес Sip сервера.
    // При пустом sip_server будет использован сервер SIP регистрации
    string sip_server = 4 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"sip.acme.io:5060\"" }
    ];
    // Вариант подстановки номера дома и квартиры в SIP Invite.
    // При отсутствии значения используется вариант H4LZ_F4LZ
    InviteTemplateType invite_template_type = 5 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "H4LZ_F4LZ" }
    ];
}
// Запрос редактирования Gate режима
message SaveGateModeRequest {
    // Настройки Gate режима
    GateMode data = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос редактирования Gate режима
message SaveGateModeResponse {
    // Ошибка запроса
    message Error {
        // Причина ошибки
        oneof reason {
            // Ошибка валидации
            ValidationError validation = 1;
        }
    }
    // Тип ответа
    oneof type {
        // Настройки Gate режима
        GateMode data = 1;
        // Ошибка
        Error error = 2;
    }
}