losant_rest 1.14.0 → 1.15.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (171) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/docs/_schemas.md +10590 -3153
  4. data/docs/devices.md +40 -0
  5. data/docs/embeddedDeployment.md +49 -0
  6. data/docs/embeddedDeployments.md +215 -0
  7. data/docs/flow.md +2 -2
  8. data/docs/flows.md +2 -2
  9. data/docs/instance.md +4 -2
  10. data/lib/losant_rest/application.rb +1 -1
  11. data/lib/losant_rest/application_api_token.rb +1 -1
  12. data/lib/losant_rest/application_api_tokens.rb +1 -1
  13. data/lib/losant_rest/application_certificate.rb +1 -1
  14. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  15. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  16. data/lib/losant_rest/application_certificates.rb +1 -1
  17. data/lib/losant_rest/application_dashboard.rb +1 -1
  18. data/lib/losant_rest/application_dashboards.rb +1 -1
  19. data/lib/losant_rest/application_key.rb +1 -1
  20. data/lib/losant_rest/application_keys.rb +1 -1
  21. data/lib/losant_rest/application_template.rb +1 -1
  22. data/lib/losant_rest/application_templates.rb +1 -1
  23. data/lib/losant_rest/applications.rb +1 -1
  24. data/lib/losant_rest/audit_log.rb +1 -1
  25. data/lib/losant_rest/audit_logs.rb +1 -1
  26. data/lib/losant_rest/auth.rb +1 -1
  27. data/lib/losant_rest/client.rb +11 -3
  28. data/lib/losant_rest/dashboard.rb +1 -1
  29. data/lib/losant_rest/dashboards.rb +1 -1
  30. data/lib/losant_rest/data.rb +1 -1
  31. data/lib/losant_rest/data_table.rb +1 -1
  32. data/lib/losant_rest/data_table_row.rb +1 -1
  33. data/lib/losant_rest/data_table_rows.rb +1 -1
  34. data/lib/losant_rest/data_tables.rb +1 -1
  35. data/lib/losant_rest/device.rb +1 -1
  36. data/lib/losant_rest/device_recipe.rb +1 -1
  37. data/lib/losant_rest/device_recipes.rb +1 -1
  38. data/lib/losant_rest/devices.rb +50 -1
  39. data/lib/losant_rest/edge_deployment.rb +1 -1
  40. data/lib/losant_rest/edge_deployments.rb +1 -1
  41. data/lib/losant_rest/embedded_deployment.rb +81 -0
  42. data/lib/losant_rest/embedded_deployments.rb +280 -0
  43. data/lib/losant_rest/error.rb +1 -1
  44. data/lib/losant_rest/event.rb +1 -1
  45. data/lib/losant_rest/events.rb +1 -1
  46. data/lib/losant_rest/experience.rb +1 -1
  47. data/lib/losant_rest/experience_domain.rb +1 -1
  48. data/lib/losant_rest/experience_domains.rb +1 -1
  49. data/lib/losant_rest/experience_endpoint.rb +1 -1
  50. data/lib/losant_rest/experience_endpoints.rb +1 -1
  51. data/lib/losant_rest/experience_group.rb +1 -1
  52. data/lib/losant_rest/experience_groups.rb +1 -1
  53. data/lib/losant_rest/experience_slug.rb +1 -1
  54. data/lib/losant_rest/experience_slugs.rb +1 -1
  55. data/lib/losant_rest/experience_user.rb +1 -1
  56. data/lib/losant_rest/experience_users.rb +1 -1
  57. data/lib/losant_rest/experience_version.rb +1 -1
  58. data/lib/losant_rest/experience_versions.rb +1 -1
  59. data/lib/losant_rest/experience_view.rb +1 -1
  60. data/lib/losant_rest/experience_views.rb +1 -1
  61. data/lib/losant_rest/file.rb +1 -1
  62. data/lib/losant_rest/files.rb +1 -1
  63. data/lib/losant_rest/flow.rb +3 -3
  64. data/lib/losant_rest/flow_version.rb +1 -1
  65. data/lib/losant_rest/flow_versions.rb +1 -1
  66. data/lib/losant_rest/flows.rb +3 -3
  67. data/lib/losant_rest/instance.rb +2 -1
  68. data/lib/losant_rest/instance_api_token.rb +1 -1
  69. data/lib/losant_rest/instance_api_tokens.rb +1 -1
  70. data/lib/losant_rest/instance_member.rb +1 -1
  71. data/lib/losant_rest/instance_members.rb +1 -1
  72. data/lib/losant_rest/instance_org.rb +1 -1
  73. data/lib/losant_rest/instance_org_invite.rb +1 -1
  74. data/lib/losant_rest/instance_org_invites.rb +1 -1
  75. data/lib/losant_rest/instance_org_member.rb +1 -1
  76. data/lib/losant_rest/instance_org_members.rb +1 -1
  77. data/lib/losant_rest/instance_orgs.rb +1 -1
  78. data/lib/losant_rest/instances.rb +1 -1
  79. data/lib/losant_rest/integration.rb +1 -1
  80. data/lib/losant_rest/integrations.rb +1 -1
  81. data/lib/losant_rest/me.rb +1 -1
  82. data/lib/losant_rest/notebook.rb +1 -1
  83. data/lib/losant_rest/notebooks.rb +1 -1
  84. data/lib/losant_rest/org.rb +1 -1
  85. data/lib/losant_rest/org_invites.rb +1 -1
  86. data/lib/losant_rest/orgs.rb +1 -1
  87. data/lib/losant_rest/user_api_token.rb +1 -1
  88. data/lib/losant_rest/user_api_tokens.rb +1 -1
  89. data/lib/losant_rest/utils.rb +1 -1
  90. data/lib/losant_rest/version.rb +2 -2
  91. data/lib/losant_rest/webhook.rb +1 -1
  92. data/lib/losant_rest/webhooks.rb +1 -1
  93. data/lib/losant_rest.rb +3 -1
  94. data/schemas/apiTokenPost.json +9 -0
  95. data/schemas/application.json +32 -32
  96. data/schemas/applicationCreationByTemplateResult.json +32 -32
  97. data/schemas/applicationDashboardPost.json +8 -5
  98. data/schemas/applicationPatch.json +13 -13
  99. data/schemas/applicationPost.json +13 -13
  100. data/schemas/applicationTemplate.json +16 -16
  101. data/schemas/applicationTemplates.json +16 -16
  102. data/schemas/applications.json +32 -32
  103. data/schemas/authedDevice.json +2 -1
  104. data/schemas/dashboard.json +8 -5
  105. data/schemas/dashboardPatch.json +8 -5
  106. data/schemas/dashboardPost.json +8 -5
  107. data/schemas/dashboardSendReport.json +6 -6
  108. data/schemas/dashboards.json +8 -5
  109. data/schemas/dataTableRowsDelete.json +1 -1
  110. data/schemas/device.json +2 -1
  111. data/schemas/deviceClassFilter.json +4 -2
  112. data/schemas/deviceNamesResponse.json +36 -0
  113. data/schemas/devicePatch.json +2 -1
  114. data/schemas/devicePost.json +2 -1
  115. data/schemas/deviceRecipe.json +2 -1
  116. data/schemas/deviceRecipePatch.json +2 -1
  117. data/schemas/deviceRecipePost.json +2 -1
  118. data/schemas/deviceRecipes.json +2 -1
  119. data/schemas/devices.json +4 -2
  120. data/schemas/devicesPatch.json +4 -2
  121. data/schemas/edgeDeployment.json +4 -0
  122. data/schemas/edgeDeployments.json +4 -0
  123. data/schemas/embeddedDeployment.json +179 -0
  124. data/schemas/embeddedDeploymentExport.json +44 -0
  125. data/schemas/embeddedDeploymentRelease.json +58 -0
  126. data/schemas/embeddedDeploymentRemove.json +25 -0
  127. data/schemas/embeddedDeploymentReplace.json +29 -0
  128. data/schemas/embeddedDeployments.json +212 -0
  129. data/schemas/eventsDeleted.json +1 -1
  130. data/schemas/eventsExport.json +4 -0
  131. data/schemas/experienceEndpoint.json +6 -8
  132. data/schemas/experienceEndpointPatch.json +6 -8
  133. data/schemas/experienceEndpointPost.json +6 -8
  134. data/schemas/experienceEndpoints.json +6 -8
  135. data/schemas/experienceLinkedResources.json +1292 -167
  136. data/schemas/flow.json +391 -15
  137. data/schemas/flowPatch.json +390 -15
  138. data/schemas/flowPost.json +391 -15
  139. data/schemas/flowVersion.json +821 -71
  140. data/schemas/flowVersionPost.json +390 -15
  141. data/schemas/flowVersions.json +821 -71
  142. data/schemas/flows.json +392 -15
  143. data/schemas/flowsImportPost.json +821 -70
  144. data/schemas/flowsImportResult.json +1392 -266
  145. data/schemas/githubLogin.json +9 -0
  146. data/schemas/historicalSummary.json +87 -74
  147. data/schemas/instance.json +92 -79
  148. data/schemas/instanceMember.json +6 -1
  149. data/schemas/instanceMembers.json +6 -1
  150. data/schemas/instanceOrg.json +87 -74
  151. data/schemas/instanceOrgMember.json +6 -1
  152. data/schemas/instanceOrgPatch.json +64 -26
  153. data/schemas/instanceOrgPost.json +65 -27
  154. data/schemas/instanceOrgs.json +87 -74
  155. data/schemas/instancePatch.json +2 -2
  156. data/schemas/integration.json +1 -1
  157. data/schemas/integrationPatch.json +1 -1
  158. data/schemas/integrationPost.json +1 -1
  159. data/schemas/integrations.json +1 -1
  160. data/schemas/me.json +104 -92
  161. data/schemas/mePatch.json +0 -1
  162. data/schemas/notebook.json +2 -1
  163. data/schemas/notebookExecutionLogs.json +2 -1
  164. data/schemas/notebookPatch.json +2 -1
  165. data/schemas/notebookPost.json +2 -1
  166. data/schemas/notebooks.json +2 -1
  167. data/schemas/org.json +115 -97
  168. data/schemas/orgs.json +115 -97
  169. data/schemas/userCredentials.json +9 -0
  170. data/schemas/userPost.json +9 -1
  171. metadata +17 -6
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -130,6 +130,55 @@ module LosantRest
130
130
  body: body)
