/*
  Сервис реализует функционал управления шаблонами уведомлений
*/
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 NotificationTemplateService {
  // Метод сохранения шаблона уведомления.
  // Поддерживает создание и обновление.
  // Поддерживает mustache теги в переменных template_header и template_text.
  // Сценарий использования метода: https://confluence.rt.ru/pages/viewpage.action?pageId=774989444.
  // Метод доступен для: admin, manager, service
  rpc PostNotificationTemplate(PostNotificationTemplateRequest) returns (PostNotificationTemplateResponse) {
    option (google.api.http) = {
      post: "/multiapp/api/v1/notification_template"
      body: "*"
    };
  }
  // Метод получения шаблона уведомления.
  // Метод доступен для: admin, manager, service, partner.
  // Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization.
  // Роли partner доступны только связанные с ней шаблоны
  rpc GetNotificationTemplate(GetNotificationTemplateRequest) returns (GetNotificationTemplateResponse) {
    option (google.api.http) = {
      get: "/multiapp/api/v1/notification_template/{id}"
    };
  }
  // Метод удаления шаблона уведомления.
  // Устанавливает текущую дату и время в параметр deleted_at.
  // Метод доступен для: admin, manager, service
  rpc DeleteNotificationTemplate(DeleteNotificationTemplateRequest) returns (DeleteNotificationTemplateResponse) {
    option (google.api.http) = {
      delete: "/multiapp/api/v1/notification_template/{id}"
    };
  }
  // Метод получения списка шаблонов уведомлений.
  // Метод доступен для: admin, manager, service, partner.
  // Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization.
  // Если метод вызван ролью partner в фильтре поле partner_ids принудительно замещается его идентификатором
  rpc GetNotificationTemplateList(GetNotificationTemplateListRequest) returns (stream GetNotificationTemplateListResponse) {
    option (google.api.http) = {
      get: "/multiapp/api/v1/notification_template/list"
    };
  }
  // Метод получения количества шаблонов уведомлений.
  // Метод доступен для: admin, manager, service, partner.
  // Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization.
  // Если метод вызван ролью partner в фильтре поле partner_ids принудительно замещается его идентификатором
  rpc GetNotificationTemplateCount(GetNotificationTemplateCountRequest) returns (GetNotificationTemplateCountResponse) {
    option (google.api.http) = {
      get: "/multiapp/api/v1/notification_template/count"
    };
  }
  // Метод создания связи шаблона уведомления и партнера.
  // Метод доступен для: admin, manager, service
  rpc PutNotificationTemplatePartnerAttach(PutNotificationTemplatePartnerAttachRequest) returns (PutNotificationTemplatePartnerAttachResponse) {
    option (google.api.http) = {
      put: "/multiapp/api/v1/notification_template/{notification_template_partner.notification_template_id}/partner/{notification_template_partner.partner_id}/attach"
    };
  }
  // Метод удаления связи шаблона уведомления и партнера.
  // Метод доступен для: admin, manager, service
  rpc PutNotificationTemplatePartnerDetach(PutNotificationTemplatePartnerDetachRequest) returns (PutNotificationTemplatePartnerDetachResponse) {
    option (google.api.http) = {
      put: "/multiapp/api/v1/notification_template/{notification_template_partner.notification_template_id}/partner/{notification_template_partner.partner_id}/detach"
    };
  }
}

// Шаблон уведомления.
// # Описание модели
message NotificationTemplate {
  // Идентификатор.
  // Если не передан создаётся сервером.
  // # Тип: Guid
  string id = 1;
  // Заголовок шаблона.
  // Поддерживает mustache теги в формате: {{название переменной|тип данных}}.
  // Название переменной в теге может содержать латинские буквы (в верхнем или нижнем регистре), цифры и символ "_".
  // Тип данных может быть указан в верхнем или нижнем регистре, пробелы не допускаются, допустимые типы данных указаны в таблице.
  // Символы "{" и "}" являются служебными и могут использоваться только для формирования Mustache тегов.
  // # Диапазон: 3..128
  string template_header = 2 [(google.api.field_behavior) = REQUIRED];
  // Тело шаблона.
  // Поддерживает mustache теги в формате: {{название переменной|тип данных}}.
  // Название переменной в теге может содержать латинские буквы (в верхнем или нижнем регистре), цифры и символ "_".
  // Тип данных может быть указан в верхнем или нижнем регистре, пробелы не допускаются, допустимые типы данных указаны в таблице.
  // Символы "{" и "}" являются служебными и могут использоваться только для формирования Mustache тегов.
  // # Диапазон: 3..512
  string template_text = 3 [(google.api.field_behavior) = REQUIRED];
  // Дата создания.
  // # Тип: DateTime
  google.protobuf.Timestamp created_at = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Дата последнего изменения.
  // Заполняется и обновляется сервером.
  // При изменении должен совпадать со значением из БД.
  // Является версией объекта.
  // # Тип: DateTime
  google.protobuf.Timestamp changed_at = 5;
  // Дата удаления.
  // # Тип: DateTime?
  google.protobuf.Timestamp deleted_at = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
  // Системное наименование.
  // # Диапазон: 3..256
  string title = 7 [(google.api.field_behavior) = REQUIRED];
  // Ошибка сохранения.
  // Эти проверки выполняются при работе с базой данных и сторонними сервисами
  message SavingError {
    // Конфликт версий.
    // Причины:
    // - В базе хранится другая версия строки, значения changed_at отличаются
    message Conflict {}

    // Причина ошибки
    oneof reason {
      // Конфликт версий
      Conflict conflict = 1;
    }
  }
}

