/* Сервис реализует функционал управления точками продаж. Точки проджаж используются как точки дистрибьюции ключей */ syntax = "proto3"; import "google/api/annotations.proto"; import "google/api/field_behavior.proto"; import "google/protobuf/descriptor.proto"; import "google/protobuf/wrappers.proto"; import "google/protobuf/timestamp.proto"; package keyapis.ad.v1; option java_package = "ru.keyapis.ad.v1"; option java_outer_classname = "KeyapisAdV1Proto"; option java_multiple_files = false; option java_string_check_utf8 = true; option go_package = "/keyapis_ad_v1"; option cc_enable_arenas = true; option csharp_namespace = "Keyapis.Ad.V1"; option objc_class_prefix = "KEYAPISADV1"; option php_namespace = "Keyapis\\Ad\\V1"; option ruby_package = "Keyapis::Ad::V1"; option optimize_for = LITE_RUNTIME; // Сервис точек продаж service SalepointService { // Метод сохранения точки продаж. // Поддерживает создание и обновление. // Метод доступен для: manager, service, application(ad:edit) rpc PostSalepoint(PostSalepointRequest) returns (PostSalepointResponse) { option (google.api.http) = { post: "/ad/api/v1/salepoint" body: "*" }; } // Метод получения точки продаж. // Не требует авторизации rpc GetSalepoint(GetSalepointRequest) returns (GetSalepointResponse) { option (google.api.http) = { get: "/ad/api/v1/salepoint/{id}" }; } // Метод получения списка точек продаж. // Не требует авторизации rpc GetSalepointList(GetSalepointListRequest) returns (stream GetSalepointListResponse) { option (google.api.http) = { get: "/ad/api/v1/salepoint/list" }; } // Метод получения количества точек продаж. // Не требует авторизации rpc GetSalepointCount(GetSalepointCountRequest) returns (GetSalepointCountResponse) { option (google.api.http) = { get: "/ad/api/v1/salepoint/count" }; } } // Точка продаж message Salepoint { // Идентификатор int32 id = 1; // Название string title = 2 [(google.api.field_behavior) = REQUIRED]; // Справочник типов точек продаж enum Type { // Значение не указано TYPE_UNKNOWN = 0; // Теле2 TELE2 = 1; // Почта россии POCHTA_ROSSII = 2; // Перекресток PEREKRESTOK = 3; // Пятерочка PYATEROCHKA = 4; // Другая ANOTHER = 5; // Мегафон MEGAFON = 6; } // Тип точки продаж Type type = 3 [(google.api.field_behavior) = REQUIRED]; // Описание google.protobuf.StringValue description = 4; // Адрес string address = 5 [(google.api.field_behavior) = REQUIRED]; // Местонахождение message Location { // Широта float latitude = 1 [(google.api.field_behavior) = REQUIRED]; // Долгота float longitude = 2 [(google.api.field_behavior) = REQUIRED]; } // Местонахождение Location location = 6 [(google.api.field_behavior) = REQUIRED]; // Рабочее время message Worktime { // Справочник дней enum DayType { // Значение не указано DAY_TYPE_UNKNOWN = 0; // Понедельник MONDAY = 1; // Вторник TUESDAY = 2; // Среда WEDNESDAY = 3; // Четверг THURSDAY = 4; // Пятница FRIDAY = 5; // Суббота SATURDAY = 6; // Воскресенье SUNDAY = 7; } // День недели DayType day_type = 1 [(google.api.field_behavior) = REQUIRED]; // Время открытия string opened_at = 2 [(google.api.field_behavior) = REQUIRED]; // Время закрытия string closed_at = 3 [(google.api.field_behavior) = REQUIRED]; } // Рабочее время repeated Worktime worktimes = 7 [(google.api.field_behavior) = REQUIRED]; // Номер телефона google.protobuf.StringValue phone_number = 8; // Ссылка на сайт string site_url = 9 [(google.api.field_behavior) = REQUIRED]; // Дата создания google.protobuf.Timestamp created_at = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата последнего изменения. // Заполняется и обновляется сервером. // Заполняется при создании и изменении. // Является версией объекта google.protobuf.Timestamp changed_at = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата архивации google.protobuf.Timestamp archieved_at = 12; } // Фильтр точек продаж message SalepointFilter { // По тексту. // Если значение не передано то поиск по нему не производится. // # Поиск производится по полям: // # - Название google.protobuf.StringValue text = 1; // Местонахождение message Location { // По широте float latitude = 1; // По долготе float longitude = 2; } // По местонахождению. // Игнорируется если дистанция не передана Location location = 2; // По дистанции. // Игнорируется если местонахождение не передано google.protobuf.FloatValue distance = 3; // По архивированым google.protobuf.BoolValue is_archieved = 4; } // Пагинация по точекам продаж message SalepointPaging { // Справочник типов значений сортировки enum OrderByType { // Значение не указано ORDER_BY_TYPE_UNKNOWN = 0; // По идентификатору ID = 1; // По дистанции DISTANCE = 2; // По рангу близости. // При поиске по тексту RANK_CD = 3; } // Тип значения сортировки. // По умолчанию: ORDER_BY_TYPE_ID OrderByType order_by_type = 1; // Справочник типов направлений сортировки enum DirectionType { // Значение не указано DIRECTION_TYPE_UNKNOWN = 0; // От большего к меньшему DESC = 1; // От меньшего к большему ASC = 2; } // Тип направления сортировки. // По умолчанию: DESC DirectionType direction_type = 2; // Количество записей на страницу. // Минимальное значение: 1. // Максимальное значение: 100. // По умолчанию: 20. // Если значение 0 (не передано), то выставляем значение по умолчанию int32 limit = 3; // Сдвиг. // По умолчанию: 0 int32 offset = 4; } // Запрос сохранения точки продаж message PostSalepointRequest { // Точка продаж Salepoint data = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос сохранения точки продаж message PostSalepointResponse { // Тип результата oneof type { // Точка продаж Salepoint data = 1; } } // Запрос получения точки продаж message GetSalepointRequest { // Идентификатор точки продаж int32 id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос получения точки продаж message GetSalepointResponse { // Тип результата oneof type { // Точка продаж Salepoint data = 1; } } // Запрос получения списка точек продаж message GetSalepointListRequest { // Фильтр SalepointFilter filter = 1; // Вариант разбиения на страницы oneof pagination { // Пагинация SalepointPaging paging = 2; } } // Ответ на запрос получения списка точек продаж message GetSalepointListResponse { // Тип результата oneof type { // Точка продаж Salepoint data = 1; } } // Запрос получения количества точек продаж message GetSalepointCountRequest { // Фильтр SalepointFilter filter = 1; } // Ответ на запрос получения количества точек продаж message GetSalepointCountResponse { // Тип результата oneof type { // Всего точек продаж int32 data = 1; } }