losant_rest 1.18.0 → 1.19.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/_schemas.md +10369 -390
- data/docs/applications.md +49 -0
- data/docs/credential.md +175 -0
- data/docs/credentials.md +93 -0
- data/docs/device.md +12 -3
- data/docs/me.md +116 -0
- data/lib/losant_rest/client.rb +10 -2
- data/lib/losant_rest/credential.rb +224 -0
- data/lib/losant_rest/credentials.rb +138 -0
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest.rb +2 -0
- data/lib/platform_rest/application.rb +932 -0
- data/lib/platform_rest/application_api_token.rb +176 -0
- data/lib/platform_rest/application_api_tokens.rb +136 -0
- data/lib/platform_rest/application_certificate.rb +176 -0
- data/lib/platform_rest/application_certificate_authorities.rb +138 -0
- data/lib/platform_rest/application_certificate_authority.rb +176 -0
- data/lib/platform_rest/application_certificates.rb +138 -0
- data/lib/platform_rest/application_dashboard.rb +225 -0
- data/lib/platform_rest/application_dashboards.rb +138 -0
- data/lib/platform_rest/application_key.rb +176 -0
- data/lib/platform_rest/application_keys.rb +141 -0
- data/lib/platform_rest/application_template.rb +79 -0
- data/lib/platform_rest/application_templates.rb +176 -0
- data/lib/platform_rest/applications.rb +209 -0
- data/lib/platform_rest/audit_log.rb +81 -0
- data/lib/platform_rest/audit_logs.rb +93 -0
- data/lib/platform_rest/auth.rb +245 -0
- data/lib/platform_rest/client.rb +410 -0
- data/lib/platform_rest/credential.rb +224 -0
- data/lib/platform_rest/credentials.rb +138 -0
- data/lib/platform_rest/dashboard.rb +268 -0
- data/lib/platform_rest/dashboards.rb +136 -0
- data/lib/platform_rest/data.rb +176 -0
- data/lib/platform_rest/data_table.rb +274 -0
- data/lib/platform_rest/data_table_row.rb +182 -0
- data/lib/platform_rest/data_table_rows.rb +343 -0
- data/lib/platform_rest/data_tables.rb +138 -0
- data/lib/platform_rest/device.rb +767 -0
- data/lib/platform_rest/device_recipe.rb +234 -0
- data/lib/platform_rest/device_recipes.rb +146 -0
- data/lib/platform_rest/devices.rb +707 -0
- data/lib/platform_rest/edge_deployment.rb +81 -0
- data/lib/platform_rest/edge_deployments.rb +236 -0
- data/lib/platform_rest/embedded_deployment.rb +81 -0
- data/lib/platform_rest/embedded_deployments.rb +280 -0
- data/lib/platform_rest/error.rb +34 -0
- data/lib/platform_rest/event.rb +176 -0
- data/lib/platform_rest/events.rb +341 -0
- data/lib/platform_rest/experience.rb +142 -0
- data/lib/platform_rest/experience_domain.rb +176 -0
- data/lib/platform_rest/experience_domains.rb +126 -0
- data/lib/platform_rest/experience_endpoint.rb +230 -0
- data/lib/platform_rest/experience_endpoints.rb +200 -0
- data/lib/platform_rest/experience_group.rb +180 -0
- data/lib/platform_rest/experience_groups.rb +141 -0
- data/lib/platform_rest/experience_slug.rb +176 -0
- data/lib/platform_rest/experience_slugs.rb +126 -0
- data/lib/platform_rest/experience_user.rb +176 -0
- data/lib/platform_rest/experience_users.rb +142 -0
- data/lib/platform_rest/experience_version.rb +176 -0
- data/lib/platform_rest/experience_versions.rb +138 -0
- data/lib/platform_rest/experience_view.rb +228 -0
- data/lib/platform_rest/experience_views.rb +142 -0
- data/lib/platform_rest/file.rb +226 -0
- data/lib/platform_rest/files.rb +144 -0
- data/lib/platform_rest/flow.rb +580 -0
- data/lib/platform_rest/flow_version.rb +352 -0
- data/lib/platform_rest/flow_versions.rb +201 -0
- data/lib/platform_rest/flows.rb +310 -0
- data/lib/platform_rest/instance.rb +377 -0
- data/lib/platform_rest/instance_api_token.rb +176 -0
- data/lib/platform_rest/instance_api_tokens.rb +136 -0
- data/lib/platform_rest/instance_custom_node.rb +282 -0
- data/lib/platform_rest/instance_custom_nodes.rb +136 -0
- data/lib/platform_rest/instance_member.rb +176 -0
- data/lib/platform_rest/instance_members.rb +134 -0
- data/lib/platform_rest/instance_org.rb +336 -0
- data/lib/platform_rest/instance_org_invite.rb +182 -0
- data/lib/platform_rest/instance_org_invites.rb +138 -0
- data/lib/platform_rest/instance_org_member.rb +182 -0
- data/lib/platform_rest/instance_org_members.rb +138 -0
- data/lib/platform_rest/instance_orgs.rb +139 -0
- data/lib/platform_rest/instance_sandbox.rb +181 -0
- data/lib/platform_rest/instance_sandboxes.rb +98 -0
- data/lib/platform_rest/instances.rb +88 -0
- data/lib/platform_rest/integration.rb +178 -0
- data/lib/platform_rest/integrations.rb +138 -0
- data/lib/platform_rest/me.rb +923 -0
- data/lib/platform_rest/notebook.rb +423 -0
- data/lib/platform_rest/notebooks.rb +138 -0
- data/lib/platform_rest/org.rb +663 -0
- data/lib/platform_rest/org_invites.rb +124 -0
- data/lib/platform_rest/orgs.rb +140 -0
- data/lib/platform_rest/resource_job.rb +326 -0
- data/lib/platform_rest/resource_jobs.rb +138 -0
- data/lib/platform_rest/user_api_token.rb +170 -0
- data/lib/platform_rest/user_api_tokens.rb +132 -0
- data/lib/platform_rest/utils.rb +44 -0
- data/lib/platform_rest/webhook.rb +178 -0
- data/lib/platform_rest/webhooks.rb +138 -0
- data/lib/platform_rest.rb +129 -0
- data/schemas/apiTokenPost.json +12 -0
- data/schemas/application.json +9 -8
- data/schemas/applicationCreationByTemplateResult.json +9 -8
- data/schemas/applicationDashboardPost.json +66 -0
- data/schemas/applicationPatch.json +6 -8
- data/schemas/applicationPost.json +6 -8
- data/schemas/applications.json +9 -8
- data/schemas/credential.json +115 -0
- data/schemas/credentialLinkedResources.json +8254 -0
- data/schemas/credentialPatch.json +66 -0
- data/schemas/credentialPost.json +89 -0
- data/schemas/credentials.json +160 -0
- data/schemas/dashboard.json +66 -0
- data/schemas/dashboardPatch.json +76 -3
- data/schemas/dashboardPost.json +76 -3
- data/schemas/dashboards.json +66 -0
- data/schemas/device.json +8 -0
- data/schemas/deviceConnectionStatus.json +10 -0
- data/schemas/deviceLog.json +3 -0
- data/schemas/devices.json +8 -0
- data/schemas/event.json +8 -0
- data/schemas/eventPlusNewCount.json +8 -0
- data/schemas/events.json +8 -0
- data/schemas/experienceGroup.json +8 -0
- data/schemas/experienceGroups.json +8 -0
- data/schemas/experienceLinkedResources.json +6 -3
- data/schemas/flow.json +2 -1
- data/schemas/flowPatch.json +2 -1
- data/schemas/flowPost.json +2 -1
- data/schemas/flowVersion.json +4 -2
- data/schemas/flowVersionPost.json +2 -1
- data/schemas/flowVersions.json +4 -2
- data/schemas/flows.json +2 -1
- data/schemas/flowsImportPost.json +4 -2
- data/schemas/flowsImportResult.json +6 -3
- data/schemas/githubLogin.json +12 -0
- data/schemas/historicalSummaries.json +4 -0
- data/schemas/historicalSummary.json +4 -0
- data/schemas/instance.json +7 -0
- data/schemas/instanceOrg.json +4 -0
- data/schemas/instanceOrgPatch.json +4 -0
- data/schemas/instanceOrgPost.json +4 -0
- data/schemas/instanceOrgs.json +4 -0
- data/schemas/instancePatch.json +4 -0
- data/schemas/instanceSandbox.json +6 -0
- data/schemas/instanceSandboxes.json +6 -0
- data/schemas/instances.json +7 -0
- data/schemas/integration.json +26 -12
- data/schemas/integrationPatch.json +33 -22
- data/schemas/integrationPost.json +26 -12
- data/schemas/integrations.json +26 -12
- data/schemas/me.json +6 -0
- data/schemas/org.json +7 -0
- data/schemas/orgInviteActionUser.json +18 -0
- data/schemas/orgInviteResultUser.json +18 -0
- data/schemas/orgInviteUser.json +51 -0
- data/schemas/orgInvitesUser.json +59 -0
- data/schemas/orgs.json +7 -0
- data/schemas/payloadCountsBreakdown.json +1 -25
- data/schemas/periodSummaries.json +172 -0
- data/schemas/samlResponse.json +12 -0
- data/schemas/userCredentials.json +12 -0
- data/schemas/userPost.json +12 -0
- metadata +107 -2
@@ -0,0 +1,423 @@
|
|
1
|
+
# The MIT License (MIT)
|
2
|
+
#
|
3
|
+
# Copyright (c) 2023 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 PlatformRest
|
26
|
+
|
27
|
+
# Class containing all the actions for the Notebook Resource
|
28
|
+
class Notebook
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Marks a specific notebook execution for cancellation
|
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, notebook.*, or notebook.execute.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} applicationId - ID associated with the application
|
44
|
+
# * {string} notebookId - ID associated with the notebook
|
45
|
+
# * {undefined} executionId - The ID of the execution to cancel
|
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 the execution was successfully marked for cancellation (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 execution was not found (https://api.losant.com/#/definitions/error)
|
57
|
+
def cancel_execution(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("applicationId is required") unless params.has_key?(:applicationId)
|
64
|
+
raise ArgumentError.new("notebookId is required") unless params.has_key?(:notebookId)
|
65
|
+
raise ArgumentError.new("executionId is required") unless params.has_key?(:executionId)
|
66
|
+
|
67
|
+
query_params[:executionId] = params[:executionId] if params.has_key?(:executionId)
|
68
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
69
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
70
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
71
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
72
|
+
|
73
|
+
path = "/applications/#{params[:applicationId]}/notebooks/#{params[:notebookId]}/cancelExecution"
|
74
|
+
|
75
|
+
@client.request(
|
76
|
+
method: :post,
|
77
|
+
path: path,
|
78
|
+
query: query_params,
|
79
|
+
headers: headers,
|
80
|
+
body: body)
|
81
|
+
end
|
82
|
+
|
83
|
+
# Deletes a notebook
|
84
|
+
#
|
85
|
+
# Authentication:
|
86
|
+
# The client must be configured with a valid api
|
87
|
+
# access token to call this action. The token
|
88
|
+
# must include at least one of the following scopes:
|
89
|
+
# all.Application, all.Organization, all.User, notebook.*, or notebook.delete.
|
90
|
+
#
|
91
|
+
# Parameters:
|
92
|
+
# * {string} applicationId - ID associated with the application
|
93
|
+
# * {string} notebookId - ID associated with the notebook
|
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 - If notebook was successfully deleted (https://api.losant.com/#/definitions/success)
|
101
|
+
#
|
102
|
+
# Errors:
|
103
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
104
|
+
# * 404 - Error if notebook was not found (https://api.losant.com/#/definitions/error)
|
105
|
+
def delete(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("applicationId is required") unless params.has_key?(:applicationId)
|
112
|
+
raise ArgumentError.new("notebookId is required") unless params.has_key?(:notebookId)
|
113
|
+
|
114
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
115
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
116
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
117
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
118
|
+
|
119
|
+
path = "/applications/#{params[:applicationId]}/notebooks/#{params[:notebookId]}"
|
120
|
+
|
121
|
+
@client.request(
|
122
|
+
method: :delete,
|
123
|
+
path: path,
|
124
|
+
query: query_params,
|
125
|
+
headers: headers,
|
126
|
+
body: body)
|
127
|
+
end
|
128
|
+
|
129
|
+
# Triggers the execution of a notebook
|
130
|
+
#
|
131
|
+
# Authentication:
|
132
|
+
# The client must be configured with a valid api
|
133
|
+
# access token to call this action. The token
|
134
|
+
# must include at least one of the following scopes:
|
135
|
+
# all.Application, all.Organization, all.User, notebook.*, or notebook.execute.
|
136
|
+
#
|
137
|
+
# Parameters:
|
138
|
+
# * {string} applicationId - ID associated with the application
|
139
|
+
# * {string} notebookId - ID associated with the notebook
|
140
|
+
# * {hash} executionOptions - The options for the execution (https://api.losant.com/#/definitions/notebookExecutionOptions)
|
141
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
142
|
+
# * {boolean} _actions - Return resource actions in response
|
143
|
+
# * {boolean} _links - Return resource link in response
|
144
|
+
# * {boolean} _embedded - Return embedded resources in response
|
145
|
+
#
|
146
|
+
# Responses:
|
147
|
+
# * 200 - If execution request was accepted and successfully queued (https://api.losant.com/#/definitions/successWithExecutionId)
|
148
|
+
#
|
149
|
+
# Errors:
|
150
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
151
|
+
# * 404 - Error if notebook was not found (https://api.losant.com/#/definitions/error)
|
152
|
+
def execute(params = {})
|
153
|
+
params = Utils.symbolize_hash_keys(params)
|
154
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
155
|
+
headers = {}
|
156
|
+
body = nil
|
157
|
+
|
158
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
159
|
+
raise ArgumentError.new("notebookId is required") unless params.has_key?(:notebookId)
|
160
|
+
raise ArgumentError.new("executionOptions is required") unless params.has_key?(:executionOptions)
|
161
|
+
|
162
|
+
body = params[:executionOptions] if params.has_key?(:executionOptions)
|
163
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
164
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
165
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
166
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
167
|
+
|
168
|
+
path = "/applications/#{params[:applicationId]}/notebooks/#{params[:notebookId]}/execute"
|
169
|
+
|
170
|
+
@client.request(
|
171
|
+
method: :post,
|
172
|
+
path: path,
|
173
|
+
query: query_params,
|
174
|
+
headers: headers,
|
175
|
+
body: body)
|
176
|
+
end
|
177
|
+
|
178
|
+
# Retrieves information on a notebook
|
179
|
+
#
|
180
|
+
# Authentication:
|
181
|
+
# The client must be configured with a valid api
|
182
|
+
# access token to call this action. The token
|
183
|
+
# must include at least one of the following scopes:
|
184
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebook.*, or notebook.get.
|
185
|
+
#
|
186
|
+
# Parameters:
|
187
|
+
# * {string} applicationId - ID associated with the application
|
188
|
+
# * {string} notebookId - ID associated with the notebook
|
189
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
190
|
+
# * {boolean} _actions - Return resource actions in response
|
191
|
+
# * {boolean} _links - Return resource link in response
|
192
|
+
# * {boolean} _embedded - Return embedded resources in response
|
193
|
+
#
|
194
|
+
# Responses:
|
195
|
+
# * 200 - notebook information (https://api.losant.com/#/definitions/notebook)
|
196
|
+
#
|
197
|
+
# Errors:
|
198
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
199
|
+
# * 404 - Error if notebook was not found (https://api.losant.com/#/definitions/error)
|
200
|
+
def get(params = {})
|
201
|
+
params = Utils.symbolize_hash_keys(params)
|
202
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
203
|
+
headers = {}
|
204
|
+
body = nil
|
205
|
+
|
206
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
207
|
+
raise ArgumentError.new("notebookId is required") unless params.has_key?(:notebookId)
|
208
|
+
|
209
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
210
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
211
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
212
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
213
|
+
|
214
|
+
path = "/applications/#{params[:applicationId]}/notebooks/#{params[:notebookId]}"
|
215
|
+
|
216
|
+
@client.request(
|
217
|
+
method: :get,
|
218
|
+
path: path,
|
219
|
+
query: query_params,
|
220
|
+
headers: headers,
|
221
|
+
body: body)
|
222
|
+
end
|
223
|
+
|
224
|
+
# Retrieves information on notebook executions
|
225
|
+
#
|
226
|
+
# Authentication:
|
227
|
+
# The client must be configured with a valid api
|
228
|
+
# access token to call this action. The token
|
229
|
+
# must include at least one of the following scopes:
|
230
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebook.*, or notebook.logs.
|
231
|
+
#
|
232
|
+
# Parameters:
|
233
|
+
# * {string} applicationId - ID associated with the application
|
234
|
+
# * {string} notebookId - ID associated with the notebook
|
235
|
+
# * {string} limit - Max log entries to return (ordered by time descending)
|
236
|
+
# * {string} since - Look for log entries since this time (ms since epoch)
|
237
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
238
|
+
# * {boolean} _actions - Return resource actions in response
|
239
|
+
# * {boolean} _links - Return resource link in response
|
240
|
+
# * {boolean} _embedded - Return embedded resources in response
|
241
|
+
#
|
242
|
+
# Responses:
|
243
|
+
# * 200 - notebook execution information (https://api.losant.com/#/definitions/notebookExecutionLogs)
|
244
|
+
#
|
245
|
+
# Errors:
|
246
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
247
|
+
# * 404 - Error if notebook was not found (https://api.losant.com/#/definitions/error)
|
248
|
+
def logs(params = {})
|
249
|
+
params = Utils.symbolize_hash_keys(params)
|
250
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
251
|
+
headers = {}
|
252
|
+
body = nil
|
253
|
+
|
254
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
255
|
+
raise ArgumentError.new("notebookId is required") unless params.has_key?(:notebookId)
|
256
|
+
|
257
|
+
query_params[:limit] = params[:limit] if params.has_key?(:limit)
|
258
|
+
query_params[:since] = params[:since] if params.has_key?(:since)
|
259
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
260
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
261
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
262
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
263
|
+
|
264
|
+
path = "/applications/#{params[:applicationId]}/notebooks/#{params[:notebookId]}/logs"
|
265
|
+
|
266
|
+
@client.request(
|
267
|
+
method: :get,
|
268
|
+
path: path,
|
269
|
+
query: query_params,
|
270
|
+
headers: headers,
|
271
|
+
body: body)
|
272
|
+
end
|
273
|
+
|
274
|
+
# Returns notebook execution usage by day for the time range specified for this notebook
|
275
|
+
#
|
276
|
+
# Authentication:
|
277
|
+
# The client must be configured with a valid api
|
278
|
+
# access token to call this action. The token
|
279
|
+
# must include at least one of the following scopes:
|
280
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebook.*, or notebook.notebookMinuteCounts.
|
281
|
+
#
|
282
|
+
# Parameters:
|
283
|
+
# * {string} applicationId - ID associated with the application
|
284
|
+
# * {string} notebookId - ID associated with the notebook
|
285
|
+
# * {string} start - Start of range for notebook execution query (ms since epoch)
|
286
|
+
# * {string} end - End of range for notebook execution query (ms since epoch)
|
287
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
288
|
+
# * {boolean} _actions - Return resource actions in response
|
289
|
+
# * {boolean} _links - Return resource link in response
|
290
|
+
# * {boolean} _embedded - Return embedded resources in response
|
291
|
+
#
|
292
|
+
# Responses:
|
293
|
+
# * 200 - Notebook usage information (https://api.losant.com/#/definitions/notebookMinuteCounts)
|
294
|
+
#
|
295
|
+
# Errors:
|
296
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
297
|
+
# * 404 - Error if notebook was not found (https://api.losant.com/#/definitions/error)
|
298
|
+
def notebook_minute_counts(params = {})
|
299
|
+
params = Utils.symbolize_hash_keys(params)
|
300
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
301
|
+
headers = {}
|
302
|
+
body = nil
|
303
|
+
|
304
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
305
|
+
raise ArgumentError.new("notebookId is required") unless params.has_key?(:notebookId)
|
306
|
+
|
307
|
+
query_params[:start] = params[:start] if params.has_key?(:start)
|
308
|
+
query_params[:end] = params[:end] if params.has_key?(:end)
|
309
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
310
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
311
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
312
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
313
|
+
|
314
|
+
path = "/applications/#{params[:applicationId]}/notebooks/#{params[:notebookId]}/notebookMinuteCounts"
|
315
|
+
|
316
|
+
@client.request(
|
317
|
+
method: :get,
|
318
|
+
path: path,
|
319
|
+
query: query_params,
|
320
|
+
headers: headers,
|
321
|
+
body: body)
|
322
|
+
end
|
323
|
+
|
324
|
+
# Updates information about a notebook
|
325
|
+
#
|
326
|
+
# Authentication:
|
327
|
+
# The client must be configured with a valid api
|
328
|
+
# access token to call this action. The token
|
329
|
+
# must include at least one of the following scopes:
|
330
|
+
# all.Application, all.Organization, all.User, notebook.*, or notebook.patch.
|
331
|
+
#
|
332
|
+
# Parameters:
|
333
|
+
# * {string} applicationId - ID associated with the application
|
334
|
+
# * {string} notebookId - ID associated with the notebook
|
335
|
+
# * {hash} notebook - Object containing new properties of the notebook (https://api.losant.com/#/definitions/notebookPatch)
|
336
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
337
|
+
# * {boolean} _actions - Return resource actions in response
|
338
|
+
# * {boolean} _links - Return resource link in response
|
339
|
+
# * {boolean} _embedded - Return embedded resources in response
|
340
|
+
#
|
341
|
+
# Responses:
|
342
|
+
# * 200 - Updated notebook information (https://api.losant.com/#/definitions/notebook)
|
343
|
+
#
|
344
|
+
# Errors:
|
345
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
346
|
+
# * 404 - Error if notebook was not found (https://api.losant.com/#/definitions/error)
|
347
|
+
def patch(params = {})
|
348
|
+
params = Utils.symbolize_hash_keys(params)
|
349
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
350
|
+
headers = {}
|
351
|
+
body = nil
|
352
|
+
|
353
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
354
|
+
raise ArgumentError.new("notebookId is required") unless params.has_key?(:notebookId)
|
355
|
+
raise ArgumentError.new("notebook is required") unless params.has_key?(:notebook)
|
356
|
+
|
357
|
+
body = params[:notebook] if params.has_key?(:notebook)
|
358
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
359
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
360
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
361
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
362
|
+
|
363
|
+
path = "/applications/#{params[:applicationId]}/notebooks/#{params[:notebookId]}"
|
364
|
+
|
365
|
+
@client.request(
|
366
|
+
method: :patch,
|
367
|
+
path: path,
|
368
|
+
query: query_params,
|
369
|
+
headers: headers,
|
370
|
+
body: body)
|
371
|
+
end
|
372
|
+
|
373
|
+
# Requests a combined zip file of the potential input data for a notebook execution
|
374
|
+
#
|
375
|
+
# Authentication:
|
376
|
+
# The client must be configured with a valid api
|
377
|
+
# access token to call this action. The token
|
378
|
+
# must include at least one of the following scopes:
|
379
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebook.*, or notebook.requestInputDataExport.
|
380
|
+
#
|
381
|
+
# Parameters:
|
382
|
+
# * {string} applicationId - ID associated with the application
|
383
|
+
# * {string} notebookId - ID associated with the notebook
|
384
|
+
# * {hash} exportOptions - The options for the export (https://api.losant.com/#/definitions/notebookDataExportOptions)
|
385
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
386
|
+
# * {boolean} _actions - Return resource actions in response
|
387
|
+
# * {boolean} _links - Return resource link in response
|
388
|
+
# * {boolean} _embedded - Return embedded resources in response
|
389
|
+
#
|
390
|
+
# Responses:
|
391
|
+
# * 202 - If export request was accepted and successfully queued (https://api.losant.com/#/definitions/jobEnqueuedResult)
|
392
|
+
#
|
393
|
+
# Errors:
|
394
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
395
|
+
# * 404 - Error if notebook was not found (https://api.losant.com/#/definitions/error)
|
396
|
+
def request_input_data_export(params = {})
|
397
|
+
params = Utils.symbolize_hash_keys(params)
|
398
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
399
|
+
headers = {}
|
400
|
+
body = nil
|
401
|
+
|
402
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
403
|
+
raise ArgumentError.new("notebookId is required") unless params.has_key?(:notebookId)
|
404
|
+
raise ArgumentError.new("exportOptions is required") unless params.has_key?(:exportOptions)
|
405
|
+
|
406
|
+
body = params[:exportOptions] if params.has_key?(:exportOptions)
|
407
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
408
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
409
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
410
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
411
|
+
|
412
|
+
path = "/applications/#{params[:applicationId]}/notebooks/#{params[:notebookId]}/requestInputDataExport"
|
413
|
+
|
414
|
+
@client.request(
|
415
|
+
method: :post,
|
416
|
+
path: path,
|
417
|
+
query: query_params,
|
418
|
+
headers: headers,
|
419
|
+
body: body)
|
420
|
+
end
|
421
|
+
|
422
|
+
end
|
423
|
+
end
|
@@ -0,0 +1,138 @@
|
|
1
|
+
# The MIT License (MIT)
|
2
|
+
#
|
3
|
+
# Copyright (c) 2023 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 PlatformRest
|
26
|
+
|
27
|
+
# Class containing all the actions for the Notebooks Resource
|
28
|
+
class Notebooks
|
29
|
+
|
30
|
+
def initialize(client)
|
31
|
+
@client = client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Returns the notebooks for an application
|
35
|
+
#
|
36
|
+
# Authentication:
|
37
|
+
# The client must be configured with a valid api
|
38
|
+
# access token to call this action. The token
|
39
|
+
# must include at least one of the following scopes:
|
40
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebooks.*, or notebooks.get.
|
41
|
+
#
|
42
|
+
# Parameters:
|
43
|
+
# * {string} applicationId - ID associated with the application
|
44
|
+
# * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated, lastExecutionRequested
|
45
|
+
# * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
|
46
|
+
# * {string} page - Which page of results to return
|
47
|
+
# * {string} perPage - How many items to return per page
|
48
|
+
# * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
|
49
|
+
# * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
|
50
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
51
|
+
# * {boolean} _actions - Return resource actions in response
|
52
|
+
# * {boolean} _links - Return resource link in response
|
53
|
+
# * {boolean} _embedded - Return embedded resources in response
|
54
|
+
#
|
55
|
+
# Responses:
|
56
|
+
# * 200 - Collection of notebooks (https://api.losant.com/#/definitions/notebooks)
|
57
|
+
#
|
58
|
+
# Errors:
|
59
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
60
|
+
# * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
|
61
|
+
def get(params = {})
|
62
|
+
params = Utils.symbolize_hash_keys(params)
|
63
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
64
|
+
headers = {}
|
65
|
+
body = nil
|
66
|
+
|
67
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
68
|
+
|
69
|
+
query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
|
70
|
+
query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
|
71
|
+
query_params[:page] = params[:page] if params.has_key?(:page)
|
72
|
+
query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
|
73
|
+
query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
|
74
|
+
query_params[:filter] = params[:filter] if params.has_key?(:filter)
|
75
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
76
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
77
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
78
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
79
|
+
|
80
|
+
path = "/applications/#{params[:applicationId]}/notebooks"
|
81
|
+
|
82
|
+
@client.request(
|
83
|
+
method: :get,
|
84
|
+
path: path,
|
85
|
+
query: query_params,
|
86
|
+
headers: headers,
|
87
|
+
body: body)
|
88
|
+
end
|
89
|
+
|
90
|
+
# Create a new notebook for an application
|
91
|
+
#
|
92
|
+
# Authentication:
|
93
|
+
# The client must be configured with a valid api
|
94
|
+
# access token to call this action. The token
|
95
|
+
# must include at least one of the following scopes:
|
96
|
+
# all.Application, all.Organization, all.User, notebooks.*, or notebooks.post.
|
97
|
+
#
|
98
|
+
# Parameters:
|
99
|
+
# * {string} applicationId - ID associated with the application
|
100
|
+
# * {hash} notebook - New notebook information (https://api.losant.com/#/definitions/notebookPost)
|
101
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
102
|
+
# * {boolean} _actions - Return resource actions in response
|
103
|
+
# * {boolean} _links - Return resource link in response
|
104
|
+
# * {boolean} _embedded - Return embedded resources in response
|
105
|
+
#
|
106
|
+
# Responses:
|
107
|
+
# * 201 - Successfully created notebook (https://api.losant.com/#/definitions/notebook)
|
108
|
+
#
|
109
|
+
# Errors:
|
110
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
111
|
+
# * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
|
112
|
+
def post(params = {})
|
113
|
+
params = Utils.symbolize_hash_keys(params)
|
114
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
115
|
+
headers = {}
|
116
|
+
body = nil
|
117
|
+
|
118
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
119
|
+
raise ArgumentError.new("notebook is required") unless params.has_key?(:notebook)
|
120
|
+
|
121
|
+
body = params[:notebook] if params.has_key?(:notebook)
|
122
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
123
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
124
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
125
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
126
|
+
|
127
|
+
path = "/applications/#{params[:applicationId]}/notebooks"
|
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
|