losant_rest 1.10.4 → 1.13.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 +2 -2
- data/docs/_schemas.md +35272 -19039
- data/docs/application.md +45 -4
- data/docs/applicationApiTokens.md +2 -2
- data/docs/applicationCertificateAuthorities.md +1 -1
- data/docs/applicationCertificates.md +1 -1
- data/docs/applicationDashboard.md +133 -0
- data/docs/applicationDashboards.md +93 -0
- data/docs/applicationKeys.md +4 -3
- data/docs/applicationTemplates.md +1 -1
- data/docs/applications.md +2 -2
- data/docs/auditLogs.md +1 -1
- data/docs/dashboards.md +1 -1
- data/docs/dataTable.md +1 -1
- data/docs/dataTableRows.md +1 -1
- data/docs/dataTables.md +2 -2
- data/docs/deviceRecipes.md +1 -1
- data/docs/devices.md +127 -3
- data/docs/edgeDeployments.md +1 -1
- data/docs/events.md +4 -4
- 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/experienceGroups.md +1 -1
- data/docs/experienceSlugs.md +1 -1
- data/docs/experienceUsers.md +1 -1
- data/docs/experienceVersion.md +3 -3
- data/docs/experienceVersions.md +3 -3
- data/docs/experienceView.md +4 -4
- data/docs/experienceViews.md +3 -3
- data/docs/file.md +5 -5
- data/docs/files.md +3 -3
- data/docs/flow.md +41 -0
- data/docs/flowVersions.md +46 -1
- data/docs/flows.md +5 -2
- 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 +133 -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/integrations.md +1 -1
- data/docs/notebooks.md +1 -1
- data/docs/orgs.md +1 -1
- data/docs/userApiToken.md +125 -0
- data/docs/userApiTokens.md +87 -0
- data/docs/webhook.md +1 -0
- data/docs/webhooks.md +1 -1
- data/lib/losant_rest.rb +15 -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 +59 -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 +1 -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 +155 -3
- 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 +54 -1
- data/lib/losant_rest/flows.rb +9 -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 +176 -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/advancedFlowByVersionQuery.json +665 -0
- data/schemas/advancedFlowQuery.json +883 -0
- data/schemas/advancedFlowVersionQuery.json +925 -0
- data/schemas/apiToken.json +2 -1
- data/schemas/apiTokenPost.json +420 -0
- data/schemas/apiTokens.json +4 -2
- data/schemas/applicationApiTokenPost.json +11 -0
- data/schemas/applicationDashboardPost.json +5687 -0
- data/schemas/applicationGlobalPatch.json +33 -0
- data/schemas/attributeNamesResponse.json +14 -0
- data/schemas/auditLog.json +4 -0
- data/schemas/auditLogFilter.json +4 -0
- data/schemas/auditLogs.json +4 -0
- data/schemas/authedUser.json +3 -0
- data/schemas/bulkDeleteResponse.json +12 -0
- data/schemas/changePassword.json +1 -1
- data/schemas/dashboard.json +72 -17
- data/schemas/dashboardPatch.json +72 -17
- data/schemas/dashboardPost.json +72 -17
- data/schemas/dashboardSendReport.json +4 -0
- data/schemas/dashboards.json +72 -17
- data/schemas/deviceAttributeDataTypeFilter.json +29 -0
- data/schemas/deviceClassFilter.json +1 -2
- data/schemas/devicesDeletePost.json +309 -0
- data/schemas/devicesExportPost.json +309 -0
- data/schemas/devicesPatch.json +309 -0
- data/schemas/devicesRemoveDataPost.json +309 -0
- data/schemas/experienceGroup.json +6 -0
- data/schemas/experienceGroups.json +6 -0
- data/schemas/experienceLinkedResources.json +57 -0
- data/schemas/experienceVersion.json +9 -0
- data/schemas/experienceVersionPatch.json +9 -0
- data/schemas/experienceVersions.json +9 -0
- data/schemas/filePost.json +8 -2
- data/schemas/files.json +3 -0
- data/schemas/flow.json +19 -0
- data/schemas/flowPatch.json +19 -0
- data/schemas/flowPost.json +19 -0
- data/schemas/flowStorageMetadata.json +13 -0
- data/schemas/flowVersion.json +38 -0
- data/schemas/flowVersionPost.json +19 -0
- data/schemas/flowVersions.json +38 -0
- data/schemas/flowVersionsDeletePost.json +941 -0
- data/schemas/flows.json +19 -0
- data/schemas/flowsImportPost.json +38 -0
- data/schemas/flowsImportResult.json +57 -0
- data/schemas/githubLogin.json +64 -1
- data/schemas/historicalSummaries.json +43 -0
- data/schemas/historicalSummary.json +458 -0
- data/schemas/instance.json +192 -0
- data/schemas/instanceMember.json +37 -0
- data/schemas/instanceMemberPatch.json +17 -0
- data/schemas/instanceMemberPost.json +22 -0
- data/schemas/instanceMembers.json +69 -0
- data/schemas/instanceOrg.json +133 -0
- data/schemas/instanceOrgMember.json +37 -0
- data/schemas/instanceOrgMemberPatch.json +69 -0
- data/schemas/instanceOrgMemberPost.json +161 -0
- data/schemas/instanceOrgMembers.json +34 -0
- data/schemas/instanceOrgPatch.json +122 -0
- data/schemas/instanceOrgPost.json +291 -0
- data/schemas/instanceOrgs.json +174 -0
- data/schemas/instancePatch.json +67 -0
- data/schemas/instanceReportOptionsPost.json +41 -0
- data/schemas/instances.json +43 -0
- data/schemas/integration.json +3 -0
- data/schemas/integrationPatch.json +3 -0
- data/schemas/integrationPost.json +3 -0
- data/schemas/integrations.json +3 -0
- data/schemas/me.json +3 -0
- data/schemas/mePatch.json +1 -1
- data/schemas/multiDeviceCommand.json +309 -0
- data/schemas/notebook.json +22 -0
- data/schemas/notebookExecutionLogs.json +7 -0
- data/schemas/notebookPatch.json +7 -0
- data/schemas/notebookPost.json +7 -0
- data/schemas/notebooks.json +22 -0
- data/schemas/orgPatch.json +0 -9
- data/schemas/passwordResetFinish.json +1 -1
- data/schemas/payloadStats.json +110 -0
- data/schemas/tagKeysResponse.json +14 -0
- data/schemas/tagValuesResponse.json +19 -0
- data/schemas/userCredentials.json +64 -1
- data/schemas/userPost.json +65 -2
- data/schemas/validateContextError.json +34 -0
- data/schemas/validateContextSuccess.json +34 -0
- metadata +64 -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 Instance Org Members Resource
|
28
|
+
class InstanceOrgMembers
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Returns a collection of instance organization members
|
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, instanceOrgMembers.*, or instanceOrgMembers.get.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} instanceId - ID associated with the instance
|
44
|
+
# * {string} orgId - ID associated with the instance
|
45
|
+
# * {string} sortField - Field to sort the results by. Accepted values are: email, role
|
46
|
+
# * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
|
47
|
+
# * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role
|
48
|
+
# * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
|
49
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
50
|
+
# * {boolean} _actions - Return resource actions in response
|
51
|
+
# * {boolean} _links - Return resource link in response
|
52
|
+
# * {boolean} _embedded - Return embedded resources in response
|
53
|
+
#
|
54
|
+
# Responses:
|
55
|
+
# * 200 - A collection of instance organization members (https://api.losant.com/#/definitions/instanceOrgMembers)
|
56
|
+
#
|
57
|
+
# Errors:
|
58
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
59
|
+
# * 404 - Error if instance was not found (https://api.losant.com/#/definitions/error)
|
60
|
+
def get(params = {})
|
61
|
+
params = Utils.symbolize_hash_keys(params)
|
62
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
63
|
+
headers = {}
|
64
|
+
body = nil
|
65
|
+
|
66
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
67
|
+
raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
|
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[:filterField] = params[:filterField] if params.has_key?(:filterField)
|
72
|
+
query_params[:filter] = params[:filter] if params.has_key?(:filter)
|
73
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
74
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
75
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
76
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
77
|
+
|
78
|
+
path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/members"
|
79
|
+
|
80
|
+
@client.request(
|
81
|
+
method: :get,
|
82
|
+
path: path,
|
83
|
+
query: query_params,
|
84
|
+
headers: headers,
|
85
|
+
body: body)
|
86
|
+
end
|
87
|
+
|
88
|
+
# Creates a new organization member
|
89
|
+
#
|
90
|
+
# Authentication:
|
91
|
+
# The client must be configured with a valid api
|
92
|
+
# access token to call this action. The token
|
93
|
+
# must include at least one of the following scopes:
|
94
|
+
# all.Instance, all.User, instanceOrgMembers.*, or instanceOrgMembers.post.
|
95
|
+
#
|
96
|
+
# Parameters:
|
97
|
+
# * {string} instanceId - ID associated with the instance
|
98
|
+
# * {string} orgId - ID associated with the instance
|
99
|
+
# * {hash} member - Object containing new member info (https://api.losant.com/#/definitions/instanceOrgMemberPost)
|
100
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
101
|
+
# * {boolean} _actions - Return resource actions in response
|
102
|
+
# * {boolean} _links - Return resource link in response
|
103
|
+
# * {boolean} _embedded - Return embedded resources in response
|
104
|
+
#
|
105
|
+
# Responses:
|
106
|
+
# * 200 - The newly created instance member (https://api.losant.com/#/definitions/instanceOrgMember)
|
107
|
+
#
|
108
|
+
# Errors:
|
109
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
110
|
+
# * 404 - Error if instance was not found (https://api.losant.com/#/definitions/error)
|
111
|
+
def post(params = {})
|
112
|
+
params = Utils.symbolize_hash_keys(params)
|
113
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
114
|
+
headers = {}
|
115
|
+
body = nil
|
116
|
+
|
117
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
118
|
+
raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
|
119
|
+
raise ArgumentError.new("member is required") unless params.has_key?(:member)
|
120
|
+
|
121
|
+
body = params[:member] if params.has_key?(:member)
|
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 = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/members"
|
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
|
@@ -0,0 +1,139 @@
|
|
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 Orgs Resource
|
28
|
+
class InstanceOrgs
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Returns the organizations associated with the current instance
|
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, instanceOrgs.*, or instanceOrgs.get.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} instanceId - ID associated with the instance
|
44
|
+
# * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
|
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} summaryExclude - Comma-separated list of summary fields to exclude from org summaries
|
51
|
+
# * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
|
52
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
53
|
+
# * {boolean} _actions - Return resource actions in response
|
54
|
+
# * {boolean} _links - Return resource link in response
|
55
|
+
# * {boolean} _embedded - Return embedded resources in response
|
56
|
+
#
|
57
|
+
# Responses:
|
58
|
+
# * 200 - A collection of organizations (https://api.losant.com/#/definitions/instanceOrgs)
|
59
|
+
#
|
60
|
+
# Errors:
|
61
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
62
|
+
def get(params = {})
|
63
|
+
params = Utils.symbolize_hash_keys(params)
|
64
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
65
|
+
headers = {}
|
66
|
+
body = nil
|
67
|
+
|
68
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
69
|
+
|
70
|
+
query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
|
71
|
+
query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
|
72
|
+
query_params[:page] = params[:page] if params.has_key?(:page)
|
73
|
+
query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
|
74
|
+
query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
|
75
|
+
query_params[:filter] = params[:filter] if params.has_key?(:filter)
|
76
|
+
query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
|
77
|
+
query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
|
78
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
79
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
80
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
81
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
82
|
+
|
83
|
+
path = "/instances/#{params[:instanceId]}/orgs"
|
84
|
+
|
85
|
+
@client.request(
|
86
|
+
method: :get,
|
87
|
+
path: path,
|
88
|
+
query: query_params,
|
89
|
+
headers: headers,
|
90
|
+
body: body)
|
91
|
+
end
|
92
|
+
|
93
|
+
# Create a new organization
|
94
|
+
#
|
95
|
+
# Authentication:
|
96
|
+
# The client must be configured with a valid api
|
97
|
+
# access token to call this action. The token
|
98
|
+
# must include at least one of the following scopes:
|
99
|
+
# all.Instance, all.User, instanceOrgs.*, or instanceOrgs.post.
|
100
|
+
#
|
101
|
+
# Parameters:
|
102
|
+
# * {string} instanceId - ID associated with the instance
|
103
|
+
# * {hash} orgConfig - Object containing configurations for the new organization (https://api.losant.com/#/definitions/instanceOrgPost)
|
104
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
105
|
+
# * {boolean} _actions - Return resource actions in response
|
106
|
+
# * {boolean} _links - Return resource link in response
|
107
|
+
# * {boolean} _embedded - Return embedded resources in response
|
108
|
+
#
|
109
|
+
# Responses:
|
110
|
+
# * 200 - The newly created organization (https://api.losant.com/#/definitions/org)
|
111
|
+
#
|
112
|
+
# Errors:
|
113
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
114
|
+
def post(params = {})
|
115
|
+
params = Utils.symbolize_hash_keys(params)
|
116
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
117
|
+
headers = {}
|
118
|
+
body = nil
|
119
|
+
|
120
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
121
|
+
|
122
|
+
body = params[:orgConfig] if params.has_key?(:orgConfig)
|
123
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
124
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
125
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
126
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
127
|
+
|
128
|
+
path = "/instances/#{params[:instanceId]}/orgs"
|
129
|
+
|
130
|
+
@client.request(
|
131
|
+
method: :post,
|
132
|
+
path: path,
|
133
|
+
query: query_params,
|
134
|
+
headers: headers,
|
135
|
+
body: body)
|
136
|
+
end
|
137
|
+
|
138
|
+
end
|
139
|
+
end
|
@@ -0,0 +1,88 @@
|
|
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 Instances Resource
|
28
|
+
class Instances
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Returns a collection of instances
|
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.User, all.User.read, instances.*, or instances.get.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
|
44
|
+
# * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
|
45
|
+
# * {string} page - Which page of results to return
|
46
|
+
# * {string} perPage - How many items to return per page
|
47
|
+
# * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
|
48
|
+
# * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
|
49
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
50
|
+
# * {boolean} _actions - Return resource actions in response
|
51
|
+
# * {boolean} _links - Return resource link in response
|
52
|
+
# * {boolean} _embedded - Return embedded resources in response
|
53
|
+
#
|
54
|
+
# Responses:
|
55
|
+
# * 200 - Collection of instances (https://api.losant.com/#/definitions/instances)
|
56
|
+
#
|
57
|
+
# Errors:
|
58
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
59
|
+
def get(params = {})
|
60
|
+
params = Utils.symbolize_hash_keys(params)
|
61
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
62
|
+
headers = {}
|
63
|
+
body = nil
|
64
|
+
|
65
|
+
|
66
|
+
query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
|
67
|
+
query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
|
68
|
+
query_params[:page] = params[:page] if params.has_key?(:page)
|
69
|
+
query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
|
70
|
+
query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
|
71
|
+
query_params[:filter] = params[:filter] if params.has_key?(:filter)
|
72
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
73
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
74
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
75
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
76
|
+
|
77
|
+
path = "/instances"
|
78
|
+
|
79
|
+
@client.request(
|
80
|
+
method: :get,
|
81
|
+
path: path,
|
82
|
+
query: query_params,
|
83
|
+
headers: headers,
|
84
|
+
body: body)
|
85
|
+
end
|
86
|
+
|
87
|
+
end
|
88
|
+
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
|
@@ -42,6 +42,7 @@ module LosantRest
|
|
42
42
|
# Parameters:
|
43
43
|
# * {string} applicationId - ID associated with the application
|
44
44
|
# * {string} integrationId - ID associated with the integration
|
45
|
+
# * {string} includeWorkflows - If the workflows that utilize this integration should also be deleted.
|
45
46
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
46
47
|
# * {boolean} _actions - Return resource actions in response
|
47
48
|
# * {boolean} _links - Return resource link in response
|
@@ -62,6 +63,7 @@ module LosantRest
|
|
62
63
|
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
63
64
|
raise ArgumentError.new("integrationId is required") unless params.has_key?(:integrationId)
|
64
65
|
|
66
|
+
query_params[:includeWorkflows] = params[:includeWorkflows] if params.has_key?(:includeWorkflows)
|
65
67
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
66
68
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
67
69
|
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
|
data/lib/losant_rest/me.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
|
@@ -449,7 +449,7 @@ module LosantRest
|
|
449
449
|
# * {boolean} _embedded - Return embedded resources in response
|
450
450
|
#
|
451
451
|
# Responses:
|
452
|
-
# * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/
|
452
|
+
# * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadStats)
|
453
453
|
#
|
454
454
|
# Errors:
|
455
455
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
data/lib/losant_rest/notebook.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
|
data/lib/losant_rest/org.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
|
@@ -290,7 +290,7 @@ module LosantRest
|
|
290
290
|
# * {boolean} _embedded - Return embedded resources in response
|
291
291
|
#
|
292
292
|
# Responses:
|
293
|
-
# * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/
|
293
|
+
# * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadStats)
|
294
294
|
#
|
295
295
|
# Errors:
|
296
296
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|