diff --git a/CHANGELOG.md b/CHANGELOG.md index da50e36..a3aa93c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,28 @@ # Changelog Hiber API +### 0.210 (2024-09-24) + +##### AssetService + +- Added new asset types. +- Added `numeric_value_types` to `Asset.AssignedDevice` to easily see which devices produce which `Value.Numeric.Type`. + +##### CurrentUserService + +- Marked a number of fields `optional` for cases where you do not have permission to see them, or, for the permission filters, if they are empty. + +##### EventService + +- Updated the event json examples with default values for fields. + +##### Publisher + +- Marked a number of deprecated data fields `optional`. + +##### TokenService + +- Add an option to `minimize` tokens in `CreateTokenRequest`. This reduces the length of the token significantly. + ### 0.209 (2024-09-17) ##### MessageService diff --git a/asset.proto b/asset.proto index 5a59b3a..a72edaf 100644 --- a/asset.proto +++ b/asset.proto @@ -31,6 +31,7 @@ message Asset { WELL_ANNULUS_B = 2; WELL_ANNULUS_C = 3; WELL_ANNULUS_D = 4; + WELL_HEAD = 15; WELL_TUBING_HEAD = 5; WELL_TUBING = 6; WELL_FLOW_LINE = 7; @@ -38,6 +39,9 @@ message Asset { WELL_PRODUCTION_CASING_PRESSURE = 9; WELL_INTERMITTENT_CASING_PRESSURE = 10; PIPELINE = 11; + PRODUCTION_LINE = 12; + GAS_MANIFOLD = 13; + PRODUCTION_MANIFOLD = 14; } /* A device assigned to this asset. @@ -53,6 +57,7 @@ message Asset { optional Timestamp last_message_received_at = 6; optional TimeRange assignment_time_range = 7; optional health.HealthLevel health = 8; + repeated value.Value.Numeric.Type numeric_value_types = 9; } string identifier = 1; diff --git a/currentuser.proto b/currentuser.proto index cb991ce..8368cc2 100644 --- a/currentuser.proto +++ b/currentuser.proto @@ -36,14 +36,22 @@ service CurrentUserService { /* Your personal data. */ message CurrentUser { string id = 1; - string email = 2; - string name = 3; + + /* Email address of the current user. + * Only set when you have permission to read the user data (i.e. a token without that permission would not see this) + */ + optional string email = 2; + + /* Name of the current user. + * Only set when you have permission to read the user data (i.e. a token without that permission would not see this) + */ + optional string name = 3; /* The organizations that this user has access to. */ repeated string organizations = 4; - /* The default organization for this user. */ - string default_organization = 5; + /* The default organization for this user, if any. */ + optional string default_organization = 5; /* Open access requests. */ repeated string requested_organizations = 6; @@ -51,22 +59,22 @@ message CurrentUser { reserved 7; /* The current organization for this user. - * If this is a user, this equals the default_organization. + * If this is a user, this equals the default_organization, if any. * If this is a token, it's the token's organization. */ - string current_organization = 8; + optional string current_organization = 8; /* Permissions for the current organization. */ - Filter.OrganizationPermissions current_organization_permissions = 9; + optional Filter.OrganizationPermissions current_organization_permissions = 9; - /* Permissions for the user. If this is a token, the user permissions may be limited. */ - Filter.UserPermissions user_permissions = 10; + /* Permissions for the user. If this is a token, the user permissions may be limited or omitted. */ + optional Filter.UserPermissions user_permissions = 10; /* Permissions for customer support. * Used for features typically reserved for customer support, or that behave differently * when used by a customer support operator. */ - Filter.SupportPermissions support_permissions = 14; + optional Filter.SupportPermissions support_permissions = 14; /* Roles for the current organization. */ repeated string roles = 15; diff --git a/docs/enum-json/asset.json b/docs/enum-json/asset.json index 9adb6f9..362ceca 100644 --- a/docs/enum-json/asset.json +++ b/docs/enum-json/asset.json @@ -7,6 +7,7 @@ , "WELL_ANNULUS_B": "" , "WELL_ANNULUS_C": "" , "WELL_ANNULUS_D": "" + , "WELL_HEAD": "" , "WELL_TUBING_HEAD": "" , "WELL_TUBING": "" , "WELL_FLOW_LINE": "" @@ -14,5 +15,8 @@ , "WELL_PRODUCTION_CASING_PRESSURE": "" , "WELL_INTERMITTENT_CASING_PRESSURE": "" , "PIPELINE": "" + , "PRODUCTION_LINE": "" + , "GAS_MANIFOLD": "" + , "PRODUCTION_MANIFOLD": "" } }] \ No newline at end of file diff --git a/docs/html/asset.html b/docs/html/asset.html index bd41473..a9acf82 100644 --- a/docs/html/asset.html +++ b/docs/html/asset.html @@ -914,6 +914,13 @@

Asset.AssignedDevice

+ + numeric_value_types + hiber.value.Value.Numeric.Type + repeated +

+ + @@ -1006,6 +1013,12 @@

Asset.Type

+ + WELL_HEAD + 15 +

+ + WELL_TUBING_HEAD 5 @@ -1048,6 +1061,24 @@

Asset.Type

+ + PRODUCTION_LINE + 12 +

+ + + + GAS_MANIFOLD + 13 +

+ + + + PRODUCTION_MANIFOLD + 14 +

+ + diff --git a/docs/html/asset_service.html b/docs/html/asset_service.html index ce44570..854263d 100644 --- a/docs/html/asset_service.html +++ b/docs/html/asset_service.html @@ -4299,6 +4299,13 @@

Asset.AssignedDevice

+ + numeric_value_types + hiber.value.Value.Numeric.Type + repeated +

+ + @@ -4391,6 +4398,12 @@

Asset.Type

+ + WELL_HEAD + 15 +

+ + WELL_TUBING_HEAD 5 @@ -4433,6 +4446,24 @@

Asset.Type

+ + PRODUCTION_LINE + 12 +

+ + + + GAS_MANIFOLD + 13 +

+ + + + PRODUCTION_MANIFOLD + 14 +

+ + diff --git a/docs/html/assignment.html b/docs/html/assignment.html index 840b6d4..8b6bef8 100644 --- a/docs/html/assignment.html +++ b/docs/html/assignment.html @@ -5318,6 +5318,13 @@

Asset.AssignedDevice

+ + numeric_value_types + hiber.value.Value.Numeric.Type + repeated +

+ + @@ -5410,6 +5417,12 @@

Asset.Type

+ + WELL_HEAD + 15 +

+ + WELL_TUBING_HEAD 5 @@ -5452,6 +5465,24 @@

Asset.Type

+ + PRODUCTION_LINE + 12 +

+ + + + GAS_MANIFOLD + 13 +

+ + + + PRODUCTION_MANIFOLD + 14 +

+ + diff --git a/docs/html/currentuser.html b/docs/html/currentuser.html index 65d572f..1c0770a 100644 --- a/docs/html/currentuser.html +++ b/docs/html/currentuser.html @@ -893,15 +893,17 @@

CurrentUser

email string - -

+ optional +

Email address of the current user. +Only set when you have permission to read the user data (i.e. a token without that permission would not see this)

name string - -

+ optional +

Name of the current user. +Only set when you have permission to read the user data (i.e. a token without that permission would not see this)

@@ -914,8 +916,8 @@

CurrentUser

default_organization string - -

The default organization for this user.

+ optional +

The default organization for this user, if any.

