/* Сервис реализует функционал управления уведомлениями */ 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/bell/v1/keyapis_bell_common_v1.proto"; package keyapis.bell.v1; option java_package = "ru.keyapis.bell.v1"; option java_outer_classname = "KeyapisBellV1Proto"; option java_multiple_files = false; option java_string_check_utf8 = true; option go_package = "/keyapis_bell_v1"; option cc_enable_arenas = true; option csharp_namespace = "Keyapis.Bell.V1"; option objc_class_prefix = "KEYAPISBELLV1"; option php_namespace = "Keyapis\\Bell\\V1"; option ruby_package = "Keyapis::Bell::V1"; option optimize_for = LITE_RUNTIME; // Сервис уведомлений service NotificationService { // Метод сохранения уведомления. // Поддерживает только создание. // Метод доступен для: service rpc PostNotification(PostNotificationRequest) returns (PostNotificationResponse) { option (google.api.http) = { post: "/bell/api/v1/notification" body: "*" }; } // Метод получения уведомления. // Метод доступен для: admin, manager, master, slave, service rpc GetNotification(GetNotificationRequest) returns (GetNotificationResponse) { option (google.api.http) = { get: "/bell/api/v1/notification/{id}" }; } // Метод получения списка уведомлений. // Метод доступен для: admin, manager, master, slave, service rpc GetNotificationList(GetNotificationListRequest) returns (stream GetNotificationListResponse) { option (google.api.http) = { get: "/bell/api/v1/notification/list" }; } // Метод получения количества уведомлений. // Метод доступен для: admin, manager, master, slave, service rpc GetNotificationCount(GetNotificationCountRequest) returns (GetNotificationCountResponse) { option (google.api.http) = { get: "/bell/api/v1/notification/count" }; } // Метод изменения статуса уведомления на "Просмотрено". // Метод доступен для: master, slave, service rpc PostNotificationView(PostNotificationViewRequest) returns (PostNotificationViewResponse) { option (google.api.http) = { post: "/bell/api/v1/notification/{id}/view" }; } // Метод изменения статуса уведомлений на "Просмотрено" по ОРПОНу и номеру квартиры. // Метод доступен для: master, slave, service rpc PostNotificationViewOrponRoomNumber(PostNotificationViewOrponRoomNumberRequest) returns (PostNotificationViewOrponRoomNumberResponse) { option (google.api.http) = { post: "/bell/api/v1/notification/view/orpon/{orpon}/room_number/{room_number}" }; } } // Уведомление. // # Описание модели message Notification { // Идентификатор. // Создаётся сервером. // # Тип: Guid string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // ОРПОН. // # Диапазон 1..9223372036854775807 int64 orpon = 2 [(google.api.field_behavior) = REQUIRED]; // Наименование приложения-отправителя. // # Диапазон: 3..256 google.protobuf.StringValue app_title = 3; // Номер квартиры. // # Диапазон: 1..4 string room_number = 4 [(google.api.field_behavior) = REQUIRED]; // Заголовок. // # Диапазон: 3..128 string header = 5 [(google.api.field_behavior) = REQUIRED]; // Тело. // # Диапазон: 3..256 string text = 6 [(google.api.field_behavior) = REQUIRED]; // Статус enum StatusType { // Значение не указано STATUS_TYPE_UNKNOWN = 0; // Новый. // Устанавливается по умолчанию NEW = 1; // Доставлен DELIVERED = 2; // Просмотрен VIEWED = 3; } // Статус StatusType status_type = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата создания. // # Тип: DateTime google.protobuf.Timestamp created_at = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата последнего изменения статуса. // Заполняется и обновляется сервером. // # Тип: DateTime google.protobuf.Timestamp status_changed_at = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; // Полезная нагрузка map payload = 10; } // Запрос сохранения уведомления message PostNotificationRequest { // Уведомление Notification data = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос сохранения уведомления message PostNotificationResponse { // Ошибка сохранения уведомления message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Уведомление Notification data = 1; // Ошибка Error error = 2; } } // Запрос получения уведомления message GetNotificationRequest { // Идентификатор уведомления. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос на получение уведомления message GetNotificationResponse { // Ошибка запроса на получение уведомления message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Уведомление Notification data = 1; // Ошибка Error error = 2; } } // Запрос получения списка уведомлений message GetNotificationListRequest { // Фильтр NotificationFilter filter = 1; // Вариант разбиения на страницы oneof pagination { // Стандартный постраничный вывод NotificationPaging paging = 2; } } // Ответ на запрос на получение списка уведомлений message GetNotificationListResponse { // Ошибка запроса на получение списка уведомлений message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Уведомление Notification data = 1; // Ошибка Error error = 2; } } // Запрос получения количества уведомлений message GetNotificationCountRequest { // Фильтр NotificationFilter filter = 1; } // Ответ на запрос на получение количества уведомлений message GetNotificationCountResponse { // Ошибка запроса на получение количества уведомлений message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Количество уведомлений int32 data = 1; // Ошибка Error error = 2; } } // Запрос на изменение статуса уведомления на "Просмотрено" уведомления message PostNotificationViewRequest { // Идентификатор уведомления. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на изменение статуса уведомления на "Просмотрено" уведомления message PostNotificationViewResponse { // Ошибка message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Ошибка Error error = 1; } } // Фильтр уведомлений message NotificationFilter { // По ОРПОН repeated int64 orpons = 1; // По номерам квартир repeated string room_numbers = 2; // По статусам repeated Notification.StatusType status_types = 3; } // Постраничный вывод message NotificationPaging { // Справочник типов значений сортировки. // # Тип: byte enum OrderByType { // Значение не указано ORDER_BY_TYPE_UNKNOWN = 0; // По дате создания CREATED_AT = 1; // По дате последнего изменения статуса STATUS_CHANGED_AT = 2; } // Тип значения сортировки. // Если значение не передано, то будет взято значение по умолчанию. // # По умолчанию: CREATED_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; } // Запрос на изменение статуса уведомлений на "Просмотрено" по ОРПОНу и номеру квартиры message PostNotificationViewOrponRoomNumberRequest { // ОРПОН. // # Диапазон: 1..9223372036854775807 int64 orpon = 1 [(google.api.field_behavior) = REQUIRED]; // Номер квартиры. // # Диапазон: 1..4 string room_number = 2 [(google.api.field_behavior) = REQUIRED]; } // Ответ на изменение статуса уведомлений на "Просмотрено" по ОРПОНу и номеру квартиры message PostNotificationViewOrponRoomNumberResponse { // Ошибка message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Количество изменённых уведомлений int32 data = 1; // Ошибка Error error = 2; } }