losant_rest 1.19.0 → 1.19.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +872 -38
  3. data/docs/applications.md +49 -0
  4. data/docs/device.md +12 -3
  5. data/docs/me.md +116 -0
  6. data/lib/losant_rest/version.rb +1 -1
  7. data/lib/platform_rest/application.rb +932 -0
  8. data/lib/platform_rest/application_api_token.rb +176 -0
  9. data/lib/platform_rest/application_api_tokens.rb +136 -0
  10. data/lib/platform_rest/application_certificate.rb +176 -0
  11. data/lib/platform_rest/application_certificate_authorities.rb +138 -0
  12. data/lib/platform_rest/application_certificate_authority.rb +176 -0
  13. data/lib/platform_rest/application_certificates.rb +138 -0
  14. data/lib/platform_rest/application_dashboard.rb +225 -0
  15. data/lib/platform_rest/application_dashboards.rb +138 -0
  16. data/lib/platform_rest/application_key.rb +176 -0
  17. data/lib/platform_rest/application_keys.rb +141 -0
  18. data/lib/platform_rest/application_template.rb +79 -0
  19. data/lib/platform_rest/application_templates.rb +176 -0
  20. data/lib/platform_rest/applications.rb +209 -0
  21. data/lib/platform_rest/audit_log.rb +81 -0
  22. data/lib/platform_rest/audit_logs.rb +93 -0
  23. data/lib/platform_rest/auth.rb +245 -0
  24. data/lib/platform_rest/client.rb +410 -0
  25. data/lib/platform_rest/credential.rb +224 -0
  26. data/lib/platform_rest/credentials.rb +138 -0
  27. data/lib/platform_rest/dashboard.rb +268 -0
  28. data/lib/platform_rest/dashboards.rb +136 -0
  29. data/lib/platform_rest/data.rb +176 -0
  30. data/lib/platform_rest/data_table.rb +274 -0
  31. data/lib/platform_rest/data_table_row.rb +182 -0
  32. data/lib/platform_rest/data_table_rows.rb +343 -0
  33. data/lib/platform_rest/data_tables.rb +138 -0
  34. data/lib/platform_rest/device.rb +767 -0
  35. data/lib/platform_rest/device_recipe.rb +234 -0
  36. data/lib/platform_rest/device_recipes.rb +146 -0
  37. data/lib/platform_rest/devices.rb +707 -0
  38. data/lib/platform_rest/edge_deployment.rb +81 -0
  39. data/lib/platform_rest/edge_deployments.rb +236 -0
  40. data/lib/platform_rest/embedded_deployment.rb +81 -0
  41. data/lib/platform_rest/embedded_deployments.rb +280 -0
  42. data/lib/platform_rest/error.rb +34 -0
  43. data/lib/platform_rest/event.rb +176 -0
  44. data/lib/platform_rest/events.rb +341 -0
  45. data/lib/platform_rest/experience.rb +142 -0
  46. data/lib/platform_rest/experience_domain.rb +176 -0
  47. data/lib/platform_rest/experience_domains.rb +126 -0
  48. data/lib/platform_rest/experience_endpoint.rb +230 -0
  49. data/lib/platform_rest/experience_endpoints.rb +200 -0
  50. data/lib/platform_rest/experience_group.rb +180 -0
  51. data/lib/platform_rest/experience_groups.rb +141 -0
  52. data/lib/platform_rest/experience_slug.rb +176 -0
  53. data/lib/platform_rest/experience_slugs.rb +126 -0
  54. data/lib/platform_rest/experience_user.rb +176 -0
  55. data/lib/platform_rest/experience_users.rb +142 -0
  56. data/lib/platform_rest/experience_version.rb +176 -0
  57. data/lib/platform_rest/experience_versions.rb +138 -0
  58. data/lib/platform_rest/experience_view.rb +228 -0
  59. data/lib/platform_rest/experience_views.rb +142 -0
  60. data/lib/platform_rest/file.rb +226 -0
  61. data/lib/platform_rest/files.rb +144 -0
  62. data/lib/platform_rest/flow.rb +580 -0
  63. data/lib/platform_rest/flow_version.rb +352 -0
  64. data/lib/platform_rest/flow_versions.rb +201 -0
  65. data/lib/platform_rest/flows.rb +310 -0
  66. data/lib/platform_rest/instance.rb +377 -0
  67. data/lib/platform_rest/instance_api_token.rb +176 -0
  68. data/lib/platform_rest/instance_api_tokens.rb +136 -0
  69. data/lib/platform_rest/instance_custom_node.rb +282 -0
  70. data/lib/platform_rest/instance_custom_nodes.rb +136 -0
  71. data/lib/platform_rest/instance_member.rb +176 -0
  72. data/lib/platform_rest/instance_members.rb +134 -0
  73. data/lib/platform_rest/instance_org.rb +336 -0
  74. data/lib/platform_rest/instance_org_invite.rb +182 -0
  75. data/lib/platform_rest/instance_org_invites.rb +138 -0
  76. data/lib/platform_rest/instance_org_member.rb +182 -0
  77. data/lib/platform_rest/instance_org_members.rb +138 -0
  78. data/lib/platform_rest/instance_orgs.rb +139 -0
  79. data/lib/platform_rest/instance_sandbox.rb +181 -0
  80. data/lib/platform_rest/instance_sandboxes.rb +98 -0
  81. data/lib/platform_rest/instances.rb +88 -0
  82. data/lib/platform_rest/integration.rb +178 -0
  83. data/lib/platform_rest/integrations.rb +138 -0
  84. data/lib/platform_rest/me.rb +923 -0
  85. data/lib/platform_rest/notebook.rb +423 -0
  86. data/lib/platform_rest/notebooks.rb +138 -0
  87. data/lib/platform_rest/org.rb +663 -0
  88. data/lib/platform_rest/org_invites.rb +124 -0
  89. data/lib/platform_rest/orgs.rb +140 -0
  90. data/lib/platform_rest/resource_job.rb +326 -0
  91. data/lib/platform_rest/resource_jobs.rb +138 -0
  92. data/lib/platform_rest/user_api_token.rb +170 -0
  93. data/lib/platform_rest/user_api_tokens.rb +132 -0
  94. data/lib/platform_rest/utils.rb +44 -0
  95. data/lib/platform_rest/webhook.rb +178 -0
  96. data/lib/platform_rest/webhooks.rb +138 -0
  97. data/lib/platform_rest.rb +129 -0
  98. data/schemas/apiTokenPost.json +4 -0
  99. data/schemas/applicationDashboardPost.json +66 -0
  100. data/schemas/dashboard.json +66 -0
  101. data/schemas/dashboardPatch.json +66 -0
  102. data/schemas/dashboardPost.json +66 -0
  103. data/schemas/dashboards.json +66 -0
  104. data/schemas/deviceConnectionStatus.json +10 -0
  105. data/schemas/deviceLog.json +3 -0
  106. data/schemas/event.json +8 -0
  107. data/schemas/eventPlusNewCount.json +8 -0
  108. data/schemas/events.json +8 -0
  109. data/schemas/githubLogin.json +4 -0
  110. data/schemas/integrationPatch.json +0 -10
  111. data/schemas/orgInviteActionUser.json +18 -0
  112. data/schemas/orgInviteResultUser.json +18 -0
  113. data/schemas/orgInviteUser.json +51 -0
  114. data/schemas/orgInvitesUser.json +59 -0
  115. data/schemas/payloadCountsBreakdown.json +1 -25
  116. data/schemas/periodSummaries.json +172 -0
  117. data/schemas/samlResponse.json +4 -0
  118. data/schemas/userCredentials.json +4 -0
  119. data/schemas/userPost.json +4 -0
  120. metadata +98 -2