@@ -928,30 +930,30 @@

CurrentUser

current_organization string - + optional

The current organization for this user. -If this is a user, this equals the default_organization. +If this is a user, this equals the default_organization, if any. If this is a token, it's the token's organization.

current_organization_permissions hiber.Filter.OrganizationPermissions - + optional

Permissions for the current organization.

user_permissions hiber.Filter.UserPermissions - -

Permissions for the user. If this is a token, the user permissions may be limited.

+ optional +

Permissions for the user. If this is a token, the user permissions may be limited or omitted.

support_permissions hiber.Filter.SupportPermissions - + optional

Permissions for customer support. Used for features typically reserved for customer support, or that behave differently when used by a customer support operator.

diff --git a/docs/html/event.html b/docs/html/event.html index d200925..8066e7d 100644 --- a/docs/html/event.html +++ b/docs/html/event.html @@ -9627,6 +9627,13 @@

Asset.AssignedDevice

+ + numeric_value_types + hiber.value.Value.Numeric.Type + repeated +

+ + @@ -9719,6 +9726,12 @@

Asset.Type

+ + WELL_HEAD + 15 +

+ + WELL_TUBING_HEAD 5 @@ -9761,6 +9774,24 @@

Asset.Type

+ + PRODUCTION_LINE + 12 +

+ + + + GAS_MANIFOLD + 13 +

+ + + + PRODUCTION_MANIFOLD + 14 +

+ + @@ -22142,42 +22173,42 @@

Publisher.Data

content_type Publisher.ContentType - + optional

disabled bool - + optional

certificate_id int64 - + optional

certificate_name string - + optional

ca_certificate_id int64 - + optional

ca_certificate_name string - + optional

diff --git a/docs/html/field_service.html b/docs/html/field_service.html index e8e198b..5f2d0e2 100644 --- a/docs/html/field_service.html +++ b/docs/html/field_service.html @@ -2408,6 +2408,13 @@

Asset.AssignedDevice

+ + numeric_value_types + hiber.value.Value.Numeric.Type + repeated +

+ + @@ -2500,6 +2507,12 @@

Asset.Type

+ + WELL_HEAD + 15 +

+ + WELL_TUBING_HEAD 5 @@ -2542,6 +2555,24 @@

Asset.Type

+ + PRODUCTION_LINE + 12 +

+ + + + GAS_MANIFOLD + 13 +

+ + + + PRODUCTION_MANIFOLD + 14 +

+ + diff --git a/docs/html/publisher.html b/docs/html/publisher.html index 11c3798..e13f6f3 100644 --- a/docs/html/publisher.html +++ b/docs/html/publisher.html @@ -1113,42 +1113,42 @@

Publisher.Data

content_type Publisher.ContentType - + optional

disabled bool - + optional

certificate_id int64 - + optional

certificate_name string - + optional

ca_certificate_id int64 - + optional

ca_certificate_name string - + optional

diff --git a/docs/html/role_service.html b/docs/html/role_service.html index b5c4bdf..e8c5495 100644 --- a/docs/html/role_service.html +++ b/docs/html/role_service.html @@ -722,15 +722,17 @@

CurrentUser

email string - -

+ optional +

Email address of the current user. +Only set when you have permission to read the user data (i.e. a token without that permission would not see this)

name string - -

+ optional +

Name of the current user. +Only set when you have permission to read the user data (i.e. a token without that permission would not see this)

@@ -743,8 +745,8 @@

CurrentUser

default_organization string - -

The default organization for this user.

+ optional +

The default organization for this user, if any.

@@ -757,30 +759,30 @@

CurrentUser

current_organization string - + optional

The current organization for this user. -If this is a user, this equals the default_organization. +If this is a user, this equals the default_organization, if any. If this is a token, it's the token's organization.

current_organization_permissions hiber.Filter.OrganizationPermissions - + optional

Permissions for the current organization.

user_permissions hiber.Filter.UserPermissions - -

Permissions for the user. If this is a token, the user permissions may be limited.

+ optional +

Permissions for the user. If this is a token, the user permissions may be limited or omitted.

support_permissions hiber.Filter.SupportPermissions - + optional

Permissions for customer support. Used for features typically reserved for customer support, or that behave differently when used by a customer support operator.

diff --git a/docs/html/value_service.html b/docs/html/value_service.html index 37d4890..d9f0bd4 100644 --- a/docs/html/value_service.html +++ b/docs/html/value_service.html @@ -3857,6 +3857,13 @@

Asset.AssignedDevice

+ + numeric_value_types + hiber.value.Value.Numeric.Type + repeated +

+ + @@ -3949,6 +3956,12 @@

Asset.Type

+ + WELL_HEAD + 15 +

+ + WELL_TUBING_HEAD 5 @@ -3991,6 +4004,24 @@

Asset.Type

+ + PRODUCTION_LINE + 12 +

+ + + + GAS_MANIFOLD + 13 +

+ + + + PRODUCTION_MANIFOLD + 14 +

