losant_rest 1.12.0 → 1.14.1
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 +17509 -8097
- data/docs/application.md +6 -6
- data/docs/applicationApiTokens.md +1 -1
- 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/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/instance.md +168 -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/me.md +1 -1
- data/docs/org.md +1 -1
- data/docs/userApiToken.md +125 -0
- data/docs/userApiTokens.md +87 -0
- data/lib/losant_rest/application.rb +7 -7
- 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 +1 -1
- data/lib/losant_rest/application_dashboards.rb +1 -1
- data/lib/losant_rest/application_key.rb +1 -1
- data/lib/losant_rest/application_keys.rb +1 -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 +63 -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 +1 -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 +1 -1
- data/lib/losant_rest/instance.rb +227 -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 +1 -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 +1 -1
- data/lib/losant_rest/webhooks.rb +1 -1
- data/lib/losant_rest.rb +16 -1
- data/schemas/advancedDeviceQuery.json +309 -0
- data/schemas/apiToken.json +2 -1
- data/schemas/apiTokenPost.json +431 -0
- data/schemas/apiTokens.json +4 -2
- data/schemas/applicationApiTokenPost.json +1 -0
- data/schemas/applicationDashboardPost.json +39 -17
- 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 +39 -17
- data/schemas/dashboardPatch.json +39 -17
- data/schemas/dashboardPost.json +39 -17
- data/schemas/dashboardSendReport.json +4 -0
- data/schemas/dashboards.json +39 -17
- data/schemas/dataTableRowsDelete.json +1 -1
- 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/eventsDeleted.json +1 -1
- data/schemas/experienceGroup.json +6 -0
- data/schemas/experienceGroups.json +6 -0
- data/schemas/experienceLinkedResources.json +381 -6
- data/schemas/filePost.json +8 -2
- data/schemas/flow.json +127 -2
- data/schemas/flowPatch.json +127 -2
- data/schemas/flowPost.json +127 -2
- data/schemas/flowStorageMetadata.json +13 -0
- data/schemas/flowVersion.json +254 -4
- data/schemas/flowVersionPost.json +127 -2
- data/schemas/flowVersions.json +254 -4
- data/schemas/flowVersionsDeletePost.json +941 -0
- data/schemas/flows.json +127 -2
- data/schemas/flowsImportPost.json +254 -4
- data/schemas/flowsImportResult.json +381 -6
- data/schemas/githubLogin.json +64 -11
- data/schemas/historicalSummaries.json +43 -0
- data/schemas/historicalSummary.json +490 -0
- data/schemas/instance.json +60 -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 +14 -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 +19 -0
- data/schemas/instanceOrgPost.json +177 -0
- data/schemas/instanceOrgs.json +18 -0
- data/schemas/instancePatch.json +67 -0
- data/schemas/instanceReportOptionsPost.json +41 -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 +64 -11
- data/schemas/userPost.json +64 -11
- data/schemas/validateContextError.json +34 -0
- data/schemas/validateContextSuccess.json +34 -0
- data/schemas/virtualButtonPress.json +4 -0
- metadata +55 -3
data/lib/losant_rest/files.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
|
@@ -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, files.*, or files.get.
|
40
|
+
# all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, files.*, or files.get.
|
41
41
|
#
|
42
42
|
# Parameters:
|
43
43
|
# * {string} applicationId - ID associated with the application
|
@@ -99,7 +99,7 @@ module LosantRest
|
|
99
99
|
# The client must be configured with a valid api
|
100
100
|
# access token to call this action. The token
|
101
101
|
# must include at least one of the following scopes:
|
102
|
-
# all.Application, all.Organization, all.User, files.*, or files.post.
|
102
|
+
# all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, files.*, or files.post.
|
103
103
|
#
|
104
104
|
# Parameters:
|
105
105
|
# * {string} applicationId - ID associated with the application
|
data/lib/losant_rest/flow.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
|
@@ -325,6 +325,52 @@ module LosantRest
|
|
325
325
|
body: body)
|
326
326
|
end
|
327
327
|
|
328
|
+
# Gets metadata about storage for this flow
|
329
|
+
#
|
330
|
+
# Authentication:
|
331
|
+
# The client must be configured with a valid api
|
332
|
+
# access token to call this action. The token
|
333
|
+
# must include at least one of the following scopes:
|
334
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.getStorageEntriesMetadata.
|
335
|
+
#
|
336
|
+
# Parameters:
|
337
|
+
# * {string} applicationId - ID associated with the application
|
338
|
+
# * {string} flowId - ID associated with the flow
|
339
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
340
|
+
# * {boolean} _actions - Return resource actions in response
|
341
|
+
# * {boolean} _links - Return resource link in response
|
342
|
+
# * {boolean} _embedded - Return embedded resources in response
|
343
|
+
#
|
344
|
+
# Responses:
|
345
|
+
# * 200 - The meta data for the current storage entries (https://api.losant.com/#/definitions/flowStorageMetadata)
|
346
|
+
#
|
347
|
+
# Errors:
|
348
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
349
|
+
# * 404 - Error if flow was not found (https://api.losant.com/#/definitions/error)
|
350
|
+
def get_storage_entries_metadata(params = {})
|
351
|
+
params = Utils.symbolize_hash_keys(params)
|
352
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
353
|
+
headers = {}
|
354
|
+
body = nil
|
355
|
+
|
356
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
357
|
+
raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
|
358
|
+
|
359
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
360
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
361
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
362
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
363
|
+
|
364
|
+
path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/storage-metadata"
|
365
|
+
|
366
|
+
@client.request(
|
367
|
+
method: :get,
|
368
|
+
path: path,
|
369
|
+
query: query_params,
|
370
|
+
headers: headers,
|
371
|
+
body: body)
|
372
|
+
end
|
373
|
+
|
328
374
|
# Updates information about a flow
|
329
375
|
#
|
330
376
|
# Authentication:
|
@@ -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
|
@@ -31,6 +31,56 @@ module LosantRest
|
|
31
31
|
@client = client
|
32
32
|
end
|
33
33
|
|
34
|
+
# Delete flow versions
|
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.Organization, all.User, flowVersions.*, or flowVersions.delete.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} applicationId - ID associated with the application
|
44
|
+
# * {string} flowId - ID associated with the flow
|
45
|
+
# * {hash} options - Object containing flow version deletion options (https://api.losant.com/#/definitions/flowVersionsDeletePost)
|
46
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
47
|
+
# * {boolean} _actions - Return resource actions in response
|
48
|
+
# * {boolean} _links - Return resource link in response
|
49
|
+
# * {boolean} _embedded - Return embedded resources in response
|
50
|
+
#
|
51
|
+
# Responses:
|
52
|
+
# * 200 - Object indicating number of flow versions deleted or failed (https://api.losant.com/#/definitions/bulkDeleteResponse)
|
53
|
+
# * 202 - If a job was enqueued for the flow versions to be deleted (https://api.losant.com/#/definitions/jobEnqueuedResult)
|
54
|
+
#
|
55
|
+
# Errors:
|
56
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
57
|
+
# * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
|
58
|
+
def delete(params = {})
|
59
|
+
params = Utils.symbolize_hash_keys(params)
|
60
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
61
|
+
headers = {}
|
62
|
+
body = nil
|
63
|
+
|
64
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
65
|
+
raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
|
66
|
+
raise ArgumentError.new("options is required") unless params.has_key?(:options)
|
67
|
+
|
68
|
+
body = params[:options] if params.has_key?(:options)
|
69
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
70
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
71
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
72
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
73
|
+
|
74
|
+
path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/delete"
|
75
|
+
|
76
|
+
@client.request(
|
77
|
+
method: :post,
|
78
|
+
path: path,
|
79
|
+
query: query_params,
|
80
|
+
headers: headers,
|
81
|
+
body: body)
|
82
|
+
end
|
83
|
+
|
34
84
|
# Returns the flow versions for a flow
|
35
85
|
#
|
36
86
|
# Authentication:
|
data/lib/losant_rest/flows.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
|
@@ -0,0 +1,227 @@
|
|
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 Instance Resource
|
28
|
+
class Instance
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Generates a CSV report on instance stats
|
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.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.generateReport.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} instanceId - ID associated with the instance
|
44
|
+
# * {hash} options - Object containing report configuration (https://api.losant.com/#/definitions/instanceReportOptionsPost)
|
45
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
46
|
+
# * {boolean} _actions - Return resource actions in response
|
47
|
+
# * {boolean} _links - Return resource link in response
|
48
|
+
# * {boolean} _embedded - Return embedded resources in response
|
49
|
+
#
|
50
|
+
# Responses:
|
51
|
+
# * 200 - If generation of report was successfully started (https://api.losant.com/#/definitions/success)
|
52
|
+
#
|
53
|
+
# Errors:
|
54
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
55
|
+
def generate_report(params = {})
|
56
|
+
params = Utils.symbolize_hash_keys(params)
|
57
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
58
|
+
headers = {}
|
59
|
+
body = nil
|
60
|
+
|
61
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
62
|
+
|
63
|
+
body = params[:options] if params.has_key?(:options)
|
64
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
65
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
66
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
67
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
68
|
+
|
69
|
+
path = "/instances/#{params[:instanceId]}/generateReport"
|
70
|
+
|
71
|
+
@client.request(
|
72
|
+
method: :post,
|
73
|
+
path: path,
|
74
|
+
query: query_params,
|
75
|
+
headers: headers,
|
76
|
+
body: body)
|
77
|
+
end
|
78
|
+
|
79
|
+
# Returns an instance
|
80
|
+
#
|
81
|
+
# Authentication:
|
82
|
+
# The client must be configured with a valid api
|
83
|
+
# access token to call this action. The token
|
84
|
+
# must include at least one of the following scopes:
|
85
|
+
# all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.get.
|
86
|
+
#
|
87
|
+
# Parameters:
|
88
|
+
# * {string} instanceId - ID associated with the instance
|
89
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
90
|
+
# * {boolean} _actions - Return resource actions in response
|
91
|
+
# * {boolean} _links - Return resource link in response
|
92
|
+
# * {boolean} _embedded - Return embedded resources in response
|
93
|
+
#
|
94
|
+
# Responses:
|
95
|
+
# * 200 - A single instance (https://api.losant.com/#/definitions/instance)
|
96
|
+
#
|
97
|
+
# Errors:
|
98
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
99
|
+
# * 404 - Error if instance was not found (https://api.losant.com/#/definitions/error)
|
100
|
+
def get(params = {})
|
101
|
+
params = Utils.symbolize_hash_keys(params)
|
102
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
103
|
+
headers = {}
|
104
|
+
body = nil
|
105
|
+
|
106
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
107
|
+
|
108
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
109
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
110
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
111
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
112
|
+
|
113
|
+
path = "/instances/#{params[:instanceId]}"
|
114
|
+
|
115
|
+
@client.request(
|
116
|
+
method: :get,
|
117
|
+
path: path,
|
118
|
+
query: query_params,
|
119
|
+
headers: headers,
|
120
|
+
body: body)
|
121
|
+
end
|
122
|
+
|
123
|
+
# Return historical summary entries for an instance
|
124
|
+
#
|
125
|
+
# Authentication:
|
126
|
+
# The client must be configured with a valid api
|
127
|
+
# access token to call this action. The token
|
128
|
+
# must include at least one of the following scopes:
|
129
|
+
# all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.historicalSummaries.
|
130
|
+
#
|
131
|
+
# Parameters:
|
132
|
+
# * {string} instanceId - ID associated with the instance
|
133
|
+
# * {string} month - Timestamp within the month to report a summary for.
|
134
|
+
# * {string} sortField - Field to sort the results by. Accepted values are: resourceId, currentPeriodStart
|
135
|
+
# * {string} sortDirection - Direction to sort the results in. Accepted values are: asc, desc
|
136
|
+
# * {string} page - Which page of results to return
|
137
|
+
# * {string} perPage - How many items to return per page
|
138
|
+
# * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: resourceType, resourceId, ownerId, ownerType
|
139
|
+
# * {string} filter - Filter to apply against the filtered field. Blank or not provided means no filtering.
|
140
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
141
|
+
# * {boolean} _actions - Return resource actions in response
|
142
|
+
# * {boolean} _links - Return resource link in response
|
143
|
+
# * {boolean} _embedded - Return embedded resources in response
|
144
|
+
#
|
145
|
+
# Responses:
|
146
|
+
# * 200 - Collection of historical summaries (https://api.losant.com/#/definitions/historicalSummaries)
|
147
|
+
#
|
148
|
+
# Errors:
|
149
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
150
|
+
def historical_summaries(params = {})
|
151
|
+
params = Utils.symbolize_hash_keys(params)
|
152
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
153
|
+
headers = {}
|
154
|
+
body = nil
|
155
|
+
|
156
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
157
|
+
|
158
|
+
query_params[:month] = params[:month] if params.has_key?(:month)
|
159
|
+
query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
|
160
|
+
query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
|
161
|
+
query_params[:page] = params[:page] if params.has_key?(:page)
|
162
|
+
query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
|
163
|
+
query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
|
164
|
+
query_params[:filter] = params[:filter] if params.has_key?(:filter)
|
165
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
166
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
167
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
168
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
169
|
+
|
170
|
+
path = "/instances/#{params[:instanceId]}/historicalSummaries"
|
171
|
+
|
172
|
+
@client.request(
|
173
|
+
method: :get,
|
174
|
+
path: path,
|
175
|
+
query: query_params,
|
176
|
+
headers: headers,
|
177
|
+
body: body)
|
178
|
+
end
|
179
|
+
|
180
|
+
# Updates information about an instance
|
181
|
+
#
|
182
|
+
# Authentication:
|
183
|
+
# The client must be configured with a valid api
|
184
|
+
# access token to call this action. The token
|
185
|
+
# must include at least one of the following scopes:
|
186
|
+
# all.Instance, all.User, instance.*, or instance.patch.
|
187
|
+
#
|
188
|
+
# Parameters:
|
189
|
+
# * {string} instanceId - ID associated with the instance
|
190
|
+
# * {hash} instance - Updated instance information (https://api.losant.com/#/definitions/instancePatch)
|
191
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
192
|
+
# * {boolean} _actions - Return resource actions in response
|
193
|
+
# * {boolean} _links - Return resource link in response
|
194
|
+
# * {boolean} _embedded - Return embedded resources in response
|
195
|
+
#
|
196
|
+
# Responses:
|
197
|
+
# * 200 - The updated instance object (https://api.losant.com/#/definitions/instance)
|
198
|
+
#
|
199
|
+
# Errors:
|
200
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
201
|
+
def patch(params = {})
|
202
|
+
params = Utils.symbolize_hash_keys(params)
|
203
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
204
|
+
headers = {}
|
205
|
+
body = nil
|
206
|
+
|
207
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
208
|
+
raise ArgumentError.new("instance is required") unless params.has_key?(:instance)
|
209
|
+
|
210
|
+
body = params[:instance] if params.has_key?(:instance)
|
211
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
212
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
213
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
214
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
215
|
+
|
216
|
+
path = "/instances/#{params[:instanceId]}"
|
217
|
+
|
218
|
+
@client.request(
|
219
|
+
method: :patch,
|
220
|
+
path: path,
|
221
|
+
query: query_params,
|
222
|
+
headers: headers,
|
223
|
+
body: body)
|
224
|
+
end
|
225
|
+
|
226
|
+
end
|
227
|
+
end
|
@@ -0,0 +1,176 @@
|
|
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 Instance Api Token Resource
|
28
|
+
class InstanceApiToken
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Deletes an API Token
|
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.Instance, all.User, instanceApiToken.*, or instanceApiToken.delete.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} instanceId - ID associated with the instance
|
44
|
+
# * {string} apiTokenId - ID associated with the API token
|
45
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
46
|
+
# * {boolean} _actions - Return resource actions in response
|
47
|
+
# * {boolean} _links - Return resource link in response
|
48
|
+
# * {boolean} _embedded - Return embedded resources in response
|
49
|
+
#
|
50
|
+
# Responses:
|
51
|
+
# * 200 - If API token was successfully deleted (https://api.losant.com/#/definitions/success)
|
52
|
+
#
|
53
|
+
# Errors:
|
54
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
55
|
+
# * 404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
|
56
|
+
def delete(params = {})
|
57
|
+
params = Utils.symbolize_hash_keys(params)
|
58
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
59
|
+
headers = {}
|
60
|
+
body = nil
|
61
|
+
|
62
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
63
|
+
raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
|
64
|
+
|
65
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
66
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
67
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
68
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
69
|
+
|
70
|
+
path = "/instances/#{params[:instanceId]}/tokens/#{params[:apiTokenId]}"
|
71
|
+
|
72
|
+
@client.request(
|
73
|
+
method: :delete,
|
74
|
+
path: path,
|
75
|
+
query: query_params,
|
76
|
+
headers: headers,
|
77
|
+
body: body)
|
78
|
+
end
|
79
|
+
|
80
|
+
# Retrieves information on an API token
|
81
|
+
#
|
82
|
+
# Authentication:
|
83
|
+
# The client must be configured with a valid api
|
84
|
+
# access token to call this action. The token
|
85
|
+
# must include at least one of the following scopes:
|
86
|
+
# all.Instance, all.Instance.read, all.User, all.User.read, instanceApiToken.*, or instanceApiToken.get.
|
87
|
+
#
|
88
|
+
# Parameters:
|
89
|
+
# * {string} instanceId - ID associated with the instance
|
90
|
+
# * {string} apiTokenId - ID associated with the API token
|
91
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
92
|
+
# * {boolean} _actions - Return resource actions in response
|
93
|
+
# * {boolean} _links - Return resource link in response
|
94
|
+
# * {boolean} _embedded - Return embedded resources in response
|
95
|
+
#
|
96
|
+
# Responses:
|
97
|
+
# * 200 - API token information (https://api.losant.com/#/definitions/apiToken)
|
98
|
+
#
|
99
|
+
# Errors:
|
100
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
101
|
+
# * 404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
|
102
|
+
def get(params = {})
|
103
|
+
params = Utils.symbolize_hash_keys(params)
|
104
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
105
|
+
headers = {}
|
106
|
+
body = nil
|
107
|
+
|
108
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
109
|
+
raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
|
110
|
+
|
111
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
112
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
113
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
114
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
115
|
+
|
116
|
+
path = "/instances/#{params[:instanceId]}/tokens/#{params[:apiTokenId]}"
|
117
|
+
|
118
|
+
@client.request(
|
119
|
+
method: :get,
|
120
|
+
path: path,
|
121
|
+
query: query_params,
|
122
|
+
headers: headers,
|
123
|
+
body: body)
|
124
|
+
end
|
125
|
+
|
126
|
+
# Updates information about an API token
|
127
|
+
#
|
128
|
+
# Authentication:
|
129
|
+
# The client must be configured with a valid api
|
130
|
+
# access token to call this action. The token
|
131
|
+
# must include at least one of the following scopes:
|
132
|
+
# all.Instance, all.User, instanceApiToken.*, or instanceApiToken.patch.
|
133
|
+
#
|
134
|
+
# Parameters:
|
135
|
+
# * {string} instanceId - ID associated with the instance
|
136
|
+
# * {string} apiTokenId - ID associated with the API token
|
137
|
+
# * {hash} apiToken - Object containing new properties of the API token (https://api.losant.com/#/definitions/apiTokenPatch)
|
138
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
139
|
+
# * {boolean} _actions - Return resource actions in response
|
140
|
+
# * {boolean} _links - Return resource link in response
|
141
|
+
# * {boolean} _embedded - Return embedded resources in response
|
142
|
+
#
|
143
|
+
# Responses:
|
144
|
+
# * 200 - Updated API token information (https://api.losant.com/#/definitions/apiToken)
|
145
|
+
#
|
146
|
+
# Errors:
|
147
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
148
|
+
# * 404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
|
149
|
+
def patch(params = {})
|
150
|
+
params = Utils.symbolize_hash_keys(params)
|
151
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
152
|
+
headers = {}
|
153
|
+
body = nil
|
154
|
+
|
155
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
156
|
+
raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
|
157
|
+
raise ArgumentError.new("apiToken is required") unless params.has_key?(:apiToken)
|
158
|
+
|
159
|
+
body = params[:apiToken] if params.has_key?(:apiToken)
|
160
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
161
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
162
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
163
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
164
|
+
|
165
|
+
path = "/instances/#{params[:instanceId]}/tokens/#{params[:apiTokenId]}"
|
166
|
+
|
167
|
+
@client.request(
|
168
|
+
method: :patch,
|
169
|
+
path: path,
|
170
|
+
query: query_params,
|
171
|
+
headers: headers,
|
172
|
+
body: body)
|
173
|
+
end
|
174
|
+
|
175
|
+
end
|
176
|
+
end
|