Протокол¶
Оглавление¶
-
keyapis/multiapp/v1/keyapis_multiapp_notification_template_v1.proto
- DeleteNotificationTemplateResponse
- DeleteNotificationTemplateResponse.Error
- GetNotificationTemplateCountRequest
- GetNotificationTemplateCountResponse
- GetNotificationTemplateCountResponse.Error
- GetNotificationTemplateListRequest
- GetNotificationTemplateListResponse
- GetNotificationTemplateListResponse.Error
- GetNotificationTemplateRequest
- GetNotificationTemplateResponse
- GetNotificationTemplateResponse.Error
- NotificationTemplate
- NotificationTemplate.SavingError
- NotificationTemplate.SavingError.Conflict
- NotificationTemplateFilter
- NotificationTemplatePaging
- NotificationTemplatePartner
- NotificationTemplatePartner.SavingError
- NotificationTemplatePartner.SavingError.PartnerIsDeleted
- NotificationTemplatePartner.SavingError.TemplateIsDeleted
- PostNotificationTemplateRequest
- PostNotificationTemplateResponse
- PostNotificationTemplateResponse.Error
- PostNotificationTemplateResponse.Error.IncorrectDataTypeError
- PostNotificationTemplateResponse.Error.IncorrectTagFormatError
- PostNotificationTemplateResponse.Error.IncorrectVariableNameError
- PutNotificationTemplatePartnerAttachRequest
- PutNotificationTemplatePartnerAttachResponse
- PutNotificationTemplatePartnerAttachResponse.Error
- PutNotificationTemplatePartnerDetachRequest
- PutNotificationTemplatePartnerDetachResponse
- NotificationTemplatePaging.OrderByType
Схема классов¶
keyapis/multiapp/v1/keyapis_multiapp_notification_template_v1.proto¶
Сервис реализует функционал управления шаблонами уведомлений
NotificationTemplateService¶
Сервис шаблонов уведомлений
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| PostNotificationTemplate | Метод сохранения шаблона уведомления. Поддерживает создание и обновление. Поддерживает mustache теги в переменных template_header и template_text. Сценарий использования метода: https://confluence.rt.ru/pages/viewpage.action?pageId=774989444. Метод доступен для: admin, manager, service | keyapis.multiapp.v1.PostNotificationTemplateRequest | keyapis.multiapp.v1.PostNotificationTemplateResponse |
| GetNotificationTemplate | Метод получения шаблона уведомления. Метод доступен для: admin, manager, service, partner. Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization. Роли partner доступны только связанные с ней шаблоны | keyapis.multiapp.v1.GetNotificationTemplateRequest | keyapis.multiapp.v1.GetNotificationTemplateResponse |
| DeleteNotificationTemplate | Метод удаления шаблона уведомления. Устанавливает текущую дату и время в параметр deleted_at. Метод доступен для: admin, manager, service | keyapis.multiapp.v1.DeleteNotificationTemplateRequest | keyapis.multiapp.v1.DeleteNotificationTemplateResponse |
| GetNotificationTemplateList | Метод получения списка шаблонов уведомлений. Метод доступен для: admin, manager, service, partner. Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization. Если метод вызван ролью partner в фильтре поле partner_ids принудительно замещается его идентификатором | keyapis.multiapp.v1.GetNotificationTemplateListRequest | keyapis.multiapp.v1.GetNotificationTemplateListResponse stream |
| GetNotificationTemplateCount | Метод получения количества шаблонов уведомлений. Метод доступен для: admin, manager, service, partner. Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization. Если метод вызван ролью partner в фильтре поле partner_ids принудительно замещается его идентификатором | keyapis.multiapp.v1.GetNotificationTemplateCountRequest | keyapis.multiapp.v1.GetNotificationTemplateCountResponse |
| PutNotificationTemplatePartnerAttach | Метод создания связи шаблона уведомления и партнера. Метод доступен для: admin, manager, service | keyapis.multiapp.v1.PutNotificationTemplatePartnerAttachRequest | keyapis.multiapp.v1.PutNotificationTemplatePartnerAttachResponse |
| PutNotificationTemplatePartnerDetach | Метод удаления связи шаблона уведомления и партнера. Метод доступен для: admin, manager, service | keyapis.multiapp.v1.PutNotificationTemplatePartnerDetachRequest | keyapis.multiapp.v1.PutNotificationTemplatePartnerDetachResponse |
DeleteNotificationTemplateRequest¶
Запрос на удаление шаблона уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор шаблона уведомления. # Тип: Guid | string | REQUIRED |
DeleteNotificationTemplateResponse¶
Ответ на запрос удаления шаблона уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка при удалении | optional keyapis.multiapp.v1.DeleteNotificationTemplateResponse.Error |
DeleteNotificationTemplateResponse.Error¶
Ошибка удаления шаблона уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.multiapp.v1.ValidationError |
GetNotificationTemplateCountRequest¶
Запрос получения количества шаблонов уведомлений
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.multiapp.v1.NotificationTemplateFilter |
GetNotificationTemplateCountResponse¶
Ответ на запрос получения количества шаблонов уведомлений
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего шаблонов уведомлений | optional int32 | |
| error | Ошибка | optional keyapis.multiapp.v1.GetNotificationTemplateCountResponse.Error |
GetNotificationTemplateCountResponse.Error¶
Ошибка запроса получения количества шаблонов уведомлений
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.multiapp.v1.ValidationError |
GetNotificationTemplateListRequest¶
Запрос получения списка шаблонов уведомлений
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.multiapp.v1.NotificationTemplateFilter | |
| paging | Пагинация | optional keyapis.multiapp.v1.NotificationTemplatePaging |
GetNotificationTemplateListResponse¶
Ответ на запрос получения списка шаблонов уведомлений
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Шаблон уведомления | optional keyapis.multiapp.v1.NotificationTemplate | |
| error | Ошибка | optional keyapis.multiapp.v1.GetNotificationTemplateListResponse.Error |
GetNotificationTemplateListResponse.Error¶
Ошибка запроса получения списка шаблонов уведомлений
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.multiapp.v1.ValidationError |
GetNotificationTemplateRequest¶
Запрос получения шаблона уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор шаблона уведомления. # Тип: Guid | string | REQUIRED |
GetNotificationTemplateResponse¶
Ответ на запрос получения шаблона уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Шаблон уведомления | optional keyapis.multiapp.v1.NotificationTemplate | |
| error | Ошибка | optional keyapis.multiapp.v1.GetNotificationTemplateResponse.Error |
GetNotificationTemplateResponse.Error¶
Ошибка запроса получения шаблона уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.multiapp.v1.ValidationError |
NotificationTemplate¶
Шаблон уведомления.
Описание модели¶
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор. Если не передан создаётся сервером. # Тип: Guid | string | |
| template_header | Заголовок шаблона. Поддерживает mustache теги в формате: {{название переменной | тип данных}}. Название переменной в теге может содержать латинские буквы (в верхнем или нижнем регистре), цифры и символ "_". Тип данных может быть указан в верхнем или нижнем регистре, пробелы не допускаются, допустимые типы данных указаны в таблице. Символы "{" и "}" являются служебными и могут использоваться только для формирования Mustache тегов. # Диапазон: 3..128 | string |
| template_text | Тело шаблона. Поддерживает mustache теги в формате: {{название переменной | тип данных}}. Название переменной в теге может содержать латинские буквы (в верхнем или нижнем регистре), цифры и символ "_". Тип данных может быть указан в верхнем или нижнем регистре, пробелы не допускаются, допустимые типы данных указаны в таблице. Символы "{" и "}" являются служебными и могут использоваться только для формирования Mustache тегов. # Диапазон: 3..512 | string |
| created_at | Дата создания. # Тип: DateTime | google.protobuf.Timestamp | OUTPUT_ONLY |
| changed_at | Дата последнего изменения. Заполняется и обновляется сервером. При изменении должен совпадать со значением из БД. Является версией объекта. # Тип: DateTime | google.protobuf.Timestamp | |
| deleted_at | Дата удаления. # Тип: DateTime? | google.protobuf.Timestamp | OUTPUT_ONLY |
| title | Системное наименование. # Диапазон: 3..256 | string | REQUIRED |
NotificationTemplate.SavingError¶
Ошибка сохранения. Эти проверки выполняются при работе с базой данных и сторонними сервисами
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| conflict | Конфликт версий | optional keyapis.multiapp.v1.NotificationTemplate.SavingError.Conflict |
NotificationTemplate.SavingError.Conflict¶
Конфликт версий. Причины: - В базе хранится другая версия строки, значения changed_at отличаются
NotificationTemplateFilter¶
Фильтр шаблонов уведомлений
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| text | По тексту. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Заголовок шаблона; # - Тело шаблона; # - Системное наименование | google.protobuf.StringValue | |
| partner_ids | По идентификаторам партнера. # Тип: Guid | repeated string | |
| is_show_deleted | Показывать удаленные | google.protobuf.BoolValue |
NotificationTemplatePaging¶
Пагинация шаблонов уведомлений
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: CHANGED_AT | keyapis.multiapp.v1.NotificationTemplatePaging.OrderByType | |
| direction_type | Тип направления сортировки. # По умолчанию: DESC | keyapis.multiapp.v1.NotificationTemplatePaging.DirectionType | |
| limit | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 | int32 | |
| offset | Сдвиг. # Диапазон: 0..2147483647 | int32 |
NotificationTemplatePartner¶
Связь шаблона уведомлений и партнера.
Описание модели¶
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| notification_template_id | Идентификатор шаблона уведомления. # Тип: Guid | string | REQUIRED |
| partner_id | Идентификатор партнера. # Тип: Guid | string | REQUIRED |
NotificationTemplatePartner.SavingError¶
Ошибка сохранения. Эти проверки выполняются при работе с базой данных и сторонними сервисами
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| partner_is_deleted | Партнер удален | optional keyapis.multiapp.v1.NotificationTemplatePartner.SavingError.PartnerIsDeleted | |
| template_is_deleted | Шаблон удален | optional keyapis.multiapp.v1.NotificationTemplatePartner.SavingError.TemplateIsDeleted |
NotificationTemplatePartner.SavingError.PartnerIsDeleted¶
Партнер удален
NotificationTemplatePartner.SavingError.TemplateIsDeleted¶
Шаблон удален
PostNotificationTemplateRequest¶
Запрос сохранения приложения
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Приложение | keyapis.multiapp.v1.NotificationTemplate | REQUIRED |
PostNotificationTemplateResponse¶
Ответ на запрос сохранения шаблона уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Шаблон уведомления | optional keyapis.multiapp.v1.NotificationTemplate | |
| error | Ошибка | optional keyapis.multiapp.v1.PostNotificationTemplateResponse.Error |
PostNotificationTemplateResponse.Error¶
Ошибка запроса сохранения шаблона уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.multiapp.v1.ValidationError | |
| saving | Ошибка сохранения | optional keyapis.multiapp.v1.NotificationTemplate.SavingError | |
| incorrect_data_type | Некорректный тип данных для переменной в шаблоне | optional keyapis.multiapp.v1.PostNotificationTemplateResponse.Error.IncorrectDataTypeError | |
| incorrect_variable_name_error | Некорректное наименование переменной в шаблоне | optional keyapis.multiapp.v1.PostNotificationTemplateResponse.Error.IncorrectVariableNameError | |
| incorrect_tag_format_error | Некорректный формат Mustache тегов | optional keyapis.multiapp.v1.PostNotificationTemplateResponse.Error.IncorrectTagFormatError |
PostNotificationTemplateResponse.Error.IncorrectDataTypeError¶
Некорректный тип данных для переменной в шаблоне. Список допустимых типов данных: - Number; - Date; - Phone; - Time
PostNotificationTemplateResponse.Error.IncorrectTagFormatError¶
Некорректный формат Mustache тегов
PostNotificationTemplateResponse.Error.IncorrectVariableNameError¶
Некорректное наименование переменной в шаблоне
PutNotificationTemplatePartnerAttachRequest¶
Запрос создания связи шаблона уведомления и партнера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| notification_template_partner | Связь шаблона уведомления и партнера | keyapis.multiapp.v1.NotificationTemplatePartner | REQUIRED |
PutNotificationTemplatePartnerAttachResponse¶
Ответ на запрос создания связи шаблона уведомления и партнера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.multiapp.v1.PutNotificationTemplatePartnerAttachResponse.Error |
PutNotificationTemplatePartnerAttachResponse.Error¶
Ошибка запроса на создание шаблона уведомления и партнера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.multiapp.v1.ValidationError | |
| saving | Ошибка сохранения | optional keyapis.multiapp.v1.NotificationTemplatePartner.SavingError |
PutNotificationTemplatePartnerDetachRequest¶
Запрос удаления связи шаблона уведомления и партнера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| notification_template_partner | Связь шаблона уведомления и партнера | keyapis.multiapp.v1.NotificationTemplatePartner | REQUIRED |
PutNotificationTemplatePartnerDetachResponse¶
Ответ на запрос удаление связи шаблона уведомления и партнера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.multiapp.v1.PutNotificationTemplatePartnerDetachResponse.Error |
PutNotificationTemplatePartnerDetachResponse.Error¶
Ошибка запроса на удаление шаблона уведомления и партнера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.multiapp.v1.ValidationError |
NotificationTemplatePaging.DirectionType¶
Справочник типов направлений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
NotificationTemplatePaging.OrderByType¶
Справочник типов значений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | CHANGED_AT | Дата последнего изменения |
| 2 | CREATED_AT | Дата создания |
| 3 | RANK | По рангу для поиска по тексту. Применяется когда передано поле для поиска по тексту. В случае если текстовое поле не передано, применяется значение по умолчанию |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| uint32 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| sfixed32 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |