losant_rest 1.19.7 → 1.19.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/test.yml +30 -0
- data/README.md +2 -2
- data/docs/_schemas.md +3986 -227
- data/docs/devices.md +0 -1
- data/docs/instanceOrgs.md +1 -0
- data/lib/platform_rest/client.rb +2 -2
- data/lib/platform_rest/devices.rb +0 -1
- data/lib/platform_rest/instance_orgs.rb +3 -0
- data/lib/platform_rest/version.rb +1 -1
- data/schemas/advancedInstanceOrgQuery.json +1171 -0
- data/schemas/application.json +20 -4
- data/schemas/applicationCreationByTemplateResult.json +20 -4
- data/schemas/applicationDashboardPost.json +7 -0
- data/schemas/applicationTemplate.json +4 -0
- data/schemas/applicationTemplates.json +4 -0
- data/schemas/applications.json +20 -4
- data/schemas/credential.json +13 -1
- data/schemas/credentialLinkedResources.json +330 -18
- data/schemas/credentialPatch.json +22 -0
- data/schemas/credentialPost.json +31 -1
- data/schemas/credentials.json +13 -1
- data/schemas/dashboard.json +7 -0
- data/schemas/dashboardPatch.json +7 -0
- data/schemas/dashboardPost.json +7 -0
- data/schemas/dashboards.json +7 -0
- data/schemas/devicesExportPost.json +8 -0
- data/schemas/devicesRemoveDataPost.json +10 -0
- data/schemas/experienceLinkedResources.json +341 -18
- data/schemas/experienceView.json +11 -0
- data/schemas/experienceViewPatch.json +11 -0
- data/schemas/experienceViewPost.json +11 -0
- data/schemas/experienceViews.json +11 -0
- data/schemas/flow.json +110 -6
- data/schemas/flowPatch.json +110 -6
- data/schemas/flowPost.json +110 -6
- data/schemas/flowVersion.json +220 -12
- data/schemas/flowVersionPost.json +110 -6
- data/schemas/flowVersions.json +220 -12
- data/schemas/flows.json +110 -6
- data/schemas/flowsImportPost.json +220 -12
- data/schemas/flowsImportResult.json +330 -18
- data/schemas/historicalSummaries.json +40 -8
- data/schemas/historicalSummary.json +40 -8
- data/schemas/instanceCustomNodePatch.json +8 -6
- data/schemas/instanceCustomNodePost.json +8 -6
- data/schemas/instanceOrg.json +20 -4
- data/schemas/instanceOrgs.json +20 -4
- data/schemas/instanceSandbox.json +20 -4
- data/schemas/instanceSandboxes.json +20 -4
- data/schemas/me.json +20 -4
- data/schemas/notebook.json +8 -0
- data/schemas/notebookPatch.json +8 -0
- data/schemas/notebookPost.json +8 -0
- data/schemas/notebooks.json +8 -0
- data/schemas/org.json +20 -4
- data/schemas/orgs.json +20 -4
- data/schemas/payloadStats.json +20 -4
- data/schemas/webhook.json +13 -0
- data/schemas/webhookPatch.json +13 -0
- data/schemas/webhookPost.json +13 -0
- data/schemas/webhooks.json +13 -0
- metadata +4 -3
- data/.travis.yml +0 -7
data/docs/devices.md
CHANGED
@@ -427,7 +427,6 @@ all.Application, all.Organization, all.User, devices.*, or devices.removeData.
|
|
427
427
|
|
428
428
|
| Code | Type | Description |
|
429
429
|
| ---- | ---- | ----------- |
|
430
|
-
| 200 | [Devices Data Removed](_schemas.md#devices-data-removed) | Object indicating number of devices completed or skipped |
|
431
430
|
| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for device data to be removed |
|
432
431
|
|
433
432
|
#### Error Responses
|
data/docs/instanceOrgs.md
CHANGED
@@ -38,6 +38,7 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgs.*, or ins
|
|
38
38
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*org |
|
40
40
|
| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
|
41
|
+
| query | [Advanced Instance Organization Query](_schemas.md#advanced-instance-organization-query) | N | Organization filter JSON object which overrides all other filter params. | | [Advanced Instance Organization Query Example](_schemas.md#advanced-instance-organization-query-example) |
|
41
42
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
42
43
|
|
43
44
|
#### Successful Responses
|
data/lib/platform_rest/client.rb
CHANGED
@@ -27,7 +27,7 @@ module PlatformRest
|
|
27
27
|
#
|
28
28
|
# User API for accessing platform data
|
29
29
|
#
|
30
|
-
# Built For Version 1.26.
|
30
|
+
# Built For Version 1.26.9
|
31
31
|
class Client
|
32
32
|
attr_accessor :auth_token, :url
|
33
33
|
|
@@ -398,7 +398,7 @@ module PlatformRest
|
|
398
398
|
|
399
399
|
headers["Accept"] = "application/json"
|
400
400
|
headers["Content-Type"] = "application/json"
|
401
|
-
headers["Accept-Version"] = "^1.26.
|
401
|
+
headers["Accept-Version"] = "^1.26.9"
|
402
402
|
headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
|
403
403
|
path = self.url + options.fetch(:path, "")
|
404
404
|
|
@@ -523,7 +523,6 @@ module PlatformRest
|
|
523
523
|
# * {boolean} _embedded - Return embedded resources in response
|
524
524
|
#
|
525
525
|
# Responses:
|
526
|
-
# * 200 - Object indicating number of devices completed or skipped (https://api.losant.com/#/definitions/devicesDataRemoved)
|
527
526
|
# * 202 - If a job was enqueued for device data to be removed (https://api.losant.com/#/definitions/jobEnqueuedResult)
|
528
527
|
#
|
529
528
|
# Errors:
|
@@ -48,6 +48,7 @@ module PlatformRest
|
|
48
48
|
# * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
|
49
49
|
# * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
|
50
50
|
# * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
|
51
|
+
# * {hash} query - Organization filter JSON object which overrides all other filter params. (https://api.losant.com/#/definitions/advancedInstanceOrgQuery)
|
51
52
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
52
53
|
# * {boolean} _actions - Return resource actions in response
|
53
54
|
# * {boolean} _links - Return resource link in response
|
@@ -73,6 +74,8 @@ module PlatformRest
|
|
73
74
|
query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
|
74
75
|
query_params[:filter] = params[:filter] if params.has_key?(:filter)
|
75
76
|
query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
|
77
|
+
query_params[:query] = params[:query] if params.has_key?(:query)
|
78
|
+
query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
|
76
79
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
77
80
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
78
81
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|