losant_rest 1.15.1 → 1.16.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (152) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/docs/_schemas.md +12170 -4718
  4. data/docs/application.md +3 -4
  5. data/docs/applicationDashboard.md +43 -0
  6. data/docs/applications.md +3 -2
  7. data/docs/devices.md +40 -0
  8. data/docs/flows.md +38 -0
  9. data/docs/instanceCustomNode.md +222 -0
  10. data/docs/instanceCustomNodes.md +91 -0
  11. data/lib/losant_rest/application.rb +1 -1
  12. data/lib/losant_rest/application_api_token.rb +1 -1
  13. data/lib/losant_rest/application_api_tokens.rb +1 -1
  14. data/lib/losant_rest/application_certificate.rb +1 -1
  15. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  16. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  17. data/lib/losant_rest/application_certificates.rb +1 -1
  18. data/lib/losant_rest/application_dashboard.rb +50 -1
  19. data/lib/losant_rest/application_dashboards.rb +1 -1
  20. data/lib/losant_rest/application_key.rb +1 -1
  21. data/lib/losant_rest/application_keys.rb +1 -1
  22. data/lib/losant_rest/application_template.rb +1 -1
  23. data/lib/losant_rest/application_templates.rb +1 -1
  24. data/lib/losant_rest/applications.rb +1 -1
  25. data/lib/losant_rest/audit_log.rb +1 -1
  26. data/lib/losant_rest/audit_logs.rb +1 -1
  27. data/lib/losant_rest/auth.rb +1 -1
  28. data/lib/losant_rest/client.rb +11 -3
  29. data/lib/losant_rest/dashboard.rb +1 -1
  30. data/lib/losant_rest/dashboards.rb +1 -1
  31. data/lib/losant_rest/data.rb +1 -1
  32. data/lib/losant_rest/data_table.rb +1 -1
  33. data/lib/losant_rest/data_table_row.rb +1 -1
  34. data/lib/losant_rest/data_table_rows.rb +1 -1
  35. data/lib/losant_rest/data_tables.rb +1 -1
  36. data/lib/losant_rest/device.rb +1 -1
  37. data/lib/losant_rest/device_recipe.rb +1 -1
  38. data/lib/losant_rest/device_recipes.rb +1 -1
  39. data/lib/losant_rest/devices.rb +50 -1
  40. data/lib/losant_rest/edge_deployment.rb +1 -1
  41. data/lib/losant_rest/edge_deployments.rb +1 -1
  42. data/lib/losant_rest/embedded_deployment.rb +1 -1
  43. data/lib/losant_rest/embedded_deployments.rb +1 -1
  44. data/lib/losant_rest/error.rb +1 -1
  45. data/lib/losant_rest/event.rb +1 -1
  46. data/lib/losant_rest/events.rb +1 -1
  47. data/lib/losant_rest/experience.rb +1 -1
  48. data/lib/losant_rest/experience_domain.rb +1 -1
  49. data/lib/losant_rest/experience_domains.rb +1 -1
  50. data/lib/losant_rest/experience_endpoint.rb +1 -1
  51. data/lib/losant_rest/experience_endpoints.rb +1 -1
  52. data/lib/losant_rest/experience_group.rb +1 -1
  53. data/lib/losant_rest/experience_groups.rb +1 -1
  54. data/lib/losant_rest/experience_slug.rb +1 -1
  55. data/lib/losant_rest/experience_slugs.rb +1 -1
  56. data/lib/losant_rest/experience_user.rb +1 -1
  57. data/lib/losant_rest/experience_users.rb +1 -1
  58. data/lib/losant_rest/experience_version.rb +1 -1
  59. data/lib/losant_rest/experience_versions.rb +1 -1
  60. data/lib/losant_rest/experience_view.rb +1 -1
  61. data/lib/losant_rest/experience_views.rb +1 -1
  62. data/lib/losant_rest/file.rb +1 -1
  63. data/lib/losant_rest/files.rb +1 -1
  64. data/lib/losant_rest/flow.rb +1 -1
  65. data/lib/losant_rest/flow_version.rb +1 -1
  66. data/lib/losant_rest/flow_versions.rb +1 -1
  67. data/lib/losant_rest/flows.rb +45 -1
  68. data/lib/losant_rest/instance.rb +1 -1
  69. data/lib/losant_rest/instance_api_token.rb +1 -1
  70. data/lib/losant_rest/instance_api_tokens.rb +1 -1
  71. data/lib/losant_rest/instance_custom_node.rb +282 -0
  72. data/lib/losant_rest/instance_custom_nodes.rb +136 -0
  73. data/lib/losant_rest/instance_member.rb +1 -1
  74. data/lib/losant_rest/instance_members.rb +1 -1
  75. data/lib/losant_rest/instance_org.rb +1 -1
  76. data/lib/losant_rest/instance_org_invite.rb +1 -1
  77. data/lib/losant_rest/instance_org_invites.rb +1 -1
  78. data/lib/losant_rest/instance_org_member.rb +1 -1
  79. data/lib/losant_rest/instance_org_members.rb +1 -1
  80. data/lib/losant_rest/instance_orgs.rb +1 -1
  81. data/lib/losant_rest/instances.rb +1 -1
  82. data/lib/losant_rest/integration.rb +1 -1
  83. data/lib/losant_rest/integrations.rb +1 -1
  84. data/lib/losant_rest/me.rb +1 -1
  85. data/lib/losant_rest/notebook.rb +1 -1
  86. data/lib/losant_rest/notebooks.rb +1 -1
  87. data/lib/losant_rest/org.rb +1 -1
  88. data/lib/losant_rest/org_invites.rb +1 -1
  89. data/lib/losant_rest/orgs.rb +1 -1
  90. data/lib/losant_rest/user_api_token.rb +1 -1
  91. data/lib/losant_rest/user_api_tokens.rb +1 -1
  92. data/lib/losant_rest/utils.rb +1 -1
  93. data/lib/losant_rest/version.rb +2 -2
  94. data/lib/losant_rest/webhook.rb +1 -1
  95. data/lib/losant_rest/webhooks.rb +1 -1
  96. data/lib/losant_rest.rb +3 -1
  97. data/schemas/apiTokenPost.json +13 -1
  98. data/schemas/application.json +1 -1
  99. data/schemas/applicationApplyTemplatePatch.json +5 -0
  100. data/schemas/applicationClonePost.json +5 -0
  101. data/schemas/applicationCreationByTemplateResult.json +1 -1
  102. data/schemas/applicationDashboardPost.json +162 -3
  103. data/schemas/applicationExportPost.json +4 -0
  104. data/schemas/applicationImportOptions.json +43 -0
  105. data/schemas/applicationPatch.json +1 -1
  106. data/schemas/applicationPost.json +1 -1
  107. data/schemas/applications.json +1 -1
  108. data/schemas/dashboard.json +162 -3
  109. data/schemas/dashboardPatch.json +162 -3
  110. data/schemas/dashboardPost.json +162 -3
  111. data/schemas/dashboardSendReport.json +20 -3
  112. data/schemas/dashboards.json +162 -3
  113. data/schemas/deviceNamesResponse.json +36 -0
  114. data/schemas/experienceBootstrapOptions.json +1 -1
  115. data/schemas/experienceLinkedResources.json +485 -5
  116. data/schemas/experienceSlug.json +1 -1
  117. data/schemas/experienceSlugPatch.json +1 -1
  118. data/schemas/experienceSlugPost.json +1 -1
  119. data/schemas/experienceSlugs.json +1 -1
  120. data/schemas/experienceUser.json +2 -1
  121. data/schemas/experienceUsers.json +2 -1
  122. data/schemas/flow.json +173 -0
  123. data/schemas/flowPatch.json +174 -0
  124. data/schemas/flowPost.json +174 -0
  125. data/schemas/flowVersion.json +312 -5
  126. data/schemas/flowVersionPost.json +156 -0
  127. data/schemas/flowVersions.json +312 -5
  128. data/schemas/flows.json +173 -0
  129. data/schemas/flowsImportPost.json +339 -2
  130. data/schemas/flowsImportResult.json +485 -5
  131. data/schemas/githubLogin.json +13 -1
  132. data/schemas/instanceCustomNode.json +589 -0
  133. data/schemas/instanceCustomNodePatch.json +674 -0
  134. data/schemas/instanceCustomNodePost.json +679 -0
  135. data/schemas/instanceCustomNodes.json +634 -0
  136. data/schemas/instanceMember.json +2 -2
  137. data/schemas/instanceMembers.json +2 -2
  138. data/schemas/instanceOrg.json +8 -0
  139. data/schemas/instanceOrgMember.json +2 -2
  140. data/schemas/instanceOrgs.json +8 -0
  141. data/schemas/integration.json +30 -2
  142. data/schemas/integrationPatch.json +30 -2
  143. data/schemas/integrationPost.json +30 -2
  144. data/schemas/integrations.json +30 -2
  145. data/schemas/me.json +2 -2
  146. data/schemas/mePatch.json +0 -1
  147. data/schemas/org.json +2 -2
  148. data/schemas/orgs.json +2 -2
  149. data/schemas/paletteResponse.json +785 -0
  150. data/schemas/userCredentials.json +13 -1
  151. data/schemas/userPost.json +13 -2
  152. metadata +13 -2
