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,81 @@
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 Edge Deployment Resource
28
+ class EdgeDeployment
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Retrieves information on an edge 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, edgeDeployment.*, or edgeDeployment.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} edgeDeploymentId - ID associated with the edge 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 - Edge deployment information (https://api.losant.com/#/definitions/edgeDeployment)
52
+ #
53
+ # Errors:
54
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
55
+ # * 404 - Error if edge 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("edgeDeploymentId is required") unless params.has_key?(:edgeDeploymentId)
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]}/edge/deployments/#{params[:edgeDeploymentId]}"
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,236 @@
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 Edge Deployments Resource
28
+ class EdgeDeployments
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Returns the edge deployments for an application
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, edgeDeployments.*, or edgeDeployments.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} sortField - Field to sort the results by. Accepted values are: id, deviceId, flowId, desiredVersion, currentVersion, creationDate, lastUpdated
45
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
46
+ # * {string} page - Which page of results to return
47
+ # * {string} perPage - How many items to return per page
48
+ # * {string} deviceId - Filter deployments to the given Device ID
49
+ # * {string} version - Filter deployments to the given Workflow Version (matches against both current and desired)
50
+ # * {undefined} filterEmpty - Filter out deployments where both the current and desired version are null.
51
+ # * {string} flowId - Filter deployments to the given Workflow ID
52
+ # * {string} losantdomain - Domain scope of request (rarely needed)
53
+ # * {boolean} _actions - Return resource actions in response
54
+ # * {boolean} _links - Return resource link in response
55
+ # * {boolean} _embedded - Return embedded resources in response
56
+ #
57
+ # Responses:
58
+ # * 200 - Collection of edge deployments (https://api.losant.com/#/definitions/edgeDeployments)
59
+ #
60
+ # Errors:
61
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
62
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
63
+ def get(params = {})
64
+ params = Utils.symbolize_hash_keys(params)
65
+ query_params = { _actions: false, _links: true, _embedded: true }
66
+ headers = {}
67
+ body = nil
68
+
69
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
70
+
71
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
72
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
73
+ query_params[:page] = params[:page] if params.has_key?(:page)
74
+ query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
75
+ query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
76
+ query_params[:version] = params[:version] if params.has_key?(:version)
77
+ query_params[:filterEmpty] = params[:filterEmpty] if params.has_key?(:filterEmpty)
78
+ query_params[:flowId] = params[:flowId] if params.has_key?(:flowId)
79
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
80
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
81
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
82
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
83
+
84
+ path = "/applications/#{params[:applicationId]}/edge/deployments"
85
+
86
+ @client.request(
87
+ method: :get,
88
+ path: path,
89
+ query: query_params,
90
+ headers: headers,
91
+ body: body)
92
+ end
93
+
94
+ # Deploy an edge workflow version to one or more edge devices. Version can be blank, if removal is desired.
95
+ #
96
+ # Authentication:
97
+ # The client must be configured with a valid api
98
+ # access token to call this action. The token
99
+ # must include at least one of the following scopes:
100
+ # all.Application, all.Organization, all.User, edgeDeployments.*, or edgeDeployments.release.
101
+ #
102
+ # Parameters:
103
+ # * {string} applicationId - ID associated with the application
104
+ # * {hash} deployment - Deployment release information (https://api.losant.com/#/definitions/edgeDeploymentRelease)
105
+ # * {string} losantdomain - Domain scope of request (rarely needed)
106
+ # * {boolean} _actions - Return resource actions in response
107
+ # * {boolean} _links - Return resource link in response
108
+ # * {boolean} _embedded - Return embedded resources in response
109
+ #
110
+ # Responses:
111
+ # * 201 - If deployment release has been initiated successfully (https://api.losant.com/#/definitions/success)
112
+ #
113
+ # Errors:
114
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
115
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
116
+ def release(params = {})
117
+ params = Utils.symbolize_hash_keys(params)
118
+ query_params = { _actions: false, _links: true, _embedded: true }
119
+ headers = {}
120
+ body = nil
121
+
122
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
123
+ raise ArgumentError.new("deployment is required") unless params.has_key?(:deployment)
124
+
125
+ body = params[:deployment] if params.has_key?(:deployment)
126
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
127
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
128
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
129
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
130
+
131
+ path = "/applications/#{params[:applicationId]}/edge/deployments/release"
132
+
133
+ @client.request(
134
+ method: :post,
135
+ path: path,
136
+ query: query_params,
137
+ headers: headers,
138
+ body: body)
139
+ end
140
+
141
+ # Remove all edge deployments from a device, remove all edge deployments of a workflow, or remove a specific workflow from a specific device
142
+ #
143
+ # Authentication:
144
+ # The client must be configured with a valid api
145
+ # access token to call this action. The token
146
+ # must include at least one of the following scopes:
147
+ # all.Application, all.Organization, all.User, edgeDeployments.*, or edgeDeployments.remove.
148
+ #
149
+ # Parameters:
150
+ # * {string} applicationId - ID associated with the application
151
+ # * {hash} deployment - Deployment removal information (https://api.losant.com/#/definitions/edgeDeploymentRemove)
152
+ # * {string} losantdomain - Domain scope of request (rarely needed)
153
+ # * {boolean} _actions - Return resource actions in response
154
+ # * {boolean} _links - Return resource link in response
155
+ # * {boolean} _embedded - Return embedded resources in response
156
+ #
157
+ # Responses:
158
+ # * 201 - If deployment removal has been initiated successfully (https://api.losant.com/#/definitions/success)
159
+ #
160
+ # Errors:
161
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
162
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
163
+ def remove(params = {})
164
+ params = Utils.symbolize_hash_keys(params)
165
+ query_params = { _actions: false, _links: true, _embedded: true }
166
+ headers = {}
167
+ body = nil
168
+
169
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
170
+ raise ArgumentError.new("deployment is required") unless params.has_key?(:deployment)
171
+
172
+ body = params[:deployment] if params.has_key?(:deployment)
173
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
174
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
175
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
176
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
177
+
178
+ path = "/applications/#{params[:applicationId]}/edge/deployments/remove"
179
+
180
+ @client.request(
181
+ method: :post,
182
+ path: path,
183
+ query: query_params,
184
+ headers: headers,
185
+ body: body)
186
+ end
187
+
188
+ # Replace deployments of an edge workflow version with a new version. New version can be blank, if removal is desired.
189
+ #
190
+ # Authentication:
191
+ # The client must be configured with a valid api
192
+ # access token to call this action. The token
193
+ # must include at least one of the following scopes:
194
+ # all.Application, all.Organization, all.User, edgeDeployments.*, or edgeDeployments.replace.
195
+ #
196
+ # Parameters:
197
+ # * {string} applicationId - ID associated with the application
198
+ # * {hash} deployment - Deployment replacement information (https://api.losant.com/#/definitions/edgeDeploymentReplace)
199
+ # * {string} losantdomain - Domain scope of request (rarely needed)
200
+ # * {boolean} _actions - Return resource actions in response
201
+ # * {boolean} _links - Return resource link in response
202
+ # * {boolean} _embedded - Return embedded resources in response
203
+ #
204
+ # Responses:
205
+ # * 201 - If deployment replacement has been initiated successfully (https://api.losant.com/#/definitions/success)
206
+ #
207
+ # Errors:
208
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
209
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
210
+ def replace(params = {})
211
+ params = Utils.symbolize_hash_keys(params)
212
+ query_params = { _actions: false, _links: true, _embedded: true }
213
+ headers = {}
214
+ body = nil
215
+
216
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
217
+ raise ArgumentError.new("deployment is required") unless params.has_key?(:deployment)
218
+
219
+ body = params[:deployment] if params.has_key?(:deployment)
220
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
221
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
222
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
223
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
224
+
225
+ path = "/applications/#{params[:applicationId]}/edge/deployments/replace"
226
+
227
+ @client.request(
228
+ method: :post,
229
+ path: path,
230
+ query: query_params,
231
+ headers: headers,
232
+ body: body)
233
+ end
234
+
235
+ end
236
+ end
@@ -0,0 +1,81 @@
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 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) 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 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
+ # * 202 - If generation of export was successfully started (https://api.losant.com/#/definitions/jobEnqueuedResult)
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