losant_rest 1.23.2 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/test.yml +2 -2
- data/.ruby-version +1 -1
- data/LICENSE +1 -1
- data/README.md +1 -1
- data/docs/_schemas.md +1809 -381
- data/docs/applicationKeys.md +2 -2
- data/docs/events.md +3 -1
- data/lib/platform_rest/application.rb +1 -1
- data/lib/platform_rest/application_api_token.rb +1 -1
- data/lib/platform_rest/application_api_tokens.rb +1 -1
- data/lib/platform_rest/application_certificate.rb +1 -1
- data/lib/platform_rest/application_certificate_authorities.rb +1 -1
- data/lib/platform_rest/application_certificate_authority.rb +1 -1
- data/lib/platform_rest/application_certificates.rb +1 -1
- data/lib/platform_rest/application_dashboard.rb +1 -1
- data/lib/platform_rest/application_dashboards.rb +1 -1
- data/lib/platform_rest/application_job_log.rb +1 -1
- data/lib/platform_rest/application_job_logs.rb +1 -1
- data/lib/platform_rest/application_key.rb +1 -1
- data/lib/platform_rest/application_keys.rb +3 -3
- data/lib/platform_rest/application_template.rb +1 -1
- data/lib/platform_rest/application_templates.rb +1 -1
- data/lib/platform_rest/applications.rb +1 -1
- data/lib/platform_rest/audit_log.rb +1 -1
- data/lib/platform_rest/audit_logs.rb +1 -1
- data/lib/platform_rest/auth.rb +1 -1
- data/lib/platform_rest/client.rb +3 -3
- data/lib/platform_rest/credential.rb +1 -1
- data/lib/platform_rest/credentials.rb +1 -1
- data/lib/platform_rest/dashboard.rb +1 -1
- data/lib/platform_rest/dashboards.rb +1 -1
- data/lib/platform_rest/data.rb +1 -1
- data/lib/platform_rest/data_table.rb +1 -1
- data/lib/platform_rest/data_table_row.rb +1 -1
- data/lib/platform_rest/data_table_rows.rb +1 -1
- data/lib/platform_rest/data_tables.rb +1 -1
- data/lib/platform_rest/device.rb +1 -1
- data/lib/platform_rest/device_attribute.rb +1 -1
- data/lib/platform_rest/device_attributes.rb +1 -1
- data/lib/platform_rest/device_recipe.rb +1 -1
- data/lib/platform_rest/device_recipes.rb +1 -1
- data/lib/platform_rest/devices.rb +1 -1
- data/lib/platform_rest/edge_deployment.rb +1 -1
- data/lib/platform_rest/edge_deployments.rb +1 -1
- data/lib/platform_rest/embedded_deployment.rb +1 -1
- data/lib/platform_rest/embedded_deployments.rb +1 -1
- data/lib/platform_rest/error.rb +1 -1
- data/lib/platform_rest/event.rb +1 -1
- data/lib/platform_rest/events.rb +6 -2
- data/lib/platform_rest/experience.rb +1 -1
- data/lib/platform_rest/experience_domain.rb +1 -1
- data/lib/platform_rest/experience_domains.rb +1 -1
- data/lib/platform_rest/experience_endpoint.rb +1 -1
- data/lib/platform_rest/experience_endpoints.rb +1 -1
- data/lib/platform_rest/experience_group.rb +1 -1
- data/lib/platform_rest/experience_groups.rb +1 -1
- data/lib/platform_rest/experience_slug.rb +1 -1
- data/lib/platform_rest/experience_slugs.rb +1 -1
- data/lib/platform_rest/experience_user.rb +1 -1
- data/lib/platform_rest/experience_users.rb +1 -1
- data/lib/platform_rest/experience_version.rb +1 -1
- data/lib/platform_rest/experience_versions.rb +1 -1
- data/lib/platform_rest/experience_view.rb +1 -1
- data/lib/platform_rest/experience_views.rb +1 -1
- data/lib/platform_rest/file.rb +1 -1
- data/lib/platform_rest/files.rb +1 -1
- data/lib/platform_rest/flow.rb +1 -1
- data/lib/platform_rest/flow_version.rb +1 -1
- data/lib/platform_rest/flow_versions.rb +1 -1
- data/lib/platform_rest/flows.rb +1 -1
- data/lib/platform_rest/instance.rb +1 -1
- data/lib/platform_rest/instance_api_token.rb +1 -1
- data/lib/platform_rest/instance_api_tokens.rb +1 -1
- data/lib/platform_rest/instance_audit_log.rb +1 -1
- data/lib/platform_rest/instance_audit_logs.rb +1 -1
- data/lib/platform_rest/instance_custom_node.rb +1 -1
- data/lib/platform_rest/instance_custom_nodes.rb +1 -1
- data/lib/platform_rest/instance_member.rb +1 -1
- data/lib/platform_rest/instance_members.rb +1 -1
- data/lib/platform_rest/instance_notification_rule.rb +1 -1
- data/lib/platform_rest/instance_notification_rules.rb +1 -1
- data/lib/platform_rest/instance_org.rb +1 -1
- data/lib/platform_rest/instance_org_invite.rb +1 -1
- data/lib/platform_rest/instance_org_invites.rb +1 -1
- data/lib/platform_rest/instance_org_member.rb +1 -1
- data/lib/platform_rest/instance_org_members.rb +1 -1
- data/lib/platform_rest/instance_orgs.rb +1 -1
- data/lib/platform_rest/instance_sandbox.rb +1 -1
- data/lib/platform_rest/instance_sandboxes.rb +1 -1
- data/lib/platform_rest/instances.rb +1 -1
- data/lib/platform_rest/integration.rb +1 -1
- data/lib/platform_rest/integrations.rb +1 -1
- data/lib/platform_rest/me.rb +1 -1
- data/lib/platform_rest/notebook.rb +1 -1
- data/lib/platform_rest/notebooks.rb +1 -1
- data/lib/platform_rest/org.rb +1 -1
- data/lib/platform_rest/org_invites.rb +1 -1
- data/lib/platform_rest/orgs.rb +1 -1
- data/lib/platform_rest/private_file.rb +1 -1
- data/lib/platform_rest/private_files.rb +1 -1
- data/lib/platform_rest/resource_job.rb +1 -1
- data/lib/platform_rest/resource_jobs.rb +1 -1
- data/lib/platform_rest/user_api_token.rb +1 -1
- data/lib/platform_rest/user_api_tokens.rb +1 -1
- data/lib/platform_rest/utils.rb +1 -1
- data/lib/platform_rest/version.rb +2 -2
- data/lib/platform_rest/webhook.rb +1 -1
- data/lib/platform_rest/webhooks.rb +1 -1
- data/lib/platform_rest.rb +1 -1
- data/losant_rest.gemspec +6 -5
- data/schemas/advancedApplicationKeyQuery.json +345 -0
- data/schemas/advancedDeviceQuery.json +36 -0
- data/schemas/advancedEventQuery.json +36 -0
- data/schemas/advancedExperienceGroupQuery.json +36 -0
- data/schemas/advancedExperienceUserQuery.json +36 -0
- data/schemas/advancedInstanceOrgQuery.json +36 -0
- data/schemas/apiTokenPost.json +0 -1
- data/schemas/applicationCertificate.json +5 -0
- data/schemas/applicationCertificates.json +5 -0
- data/schemas/applicationKey.json +45 -0
- data/schemas/applicationKeyPatch.json +28 -0
- data/schemas/applicationKeyPost.json +21 -0
- data/schemas/applicationKeyPostResponse.json +45 -0
- data/schemas/applicationKeys.json +45 -0
- data/schemas/credential.json +57 -2
- data/schemas/credentialPatch.json +29 -0
- data/schemas/credentialPost.json +39 -1
- data/schemas/credentials.json +57 -2
- data/schemas/devicesDataExport.json +36 -0
- data/schemas/devicesDeleteOrRestorePost.json +36 -0
- data/schemas/devicesExportPayloadCountPost.json +36 -0
- data/schemas/devicesExportPost.json +36 -0
- data/schemas/devicesPatch.json +36 -0
- data/schemas/devicesRemoveDataPost.json +36 -0
- data/schemas/event.json +4 -0
- data/schemas/eventPlusNewCount.json +4 -0
- data/schemas/eventPost.json +4 -0
- data/schemas/events.json +4 -0
- data/schemas/eventsExport.json +40 -0
- data/schemas/githubLogin.json +0 -1
- data/schemas/lastValueQuery.json +36 -0
- data/schemas/multiDeviceCommand.json +36 -0
- data/schemas/notebook.json +39 -0
- data/schemas/notebookPatch.json +39 -0
- data/schemas/notebookPost.json +39 -0
- data/schemas/notebooks.json +39 -0
- data/schemas/samlResponse.json +0 -1
- data/schemas/timeSeriesQuery.json +36 -0
- data/schemas/userCredentials.json +0 -1
- data/schemas/userPost.json +0 -1
- data/test/basic_test.rb +1 -1
- data/test/test_helper.rb +2 -1
- metadata +26 -15
data/docs/applicationKeys.md
CHANGED
|
@@ -31,11 +31,11 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
|
31
31
|
| Name | Type | Required | Description | Default | Example |
|
|
32
32
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
33
33
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
|
34
|
-
| sortField | string | N | Field to sort the results by. Accepted values are: key, status, id, creationDate, lastUpdated | creationDate | creationDate |
|
|
34
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: key, status, id, creationDate, lastUpdated, name | creationDate | creationDate |
|
|
35
35
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | asc |
|
|
36
36
|
| page | string | N | Which page of results to return | 0 | 0 |
|
|
37
37
|
| perPage | string | N | How many items to return per page | 100 | 10 |
|
|
38
|
-
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: key, status | | key |
|
|
38
|
+
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: key, status, name | | key |
|
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | the*key |
|
|
40
40
|
| query | [Advanced Application Key Query](_schemas.md#advanced-application-key-query) | N | Application key filter JSON object which overrides the filterField and filter parameters. | | [Advanced Application Key Query Example](_schemas.md#advanced-application-key-query-example) |
|
|
41
41
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
data/docs/events.md
CHANGED
|
@@ -203,7 +203,9 @@ all.Application, all.Organization, all.User, events.*, or events.patch.
|
|
|
203
203
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
|
|
204
204
|
| state | string | N | If provided, act on events only in the given state. Accepted values are: new, acknowledged, resolved | | new |
|
|
205
205
|
| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overrides the filterField, filter, and state parameters. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
|
|
206
|
-
|
|
|
206
|
+
| email | string | N | Email address to send a notification with update job results. Defaults to current user's email. | | email@example.com |
|
|
207
|
+
| callbackUrl | string | N | Callback URL to call with update results from a job. | | https://example.com/cburl |
|
|
208
|
+
| updates | [Event Patch](_schemas.md#event-patch) | Y | Object containing updated information for the events. | | [Event Patch Example](_schemas.md#event-patch-example) |
|
|
207
209
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
208
210
|
|
|
209
211
|
#### Successful Responses
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# The MIT License (MIT)
|
|
2
2
|
#
|
|
3
|
-
# Copyright (c)
|
|
3
|
+
# Copyright (c) 2026 SUSE
|
|
4
4
|
#
|
|
5
5
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
6
|
# of this software and associated documentation files (the "Software"), to deal
|
|
@@ -41,11 +41,11 @@ module PlatformRest
|
|
|
41
41
|
#
|
|
42
42
|
# Parameters:
|
|
43
43
|
# * {string} applicationId - ID associated with the application
|
|
44
|
-
# * {string} sortField - Field to sort the results by. Accepted values are: key, status, id, creationDate, lastUpdated
|
|
44
|
+
# * {string} sortField - Field to sort the results by. Accepted values are: key, status, id, creationDate, lastUpdated, name
|
|
45
45
|
# * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
|
|
46
46
|
# * {string} page - Which page of results to return
|
|
47
47
|
# * {string} perPage - How many items to return per page
|
|
48
|
-
# * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: key, status
|
|
48
|
+
# * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: key, status, name
|
|
49
49
|
# * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
|
|
50
50
|
# * {hash} query - Application key filter JSON object which overrides the filterField and filter parameters. (https://api.losant.com/#/definitions/advancedApplicationKeyQuery)
|
|
51
51
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
data/lib/platform_rest/auth.rb
CHANGED
data/lib/platform_rest/client.rb
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# The MIT License (MIT)
|
|
2
2
|
#
|
|
3
|
-
# Copyright (c)
|
|
3
|
+
# Copyright (c) 2026 SUSE
|
|
4
4
|
#
|
|
5
5
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
6
|
# of this software and associated documentation files (the "Software"), to deal
|
|
@@ -27,7 +27,7 @@ module PlatformRest
|
|
|
27
27
|
#
|
|
28
28
|
# User API for accessing platform data
|
|
29
29
|
#
|
|
30
|
-
# Built For Version 1.29.
|
|
30
|
+
# Built For Version 1.29.4
|
|
31
31
|
class Client
|
|
32
32
|
attr_accessor :auth_token, :url
|
|
33
33
|
|
|
@@ -430,7 +430,7 @@ module PlatformRest
|
|
|
430
430
|
|
|
431
431
|
headers["Accept"] = "application/json"
|
|
432
432
|
headers["Content-Type"] = "application/json"
|
|
433
|
-
headers["Accept-Version"] = "^1.29.
|
|
433
|
+
headers["Accept-Version"] = "^1.29.4"
|
|
434
434
|
headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
|
|
435
435
|
path = self.url + options.fetch(:path, "")
|
|
436
436
|
|
data/lib/platform_rest/data.rb
CHANGED
data/lib/platform_rest/device.rb
CHANGED
data/lib/platform_rest/error.rb
CHANGED
data/lib/platform_rest/event.rb
CHANGED
data/lib/platform_rest/events.rb
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# The MIT License (MIT)
|
|
2
2
|
#
|
|
3
|
-
# Copyright (c)
|
|
3
|
+
# Copyright (c) 2026 SUSE
|
|
4
4
|
#
|
|
5
5
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
6
|
# of this software and associated documentation files (the "Software"), to deal
|
|
@@ -251,7 +251,9 @@ module PlatformRest
|
|
|
251
251
|
# * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
|
|
252
252
|
# * {string} state - If provided, act on events only in the given state. Accepted values are: new, acknowledged, resolved
|
|
253
253
|
# * {hash} query - Event filter JSON object which overrides the filterField, filter, and state parameters. (https://api.losant.com/#/definitions/advancedEventQuery)
|
|
254
|
-
# * {
|
|
254
|
+
# * {string} email - Email address to send a notification with update job results. Defaults to current user's email.
|
|
255
|
+
# * {string} callbackUrl - Callback URL to call with update results from a job.
|
|
256
|
+
# * {hash} updates - Object containing updated information for the events. (https://api.losant.com/#/definitions/eventPatch)
|
|
255
257
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
|
256
258
|
# * {boolean} _actions - Return resource actions in response
|
|
257
259
|
# * {boolean} _links - Return resource link in response
|
|
@@ -278,6 +280,8 @@ module PlatformRest
|
|
|
278
280
|
query_params[:state] = params[:state] if params.has_key?(:state)
|
|
279
281
|
query_params[:query] = params[:query] if params.has_key?(:query)
|
|
280
282
|
query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
|
|
283
|
+
query_params[:email] = params[:email] if params.has_key?(:email)
|
|
284
|
+
query_params[:callbackUrl] = params[:callbackUrl] if params.has_key?(:callbackUrl)
|
|
281
285
|
body = params[:updates] if params.has_key?(:updates)
|
|
282
286
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
|
283
287
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
data/lib/platform_rest/file.rb
CHANGED
data/lib/platform_rest/files.rb
CHANGED