# Протокол

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

- [keyapis/subscription/v1/keyapis_subscription_events_v1.proto](#keyapis_subscription_v1_keyapis_subscription_events_v1-proto)
    - [CmsInitTask](#keyapis-subscription-v1-CmsInitTask)
    - [CommercialOfferCmsAvailableTask](#keyapis-subscription-v1-CommercialOfferCmsAvailableTask)
    - [CommercialOfferCmsUnavailableTask](#keyapis-subscription-v1-CommercialOfferCmsUnavailableTask)
    - [PrivilegeStateChangeTask](#keyapis-subscription-v1-PrivilegeStateChangeTask)
  


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




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

## [keyapis/subscription/v1/keyapis_subscription_events_v1.proto](/protos/key/keyapis/subscription/v1/keyapis_subscription_events_v1.proto)
События устройств (домофоны, калитки, шлагбаумы)

 <!-- end services -->


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


### [CmsInitTask](#keyapis-subscription-v1-CmsInitTask)
 Событие инициализации сценария обновления статусов аналоговых трубок.
Очередь key.subscription.cms_init


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-CmsInitTask-request_id"></a> [request_id](#keyapis-subscription-v1-CmsInitTask-request_id) | Идентификатор запроса |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-CmsInitTask-orpons"></a> [orpons](#keyapis-subscription-v1-CmsInitTask-orpons) | ОРПОНы домов |  repeated  [int64](#scalar-types) | REQUIRED|






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


### [CommercialOfferCmsAvailableTask](#keyapis-subscription-v1-CommercialOfferCmsAvailableTask)
 Событие о появлении коммерческой возможности с услугой аналоговой трубки.
Очередь key.subscription.cms_available


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-CommercialOfferCmsAvailableTask-request_id"></a> [request_id](#keyapis-subscription-v1-CommercialOfferCmsAvailableTask-request_id) | Идентификатор запроса |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-CommercialOfferCmsAvailableTask-orpon_id"></a> [orpon_id](#keyapis-subscription-v1-CommercialOfferCmsAvailableTask-orpon_id) | Идентификатор ОРПОН дома |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-CommercialOfferCmsAvailableTask-privileged_room_numbers"></a> [privileged_room_numbers](#keyapis-subscription-v1-CommercialOfferCmsAvailableTask-privileged_room_numbers) | Номера квартир, с привилегией "Аналоговая трубка" в статусе: Оплачено, Промо, Отключается |  repeated  [string](#scalar-types) | <nil>|






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


### [CommercialOfferCmsUnavailableTask](#keyapis-subscription-v1-CommercialOfferCmsUnavailableTask)
 Событие о прекращении действия коммерческой возможности с услугой аналоговой трубки.
Очередь key.subscription.cms_unavailable


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-CommercialOfferCmsUnavailableTask-request_id"></a> [request_id](#keyapis-subscription-v1-CommercialOfferCmsUnavailableTask-request_id) | Идентификатор запроса |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-CommercialOfferCmsUnavailableTask-orpon_id"></a> [orpon_id](#keyapis-subscription-v1-CommercialOfferCmsUnavailableTask-orpon_id) | Идентификатор ОРПОН дома |    [int64](#scalar-types) | REQUIRED|






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


### [PrivilegeStateChangeTask](#keyapis-subscription-v1-PrivilegeStateChangeTask)
 Сообщение об изменении состояния привилегии.
Очередь key.subscription.privilege_state_change


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-PrivilegeStateChangeTask-request_id"></a> [request_id](#keyapis-subscription-v1-PrivilegeStateChangeTask-request_id) | Идентификатор запроса |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-PrivilegeStateChangeTask-orpon_id"></a> [orpon_id](#keyapis-subscription-v1-PrivilegeStateChangeTask-orpon_id) | Идентификатор ОРПОН дома |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-PrivilegeStateChangeTask-room_number"></a> [room_number](#keyapis-subscription-v1-PrivilegeStateChangeTask-room_number) | Номер квартиры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-PrivilegeStateChangeTask-privilege_type"></a> [privilege_type](#keyapis-subscription-v1-PrivilegeStateChangeTask-privilege_type) | Тип привилегии |    [keyapis.subscription.v1.Privilege.Type](#keyapis-subscription-v1-Privilege-Type) | REQUIRED|
| <a id="keyapis-subscription-v1-PrivilegeStateChangeTask-state_type"></a> [state_type](#keyapis-subscription-v1-PrivilegeStateChangeTask-state_type) | Тип состояния привилегий |    [keyapis.subscription.v1.Privilege.StateType](#keyapis-subscription-v1-Privilege-StateType) | REQUIRED|
| <a id="keyapis-subscription-v1-PrivilegeStateChangeTask-previous_state_type"></a> [previous_state_type](#keyapis-subscription-v1-PrivilegeStateChangeTask-previous_state_type) | Предыдущий тип состояния привилегии |    [keyapis.subscription.v1.Privilege.StateType](#keyapis-subscription-v1-Privilege-StateType) | <nil>|
| <a id="keyapis-subscription-v1-PrivilegeStateChangeTask-updated_at"></a> [updated_at](#keyapis-subscription-v1-PrivilegeStateChangeTask-updated_at) | Дата обновления состояния привилегии |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | REQUIRED|





 <!-- end messages -->

 <!-- 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 |