losant_rest 1.11.1 → 1.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +1 -1
- data/docs/_schemas.md +34959 -19022
- data/docs/application.md +46 -5
- data/docs/applicationApiTokens.md +1 -1
- data/docs/applicationDashboard.md +133 -0
- data/docs/applicationDashboards.md +93 -0
- data/docs/applicationKeys.md +3 -2
- data/docs/applications.md +1 -1
- data/docs/dataTable.md +1 -1
- data/docs/dataTableRows.md +1 -1
- data/docs/dataTables.md +1 -1
- data/docs/device.md +43 -0
- data/docs/devices.md +41 -2
- data/docs/edgeDeployment.md +49 -0
- data/docs/events.md +3 -3
- data/docs/experience.md +1 -1
- data/docs/experienceDomains.md +1 -1
- data/docs/experienceEndpoint.md +1 -0
- data/docs/experienceGroup.md +2 -0
- data/docs/experienceSlugs.md +1 -1
- data/docs/experienceVersion.md +3 -3
- data/docs/experienceVersions.md +2 -2
- data/docs/experienceView.md +4 -4
- data/docs/experienceViews.md +2 -2
- data/docs/file.md +5 -5
- data/docs/files.md +2 -2
- data/docs/flow.md +41 -0
- data/docs/flowVersions.md +44 -0
- data/docs/flows.md +1 -0
- data/docs/instance.md +166 -0
- data/docs/instanceApiToken.md +133 -0
- data/docs/instanceApiTokens.md +91 -0
- data/docs/instanceMember.md +133 -0
- data/docs/instanceMembers.md +91 -0
- data/docs/instanceOrg.md +135 -0
- data/docs/instanceOrgInvite.md +139 -0
- data/docs/instanceOrgInvites.md +96 -0
- data/docs/instanceOrgMember.md +139 -0
- data/docs/instanceOrgMembers.md +96 -0
- data/docs/instanceOrgs.md +91 -0
- data/docs/instances.md +50 -0
- data/docs/integration.md +1 -0
- data/docs/me.md +1 -1
- data/docs/org.md +1 -1
- data/docs/userApiToken.md +125 -0
- data/docs/userApiTokens.md +87 -0
- data/docs/webhook.md +1 -0
- data/lib/losant_rest.rb +18 -1
- data/lib/losant_rest/application.rb +53 -6
- data/lib/losant_rest/application_api_token.rb +1 -1
- data/lib/losant_rest/application_api_tokens.rb +2 -2
- data/lib/losant_rest/application_certificate.rb +1 -1
- data/lib/losant_rest/application_certificate_authorities.rb +1 -1
- data/lib/losant_rest/application_certificate_authority.rb +1 -1
- data/lib/losant_rest/application_certificates.rb +1 -1
- data/lib/losant_rest/application_dashboard.rb +176 -0
- data/lib/losant_rest/application_dashboards.rb +138 -0
- data/lib/losant_rest/application_key.rb +1 -1
- data/lib/losant_rest/application_keys.rb +4 -1
- data/lib/losant_rest/application_template.rb +1 -1
- data/lib/losant_rest/application_templates.rb +1 -1
- data/lib/losant_rest/applications.rb +2 -2
- data/lib/losant_rest/audit_log.rb +1 -1
- data/lib/losant_rest/audit_logs.rb +1 -1
- data/lib/losant_rest/auth.rb +1 -1
- data/lib/losant_rest/client.rb +71 -3
- data/lib/losant_rest/dashboard.rb +1 -1
- data/lib/losant_rest/dashboards.rb +1 -1
- data/lib/losant_rest/data.rb +1 -1
- data/lib/losant_rest/data_table.rb +2 -2
- data/lib/losant_rest/data_table_row.rb +1 -1
- data/lib/losant_rest/data_table_rows.rb +2 -2
- data/lib/losant_rest/data_tables.rb +2 -2
- data/lib/losant_rest/device.rb +51 -1
- data/lib/losant_rest/device_recipe.rb +1 -1
- data/lib/losant_rest/device_recipes.rb +1 -1
- data/lib/losant_rest/devices.rb +49 -3
- data/lib/losant_rest/edge_deployment.rb +81 -0
- data/lib/losant_rest/edge_deployments.rb +1 -1
- data/lib/losant_rest/error.rb +1 -1
- data/lib/losant_rest/event.rb +1 -1
- data/lib/losant_rest/events.rb +4 -4
- data/lib/losant_rest/experience.rb +2 -2
- data/lib/losant_rest/experience_domain.rb +1 -1
- data/lib/losant_rest/experience_domains.rb +2 -2
- data/lib/losant_rest/experience_endpoint.rb +3 -1
- data/lib/losant_rest/experience_endpoints.rb +1 -1
- data/lib/losant_rest/experience_group.rb +5 -1
- data/lib/losant_rest/experience_groups.rb +1 -1
- data/lib/losant_rest/experience_slug.rb +1 -1
- data/lib/losant_rest/experience_slugs.rb +2 -2
- data/lib/losant_rest/experience_user.rb +1 -1
- data/lib/losant_rest/experience_users.rb +1 -1
- data/lib/losant_rest/experience_version.rb +4 -4
- data/lib/losant_rest/experience_versions.rb +3 -3
- data/lib/losant_rest/experience_view.rb +5 -5
- data/lib/losant_rest/experience_views.rb +3 -3
- data/lib/losant_rest/file.rb +5 -5
- data/lib/losant_rest/files.rb +3 -3
- data/lib/losant_rest/flow.rb +47 -1
- data/lib/losant_rest/flow_version.rb +1 -1
- data/lib/losant_rest/flow_versions.rb +51 -1
- data/lib/losant_rest/flows.rb +3 -1
- data/lib/losant_rest/instance.rb +226 -0
- data/lib/losant_rest/instance_api_token.rb +176 -0
- data/lib/losant_rest/instance_api_tokens.rb +136 -0
- data/lib/losant_rest/instance_member.rb +176 -0
- data/lib/losant_rest/instance_members.rb +134 -0
- data/lib/losant_rest/instance_org.rb +180 -0
- data/lib/losant_rest/instance_org_invite.rb +182 -0
- data/lib/losant_rest/instance_org_invites.rb +138 -0
- data/lib/losant_rest/instance_org_member.rb +182 -0
- data/lib/losant_rest/instance_org_members.rb +138 -0
- data/lib/losant_rest/instance_orgs.rb +139 -0
- data/lib/losant_rest/instances.rb +88 -0
- data/lib/losant_rest/integration.rb +3 -1
- data/lib/losant_rest/integrations.rb +1 -1
- data/lib/losant_rest/me.rb +2 -2
- data/lib/losant_rest/notebook.rb +1 -1
- data/lib/losant_rest/notebooks.rb +1 -1
- data/lib/losant_rest/org.rb +2 -2
- data/lib/losant_rest/org_invites.rb +1 -1
- data/lib/losant_rest/orgs.rb +1 -1
- data/lib/losant_rest/user_api_token.rb +170 -0
- data/lib/losant_rest/user_api_tokens.rb +132 -0
- data/lib/losant_rest/utils.rb +1 -1
- data/lib/losant_rest/version.rb +2 -2
- data/lib/losant_rest/webhook.rb +3 -1
- data/lib/losant_rest/webhooks.rb +1 -1
- data/schemas/advancedApplicationKeyQuery.json +1082 -0
- data/schemas/advancedDeviceQuery.json +309 -0
- data/schemas/advancedFlowQuery.json +218 -0
- data/schemas/advancedFlowVersionQuery.json +218 -0
- data/schemas/apiToken.json +2 -1
- data/schemas/apiTokenPost.json +431 -0
- data/schemas/apiTokens.json +4 -2
- data/schemas/applicationApiTokenPost.json +8 -0
- data/schemas/applicationDashboardPost.json +5687 -0
- data/schemas/applicationGlobalPatch.json +33 -0
- data/schemas/auditLog.json +4 -0
- data/schemas/auditLogFilter.json +4 -0
- data/schemas/auditLogs.json +4 -0
- data/schemas/bulkDeleteResponse.json +12 -0
- data/schemas/dashboard.json +66 -17
- data/schemas/dashboardPatch.json +66 -17
- data/schemas/dashboardPost.json +66 -17
- data/schemas/dashboardSendReport.json +4 -0
- data/schemas/dashboards.json +66 -17
- data/schemas/devicePayloadCounts.json +24 -0
- data/schemas/devicesDeletePost.json +309 -0
- data/schemas/devicesExportPayloadCountPost.json +1350 -0
- data/schemas/devicesExportPost.json +309 -0
- data/schemas/devicesPatch.json +309 -0
- data/schemas/devicesRemoveDataPost.json +309 -0
- data/schemas/edgeDeployment.json +16 -0
- data/schemas/edgeDeployments.json +16 -0
- data/schemas/experienceGroup.json +6 -0
- data/schemas/experienceGroups.json +6 -0
- data/schemas/experienceLinkedResources.json +45 -0
- data/schemas/filePost.json +8 -2
- data/schemas/files.json +3 -0
- data/schemas/flow.json +15 -0
- data/schemas/flowPatch.json +15 -0
- data/schemas/flowPost.json +15 -0
- data/schemas/flowStorageMetadata.json +13 -0
- data/schemas/flowVersion.json +30 -0
- data/schemas/flowVersionPost.json +15 -0
- data/schemas/flowVersions.json +30 -0
- data/schemas/flowVersionsDeletePost.json +941 -0
- data/schemas/flows.json +15 -0
- data/schemas/flowsImportPost.json +30 -0
- data/schemas/flowsImportResult.json +45 -0
- data/schemas/githubLogin.json +72 -1
- data/schemas/historicalSummaries.json +43 -0
- data/schemas/historicalSummary.json +490 -0
- data/schemas/instance.json +192 -0
- data/schemas/instanceMember.json +41 -0
- data/schemas/instanceMemberPatch.json +17 -0
- data/schemas/instanceMemberPost.json +37 -0
- data/schemas/instanceMembers.json +77 -0
- data/schemas/instanceOrg.json +133 -0
- data/schemas/instanceOrgMember.json +45 -0
- data/schemas/instanceOrgMemberPatch.json +69 -0
- data/schemas/instanceOrgMemberPost.json +161 -0
- data/schemas/instanceOrgMembers.json +42 -0
- data/schemas/instanceOrgPatch.json +122 -0
- data/schemas/instanceOrgPost.json +291 -0
- data/schemas/instanceOrgs.json +178 -0
- data/schemas/instancePatch.json +67 -0
- data/schemas/instanceReportOptionsPost.json +41 -0
- data/schemas/instances.json +43 -0
- data/schemas/me.json +30 -14
- data/schemas/multiDeviceCommand.json +309 -0
- data/schemas/notebook.json +45 -0
- data/schemas/notebookPatch.json +30 -0
- data/schemas/notebookPost.json +30 -0
- data/schemas/notebooks.json +45 -0
- data/schemas/org.json +30 -14
- data/schemas/orgInvite.json +90 -0
- data/schemas/orgInviteCollection.json +130 -0
- data/schemas/orgInvites.json +82 -77
- data/schemas/orgPatch.json +0 -9
- data/schemas/orgRoleInfo.json +69 -0
- data/schemas/orgs.json +30 -14
- data/schemas/payloadStats.json +126 -0
- data/schemas/userCredentials.json +72 -1
- data/schemas/userPost.json +72 -1
- data/schemas/validateContextError.json +34 -0
- data/schemas/validateContextSuccess.json +34 -0
- data/schemas/virtualButtonPress.json +4 -0
- metadata +68 -3
@@ -0,0 +1,138 @@
|
|
1
|
+
# The MIT License (MIT)
|
2
|
+
#
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
4
|
+
#
|
5
|
+
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
# of this software and associated documentation files (the "Software"), to deal
|
7
|
+
# in the Software without restriction, including without limitation the rights
|
8
|
+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
# copies of the Software, and to permit persons to whom the Software is
|
10
|
+
# furnished to do so, subject to the following conditions:
|
11
|
+
#
|
12
|
+
# The above copyright notice and this permission notice shall be included in all
|
13
|
+
# copies or substantial portions of the Software.
|
14
|
+
#
|
15
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
# SOFTWARE.
|
22
|
+
|
23
|
+
require "json"
|
24
|
+
|
25
|
+
module LosantRest
|
26
|
+
|
27
|
+
# Class containing all the actions for the Application Dashboards Resource
|
28
|
+
class ApplicationDashboards
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Returns all dashboards scoped to the given application.
|
35
|
+
#
|
36
|
+
# Authentication:
|
37
|
+
# The client must be configured with a valid api
|
38
|
+
# access token to call this action. The token
|
39
|
+
# must include at least one of the following scopes:
|
40
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationDashboards.*, or applicationDashboards.get.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} applicationId - ID associated with the application
|
44
|
+
# * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate
|
45
|
+
# * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
|
46
|
+
# * {string} page - Which page of results to return
|
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: name
|
49
|
+
# * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
|
50
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
51
|
+
# * {boolean} _actions - Return resource actions in response
|
52
|
+
# * {boolean} _links - Return resource link in response
|
53
|
+
# * {boolean} _embedded - Return embedded resources in response
|
54
|
+
#
|
55
|
+
# Responses:
|
56
|
+
# * 200 - Collection of dashboards (https://api.losant.com/#/definitions/dashboards)
|
57
|
+
#
|
58
|
+
# Errors:
|
59
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
60
|
+
# * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
|
61
|
+
def get(params = {})
|
62
|
+
params = Utils.symbolize_hash_keys(params)
|
63
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
64
|
+
headers = {}
|
65
|
+
body = nil
|
66
|
+
|
67
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
68
|
+
|
69
|
+
query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
|
70
|
+
query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
|
71
|
+
query_params[:page] = params[:page] if params.has_key?(:page)
|
72
|
+
query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
|
73
|
+
query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
|
74
|
+
query_params[:filter] = params[:filter] if params.has_key?(:filter)
|
75
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
76
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
77
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
78
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
79
|
+
|
80
|
+
path = "/applications/#{params[:applicationId]}/dashboards"
|
81
|
+
|
82
|
+
@client.request(
|
83
|
+
method: :get,
|
84
|
+
path: path,
|
85
|
+
query: query_params,
|
86
|
+
headers: headers,
|
87
|
+
body: body)
|
88
|
+
end
|
89
|
+
|
90
|
+
# Create a new dashboard
|
91
|
+
#
|
92
|
+
# Authentication:
|
93
|
+
# The client must be configured with a valid api
|
94
|
+
# access token to call this action. The token
|
95
|
+
# must include at least one of the following scopes:
|
96
|
+
# all.Application, all.Organization, all.User, applicationDashboards.*, or applicationDashboards.post.
|
97
|
+
#
|
98
|
+
# Parameters:
|
99
|
+
# * {string} applicationId - ID associated with the application
|
100
|
+
# * {hash} dashboard - New dashboard information (https://api.losant.com/#/definitions/applicationDashboardPost)
|
101
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
102
|
+
# * {boolean} _actions - Return resource actions in response
|
103
|
+
# * {boolean} _links - Return resource link in response
|
104
|
+
# * {boolean} _embedded - Return embedded resources in response
|
105
|
+
#
|
106
|
+
# Responses:
|
107
|
+
# * 201 - Successfully created dashboard (https://api.losant.com/#/definitions/dashboard)
|
108
|
+
#
|
109
|
+
# Errors:
|
110
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
111
|
+
# * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
|
112
|
+
def post(params = {})
|
113
|
+
params = Utils.symbolize_hash_keys(params)
|
114
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
115
|
+
headers = {}
|
116
|
+
body = nil
|
117
|
+
|
118
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
119
|
+
raise ArgumentError.new("dashboard is required") unless params.has_key?(:dashboard)
|
120
|
+
|
121
|
+
body = params[:dashboard] if params.has_key?(:dashboard)
|
122
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
123
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
124
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
125
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
126
|
+
|
127
|
+
path = "/applications/#{params[:applicationId]}/dashboards"
|
128
|
+
|
129
|
+
@client.request(
|
130
|
+
method: :post,
|
131
|
+
path: path,
|
132
|
+
query: query_params,
|
133
|
+
headers: headers,
|
134
|
+
body: body)
|
135
|
+
end
|
136
|
+
|
137
|
+
end
|
138
|
+
end
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -47,6 +47,7 @@ module LosantRest
|
|
47
47
|
# * {string} perPage - How many items to return per page
|
48
48
|
# * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: key, status
|
49
49
|
# * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
|
50
|
+
# * {hash} query - Application key filter JSON object which overrides the filterField and filter parameters. (https://api.losant.com/#/definitions/advancedApplicationKeyQuery)
|
50
51
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
51
52
|
# * {boolean} _actions - Return resource actions in response
|
52
53
|
# * {boolean} _links - Return resource link in response
|
@@ -72,6 +73,8 @@ module LosantRest
|
|
72
73
|
query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
|
73
74
|
query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
|
74
75
|
query_params[:filter] = params[:filter] if params.has_key?(:filter)
|
76
|
+
query_params[:query] = params[:query] if params.has_key?(:query)
|
77
|
+
query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
|
75
78
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
76
79
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
77
80
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -37,7 +37,7 @@ module LosantRest
|
|
37
37
|
# The client must be configured with a valid api
|
38
38
|
# access token to call this action. The token
|
39
39
|
# must include at least one of the following scopes:
|
40
|
-
# all.Organization, all.Organization.read, all.User, all.User.read, applications.*, or applications.get.
|
40
|
+
# all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, applications.*, or applications.get.
|
41
41
|
#
|
42
42
|
# Parameters:
|
43
43
|
# * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, lastUpdated
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
data/lib/losant_rest/auth.rb
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
data/lib/losant_rest/client.rb
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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 LosantRest
|
|
27
27
|
#
|
28
28
|
# User API for accessing Losant data
|
29
29
|
#
|
30
|
-
# Built For Version 1.
|
30
|
+
# Built For Version 1.21.0
|
31
31
|
class Client
|
32
32
|
attr_accessor :auth_token, :url
|
33
33
|
|
@@ -64,6 +64,14 @@ module LosantRest
|
|
64
64
|
@application_certificates ||= ApplicationCertificates.new(self)
|
65
65
|
end
|
66
66
|
|
67
|
+
def application_dashboard
|
68
|
+
@application_dashboard ||= ApplicationDashboard.new(self)
|
69
|
+
end
|
70
|
+
|
71
|
+
def application_dashboards
|
72
|
+
@application_dashboards ||= ApplicationDashboards.new(self)
|
73
|
+
end
|
74
|
+
|
67
75
|
def application_key
|
68
76
|
@application_key ||= ApplicationKey.new(self)
|
69
77
|
end
|
@@ -140,6 +148,10 @@ module LosantRest
|
|
140
148
|
@devices ||= Devices.new(self)
|
141
149
|
end
|
142
150
|
|
151
|
+
def edge_deployment
|
152
|
+
@edge_deployment ||= EdgeDeployment.new(self)
|
153
|
+
end
|
154
|
+
|
143
155
|
def edge_deployments
|
144
156
|
@edge_deployments ||= EdgeDeployments.new(self)
|
145
157
|
end
|
@@ -236,6 +248,54 @@ module LosantRest
|
|
236
248
|
@flows ||= Flows.new(self)
|
237
249
|
end
|
238
250
|
|
251
|
+
def instance
|
252
|
+
@instance ||= Instance.new(self)
|
253
|
+
end
|
254
|
+
|
255
|
+
def instance_api_token
|
256
|
+
@instance_api_token ||= InstanceApiToken.new(self)
|
257
|
+
end
|
258
|
+
|
259
|
+
def instance_api_tokens
|
260
|
+
@instance_api_tokens ||= InstanceApiTokens.new(self)
|
261
|
+
end
|
262
|
+
|
263
|
+
def instance_member
|
264
|
+
@instance_member ||= InstanceMember.new(self)
|
265
|
+
end
|
266
|
+
|
267
|
+
def instance_members
|
268
|
+
@instance_members ||= InstanceMembers.new(self)
|
269
|
+
end
|
270
|
+
|
271
|
+
def instance_org
|
272
|
+
@instance_org ||= InstanceOrg.new(self)
|
273
|
+
end
|
274
|
+
|
275
|
+
def instance_org_invite
|
276
|
+
@instance_org_invite ||= InstanceOrgInvite.new(self)
|
277
|
+
end
|
278
|
+
|
279
|
+
def instance_org_invites
|
280
|
+
@instance_org_invites ||= InstanceOrgInvites.new(self)
|
281
|
+
end
|
282
|
+
|
283
|
+
def instance_org_member
|
284
|
+
@instance_org_member ||= InstanceOrgMember.new(self)
|
285
|
+
end
|
286
|
+
|
287
|
+
def instance_org_members
|
288
|
+
@instance_org_members ||= InstanceOrgMembers.new(self)
|
289
|
+
end
|
290
|
+
|
291
|
+
def instance_orgs
|
292
|
+
@instance_orgs ||= InstanceOrgs.new(self)
|
293
|
+
end
|
294
|
+
|
295
|
+
def instances
|
296
|
+
@instances ||= Instances.new(self)
|
297
|
+
end
|
298
|
+
|
239
299
|
def integration
|
240
300
|
@integration ||= Integration.new(self)
|
241
301
|
end
|
@@ -268,6 +328,14 @@ module LosantRest
|
|
268
328
|
@orgs ||= Orgs.new(self)
|
269
329
|
end
|
270
330
|
|
331
|
+
def user_api_token
|
332
|
+
@user_api_token ||= UserApiToken.new(self)
|
333
|
+
end
|
334
|
+
|
335
|
+
def user_api_tokens
|
336
|
+
@user_api_tokens ||= UserApiTokens.new(self)
|
337
|
+
end
|
338
|
+
|
271
339
|
def webhook
|
272
340
|
@webhook ||= Webhook.new(self)
|
273
341
|
end
|
@@ -282,7 +350,7 @@ module LosantRest
|
|
282
350
|
|
283
351
|
headers["Accept"] = "application/json"
|
284
352
|
headers["Content-Type"] = "application/json"
|
285
|
-
headers["Accept-Version"] = "^1.
|
353
|
+
headers["Accept-Version"] = "^1.21.0"
|
286
354
|
headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
|
287
355
|
path = self.url + options.fetch(:path, "")
|
288
356
|
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
data/lib/losant_rest/data.rb
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -132,7 +132,7 @@ module LosantRest
|
|
132
132
|
# The client must be configured with a valid api
|
133
133
|
# access token to call this action. The token
|
134
134
|
# must include at least one of the following scopes:
|
135
|
-
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTable.*, or dataTable.get.
|
135
|
+
# all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTable.*, or dataTable.get.
|
136
136
|
#
|
137
137
|
# Parameters:
|
138
138
|
# * {string} applicationId - ID associated with the application
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -136,7 +136,7 @@ module LosantRest
|
|
136
136
|
# The client must be configured with a valid api
|
137
137
|
# access token to call this action. The token
|
138
138
|
# must include at least one of the following scopes:
|
139
|
-
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTableRows.*, or dataTableRows.get.
|
139
|
+
# all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTableRows.*, or dataTableRows.get.
|
140
140
|
#
|
141
141
|
# Parameters:
|
142
142
|
# * {string} applicationId - ID associated with the application
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -37,7 +37,7 @@ module LosantRest
|
|
37
37
|
# The client must be configured with a valid api
|
38
38
|
# access token to call this action. The token
|
39
39
|
# must include at least one of the following scopes:
|
40
|
-
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTables.*, or dataTables.get.
|
40
|
+
# all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTables.*, or dataTables.get.
|
41
41
|
#
|
42
42
|
# Parameters:
|
43
43
|
# * {string} applicationId - ID associated with the application
|
data/lib/losant_rest/device.rb
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# The MIT License (MIT)
|
2
2
|
#
|
3
|
-
# Copyright (c)
|
3
|
+
# Copyright (c) 2021 Losant IoT, Inc.
|
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
|
@@ -438,6 +438,56 @@ module LosantRest
|
|
438
438
|
body: body)
|
439
439
|
end
|
440
440
|
|
441
|
+
# Returns payload counts for the time range specified for this device
|
442
|
+
#
|
443
|
+
# Authentication:
|
444
|
+
# The client must be configured with a valid api
|
445
|
+
# access token to call this action. The token
|
446
|
+
# must include at least one of the following scopes:
|
447
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.payloadCounts.
|
448
|
+
#
|
449
|
+
# Parameters:
|
450
|
+
# * {string} applicationId - ID associated with the application
|
451
|
+
# * {string} deviceId - ID associated with the device
|
452
|
+
# * {string} start - Start of range for payload count query (ms since epoch)
|
453
|
+
# * {string} end - End of range for payload count query (ms since epoch)
|
454
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
455
|
+
# * {boolean} _actions - Return resource actions in response
|
456
|
+
# * {boolean} _links - Return resource link in response
|
457
|
+
# * {boolean} _embedded - Return embedded resources in response
|
458
|
+
#
|
459
|
+
# Responses:
|
460
|
+
# * 200 - Payload counts, by type (https://api.losant.com/#/definitions/devicePayloadCounts)
|
461
|
+
#
|
462
|
+
# Errors:
|
463
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
464
|
+
# * 404 - Error if device was not found (https://api.losant.com/#/definitions/error)
|
465
|
+
def payload_counts(params = {})
|
466
|
+
params = Utils.symbolize_hash_keys(params)
|
467
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
468
|
+
headers = {}
|
469
|
+
body = nil
|
470
|
+
|
471
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
472
|
+
raise ArgumentError.new("deviceId is required") unless params.has_key?(:deviceId)
|
473
|
+
|
474
|
+
query_params[:start] = params[:start] if params.has_key?(:start)
|
475
|
+
query_params[:end] = params[:end] if params.has_key?(:end)
|
476
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
477
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
478
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
479
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
480
|
+
|
481
|
+
path = "/applications/#{params[:applicationId]}/devices/#{params[:deviceId]}/payloadCounts"
|
482
|
+
|
483
|
+
@client.request(
|
484
|
+
method: :get,
|
485
|
+
path: path,
|
486
|
+
query: query_params,
|
487
|
+
headers: headers,
|
488
|
+
body: body)
|
489
|
+
end
|
490
|
+
|
441
491
|
# Removes all device data for the specified time range. Defaults to all data.
|
442
492
|
#
|
443
493
|
# Authentication:
|