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,134 @@
|
|
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 Members Resource
|
28
|
+
class InstanceMembers
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Returns a collection of instance 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, instanceMembers.*, or instanceMembers.get.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} instanceId - ID associated with the instance
|
44
|
+
# * {string} sortField - Field to sort the results by. Accepted values are: email, role
|
45
|
+
# * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
|
46
|
+
# * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role
|
47
|
+
# * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
|
48
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
49
|
+
# * {boolean} _actions - Return resource actions in response
|
50
|
+
# * {boolean} _links - Return resource link in response
|
51
|
+
# * {boolean} _embedded - Return embedded resources in response
|
52
|
+
#
|
53
|
+
# Responses:
|
54
|
+
# * 200 - A collection of instance members (https://api.losant.com/#/definitions/instanceMembers)
|
55
|
+
#
|
56
|
+
# Errors:
|
57
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
58
|
+
# * 404 - Error if instance was not found (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
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
66
|
+
|
67
|
+
query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
|
68
|
+
query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
|
69
|
+
query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
|
70
|
+
query_params[:filter] = params[:filter] if params.has_key?(:filter)
|
71
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
72
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
73
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
74
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
75
|
+
|
76
|
+
path = "/instances/#{params[:instanceId]}/members"
|
77
|
+
|
78
|
+
@client.request(
|
79
|
+
method: :get,
|
80
|
+
path: path,
|
81
|
+
query: query_params,
|
82
|
+
headers: headers,
|
83
|
+
body: body)
|
84
|
+
end
|
85
|
+
|
86
|
+
# Creates a new instance member
|
87
|
+
#
|
88
|
+
# Authentication:
|
89
|
+
# The client must be configured with a valid api
|
90
|
+
# access token to call this action. The token
|
91
|
+
# must include at least one of the following scopes:
|
92
|
+
# all.Instance, all.User, instanceMembers.*, or instanceMembers.post.
|
93
|
+
#
|
94
|
+
# Parameters:
|
95
|
+
# * {string} instanceId - ID associated with the instance
|
96
|
+
# * {hash} member - Object containing new member info (https://api.losant.com/#/definitions/instanceMemberPost)
|
97
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
98
|
+
# * {boolean} _actions - Return resource actions in response
|
99
|
+
# * {boolean} _links - Return resource link in response
|
100
|
+
# * {boolean} _embedded - Return embedded resources in response
|
101
|
+
#
|
102
|
+
# Responses:
|
103
|
+
# * 200 - The newly created instance member (https://api.losant.com/#/definitions/instanceMember)
|
104
|
+
#
|
105
|
+
# Errors:
|
106
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
107
|
+
# * 404 - Error if instance was not found (https://api.losant.com/#/definitions/error)
|
108
|
+
def post(params = {})
|
109
|
+
params = Utils.symbolize_hash_keys(params)
|
110
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
111
|
+
headers = {}
|
112
|
+
body = nil
|
113
|
+
|
114
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
115
|
+
raise ArgumentError.new("member is required") unless params.has_key?(:member)
|
116
|
+
|
117
|
+
body = params[:member] if params.has_key?(:member)
|
118
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
119
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
120
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
121
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
122
|
+
|
123
|
+
path = "/instances/#{params[:instanceId]}/members"
|
124
|
+
|
125
|
+
@client.request(
|
126
|
+
method: :post,
|
127
|
+
path: path,
|
128
|
+
query: query_params,
|
129
|
+
headers: headers,
|
130
|
+
body: body)
|
131
|
+
end
|
132
|
+
|
133
|
+
end
|
134
|
+
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 Org Resource
|
28
|
+
class InstanceOrg
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Deletes an organization
|
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, instanceOrg.*, or instanceOrg.delete.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} instanceId - ID associated with the instance
|
44
|
+
# * {string} orgId - ID associated with the organization
|
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 organization 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 organization 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("orgId is required") unless params.has_key?(:orgId)
|
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]}/orgs/#{params[:orgId]}"
|
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 organization
|
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, instanceOrg.*, or instanceOrg.get.
|
87
|
+
#
|
88
|
+
# Parameters:
|
89
|
+
# * {string} instanceId - ID associated with the instance
|
90
|
+
# * {string} orgId - ID associated with the organization
|
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 - A single organization (https://api.losant.com/#/definitions/instanceOrg)
|
98
|
+
#
|
99
|
+
# Errors:
|
100
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
101
|
+
# * 404 - Error if organization 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("orgId is required") unless params.has_key?(:orgId)
|
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]}/orgs/#{params[:orgId]}"
|
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 organization
|
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, instanceOrg.*, or instanceOrg.patch.
|
133
|
+
#
|
134
|
+
# Parameters:
|
135
|
+
# * {string} instanceId - ID associated with the instance
|
136
|
+
# * {string} orgId - ID associated with the organization
|
137
|
+
# * {hash} organization - Object containing new organization properties (https://api.losant.com/#/definitions/instanceOrgPatch)
|
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 organization information (https://api.losant.com/#/definitions/instanceOrg)
|
145
|
+
#
|
146
|
+
# Errors:
|
147
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
148
|
+
# * 404 - Error if organization 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("orgId is required") unless params.has_key?(:orgId)
|
157
|
+
raise ArgumentError.new("organization is required") unless params.has_key?(:organization)
|
158
|
+
|
159
|
+
body = params[:organization] if params.has_key?(:organization)
|
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]}/orgs/#{params[:orgId]}"
|
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
|
@@ -0,0 +1,182 @@
|
|
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 Member Resource
|
28
|
+
class InstanceOrgMember
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Deletes an organization member
|
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, instanceOrgMember.*, or instanceOrgMember.delete.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} instanceId - ID associated with the instance
|
44
|
+
# * {string} orgId - ID associated with the organization
|
45
|
+
# * {string} userId - ID associated with the organization member
|
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 - If member was successfully deleted (https://api.losant.com/#/definitions/success)
|
53
|
+
#
|
54
|
+
# Errors:
|
55
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
56
|
+
# * 404 - Error if organization or member was not found (https://api.losant.com/#/definitions/error)
|
57
|
+
def delete(params = {})
|
58
|
+
params = Utils.symbolize_hash_keys(params)
|
59
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
60
|
+
headers = {}
|
61
|
+
body = nil
|
62
|
+
|
63
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
64
|
+
raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
|
65
|
+
raise ArgumentError.new("userId is required") unless params.has_key?(:userId)
|
66
|
+
|
67
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
68
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
69
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
70
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
71
|
+
|
72
|
+
path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/members/#{params[:userId]}"
|
73
|
+
|
74
|
+
@client.request(
|
75
|
+
method: :delete,
|
76
|
+
path: path,
|
77
|
+
query: query_params,
|
78
|
+
headers: headers,
|
79
|
+
body: body)
|
80
|
+
end
|
81
|
+
|
82
|
+
# Returns an organization member
|
83
|
+
#
|
84
|
+
# Authentication:
|
85
|
+
# The client must be configured with a valid api
|
86
|
+
# access token to call this action. The token
|
87
|
+
# must include at least one of the following scopes:
|
88
|
+
# all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgMember.*, or instanceOrgMember.get.
|
89
|
+
#
|
90
|
+
# Parameters:
|
91
|
+
# * {string} instanceId - ID associated with the instance
|
92
|
+
# * {string} orgId - ID associated with the organization
|
93
|
+
# * {string} userId - ID associated with the organization member
|
94
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
95
|
+
# * {boolean} _actions - Return resource actions in response
|
96
|
+
# * {boolean} _links - Return resource link in response
|
97
|
+
# * {boolean} _embedded - Return embedded resources in response
|
98
|
+
#
|
99
|
+
# Responses:
|
100
|
+
# * 200 - A single organization member (https://api.losant.com/#/definitions/instanceOrgMember)
|
101
|
+
#
|
102
|
+
# Errors:
|
103
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
104
|
+
# * 404 - Error if instance, organization, or member was not found (https://api.losant.com/#/definitions/error)
|
105
|
+
def get(params = {})
|
106
|
+
params = Utils.symbolize_hash_keys(params)
|
107
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
108
|
+
headers = {}
|
109
|
+
body = nil
|
110
|
+
|
111
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
112
|
+
raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
|
113
|
+
raise ArgumentError.new("userId is required") unless params.has_key?(:userId)
|
114
|
+
|
115
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
116
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
117
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
118
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
119
|
+
|
120
|
+
path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/members/#{params[:userId]}"
|
121
|
+
|
122
|
+
@client.request(
|
123
|
+
method: :get,
|
124
|
+
path: path,
|
125
|
+
query: query_params,
|
126
|
+
headers: headers,
|
127
|
+
body: body)
|
128
|
+
end
|
129
|
+
|
130
|
+
# Modifies the role of an organization member
|
131
|
+
#
|
132
|
+
# Authentication:
|
133
|
+
# The client must be configured with a valid api
|
134
|
+
# access token to call this action. The token
|
135
|
+
# must include at least one of the following scopes:
|
136
|
+
# all.Instance, all.User, instanceOrgMember.*, or instanceOrgMember.patch.
|
137
|
+
#
|
138
|
+
# Parameters:
|
139
|
+
# * {string} instanceId - ID associated with the instance
|
140
|
+
# * {string} orgId - ID associated with the organization
|
141
|
+
# * {string} userId - ID associated with the organization member
|
142
|
+
# * {hash} member - Object containing new member info (https://api.losant.com/#/definitions/instanceOrgMemberPatch)
|
143
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
144
|
+
# * {boolean} _actions - Return resource actions in response
|
145
|
+
# * {boolean} _links - Return resource link in response
|
146
|
+
# * {boolean} _embedded - Return embedded resources in response
|
147
|
+
#
|
148
|
+
# Responses:
|
149
|
+
# * 200 - The modified organization member (https://api.losant.com/#/definitions/instanceOrgMember)
|
150
|
+
#
|
151
|
+
# Errors:
|
152
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
153
|
+
# * 404 - Error if organization or member was not found (https://api.losant.com/#/definitions/error)
|
154
|
+
def patch(params = {})
|
155
|
+
params = Utils.symbolize_hash_keys(params)
|
156
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
157
|
+
headers = {}
|
158
|
+
body = nil
|
159
|
+
|
160
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
161
|
+
raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
|
162
|
+
raise ArgumentError.new("userId is required") unless params.has_key?(:userId)
|
163
|
+
raise ArgumentError.new("member is required") unless params.has_key?(:member)
|
164
|
+
|
165
|
+
body = params[:member] if params.has_key?(:member)
|
166
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
167
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
168
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
169
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
170
|
+
|
171
|
+
path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/members/#{params[:userId]}"
|
172
|
+
|
173
|
+
@client.request(
|
174
|
+
method: :patch,
|
175
|
+
path: path,
|
176
|
+
query: query_params,
|
177
|
+
headers: headers,
|
178
|
+
body: body)
|
179
|
+
end
|
180
|
+
|
181
|
+
end
|
182
|
+
end
|