losant_rest 1.15.2 → 1.16.0
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 +5233 -1385
- data/docs/application.md +3 -4
- data/docs/applications.md +3 -2
- data/docs/flows.md +38 -0
- data/docs/instanceCustomNode.md +222 -0
- data/docs/instanceCustomNodes.md +91 -0
- data/lib/losant_rest/client.rb +10 -2
- data/lib/losant_rest/flows.rb +44 -0
- data/lib/losant_rest/instance_custom_node.rb +282 -0
- data/lib/losant_rest/instance_custom_nodes.rb +136 -0
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest.rb +2 -0
- data/schemas/apiTokenPost.json +11 -1
- data/schemas/applicationImportOptions.json +11 -0
- data/schemas/experienceLinkedResources.json +20 -5
- data/schemas/flow.json +18 -0
- data/schemas/flowPatch.json +19 -0
- data/schemas/flowPost.json +19 -0
- data/schemas/flowVersion.json +2 -5
- data/schemas/flowVersionPost.json +1 -0
- data/schemas/flowVersions.json +2 -5
- data/schemas/flows.json +18 -0
- data/schemas/flowsImportPost.json +29 -2
- data/schemas/flowsImportResult.json +20 -5
- data/schemas/githubLogin.json +11 -1
- data/schemas/instanceCustomNode.json +580 -0
- data/schemas/instanceCustomNodePatch.json +674 -0
- data/schemas/instanceCustomNodePost.json +679 -0
- data/schemas/instanceCustomNodes.json +625 -0
- data/schemas/integration.json +27 -0
- data/schemas/integrationPatch.json +27 -0
- data/schemas/integrationPost.json +27 -0
- data/schemas/integrations.json +27 -0
- data/schemas/paletteResponse.json +785 -0
- data/schemas/userCredentials.json +11 -1
- data/schemas/userPost.json +11 -1
- metadata +12 -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
|
data/lib/losant_rest/version.rb
CHANGED
data/lib/losant_rest.rb
CHANGED
@@ -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"
|
data/schemas/apiTokenPost.json
CHANGED
@@ -265,6 +265,7 @@
|
|
265
265
|
"flows.get",
|
266
266
|
"flows.getByVersion",
|
267
267
|
"flows.import",
|
268
|
+
"flows.palette",
|
268
269
|
"flows.post",
|
269
270
|
"flowVersion.delete",
|
270
271
|
"flowVersion.errors",
|
@@ -379,7 +380,16 @@
|
|
379
380
|
"instanceApiToken.*",
|
380
381
|
"instanceApiToken.get",
|
381
382
|
"instanceApiToken.patch",
|
382
|
-
"instanceApiToken.delete"
|
383
|
+
"instanceApiToken.delete",
|
384
|
+
"instanceCustomNodes.*",
|
385
|
+
"instanceCustomNodes.get",
|
386
|
+
"instanceCustomNodes.post",
|
387
|
+
"instanceCustomNode.*",
|
388
|
+
"instanceCustomNode.get",
|
389
|
+
"instanceCustomNode.patch",
|
390
|
+
"instanceCustomNode.delete",
|
391
|
+
"instanceCustomNode.errors",
|
392
|
+
"instanceCustomNode.stats"
|
383
393
|
]
|
384
394
|
},
|
385
395
|
{
|
@@ -412,11 +412,28 @@
|
|
412
412
|
"type": "string",
|
413
413
|
"maxLength": 32767
|
414
414
|
},
|
415
|
+
"shortDescription": {
|
416
|
+
"type": "string",
|
417
|
+
"maxLength": 1024
|
418
|
+
},
|
415
419
|
"iconData": {
|
416
420
|
"type": "string",
|
417
421
|
"maxLength": 32767,
|
418
422
|
"pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
|
419
423
|
},
|
424
|
+
"docsUrl": {
|
425
|
+
"type": "string",
|
426
|
+
"maxLength": 1024
|
427
|
+
},
|
428
|
+
"category": {
|
429
|
+
"type": "string",
|
430
|
+
"enum": [
|
431
|
+
"data",
|
432
|
+
"experience",
|
433
|
+
"logic",
|
434
|
+
"output"
|
435
|
+
]
|
436
|
+
},
|
420
437
|
"enabled": {
|
421
438
|
"type": "boolean"
|
422
439
|
},
|
@@ -489,6 +506,7 @@
|
|
489
506
|
"deviceIdsTagsDisconnect",
|
490
507
|
"eeaInit",
|
491
508
|
"flowError",
|
509
|
+
"azureEventHub",
|
492
510
|
"googlePubSub",
|
493
511
|
"meridian",
|
494
512
|
"mqtt",
|
@@ -3128,6 +3146,7 @@
|
|
3128
3146
|
"deviceIdsTagsDisconnect",
|
3129
3147
|
"eeaInit",
|
3130
3148
|
"flowError",
|
3149
|
+
"azureEventHub",
|
3131
3150
|
"googlePubSub",
|
3132
3151
|
"meridian",
|
3133
3152
|
"mqtt",
|
@@ -5643,11 +5662,6 @@
|
|
5643
5662
|
"type": "string",
|
5644
5663
|
"maxLength": 32767
|
5645
5664
|
},
|
5646
|
-
"iconData": {
|
5647
|
-
"type": "string",
|
5648
|
-
"maxLength": 32767,
|
5649
|
-
"pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
|
5650
|
-
},
|
5651
5665
|
"flowClass": {
|
5652
5666
|
"type": "string",
|
5653
5667
|
"enum": [
|
@@ -5716,6 +5730,7 @@
|
|
5716
5730
|
"deviceIdsTagsDisconnect",
|
5717
5731
|
"eeaInit",
|
5718
5732
|
"flowError",
|
5733
|
+
"azureEventHub",
|
5719
5734
|
"googlePubSub",
|
5720
5735
|
"meridian",
|
5721
5736
|
"mqtt",
|
data/schemas/flow.json
CHANGED
@@ -31,11 +31,28 @@
|
|
31
31
|
"type": "string",
|
32
32
|
"maxLength": 32767
|
33
33
|
},
|
34
|
+
"shortDescription": {
|
35
|
+
"type": "string",
|
36
|
+
"maxLength": 1024
|
37
|
+
},
|
34
38
|
"iconData": {
|
35
39
|
"type": "string",
|
36
40
|
"maxLength": 32767,
|
37
41
|
"pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
|
38
42
|
},
|
43
|
+
"docsUrl": {
|
44
|
+
"type": "string",
|
45
|
+
"maxLength": 1024
|
46
|
+
},
|
47
|
+
"category": {
|
48
|
+
"type": "string",
|
49
|
+
"enum": [
|
50
|
+
"data",
|
51
|
+
"experience",
|
52
|
+
"logic",
|
53
|
+
"output"
|
54
|
+
]
|
55
|
+
},
|
39
56
|
"enabled": {
|
40
57
|
"type": "boolean"
|
41
58
|
},
|
@@ -108,6 +125,7 @@
|
|
108
125
|
"deviceIdsTagsDisconnect",
|
109
126
|
"eeaInit",
|
110
127
|
"flowError",
|
128
|
+
"azureEventHub",
|
111
129
|
"googlePubSub",
|
112
130
|
"meridian",
|
113
131
|
"mqtt",
|
data/schemas/flowPatch.json
CHANGED
@@ -11,6 +11,10 @@
|
|
11
11
|
"type": "string",
|
12
12
|
"maxLength": 32767
|
13
13
|
},
|
14
|
+
"shortDescription": {
|
15
|
+
"type": "string",
|
16
|
+
"maxLength": 1024
|
17
|
+
},
|
14
18
|
"iconData": {
|
15
19
|
"oneOf": [
|
16
20
|
{
|
@@ -23,6 +27,20 @@
|
|
23
27
|
}
|
24
28
|
]
|
25
29
|
},
|
30
|
+
"docsUrl": {
|
31
|
+
"type": "string",
|
32
|
+
"maxLength": 1024
|
33
|
+
},
|
34
|
+
"category": {
|
35
|
+
"type": "string",
|
36
|
+
"enum": [
|
37
|
+
"data",
|
38
|
+
"experience",
|
39
|
+
"logic",
|
40
|
+
"output",
|
41
|
+
""
|
42
|
+
]
|
43
|
+
},
|
26
44
|
"enabled": {
|
27
45
|
"type": "boolean"
|
28
46
|
},
|
@@ -88,6 +106,7 @@
|
|
88
106
|
"deviceIdsTagsDisconnect",
|
89
107
|
"eeaInit",
|
90
108
|
"flowError",
|
109
|
+
"azureEventHub",
|
91
110
|
"googlePubSub",
|
92
111
|
"meridian",
|
93
112
|
"mqtt",
|
data/schemas/flowPost.json
CHANGED
@@ -11,6 +11,10 @@
|
|
11
11
|
"type": "string",
|
12
12
|
"maxLength": 32767
|
13
13
|
},
|
14
|
+
"shortDescription": {
|
15
|
+
"type": "string",
|
16
|
+
"maxLength": 1024
|
17
|
+
},
|
14
18
|
"iconData": {
|
15
19
|
"oneOf": [
|
16
20
|
{
|
@@ -23,6 +27,20 @@
|
|
23
27
|
}
|
24
28
|
]
|
25
29
|
},
|
30
|
+
"docsUrl": {
|
31
|
+
"type": "string",
|
32
|
+
"maxLength": 1024
|
33
|
+
},
|
34
|
+
"category": {
|
35
|
+
"type": "string",
|
36
|
+
"enum": [
|
37
|
+
"data",
|
38
|
+
"experience",
|
39
|
+
"logic",
|
40
|
+
"output",
|
41
|
+
""
|
42
|
+
]
|
43
|
+
},
|
26
44
|
"enabled": {
|
27
45
|
"type": "boolean"
|
28
46
|
},
|
@@ -77,6 +95,7 @@
|
|
77
95
|
"deviceIdsTagsDisconnect",
|
78
96
|
"eeaInit",
|
79
97
|
"flowError",
|
98
|
+
"azureEventHub",
|
80
99
|
"googlePubSub",
|
81
100
|
"meridian",
|
82
101
|
"mqtt",
|
data/schemas/flowVersion.json
CHANGED
@@ -92,6 +92,7 @@
|
|
92
92
|
"deviceIdsTagsDisconnect",
|
93
93
|
"eeaInit",
|
94
94
|
"flowError",
|
95
|
+
"azureEventHub",
|
95
96
|
"googlePubSub",
|
96
97
|
"meridian",
|
97
98
|
"mqtt",
|
@@ -2607,11 +2608,6 @@
|
|
2607
2608
|
"type": "string",
|
2608
2609
|
"maxLength": 32767
|
2609
2610
|
},
|
2610
|
-
"iconData": {
|
2611
|
-
"type": "string",
|
2612
|
-
"maxLength": 32767,
|
2613
|
-
"pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
|
2614
|
-
},
|
2615
2611
|
"flowClass": {
|
2616
2612
|
"type": "string",
|
2617
2613
|
"enum": [
|
@@ -2680,6 +2676,7 @@
|
|
2680
2676
|
"deviceIdsTagsDisconnect",
|
2681
2677
|
"eeaInit",
|
2682
2678
|
"flowError",
|
2679
|
+
"azureEventHub",
|
2683
2680
|
"googlePubSub",
|
2684
2681
|
"meridian",
|
2685
2682
|
"mqtt",
|