131
131
  end
132
132
 
133
+ # Gets the device names that match the given query. Maximum 1K returned.
134
+ #
135
+ # Authentication:
136
+ # The client must be configured with a valid api
137
+ # access token to call this action. The token
138
+ # must include at least one of the following scopes:
139
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.deviceNames.
140
+ #
141
+ # Parameters:
142
+ # * {string} applicationId - ID associated with the application
143
+ # * {hash} query - Device filter JSON object (https://api.losant.com/#/definitions/advancedDeviceQuery)
144
+ # * {string} startsWith - Filter devices down to those that have names starting with the given string. Case insensitive.
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 - The matching device names (https://api.losant.com/#/definitions/deviceNamesResponse)
152
+ #
153
+ # Errors:
154
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
155
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
156
+ def device_names(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("applicationId is required") unless params.has_key?(:applicationId)
163
+
164
+ query_params[:query] = params[:query] if params.has_key?(:query)
165
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
166
+ query_params[:startsWith] = params[:startsWith] if params.has_key?(:startsWith)
167
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
168
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
169
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
170
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
171
+
172
+ path = "/applications/#{params[:applicationId]}/devices/deviceNames"
173
+
174
+ @client.request(
175
+ method: :get,
176
+ path: path,
177
+ query: query_params,
178
+ headers: headers,
179
+ body: body)
180
+ end
181
+
133
182
  # Creates an export of all device metadata
134
183
  #
135
184
  # Authentication:
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -0,0 +1,81 @@
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 Embedded Deployment Resource
28
+ class EmbeddedDeployment
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Retrieves information on an embedded deployment
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, embeddedDeployment.*, or embeddedDeployment.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} embeddedDeploymentId - ID associated with the embedded deployment
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 - Embedded deployment information (https://api.losant.com/#/definitions/embeddedDeployment)
52
+ #
53
+ # Errors:
54
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
55
+ # * 404 - Error if embedded deployment was not found (https://api.losant.com/#/definitions/error)
56
+ def get(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("applicationId is required") unless params.has_key?(:applicationId)
63
+ raise ArgumentError.new("embeddedDeploymentId is required") unless params.has_key?(:embeddedDeploymentId)
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 = "/applications/#{params[:applicationId]}/embedded/deployments/#{params[:embeddedDeploymentId]}"
71
+
72
+ @client.request(
73
+ method: :get,
74
+ path: path,
75
+ query: query_params,
76
+ headers: headers,
77
+ body: body)
78
+ end
79
+
80
+ end
81
+ end
@@ -0,0 +1,280 @@
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 Embedded Deployments Resource
28
+ class EmbeddedDeployments
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Request an export of the compiled WASM files for a current deployment
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, embeddedDeployments.*, or embeddedDeployments.export.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {hash} options - Export options for embedded deployment (https://api.losant.com/#/definitions/embeddedDeploymentExport)
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 generation of export was successfully started (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 deployment was not found (https://api.losant.com/#/definitions/error)
56
+ def export(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("applicationId is required") unless params.has_key?(:applicationId)
63
+
64
+ body = params[:options] if params.has_key?(:options)
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 = "/applications/#{params[:applicationId]}/embedded/deployments/export"
71
+
72
+ @client.request(
73
+ method: :post,
74
+ path: path,
75
+ query: query_params,
76
+ headers: headers,
77
+ body: body)
78
+ end
79
+
80
+ # Returns the embedded deployments for an application
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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, embeddedDeployments.*, or embeddedDeployments.get.
87
+ #
88
+ # Parameters:
89
+ # * {string} applicationId - ID associated with the application
90
+ # * {string} sortField - Field to sort the results by. Accepted values are: id, creationDate, lastUpdated
91
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
92
+ # * {string} page - Which page of results to return
93
+ # * {string} perPage - How many items to return per page
94
+ # * {string} deviceId - Filter deployments to the given Device ID
95
+ # * {string} version - Filter deployments to the given Workflow Version (matches against both current and desired)
96
+ # * {string} flowId - Filter deployments to the given Workflow ID
97
+ # * {string} losantdomain - Domain scope of request (rarely needed)
98
+ # * {boolean} _actions - Return resource actions in response
99
+ # * {boolean} _links - Return resource link in response
100
+ # * {boolean} _embedded - Return embedded resources in response
101
+ #
102
+ # Responses:
103
+ # * 200 - Collection of embedded deployments (https://api.losant.com/#/definitions/embeddedDeployments)
104
+ #
105
+ # Errors:
106
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
107
+ # * 404 - Error if application or device was not found (https://api.losant.com/#/definitions/error)
108
+ def get(params = {})
109
+ params = Utils.symbolize_hash_keys(params)
110
+ query_params = { _actions: false, _links: true, _embedded: true }
111
+ headers = {}
112
+ body = nil
113
+
114
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
115
+
116
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
117
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
118
+ query_params[:page] = params[:page] if params.has_key?(:page)
119
+ query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
120
+ query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
121
+ query_params[:version] = params[:version] if params.has_key?(:version)
122
+ query_params[:flowId] = params[:flowId] if params.has_key?(:flowId)
123
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
124
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
125
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
126
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
127
+
128
+ path = "/applications/#{params[:applicationId]}/embedded/deployments"
129
+
130
+ @client.request(
131
+ method: :get,
132
+ path: path,
133
+ query: query_params,
134
+ headers: headers,
135
+ body: body)
136
+ end
137
+
138
+ # Deploy an embedded workflow version to one or more embedded devices. Version can be blank, if removal is desired.
139
+ #
140
+ # Authentication:
141
+ # The client must be configured with a valid api
142
+ # access token to call this action. The token
143
+ # must include at least one of the following scopes:
144
+ # all.Application, all.Organization, all.User, embeddedDeployments.*, or embeddedDeployments.release.
145
+ #
146
+ # Parameters:
147
+ # * {string} applicationId - ID associated with the application
148
+ # * {hash} deployment - Deployment release information (https://api.losant.com/#/definitions/embeddedDeploymentRelease)
149
+ # * {string} losantdomain - Domain scope of request (rarely needed)
150
+ # * {boolean} _actions - Return resource actions in response
151
+ # * {boolean} _links - Return resource link in response
152
+ # * {boolean} _embedded - Return embedded resources in response
153
+ #
154
+ # Responses:
155
+ # * 201 - If deployment release has been initiated successfully (https://api.losant.com/#/definitions/success)
156
+ #
157
+ # Errors:
158
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
159
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
160
+ def release(params = {})
161
+ params = Utils.symbolize_hash_keys(params)
162
+ query_params = { _actions: false, _links: true, _embedded: true }
163
+ headers = {}
164
+ body = nil
165
+
166
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
167
+ raise ArgumentError.new("deployment is required") unless params.has_key?(:deployment)
168
+
169
+ body = params[:deployment] if params.has_key?(:deployment)
170
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
171
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
172
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
173
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
174
+
175
+ path = "/applications/#{params[:applicationId]}/embedded/deployments/release"
176
+
177
+ @client.request(
178
+ method: :post,
179
+ path: path,
180
+ query: query_params,
181
+ headers: headers,
182
+ body: body)
183
+ end
184
+
185
+ # Remove all embedded deployments from a device, remove all embedded deployments of a workflow, or remove a specific workflow from a specific device
186
+ #
187
+ # Authentication:
188
+ # The client must be configured with a valid api
189
+ # access token to call this action. The token
190
+ # must include at least one of the following scopes:
191
+ # all.Application, all.Organization, all.User, embeddedDeployments.*, or embeddedDeployments.remove.
192
+ #
193
+ # Parameters:
194
+ # * {string} applicationId - ID associated with the application
195
+ # * {hash} deployment - Deployment removal information (https://api.losant.com/#/definitions/embeddedDeploymentRemove)
196
+ # * {string} losantdomain - Domain scope of request (rarely needed)
197
+ # * {boolean} _actions - Return resource actions in response
198
+ # * {boolean} _links - Return resource link in response
199
+ # * {boolean} _embedded - Return embedded resources in response
200
+ #
201
+ # Responses:
202
+ # * 201 - If deployment removal has been initiated successfully (https://api.losant.com/#/definitions/success)
203
+ #
204
+ # Errors:
205
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
206
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
207
+ def remove(params = {})
208
+ params = Utils.symbolize_hash_keys(params)
209
+ query_params = { _actions: false, _links: true, _embedded: true }
210
+ headers = {}
211
+ body = nil
212
+
213
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
214
+ raise ArgumentError.new("deployment is required") unless params.has_key?(:deployment)
215
+
216
+ body = params[:deployment] if params.has_key?(:deployment)
217
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
218
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
219
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
220
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
221
+
222
+ path = "/applications/#{params[:applicationId]}/embedded/deployments/remove"
223
+
224
+ @client.request(
225
+ method: :post,
226
+ path: path,
227
+ query: query_params,
228
+ headers: headers,
229
+ body: body)
230
+ end
231
+
232
+ # Replace deployments of an embedded workflow version with a new version. New version can be blank, if removal is desired.
233
+ #
234
+ # Authentication:
235
+ # The client must be configured with a valid api
236
+ # access token to call this action. The token
237
+ # must include at least one of the following scopes:
238
+ # all.Application, all.Organization, all.User, embeddedDeployments.*, or embeddedDeployments.replace.
239
+ #
240
+ # Parameters:
241
+ # * {string} applicationId - ID associated with the application
242
+ # * {hash} deployment - Deployment replacement information (https://api.losant.com/#/definitions/embeddedDeploymentReplace)
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
+ # * 201 - If deployment replacement has been initiated successfully (https://api.losant.com/#/definitions/success)
250
+ #
251
+ # Errors:
252
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
253
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
254
+ def replace(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("applicationId is required") unless params.has_key?(:applicationId)
261
+ raise ArgumentError.new("deployment is required") unless params.has_key?(:deployment)
262
+
263
+ body = params[:deployment] if params.has_key?(:deployment)
264
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
265
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
266
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
267
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
268
+
269
+ path = "/applications/#{params[:applicationId]}/embedded/deployments/replace"
270
+
271
+ @client.request(
272
+ method: :post,
273
+ path: path,
274
+ query: query_params,
275
+ headers: headers,
276
+ body: body)
277
+ end
278
+
279
+ end
280
+ end
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2021 Losant IoT, Inc.
3
+ # Copyright (c) 2022 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -139,7 +139,7 @@ module LosantRest
139
139
  # * {string} limit - Maximum number of errors to return
140
140
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
141
141
  # * {string} flowVersion - Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version.
142
- # * {string} deviceId - For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs.
142
+ # * {string} deviceId - For edge or embedded workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs.
143
143
  # * {string} losantdomain - Domain scope of request (rarely needed)
144
144
  # * {boolean} _actions - Return resource actions in response
145
145
  # * {boolean} _links - Return resource link in response
@@ -535,7 +535,7 @@ module LosantRest
535
535
  # * {string} end - End of time range in milliseconds since epoch
536
536
  # * {string} resolution - Resolution in milliseconds
537
537
  # * {string} flowVersion - Flow version name or ID. When not included, will be aggregate for all versions. Pass develop for just the develop version.
538
- # * {string} deviceId - For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs.
538
+ # * {string} deviceId - For edge or embedded workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs.
539
539
  # * {string} losantdomain - Domain scope of request (rarely needed)
540
540
  # * {boolean} _actions - Return resource actions in response
541
541
  # * {boolean} _links - Return resource link in response