diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6206c59..7b80dca 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,18 @@
# Changelog Hiber API
+### 0.140 (2023-02-13)
+
+##### ModemMessageBodyParserService
+
+- Removed deprecated field `data_fields_deprecated`
+- Added field `metadata_fields.require_message_metadata` to replace `require_message_metadata`
+- Deprecated field `require_message_metadata`
+
+##### EventService
+
+- Changed the title and description for `ModemEvent.MessageEvent.ModemMessageCannotBeParsedEvent`
+ to reflect that this is a configuration issue that hiber support should solve.
+
### 0.139 (2023-02-06)
##### ModemService
diff --git a/docs/html/assignment.html b/docs/html/assignment.html
index cce6934..44ae331 100644
--- a/docs/html/assignment.html
+++ b/docs/html/assignment.html
@@ -1030,6 +1030,10 @@
@@ -7722,13 +7730,6 @@ ModemMessageBodyP
Data fields are cached for efficient retrieval and allow all kinds of processing.
-
- data_fields_deprecated |
- string |
- repeated |
- Deprecated. |
-
-
metadata_fields |
ModemMessageBodyParser.MetadataFields |
@@ -7747,17 +7748,18 @@ ModemMessageBodyP
post_processing |
ModemMessageBodyParser.PostProcessing |
repeated |
- The list of post-processing steps applied to the result of this parser. |
+ Deprecated. The list of post-processing steps applied to the result of this parser. |
require_message_metadata |
ModemMessageBodyParser.RequireMessageMetadataEntry |
repeated |
- In order to use this parser on a message,
+ | Deprecated. In order to use this parser on a message,
the metadata on the message must match the given requirement here.
The key of the map is the json-path to look for in the message metadata,
-the value of the map is the json to expect at that json-path. |
+the value of the map is the json to expect at that json-path.
+Deprecated: use metadata_fields.require_message_metadata
@@ -7777,7 +7779,12 @@ Fields with deprecated option
- data_fields_deprecated |
+ post_processing |
+ true |
+
+
+
+ require_message_metadata |
true |
@@ -7860,6 +7867,16 @@ Mo
from the message. If not set, sent time is used.
+
+ require_message_metadata |
+ ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry |
+ repeated |
+ In order to use this parser on a message,
+the metadata on the message must match the given requirement here.
+The key of the map is the json-path to look for in the message metadata,
+the value of the map is the json to expect at that json-path. |
+
+
@@ -7898,6 +7915,37 @@ ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry
+
+
+
+
+
+
+
+
+
ModemMessageBodyParser.RequireMessageMetadataEntry
@@ -8678,10 +8726,17 @@ string
+ optional |
+ If set, changes the name of the parser. |
+
+
content_ksy |
string |
- |
+ optional |
The new ksy definition for this parser. |
@@ -8702,7 +8757,7 @@ UpdateUploadedModemMessageBodyParserRequest.MetadataFields
- |
+ optional |
Fields in the parsed result that match special things that can be processed by the system, like a location. |
@@ -8710,67 +8765,45 @@ ModemMessageBodyParser.PostProcessing
repeated |
- Add a post-processing step to the result of this parser. |
+ Deprecated. Add a post-processing step to the result of this parser. |
remove_post_processing |
ModemMessageBodyParser.PostProcessing |
repeated |
- Remove a post-processing step to the result of this parser. |
-
-
-
- add_require_message_metadata |
- UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry |
- repeated |
- In order to use this parser on a message,
-the metadata on the message must match the given requirement here.
-The key of the map is the json-path to look for in the message metadata,
-the value of the map is the json to expect at that json-path. |
-
-
-
- remove_require_message_metadata |
- string |
- repeated |
- Remove a requirement for the metadata. Remove by listing the json-path here. |
+ Deprecated. Remove a post-processing step to the result of this parser. |
-
-
-
- UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry
-
-
-
-
-
- Field | Type | Label | Description |
-
-
+
+
+ Fields with deprecated option
+
+
+
+ Name |
+ Option |
+
+
+
- key |
- string |
- |
- |
+ add_post_processing |
+ true |
- value |
- google.protobuf.Value |
- |
- |
+ remove_post_processing |
+ true |
-
-
-
+
+
+
@@ -8848,6 +8881,92 @@ UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry
+ repeated |
+ In order to use this parser on a message,
+the metadata on the message must match the given requirement here.
+The key of the map is the json-path to look for in the message metadata,
+the value of the map is the json to expect at that json-path. |
+
+
+
+ remove_require_message_metadata |
+ string |
+ repeated |
+ Remove a requirement for the metadata. Remove by listing the json-path here. |
+
+
+
+ replace_require_message_metadata |
+ UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry |
+ repeated |
+ Replaces the entire configuration for required message metadata. |
+
+
+
+
+
+
+
+
+
+ UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry
+
+
+
+
+
+
+
+
+
+ UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry
+
+
+
+
diff --git a/docs/html/modem_claim.html b/docs/html/modem_claim.html
index 628307a..475e2c3 100644
--- a/docs/html/modem_claim.html
+++ b/docs/html/modem_claim.html
@@ -742,7 +742,7 @@ ModemClaimSelection
ModemClaimService
- Claim a modem that you have in your possession, but was not marked as inbound for you.
This is only possible for a modem that has not been activated.
This process is instantaneous, but the previous owner can reject the claim afterwards.
This service is deprecated and will be removed in the future. In some cases, it may be disabled before it is removed.
// TODO(2023-01-31) remove this service from the API before this date
+ Claim a modem that you have in your possession, but was not marked as inbound for you.
This is only possible for a modem that has not been activated.
This process is instantaneous, but the previous owner can reject the claim afterwards.
This service is deprecated and will be removed in the future. In some cases, it may be disabled before it is removed.
// TODO(2023-03-01) remove this service from the API before this date
Method Name | Request Type | Response Type | Description |
diff --git a/docs/html/modem_message_body_parser.html b/docs/html/modem_message_body_parser.html
index 97d7805..d598c1c 100644
--- a/docs/html/modem_message_body_parser.html
+++ b/docs/html/modem_message_body_parser.html
@@ -238,6 +238,10 @@ Table of Contents
MModemMessageBodyParser.MetadataFields.LocationFields
+
+ MModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry
+
+
MModemMessageBodyParser.RequireMessageMetadataEntry
@@ -323,11 +327,15 @@ Table of Contents
- MUpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry
+ MUpdateUploadedModemMessageBodyParserRequest.MetadataFields
- MUpdateUploadedModemMessageBodyParserRequest.MetadataFields
+ MUpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry
+
+
+
+ MUpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry
@@ -1220,13 +1228,6 @@ ModemMessageBodyP
Data fields are cached for efficient retrieval and allow all kinds of processing.
-
- data_fields_deprecated |
- string |
- repeated |
- Deprecated. |
-
-
metadata_fields |
ModemMessageBodyParser.MetadataFields |
@@ -1245,17 +1246,18 @@ ModemMessageBodyP
post_processing |
ModemMessageBodyParser.PostProcessing |
repeated |
- The list of post-processing steps applied to the result of this parser. |
+ Deprecated. The list of post-processing steps applied to the result of this parser. |
require_message_metadata |
ModemMessageBodyParser.RequireMessageMetadataEntry |
repeated |
- In order to use this parser on a message,
+ | Deprecated. In order to use this parser on a message,
the metadata on the message must match the given requirement here.
The key of the map is the json-path to look for in the message metadata,
-the value of the map is the json to expect at that json-path. |
+the value of the map is the json to expect at that json-path.
+Deprecated: use metadata_fields.require_message_metadata
@@ -1275,7 +1277,12 @@ Fields with deprecated option
- data_fields_deprecated |
+ post_processing |
+ true |
+
+
+
+ require_message_metadata |
true |
@@ -1358,6 +1365,16 @@ Mo
from the message. If not set, sent time is used.
+
+ require_message_metadata |
+ ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry |
+ repeated |
+ In order to use this parser on a message,
+the metadata on the message must match the given requirement here.
+The key of the map is the json-path to look for in the message metadata,
+the value of the map is the json to expect at that json-path. |
+
+
@@ -1396,6 +1413,37 @@ ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry
+
+
+
+
+
+
+
+
+
ModemMessageBodyParser.RequireMessageMetadataEntry
@@ -2176,10 +2224,17 @@ string
+ optional |
+ If set, changes the name of the parser. |
+
+
content_ksy |
string |
- |
+ optional |
The new ksy definition for this parser. |
@@ -2200,7 +2255,7 @@ UpdateUploadedModemMessageBodyParserRequest.MetadataFields
- |
+ optional |
Fields in the parsed result that match special things that can be processed by the system, like a location. |
@@ -2208,67 +2263,45 @@ ModemMessageBodyParser.PostProcessing
repeated |
- Add a post-processing step to the result of this parser. |
+ Deprecated. Add a post-processing step to the result of this parser. |
remove_post_processing |
ModemMessageBodyParser.PostProcessing |
repeated |
- Remove a post-processing step to the result of this parser. |
-
-
-
- add_require_message_metadata |
- UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry |
- repeated |
- In order to use this parser on a message,
-the metadata on the message must match the given requirement here.
-The key of the map is the json-path to look for in the message metadata,
-the value of the map is the json to expect at that json-path. |
-
-
-
- remove_require_message_metadata |
- string |
- repeated |
- Remove a requirement for the metadata. Remove by listing the json-path here. |
+ Deprecated. Remove a post-processing step to the result of this parser. |
-
-
-
- UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry
-
-
-
-
-
- Field | Type | Label | Description |
-
-
+
+
+ Fields with deprecated option
+
+
+
+ Name |
+ Option |
+
+
+
- key |
- string |
- |
- |
+ add_post_processing |
+ true |
- value |
- google.protobuf.Value |
- |
- |
+ remove_post_processing |
+ true |
-
-
-
+
+
+
@@ -2346,6 +2379,92 @@ UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry
+ repeated |
+ In order to use this parser on a message,
+the metadata on the message must match the given requirement here.
+The key of the map is the json-path to look for in the message metadata,
+the value of the map is the json to expect at that json-path. |
+
+
+
+ remove_require_message_metadata |
+ string |
+ repeated |
+ Remove a requirement for the metadata. Remove by listing the json-path here. |
+
+
+
+ replace_require_message_metadata |
+ UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry |
+ repeated |
+ Replaces the entire configuration for required message metadata. |
+
+
+
+
+
+
+
+
+
+ UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry
+
+
+
+
+
+
+
+
+
+ UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry
+
+
+
+
diff --git a/docs/md/assignment.md b/docs/md/assignment.md
index 2329120..a5a2065 100644
--- a/docs/md/assignment.md
+++ b/docs/md/assignment.md
@@ -125,6 +125,7 @@
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.AvailableToChildOrganizations](#hibermodemmessagebodyparsermodemmessagebodyparseravailabletochildorganizations)
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafields)
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.LocationFields](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafieldslocationfields)
+ - [hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafieldsrequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparserrequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.ModemMessageBodyParserSelection](#hibermodemmessagebodyparsermodemmessagebodyparserselection)
- [hiber.modem.message.bodyparser.RenameModemMessageBodyParserRequest](#hibermodemmessagebodyparserrenamemodemmessagebodyparserrequest)
@@ -146,8 +147,9 @@
- [hiber.modem.message.bodyparser.UpdateChildOrganizationAvailabilityRequest](#hibermodemmessagebodyparserupdatechildorganizationavailabilityrequest)
- [hiber.modem.message.bodyparser.UpdateSimpleModemMessageBodyParserRequest](#hibermodemmessagebodyparserupdatesimplemodemmessagebodyparserrequest)
- [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequest)
- - [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestaddrequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafields)
+ - [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsaddrequiremessagemetadataentry)
+ - [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsreplacerequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.UploadModemMessageBodyParserRequest](#hibermodemmessagebodyparseruploadmodemmessagebodyparserrequest)
- [hiber.modem.message.bodyparser.UploadModemMessageBodyParserRequest.RequireMessageMetadataEntry](#hibermodemmessagebodyparseruploadmodemmessagebodyparserrequestrequiremessagemetadataentry)
@@ -1488,11 +1490,10 @@ A parser can be defined in two ways: using a .ksy (Kaitai struct https://kaitai.
| content_ksy | [ string](#string) | The content of this parsers script. If simple_parser is set, this content is generated from that definition. This field may be omitted by the list call to save data. |
| simple_parser | [ hiber.modem.message.bodyparser.SimpleModemMessageBodyParser](#hibermodemmessagebodyparsersimplemodemmessagebodyparser) | The simple parser this .ksy was generated from, if it was generated from a simple parser. This field may be omitted on demand to save data in the list call. |
| data_fields | [repeated hiber.field.Field](#hiberfieldfield) | Fields in the parsed result that contain data. Data fields are cached for efficient retrieval and allow all kinds of processing. |
-| data_fields_deprecated | [repeated string](#string) | none |
| metadata_fields | [ hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafields) | Fields in the parsed result that contain metadata, and special things like a location. |
| available_to_child_organizations | [ hiber.modem.message.bodyparser.ModemMessageBodyParser.AvailableToChildOrganizations](#hibermodemmessagebodyparsermodemmessagebodyparseravailabletochildorganizations) | If set, this parser is available to your child organizations, as a Provided parser. |
| post_processing | [repeated hiber.modem.message.bodyparser.ModemMessageBodyParser.PostProcessing](#hibermodemmessagebodyparsermodemmessagebodyparserpostprocessing) | The list of post-processing steps applied to the result of this parser. |
-| require_message_metadata | [map hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparserrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
+| require_message_metadata | [map hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparserrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. Deprecated: use metadata_fields.require_message_metadata |
### hiber.modem.message.bodyparser.ModemMessageBodyParser.AvailableToChildOrganizations
@@ -1515,6 +1516,7 @@ like a location or battery percentage.
| modem_metadata_fields | [repeated string](#string) | Custom metadata fields, which will be added to the modem metadata json. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_time_field | [ string](#string) | Field that contains the time (epoch seconds) to use for the values extracted from the message. If not set, sent time is used. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_offset_field | [ string](#string) | Field that contains the time offset (second before sent time) to use for the values extracted from the message. If not set, sent time is used. |
+| require_message_metadata | [map hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafieldsrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
### hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.LocationFields
@@ -1525,6 +1527,15 @@ like a location or battery percentage.
| latitude | [ string](#string) | none |
| longitude | [ string](#string) | none |
+### hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
+
### hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry
@@ -1743,23 +1754,13 @@ Upload an updated body parser from a .ksy file, replacing the previous file.
| ----- | ---- | ----------- |
| organization | [ string](#string) | Pick the organization to use (/impersonate). If unset, your default organization is used. |
| identifier | [ string](#string) | The identifier of the parser that should be updated. |
-| content_ksy | [ string](#string) | The new ksy definition for this parser. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_name**.name | [optional string](#string) | If set, changes the name of the parser. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_content_ksy**.content_ksy | [optional string](#string) | The new ksy definition for this parser. |
| add_data_fields | [repeated hiber.field.Field](#hiberfieldfield) | Add fields to the data fields list. |
| remove_data_fields | [repeated string](#string) | Remove fields from the data fields list. |
-| metadata_fields | [ hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafields) | Fields in the parsed result that match special things that can be processed by the system, like a location. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_metadata_fields**.metadata_fields | [optional hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafields) | Fields in the parsed result that match special things that can be processed by the system, like a location. |
| add_post_processing | [repeated hiber.modem.message.bodyparser.ModemMessageBodyParser.PostProcessing](#hibermodemmessagebodyparsermodemmessagebodyparserpostprocessing) | Add a post-processing step to the result of this parser. |
| remove_post_processing | [repeated hiber.modem.message.bodyparser.ModemMessageBodyParser.PostProcessing](#hibermodemmessagebodyparsermodemmessagebodyparserpostprocessing) | Remove a post-processing step to the result of this parser. |
-| add_require_message_metadata | [map hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestaddrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
-| remove_require_message_metadata | [repeated string](#string) | Remove a requirement for the metadata. Remove by listing the json-path here. |
-
-### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| key | [ string](#string) | none |
-| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields
@@ -1776,6 +1777,27 @@ Upload an updated body parser from a .ksy file, replacing the previous file.
| replace_modem_metadata_fields | [repeated string](#string) | Replace the modem metadata fields list. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_time_field | [ hiber.UpdateClearableString](#hiberupdateclearablestring) | Update the custom field to extract to measured_at time. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_offset_field | [ hiber.UpdateClearableString](#hiberupdateclearablestring) | Update the custom field to extract to measured_at offset from the sent_at time in seconds. |
+| add_require_message_metadata | [map hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsaddrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
+| remove_require_message_metadata | [repeated string](#string) | Remove a requirement for the metadata. Remove by listing the json-path here. |
+| replace_require_message_metadata | [map hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsreplacerequiremessagemetadataentry) | Replaces the entire configuration for required message metadata. |
+
+### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
+
+### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
### hiber.modem.message.bodyparser.UploadModemMessageBodyParserRequest
diff --git a/docs/md/event.md b/docs/md/event.md
index b829832..4ded8c1 100644
--- a/docs/md/event.md
+++ b/docs/md/event.md
@@ -282,6 +282,7 @@
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.AvailableToChildOrganizations](#hibermodemmessagebodyparsermodemmessagebodyparseravailabletochildorganizations)
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafields)
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.LocationFields](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafieldslocationfields)
+ - [hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafieldsrequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparserrequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.ModemMessageBodyParserSelection](#hibermodemmessagebodyparsermodemmessagebodyparserselection)
- [hiber.modem.message.bodyparser.RenameModemMessageBodyParserRequest](#hibermodemmessagebodyparserrenamemodemmessagebodyparserrequest)
@@ -303,8 +304,9 @@
- [hiber.modem.message.bodyparser.UpdateChildOrganizationAvailabilityRequest](#hibermodemmessagebodyparserupdatechildorganizationavailabilityrequest)
- [hiber.modem.message.bodyparser.UpdateSimpleModemMessageBodyParserRequest](#hibermodemmessagebodyparserupdatesimplemodemmessagebodyparserrequest)
- [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequest)
- - [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestaddrequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafields)
+ - [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsaddrequiremessagemetadataentry)
+ - [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsreplacerequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.UploadModemMessageBodyParserRequest](#hibermodemmessagebodyparseruploadmodemmessagebodyparserrequest)
- [hiber.modem.message.bodyparser.UploadModemMessageBodyParserRequest.RequireMessageMetadataEntry](#hibermodemmessagebodyparseruploadmodemmessagebodyparserrequestrequiremessagemetadataentry)
@@ -3569,11 +3571,10 @@ A parser can be defined in two ways: using a .ksy (Kaitai struct https://kaitai.
| content_ksy | [ string](#string) | The content of this parsers script. If simple_parser is set, this content is generated from that definition. This field may be omitted by the list call to save data. |
| simple_parser | [ hiber.modem.message.bodyparser.SimpleModemMessageBodyParser](#hibermodemmessagebodyparsersimplemodemmessagebodyparser) | The simple parser this .ksy was generated from, if it was generated from a simple parser. This field may be omitted on demand to save data in the list call. |
| data_fields | [repeated hiber.field.Field](#hiberfieldfield) | Fields in the parsed result that contain data. Data fields are cached for efficient retrieval and allow all kinds of processing. |
-| data_fields_deprecated | [repeated string](#string) | none |
| metadata_fields | [ hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafields) | Fields in the parsed result that contain metadata, and special things like a location. |
| available_to_child_organizations | [ hiber.modem.message.bodyparser.ModemMessageBodyParser.AvailableToChildOrganizations](#hibermodemmessagebodyparsermodemmessagebodyparseravailabletochildorganizations) | If set, this parser is available to your child organizations, as a Provided parser. |
| post_processing | [repeated hiber.modem.message.bodyparser.ModemMessageBodyParser.PostProcessing](#hibermodemmessagebodyparsermodemmessagebodyparserpostprocessing) | The list of post-processing steps applied to the result of this parser. |
-| require_message_metadata | [map hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparserrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
+| require_message_metadata | [map hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparserrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. Deprecated: use metadata_fields.require_message_metadata |
### hiber.modem.message.bodyparser.ModemMessageBodyParser.AvailableToChildOrganizations
@@ -3596,6 +3597,7 @@ like a location or battery percentage.
| modem_metadata_fields | [repeated string](#string) | Custom metadata fields, which will be added to the modem metadata json. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_time_field | [ string](#string) | Field that contains the time (epoch seconds) to use for the values extracted from the message. If not set, sent time is used. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_offset_field | [ string](#string) | Field that contains the time offset (second before sent time) to use for the values extracted from the message. If not set, sent time is used. |
+| require_message_metadata | [map hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafieldsrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
### hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.LocationFields
@@ -3606,6 +3608,15 @@ like a location or battery percentage.
| latitude | [ string](#string) | none |
| longitude | [ string](#string) | none |
+### hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
+
### hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry
@@ -3824,23 +3835,13 @@ Upload an updated body parser from a .ksy file, replacing the previous file.
| ----- | ---- | ----------- |
| organization | [ string](#string) | Pick the organization to use (/impersonate). If unset, your default organization is used. |
| identifier | [ string](#string) | The identifier of the parser that should be updated. |
-| content_ksy | [ string](#string) | The new ksy definition for this parser. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_name**.name | [optional string](#string) | If set, changes the name of the parser. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_content_ksy**.content_ksy | [optional string](#string) | The new ksy definition for this parser. |
| add_data_fields | [repeated hiber.field.Field](#hiberfieldfield) | Add fields to the data fields list. |
| remove_data_fields | [repeated string](#string) | Remove fields from the data fields list. |
-| metadata_fields | [ hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafields) | Fields in the parsed result that match special things that can be processed by the system, like a location. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_metadata_fields**.metadata_fields | [optional hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafields) | Fields in the parsed result that match special things that can be processed by the system, like a location. |
| add_post_processing | [repeated hiber.modem.message.bodyparser.ModemMessageBodyParser.PostProcessing](#hibermodemmessagebodyparsermodemmessagebodyparserpostprocessing) | Add a post-processing step to the result of this parser. |
| remove_post_processing | [repeated hiber.modem.message.bodyparser.ModemMessageBodyParser.PostProcessing](#hibermodemmessagebodyparsermodemmessagebodyparserpostprocessing) | Remove a post-processing step to the result of this parser. |
-| add_require_message_metadata | [map hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestaddrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
-| remove_require_message_metadata | [repeated string](#string) | Remove a requirement for the metadata. Remove by listing the json-path here. |
-
-### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| key | [ string](#string) | none |
-| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields
@@ -3857,6 +3858,27 @@ Upload an updated body parser from a .ksy file, replacing the previous file.
| replace_modem_metadata_fields | [repeated string](#string) | Replace the modem metadata fields list. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_time_field | [ hiber.UpdateClearableString](#hiberupdateclearablestring) | Update the custom field to extract to measured_at time. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_offset_field | [ hiber.UpdateClearableString](#hiberupdateclearablestring) | Update the custom field to extract to measured_at offset from the sent_at time in seconds. |
+| add_require_message_metadata | [map hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsaddrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
+| remove_require_message_metadata | [repeated string](#string) | Remove a requirement for the metadata. Remove by listing the json-path here. |
+| replace_require_message_metadata | [map hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsreplacerequiremessagemetadataentry) | Replaces the entire configuration for required message metadata. |
+
+### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
+
+### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
### hiber.modem.message.bodyparser.UploadModemMessageBodyParserRequest
diff --git a/docs/md/field_service.md b/docs/md/field_service.md
index 8fb01aa..852a08e 100644
--- a/docs/md/field_service.md
+++ b/docs/md/field_service.md
@@ -65,6 +65,7 @@
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.AvailableToChildOrganizations](#hibermodemmessagebodyparsermodemmessagebodyparseravailabletochildorganizations)
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafields)
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.LocationFields](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafieldslocationfields)
+ - [hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafieldsrequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparserrequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.ModemMessageBodyParserSelection](#hibermodemmessagebodyparsermodemmessagebodyparserselection)
- [hiber.modem.message.bodyparser.RenameModemMessageBodyParserRequest](#hibermodemmessagebodyparserrenamemodemmessagebodyparserrequest)
@@ -86,8 +87,9 @@
- [hiber.modem.message.bodyparser.UpdateChildOrganizationAvailabilityRequest](#hibermodemmessagebodyparserupdatechildorganizationavailabilityrequest)
- [hiber.modem.message.bodyparser.UpdateSimpleModemMessageBodyParserRequest](#hibermodemmessagebodyparserupdatesimplemodemmessagebodyparserrequest)
- [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequest)
- - [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestaddrequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafields)
+ - [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsaddrequiremessagemetadataentry)
+ - [hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsreplacerequiremessagemetadataentry)
- [hiber.modem.message.bodyparser.UploadModemMessageBodyParserRequest](#hibermodemmessagebodyparseruploadmodemmessagebodyparserrequest)
- [hiber.modem.message.bodyparser.UploadModemMessageBodyParserRequest.RequireMessageMetadataEntry](#hibermodemmessagebodyparseruploadmodemmessagebodyparserrequestrequiremessagemetadataentry)
@@ -782,11 +784,10 @@ A parser can be defined in two ways: using a .ksy (Kaitai struct https://kaitai.
| content_ksy | [ string](#string) | The content of this parsers script. If simple_parser is set, this content is generated from that definition. This field may be omitted by the list call to save data. |
| simple_parser | [ hiber.modem.message.bodyparser.SimpleModemMessageBodyParser](#hibermodemmessagebodyparsersimplemodemmessagebodyparser) | The simple parser this .ksy was generated from, if it was generated from a simple parser. This field may be omitted on demand to save data in the list call. |
| data_fields | [repeated hiber.field.Field](#hiberfieldfield) | Fields in the parsed result that contain data. Data fields are cached for efficient retrieval and allow all kinds of processing. |
-| data_fields_deprecated | [repeated string](#string) | none |
| metadata_fields | [ hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafields) | Fields in the parsed result that contain metadata, and special things like a location. |
| available_to_child_organizations | [ hiber.modem.message.bodyparser.ModemMessageBodyParser.AvailableToChildOrganizations](#hibermodemmessagebodyparsermodemmessagebodyparseravailabletochildorganizations) | If set, this parser is available to your child organizations, as a Provided parser. |
| post_processing | [repeated hiber.modem.message.bodyparser.ModemMessageBodyParser.PostProcessing](#hibermodemmessagebodyparsermodemmessagebodyparserpostprocessing) | The list of post-processing steps applied to the result of this parser. |
-| require_message_metadata | [map hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparserrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
+| require_message_metadata | [map hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparserrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. Deprecated: use metadata_fields.require_message_metadata |
### hiber.modem.message.bodyparser.ModemMessageBodyParser.AvailableToChildOrganizations
@@ -809,6 +810,7 @@ like a location or battery percentage.
| modem_metadata_fields | [repeated string](#string) | Custom metadata fields, which will be added to the modem metadata json. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_time_field | [ string](#string) | Field that contains the time (epoch seconds) to use for the values extracted from the message. If not set, sent time is used. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_offset_field | [ string](#string) | Field that contains the time offset (second before sent time) to use for the values extracted from the message. If not set, sent time is used. |
+| require_message_metadata | [map hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry](#hibermodemmessagebodyparsermodemmessagebodyparsermetadatafieldsrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
### hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.LocationFields
@@ -819,6 +821,15 @@ like a location or battery percentage.
| latitude | [ string](#string) | none |
| longitude | [ string](#string) | none |
+### hiber.modem.message.bodyparser.ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
+
### hiber.modem.message.bodyparser.ModemMessageBodyParser.RequireMessageMetadataEntry
@@ -1037,23 +1048,13 @@ Upload an updated body parser from a .ksy file, replacing the previous file.
| ----- | ---- | ----------- |
| organization | [ string](#string) | Pick the organization to use (/impersonate). If unset, your default organization is used. |
| identifier | [ string](#string) | The identifier of the parser that should be updated. |
-| content_ksy | [ string](#string) | The new ksy definition for this parser. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_name**.name | [optional string](#string) | If set, changes the name of the parser. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_content_ksy**.content_ksy | [optional string](#string) | The new ksy definition for this parser. |
| add_data_fields | [repeated hiber.field.Field](#hiberfieldfield) | Add fields to the data fields list. |
| remove_data_fields | [repeated string](#string) | Remove fields from the data fields list. |
-| metadata_fields | [ hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafields) | Fields in the parsed result that match special things that can be processed by the system, like a location. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_metadata_fields**.metadata_fields | [optional hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafields) | Fields in the parsed result that match special things that can be processed by the system, like a location. |
| add_post_processing | [repeated hiber.modem.message.bodyparser.ModemMessageBodyParser.PostProcessing](#hibermodemmessagebodyparsermodemmessagebodyparserpostprocessing) | Add a post-processing step to the result of this parser. |
| remove_post_processing | [repeated hiber.modem.message.bodyparser.ModemMessageBodyParser.PostProcessing](#hibermodemmessagebodyparsermodemmessagebodyparserpostprocessing) | Remove a post-processing step to the result of this parser. |
-| add_require_message_metadata | [map hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestaddrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
-| remove_require_message_metadata | [repeated string](#string) | Remove a requirement for the metadata. Remove by listing the json-path here. |
-
-### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| key | [ string](#string) | none |
-| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields
@@ -1070,6 +1071,27 @@ Upload an updated body parser from a .ksy file, replacing the previous file.
| replace_modem_metadata_fields | [repeated string](#string) | Replace the modem metadata fields list. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_time_field | [ hiber.UpdateClearableString](#hiberupdateclearablestring) | Update the custom field to extract to measured_at time. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_offset_field | [ hiber.UpdateClearableString](#hiberupdateclearablestring) | Update the custom field to extract to measured_at offset from the sent_at time in seconds. |
+| add_require_message_metadata | [map hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsaddrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
+| remove_require_message_metadata | [repeated string](#string) | Remove a requirement for the metadata. Remove by listing the json-path here. |
+| replace_require_message_metadata | [map hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry](#hibermodemmessagebodyparserupdateuploadedmodemmessagebodyparserrequestmetadatafieldsreplacerequiremessagemetadataentry) | Replaces the entire configuration for required message metadata. |
+
+### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
+
+### hiber.modem.message.bodyparser.UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
### hiber.modem.message.bodyparser.UploadModemMessageBodyParserRequest
diff --git a/docs/md/modem_claim.md b/docs/md/modem_claim.md
index f5cd188..bc90a70 100644
--- a/docs/md/modem_claim.md
+++ b/docs/md/modem_claim.md
@@ -85,7 +85,7 @@ This is only possible for a modem that has not been activated.
This process is instantaneous, but the previous owner can reject the claim afterwards.
This service is deprecated and will be removed in the future. In some cases, it may be disabled before it is removed.
-// TODO(2023-01-31) remove this service from the API before this date
+// TODO(2023-03-01) remove this service from the API before this date
### Claim
> **rpc** Claim([ClaimModemRequest](#claimmodemrequest))
diff --git a/docs/md/modem_message_body_parser.md b/docs/md/modem_message_body_parser.md
index 0d5060b..9baff22 100644
--- a/docs/md/modem_message_body_parser.md
+++ b/docs/md/modem_message_body_parser.md
@@ -35,6 +35,7 @@ where you can find documentation, examples and a web IDE.
- [ModemMessageBodyParser.AvailableToChildOrganizations](#modemmessagebodyparseravailabletochildorganizations)
- [ModemMessageBodyParser.MetadataFields](#modemmessagebodyparsermetadatafields)
- [ModemMessageBodyParser.MetadataFields.LocationFields](#modemmessagebodyparsermetadatafieldslocationfields)
+ - [ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry](#modemmessagebodyparsermetadatafieldsrequiremessagemetadataentry)
- [ModemMessageBodyParser.RequireMessageMetadataEntry](#modemmessagebodyparserrequiremessagemetadataentry)
- [ModemMessageBodyParserSelection](#modemmessagebodyparserselection)
- [RenameModemMessageBodyParserRequest](#renamemodemmessagebodyparserrequest)
@@ -56,8 +57,9 @@ where you can find documentation, examples and a web IDE.
- [UpdateChildOrganizationAvailabilityRequest](#updatechildorganizationavailabilityrequest)
- [UpdateSimpleModemMessageBodyParserRequest](#updatesimplemodemmessagebodyparserrequest)
- [UpdateUploadedModemMessageBodyParserRequest](#updateuploadedmodemmessagebodyparserrequest)
- - [UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry](#updateuploadedmodemmessagebodyparserrequestaddrequiremessagemetadataentry)
- [UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#updateuploadedmodemmessagebodyparserrequestmetadatafields)
+ - [UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry](#updateuploadedmodemmessagebodyparserrequestmetadatafieldsaddrequiremessagemetadataentry)
+ - [UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry](#updateuploadedmodemmessagebodyparserrequestmetadatafieldsreplacerequiremessagemetadataentry)
- [UploadModemMessageBodyParserRequest](#uploadmodemmessagebodyparserrequest)
- [UploadModemMessageBodyParserRequest.RequireMessageMetadataEntry](#uploadmodemmessagebodyparserrequestrequiremessagemetadataentry)
@@ -351,11 +353,10 @@ A parser can be defined in two ways: using a .ksy (Kaitai struct https://kaitai.
| content_ksy | [ string](#string) | The content of this parsers script. If simple_parser is set, this content is generated from that definition. This field may be omitted by the list call to save data. |
| simple_parser | [ SimpleModemMessageBodyParser](#simplemodemmessagebodyparser) | The simple parser this .ksy was generated from, if it was generated from a simple parser. This field may be omitted on demand to save data in the list call. |
| data_fields | [repeated hiber.field.Field](#hiberfieldfield) | Fields in the parsed result that contain data. Data fields are cached for efficient retrieval and allow all kinds of processing. |
-| data_fields_deprecated | [repeated string](#string) | none |
| metadata_fields | [ ModemMessageBodyParser.MetadataFields](#modemmessagebodyparsermetadatafields) | Fields in the parsed result that contain metadata, and special things like a location. |
| available_to_child_organizations | [ ModemMessageBodyParser.AvailableToChildOrganizations](#modemmessagebodyparseravailabletochildorganizations) | If set, this parser is available to your child organizations, as a Provided parser. |
| post_processing | [repeated ModemMessageBodyParser.PostProcessing](#modemmessagebodyparserpostprocessing) | The list of post-processing steps applied to the result of this parser. |
-| require_message_metadata | [map ModemMessageBodyParser.RequireMessageMetadataEntry](#modemmessagebodyparserrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
+| require_message_metadata | [map ModemMessageBodyParser.RequireMessageMetadataEntry](#modemmessagebodyparserrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. Deprecated: use metadata_fields.require_message_metadata |
### ModemMessageBodyParser.AvailableToChildOrganizations
@@ -378,6 +379,7 @@ like a location or battery percentage.
| modem_metadata_fields | [repeated string](#string) | Custom metadata fields, which will be added to the modem metadata json. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_time_field | [ string](#string) | Field that contains the time (epoch seconds) to use for the values extracted from the message. If not set, sent time is used. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_offset_field | [ string](#string) | Field that contains the time offset (second before sent time) to use for the values extracted from the message. If not set, sent time is used. |
+| require_message_metadata | [map ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry](#modemmessagebodyparsermetadatafieldsrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
### ModemMessageBodyParser.MetadataFields.LocationFields
@@ -388,6 +390,15 @@ like a location or battery percentage.
| latitude | [ string](#string) | none |
| longitude | [ string](#string) | none |
+### ModemMessageBodyParser.MetadataFields.RequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
+
### ModemMessageBodyParser.RequireMessageMetadataEntry
@@ -606,23 +617,13 @@ Upload an updated body parser from a .ksy file, replacing the previous file.
| ----- | ---- | ----------- |
| organization | [ string](#string) | Pick the organization to use (/impersonate). If unset, your default organization is used. |
| identifier | [ string](#string) | The identifier of the parser that should be updated. |
-| content_ksy | [ string](#string) | The new ksy definition for this parser. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_name**.name | [optional string](#string) | If set, changes the name of the parser. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_content_ksy**.content_ksy | [optional string](#string) | The new ksy definition for this parser. |
| add_data_fields | [repeated hiber.field.Field](#hiberfieldfield) | Add fields to the data fields list. |
| remove_data_fields | [repeated string](#string) | Remove fields from the data fields list. |
-| metadata_fields | [ UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#updateuploadedmodemmessagebodyparserrequestmetadatafields) | Fields in the parsed result that match special things that can be processed by the system, like a location. |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_metadata_fields**.metadata_fields | [optional UpdateUploadedModemMessageBodyParserRequest.MetadataFields](#updateuploadedmodemmessagebodyparserrequestmetadatafields) | Fields in the parsed result that match special things that can be processed by the system, like a location. |
| add_post_processing | [repeated ModemMessageBodyParser.PostProcessing](#modemmessagebodyparserpostprocessing) | Add a post-processing step to the result of this parser. |
| remove_post_processing | [repeated ModemMessageBodyParser.PostProcessing](#modemmessagebodyparserpostprocessing) | Remove a post-processing step to the result of this parser. |
-| add_require_message_metadata | [map UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry](#updateuploadedmodemmessagebodyparserrequestaddrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
-| remove_require_message_metadata | [repeated string](#string) | Remove a requirement for the metadata. Remove by listing the json-path here. |
-
-### UpdateUploadedModemMessageBodyParserRequest.AddRequireMessageMetadataEntry
-
-
-
-| Field | Type | Description |
-| ----- | ---- | ----------- |
-| key | [ string](#string) | none |
-| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
### UpdateUploadedModemMessageBodyParserRequest.MetadataFields
@@ -639,6 +640,27 @@ Upload an updated body parser from a .ksy file, replacing the previous file.
| replace_modem_metadata_fields | [repeated string](#string) | Replace the modem metadata fields list. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_time_field | [ hiber.UpdateClearableString](#hiberupdateclearablestring) | Update the custom field to extract to measured_at time. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **measured_at_field**.measured_at_offset_field | [ hiber.UpdateClearableString](#hiberupdateclearablestring) | Update the custom field to extract to measured_at offset from the sent_at time in seconds. |
+| add_require_message_metadata | [map UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry](#updateuploadedmodemmessagebodyparserrequestmetadatafieldsaddrequiremessagemetadataentry) | In order to use this parser on a message, the metadata on the message must match the given requirement here. The key of the map is the json-path to look for in the message metadata, the value of the map is the json to expect at that json-path. |
+| remove_require_message_metadata | [repeated string](#string) | Remove a requirement for the metadata. Remove by listing the json-path here. |
+| replace_require_message_metadata | [map UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry](#updateuploadedmodemmessagebodyparserrequestmetadatafieldsreplacerequiremessagemetadataentry) | Replaces the entire configuration for required message metadata. |
+
+### UpdateUploadedModemMessageBodyParserRequest.MetadataFields.AddRequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
+
+### UpdateUploadedModemMessageBodyParserRequest.MetadataFields.ReplaceRequireMessageMetadataEntry
+
+
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| key | [ string](#string) | none |
+| value | [ google.protobuf.Value](#googleprotobufvalue) | none |
### UploadModemMessageBodyParserRequest
diff --git a/event-json-examples/export-created.json b/event-json-examples/export-created.json
index 2bb8901..c11b9a0 100644
--- a/event-json-examples/export-created.json
+++ b/event-json-examples/export-created.json
@@ -36,7 +36,7 @@
}
},
"title": "Exporting messages for modem AAAA AAAA to example-identifier from 2020-05-02 05:15:25Z to 2020-06-01 05:15:25Z.",
- "description": "Exporting messages for modem AAAA AAAA to example-identifier from 2020-05-02 05:15:25Z to 2020-06-01 05:15:25Z.\n\ngroup: example-tag, example-tag-2\nRequested by: user-identifier for your-organization",
+ "description": "Exporting messages for modem 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",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
@@ -44,7 +44,7 @@
}
},
"title": "Exporting messages for modem AAAA AAAA to example-identifier from 2020-05-02 05:15:25Z to 2020-06-01 05:15:25Z.",
- "description": "Exporting messages for modem AAAA AAAA to example-identifier from 2020-05-02 05:15:25Z to 2020-06-01 05:15:25Z.\n\ngroup: example-tag, example-tag-2\nRequested by: user-identifier for your-organization",
+ "description": "Exporting messages for modem 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",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
diff --git a/event-json-examples/export-failed.json b/event-json-examples/export-failed.json
index 61de8aa..c910e03 100644
--- a/event-json-examples/export-failed.json
+++ b/event-json-examples/export-failed.json
@@ -37,7 +37,7 @@
"error": "No messages found in time range."
},
"title": "Export example-identifier of messages for modem AAAA AAAA has failed.",
- "description": "The export example-identifier of messages for modem 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\ngroup: example-tag, example-tag-2\nRequested by: user-identifier for your-organization",
+ "description": "The export example-identifier of messages for modem 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",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
@@ -45,7 +45,7 @@
}
},
"title": "Export example-identifier of messages for modem AAAA AAAA has failed.",
- "description": "The export example-identifier of messages for modem 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\ngroup: example-tag, example-tag-2\nRequested by: user-identifier for your-organization",
+ "description": "The export example-identifier of messages for modem 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",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
diff --git a/event-json-examples/export-ready.json b/event-json-examples/export-ready.json
index bc9863e..b05f949 100644
--- a/event-json-examples/export-ready.json
+++ b/event-json-examples/export-ready.json
@@ -64,7 +64,7 @@
}
},
"title": "Export example-identifier of messages for modem AAAA AAAA is ready.",
- "description": "The export example-identifier of messages for modem 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\ngroup: example-tag, example-tag-2\nRequested by: user-identifier for your-organization",
+ "description": "The export example-identifier of messages for modem 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",
"time": {
"timestamp": "2020-05-22T05:15:25.355Z",
"textual": "2020-05-22T05:15:25.355Z",
@@ -72,7 +72,7 @@
}
},
"title": "Export example-identifier of messages for modem AAAA AAAA is ready.",
- "description": "The export example-identifier of messages for modem 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\ngroup: example-tag, example-tag-2\nRequested by: user-identifier for your-organization",
+ "description": "The export example-identifier of messages for modem 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",
"time": {
"timestamp": "2020-05-22T05:15:25.355Z",
"textual": "2020-05-22T05:15:25.355Z",
diff --git a/event-json-examples/modem-activated.json b/event-json-examples/modem-activated.json
index 3f57fa0..6ec3ee2 100644
--- a/event-json-examples/modem-activated.json
+++ b/event-json-examples/modem-activated.json
@@ -12,24 +12,24 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "Modem AAAA AAAA has been installed at 2020-06-01 05:15:25Z.",
- "description": "Modem AAAA AAAA in your-organization was installed at 2020-06-01 05:15:25Z.\n\ngroup: example-tag, example-tag-2",
+ "description": "Modem AAAA AAAA in your-organization was installed at 2020-06-01 05:15:25Z.\n\nwell: example-tag, example-tag-2",
"modemExternalDeviceId": "00 11 22 33 AA BB CC DD"
},
"title": "Modem AAAA AAAA has been installed at 2020-06-01 05:15:25Z.",
- "description": "Modem AAAA AAAA in your-organization was installed at 2020-06-01 05:15:25Z.\n\ngroup: example-tag, example-tag-2",
+ "description": "Modem AAAA AAAA in your-organization was installed at 2020-06-01 05:15:25Z.\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event-json-examples/modem-alarm.json b/event-json-examples/modem-alarm.json
index d841d6c..31b2011 100644
--- a/event-json-examples/modem-alarm.json
+++ b/event-json-examples/modem-alarm.json
@@ -14,17 +14,17 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
}, {
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}],
"title": "Expected battery to be within 20..100%, but it is now at 15%!",
- "description": "In organization your-organization modem AAAA AAAA has failed the following checks:\n\n- example-check-id: Expected battery to be within 20..100%, but it is now at 15%!\n\nThe error messages were produced by alarm example-identifier: example\n\ngroup: example-tag, example-tag-2",
+ "description": "In organization your-organization modem AAAA AAAA has failed the following checks:\n\n- example-check-id: Expected battery to be within 20..100%, but it is now at 15%!\n\nThe error messages were produced by alarm example-identifier: example\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
@@ -58,7 +58,7 @@
"severity": "3"
},
"title": "Expected battery to be within 20..100%, but it is now at 15%!",
- "description": "In organization your-organization modem AAAA AAAA has failed the following checks:\n\n- example-check-id: Expected battery to be within 20..100%, but it is now at 15%!\n\nThe error messages were produced by alarm example-identifier: example\n\ngroup: example-tag, example-tag-2",
+ "description": "In organization your-organization modem AAAA AAAA has failed the following checks:\n\n- example-check-id: Expected battery to be within 20..100%, but it is now at 15%!\n\nThe error messages were produced by alarm example-identifier: example\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event-json-examples/modem-created.json b/event-json-examples/modem-created.json
index 7331c47..7f01c63 100644
--- a/event-json-examples/modem-created.json
+++ b/event-json-examples/modem-created.json
@@ -12,24 +12,24 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "Modem AAAA AAAA was created.",
- "description": "Modem AAAA AAAA was automatically created for device 00 11 22 33 AA BB CC DD.\n\ngroup: example-tag, example-tag-2",
+ "description": "Modem AAAA AAAA was automatically created for device 00 11 22 33 AA BB CC DD.\n\nwell: example-tag, example-tag-2",
"modemExternalDeviceId": "00 11 22 33 AA BB CC DD"
},
"title": "Modem AAAA AAAA was created.",
- "description": "Modem AAAA AAAA was automatically created for device 00 11 22 33 AA BB CC DD.\n\ngroup: example-tag, example-tag-2",
+ "description": "Modem AAAA AAAA was automatically created for device 00 11 22 33 AA BB CC DD.\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event-json-examples/modem-location-updated.json b/event-json-examples/modem-location-updated.json
index be419d3..0844277 100644
--- a/event-json-examples/modem-location-updated.json
+++ b/event-json-examples/modem-location-updated.json
@@ -17,20 +17,20 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "Modem AAAA AAAA is now at [21.222,31.33299].",
- "description": "The message from modem AAAA AAAA, received at 2020-06-01 05:15:25Z, changed the modem location from [20.222,30.33299] to [21.222,31.33299].\n\ngroup: example-tag, example-tag-2",
+ "description": "The message from modem AAAA AAAA, received at 2020-06-01 05:15:25Z, changed the modem location from [20.222,30.33299] to [21.222,31.33299].\n\nwell: example-tag, example-tag-2",
"modemExternalDeviceId": "00 11 22 33 AA BB CC DD",
"updatedAt": {
"timestamp": "2020-06-01T05:15:25.355Z",
@@ -39,7 +39,7 @@
}
},
"title": "Modem AAAA AAAA is now at [21.222,31.33299].",
- "description": "The message from modem AAAA AAAA, received at 2020-06-01 05:15:25Z, changed the modem location from [20.222,30.33299] to [21.222,31.33299].\n\ngroup: example-tag, example-tag-2",
+ "description": "The message from modem AAAA AAAA, received at 2020-06-01 05:15:25Z, changed the modem location from [20.222,30.33299] to [21.222,31.33299].\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event-json-examples/modem-message-body-parsed.json b/event-json-examples/modem-message-body-parsed.json
index 6a014a8..d625905 100644
--- a/event-json-examples/modem-message-body-parsed.json
+++ b/event-json-examples/modem-message-body-parsed.json
@@ -19,20 +19,20 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "A message from modem AAAA AAAA was parsed by body parser example-identifier.",
- "description": "A message from modem AAAA AAAA was parsed by body parser example-identifier:\n\n{\"text\": \"example\"}\n\ngroup: example-tag, example-tag-2",
+ "description": "A message from modem AAAA AAAA was parsed by body parser example-identifier:\n\n{\"text\": \"example\"}\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T07:15:25.355Z",
"textual": "2020-06-01T07:15:25.355Z",
@@ -40,7 +40,7 @@
}
},
"title": "A message from modem AAAA AAAA was parsed by body parser example-identifier.",
- "description": "A message from modem AAAA AAAA was parsed by body parser example-identifier:\n\n{\"text\": \"example\"}\n\ngroup: example-tag, example-tag-2",
+ "description": "A message from modem AAAA AAAA was parsed by body parser example-identifier:\n\n{\"text\": \"example\"}\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event-json-examples/modem-message-body-parser-created.json b/event-json-examples/modem-message-body-parser-created.json
index 6b3eca8..09eea6a 100644
--- a/event-json-examples/modem-message-body-parser-created.json
+++ b/event-json-examples/modem-message-body-parser-created.json
@@ -5,7 +5,14 @@
"name": "example",
"contentKsy": "example",
"identifier": "example-identifier",
+ "organization": "your-organization",
"metadataFields": {
+ "requireMessageMetadata": {
+ "$.fPort": 10.0
+ }
+ },
+ "requireMessageMetadata": {
+ "$.fPort": 10.0
}
},
"title": "Modem Message Body Parser example (example-identifier) was created.",
diff --git a/event-json-examples/modem-message-body-parser-updated.json b/event-json-examples/modem-message-body-parser-updated.json
index 76909a4..9a784ae 100644
--- a/event-json-examples/modem-message-body-parser-updated.json
+++ b/event-json-examples/modem-message-body-parser-updated.json
@@ -12,7 +12,7 @@
}
},
"title": "Modem Message Body Parser example-identifier was updated.",
- "description": "Modem Message Body Parser example-identifier was updated:\n\n- The name was changed from example-old to example.",
+ "description": "Modem 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 modem metadata fields were updated.\n\n- The require metadata fields were updated.",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
@@ -26,5 +26,5 @@
"timeZone": "UTC"
},
"title": "Modem Message Body Parser example-identifier was updated.",
- "description": "Modem Message Body Parser example-identifier was updated:\n\n- The name was changed from example-old to example."
+ "description": "Modem 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 modem metadata fields were updated.\n\n- The require metadata fields were updated."
}
diff --git a/event-json-examples/modem-message-body-received.json b/event-json-examples/modem-message-body-received.json
index 8c7ed9f..9c04f45 100644
--- a/event-json-examples/modem-message-body-received.json
+++ b/event-json-examples/modem-message-body-received.json
@@ -18,20 +18,20 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "New message from modem AAAA AAAA was received. It was sent at 2020-06-01 05:15:25Z.",
- "description": "A new message from modem AAAA AAAA was received. It was sent at 2020-06-01 05:15:25Z.\n\nThe body (hex) was: 6578616D706C65\n\ngroup: example-tag, example-tag-2",
+ "description": "A new message from modem AAAA AAAA was received. It was sent at 2020-06-01 05:15:25Z.\n\nThe body (hex) was: 6578616D706C65\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T06:15:25.355Z",
"textual": "2020-06-01T06:15:25.355Z",
@@ -39,7 +39,7 @@
}
},
"title": "New message from modem AAAA AAAA was received. It was sent at 2020-06-01 05:15:25Z.",
- "description": "A new message from modem AAAA AAAA was received. It was sent at 2020-06-01 05:15:25Z.\n\nThe body (hex) was: 6578616D706C65\n\ngroup: example-tag, example-tag-2",
+ "description": "A new message from modem AAAA AAAA was received. It was sent at 2020-06-01 05:15:25Z.\n\nThe body (hex) was: 6578616D706C65\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event-json-examples/modem-message-cannot-be-parsed.json b/event-json-examples/modem-message-cannot-be-parsed.json
index ac675d3..889aa05 100644
--- a/event-json-examples/modem-message-cannot-be-parsed.json
+++ b/event-json-examples/modem-message-cannot-be-parsed.json
@@ -26,24 +26,24 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
- "title": "Message received from modem AAAA AAAA cannot be parsed!",
- "description": "Message received from modem AAAA AAAA cannot be parsed!\n\nThis can be caused by multiple things:\n- invalid configuration in the modem or the stored modem parameters in the system;\n- the message body could not be parsed by any of the assigned parsers.\n\nSee the message below for more information:\n\nParsing failure: all assigned parsers have failed with the following errors:\n\n - Failed: 13 bytes were not parsed.\n\ngroup: example-tag, example-tag-2",
+ "title": "Processing for AAAA AAAA appears to be misconfigured! Please contact customer support if this is not resolved.",
+ "description": "Processing for AAAA AAAA appears to be misconfigured! Please contact customer support if this is not resolved.\n\nThis can mean that:\n- the device is sending invalid messages\n- the processing is configured incorrectly (i.e. for a different type of device)\n\nSee the message below for more information:\n\nParsing failure: all assigned parsers have failed with the following errors:\n\n - Failed: 13 bytes were not parsed.\n\nwell: example-tag, example-tag-2",
"modemExternalDeviceId": "00 11 22 33 AA BB CC DD"
},
- "title": "Message received from modem AAAA AAAA cannot be parsed!",
- "description": "Message received from modem AAAA AAAA cannot be parsed!\n\nThis can be caused by multiple things:\n- invalid configuration in the modem or the stored modem parameters in the system;\n- the message body could not be parsed by any of the assigned parsers.\n\nSee the message below for more information:\n\nParsing failure: all assigned parsers have failed with the following errors:\n\n - Failed: 13 bytes were not parsed.\n\ngroup: example-tag, example-tag-2",
+ "title": "Processing for AAAA AAAA appears to be misconfigured! Please contact customer support if this is not resolved.",
+ "description": "Processing for AAAA AAAA appears to be misconfigured! Please contact customer support if this is not resolved.\n\nThis can mean that:\n- the device is sending invalid messages\n- the processing is configured incorrectly (i.e. for a different type of device)\n\nSee the message below for more information:\n\nParsing failure: all assigned parsers have failed with the following errors:\n\n - Failed: 13 bytes were not parsed.\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event-json-examples/modem-message-received.json b/event-json-examples/modem-message-received.json
index af3ab73..9aba322 100644
--- a/event-json-examples/modem-message-received.json
+++ b/event-json-examples/modem-message-received.json
@@ -49,14 +49,14 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
@@ -70,19 +70,19 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "New message from modem AAAA AAAA was received and processed. It was sent at 2020-06-01 05:15:25Z.",
- "description": "A new message from modem AAAA AAAA was received and processed.\n\nThe message was sent at 2020-06-01 05:15:25Z with location [20.222,30.33299].\n\nThe body (hex) was: 6578616D706C65\n\nIt was parsed to:\n\n{\n \"text\": \"example\"\n}\n\ngroup: example-tag, example-tag-2",
+ "description": "A new message from modem AAAA AAAA was received and processed.\n\nThe message was sent at 2020-06-01 05:15:25Z with location [20.222,30.33299].\n\nThe body (hex) was: 6578616D706C65\n\nIt was parsed to:\n\n{\n \"text\": \"example\"\n}\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T06:15:25.365Z",
"textual": "2020-06-01T06:15:25.365Z",
@@ -91,7 +91,7 @@
"modemExternalDeviceId": "00 11 22 33 AA BB CC DD"
},
"title": "New message from modem AAAA AAAA was received and processed. It was sent at 2020-06-01 05:15:25Z.",
- "description": "A new message from modem AAAA AAAA was received and processed.\n\nThe message was sent at 2020-06-01 05:15:25Z with location [20.222,30.33299].\n\nThe body (hex) was: 6578616D706C65\n\nIt was parsed to:\n\n{\n \"text\": \"example\"\n}\n\ngroup: example-tag, example-tag-2",
+ "description": "A new message from modem AAAA AAAA was received and processed.\n\nThe message was sent at 2020-06-01 05:15:25Z with location [20.222,30.33299].\n\nThe body (hex) was: 6578616D706C65\n\nIt was parsed to:\n\n{\n \"text\": \"example\"\n}\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event-json-examples/modem-updated.json b/event-json-examples/modem-updated.json
index f93b3e6..81a5990 100644
--- a/event-json-examples/modem-updated.json
+++ b/event-json-examples/modem-updated.json
@@ -12,19 +12,19 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "Modem AAAA AAAA was updated.",
- "description": "Modem AAAA AAAA was updated:\n\n- Display name was changed from 'AAAA AAAA' to 'custom-name'.\n\n- The peripherals were changed.\n\n- The notes were changed to:\nmy-updated-notes\n\ngroup: example-tag, example-tag-2",
+ "description": "Modem AAAA AAAA was updated:\n\n- Display name was changed from 'AAAA AAAA' to 'custom-name'.\n\n- The peripherals were changed.\n\n- The notes were changed to:\nmy-updated-notes\n\nwell: example-tag, example-tag-2",
"displayName": {
"updated": true,
"value": "custom-name"
@@ -41,7 +41,7 @@
"modemExternalDeviceId": "00 11 22 33 AA BB CC DD"
},
"title": "Modem AAAA AAAA was updated.",
- "description": "Modem AAAA AAAA was updated:\n\n- Display name was changed from 'AAAA AAAA' to 'custom-name'.\n\n- The peripherals were changed.\n\n- The notes were changed to:\nmy-updated-notes\n\ngroup: example-tag, example-tag-2",
+ "description": "Modem AAAA AAAA was updated:\n\n- Display name was changed from 'AAAA AAAA' to 'custom-name'.\n\n- The peripherals were changed.\n\n- The notes were changed to:\nmy-updated-notes\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event-json-examples/publisher-auto-disabled.json b/event-json-examples/publisher-auto-disabled.json
index ad3704d..b97be82 100644
--- a/event-json-examples/publisher-auto-disabled.json
+++ b/event-json-examples/publisher-auto-disabled.json
@@ -8,20 +8,20 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "Webhook (id 10001) has been disabled automatically.",
- "description": "Webhook (id 10001) has been disabled automatically, because it was failing continuously.\n\ngroup: example-tag, example-tag-2",
+ "description": "Webhook (id 10001) has been disabled automatically, because it was failing continuously.\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T06:15:25.355Z",
"textual": "2020-06-01T06:15:25.355Z",
@@ -39,7 +39,7 @@
}
},
"title": "Webhook (id 10001) has been disabled automatically.",
- "description": "Webhook (id 10001) has been disabled automatically, because it was failing continuously.\n\ngroup: example-tag, example-tag-2",
+ "description": "Webhook (id 10001) has been disabled automatically, because it was failing continuously.\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T06:15:25.355Z",
"textual": "2020-06-01T06:15:25.355Z",
diff --git a/event-json-examples/publisher-created.json b/event-json-examples/publisher-created.json
index c4a2035..150452b 100644
--- a/event-json-examples/publisher-created.json
+++ b/event-json-examples/publisher-created.json
@@ -31,14 +31,14 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
@@ -58,20 +58,20 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"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\ngroup: example-tag, example-tag-2",
+ "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",
@@ -79,7 +79,7 @@
}
},
"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\ngroup: example-tag, example-tag-2",
+ "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",
diff --git a/event-json-examples/publisher-deleted.json b/event-json-examples/publisher-deleted.json
index 696f599..a2e65f1 100644
--- a/event-json-examples/publisher-deleted.json
+++ b/event-json-examples/publisher-deleted.json
@@ -31,14 +31,14 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
@@ -58,20 +58,20 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "Webhook at https://example.com/my-webhook (id 10001) has been deleted.",
- "description": "Webhook at https://example.com/my-webhook (id 10001) has been deleted:\n\nexample\n\ngroup: example-tag, example-tag-2",
+ "description": "Webhook at https://example.com/my-webhook (id 10001) has been deleted:\n\nexample\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
@@ -79,7 +79,7 @@
}
},
"title": "Webhook at https://example.com/my-webhook (id 10001) has been deleted.",
- "description": "Webhook at https://example.com/my-webhook (id 10001) has been deleted:\n\nexample\n\ngroup: example-tag, example-tag-2",
+ "description": "Webhook at https://example.com/my-webhook (id 10001) has been deleted:\n\nexample\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
diff --git a/event-json-examples/publisher-failed.json b/event-json-examples/publisher-failed.json
index 0942c36..72b37a2 100644
--- a/event-json-examples/publisher-failed.json
+++ b/event-json-examples/publisher-failed.json
@@ -33,14 +33,14 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
@@ -69,20 +69,20 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"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\ngroup: example-tag, example-tag-2",
+ "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",
@@ -90,7 +90,7 @@
}
},
"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\ngroup: example-tag, example-tag-2",
+ "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",
diff --git a/event-json-examples/publisher-updated.json b/event-json-examples/publisher-updated.json
index afc84b0..ab69d4e 100644
--- a/event-json-examples/publisher-updated.json
+++ b/event-json-examples/publisher-updated.json
@@ -27,20 +27,20 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "Webhook (id 1) has been updated.",
- "description": "Webhook (id 1) has been updated.\n\n- Description was updated to 'updated'.\n\n- Webhook url was changed to https://example.com/updated-webhook.\n\ngroup: example-tag, example-tag-2",
+ "description": "Webhook (id 1) has been updated.\n\n- Description was updated to 'updated'.\n\n- Webhook url was changed to https://example.com/updated-webhook.\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
@@ -53,7 +53,7 @@
}
},
"title": "Webhook (id 1) has been updated.",
- "description": "Webhook (id 1) has been updated.\n\n- Description was updated to 'updated'.\n\n- Webhook url was changed to https://example.com/updated-webhook.\n\ngroup: example-tag, example-tag-2",
+ "description": "Webhook (id 1) has been updated.\n\n- Description was updated to 'updated'.\n\n- Webhook url was changed to https://example.com/updated-webhook.\n\nwell: example-tag, example-tag-2",
"time": {
"timestamp": "2020-06-01T05:15:25.355Z",
"textual": "2020-06-01T05:15:25.355Z",
diff --git a/event-json-examples/transfer.json b/event-json-examples/transfer.json
index 6e3b707..a77e7c9 100644
--- a/event-json-examples/transfer.json
+++ b/event-json-examples/transfer.json
@@ -11,19 +11,19 @@
"id": "1",
"label": {
"name": "example-tag",
- "type": "group"
+ "type": "well"
}
},
{
"id": "2",
"label": {
"name": "example-tag-2",
- "type": "group"
+ "type": "well"
}
}
],
"title": "You transferred 1 device to your-organization-2.",
- "description": "your-organization transferred 1 device to your-organization-2.\n\nThe following devices are in this transfer:\n\n- AAAA AAAA (00 11 22 33 AA BB CC DD)\n\ngroup: example-tag, example-tag-2",
+ "description": "your-organization transferred 1 device to your-organization-2.\n\nThe following devices are in this transfer:\n\n- AAAA AAAA (00 11 22 33 AA BB CC DD)\n\nwell: example-tag, example-tag-2",
"transfer": {
"identifier": "example-identifier",
"senderOrganization": "your-organization",
@@ -48,7 +48,7 @@
"timeZone": "UTC"
},
"title": "You transferred 1 device to your-organization-2.",
- "description": "your-organization transferred 1 device to your-organization-2.\n\nThe following devices are in this transfer:\n\n- AAAA AAAA (00 11 22 33 AA BB CC DD)\n\ngroup: example-tag, example-tag-2",
+ "description": "your-organization transferred 1 device to your-organization-2.\n\nThe following devices are in this transfer:\n\n- AAAA AAAA (00 11 22 33 AA BB CC DD)\n\nwell: example-tag, example-tag-2",
"modem": {
"number": "AAAA AAAA",
"name": "AAAA AAAA",
diff --git a/event.proto b/event.proto
index fd6731d..a2d08e5 100644
--- a/event.proto
+++ b/event.proto
@@ -484,7 +484,7 @@ message Event {
}
message ModemTransferEvent {
- // TODO(2023-02-01) remove before this date
+ // TODO(2023-03-01) remove before this date
option deprecated = true;
message ModemTransferStartedEvent {
diff --git a/home/wbouvy/hiber/ms-code/cli/customer/build-proto/dependencyUpdates/report.txt b/home/wbouvy/hiber/ms-code/cli/customer/build-proto/dependencyUpdates/report.txt
new file mode 100644
index 0000000..b6882e0
--- /dev/null
+++ b/home/wbouvy/hiber/ms-code/cli/customer/build-proto/dependencyUpdates/report.txt
@@ -0,0 +1,12 @@
+------------------------------------------------------------
+/home/wbouvy/hiber/ms-code/cli/customer/proto
+
+------------------------------------------------------------
+:proto Project Dependency Updates (report to plain text file)
+------------------------------------------------------------
+
+The following dependencies have later release versions:
+ - org.jetbrains.kotlin:kotlin-bom [1.7.10 -> 1.8.10]
+ https://kotlinlang.org/
+ - org.jetbrains.kotlin:kotlin-scripting-compiler-embeddable [1.7.10 -> 1.8.10]
+ https://kotlinlang.org/
diff --git a/modem_claim.proto b/modem_claim.proto
index efb2e6f..2175a36 100644
--- a/modem_claim.proto
+++ b/modem_claim.proto
@@ -15,7 +15,7 @@ option go_package = "hiber";
* This process is instantaneous, but the previous owner can reject the claim afterwards.
*
* This service is deprecated and will be removed in the future. In some cases, it may be disabled before it is removed.
- * // TODO(2023-01-31) remove this service from the API before this date
+ * // TODO(2023-03-01) remove this service from the API before this date
*/
service ModemClaimService {
option deprecated = true;
diff --git a/modem_message_body_parser.proto b/modem_message_body_parser.proto
index 081d635..bc868f1 100644
--- a/modem_message_body_parser.proto
+++ b/modem_message_body_parser.proto
@@ -111,6 +111,12 @@ message ModemMessageBodyParser {
*/
string measured_at_offset_field = 5;
}
+
+ /* In order to use this parser on a message,
+ * the metadata on the message must match the given requirement here.
+ * The key of the map is the json-path to look for in the message metadata,
+ * the value of the map is the json to expect at that json-path. */
+ map require_message_metadata = 6;
}
/* The type of post-processing to be applied to the result of this parser. */
@@ -144,7 +150,6 @@ message ModemMessageBodyParser {
* Data fields are cached for efficient retrieval and allow all kinds of processing.
*/
repeated field.Field data_fields = 11;
- repeated string data_fields_deprecated = 9 [deprecated = true];
/* Fields in the parsed result that contain metadata, and special things like a location. */
MetadataFields metadata_fields = 10;
@@ -153,15 +158,17 @@ message ModemMessageBodyParser {
AvailableToChildOrganizations available_to_child_organizations = 6;
/* The list of post-processing steps applied to the result of this parser. */
- repeated PostProcessing post_processing = 13;
+ repeated PostProcessing post_processing = 13 [deprecated = true];
/* In order to use this parser on a message,
* the metadata on the message must match the given requirement here.
* The key of the map is the json-path to look for in the message metadata,
- * the value of the map is the json to expect at that json-path. */
- map require_message_metadata = 14;
+ * the value of the map is the json to expect at that json-path.
+ * Deprecated: use metadata_fields.require_message_metadata
+ */
+ map require_message_metadata = 14 [deprecated = true];
- reserved 1, 5, 12;
+ reserved 1, 5, 9, 12;
}
/* Simple modem message body parser. This can be used a convenient way to create a .ksy parser. */
@@ -381,6 +388,17 @@ message UpdateUploadedModemMessageBodyParserRequest {
/* Update the custom field to extract to measured_at offset from the sent_at time in seconds. */
UpdateClearableString measured_at_offset_field = 9;
}
+
+ /* In order to use this parser on a message,
+ * the metadata on the message must match the given requirement here.
+ * The key of the map is the json-path to look for in the message metadata,
+ * the value of the map is the json to expect at that json-path. */
+ map add_require_message_metadata = 10;
+ /* Remove a requirement for the metadata. Remove by listing the json-path here. */
+ repeated string remove_require_message_metadata = 11;
+ /* Replaces the entire configuration for required message metadata. */
+ map replace_require_message_metadata = 12;
+
}
/* Pick the organization to use (/impersonate). If unset, your default organization is used. */
@@ -389,8 +407,11 @@ message UpdateUploadedModemMessageBodyParserRequest {
/* The identifier of the parser that should be updated. */
string identifier = 4;
+ /* If set, changes the name of the parser. */
+ optional string name = 13;
+
/* The new ksy definition for this parser. */
- string content_ksy = 3;
+ optional string content_ksy = 3;
/* Add fields to the data fields list. */
repeated field.Field add_data_fields = 7;
@@ -399,22 +420,14 @@ message UpdateUploadedModemMessageBodyParserRequest {
repeated string remove_data_fields = 6;
/* Fields in the parsed result that match special things that can be processed by the system, like a location. */
- MetadataFields metadata_fields = 10;
+ optional MetadataFields metadata_fields = 10;
/* Add a post-processing step to the result of this parser. */
- repeated ModemMessageBodyParser.PostProcessing add_post_processing = 8;
+ repeated ModemMessageBodyParser.PostProcessing add_post_processing = 8 [deprecated = true];
/* Remove a post-processing step to the result of this parser. */
- repeated ModemMessageBodyParser.PostProcessing remove_post_processing = 9;
-
- /* In order to use this parser on a message,
- * the metadata on the message must match the given requirement here.
- * The key of the map is the json-path to look for in the message metadata,
- * the value of the map is the json to expect at that json-path. */
- map add_require_message_metadata = 11;
- /* Remove a requirement for the metadata. Remove by listing the json-path here. */
- repeated string remove_require_message_metadata = 12;
+ repeated ModemMessageBodyParser.PostProcessing remove_post_processing = 9 [deprecated = true];
- reserved 2, 5;
+ reserved 2, 5, 11, 12;
}
/* Create a simple modem message parser, which generates a .ksy specification. */