# Протокол

## Оглавление

- [keyapis/subscription/v1/keyapis_subscription_privilege_v1.proto](#keyapis_subscription_v1_keyapis_subscription_privilege_v1-proto)
    - [PrivilegeService](#keyapis-subscription-v1-PrivilegeService)
  
    - [GetPrivilegeCheckRequest](#keyapis-subscription-v1-GetPrivilegeCheckRequest)
    - [GetPrivilegeCheckResponse](#keyapis-subscription-v1-GetPrivilegeCheckResponse)
    - [GetPrivilegeCountRequest](#keyapis-subscription-v1-GetPrivilegeCountRequest)
    - [GetPrivilegeCountResponse](#keyapis-subscription-v1-GetPrivilegeCountResponse)
    - [GetPrivilegeCountResponse.Error](#keyapis-subscription-v1-GetPrivilegeCountResponse-Error)
    - [GetPrivilegeListRequest](#keyapis-subscription-v1-GetPrivilegeListRequest)
    - [GetPrivilegeListResponse](#keyapis-subscription-v1-GetPrivilegeListResponse)
    - [GetPrivilegeListResponse.Error](#keyapis-subscription-v1-GetPrivilegeListResponse-Error)
    - [Privilege](#keyapis-subscription-v1-Privilege)
    - [PrivilegeFilter](#keyapis-subscription-v1-PrivilegeFilter)
    - [PrivilegeFilter.ValidationError](#keyapis-subscription-v1-PrivilegeFilter-ValidationError)
    - [PrivilegeFilter.ValidationError.FlatNumbersInvalid](#keyapis-subscription-v1-PrivilegeFilter-ValidationError-FlatNumbersInvalid)
    - [PrivilegeFilter.ValidationError.OrponsInvalid](#keyapis-subscription-v1-PrivilegeFilter-ValidationError-OrponsInvalid)
    - [PrivilegePaging](#keyapis-subscription-v1-PrivilegePaging)
    - [PrivilegePaging.ValidationError](#keyapis-subscription-v1-PrivilegePaging-ValidationError)
    - [PrivilegePaging.ValidationError.LimitInvalid](#keyapis-subscription-v1-PrivilegePaging-ValidationError-LimitInvalid)
    - [PrivilegePaging.ValidationError.OffsetInvalid](#keyapis-subscription-v1-PrivilegePaging-ValidationError-OffsetInvalid)
  
    - [Privilege.StateType](#keyapis-subscription-v1-Privilege-StateType)
    - [Privilege.Type](#keyapis-subscription-v1-Privilege-Type)
    - [PrivilegePaging.DirectionType](#keyapis-subscription-v1-PrivilegePaging-DirectionType)
    - [PrivilegePaging.OrderByType](#keyapis-subscription-v1-PrivilegePaging-OrderByType)
  


## [Схема классов](/svg/protos/key/keyapis/subscription/v1/keyapis_subscription_privilege_v1.proto.svg)
<a href="/svg/protos/key/keyapis/subscription/v1/keyapis_subscription_privilege_v1.proto.svg"><img src="/svg/protos/key/keyapis/subscription/v1/keyapis_subscription_privilege_v1.proto.svg" alt="/svg/protos/key/keyapis/subscription/v1/keyapis_subscription_privilege_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_subscription_v1_keyapis_subscription_privilege_v1-proto"></a>

## [keyapis/subscription/v1/keyapis_subscription_privilege_v1.proto](/protos/key/keyapis/subscription/v1/keyapis_subscription_privilege_v1.proto)
Сервис реализует функционал управления привилегиями.
Привилегии это услуги на квартиру со статусами, в их число входят привилегии которые можно подключить, но ещё не приобретены


<a name="keyapis-subscription-v1-PrivilegeService"></a>

### PrivilegeService
 Сервис привилегий

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-subscription-v1-GetPrivilegeList"></a> [GetPrivilegeList](#keyapis-subscription-v1-GetPrivilegeList) | Метод получения привилегий. Метод доступен для: admin, master, service, ltp_first, application(subscription:read или subscription:edit) | [keyapis.subscription.v1.GetPrivilegeListRequest](#keyapis-subscription-v1-GetPrivilegeListRequest) | [keyapis.subscription.v1.GetPrivilegeListResponse](#keyapis-subscription-v1-GetPrivilegeListResponse) stream |
| <a id="keyapis-subscription-v1-GetPrivilegeCount"></a> [GetPrivilegeCount](#keyapis-subscription-v1-GetPrivilegeCount) | Метод получения количества привилегий. Метод доступен для: admin, master, service, ltp_first, application(subscription:read или subscription:edit) | [keyapis.subscription.v1.GetPrivilegeCountRequest](#keyapis-subscription-v1-GetPrivilegeCountRequest) | [keyapis.subscription.v1.GetPrivilegeCountResponse](#keyapis-subscription-v1-GetPrivilegeCountResponse) |
| <a id="keyapis-subscription-v1-GetPrivilegeCheck"></a> [GetPrivilegeCheck](#keyapis-subscription-v1-GetPrivilegeCheck) | Метод проверки привилегии. Метод доступен для: admin, master, service, ltp_first, application(subscription:read или subscription:edit) | [keyapis.subscription.v1.GetPrivilegeCheckRequest](#keyapis-subscription-v1-GetPrivilegeCheckRequest) | [keyapis.subscription.v1.GetPrivilegeCheckResponse](#keyapis-subscription-v1-GetPrivilegeCheckResponse) |

 <!-- end services -->


<a name="keyapis-subscription-v1-GetPrivilegeCheckRequest"></a>


### [GetPrivilegeCheckRequest](#keyapis-subscription-v1-GetPrivilegeCheckRequest)
 Запрос проверки предоставленной привилегии


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetPrivilegeCheckRequest-orpon"></a> [orpon](#keyapis-subscription-v1-GetPrivilegeCheckRequest-orpon) | ОРПОН. Идентификатор дома |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-GetPrivilegeCheckRequest-flat_number"></a> [flat_number](#keyapis-subscription-v1-GetPrivilegeCheckRequest-flat_number) | Номер квартиры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-GetPrivilegeCheckRequest-privilege_type"></a> [privilege_type](#keyapis-subscription-v1-GetPrivilegeCheckRequest-privilege_type) | Тип привилегии |    [keyapis.subscription.v1.Privilege.Type](#keyapis-subscription-v1-Privilege-Type) | REQUIRED|






<a name="keyapis-subscription-v1-GetPrivilegeCheckResponse"></a>


### [GetPrivilegeCheckResponse](#keyapis-subscription-v1-GetPrivilegeCheckResponse)
 Результат запроса метода проверки предоставленной привилегии


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetPrivilegeCheckResponse-data"></a> [data](#keyapis-subscription-v1-GetPrivilegeCheckResponse-data) | Доступна ли привилегия на квартире. Вернётся true если статусы: - PROMO; - PAID; - TURNS_OFF. Вернётся false если статусы: - NOT_PAID; - CAN_BE_PAID; - STATE_TYPE_UNKNOWN; - Не найден |  optional  [bool](#scalar-types) | <nil>|






<a name="keyapis-subscription-v1-GetPrivilegeCountRequest"></a>


### [GetPrivilegeCountRequest](#keyapis-subscription-v1-GetPrivilegeCountRequest)
 Запрос получения количества привилегий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetPrivilegeCountRequest-filter"></a> [filter](#keyapis-subscription-v1-GetPrivilegeCountRequest-filter) | Фильтр |    [keyapis.subscription.v1.PrivilegeFilter](#keyapis-subscription-v1-PrivilegeFilter) | <nil>|






<a name="keyapis-subscription-v1-GetPrivilegeCountResponse"></a>


### [GetPrivilegeCountResponse](#keyapis-subscription-v1-GetPrivilegeCountResponse)
 Ответ на запрос получения количества привилегий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetPrivilegeCountResponse-data"></a> [data](#keyapis-subscription-v1-GetPrivilegeCountResponse-data) | Всего привилегий |  optional  [int32](#scalar-types) | <nil>|
| <a id="keyapis-subscription-v1-GetPrivilegeCountResponse-error"></a> [error](#keyapis-subscription-v1-GetPrivilegeCountResponse-error) | Ошибка |  optional  [keyapis.subscription.v1.GetPrivilegeCountResponse.Error](#keyapis-subscription-v1-GetPrivilegeCountResponse-Error) | <nil>|






<a name="keyapis-subscription-v1-GetPrivilegeCountResponse-Error"></a>


### [GetPrivilegeCountResponse.Error](#keyapis-subscription-v1-GetPrivilegeCountResponse-Error)
 Ошибка запроса получения количества привилегий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetPrivilegeCountResponse-Error-privilege_filter_validation"></a> [privilege_filter_validation](#keyapis-subscription-v1-GetPrivilegeCountResponse-Error-privilege_filter_validation) | Ошибка фильтрации по страницам по привилегиям |  optional  [keyapis.subscription.v1.PrivilegeFilter.ValidationError](#keyapis-subscription-v1-PrivilegeFilter-ValidationError) | <nil>|






<a name="keyapis-subscription-v1-GetPrivilegeListRequest"></a>


### [GetPrivilegeListRequest](#keyapis-subscription-v1-GetPrivilegeListRequest)
 Запрос получения привилегий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetPrivilegeListRequest-filter"></a> [filter](#keyapis-subscription-v1-GetPrivilegeListRequest-filter) | Фильтр |    [keyapis.subscription.v1.PrivilegeFilter](#keyapis-subscription-v1-PrivilegeFilter) | <nil>|
| <a id="keyapis-subscription-v1-GetPrivilegeListRequest-paging"></a> [paging](#keyapis-subscription-v1-GetPrivilegeListRequest-paging) | Пагинация |  optional  [keyapis.subscription.v1.PrivilegePaging](#keyapis-subscription-v1-PrivilegePaging) | <nil>|






<a name="keyapis-subscription-v1-GetPrivilegeListResponse"></a>


### [GetPrivilegeListResponse](#keyapis-subscription-v1-GetPrivilegeListResponse)
 Ответ на запрос получения привилегий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetPrivilegeListResponse-data"></a> [data](#keyapis-subscription-v1-GetPrivilegeListResponse-data) | Предоставленная привилегия |  optional  [keyapis.subscription.v1.Privilege](#keyapis-subscription-v1-Privilege) | <nil>|
| <a id="keyapis-subscription-v1-GetPrivilegeListResponse-error"></a> [error](#keyapis-subscription-v1-GetPrivilegeListResponse-error) | Ошибка |  optional  [keyapis.subscription.v1.GetPrivilegeListResponse.Error](#keyapis-subscription-v1-GetPrivilegeListResponse-Error) | <nil>|






<a name="keyapis-subscription-v1-GetPrivilegeListResponse-Error"></a>


### [GetPrivilegeListResponse.Error](#keyapis-subscription-v1-GetPrivilegeListResponse-Error)
 Ошибка запроса получения привилегий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetPrivilegeListResponse-Error-privilege_filter_validation"></a> [privilege_filter_validation](#keyapis-subscription-v1-GetPrivilegeListResponse-Error-privilege_filter_validation) | Ошибка фильтрации по страницам |  optional  [keyapis.subscription.v1.PrivilegeFilter.ValidationError](#keyapis-subscription-v1-PrivilegeFilter-ValidationError) | <nil>|
| <a id="keyapis-subscription-v1-GetPrivilegeListResponse-Error-privilege_paging_validation"></a> [privilege_paging_validation](#keyapis-subscription-v1-GetPrivilegeListResponse-Error-privilege_paging_validation) | Ошибка пагинации по страницам |  optional  [keyapis.subscription.v1.PrivilegePaging.ValidationError](#keyapis-subscription-v1-PrivilegePaging-ValidationError) | <nil>|






<a name="keyapis-subscription-v1-Privilege"></a>


### [Privilege](#keyapis-subscription-v1-Privilege)
 Привилегия


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-Privilege-orpon"></a> [orpon](#keyapis-subscription-v1-Privilege-orpon) | ОРПОН. Идентификатор дома. Уникальный ключ: поля в порядке 1,2,3 |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-Privilege-flat_number"></a> [flat_number](#keyapis-subscription-v1-Privilege-flat_number) | Номер квартиры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-Privilege-type"></a> [type](#keyapis-subscription-v1-Privilege-type) | Тип привилегии |    [keyapis.subscription.v1.Privilege.Type](#keyapis-subscription-v1-Privilege-Type) | REQUIRED|
| <a id="keyapis-subscription-v1-Privilege-state_type"></a> [state_type](#keyapis-subscription-v1-Privilege-state_type) | Состояние привилегии |    [keyapis.subscription.v1.Privilege.StateType](#keyapis-subscription-v1-Privilege-StateType) | REQUIRED|






<a name="keyapis-subscription-v1-PrivilegeFilter"></a>


### [PrivilegeFilter](#keyapis-subscription-v1-PrivilegeFilter)
 Фильтр по привилегиям


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-PrivilegeFilter-orpons"></a> [orpons](#keyapis-subscription-v1-PrivilegeFilter-orpons) | По ОРПОНам |  repeated  [int64](#scalar-types) | <nil>|
| <a id="keyapis-subscription-v1-PrivilegeFilter-flat_numbers"></a> [flat_numbers](#keyapis-subscription-v1-PrivilegeFilter-flat_numbers) | Номера квартир |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-subscription-v1-PrivilegeFilter-types"></a> [types](#keyapis-subscription-v1-PrivilegeFilter-types) | По типам привилегий |  repeated  [keyapis.subscription.v1.Privilege.Type](#keyapis-subscription-v1-Privilege-Type) | <nil>|
| <a id="keyapis-subscription-v1-PrivilegeFilter-state_types"></a> [state_types](#keyapis-subscription-v1-PrivilegeFilter-state_types) | По состояниям привилегий |  repeated  [keyapis.subscription.v1.Privilege.StateType](#keyapis-subscription-v1-Privilege-StateType) | <nil>|






<a name="keyapis-subscription-v1-PrivilegeFilter-ValidationError"></a>


### [PrivilegeFilter.ValidationError](#keyapis-subscription-v1-PrivilegeFilter-ValidationError)
 Ошибка валидации фильтра по привилегиям.
Эти проверки выполняются до обращения в базу данных


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-PrivilegeFilter-ValidationError-orpons"></a> [orpons](#keyapis-subscription-v1-PrivilegeFilter-ValidationError-orpons) | Формат ОРПОН некорректен |  optional  [keyapis.subscription.v1.PrivilegeFilter.ValidationError.OrponsInvalid](#keyapis-subscription-v1-PrivilegeFilter-ValidationError-OrponsInvalid) | <nil>|
| <a id="keyapis-subscription-v1-PrivilegeFilter-ValidationError-flat_numbers"></a> [flat_numbers](#keyapis-subscription-v1-PrivilegeFilter-ValidationError-flat_numbers) | Формат квартиры некорректен |  optional  [keyapis.subscription.v1.PrivilegeFilter.ValidationError.FlatNumbersInvalid](#keyapis-subscription-v1-PrivilegeFilter-ValidationError-FlatNumbersInvalid) | <nil>|






<a name="keyapis-subscription-v1-PrivilegeFilter-ValidationError-FlatNumbersInvalid"></a>


### [PrivilegeFilter.ValidationError.FlatNumbersInvalid](#keyapis-subscription-v1-PrivilegeFilter-ValidationError-FlatNumbersInvalid)
 Причины:
- Формат квартиры некорректен (например, длина номера квартира более 4 знаков);
- Номер квартиры содержит буквы






<a name="keyapis-subscription-v1-PrivilegeFilter-ValidationError-OrponsInvalid"></a>


### [PrivilegeFilter.ValidationError.OrponsInvalid](#keyapis-subscription-v1-PrivilegeFilter-ValidationError-OrponsInvalid)
 Причины:
- Формат ОРПОН некорректен;
- Передано отрицательное значение






<a name="keyapis-subscription-v1-PrivilegePaging"></a>


### [PrivilegePaging](#keyapis-subscription-v1-PrivilegePaging)
 Пагинация по привилегиям


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-PrivilegePaging-order_by_type"></a> [order_by_type](#keyapis-subscription-v1-PrivilegePaging-order_by_type) | Тип значения сортировки. По умолчанию: KEY |    [keyapis.subscription.v1.PrivilegePaging.OrderByType](#keyapis-subscription-v1-PrivilegePaging-OrderByType) | <nil>|
| <a id="keyapis-subscription-v1-PrivilegePaging-direction_type"></a> [direction_type](#keyapis-subscription-v1-PrivilegePaging-direction_type) | Тип направления сортировки. По умолчанию: DESC |    [keyapis.subscription.v1.PrivilegePaging.DirectionType](#keyapis-subscription-v1-PrivilegePaging-DirectionType) | <nil>|
| <a id="keyapis-subscription-v1-PrivilegePaging-limit"></a> [limit](#keyapis-subscription-v1-PrivilegePaging-limit) | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-subscription-v1-PrivilegePaging-offset"></a> [offset](#keyapis-subscription-v1-PrivilegePaging-offset) | Сдвиг. По умолчанию: 0 |    [int32](#scalar-types) | <nil>|






<a name="keyapis-subscription-v1-PrivilegePaging-ValidationError"></a>


### [PrivilegePaging.ValidationError](#keyapis-subscription-v1-PrivilegePaging-ValidationError)
 Ошибка валидации постраничной пагинации по привилегиям.
Эти проверки выполняются до обращения в базу данных


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-PrivilegePaging-ValidationError-limit"></a> [limit](#keyapis-subscription-v1-PrivilegePaging-ValidationError-limit) | Количество передано некорректно |  optional  [keyapis.subscription.v1.PrivilegePaging.ValidationError.LimitInvalid](#keyapis-subscription-v1-PrivilegePaging-ValidationError-LimitInvalid) | <nil>|
| <a id="keyapis-subscription-v1-PrivilegePaging-ValidationError-offset"></a> [offset](#keyapis-subscription-v1-PrivilegePaging-ValidationError-offset) | Сдвиг передан некорректно |  optional  [keyapis.subscription.v1.PrivilegePaging.ValidationError.OffsetInvalid](#keyapis-subscription-v1-PrivilegePaging-ValidationError-OffsetInvalid) | <nil>|






<a name="keyapis-subscription-v1-PrivilegePaging-ValidationError-LimitInvalid"></a>


### [PrivilegePaging.ValidationError.LimitInvalid](#keyapis-subscription-v1-PrivilegePaging-ValidationError-LimitInvalid)
 Причины:
- Значение количества < 0 или > 100






<a name="keyapis-subscription-v1-PrivilegePaging-ValidationError-OffsetInvalid"></a>


### [PrivilegePaging.ValidationError.OffsetInvalid](#keyapis-subscription-v1-PrivilegePaging-ValidationError-OffsetInvalid)
 Причины:
- Значение сдвига < 0





 <!-- end messages -->



<a name="keyapis-subscription-v1-Privilege-StateType"></a>

### [Privilege.StateType](#keyapis-subscription-v1-Privilege-StateType)
 Типы состояний привилегий

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-subscription-v1-Privilege-StateType-STATE_TYPE_UNKNOWN"></a> [STATE_TYPE_UNKNOWN](#keyapis-subscription-v1-Privilege-StateType-STATE_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-subscription-v1-Privilege-StateType-CAN_BE_PAID"></a> [CAN_BE_PAID](#keyapis-subscription-v1-Privilege-StateType-CAN_BE_PAID) | Услуга доступная для подключения на доме пользователя, но не активна. Услуга есть в доступных КВ на ОРПОН, но её нет у пользователя |
| 2 | <a id="keyapis-subscription-v1-Privilege-StateType-NOT_PAID"></a> [NOT_PAID](#keyapis-subscription-v1-Privilege-StateType-NOT_PAID) | Услуга не оплачена и не активна. Услуга есть в подписке в статусе: BLOCKED |
| 3 | <a id="keyapis-subscription-v1-Privilege-StateType-TURNS_OFF"></a> [TURNS_OFF](#keyapis-subscription-v1-Privilege-StateType-TURNS_OFF) | Услуга отключается, но ещё активна. Услуга есть в подписке в статусе: SCHEDULED_CANCELED |
| 4 | <a id="keyapis-subscription-v1-Privilege-StateType-PROMO"></a> [PROMO](#keyapis-subscription-v1-Privilege-StateType-PROMO) | Услуга в промо-периоде и активна. Услуга есть в подписке в статусе: SETUP. Обычно так создают промоподписки |
| 5 | <a id="keyapis-subscription-v1-Privilege-StateType-PAID"></a> [PAID](#keyapis-subscription-v1-Privilege-StateType-PAID) | Услуга оплачена и активна. Услуга есть в подписке в статусе: ACTIVE. Либо услуга есть в подписке с неблокируемой услугой |




<a name="keyapis-subscription-v1-Privilege-Type"></a>

### [Privilege.Type](#keyapis-subscription-v1-Privilege-Type)
 Типы привилегий

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-subscription-v1-Privilege-Type-TYPE_UNKNOWN"></a> [TYPE_UNKNOWN](#keyapis-subscription-v1-Privilege-Type-TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_USE"></a> [INTERCOM_USE](#keyapis-subscription-v1-Privilege-Type-INTERCOM_USE) | Умный домофон. Базовые функции. Право доступа к разделу с домофонами и калиткаи. Действие. Закрывает услуги: get_devices_intercom |
| 2 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_OPEN"></a> [INTERCOM_OPEN](#keyapis-subscription-v1-Privilege-Type-INTERCOM_OPEN) | Умный домофон. Базовые функции. Право использовать функционал открытия двери домофона и калитки. Действие. Закрывает услуги: post_devices_open_intercom |
| 3 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_CODE_USE"></a> [INTERCOM_CODE_USE](#keyapis-subscription-v1-Privilege-Type-INTERCOM_CODE_USE) | Умный домофон. Коды. Право использовать функционал кодов домофонов и калиток. Действие. Закрывает услуги: get_devices_codes_intercom, post_devices_codes_intercom, delete_devices_codes_intercom |
| 4 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_RFID_USE"></a> [INTERCOM_RFID_USE](#keyapis-subscription-v1-Privilege-Type-INTERCOM_RFID_USE) | Умный домофон. Ключи. Право использовать функционал физических ключей домофонов и калиток. Действие. Закрывает услуги: get_devices_rfids_intercom, post_devices_rfids_barrier, delete_devices_rfids_barrier |
| 5 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_EVENT_USE"></a> [INTERCOM_EVENT_USE](#keyapis-subscription-v1-Privilege-Type-INTERCOM_EVENT_USE) | Умный домофон. События. Право использовать функционал журнала событий домофонов и калиток. Действие. Закрывает услуги: get_events_intercom |
| 6 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_CAMERA_USE"></a> [INTERCOM_CAMERA_USE](#keyapis-subscription-v1-Privilege-Type-INTERCOM_CAMERA_USE) | Умный домофон. Камеры. Право использовать функционал просмотра камер и лайв видео с домофонов и калиток. Действие. Закрывает услуги: get_devices_camera_intercom |
| 7 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_CAMERA_ARCHIVE"></a> [INTERCOM_CAMERA_ARCHIVE](#keyapis-subscription-v1-Privilege-Type-INTERCOM_CAMERA_ARCHIVE) | Умный домофон. Камеры. Право использовать функционал архива видео с камер домофонов и калиток. Действие. Закрывает услуги: get_video_archive_intercom |
| 8 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_CALLREDIRECT_APP"></a> [INTERCOM_CALLREDIRECT_APP](#keyapis-subscription-v1-Privilege-Type-INTERCOM_CALLREDIRECT_APP) | Умный домофон. Переадресация. Право перенаправления входящих вызова от домофона в приложения, используется только на сервере. Поведение. Закрывает услуги: devices_call_redirect_to_mobile_app_behavior |
| 9 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_CALLREDIRECT_PSTN"></a> [INTERCOM_CALLREDIRECT_PSTN](#keyapis-subscription-v1-Privilege-Type-INTERCOM_CALLREDIRECT_PSTN) | Умный домофон. Переадресация. Право перенаправление входящих вызовов от домофона на номера ТФОП, используется только на сервере. Поведение. Закрывает услуги: devices_call_redirect_to_pstn_behavior |
| 10 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_CALLREDIRECT_SIP"></a> [INTERCOM_CALLREDIRECT_SIP](#keyapis-subscription-v1-Privilege-Type-INTERCOM_CALLREDIRECT_SIP) | Умный домофон. Переадресация. Право перенаправление входящих вызовов от домофона на номера SIP, используется только на сервере. Поведение. Закрывает услуги: devices_call_redirect_to_sip_behavior |
| 11 | <a id="keyapis-subscription-v1-Privilege-Type-BARRIER_USE"></a> [BARRIER_USE](#keyapis-subscription-v1-Privilege-Type-BARRIER_USE) | Умный шлагбаум. Базовые функции. Право доступа к разделу шлагбаумов. Действие. Закрывает услуги: get_devices_barrier |
| 12 | <a id="keyapis-subscription-v1-Privilege-Type-BARRIER_OPEN"></a> [BARRIER_OPEN](#keyapis-subscription-v1-Privilege-Type-BARRIER_OPEN) | Умный шлагбаум. Базовые функции. Право использовать функционала поднятия стрелы шлагбаума. Действие. Закрывает услуги: post_devices_open_barrier |
| 13 | <a id="keyapis-subscription-v1-Privilege-Type-BARRIER_CODE_USE"></a> [BARRIER_CODE_USE](#keyapis-subscription-v1-Privilege-Type-BARRIER_CODE_USE) | Умный шлагбаум. Коды. Право использовать функционал открытия шлагбаума по звонку на короткий номер. Действие. Закрывает услуги: get_devices_codes_barrier, post_devices_codes_barrier, delete_devices_codes_barrier |
| 14 | <a id="keyapis-subscription-v1-Privilege-Type-BARRIER_EVENT_USE"></a> [BARRIER_EVENT_USE](#keyapis-subscription-v1-Privilege-Type-BARRIER_EVENT_USE) | Умный шлагбаум. События. Право использовать функционал журнала событий шлагбаума. Действие. Закрывает услуги: get_events_barrier |
| 15 | <a id="keyapis-subscription-v1-Privilege-Type-BARRIER_CAMERA_USE"></a> [BARRIER_CAMERA_USE](#keyapis-subscription-v1-Privilege-Type-BARRIER_CAMERA_USE) | Умный шлагбаум. Камеры. Право использовать функционал просмотра камер и лайв видео с шлагбаумов. Действие. Закрывает услуги: get_devices_camera_barrier |
| 16 | <a id="keyapis-subscription-v1-Privilege-Type-BARRIER_CAMERA_ARCHIVE"></a> [BARRIER_CAMERA_ARCHIVE](#keyapis-subscription-v1-Privilege-Type-BARRIER_CAMERA_ARCHIVE) | Умный шлагбаум. Камеры. Право использовать функционал архива видео с камер, направленных на шлагбаум. Действие. Закрывает услуги: get_video_archive_barrier |
| 17 | <a id="keyapis-subscription-v1-Privilege-Type-FR_USE"></a> [FR_USE](#keyapis-subscription-v1-Privilege-Type-FR_USE) | Распознавание лица. Фото. Право доступа к разделу распознавания лиц. Действие. Закрывает услуги: get_photo_fr_intercom, fr_intercom_access_behavior, post_photo_fr_intercom, delete_photo_fr_intercom |
| 18 | <a id="keyapis-subscription-v1-Privilege-Type-TELEMETRY_USE"></a> [TELEMETRY_USE](#keyapis-subscription-v1-Privilege-Type-TELEMETRY_USE) | Телеметрия. Базовые функции. Право доступа к разделу показаний приборов учёта. Действие. Закрывает услуги: get_telemetry_rooms_layout |
| 19 | <a id="keyapis-subscription-v1-Privilege-Type-CAMERA_USE"></a> [CAMERA_USE](#keyapis-subscription-v1-Privilege-Type-CAMERA_USE) | Камеры. Базовые функции. Право доступа к разделу камер и лайв видео с них. Действие. Закрывает услуги: get_devices_camera, get_events_camera, get_devices_camera_access_control_panel, get_devices_camera_barrier, get_devices_camera_intercom |
| 20 | <a id="keyapis-subscription-v1-Privilege-Type-CAMERA_ARCHIVE"></a> [CAMERA_ARCHIVE](#keyapis-subscription-v1-Privilege-Type-CAMERA_ARCHIVE) | Камеры. Базовые функции. Право использовать функционал архива видео с камер видеонаблюдения. Действие. Закрывает услуги: get_video_archive, get_video_archive_access_control_panel |
| 21 | <a id="keyapis-subscription-v1-Privilege-Type-INTERCOM_CMS_PHONES_USE"></a> [INTERCOM_CMS_PHONES_USE](#keyapis-subscription-v1-Privilege-Type-INTERCOM_CMS_PHONES_USE) | Умный домофон. Переадресация. Право приёма входящих вызовов от домофона на аналоговую трубку, используется только на сервере. Поведение. Закрывает услуги: devices_call_to_cms_phones_behavior |
| 22 | <a id="keyapis-subscription-v1-Privilege-Type-CAMERA_EVENT_USE"></a> [CAMERA_EVENT_USE](#keyapis-subscription-v1-Privilege-Type-CAMERA_EVENT_USE) | Умный домофон. Переадресация. Право приёма входящих вызовов от домофона на аналоговую трубку, используется только на сервере. Поведение. Закрывает услуги: get_events_camera |




<a name="keyapis-subscription-v1-PrivilegePaging-DirectionType"></a>

### [PrivilegePaging.DirectionType](#keyapis-subscription-v1-PrivilegePaging-DirectionType)
 Справочник типов направлений сортировки

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-subscription-v1-PrivilegePaging-DirectionType-DIRECTION_TYPE_UNKNOWN"></a> [DIRECTION_TYPE_UNKNOWN](#keyapis-subscription-v1-PrivilegePaging-DirectionType-DIRECTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-subscription-v1-PrivilegePaging-DirectionType-DESC"></a> [DESC](#keyapis-subscription-v1-PrivilegePaging-DirectionType-DESC) | От большего к меньшему |
| 2 | <a id="keyapis-subscription-v1-PrivilegePaging-DirectionType-ASC"></a> [ASC](#keyapis-subscription-v1-PrivilegePaging-DirectionType-ASC) | От меньшего к большему |




<a name="keyapis-subscription-v1-PrivilegePaging-OrderByType"></a>

### [PrivilegePaging.OrderByType](#keyapis-subscription-v1-PrivilegePaging-OrderByType)
 Справочник типов значений сортировки

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-subscription-v1-PrivilegePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-subscription-v1-PrivilegePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-subscription-v1-PrivilegePaging-OrderByType-KEY"></a> [KEY](#keyapis-subscription-v1-PrivilegePaging-OrderByType-KEY) | По уникальному ключу: orpon+flat_number+type |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |