losant_rest 1.19.4 → 1.19.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (237) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +9 -9
  4. data/docs/_schemas.md +1142 -63
  5. data/docs/instanceAuditLog.md +49 -0
  6. data/docs/instanceAuditLogs.md +53 -0
  7. data/examples/auth.rb +1 -1
  8. data/examples/list_devices.rb +1 -1
  9. data/lib/platform_rest/application.rb +1 -1
  10. data/lib/platform_rest/application_api_token.rb +1 -1
  11. data/lib/platform_rest/application_api_tokens.rb +1 -1
  12. data/lib/platform_rest/application_certificate.rb +1 -1
  13. data/lib/platform_rest/application_certificate_authorities.rb +1 -1
  14. data/lib/platform_rest/application_certificate_authority.rb +1 -1
  15. data/lib/platform_rest/application_certificates.rb +1 -1
  16. data/lib/platform_rest/application_dashboard.rb +1 -1
  17. data/lib/platform_rest/application_dashboards.rb +1 -1
  18. data/lib/platform_rest/application_key.rb +1 -1
  19. data/lib/platform_rest/application_keys.rb +1 -1
  20. data/lib/platform_rest/application_template.rb +1 -1
  21. data/lib/platform_rest/application_templates.rb +1 -1
  22. data/lib/platform_rest/applications.rb +1 -1
  23. data/lib/platform_rest/audit_log.rb +1 -1
  24. data/lib/platform_rest/audit_logs.rb +1 -1
  25. data/lib/platform_rest/auth.rb +1 -1
  26. data/lib/platform_rest/client.rb +11 -3
  27. data/lib/platform_rest/credential.rb +1 -1
  28. data/lib/platform_rest/credentials.rb +1 -1
  29. data/lib/platform_rest/dashboard.rb +1 -1
  30. data/lib/platform_rest/dashboards.rb +1 -1
  31. data/lib/platform_rest/data.rb +1 -1
  32. data/lib/platform_rest/data_table.rb +1 -1
  33. data/lib/platform_rest/data_table_row.rb +1 -1
  34. data/lib/platform_rest/data_table_rows.rb +1 -1
  35. data/lib/platform_rest/data_tables.rb +1 -1
  36. data/lib/platform_rest/device.rb +1 -1
  37. data/lib/platform_rest/device_recipe.rb +1 -1
  38. data/lib/platform_rest/device_recipes.rb +1 -1
  39. data/lib/platform_rest/devices.rb +1 -1
  40. data/lib/platform_rest/edge_deployment.rb +1 -1
  41. data/lib/platform_rest/edge_deployments.rb +1 -1
  42. data/lib/platform_rest/embedded_deployment.rb +1 -1
  43. data/lib/platform_rest/embedded_deployments.rb +1 -1
  44. data/lib/platform_rest/error.rb +1 -1
  45. data/lib/platform_rest/event.rb +1 -1
  46. data/lib/platform_rest/events.rb +1 -1
  47. data/lib/platform_rest/experience.rb +1 -1
  48. data/lib/platform_rest/experience_domain.rb +1 -1
  49. data/lib/platform_rest/experience_domains.rb +1 -1
  50. data/lib/platform_rest/experience_endpoint.rb +1 -1
  51. data/lib/platform_rest/experience_endpoints.rb +1 -1
  52. data/lib/platform_rest/experience_group.rb +1 -1
  53. data/lib/platform_rest/experience_groups.rb +1 -1
  54. data/lib/platform_rest/experience_slug.rb +1 -1
  55. data/lib/platform_rest/experience_slugs.rb +1 -1
  56. data/lib/platform_rest/experience_user.rb +1 -1
  57. data/lib/platform_rest/experience_users.rb +1 -1
  58. data/lib/platform_rest/experience_version.rb +1 -1
  59. data/lib/platform_rest/experience_versions.rb +1 -1
  60. data/lib/platform_rest/experience_view.rb +1 -1
  61. data/lib/platform_rest/experience_views.rb +1 -1
  62. data/lib/platform_rest/file.rb +1 -1
  63. data/lib/platform_rest/files.rb +1 -1
  64. data/lib/platform_rest/flow.rb +1 -1
  65. data/lib/platform_rest/flow_version.rb +1 -1
  66. data/lib/platform_rest/flow_versions.rb +1 -1
  67. data/lib/platform_rest/flows.rb +1 -1
  68. data/lib/platform_rest/instance.rb +1 -1
  69. data/lib/platform_rest/instance_api_token.rb +1 -1
  70. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  71. data/lib/{losant_rest/application_template.rb → platform_rest/instance_audit_log.rb} +13 -11
  72. data/lib/{losant_rest/audit_logs.rb → platform_rest/instance_audit_logs.rb} +12 -12
  73. data/lib/platform_rest/instance_custom_node.rb +1 -1
  74. data/lib/platform_rest/instance_custom_nodes.rb +1 -1
  75. data/lib/platform_rest/instance_member.rb +1 -1
  76. data/lib/platform_rest/instance_members.rb +1 -1
  77. data/lib/platform_rest/instance_org.rb +1 -1
  78. data/lib/platform_rest/instance_org_invite.rb +1 -1
  79. data/lib/platform_rest/instance_org_invites.rb +1 -1
  80. data/lib/platform_rest/instance_org_member.rb +1 -1
  81. data/lib/platform_rest/instance_org_members.rb +1 -1
  82. data/lib/platform_rest/instance_orgs.rb +1 -1
  83. data/lib/platform_rest/instance_sandbox.rb +1 -1
  84. data/lib/platform_rest/instance_sandboxes.rb +1 -1
  85. data/lib/platform_rest/instances.rb +1 -1
  86. data/lib/platform_rest/integration.rb +1 -1
  87. data/lib/platform_rest/integrations.rb +1 -1
  88. data/lib/platform_rest/me.rb +1 -1
  89. data/lib/platform_rest/notebook.rb +1 -1
  90. data/lib/platform_rest/notebooks.rb +1 -1
  91. data/lib/platform_rest/org.rb +1 -1
  92. data/lib/platform_rest/org_invites.rb +1 -1
  93. data/lib/platform_rest/orgs.rb +1 -1
  94. data/lib/platform_rest/resource_job.rb +1 -1
  95. data/lib/platform_rest/resource_jobs.rb +1 -1
  96. data/lib/platform_rest/user_api_token.rb +1 -1
  97. data/lib/platform_rest/user_api_tokens.rb +1 -1
  98. data/lib/platform_rest/utils.rb +1 -1
  99. data/lib/{losant_rest → platform_rest}/version.rb +3 -3
  100. data/lib/platform_rest/webhook.rb +1 -1
  101. data/lib/platform_rest/webhooks.rb +1 -1
  102. data/lib/platform_rest.rb +3 -1
  103. data/losant_rest.gemspec +2 -2
  104. data/schemas/apiTokenPost.json +9 -1
  105. data/schemas/auditLog.json +3 -2
  106. data/schemas/auditLogFilter.json +3 -2
  107. data/schemas/auditLogs.json +3 -2
  108. data/schemas/credential.json +50 -1
  109. data/schemas/credentialLinkedResources.json +81 -4
  110. data/schemas/credentialPatch.json +56 -0
  111. data/schemas/credentialPost.json +71 -1
  112. data/schemas/credentials.json +50 -1
  113. data/schemas/deviceConnectionStatus.json +6 -2
  114. data/schemas/devicesHistoricalImportPost.json +25 -0
  115. data/schemas/experienceLinkedResources.json +7 -5
  116. data/schemas/experienceView.json +1 -2
  117. data/schemas/experienceViewPatch.json +1 -2
  118. data/schemas/experienceViewPost.json +2 -4
  119. data/schemas/experienceViews.json +1 -2
  120. data/schemas/flow.json +2 -1
  121. data/schemas/flowPatch.json +2 -1
  122. data/schemas/flowPost.json +2 -1
  123. data/schemas/flowVersion.json +4 -2
  124. data/schemas/flowVersionPost.json +2 -1
  125. data/schemas/flowVersions.json +4 -2
  126. data/schemas/flows.json +2 -1
  127. data/schemas/flowsImportPost.json +4 -2
  128. data/schemas/flowsImportResult.json +6 -3
  129. data/schemas/githubLogin.json +9 -1
  130. data/schemas/instance.json +1 -4
  131. data/schemas/instanceAuditLog.json +94 -0
  132. data/schemas/instanceAuditLogFilter.json +106 -0
  133. data/schemas/instanceAuditLogs.json +41 -0
  134. data/schemas/instanceCustomNodePatch.json +2 -1
  135. data/schemas/instanceCustomNodePost.json +2 -1
  136. data/schemas/instanceOrgMember.json +4 -1
  137. data/schemas/instances.json +1 -4
  138. data/schemas/integration.json +75 -1
  139. data/schemas/integrationPatch.json +73 -0
  140. data/schemas/integrationPost.json +75 -1
  141. data/schemas/integrations.json +75 -1
  142. data/schemas/mePatch.json +18 -0
  143. data/schemas/samlResponse.json +9 -1
  144. data/schemas/userCredentials.json +9 -1
  145. data/schemas/userPost.json +9 -1
  146. data/test/basic_test.rb +6 -6
  147. data/test/test_helper.rb +1 -1
  148. metadata +11 -94
  149. data/lib/losant_rest/application.rb +0 -932
  150. data/lib/losant_rest/application_api_token.rb +0 -176
  151. data/lib/losant_rest/application_api_tokens.rb +0 -136
  152. data/lib/losant_rest/application_certificate.rb +0 -176
  153. data/lib/losant_rest/application_certificate_authorities.rb +0 -138
  154. data/lib/losant_rest/application_certificate_authority.rb +0 -176
  155. data/lib/losant_rest/application_certificates.rb +0 -138
  156. data/lib/losant_rest/application_dashboard.rb +0 -225
  157. data/lib/losant_rest/application_dashboards.rb +0 -138
  158. data/lib/losant_rest/application_key.rb +0 -176
  159. data/lib/losant_rest/application_keys.rb +0 -141
  160. data/lib/losant_rest/application_templates.rb +0 -176
  161. data/lib/losant_rest/applications.rb +0 -142
  162. data/lib/losant_rest/audit_log.rb +0 -81
  163. data/lib/losant_rest/auth.rb +0 -245
  164. data/lib/losant_rest/client.rb +0 -410
  165. data/lib/losant_rest/credential.rb +0 -224
  166. data/lib/losant_rest/credentials.rb +0 -138
  167. data/lib/losant_rest/dashboard.rb +0 -268
  168. data/lib/losant_rest/dashboards.rb +0 -136
  169. data/lib/losant_rest/data.rb +0 -176
  170. data/lib/losant_rest/data_table.rb +0 -274
  171. data/lib/losant_rest/data_table_row.rb +0 -182
  172. data/lib/losant_rest/data_table_rows.rb +0 -343
  173. data/lib/losant_rest/data_tables.rb +0 -138
  174. data/lib/losant_rest/device.rb +0 -749
  175. data/lib/losant_rest/device_recipe.rb +0 -234
  176. data/lib/losant_rest/device_recipes.rb +0 -146
  177. data/lib/losant_rest/devices.rb +0 -707
  178. data/lib/losant_rest/edge_deployment.rb +0 -81
  179. data/lib/losant_rest/edge_deployments.rb +0 -236
  180. data/lib/losant_rest/embedded_deployment.rb +0 -81
  181. data/lib/losant_rest/embedded_deployments.rb +0 -280
  182. data/lib/losant_rest/error.rb +0 -34
  183. data/lib/losant_rest/event.rb +0 -176
  184. data/lib/losant_rest/events.rb +0 -341
  185. data/lib/losant_rest/experience.rb +0 -142
  186. data/lib/losant_rest/experience_domain.rb +0 -176
  187. data/lib/losant_rest/experience_domains.rb +0 -126
  188. data/lib/losant_rest/experience_endpoint.rb +0 -230
  189. data/lib/losant_rest/experience_endpoints.rb +0 -200
  190. data/lib/losant_rest/experience_group.rb +0 -180
  191. data/lib/losant_rest/experience_groups.rb +0 -141
  192. data/lib/losant_rest/experience_slug.rb +0 -176
  193. data/lib/losant_rest/experience_slugs.rb +0 -126
  194. data/lib/losant_rest/experience_user.rb +0 -176
  195. data/lib/losant_rest/experience_users.rb +0 -142
  196. data/lib/losant_rest/experience_version.rb +0 -176
  197. data/lib/losant_rest/experience_versions.rb +0 -138
  198. data/lib/losant_rest/experience_view.rb +0 -228
  199. data/lib/losant_rest/experience_views.rb +0 -142
  200. data/lib/losant_rest/file.rb +0 -226
  201. data/lib/losant_rest/files.rb +0 -144
  202. data/lib/losant_rest/flow.rb +0 -580
  203. data/lib/losant_rest/flow_version.rb +0 -352
  204. data/lib/losant_rest/flow_versions.rb +0 -201
  205. data/lib/losant_rest/flows.rb +0 -310
  206. data/lib/losant_rest/instance.rb +0 -377
  207. data/lib/losant_rest/instance_api_token.rb +0 -176
  208. data/lib/losant_rest/instance_api_tokens.rb +0 -136
  209. data/lib/losant_rest/instance_custom_node.rb +0 -282
  210. data/lib/losant_rest/instance_custom_nodes.rb +0 -136
  211. data/lib/losant_rest/instance_member.rb +0 -176
  212. data/lib/losant_rest/instance_members.rb +0 -134
  213. data/lib/losant_rest/instance_org.rb +0 -336
  214. data/lib/losant_rest/instance_org_invite.rb +0 -182
  215. data/lib/losant_rest/instance_org_invites.rb +0 -138
  216. data/lib/losant_rest/instance_org_member.rb +0 -182
  217. data/lib/losant_rest/instance_org_members.rb +0 -138
  218. data/lib/losant_rest/instance_orgs.rb +0 -139
  219. data/lib/losant_rest/instance_sandbox.rb +0 -181
  220. data/lib/losant_rest/instance_sandboxes.rb +0 -98
  221. data/lib/losant_rest/instances.rb +0 -88
  222. data/lib/losant_rest/integration.rb +0 -178
  223. data/lib/losant_rest/integrations.rb +0 -138
  224. data/lib/losant_rest/me.rb +0 -790
  225. data/lib/losant_rest/notebook.rb +0 -423
  226. data/lib/losant_rest/notebooks.rb +0 -138
  227. data/lib/losant_rest/org.rb +0 -663
  228. data/lib/losant_rest/org_invites.rb +0 -124
  229. data/lib/losant_rest/orgs.rb +0 -140
  230. data/lib/losant_rest/resource_job.rb +0 -326
  231. data/lib/losant_rest/resource_jobs.rb +0 -138
  232. data/lib/losant_rest/user_api_token.rb +0 -170
  233. data/lib/losant_rest/user_api_tokens.rb +0 -132
  234. data/lib/losant_rest/utils.rb +0 -44
  235. data/lib/losant_rest/webhook.rb +0 -178
  236. data/lib/losant_rest/webhooks.rb +0 -138
  237. data/lib/losant_rest.rb +0 -129
