losant_rest 1.19.4 → 1.19.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (249) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +9 -9
  4. data/docs/_schemas.md +7090 -2334
  5. data/docs/experienceUsers.md +1 -0
  6. data/docs/instanceAuditLog.md +49 -0
  7. data/docs/instanceAuditLogs.md +53 -0
  8. data/examples/auth.rb +1 -1
  9. data/examples/list_devices.rb +1 -1
  10. data/lib/platform_rest/application.rb +1 -1
  11. data/lib/platform_rest/application_api_token.rb +1 -1
  12. data/lib/platform_rest/application_api_tokens.rb +1 -1
  13. data/lib/platform_rest/application_certificate.rb +1 -1
  14. data/lib/platform_rest/application_certificate_authorities.rb +1 -1
  15. data/lib/platform_rest/application_certificate_authority.rb +1 -1
  16. data/lib/platform_rest/application_certificates.rb +1 -1
  17. data/lib/platform_rest/application_dashboard.rb +1 -1
  18. data/lib/platform_rest/application_dashboards.rb +1 -1
  19. data/lib/platform_rest/application_key.rb +1 -1
  20. data/lib/platform_rest/application_keys.rb +1 -1
  21. data/lib/platform_rest/application_template.rb +1 -1
  22. data/lib/platform_rest/application_templates.rb +1 -1
  23. data/lib/platform_rest/applications.rb +1 -1
  24. data/lib/platform_rest/audit_log.rb +1 -1
  25. data/lib/platform_rest/audit_logs.rb +1 -1
  26. data/lib/platform_rest/auth.rb +1 -1
  27. data/lib/platform_rest/client.rb +11 -3
  28. data/lib/platform_rest/credential.rb +1 -1
  29. data/lib/platform_rest/credentials.rb +1 -1
  30. data/lib/platform_rest/dashboard.rb +1 -1
  31. data/lib/platform_rest/dashboards.rb +1 -1
  32. data/lib/platform_rest/data.rb +1 -1
  33. data/lib/platform_rest/data_table.rb +1 -1
  34. data/lib/platform_rest/data_table_row.rb +1 -1
  35. data/lib/platform_rest/data_table_rows.rb +1 -1
  36. data/lib/platform_rest/data_tables.rb +1 -1
  37. data/lib/platform_rest/device.rb +1 -1
  38. data/lib/platform_rest/device_recipe.rb +1 -1
  39. data/lib/platform_rest/device_recipes.rb +1 -1
  40. data/lib/platform_rest/devices.rb +1 -1
  41. data/lib/platform_rest/edge_deployment.rb +1 -1
  42. data/lib/platform_rest/edge_deployments.rb +1 -1
  43. data/lib/platform_rest/embedded_deployment.rb +1 -1
  44. data/lib/platform_rest/embedded_deployments.rb +1 -1
  45. data/lib/platform_rest/error.rb +1 -1
  46. data/lib/platform_rest/event.rb +1 -1
  47. data/lib/platform_rest/events.rb +1 -1
  48. data/lib/platform_rest/experience.rb +1 -1
  49. data/lib/platform_rest/experience_domain.rb +1 -1
  50. data/lib/platform_rest/experience_domains.rb +1 -1
  51. data/lib/platform_rest/experience_endpoint.rb +1 -1
  52. data/lib/platform_rest/experience_endpoints.rb +1 -1
  53. data/lib/platform_rest/experience_group.rb +1 -1
  54. data/lib/platform_rest/experience_groups.rb +1 -1
  55. data/lib/platform_rest/experience_slug.rb +1 -1
  56. data/lib/platform_rest/experience_slugs.rb +1 -1
  57. data/lib/platform_rest/experience_user.rb +1 -1
  58. data/lib/platform_rest/experience_users.rb +4 -1
  59. data/lib/platform_rest/experience_version.rb +1 -1
  60. data/lib/platform_rest/experience_versions.rb +1 -1
  61. data/lib/platform_rest/experience_view.rb +1 -1
  62. data/lib/platform_rest/experience_views.rb +1 -1
  63. data/lib/platform_rest/file.rb +1 -1
  64. data/lib/platform_rest/files.rb +1 -1
  65. data/lib/platform_rest/flow.rb +1 -1
  66. data/lib/platform_rest/flow_version.rb +1 -1
  67. data/lib/platform_rest/flow_versions.rb +1 -1
  68. data/lib/platform_rest/flows.rb +1 -1
  69. data/lib/platform_rest/instance.rb +1 -1
  70. data/lib/platform_rest/instance_api_token.rb +1 -1
  71. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  72. data/lib/{losant_rest/application_template.rb → platform_rest/instance_audit_log.rb} +13 -11
  73. data/lib/{losant_rest/audit_logs.rb → platform_rest/instance_audit_logs.rb} +12 -12
  74. data/lib/platform_rest/instance_custom_node.rb +1 -1
  75. data/lib/platform_rest/instance_custom_nodes.rb +1 -1
  76. data/lib/platform_rest/instance_member.rb +1 -1
  77. data/lib/platform_rest/instance_members.rb +1 -1
  78. data/lib/platform_rest/instance_org.rb +1 -1
  79. data/lib/platform_rest/instance_org_invite.rb +1 -1
  80. data/lib/platform_rest/instance_org_invites.rb +1 -1
  81. data/lib/platform_rest/instance_org_member.rb +1 -1
  82. data/lib/platform_rest/instance_org_members.rb +1 -1
  83. data/lib/platform_rest/instance_orgs.rb +1 -1
  84. data/lib/platform_rest/instance_sandbox.rb +1 -1
  85. data/lib/platform_rest/instance_sandboxes.rb +1 -1
  86. data/lib/platform_rest/instances.rb +1 -1
  87. data/lib/platform_rest/integration.rb +1 -1
  88. data/lib/platform_rest/integrations.rb +1 -1
  89. data/lib/platform_rest/me.rb +1 -1
  90. data/lib/platform_rest/notebook.rb +1 -1
  91. data/lib/platform_rest/notebooks.rb +1 -1
  92. data/lib/platform_rest/org.rb +1 -1
  93. data/lib/platform_rest/org_invites.rb +1 -1
  94. data/lib/platform_rest/orgs.rb +1 -1
  95. data/lib/platform_rest/resource_job.rb +1 -1
  96. data/lib/platform_rest/resource_jobs.rb +1 -1
  97. data/lib/platform_rest/user_api_token.rb +1 -1
  98. data/lib/platform_rest/user_api_tokens.rb +1 -1
  99. data/lib/platform_rest/utils.rb +1 -1
  100. data/lib/{losant_rest → platform_rest}/version.rb +3 -3
  101. data/lib/platform_rest/webhook.rb +1 -1
  102. data/lib/platform_rest/webhooks.rb +1 -1
  103. data/lib/platform_rest.rb +3 -1
  104. data/losant_rest.gemspec +2 -2
  105. data/schemas/advancedExperienceUserQuery.json +1068 -0
  106. data/schemas/apiTokenPost.json +9 -1
  107. data/schemas/auditLog.json +3 -2
  108. data/schemas/auditLogFilter.json +3 -2
  109. data/schemas/auditLogs.json +3 -2
  110. data/schemas/credential.json +95 -1
  111. data/schemas/credentialLinkedResources.json +417 -19
  112. data/schemas/credentialPatch.json +107 -0
  113. data/schemas/credentialPost.json +129 -1
  114. data/schemas/credentials.json +95 -1
  115. data/schemas/deviceConnectionStatus.json +6 -2
  116. data/schemas/devicesHistoricalImportPost.json +25 -0
  117. data/schemas/experienceLinkedResources.json +343 -20
  118. data/schemas/experienceVersion.json +64 -0
  119. data/schemas/experienceVersionPatch.json +64 -0
  120. data/schemas/experienceVersionPost.json +64 -0
  121. data/schemas/experienceVersions.json +64 -0
  122. data/schemas/experienceView.json +1 -2
  123. data/schemas/experienceViewPatch.json +1 -2
  124. data/schemas/experienceViewPost.json +2 -4
  125. data/schemas/experienceViews.json +1 -2
  126. data/schemas/flow.json +114 -6
  127. data/schemas/flowPatch.json +114 -6
  128. data/schemas/flowPost.json +114 -6
  129. data/schemas/flowVersion.json +228 -12
  130. data/schemas/flowVersionPost.json +114 -6
  131. data/schemas/flowVersions.json +228 -12
  132. data/schemas/flows.json +114 -6
  133. data/schemas/flowsImportPost.json +228 -12
  134. data/schemas/flowsImportResult.json +342 -18
  135. data/schemas/githubLogin.json +9 -1
  136. data/schemas/instance.json +1 -4
  137. data/schemas/instanceAuditLog.json +94 -0
  138. data/schemas/instanceAuditLogFilter.json +106 -0
  139. data/schemas/instanceAuditLogs.json +41 -0
  140. data/schemas/instanceCustomNode.json +2 -1
  141. data/schemas/instanceCustomNodePatch.json +2 -7
  142. data/schemas/instanceCustomNodePost.json +2 -7
  143. data/schemas/instanceCustomNodes.json +2 -1
  144. data/schemas/instanceOrgMember.json +4 -1
  145. data/schemas/instances.json +1 -4
  146. data/schemas/integration.json +75 -1
  147. data/schemas/integrationPatch.json +73 -0
  148. data/schemas/integrationPost.json +75 -1
  149. data/schemas/integrations.json +75 -1
  150. data/schemas/mePatch.json +18 -0
  151. data/schemas/resourceJob.json +2 -1
  152. data/schemas/resourceJobExecutionLogs.json +2 -1
  153. data/schemas/resourceJobPost.json +2 -1
  154. data/schemas/resourceJobs.json +2 -1
  155. data/schemas/samlResponse.json +9 -1
  156. data/schemas/userCredentials.json +9 -1
  157. data/schemas/userPost.json +9 -1
  158. data/test/basic_test.rb +6 -6
  159. data/test/test_helper.rb +1 -1
  160. metadata +12 -94
  161. data/lib/losant_rest/application.rb +0 -932
  162. data/lib/losant_rest/application_api_token.rb +0 -176
  163. data/lib/losant_rest/application_api_tokens.rb +0 -136
  164. data/lib/losant_rest/application_certificate.rb +0 -176
  165. data/lib/losant_rest/application_certificate_authorities.rb +0 -138
  166. data/lib/losant_rest/application_certificate_authority.rb +0 -176
  167. data/lib/losant_rest/application_certificates.rb +0 -138
  168. data/lib/losant_rest/application_dashboard.rb +0 -225
  169. data/lib/losant_rest/application_dashboards.rb +0 -138
  170. data/lib/losant_rest/application_key.rb +0 -176
  171. data/lib/losant_rest/application_keys.rb +0 -141
  172. data/lib/losant_rest/application_templates.rb +0 -176
  173. data/lib/losant_rest/applications.rb +0 -142
  174. data/lib/losant_rest/audit_log.rb +0 -81
  175. data/lib/losant_rest/auth.rb +0 -245
  176. data/lib/losant_rest/client.rb +0 -410
  177. data/lib/losant_rest/credential.rb +0 -224
  178. data/lib/losant_rest/credentials.rb +0 -138
  179. data/lib/losant_rest/dashboard.rb +0 -268
  180. data/lib/losant_rest/dashboards.rb +0 -136
  181. data/lib/losant_rest/data.rb +0 -176
  182. data/lib/losant_rest/data_table.rb +0 -274
  183. data/lib/losant_rest/data_table_row.rb +0 -182
  184. data/lib/losant_rest/data_table_rows.rb +0 -343
  185. data/lib/losant_rest/data_tables.rb +0 -138
  186. data/lib/losant_rest/device.rb +0 -749
  187. data/lib/losant_rest/device_recipe.rb +0 -234
  188. data/lib/losant_rest/device_recipes.rb +0 -146
  189. data/lib/losant_rest/devices.rb +0 -707
  190. data/lib/losant_rest/edge_deployment.rb +0 -81
  191. data/lib/losant_rest/edge_deployments.rb +0 -236
  192. data/lib/losant_rest/embedded_deployment.rb +0 -81
  193. data/lib/losant_rest/embedded_deployments.rb +0 -280
  194. data/lib/losant_rest/error.rb +0 -34
  195. data/lib/losant_rest/event.rb +0 -176
  196. data/lib/losant_rest/events.rb +0 -341
  197. data/lib/losant_rest/experience.rb +0 -142
  198. data/lib/losant_rest/experience_domain.rb +0 -176
  199. data/lib/losant_rest/experience_domains.rb +0 -126
  200. data/lib/losant_rest/experience_endpoint.rb +0 -230
  201. data/lib/losant_rest/experience_endpoints.rb +0 -200
  202. data/lib/losant_rest/experience_group.rb +0 -180
  203. data/lib/losant_rest/experience_groups.rb +0 -141
  204. data/lib/losant_rest/experience_slug.rb +0 -176
  205. data/lib/losant_rest/experience_slugs.rb +0 -126
  206. data/lib/losant_rest/experience_user.rb +0 -176
  207. data/lib/losant_rest/experience_users.rb +0 -142
  208. data/lib/losant_rest/experience_version.rb +0 -176
  209. data/lib/losant_rest/experience_versions.rb +0 -138
  210. data/lib/losant_rest/experience_view.rb +0 -228
  211. data/lib/losant_rest/experience_views.rb +0 -142
  212. data/lib/losant_rest/file.rb +0 -226
  213. data/lib/losant_rest/files.rb +0 -144
  214. data/lib/losant_rest/flow.rb +0 -580
  215. data/lib/losant_rest/flow_version.rb +0 -352
  216. data/lib/losant_rest/flow_versions.rb +0 -201
  217. data/lib/losant_rest/flows.rb +0 -310
  218. data/lib/losant_rest/instance.rb +0 -377
  219. data/lib/losant_rest/instance_api_token.rb +0 -176
  220. data/lib/losant_rest/instance_api_tokens.rb +0 -136
  221. data/lib/losant_rest/instance_custom_node.rb +0 -282
  222. data/lib/losant_rest/instance_custom_nodes.rb +0 -136
  223. data/lib/losant_rest/instance_member.rb +0 -176
  224. data/lib/losant_rest/instance_members.rb +0 -134
  225. data/lib/losant_rest/instance_org.rb +0 -336
  226. data/lib/losant_rest/instance_org_invite.rb +0 -182
  227. data/lib/losant_rest/instance_org_invites.rb +0 -138
  228. data/lib/losant_rest/instance_org_member.rb +0 -182
  229. data/lib/losant_rest/instance_org_members.rb +0 -138
  230. data/lib/losant_rest/instance_orgs.rb +0 -139
  231. data/lib/losant_rest/instance_sandbox.rb +0 -181
  232. data/lib/losant_rest/instance_sandboxes.rb +0 -98
  233. data/lib/losant_rest/instances.rb +0 -88
  234. data/lib/losant_rest/integration.rb +0 -178
  235. data/lib/losant_rest/integrations.rb +0 -138
  236. data/lib/losant_rest/me.rb +0 -790
  237. data/lib/losant_rest/notebook.rb +0 -423
  238. data/lib/losant_rest/notebooks.rb +0 -138
  239. data/lib/losant_rest/org.rb +0 -663
  240. data/lib/losant_rest/org_invites.rb +0 -124
  241. data/lib/losant_rest/orgs.rb +0 -140
  242. data/lib/losant_rest/resource_job.rb +0 -326
  243. data/lib/losant_rest/resource_jobs.rb +0 -138
  244. data/lib/losant_rest/user_api_token.rb +0 -170
  245. data/lib/losant_rest/user_api_tokens.rb +0 -132
  246. data/lib/losant_rest/utils.rb +0 -44
  247. data/lib/losant_rest/webhook.rb +0 -178
  248. data/lib/losant_rest/webhooks.rb +0 -138
  249. data/lib/losant_rest.rb +0 -129
@@ -1,423 +0,0 @@
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 LosantRest
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
@@ -1,138 +0,0 @@
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 LosantRest
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