@@ -0,0 +1,282 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2022 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 Custom Node Resource
28
+ class InstanceCustomNode
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Deletes a Custom Node
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, instanceCustomNode.*, or instanceCustomNode.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} instanceId - ID associated with the instance
44
+ # * {string} instanceCustomNodeId - ID associated with the Custom Node
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 Custom Node 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 Custom Node 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("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)
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]}/nodes/#{params[:instanceCustomNodeId]}"
71
+
72
+ @client.request(
73
+ method: :delete,
74
+ path: path,
75
+ query: query_params,
76
+ headers: headers,
77
+ body: body)
78
+ end
79
+
80
+ # Get information about errors that occurred during runs of this Custom Node
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, instanceCustomNode.*, or instanceCustomNode.errors.
87
+ #
88
+ # Parameters:
89
+ # * {string} instanceId - ID associated with the instance
90
+ # * {string} instanceCustomNodeId - ID associated with the Custom Node
91
+ # * {string} duration - Duration of time range in milliseconds
92
+ # * {string} end - End of time range in milliseconds since epoch
93
+ # * {string} limit - Maximum number of errors to return
94
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
95
+ # * {string} losantdomain - Domain scope of request (rarely needed)
96
+ # * {boolean} _actions - Return resource actions in response
97
+ # * {boolean} _links - Return resource link in response
98
+ # * {boolean} _embedded - Return embedded resources in response
99
+ #
100
+ # Responses:
101
+ # * 200 - Custom Node error information (https://api.losant.com/#/definitions/flowErrors)
102
+ #
103
+ # Errors:
104
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
105
+ # * 404 - Error if Custom Node was not found (https://api.losant.com/#/definitions/error)
106
+ def errors(params = {})
107
+ params = Utils.symbolize_hash_keys(params)
108
+ query_params = { _actions: false, _links: true, _embedded: true }
109
+ headers = {}
110
+ body = nil
111
+
112
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
113
+ raise ArgumentError.new("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)
114
+
115
+ query_params[:duration] = params[:duration] if params.has_key?(:duration)
116
+ query_params[:end] = params[:end] if params.has_key?(:end)
117
+ query_params[:limit] = params[:limit] if params.has_key?(:limit)
118
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
119
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
120
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
121
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
122
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
123
+
124
+ path = "/instances/#{params[:instanceId]}/nodes/#{params[:instanceCustomNodeId]}/errors"
125
+
126
+ @client.request(
127
+ method: :get,
128
+ path: path,
129
+ query: query_params,
130
+ headers: headers,
131
+ body: body)
132
+ end
133
+
134
+ # Retrieves information on a Custom Node
135
+ #
136
+ # Authentication:
137
+ # The client must be configured with a valid api
138
+ # access token to call this action. The token
139
+ # must include at least one of the following scopes:
140
+ # all.Instance, all.Instance.read, all.User, all.User.read, instanceCustomNode.*, or instanceCustomNode.get.
141
+ #
142
+ # Parameters:
143
+ # * {string} instanceId - ID associated with the instance
144
+ # * {string} instanceCustomNodeId - ID associated with the Custom Node
145
+ # * {string} losantdomain - Domain scope of request (rarely needed)
146
+ # * {boolean} _actions - Return resource actions in response
147
+ # * {boolean} _links - Return resource link in response
148
+ # * {boolean} _embedded - Return embedded resources in response
149
+ #
150
+ # Responses:
151
+ # * 200 - Custom Node information (https://api.losant.com/#/definitions/instanceCustomNode)
152
+ #
153
+ # Errors:
154
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
155
+ # * 404 - Error if Custom Node was not found (https://api.losant.com/#/definitions/error)
156
+ def get(params = {})
157
+ params = Utils.symbolize_hash_keys(params)
158
+ query_params = { _actions: false, _links: true, _embedded: true }
159
+ headers = {}
160
+ body = nil
161
+
162
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
163
+ raise ArgumentError.new("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)
164
+
165
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
166
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
167
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
168
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
169
+
170
+ path = "/instances/#{params[:instanceId]}/nodes/#{params[:instanceCustomNodeId]}"
171
+
172
+ @client.request(
173
+ method: :get,
174
+ path: path,
175
+ query: query_params,
176
+ headers: headers,
177
+ body: body)
178
+ end
179
+
180
+ # Updates information about a Custom Node
181
+ #
182
+ # Authentication:
183
+ # The client must be configured with a valid api
184
+ # access token to call this action. The token
185
+ # must include at least one of the following scopes:
186
+ # all.Instance, all.User, instanceCustomNode.*, or instanceCustomNode.patch.
187
+ #
188
+ # Parameters:
189
+ # * {string} instanceId - ID associated with the instance
190
+ # * {string} instanceCustomNodeId - ID associated with the Custom Node
191
+ # * {hash} instanceCustomNode - Object containing new properties of the Custom Node (https://api.losant.com/#/definitions/instanceCustomNodePatch)
192
+ # * {string} losantdomain - Domain scope of request (rarely needed)
193
+ # * {boolean} _actions - Return resource actions in response
194
+ # * {boolean} _links - Return resource link in response
195
+ # * {boolean} _embedded - Return embedded resources in response
196
+ #
197
+ # Responses:
198
+ # * 200 - Updated Custom Node information (https://api.losant.com/#/definitions/instanceCustomNode)
199
+ #
200
+ # Errors:
201
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
202
+ # * 404 - Error if Custom Node was not found (https://api.losant.com/#/definitions/error)
203
+ def patch(params = {})
204
+ params = Utils.symbolize_hash_keys(params)
205
+ query_params = { _actions: false, _links: true, _embedded: true }
206
+ headers = {}
207
+ body = nil
208
+
209
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
210
+ raise ArgumentError.new("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)
211
+ raise ArgumentError.new("instanceCustomNode is required") unless params.has_key?(:instanceCustomNode)
212
+
213
+ body = params[:instanceCustomNode] if params.has_key?(:instanceCustomNode)
214
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
215
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
216
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
217
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
218
+
219
+ path = "/instances/#{params[:instanceId]}/nodes/#{params[:instanceCustomNodeId]}"
220
+
221
+ @client.request(
222
+ method: :patch,
223
+ path: path,
224
+ query: query_params,
225
+ headers: headers,
226
+ body: body)
227
+ end
228
+
229
+ # Get statistics about runs for this Custom Node
230
+ #
231
+ # Authentication:
232
+ # The client must be configured with a valid api
233
+ # access token to call this action. The token
234
+ # must include at least one of the following scopes:
235
+ # all.Instance, all.Instance.read, all.User, all.User.read, instanceCustomNode.*, or instanceCustomNode.stats.
236
+ #
237
+ # Parameters:
238
+ # * {string} instanceId - ID associated with the instance
239
+ # * {string} instanceCustomNodeId - ID associated with the Custom Node
240
+ # * {string} duration - Duration of time range in milliseconds
241
+ # * {string} end - End of time range in milliseconds since epoch
242
+ # * {string} resolution - Resolution in milliseconds
243
+ # * {string} losantdomain - Domain scope of request (rarely needed)
244
+ # * {boolean} _actions - Return resource actions in response
245
+ # * {boolean} _links - Return resource link in response
246
+ # * {boolean} _embedded - Return embedded resources in response
247
+ #
248
+ # Responses:
249
+ # * 200 - Statistics for Custom Node runs (https://api.losant.com/#/definitions/flowStats)
250
+ #
251
+ # Errors:
252
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
253
+ # * 404 - Error if Custom Node was not found (https://api.losant.com/#/definitions/error)
254
+ def stats(params = {})
255
+ params = Utils.symbolize_hash_keys(params)
256
+ query_params = { _actions: false, _links: true, _embedded: true }
257
+ headers = {}
258
+ body = nil
259
+
260
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
261
+ raise ArgumentError.new("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)
262
+
263
+ query_params[:duration] = params[:duration] if params.has_key?(:duration)
264
+ query_params[:end] = params[:end] if params.has_key?(:end)
265
+ query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
266
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
267
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
268
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
269
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
270
+
271
+ path = "/instances/#{params[:instanceId]}/nodes/#{params[:instanceCustomNodeId]}/stats"
272
+
273
+ @client.request(
274
+ method: :get,
275
+ path: path,
276
+ query: query_params,
277
+ headers: headers,
278
+ body: body)
279
+ end
280
+
281
+ end
282
+ end
@@ -0,0 +1,136 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2022 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 Custom Nodes Resource
28
+ class InstanceCustomNodes
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Returns the Custom Nodes for an instance
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.Instance, all.Instance.read, all.User, all.User.read, instanceCustomNodes.*, or instanceCustomNodes.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} instanceId - ID associated with the instance
44
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
45
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
46
+ # * {string} page - Which page of results to return
47
+ # * {string} perPage - How many items to return per page
48
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
49
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
50
+ # * {string} 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 Custom Nodes (https://api.losant.com/#/definitions/instanceCustomNodes)
57
+ #
58
+ # Errors:
59
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
60
+ def get(params = {})
61
+ params = Utils.symbolize_hash_keys(params)
62
+ query_params = { _actions: false, _links: true, _embedded: true }
63
+ headers = {}
64
+ body = nil
65
+
66
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
67
+
68
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
69
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
70
+ query_params[:page] = params[:page] if params.has_key?(:page)
71
+ query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
72
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
73
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
74
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
75
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
76
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
77
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
78
+
79
+ path = "/instances/#{params[:instanceId]}/nodes"
80
+
81
+ @client.request(
82
+ method: :get,
83
+ path: path,
84
+ query: query_params,
85
+ headers: headers,
86
+ body: body)
87
+ end
88
+
89
+ # Create a new Custom Node for an instance
90
+ #
91
+ # Authentication:
92
+ # The client must be configured with a valid api
93
+ # access token to call this action. The token
94
+ # must include at least one of the following scopes:
95
+ # all.Instance, all.User, instanceCustomNodes.*, or instanceCustomNodes.post.
96
+ #
97
+ # Parameters:
98
+ # * {string} instanceId - ID associated with the instance
99
+ # * {hash} instanceCustomNode - Custom Node information (https://api.losant.com/#/definitions/instanceCustomNodePost)
100
+ # * {string} losantdomain - Domain scope of request (rarely needed)
101
+ # * {boolean} _actions - Return resource actions in response
102
+ # * {boolean} _links - Return resource link in response
103
+ # * {boolean} _embedded - Return embedded resources in response
104
+ #
105
+ # Responses:
106
+ # * 201 - The successfully created Custom Node (https://api.losant.com/#/definitions/instanceCustomNode)
107
+ #
108
+ # Errors:
109
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
110
+ def post(params = {})
111
+ params = Utils.symbolize_hash_keys(params)
112
+ query_params = { _actions: false, _links: true, _embedded: true }
113
+ headers = {}
114
+ body = nil
115
+
116
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
117
+ raise ArgumentError.new("instanceCustomNode is required") unless params.has_key?(:instanceCustomNode)
118
+
119
+ body = params[:instanceCustomNode] if params.has_key?(:instanceCustomNode)
120
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
121
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
122
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
123
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
124
+
125
+ path = "/instances/#{params[:instanceId]}/nodes"
126
+
127
+ @client.request(
128
+ method: :post,
129
+ path: path,
130
+ query: query_params,
131
+ headers: headers,
132
+ body: body)
133
+ end
134
+
135
+ end
136
+ end
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -21,5 +21,5 @@
21
21
  # SOFTWARE.
22
22
 
23
23
  module LosantRest
24
- VERSION = "1.15.1"
24
+ VERSION = "1.16.1"
25
25
  end
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
data/lib/losant_rest.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -81,6 +81,8 @@ require_relative "losant_rest/flows"
81
81
  require_relative "losant_rest/instance"
82
82
  require_relative "losant_rest/instance_api_token"
83
83
  require_relative "losant_rest/instance_api_tokens"
84
+ require_relative "losant_rest/instance_custom_node"
85
+ require_relative "losant_rest/instance_custom_nodes"
84
86
  require_relative "losant_rest/instance_member"
85
87
  require_relative "losant_rest/instance_members"
86
88
  require_relative "losant_rest/instance_org"