Releases: HiberGlobal/api
Releases · HiberGlobal/api
0.80.3
0.80.3 (2021-07-02)
This release contains a few more bug fixes.
Changes
ModemService
- Fixed a bug where fix device count for gateway was not taking organization into account,
counting orphaned devices in other organizations. - Fixed device message order, which was broken in 0.80.
0.80.2
0.80.2 (2021-06-22)
This release contains a few bug fixes.
Changes
- Fixed a bug where an Area or Shape was not allowed to contain a location of (0.0, 0.0).
TagService
- Fixed a bug where deleting a tag could affect the assignment of other tags.
- Fixed a bug where deleting a tag did not produce a ModemUpdatedEvent for the affected modems.
0.80
0.80 (2021-06-17)
This release introduces the option to create your own modems (with some limitations)
and convenience improvements.
Changes
- Added a
OrganizationPermission.MODEMS_CREATE
to create modems.
OrganizationService
- Renamed
Organization.Feature.GENERAL_PURPOSE_TRACKING
toOrganization.Feature.EASYPULSE
.
ModemService
- Added
CreateModem
to create modems for your organization.- This call is not available to all organizations, and is typically used to create modems for testing or
when you want to connect a device to the API using just the API calls in the TestingService.
- This call is not available to all organizations, and is typically used to create modems for testing or
- Fixed a bug where
UpdateModemStatus
only returned a single modem, even though all selected modems were affected. - Added
include_types
andexclude_types
toModemSelection
, replacing the simpletypes
list of included types. - Added
ModemMessageSelection.modem_selection
to allow selecting messages from multiple modems
without having to list the individual modems (i.e. by tag).
0.79
0.79 (2021-06-03)
This release contains a selection of bugfixes and API Ux improvements.
Changes
- Added a new identifier generator to clean up the different types of identifiers a bit.
- Identifiers - even without their prefix - are unique system-wide
- New identifiers are generated using the new logic for the following types:
- modem transfers
- modem alarms
- modem message body parsers
- automatic assignments
ModemAlarmService
- Removed limitation where the
minimum
ormaximum
for threshold and delta check could not be0.0
.
ModemService
- The pagination for messages should now be more accurate, and only estimate total counts if you have a lot of messages.
- Added
AvailableModemMessageFields.Request.include_total
andAvailableModemMessageFields.Response.total
to calculate the total fields for all selected modems. This can be useful to display table columns, for example.
OrganizationService
- Added new Organization Feature flag:
GENERAL_PURPOSE_TRACKING
SimulationService
- Added
random_location_in_area
toSimulation.ModemMessageSimulation.Update.Request
to allow the simulation
to generate a new location for the modem on every message, but contain it within a given area.
TokenService
- Added more options to
UpdateTokenOrganizationPermissionsRequest
- Renamed
new_organization_permissions
toreplace_organization_permissions
, to be more explicit. - Added
add_organization_permissions
to instead just add permission to the token. - Added
remove_organization_permissions
to remove permissions from the token.
- Renamed
- Added more options to
UpdateTokenUserPermissionsRequest
- Renamed
new_user_permissions
toreplace_user_permissions
, to be more explicit. - Added
add_user_permissions
to instead just add permission to the token. - Added
remove_user_permissions
to remove permissions from the token.
- Renamed
0.78
0.78 (2021-05-31)
This release adds health levels to events, so they can be shown and filtered on.
Changes
EventService
- Added
health_level
toEvent
and specific events, to reflect theHealthLevel
the event causes.
This allows us to use the new customizable health levels for events, and filtering events.- Added
health_level
to:ModemStaleEvent
ModemMessageDroppedEvent
ModemMessageDelayedEvent
ModemMessageCannotBeParsedEvent
ModemAlarmEvent
ModemTransferNotReceivedEvent
ModemTransferReturnTransferStartedEvent
PublisherEvent.AutoDisabledEvent
PublisherEvent.FailedEvent
TokenExpiryWarningEvent
EventSelection
- Added
- [B] Deprecated
is_error
andis_warning
onEvent
, anderrors_only
andwarnings_only
onEventSelection
to be replaced with theEvent.health_level
andEventSelection.health_levels
respectively.
EmailNotificationPreferences
- Added
EmailNotificationPreferences.filter_health_levels
to filter events on health level when sending them by email. - Added
UpdateEmailNotificationPreferencesRequest.add_health_levels_to_filter
to add health levels to the filter. - Added
UpdateEmailNotificationPreferencesRequest.remove_health_levels_from_filter
to remove health levels from
the filter.
SlackIntegrationService
- Added
SlackPublisher.filter_health_levels
to filter events on health level when sending them to slack. - Added
CreateSlackPublisherRequest.filter_health_levels
to filter events on health level when sending them to slack. - Added
UpdateSlackPublisherRequest.add_health_levels_to_filter
to add health levels to the filter. - Added
UpdateSlackPublisherRequest.remove_health_levels_from_filter
to remove health levels from
the filter.
WebhookService
- Added
Webhook.filter_health_levels
to filter events on health level when sending them to a webhook. - Added
CreateWebhookRequest.filter_health_levels
to filter events on health level when sending them to a webhook. - Added
UpdateWebhookRequest.add_health_levels_to_filter
and
UpdateWebhookFilterRequest.add_health_levels_to_filter
to add health levels to the filter. - Added
UpdateWebhookRequest.remove_health_levels_from_filter
and
UpdateWebhookFilterRequest.remove_health_levels_from_filter
to remove health levels from the filter.
0.77
0.77 (2021-05-17)
This release contains:
- marking data fields for message body parsers (for processing, charting, etc)
- easy access to parsed message body in messages, using a merged Struct
- exporting message to JSON or CSV
EventService
- Added
ExportCreatedEvent
,ExportReadyEvent
andExportFailedEvent
for the new export functionality.- Added
export_created
,export_ready
andexport_failed
toEvent
.
- Added
ExportService
- Introduced the ExportService, to list and manage exports.
- Exports are asynchronous and only available for a limited time when ready,
which is reflected by theExport.Status
(withPROCESSING
,READY
,EXPIRED
). - Added
Export.Format.Json
for exporting in a JSON format. - Added
Export.Format.Csv
for exporting in a CSV format. - Added
Export.Configuration.ModemMessages
to export modem messages.
This is currently the only available export configuration.
- Exports are asynchronous and only available for a limited time when ready,
ModemService
- Added
ModemMessage.body_fields
, which is a flattened Struct of allModemMessage.body_parsed[*].result
.
This is a convenience to access the fields from body_parsed, but if any fields are present in
multiple body_parsed results, it is not defined which field will be used in this Struct.
This may change in the future. - Added
ModemMessageFieldsSelection
to select fields in aModemMessage
, both proto fields and message body fields.- Added
AvailableMessageFields
to list available fields for messages from a modem.
This is generally useful to list data fields added by message body parsers
(and powered byModemMessageBodyParser.data_fields
).
The available fields are returned as aModemMessageFieldsSelection
. - Added
ListModemMessagesRequest.fields
(aModemMessageFieldsSelection
) to limit the fields for the
returned messages, to conserve data or simplify an operation.
This applies to both protobuf fields and message body fields.
- Added
ModemMessageBodyParserService
- Added
data_fields
toModemMessageBodyParser
, which are fields that are marked to contain data
(versus status fields or counters), that can be graphed, for example.- Added
has_data_fields
toModemMessageBodyParserSelection
to select parsers that have specified data fields. - Added
data_fields
toUploadModemMessageBodyParserRequest
to set the data fields for a newly uploaded parser. - Added
add_data_fields
andremove_data_fields
toUpdateUploadedModemMessageBodyParserRequest
to update the
data fields for an uploaded parser.
- Added
Permissions
- Added
EXPORT
permissions to allow a user to create exports and see download links.
0.75
0.75 (2021-04-29)
This release adds a few more options to modem alarms.
ModemAlarmService
- Fixed the index for
InactivityCheck.maximum
. - Added formatting option to error message templates:
- Added the option to round numeric values:
{actual:.3f}
- Added the option to always sign numeric values (when rounded):
{actual:+.3f}
- This is applied to numeric fields and fields that can be numeric, like
{actual}
and{expected}
.
- Added the option to round numeric values:
0.74.4
0.74.4 (2021-04-22)
Small convenience hotfix for the ModemHealthCount
.
ModemService
- [B] Changed
ModemHealthCount.Response
to group tag health counts instead of having them all in a big list.
Backwards incompatible changes
- [B] Changed
ModemHealthCount.Response
to group tag health counts instead of having them all in a big list.
0.74
0.74 (2021-04-15)
Changes
NamedLocationService
- Added
NamedLocationService
to save locations with a name. These location can then be used in other
places, like alarms.
A named locations can be either aLocation
,Area
orShape
.- Added permission
LOCATIONS_MANAGE
toOrganizationPermission
to manage named locations.
- Added permission
ModemAlarmService
- Added
named
toLocationCheck
to use a named location for the check.
EventService
ModemAlarmEvent
title is now just the error message, without any additional data.
The description contains the additional data, as before.
0.73
0.73 (2021-04-12)
Changes
ModemService
- Added
ModemHealthCount
to efficiently count how many of your modems per health level.
Optionally, the counts can also be done per tag, specified by a TagSelection.
ModemAlarmService
- Added
DelayCheck
to trigger the alarm when message delay
(the difference between sentAt and receivedAt) exceeds a given threshold.