@@ -0,0 +1,352 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2023 Losant IoT, Inc.
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
23
+ require "json"
24
+
25
+ module PlatformRest
26
+
27
+ # Class containing all the actions for the Flow Version Resource
28
+ class FlowVersion
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Deletes a flow version
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, flowVersion.*, or flowVersion.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} flowId - ID associated with the flow
45
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
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 flow version was successfully deleted (https://api.losant.com/#/definitions/success)
53
+ #
54
+ # Errors:
55
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
56
+ # * 404 - Error if flow version was not found (https://api.losant.com/#/definitions/error)
57
+ def delete(params = {})
58
+ params = Utils.symbolize_hash_keys(params)
59
+ query_params = { _actions: false, _links: true, _embedded: true }
60
+ headers = {}
61
+ body = nil
62
+
63
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
64
+ raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
65
+ raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
66
+
67
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
68
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
69
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
70
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
71
+
72
+ path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}"
73
+
74
+ @client.request(
75
+ method: :delete,
76
+ path: path,
77
+ query: query_params,
78
+ headers: headers,
79
+ body: body)
80
+ end
81
+
82
+ # Get information about errors that occurred during runs of this workflow version
83
+ #
84
+ # Authentication:
85
+ # The client must be configured with a valid api
86
+ # access token to call this action. The token
87
+ # must include at least one of the following scopes:
88
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.errors.
89
+ #
90
+ # Parameters:
91
+ # * {string} applicationId - ID associated with the application
92
+ # * {string} flowId - ID associated with the flow
93
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
94
+ # * {string} duration - Duration of time range in milliseconds
95
+ # * {string} end - End of time range in milliseconds since epoch
96
+ # * {string} limit - Maximum number of errors to return
97
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
98
+ # * {string} deviceId - For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs.
99
+ # * {string} losantdomain - Domain scope of request (rarely needed)
100
+ # * {boolean} _actions - Return resource actions in response
101
+ # * {boolean} _links - Return resource link in response
102
+ # * {boolean} _embedded - Return embedded resources in response
103
+ #
104
+ # Responses:
105
+ # * 200 - Workflow error information (https://api.losant.com/#/definitions/flowErrors)
106
+ #
107
+ # Errors:
108
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
109
+ # * 404 - Error if flow version was not found (https://api.losant.com/#/definitions/error)
110
+ def errors(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("applicationId is required") unless params.has_key?(:applicationId)
117
+ raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
118
+ raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
119
+
120
+ query_params[:duration] = params[:duration] if params.has_key?(:duration)
121
+ query_params[:end] = params[:end] if params.has_key?(:end)
122
+ query_params[:limit] = params[:limit] if params.has_key?(:limit)
123
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
124
+ query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
125
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
126
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
127
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
128
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
129
+
130
+ path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}/errors"
131
+
132
+ @client.request(
133
+ method: :get,
134
+ path: path,
135
+ query: query_params,
136
+ headers: headers,
137
+ body: body)
138
+ end
139
+
140
+ # Retrieves information on a flow version
141
+ #
142
+ # Authentication:
143
+ # The client must be configured with a valid api
144
+ # access token to call this action. The token
145
+ # must include at least one of the following scopes:
146
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.get.
147
+ #
148
+ # Parameters:
149
+ # * {string} applicationId - ID associated with the application
150
+ # * {string} flowId - ID associated with the flow
151
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
152
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
153
+ # * {string} losantdomain - Domain scope of request (rarely needed)
154
+ # * {boolean} _actions - Return resource actions in response
155
+ # * {boolean} _links - Return resource link in response
156
+ # * {boolean} _embedded - Return embedded resources in response
157
+ #
158
+ # Responses:
159
+ # * 200 - Flow version information (https://api.losant.com/#/definitions/flowVersion)
160
+ #
161
+ # Errors:
162
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
163
+ # * 404 - Error if flow version was not found (https://api.losant.com/#/definitions/error)
164
+ def get(params = {})
165
+ params = Utils.symbolize_hash_keys(params)
166
+ query_params = { _actions: false, _links: true, _embedded: true }
167
+ headers = {}
168
+ body = nil
169
+
170
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
171
+ raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
172
+ raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
173
+
174
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
175
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
176
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
177
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
178
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
179
+
180
+ path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}"
181
+
182
+ @client.request(
183
+ method: :get,
184
+ path: path,
185
+ query: query_params,
186
+ headers: headers,
187
+ body: body)
188
+ end
189
+
190
+ # Retrieve the recent log entries about runs of this workflow version
191
+ #
192
+ # Authentication:
193
+ # The client must be configured with a valid api
194
+ # access token to call this action. The token
195
+ # must include at least one of the following scopes:
196
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.log.
197
+ #
198
+ # Parameters:
199
+ # * {string} applicationId - ID associated with the application
200
+ # * {string} flowId - ID associated with the flow
201
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
202
+ # * {string} limit - Max log entries to return (ordered by time descending)
203
+ # * {string} since - Look for log entries since this time (ms since epoch)
204
+ # * {string} losantdomain - Domain scope of request (rarely needed)
205
+ # * {boolean} _actions - Return resource actions in response
206
+ # * {boolean} _links - Return resource link in response
207
+ # * {boolean} _embedded - Return embedded resources in response
208
+ #
209
+ # Responses:
210
+ # * 200 - Recent log entries (https://api.losant.com/#/definitions/flowLog)
211
+ #
212
+ # Errors:
213
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
214
+ # * 404 - Error if flow version was not found (https://api.losant.com/#/definitions/error)
215
+ def get_log_entries(params = {})
216
+ params = Utils.symbolize_hash_keys(params)
217
+ query_params = { _actions: false, _links: true, _embedded: true }
218
+ headers = {}
219
+ body = nil
220
+
221
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
222
+ raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
223
+ raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
224
+
225
+ query_params[:limit] = params[:limit] if params.has_key?(:limit)
226
+ query_params[:since] = params[:since] if params.has_key?(:since)
227
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
228
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
229
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
230
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
231
+
232
+ path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}/logs"
233
+
234
+ @client.request(
235
+ method: :get,
236
+ path: path,
237
+ query: query_params,
238
+ headers: headers,
239
+ body: body)
240
+ end
241
+
242
+ # Updates information about a flow version
243
+ #
244
+ # Authentication:
245
+ # The client must be configured with a valid api
246
+ # access token to call this action. The token
247
+ # must include at least one of the following scopes:
248
+ # all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.patch.
249
+ #
250
+ # Parameters:
251
+ # * {string} applicationId - ID associated with the application
252
+ # * {string} flowId - ID associated with the flow
253
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
254
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
255
+ # * {hash} flowVersion - Object containing new properties of the flow version (https://api.losant.com/#/definitions/flowVersionPatch)
256
+ # * {string} losantdomain - Domain scope of request (rarely needed)
257
+ # * {boolean} _actions - Return resource actions in response
258
+ # * {boolean} _links - Return resource link in response
259
+ # * {boolean} _embedded - Return embedded resources in response
260
+ #
261
+ # Responses:
262
+ # * 200 - Updated flow version information (https://api.losant.com/#/definitions/flowVersion)
263
+ #
264
+ # Errors:
265
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
266
+ # * 404 - Error if flow version was not found (https://api.losant.com/#/definitions/error)
267
+ def patch(params = {})
268
+ params = Utils.symbolize_hash_keys(params)
269
+ query_params = { _actions: false, _links: true, _embedded: true }
270
+ headers = {}
271
+ body = nil
272
+
273
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
274
+ raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
275
+ raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
276
+ raise ArgumentError.new("flowVersion is required") unless params.has_key?(:flowVersion)
277
+
278
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
279
+ body = params[:flowVersion] if params.has_key?(:flowVersion)
280
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
281
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
282
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
283
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
284
+
285
+ path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}"
286
+
287
+ @client.request(
288
+ method: :patch,
289
+ path: path,
290
+ query: query_params,
291
+ headers: headers,
292
+ body: body)
293
+ end
294
+
295
+ # Get statistics about workflow runs for this workflow version
296
+ #
297
+ # Authentication:
298
+ # The client must be configured with a valid api
299
+ # access token to call this action. The token
300
+ # must include at least one of the following scopes:
301
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.stats.
302
+ #
303
+ # Parameters:
304
+ # * {string} applicationId - ID associated with the application
305
+ # * {string} flowId - ID associated with the flow
306
+ # * {string} flowVersionId - Version ID or version name associated with the flow version
307
+ # * {string} duration - Duration of time range in milliseconds
308
+ # * {string} end - End of time range in milliseconds since epoch
309
+ # * {string} resolution - Resolution in milliseconds
310
+ # * {string} deviceId - For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs.
311
+ # * {string} losantdomain - Domain scope of request (rarely needed)
312
+ # * {boolean} _actions - Return resource actions in response
313
+ # * {boolean} _links - Return resource link in response
314
+ # * {boolean} _embedded - Return embedded resources in response
315
+ #
316
+ # Responses:
317
+ # * 200 - Statistics for workflow runs (https://api.losant.com/#/definitions/flowStats)
318
+ #
319
+ # Errors:
320
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
321
+ # * 404 - Error if flow version was not found (https://api.losant.com/#/definitions/error)
322
+ def stats(params = {})
323
+ params = Utils.symbolize_hash_keys(params)
324
+ query_params = { _actions: false, _links: true, _embedded: true }
325
+ headers = {}
326
+ body = nil
327
+
328
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
329
+ raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
330
+ raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
331
+
332
+ query_params[:duration] = params[:duration] if params.has_key?(:duration)
333
+ query_params[:end] = params[:end] if params.has_key?(:end)
334
+ query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
335
+ query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
336
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
337
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
338
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
339
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
340
+
341
+ path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}/stats"
342
+
343
+ @client.request(
344
+ method: :get,
345
+ path: path,
346
+ query: query_params,
347
+ headers: headers,
348
+ body: body)
349
+ end
350
+
351
+ end
352
+ end
@@ -0,0 +1,201 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2023 Losant IoT, Inc.
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
23
+ require "json"
24
+
25
+ module PlatformRest
26
+
27
+ # Class containing all the actions for the Flow Versions Resource
28
+ class FlowVersions
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Delete flow versions
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, flowVersions.*, or flowVersions.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} flowId - ID associated with the flow
45
+ # * {hash} options - Object containing flow version deletion options (https://api.losant.com/#/definitions/flowVersionsDeletePost)
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 - Object indicating number of flow versions deleted or failed (https://api.losant.com/#/definitions/bulkDeleteResponse)
53
+ # * 202 - If a job was enqueued for the flow versions to be deleted (https://api.losant.com/#/definitions/jobEnqueuedResult)
54
+ #
55
+ # Errors:
56
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
57
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
58
+ def delete(params = {})
59
+ params = Utils.symbolize_hash_keys(params)
60
+ query_params = { _actions: false, _links: true, _embedded: true }
61
+ headers = {}
62
+ body = nil
63
+
64
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
65
+ raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
66
+ raise ArgumentError.new("options is required") unless params.has_key?(:options)
67
+
68
+ body = params[:options] if params.has_key?(:options)
69
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
70
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
71
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
72
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
73
+
74
+ path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/delete"
75
+
76
+ @client.request(
77
+ method: :post,
78
+ path: path,
79
+ query: query_params,
80
+ headers: headers,
81
+ body: body)
82
+ end
83
+
84
+ # Returns the flow versions for a flow
85
+ #
86
+ # Authentication:
87
+ # The client must be configured with a valid api
88
+ # access token to call this action. The token
89
+ # must include at least one of the following scopes:
90
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersions.*, or flowVersions.get.
91
+ #
92
+ # Parameters:
93
+ # * {string} applicationId - ID associated with the application
94
+ # * {string} flowId - ID associated with the flow
95
+ # * {string} sortField - Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated
96
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
97
+ # * {string} page - Which page of results to return
98
+ # * {string} perPage - How many items to return per page
99
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: version
100
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
101
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
102
+ # * {hash} query - Workflow filter JSON object which overrides the filterField and filter parameters. (https://api.losant.com/#/definitions/advancedFlowVersionQuery)
103
+ # * {string} losantdomain - Domain scope of request (rarely needed)
104
+ # * {boolean} _actions - Return resource actions in response
105
+ # * {boolean} _links - Return resource link in response
106
+ # * {boolean} _embedded - Return embedded resources in response
107
+ #
108
+ # Responses:
109
+ # * 200 - Collection of flow versions (https://api.losant.com/#/definitions/flowVersions)
110
+ #
111
+ # Errors:
112
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
113
+ # * 404 - Error if flow was not found (https://api.losant.com/#/definitions/error)
114
+ def get(params = {})
115
+ params = Utils.symbolize_hash_keys(params)
116
+ query_params = { _actions: false, _links: true, _embedded: true }
117
+ headers = {}
118
+ body = nil
119
+
120
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
121
+ raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
122
+
123
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
124
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
125
+ query_params[:page] = params[:page] if params.has_key?(:page)
126
+ query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
127
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
128
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
129
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
130
+ query_params[:query] = params[:query] if params.has_key?(:query)
131
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
132
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
133
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
134
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
135
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
136
+
137
+ path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions"
138
+
139
+ @client.request(
140
+ method: :get,
141
+ path: path,
142
+ query: query_params,
143
+ headers: headers,
144
+ body: body)
145
+ end
146
+
147
+ # Create or replace a flow version for a flow
148
+ #
149
+ # Authentication:
150
+ # The client must be configured with a valid api
151
+ # access token to call this action. The token
152
+ # must include at least one of the following scopes:
153
+ # all.Application, all.Organization, all.User, flowVersions.*, or flowVersions.post.
154
+ #
155
+ # Parameters:
156
+ # * {string} applicationId - ID associated with the application
157
+ # * {string} flowId - ID associated with the flow
158
+ # * {hash} flowVersion - New flow version information (https://api.losant.com/#/definitions/flowVersionPost)
159
+ # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
160
+ # * {string} allowReplacement - Allow replacement of an existing flow version with same version name
161
+ # * {string} losantdomain - Domain scope of request (rarely needed)
162
+ # * {boolean} _actions - Return resource actions in response
163
+ # * {boolean} _links - Return resource link in response
164
+ # * {boolean} _embedded - Return embedded resources in response
165
+ #
166
+ # Responses:
167
+ # * 201 - Successfully created flow version (https://api.losant.com/#/definitions/flowVersion)
168
+ #
169
+ # Errors:
170
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
171
+ # * 404 - Error if flow was not found (https://api.losant.com/#/definitions/error)
172
+ def post(params = {})
173
+ params = Utils.symbolize_hash_keys(params)
174
+ query_params = { _actions: false, _links: true, _embedded: true }
175
+ headers = {}
176
+ body = nil
177
+
178
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
179
+ raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
180
+ raise ArgumentError.new("flowVersion is required") unless params.has_key?(:flowVersion)
181
+
182
+ body = params[:flowVersion] if params.has_key?(:flowVersion)
183
+ query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
184
+ query_params[:allowReplacement] = params[:allowReplacement] if params.has_key?(:allowReplacement)
185
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
186
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
187
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
188
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
189
+
190
+ path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions"
191
+
192
+ @client.request(
193
+ method: :post,
194
+ path: path,
195
+ query: query_params,
196
+ headers: headers,
197
+ body: body)
198
+ end
199
+
200
+ end
201
+ end