// Связь шаблона уведомлений и партнера.
// # Описание модели
message NotificationTemplatePartner {
  // Идентификатор шаблона уведомления.
  // # Тип: Guid
  string notification_template_id = 1 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор партнера.
  // # Тип: Guid
  string partner_id = 2 [(google.api.field_behavior) = REQUIRED];
  // Ошибка сохранения.
  // Эти проверки выполняются при работе с базой данных и сторонними сервисами
  message SavingError {
    // Партнер удален
    message PartnerIsDeleted {}
    // Шаблон удален
    message TemplateIsDeleted {}
    // Причина ошибки
    oneof reason {
      // Партнер удален
      PartnerIsDeleted partner_is_deleted = 1;
      // Шаблон удален
      TemplateIsDeleted template_is_deleted = 2;
    }
  }
}

// Запрос сохранения приложения
message PostNotificationTemplateRequest {
  // Приложение
  NotificationTemplate data = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос сохранения шаблона уведомления
message PostNotificationTemplateResponse {
  // Ошибка запроса сохранения шаблона уведомления
  message Error {
    // Некорректный тип данных для переменной в шаблоне.
    // Список допустимых типов данных:
    // - Number;
    // - Date;
    // - Phone;
    // - Time
    message IncorrectDataTypeError {}
    // Некорректное наименование переменной в шаблоне
    message IncorrectVariableNameError {}
    // Некорректный формат Mustache тегов
    message IncorrectTagFormatError {}
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
      // Ошибка сохранения
      NotificationTemplate.SavingError saving = 2;
      // Некорректный тип данных для переменной в шаблоне
      IncorrectDataTypeError incorrect_data_type = 3;
      // Некорректное наименование переменной в шаблоне
      IncorrectVariableNameError incorrect_variable_name_error = 4;
      // Некорректный формат Mustache тегов
      IncorrectTagFormatError incorrect_tag_format_error = 5;
    }
  }
  // Тип результата
  oneof type {
    // Шаблон уведомления
    NotificationTemplate data = 1;
    // Ошибка
    Error error = 2;
  }
}

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

// Запрос получения списка шаблонов уведомлений
message GetNotificationTemplateListRequest {
  // Фильтр
  NotificationTemplateFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Пагинация
    NotificationTemplatePaging paging = 2;
  }
}
// Ответ на запрос получения списка шаблонов уведомлений
message GetNotificationTemplateListResponse {
  // Ошибка запроса получения списка шаблонов уведомлений
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Шаблон уведомления
    NotificationTemplate data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос получения количества шаблонов уведомлений
message GetNotificationTemplateCountRequest {
  // Фильтр
  NotificationTemplateFilter filter = 1;
}
// Ответ на запрос получения количества шаблонов уведомлений
message GetNotificationTemplateCountResponse {
  // Ошибка запроса получения количества шаблонов уведомлений
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Всего шаблонов уведомлений
    int32 data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос создания связи шаблона уведомления и партнера
message PutNotificationTemplatePartnerAttachRequest {
  // Связь шаблона уведомления и партнера
  NotificationTemplatePartner notification_template_partner = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос создания связи шаблона уведомления и партнера
message PutNotificationTemplatePartnerAttachResponse {
  // Ошибка запроса на создание шаблона уведомления и партнера
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
      // Ошибка сохранения
      NotificationTemplatePartner.SavingError saving = 2;
    }
  }
  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}

// Запрос удаления связи шаблона уведомления и партнера
message PutNotificationTemplatePartnerDetachRequest {
  // Связь шаблона уведомления и партнера
  NotificationTemplatePartner notification_template_partner = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаление связи шаблона уведомления и партнера
message PutNotificationTemplatePartnerDetachResponse {
  // Ошибка запроса на удаление шаблона уведомления и партнера
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}

// Запрос на удаление шаблона уведомления
message DeleteNotificationTemplateRequest {
  // Идентификатор шаблона уведомления.
  // # Тип: Guid
  string id = 1 [(google.api.field_behavior) = REQUIRED];
}

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

// Фильтр шаблонов уведомлений
message NotificationTemplateFilter {
  // По тексту.
  // Если значение не передано то поиск по нему не производится.
  // # Диапазон: 3..64.
  // # Поиск производится по полям:
  // # - Заголовок шаблона;
  // # - Тело шаблона;
  // # - Системное наименование
  google.protobuf.StringValue text = 1;
  // По идентификаторам партнера.
  // # Тип: Guid
  repeated string partner_ids = 2;
  // Показывать удаленные
  google.protobuf.BoolValue is_show_deleted = 3;
}

// Пагинация шаблонов уведомлений
message NotificationTemplatePaging {
  // Справочник типов значений сортировки.
  // # Тип: byte
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // Дата последнего изменения
    CHANGED_AT = 1;
    // Дата создания
    CREATED_AT = 2;
    // По рангу для поиска по тексту.
    // Применяется когда передано поле для поиска по тексту.
    // В случае если текстовое поле не передано, применяется значение по умолчанию
    RANK = 3;
  }
  // Тип значения сортировки.
  // Если значение не передано, то будет взято значение по умолчанию.
  // # По умолчанию: CHANGED_AT
  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;
}