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

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

package keyapis.iot_connect.v1;

option java_package = "ru.keyapis.iot_connect.v1";
option java_outer_classname = "KeyapisIotConnectV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_iot_connect_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.IotConnect.V1";
option objc_class_prefix = "KEYAPISIOTCONNECTV1";
option php_namespace = "Keyapis\\IotConnect\\V1";
option ruby_package = "Keyapis::IotConnect::V1";
option optimize_for = LITE_RUNTIME;

// Сервис для отправки команд и сообщений внешним партнёрам IoT
service IotConnectManageService{
  // Метод разъединения аккаунтов.
  // Метод доступен для: admin
  rpc PutManageUserScopeDetach(PutManageUserScopeDetachRequest) returns (PutManageUserScopeDetachResponse)
  {
    option (google.api.http) = {
      put: "/iot_connect/api/v1/manage/user/{user_id}/scope/{scope}/detach"
    };
  }
  // Метод обработки события звонка с домофона.
  // Метод доступен для: service
  rpc PostManageCall(PostManageCallRequest) returns (PostManageCallResponse) {
    option (google.api.http) = {
      post: "/iot_connect/api/v1/manage/call"
      body: "*"
    };
  }
  // Метод обработки события об окончании группового звонка с домофона.
  // Метод доступен для: service
  rpc PostManageCallCancel(PostManageCallCancelRequest) returns (PostManageCallCancelResponse) {
    option (google.api.http) = {
      post: "/iot_connect/api/v1/manage/call_cancel"
      body: "*"
    };
  }
}

// Запрос на передачу события звонка с домофона
message PostManageCallRequest {
  // Вызываемый номер
  string to_number = 1 [(google.api.field_behavior) = REQUIRED];
  // Вызывающий номер
  string from_number = 2 [(google.api.field_behavior) = REQUIRED];
}

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

// Запрос на передачу события об окончании группового звонка с домофона
message PostManageCallCancelRequest {
  // Вызываемый номер
  string to_number = 1 [(google.api.field_behavior) = REQUIRED];
  // Вызывающий номер
  string from_number = 2 [(google.api.field_behavior) = REQUIRED];
}

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

// Запрос метода разъединения аккаунтов
message PutManageUserScopeDetachRequest {
  // Идентификатор пользователя
  int32 user_id = 1 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор клиента - оператора IoT
  string scope = 2 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос метода разъединения аккаунтов
message PutManageUserScopeDetachResponse {
  // Ошибка запроса
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}

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