@@ -1,352 +0,0 @@
1
- # The MIT License (MIT)
2
- #
3
- # Copyright (c) 2023 Losant IoT, Inc.
4
- #
5
- # Permission is hereby granted, free of charge, to any person obtaining a copy
6
- # of this software and associated documentation files (the "Software"), to deal
7
- # in the Software without restriction, including without limitation the rights
8
- # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- # copies of the Software, and to permit persons to whom the Software is
10
- # furnished to do so, subject to the following conditions:
11
- #
12
- # The above copyright notice and this permission notice shall be included in all
13
- # copies or substantial portions of the Software.
14
- #
15
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- # SOFTWARE.
22
-
23
- require "json"
24
-
25
- module LosantRest
26
-
27
- # Class containing all the actions for the 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
@@ -1,201 +0,0 @@
1
- # The MIT License (MIT)
2
- #
3
- # Copyright (c) 2023 Losant IoT, Inc.
4
- #
5
- # Permission is hereby granted, free of charge, to any person obtaining a copy
6
- # of this software and associated documentation files (the "Software"), to deal
7
- # in the Software without restriction, including without limitation the rights
8
- # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- # copies of the Software, and to permit persons to whom the Software is
10
- # furnished to do so, subject to the following conditions:
11
- #
12
- # The above copyright notice and this permission notice shall be included in all
13
- # copies or substantial portions of the Software.
14
- #
15
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- # SOFTWARE.
22
-
23
- require "json"
24
-
25
- module LosantRest
26
-
27
- # Class containing all the actions for the 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