+ + diff --git a/docs/md/asset.md b/docs/md/asset.md index cb451cc..67cf714 100644 --- a/docs/md/asset.md +++ b/docs/md/asset.md @@ -163,6 +163,7 @@ Non-operational values that the device produces will be linked to this asset | **optional** last_message_received_at | [optional hiber.Timestamp](#hibertimestamp) | | | **optional** assignment_time_range | [optional hiber.TimeRange](#hibertimerange) | | | **optional** health | [optional hiber.health.HealthLevel](#hiberhealthhealthlevel) | | +| numeric_value_types | [repeated hiber.value.Value.Numeric.Type](#hibervaluevaluenumerictype) | | ### AssetSelection @@ -188,6 +189,7 @@ Currently a limited list, but more may be added in the future. | WELL_ANNULUS_B | | 2 | | WELL_ANNULUS_C | | 3 | | WELL_ANNULUS_D | | 4 | +| WELL_HEAD | | 15 | | WELL_TUBING_HEAD | | 5 | | WELL_TUBING | | 6 | | WELL_FLOW_LINE | | 7 | @@ -195,6 +197,9 @@ Currently a limited list, but more may be added in the future. | WELL_PRODUCTION_CASING_PRESSURE | | 9 | | WELL_INTERMITTENT_CASING_PRESSURE | | 10 | | PIPELINE | | 11 | +| PRODUCTION_LINE | | 12 | +| GAS_MANIFOLD | | 13 | +| PRODUCTION_MANIFOLD | | 14 | diff --git a/docs/md/asset_service.md b/docs/md/asset_service.md index 1cea419..248761b 100644 --- a/docs/md/asset_service.md +++ b/docs/md/asset_service.md @@ -526,6 +526,7 @@ Non-operational values that the device produces will be linked to this asset | **optional** last_message_received_at | [optional hiber.Timestamp](#hibertimestamp) | | | **optional** assignment_time_range | [optional hiber.TimeRange](#hibertimerange) | | | **optional** health | [optional hiber.health.HealthLevel](#hiberhealthhealthlevel) | | +| numeric_value_types | [repeated hiber.value.Value.Numeric.Type](#hibervaluevaluenumerictype) | | ### hiber.asset.AssetSelection @@ -551,6 +552,7 @@ Currently a limited list, but more may be added in the future. | WELL_ANNULUS_B | | 2 | | WELL_ANNULUS_C | | 3 | | WELL_ANNULUS_D | | 4 | +| WELL_HEAD | | 15 | | WELL_TUBING_HEAD | | 5 | | WELL_TUBING | | 6 | | WELL_FLOW_LINE | | 7 | @@ -558,6 +560,9 @@ Currently a limited list, but more may be added in the future. | WELL_PRODUCTION_CASING_PRESSURE | | 9 | | WELL_INTERMITTENT_CASING_PRESSURE | | 10 | | PIPELINE | | 11 | +| PRODUCTION_LINE | | 12 | +| GAS_MANIFOLD | | 13 | +| PRODUCTION_MANIFOLD | | 14 | diff --git a/docs/md/assignment.md b/docs/md/assignment.md index 118ff06..0a4ae6b 100644 --- a/docs/md/assignment.md +++ b/docs/md/assignment.md @@ -743,6 +743,7 @@ Non-operational values that the device produces will be linked to this asset | **optional** last_message_received_at | [optional hiber.Timestamp](#hibertimestamp) | | | **optional** assignment_time_range | [optional hiber.TimeRange](#hibertimerange) | | | **optional** health | [optional hiber.health.HealthLevel](#hiberhealthhealthlevel) | | +| numeric_value_types | [repeated hiber.value.Value.Numeric.Type](#hibervaluevaluenumerictype) | | ### hiber.asset.AssetSelection @@ -768,6 +769,7 @@ Currently a limited list, but more may be added in the future. | WELL_ANNULUS_B | | 2 | | WELL_ANNULUS_C | | 3 | | WELL_ANNULUS_D | | 4 | +| WELL_HEAD | | 15 | | WELL_TUBING_HEAD | | 5 | | WELL_TUBING | | 6 | | WELL_FLOW_LINE | | 7 | @@ -775,6 +777,9 @@ Currently a limited list, but more may be added in the future. | WELL_PRODUCTION_CASING_PRESSURE | | 9 | | WELL_INTERMITTENT_CASING_PRESSURE | | 10 | | PIPELINE | | 11 | +| PRODUCTION_LINE | | 12 | +| GAS_MANIFOLD | | 13 | +| PRODUCTION_MANIFOLD | | 14 | diff --git a/docs/md/currentuser.md b/docs/md/currentuser.md index 7159844..9598560 100644 --- a/docs/md/currentuser.md +++ b/docs/md/currentuser.md @@ -285,15 +285,15 @@ Your personal data. | Field | Type | Description | | ----- | ---- | ----------- | | id | [ string](#string) | | -| email | [ string](#string) | | -| name | [ string](#string) | | +| **optional** email | [optional string](#string) | Email address of the current user. Only set when you have permission to read the user data (i.e. a token without that permission would not see this) | +| **optional** name | [optional string](#string) | Name of the current user. Only set when you have permission to read the user data (i.e. a token without that permission would not see this) | | organizations | [repeated string](#string) | The organizations that this user has access to. | -| default_organization | [ string](#string) | The default organization for this user. | +| **optional** default_organization | [optional string](#string) | The default organization for this user, if any. | | requested_organizations | [repeated string](#string) | Open access requests. | -| current_organization | [ string](#string) | The current organization for this user. If this is a user, this equals the default_organization. If this is a token, it's the token's organization. | -| current_organization_permissions | [ hiber.Filter.OrganizationPermissions](#hiberfilterorganizationpermissions) | Permissions for the current organization. | -| user_permissions | [ hiber.Filter.UserPermissions](#hiberfilteruserpermissions) | Permissions for the user. If this is a token, the user permissions may be limited. | -| support_permissions | [ hiber.Filter.SupportPermissions](#hiberfiltersupportpermissions) | Permissions for customer support. Used for features typically reserved for customer support, or that behave differently when used by a customer support operator. | +| **optional** current_organization | [optional string](#string) | The current organization for this user. If this is a user, this equals the default_organization, if any. If this is a token, it's the token's organization. | +| **optional** current_organization_permissions | [optional hiber.Filter.OrganizationPermissions](#hiberfilterorganizationpermissions) | Permissions for the current organization. | +| **optional** user_permissions | [optional hiber.Filter.UserPermissions](#hiberfilteruserpermissions) | Permissions for the user. If this is a token, the user permissions may be limited or omitted. | +| **optional** support_permissions | [optional hiber.Filter.SupportPermissions](#hiberfiltersupportpermissions) | Permissions for customer support. Used for features typically reserved for customer support, or that behave differently when used by a customer support operator. | | roles | [repeated string](#string) | Roles for the current organization. | | mission_control_settings | [ string](#string) | | | accepted_tac | [ bool](#bool) | Whether the user accepted the terms and conditions. | diff --git a/docs/md/event.md b/docs/md/event.md index e0445eb..3a496c3 100644 --- a/docs/md/event.md +++ b/docs/md/event.md @@ -2220,6 +2220,7 @@ Non-operational values that the device produces will be linked to this asset | **optional** last_message_received_at | [optional hiber.Timestamp](#hibertimestamp) | | | **optional** assignment_time_range | [optional hiber.TimeRange](#hibertimerange) | | | **optional** health | [optional hiber.health.HealthLevel](#hiberhealthhealthlevel) | | +| numeric_value_types | [repeated hiber.value.Value.Numeric.Type](#hibervaluevaluenumerictype) | | ### hiber.asset.AssetSelection @@ -2245,6 +2246,7 @@ Currently a limited list, but more may be added in the future. | WELL_ANNULUS_B | | 2 | | WELL_ANNULUS_C | | 3 | | WELL_ANNULUS_D | | 4 | +| WELL_HEAD | | 15 | | WELL_TUBING_HEAD | | 5 | | WELL_TUBING | | 6 | | WELL_FLOW_LINE | | 7 | @@ -2252,6 +2254,9 @@ Currently a limited list, but more may be added in the future. | WELL_PRODUCTION_CASING_PRESSURE | | 9 | | WELL_INTERMITTENT_CASING_PRESSURE | | 10 | | PIPELINE | | 11 | +| PRODUCTION_LINE | | 12 | +| GAS_MANIFOLD | | 13 | +| PRODUCTION_MANIFOLD | | 14 | @@ -4444,12 +4449,12 @@ Now, this types is only used in the relevant events. | Field | Type | Description | | ----- | ---- | ----------- | | url | [ string](#string) | | -| content_type | [ hiber.publisher.Publisher.ContentType](#hiberpublisherpublishercontenttype) | | -| disabled | [ bool](#bool) | | -| certificate_id | [ int64](#int64) | | -| certificate_name | [ string](#string) | | -| ca_certificate_id | [ int64](#int64) | | -| ca_certificate_name | [ string](#string) | | +| **optional** content_type | [optional hiber.publisher.Publisher.ContentType](#hiberpublisherpublishercontenttype) | | +| **optional** disabled | [optional bool](#bool) | | +| **optional** certificate_id | [optional int64](#int64) | | +| **optional** certificate_name | [optional string](#string) | | +| **optional** ca_certificate_id | [optional int64](#int64) | | +| **optional** ca_certificate_name | [optional string](#string) | | | [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **config**.http | [ hiber.publisher.Publisher.Data.HTTPConfig](#hiberpublisherpublisherdatahttpconfig) | | | [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **config**.mqtt | [ hiber.publisher.Publisher.Data.MQTTConfig](#hiberpublisherpublisherdatamqttconfig) | | diff --git a/docs/md/field_service.md b/docs/md/field_service.md index fad1996..fd8e608 100644 --- a/docs/md/field_service.md +++ b/docs/md/field_service.md @@ -551,6 +551,7 @@ Non-operational values that the device produces will be linked to this asset | **optional** last_message_received_at | [optional hiber.Timestamp](#hibertimestamp) | | | **optional** assignment_time_range | [optional hiber.TimeRange](#hibertimerange) | | | **optional** health | [optional hiber.health.HealthLevel](#hiberhealthhealthlevel) | | +| numeric_value_types | [repeated hiber.value.Value.Numeric.Type](#hibervaluevaluenumerictype) | | ### hiber.asset.AssetSelection @@ -576,6 +577,7 @@ Currently a limited list, but more may be added in the future. | WELL_ANNULUS_B | | 2 | | WELL_ANNULUS_C | | 3 | | WELL_ANNULUS_D | | 4 | +| WELL_HEAD | | 15 | | WELL_TUBING_HEAD | | 5 | | WELL_TUBING | | 6 | | WELL_FLOW_LINE | | 7 | @@ -583,6 +585,9 @@ Currently a limited list, but more may be added in the future. | WELL_PRODUCTION_CASING_PRESSURE | | 9 | | WELL_INTERMITTENT_CASING_PRESSURE | | 10 | | PIPELINE | | 11 | +| PRODUCTION_LINE | | 12 | +| GAS_MANIFOLD | | 13 | +| PRODUCTION_MANIFOLD | | 14 | diff --git a/docs/md/publisher.md b/docs/md/publisher.md index 9d72223..b8412b4 100644 --- a/docs/md/publisher.md +++ b/docs/md/publisher.md @@ -229,12 +229,12 @@ Now, this types is only used in the relevant events. | Field | Type | Description | | ----- | ---- | ----------- | | url | [ string](#string) | | -| content_type | [ Publisher.ContentType](#publishercontenttype) | | -| disabled | [ bool](#bool) | | -| certificate_id | [ int64](#int64) | | -| certificate_name | [ string](#string) | | -| ca_certificate_id | [ int64](#int64) | | -| ca_certificate_name | [ string](#string) | | +| **optional** content_type | [optional Publisher.ContentType](#publishercontenttype) | | +| **optional** disabled | [optional bool](#bool) | | +| **optional** certificate_id | [optional int64](#int64) | | +| **optional** certificate_name | [optional string](#string) | | +| **optional** ca_certificate_id | [optional int64](#int64) | | +| **optional** ca_certificate_name | [optional string](#string) | | | [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **config**.http | [ Publisher.Data.HTTPConfig](#publisherdatahttpconfig) | | | [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **config**.mqtt | [ Publisher.Data.MQTTConfig](#publisherdatamqttconfig) | | diff --git a/docs/md/role_service.md b/docs/md/role_service.md index 636c81d..36524af 100644 --- a/docs/md/role_service.md +++ b/docs/md/role_service.md @@ -192,15 +192,15 @@ Your personal data. | Field | Type | Description | | ----- | ---- | ----------- | | id | [ string](#string) | | -| email | [ string](#string) | | -| name | [ string](#string) | | +| **optional** email | [optional string](#string) | Email address of the current user. Only set when you have permission to read the user data (i.e. a token without that permission would not see this) | +| **optional** name | [optional string](#string) | Name of the current user. Only set when you have permission to read the user data (i.e. a token without that permission would not see this) | | organizations | [repeated string](#string) | The organizations that this user has access to. | -| default_organization | [ string](#string) | The default organization for this user. | +| **optional** default_organization | [optional string](#string) | The default organization for this user, if any. | | requested_organizations | [repeated string](#string) | Open access requests. | -| current_organization | [ string](#string) | The current organization for this user. If this is a user, this equals the default_organization. If this is a token, it's the token's organization. | -| current_organization_permissions | [ hiber.Filter.OrganizationPermissions](#hiberfilterorganizationpermissions) | Permissions for the current organization. | -| user_permissions | [ hiber.Filter.UserPermissions](#hiberfilteruserpermissions) | Permissions for the user. If this is a token, the user permissions may be limited. | -| support_permissions | [ hiber.Filter.SupportPermissions](#hiberfiltersupportpermissions) | Permissions for customer support. Used for features typically reserved for customer support, or that behave differently when used by a customer support operator. | +| **optional** current_organization | [optional string](#string) | The current organization for this user. If this is a user, this equals the default_organization, if any. If this is a token, it's the token's organization. | +| **optional** current_organization_permissions | [optional hiber.Filter.OrganizationPermissions](#hiberfilterorganizationpermissions) | Permissions for the current organization. | +| **optional** user_permissions | [optional hiber.Filter.UserPermissions](#hiberfilteruserpermissions) | Permissions for the user. If this is a token, the user permissions may be limited or omitted. | +| **optional** support_permissions | [optional hiber.Filter.SupportPermissions](#hiberfiltersupportpermissions) | Permissions for customer support. Used for features typically reserved for customer support, or that behave differently when used by a customer support operator. | | roles | [repeated string](#string) | Roles for the current organization. | | mission_control_settings | [ string](#string) | | | accepted_tac | [ bool](#bool) | Whether the user accepted the terms and conditions. | diff --git a/docs/md/value_service.md b/docs/md/value_service.md index 8dcef98..0d2de7d 100644 --- a/docs/md/value_service.md +++ b/docs/md/value_service.md @@ -367,6 +367,7 @@ Non-operational values that the device produces will be linked to this asset | **optional** last_message_received_at | [optional hiber.Timestamp](#hibertimestamp) | | | **optional** assignment_time_range | [optional hiber.TimeRange](#hibertimerange) | | | **optional** health | [optional hiber.health.HealthLevel](#hiberhealthhealthlevel) | | +| numeric_value_types | [repeated hiber.value.Value.Numeric.Type](#hibervaluevaluenumerictype) | | ### hiber.asset.AssetSelection @@ -392,6 +393,7 @@ Currently a limited list, but more may be added in the future. | WELL_ANNULUS_B | | 2 | | WELL_ANNULUS_C | | 3 | | WELL_ANNULUS_D | | 4 | +| WELL_HEAD | | 15 | | WELL_TUBING_HEAD | | 5 | | WELL_TUBING | | 6 | | WELL_FLOW_LINE | | 7 | @@ -399,6 +401,9 @@ Currently a limited list, but more may be added in the future. | WELL_PRODUCTION_CASING_PRESSURE | | 9 | | WELL_INTERMITTENT_CASING_PRESSURE | | 10 | | PIPELINE | | 11 | +| PRODUCTION_LINE | | 12 | +| GAS_MANIFOLD | | 13 | +| PRODUCTION_MANIFOLD | | 14 | diff --git a/event-json-examples/alarm-created.json b/event-json-examples/alarm-created.json index a08ef3b..fc800f3 100644 --- a/event-json-examples/alarm-created.json +++ b/event-json-examples/alarm-created.json @@ -18,7 +18,8 @@ "duration": "3600s", "textual": "1h" } - } + }, + "checks": [] }, "title": "Alarm example (example-identifier) was created.", "description": "Alarm example (example-identifier) was created:\n\nexample", @@ -35,5 +36,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "ALARM_CREATED" + "type": "ALARM_CREATED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/alarm-deleted.json b/event-json-examples/alarm-deleted.json index d80fc7b..c06e185 100644 --- a/event-json-examples/alarm-deleted.json +++ b/event-json-examples/alarm-deleted.json @@ -17,5 +17,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "ALARM_DELETED" + "type": "ALARM_DELETED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/alarm-triggered.json b/event-json-examples/alarm-triggered.json index ad06953..d164ea5 100644 --- a/event-json-examples/alarm-triggered.json +++ b/event-json-examples/alarm-triggered.json @@ -82,5 +82,6 @@ "type": "well" } } - ] + ], + "isWarning": false } diff --git a/event-json-examples/alarm-updated.json b/event-json-examples/alarm-updated.json index 6be6df1..0baa765 100644 --- a/event-json-examples/alarm-updated.json +++ b/event-json-examples/alarm-updated.json @@ -37,5 +37,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "ALARM_UPDATED" + "type": "ALARM_UPDATED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/asset-created.json b/event-json-examples/asset-created.json index e29b69d..e93fdb6 100644 --- a/event-json-examples/asset-created.json +++ b/event-json-examples/asset-created.json @@ -54,10 +54,15 @@ "fill": "white", "text": "white" }, - "severity": "1" - } + "severity": "1", + "catchAll": false + }, + "numericValueTypes": [ + "PRESSURE" + ] } - ] + ], + "inactiveDevices": [] }, "time": { "timestamp": "2020-06-01T05:15:25.355Z", @@ -106,5 +111,7 @@ "type": "well" } } - ] + ], + "isError": false, + "isWarning": false } diff --git a/event-json-examples/asset-deleted.json b/event-json-examples/asset-deleted.json index 9606b80..cd5f2c8 100644 --- a/event-json-examples/asset-deleted.json +++ b/event-json-examples/asset-deleted.json @@ -43,5 +43,7 @@ "name": "example-tag-2", "type": "well" } - }] + }], + "isError": false, + "isWarning": false } diff --git a/event-json-examples/asset-updated.json b/event-json-examples/asset-updated.json index 54b1915..b92ac9c 100644 --- a/event-json-examples/asset-updated.json +++ b/event-json-examples/asset-updated.json @@ -59,5 +59,7 @@ "type": "well" } } - ] + ], + "isError": false, + "isWarning": false } diff --git a/event-json-examples/assigned.json b/event-json-examples/assigned.json index c0238b9..5d0a51e 100644 --- a/event-json-examples/assigned.json +++ b/event-json-examples/assigned.json @@ -30,7 +30,8 @@ "timestamp": "2020-06-01T05:15:25.355Z", "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" - } + }, + "tags": [] }, "title": "example-identifier was assigned to AAAA AAAA.", "description": "Any new message from device AAAA AAAA will now be validated using alarm 'example alarm name' (example-identifier): example", @@ -44,5 +45,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "ASSIGNED" + "type": "ASSIGNED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/device-created.json b/event-json-examples/device-created.json index b97b51a..21be694 100644 --- a/event-json-examples/device-created.json +++ b/event-json-examples/device-created.json @@ -55,5 +55,7 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "DEVICE_CREATED" + "type": "DEVICE_CREATED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/device-installed.json b/event-json-examples/device-installed.json index 8441df4..c7694e9 100644 --- a/event-json-examples/device-installed.json +++ b/event-json-examples/device-installed.json @@ -55,5 +55,7 @@ } } ], - "type": "DEVICE_INSTALLED" + "type": "DEVICE_INSTALLED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/device-location-updated.json b/event-json-examples/device-location-updated.json index c270659..401134d 100644 --- a/event-json-examples/device-location-updated.json +++ b/event-json-examples/device-location-updated.json @@ -65,5 +65,7 @@ } } ], - "type": "DEVICE_LOCATION_UPDATED" + "type": "DEVICE_LOCATION_UPDATED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/device-updated.json b/event-json-examples/device-updated.json index 7a29e94..3a5efa3 100644 --- a/event-json-examples/device-updated.json +++ b/event-json-examples/device-updated.json @@ -40,6 +40,7 @@ "value": "my-updated-notes" }, "updatedNotes": "my-updated-notes", + "secureNotesUpdated": false, "externalDeviceId": "00 11 22 33 AA BB CC DD" }, "title": "Device AAAA AAAA was updated.", @@ -70,5 +71,7 @@ } } ], - "type": "DEVICE_UPDATED" + "type": "DEVICE_UPDATED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/export-created.json b/event-json-examples/export-created.json index fef63a1..d3d7e4f 100644 --- a/event-json-examples/export-created.json +++ b/event-json-examples/export-created.json @@ -8,7 +8,10 @@ "format": { "type": "JSON", "json": { - "compact": true + "compact": true, + "customFields": { + "temperatureCelsius": "$.temperature" + } } }, "configuration": { @@ -33,7 +36,9 @@ } } } - } + }, + "urls": [], + "error": "" }, "title": "Exporting messages for device AAAA AAAA to example-identifier from 2020-05-02 05:15:25Z to 2020-06-01 05:15:25Z.", "description": "Exporting messages for device AAAA AAAA to example-identifier from 2020-05-02 05:15:25Z to 2020-06-01 05:15:25Z.\n\nwell: example-tag, example-tag-2\nRequested by: user-identifier for your-organization", @@ -66,5 +71,7 @@ } } ], - "type": "EXPORT_CREATED" + "type": "EXPORT_CREATED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/export-failed.json b/event-json-examples/export-failed.json index c9865f4..263eb5e 100644 --- a/event-json-examples/export-failed.json +++ b/event-json-examples/export-failed.json @@ -8,7 +8,10 @@ "format": { "type": "JSON", "json": { - "compact": true + "compact": true, + "customFields": { + "temperatureCelsius": "$.temperature" + } } }, "configuration": { @@ -34,7 +37,8 @@ } } }, - "error": "No messages found in time range." + "error": "No messages found in time range.", + "urls": [] }, "title": "Export example-identifier of messages for device AAAA AAAA has failed.", "description": "The export example-identifier of messages for device AAAA AAAA from 2020-05-02 05:15:25Z to 2020-06-01 05:15:25Z has failed:\n\nNo messages found in time range.\n\nwell: example-tag, example-tag-2\nRequested by: user-identifier for your-organization", @@ -67,5 +71,7 @@ } } ], - "type": "EXPORT_FAILED" + "type": "EXPORT_FAILED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/export-ready.json b/event-json-examples/export-ready.json index 4690835..d5e18f6 100644 --- a/event-json-examples/export-ready.json +++ b/event-json-examples/export-ready.json @@ -61,7 +61,8 @@ } } } - } + }, + "error": "" }, "title": "Export example-identifier of messages for device AAAA AAAA is ready.", "description": "The export example-identifier of messages for device AAAA AAAA from 2020-05-02 05:15:25Z to 2020-06-01 05:15:25Z is ready to download:\n\n- export: https://example.com/export/3cr28rtrtcb23t12noex12etc1.json\n\nwell: example-tag, example-tag-2\nRequested by: user-identifier for your-organization", @@ -94,5 +95,7 @@ } } ], - "type": "EXPORT_READY" + "type": "EXPORT_READY", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/message-body-parsed.json b/event-json-examples/message-body-parsed.json index 56c5c39..8a1fa1e 100644 --- a/event-json-examples/message-body-parsed.json +++ b/event-json-examples/message-body-parsed.json @@ -66,5 +66,7 @@ "textual": "2020-06-01T07:15:25.355Z", "timeZone": "UTC" }, - "type": "MESSAGE_BODY_PARSED" + "type": "MESSAGE_BODY_PARSED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/message-body-parser-created.json b/event-json-examples/message-body-parser-created.json index 30388db..ec32094 100644 --- a/event-json-examples/message-body-parser-created.json +++ b/event-json-examples/message-body-parser-created.json @@ -6,14 +6,18 @@ "contentKsy": "example", "identifier": "example-identifier", "organization": "your-organization", + "dataFields": [], "metadataFields": { "requireMessageMetadata": { "$.fPort": 10.0 - } + }, + "messageMetadataFields": [], + "modemMetadataFields": [] }, "requireMessageMetadata": { "$.fPort": 10.0 - } + }, + "postProcessing": [] }, "title": "Message Body Parser example (example-identifier) was created.", "description": "Message Body Parser example (example-identifier) was created with the following configuration:\n\nexample", @@ -30,5 +34,8 @@ "timeZone": "UTC" }, "title": "Message Body Parser example (example-identifier) was created.", - "description": "Message Body Parser example (example-identifier) was created with the following configuration:\n\nexample" + "description": "Message Body Parser example (example-identifier) was created with the following configuration:\n\nexample", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/message-body-parser-deleted.json b/event-json-examples/message-body-parser-deleted.json index d536da1..acc9ff1 100644 --- a/event-json-examples/message-body-parser-deleted.json +++ b/event-json-examples/message-body-parser-deleted.json @@ -17,5 +17,8 @@ "timeZone": "UTC" }, "title": "Message Body Parser example-identifier was deleted.", - "description": "Message Body Parser example-identifier was deleted." + "description": "Message Body Parser example-identifier was deleted.", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/message-body-parser-updated.json b/event-json-examples/message-body-parser-updated.json index b7e26d2..3c2b6e9 100644 --- a/event-json-examples/message-body-parser-updated.json +++ b/event-json-examples/message-body-parser-updated.json @@ -21,5 +21,8 @@ "timeZone": "UTC" }, "title": "Message Body Parser example-identifier was updated.", - "description": "Message Body Parser example-identifier was updated:\n\n- The name was changed from example-old to example.\n\n- The metadata fields were updated.\n\n- The device metadata fields were updated.\n\n- The require metadata fields were updated." + "description": "Message Body Parser example-identifier was updated:\n\n- The name was changed from example-old to example.\n\n- The metadata fields were updated.\n\n- The device metadata fields were updated.\n\n- The require metadata fields were updated.", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/message-body-received.json b/event-json-examples/message-body-received.json index e8f6b3e..05752ad 100644 --- a/event-json-examples/message-body-received.json +++ b/event-json-examples/message-body-received.json @@ -65,5 +65,7 @@ "textual": "2020-06-01T06:15:25.355Z", "timeZone": "UTC" }, - "type": "MESSAGE_BODY_RECEIVED" + "type": "MESSAGE_BODY_RECEIVED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/message-cannot-be-parsed.json b/event-json-examples/message-cannot-be-parsed.json index e9ee89c..7c51ed7 100644 --- a/event-json-examples/message-cannot-be-parsed.json +++ b/event-json-examples/message-cannot-be-parsed.json @@ -80,5 +80,6 @@ "catchAll": true, "severity": "3" }, - "resolveIdentifier": "resolve-15-1127000000000000" + "resolveIdentifier": "resolve-15-1127000000000000", + "isWarning": false } diff --git a/event-json-examples/message-received.json b/event-json-examples/message-received.json index d9d4933..82a7d70 100644 --- a/event-json-examples/message-received.json +++ b/event-json-examples/message-received.json @@ -45,6 +45,9 @@ "bodyFields": { "text": "example" }, + "isTest": false, + "isGatewayMessage": false, + "viaGatewayMessage": "10002", "tags": [ { "id": "1", @@ -119,5 +122,7 @@ "textual": "2020-06-01T06:15:25.365Z", "timeZone": "UTC" }, - "type": "MESSAGE_RECEIVED" + "type": "MESSAGE_RECEIVED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/message-summary.json b/event-json-examples/message-summary.json index e2aeb1d..5f6bf04 100644 --- a/event-json-examples/message-summary.json +++ b/event-json-examples/message-summary.json @@ -4,7 +4,8 @@ "messageCount": [ { "device": "AAAA AAAA", - "amount": 10 + "amount": 10, + "source": "HIBERBAND" } ], "title": "Device message summary from 2020-05-31 05:15:25Z to 2020-06-01 05:15:25Z.", @@ -34,5 +35,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "MESSAGE_SUMMARY" + "type": "MESSAGE_SUMMARY", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/organization-created.json b/event-json-examples/organization-created.json index 696b1cd..d63c8ad 100644 --- a/event-json-examples/organization-created.json +++ b/event-json-examples/organization-created.json @@ -12,6 +12,7 @@ "state": "your-state", "country": "NL" }, + "billingName": "example", "billingAddress": { "lines": ["address line 1", "address line 2"], "zipCode": "your-postal-code", @@ -33,7 +34,8 @@ }, "features": [ "HIBER" - ] + ], + "databaseInfo": "" }, "title": "Organization Your Organization 2 (your-organization-2) was created.", "description": "Organization Your Organization 2 (your-organization-2) was created under your-organization.", @@ -50,5 +52,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "ORGANIZATION_CREATED" + "type": "ORGANIZATION_CREATED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/organization-deleted.json b/event-json-examples/organization-deleted.json index 54609ff..b08a557 100644 --- a/event-json-examples/organization-deleted.json +++ b/event-json-examples/organization-deleted.json @@ -17,5 +17,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "ORGANIZATION_DELETED" + "type": "ORGANIZATION_DELETED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/organization-event-configuration-updated.json b/event-json-examples/organization-event-configuration-updated.json index 7660bd9..d2aacea 100644 --- a/event-json-examples/organization-event-configuration-updated.json +++ b/event-json-examples/organization-event-configuration-updated.json @@ -22,5 +22,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "ORGANIZATION_EVENT_CONFIGURATION_UPDATED" + "type": "ORGANIZATION_EVENT_CONFIGURATION_UPDATED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/organization-updated.json b/event-json-examples/organization-updated.json index 0760b17..9f34443 100644 --- a/event-json-examples/organization-updated.json +++ b/event-json-examples/organization-updated.json @@ -18,6 +18,8 @@ "email": "new-email", "phone": "your-phone" }, + "featuresAdded": [], + "featuresRemoved": [], "title": "Organization data for your-organization was updated.", "description": "Organization data for your-organization was updated:\n\n- Display name was changed from 'Your Organization' to 'new-Your Organization'.\n\n- VatNumber was changed from 'your-vat-number' to 'new-vat-number'.\n\n- Address was changed.\n\n- Contact was changed to 'your-name'.", "time": { @@ -33,5 +35,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "ORGANIZATION_UPDATED" + "type": "ORGANIZATION_UPDATED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/publisher-auto-disabled.json b/event-json-examples/publisher-auto-disabled.json index 6a8cd44..299ab64 100644 --- a/event-json-examples/publisher-auto-disabled.json +++ b/event-json-examples/publisher-auto-disabled.json @@ -70,5 +70,6 @@ "type": "well" } } - ] + ], + "isWarning": false } diff --git a/event-json-examples/publisher-created.json b/event-json-examples/publisher-created.json index 9c03b4e..c7ad033 100644 --- a/event-json-examples/publisher-created.json +++ b/event-json-examples/publisher-created.json @@ -1,4 +1,5 @@ { + "isError": false, "publisherCreated": { "organization": "your-organization", "created": { @@ -7,23 +8,28 @@ "deprecatedData": { "url": "https://example.com/my-webhook", "contentType": "JSON", - "certificateId": "1", + "disabled": false, "http": { "secret": "my-secret" - } + }, + "certificateId": "1" }, "filters": { "eventTypes": { "include": [ "MESSAGE_RECEIVED" - ] + ], + "exclude": [] }, "modemNumbers": { "include": [ "AAAA AAAA" - ] + ], + "exclude": [] }, "tags": { + "include": [], + "exclude": [] } }, "tags": [ @@ -42,14 +48,20 @@ } } ], + "health": "OK", + "type": "HTTP", "inCooldownUntil": { }, + "disabled": false, "http": { "url": "https://example.com/my-webhook", "secret": "my-secret", "contentType": "JSON", + "disabled": false, "certificateId": "1", - "hmacHeaderName": "X-Hub-Signature" + "hmacHeaderName": "X-Hub-Signature", + "customHeaders": { + } }, "createdBy": "example-identifier" }, @@ -73,17 +85,19 @@ "description": "A new Webhook at https://example.com/my-webhook (id 10001) was created:\n\nexample\n\nwell: example-tag, example-tag-2", "time": { "timestamp": "2020-06-01T05:15:25.355Z", - "textual": "2020-06-01T05:15:25.355Z", - "timeZone": "UTC" + "timeZone": "UTC", + "textual": "2020-06-01T05:15:25.355Z" } }, - "title": "Webhook at https://example.com/my-webhook has been created with id 10001.", - "description": "A new Webhook at https://example.com/my-webhook (id 10001) was created:\n\nexample\n\nwell: example-tag, example-tag-2", + "type": "PUBLISHER_CREATED", "time": { "timestamp": "2020-06-01T05:15:25.355Z", - "textual": "2020-06-01T05:15:25.355Z", - "timeZone": "UTC" + "timeZone": "UTC", + "textual": "2020-06-01T05:15:25.355Z" }, + "isWarning": false, + "title": "Webhook at https://example.com/my-webhook has been created with id 10001.", + "description": "A new Webhook at https://example.com/my-webhook (id 10001) was created:\n\nexample\n\nwell: example-tag, example-tag-2", "tags": [ { "id": "1", @@ -99,6 +113,5 @@ "type": "well" } } - ], - "type": "PUBLISHER_CREATED" + ] } diff --git a/event-json-examples/publisher-deleted.json b/event-json-examples/publisher-deleted.json index 0acc692..e21e93d 100644 --- a/event-json-examples/publisher-deleted.json +++ b/event-json-examples/publisher-deleted.json @@ -4,26 +4,34 @@ "deleted": { "id": "10001", "description": "example", + "type": "HTTP", + "health": "OK", + "disabled": false, "deprecatedData": { "url": "https://example.com/my-webhook", "contentType": "JSON", "certificateId": "1", "http": { "secret": "my-secret" - } + }, + "disabled": false }, "filters": { "eventTypes": { "include": [ "MESSAGE_RECEIVED" - ] + ], + "exclude": [] }, "modemNumbers": { "include": [ "AAAA AAAA" - ] + ], + "exclude": [] }, "tags": { + "include": [], + "exclude": [] } }, "tags": [ @@ -49,7 +57,10 @@ "secret": "my-secret", "contentType": "JSON", "certificateId": "1", - "hmacHeaderName": "X-Hub-Signature" + "hmacHeaderName": "X-Hub-Signature", + "disabled": false, + "customHeaders": { + } }, "createdBy": "example-identifier" }, @@ -100,5 +111,7 @@ } } ], - "type": "PUBLISHER_DELETED" + "type": "PUBLISHER_DELETED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/publisher-failed.json b/event-json-examples/publisher-failed.json index 79341cd..2a2d21b 100644 --- a/event-json-examples/publisher-failed.json +++ b/event-json-examples/publisher-failed.json @@ -1,5 +1,5 @@ { - "isWarning": true, + "isError": false, "publisherFailed": { "organization": "your-organization", "reason": "the request timed out", @@ -9,6 +9,7 @@ "deprecatedData": { "url": "https://example.com/my-webhook", "contentType": "JSON", + "disabled": false, "certificateId": "1", "http": { "secret": "my-secret" @@ -18,14 +19,18 @@ "eventTypes": { "include": [ "MESSAGE_RECEIVED" - ] + ], + "exclude": [] }, "modemNumbers": { "include": [ "AAAA AAAA" - ] + ], + "exclude": [] }, "tags": { + "include": [], + "exclude": [] } }, "tags": [ @@ -44,26 +49,23 @@ } } ], + "health": "OK", + "type": "HTTP", "inCooldownUntil": { }, + "disabled": false, "http": { "url": "https://example.com/my-webhook", "secret": "my-secret", "contentType": "JSON", + "disabled": false, "certificateId": "1", - "hmacHeaderName": "X-Hub-Signature" + "hmacHeaderName": "X-Hub-Signature", + "customHeaders": { + } }, "createdBy": "example-identifier" }, - "healthLevel": { - "level": "Build up", - "color": "orange", - "colorData": { - "fill": "orange", - "text": "orange" - }, - "severity": "2" - }, "tags": [ { "id": "1", @@ -84,27 +86,39 @@ "description": "Webhook at https://example.com/my-webhook (id 10001) has failed:\n\nthe request timed out\n\nwell: example-tag, example-tag-2", "time": { "timestamp": "2020-06-01T05:15:25.355Z", - "textual": "2020-06-01T05:15:25.355Z", - "timeZone": "UTC" + "timeZone": "UTC", + "textual": "2020-06-01T05:15:25.355Z" + }, + "healthLevel": { + "level": "Build up", + "color": "orange", + "catchAll": false, + "colorData": { + "fill": "orange", + "text": "orange" + }, + "severity": "2" } }, - "title": "Webhook at https://example.com/my-webhook (id 10001) has failed!", - "description": "Webhook at https://example.com/my-webhook (id 10001) has failed:\n\nthe request timed out\n\nwell: example-tag, example-tag-2", + "type": "PUBLISHER_FAILED", "time": { "timestamp": "2020-06-01T05:15:25.355Z", - "textual": "2020-06-01T05:15:25.355Z", - "timeZone": "UTC" + "timeZone": "UTC", + "textual": "2020-06-01T05:15:25.355Z" }, - "type": "PUBLISHER_FAILED", + "isWarning": true, "healthLevel": { "level": "Build up", "color": "orange", + "catchAll": false, "colorData": { "fill": "orange", "text": "orange" }, "severity": "2" }, + "title": "Webhook at https://example.com/my-webhook (id 10001) has failed!", + "description": "Webhook at https://example.com/my-webhook (id 10001) has failed:\n\nthe request timed out\n\nwell: example-tag, example-tag-2", "tags": [ { "id": "1", diff --git a/event-json-examples/publisher-updated.json b/event-json-examples/publisher-updated.json index 60852e7..15668a9 100644 --- a/event-json-examples/publisher-updated.json +++ b/event-json-examples/publisher-updated.json @@ -61,5 +61,7 @@ } } ], - "type": "PUBLISHER_UPDATED" + "type": "PUBLISHER_UPDATED", + "isError": false, + "isWarning": false } diff --git a/event-json-examples/token-created.json b/event-json-examples/token-created.json index ded57b7..893f6a1 100644 --- a/event-json-examples/token-created.json +++ b/event-json-examples/token-created.json @@ -3,6 +3,7 @@ "organization": "your-organization", "token": { "id": "1", + "type": "SPECIFIC", "name": "your-token", "userId": "user-identifier", "organization": "your-organization", @@ -20,9 +21,13 @@ "USERS", "USERS_MANAGE" ], + "roles": [], "userDetails": { - "id": "user-identifier" - } + "id": "user-identifier", + "name": "", + "email": "" + }, + "usedForThisCall": false }, "title": "Token your-token (id 1) was created.", "description": "Token your-token (id 1) was created.", @@ -39,5 +44,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "TOKEN_CREATED" + "type": "TOKEN_CREATED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/token-deleted.json b/event-json-examples/token-deleted.json index a2ada91..1dd987f 100644 --- a/event-json-examples/token-deleted.json +++ b/event-json-examples/token-deleted.json @@ -3,6 +3,7 @@ "organization": "your-organization", "token": { "id": "1", + "type": "SPECIFIC", "name": "your-token", "userId": "user-identifier", "organization": "your-organization", @@ -20,9 +21,13 @@ "USERS", "USERS_MANAGE" ], + "roles": [], "userDetails": { - "id": "user-identifier" - } + "id": "user-identifier", + "name": "", + "email": "" + }, + "usedForThisCall": false }, "title": "Token your-token (id 1) was deleted.", "description": "Token your-token (id 1) was deleted.", @@ -39,5 +44,8 @@ "textual": "2020-06-01T08:15:25.355Z", "timeZone": "UTC" }, - "type": "TOKEN_DELETED" + "type": "TOKEN_DELETED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/token-expired.json b/event-json-examples/token-expired.json index e4aa3f7..98de0df 100644 --- a/event-json-examples/token-expired.json +++ b/event-json-examples/token-expired.json @@ -3,6 +3,7 @@ "organization": "your-organization", "token": { "id": "1", + "type": "SPECIFIC", "name": "your-token", "userId": "user-identifier", "organization": "your-organization", @@ -20,9 +21,13 @@ "USERS", "USERS_MANAGE" ], + "roles": [], "userDetails": { - "id": "user-identifier" - } + "id": "user-identifier", + "name": "", + "email": "" + }, + "usedForThisCall": false }, "title": "Token your-token (id 1) has expired.", "description": "Token your-token (id 1) has expired.", @@ -39,5 +44,8 @@ "textual": "2020-06-04T05:15:25.355Z", "timeZone": "UTC" }, - "type": "TOKEN_EXPIRED" + "type": "TOKEN_EXPIRED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/token-expiry-warning.json b/event-json-examples/token-expiry-warning.json index 5bdad5a..08736eb 100644 --- a/event-json-examples/token-expiry-warning.json +++ b/event-json-examples/token-expiry-warning.json @@ -5,6 +5,7 @@ "organization": "your-organization", "token": { "id": "1", + "type": "SPECIFIC", "name": "your-token", "userId": "user-identifier", "organization": "your-organization", @@ -22,9 +23,13 @@ "USERS", "USERS_MANAGE" ], + "roles": [], "userDetails": { - "id": "user-identifier" - } + "id": "user-identifier", + "name": "", + "email": "" + }, + "usedForThisCall": false }, "title": "Token your-token (id 1) will expire in 14 days.", "description": "Token your-token (id 1) will expire in 14 days.", @@ -40,7 +45,8 @@ "fill": "orange", "text": "orange" }, - "severity": "2" + "severity": "2", + "catchAll": false } }, "title": "Token your-token (id 1) will expire in 14 days.", @@ -58,6 +64,9 @@ "fill": "orange", "text": "orange" }, - "severity": "2" - } + "severity": "2", + "catchAll": false + }, + "isError": false, + "tags": [] } diff --git a/event-json-examples/transfer.json b/event-json-examples/transfer.json index 31ce4fd..f695ae3 100644 --- a/event-json-examples/transfer.json +++ b/event-json-examples/transfer.json @@ -28,6 +28,7 @@ "identifier": "example-identifier", "senderOrganization": "your-organization", "recipientOrganization": "your-organization-2", + "type": "DEVICES", "comment": "example", "createdAt": { "timestamp": "2020-06-01T05:15:25.355Z", @@ -69,8 +70,7 @@ "type": "well" } } - ] + ], + "isError": false, + "isWarning": false } - - - diff --git a/event-json-examples/unassigned.json b/event-json-examples/unassigned.json index 52709e3..12402c0 100644 --- a/event-json-examples/unassigned.json +++ b/event-json-examples/unassigned.json @@ -6,7 +6,8 @@ "toModem": "AAAA AAAA", "assignParser": { "identifier": "example-identifier", - "name": "example" + "name": "example", + "ownerOrganization": "your-organization" }, "start": { "timestamp": "2020-06-01T05:15:25.355Z", @@ -20,7 +21,8 @@ "timestamp": "2020-06-01T05:15:25.355Z", "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" - } + }, + "tags": [] }, "title": "Assignment of example-identifier to AAAA AAAA was removed.", "description": "Assignment of example-identifier to AAAA AAAA was removed.", @@ -34,5 +36,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "UNASSIGNED" + "type": "UNASSIGNED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/user-access-request.json b/event-json-examples/user-access-request.json index a9616ae..6a34567 100644 --- a/event-json-examples/user-access-request.json +++ b/event-json-examples/user-access-request.json @@ -17,5 +17,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "USER_ACCESS_REQUEST" + "type": "USER_ACCESS_REQUEST", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/user-added.json b/event-json-examples/user-added.json index 7a04790..4f3c485 100644 --- a/event-json-examples/user-added.json +++ b/event-json-examples/user-added.json @@ -17,5 +17,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "USER_ADDED" + "type": "USER_ADDED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/user-invited.json b/event-json-examples/user-invited.json index ebe4f3b..c106dda 100644 --- a/event-json-examples/user-invited.json +++ b/event-json-examples/user-invited.json @@ -17,5 +17,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "USER_INVITED" + "type": "USER_INVITED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/user-removed.json b/event-json-examples/user-removed.json index 188745c..48406c6 100644 --- a/event-json-examples/user-removed.json +++ b/event-json-examples/user-removed.json @@ -17,5 +17,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "USER_REMOVED" + "type": "USER_REMOVED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/event-json-examples/user-validation-updated.json b/event-json-examples/user-validation-updated.json index e78562e..8bf553e 100644 --- a/event-json-examples/user-validation-updated.json +++ b/event-json-examples/user-validation-updated.json @@ -17,5 +17,8 @@ "textual": "2020-06-01T05:15:25.355Z", "timeZone": "UTC" }, - "type": "USER_VALIDATION_UPDATED" + "type": "USER_VALIDATION_UPDATED", + "isError": false, + "isWarning": false, + "tags": [] } diff --git a/publisher.proto b/publisher.proto index 716fd83..23eb38c 100644 --- a/publisher.proto +++ b/publisher.proto @@ -79,12 +79,12 @@ message Publisher { option deprecated = true; string url = 1; - ContentType content_type = 2; - bool disabled = 3; - int64 certificate_id = 4; - string certificate_name = 5; - int64 ca_certificate_id = 6; - string ca_certificate_name = 7; + optional ContentType content_type = 2; + optional bool disabled = 3; + optional int64 certificate_id = 4; + optional string certificate_name = 5; + optional int64 ca_certificate_id = 6; + optional string ca_certificate_name = 7; oneof config { HTTPConfig http = 8; MQTTConfig mqtt = 9;