losant_rest 1.13.1 → 1.15.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +10817 -3660
  3. data/docs/application.md +1 -1
  4. data/docs/device.md +43 -0
  5. data/docs/devices.md +39 -0
  6. data/docs/edgeDeployment.md +49 -0
  7. data/docs/embeddedDeployment.md +49 -0
  8. data/docs/embeddedDeployments.md +215 -0
  9. data/docs/flow.md +3 -3
  10. data/docs/flows.md +2 -2
  11. data/docs/instance.md +4 -2
  12. data/docs/instanceOrg.md +2 -0
  13. data/docs/instanceOrgInvite.md +139 -0
  14. data/docs/instanceOrgInvites.md +96 -0
  15. data/docs/instanceOrgMembers.md +2 -2
  16. data/docs/instanceOrgs.md +1 -1
  17. data/docs/me.md +1 -1
  18. data/docs/org.md +1 -1
  19. data/lib/losant_rest/client.rb +22 -2
  20. data/lib/losant_rest/device.rb +50 -0
  21. data/lib/losant_rest/devices.rb +46 -0
  22. data/lib/losant_rest/edge_deployment.rb +81 -0
  23. data/lib/losant_rest/embedded_deployment.rb +81 -0
  24. data/lib/losant_rest/embedded_deployments.rb +280 -0
  25. data/lib/losant_rest/flow.rb +3 -3
  26. data/lib/losant_rest/flows.rb +2 -2
  27. data/lib/losant_rest/instance.rb +1 -0
  28. data/lib/losant_rest/instance_org.rb +4 -0
  29. data/lib/losant_rest/instance_org_invite.rb +182 -0
  30. data/lib/losant_rest/instance_org_invites.rb +138 -0
  31. data/lib/losant_rest/instance_org_members.rb +2 -2
  32. data/lib/losant_rest/instance_orgs.rb +2 -2
  33. data/lib/losant_rest/version.rb +1 -1
  34. data/lib/losant_rest.rb +5 -0
  35. data/schemas/apiTokenPost.json +19 -0
  36. data/schemas/application.json +32 -32
  37. data/schemas/applicationCreationByTemplateResult.json +32 -32
  38. data/schemas/applicationDashboardPost.json +8 -5
  39. data/schemas/applicationPatch.json +13 -13
  40. data/schemas/applicationPost.json +13 -13
  41. data/schemas/applicationTemplate.json +16 -16
  42. data/schemas/applicationTemplates.json +16 -16
  43. data/schemas/applications.json +32 -32
  44. data/schemas/authedDevice.json +2 -1
  45. data/schemas/dashboard.json +8 -5
  46. data/schemas/dashboardPatch.json +8 -5
  47. data/schemas/dashboardPost.json +8 -5
  48. data/schemas/dashboardSendReport.json +6 -6
  49. data/schemas/dashboards.json +8 -5
  50. data/schemas/dataTableRowsDelete.json +1 -1
  51. data/schemas/device.json +2 -1
  52. data/schemas/deviceClassFilter.json +4 -2
  53. data/schemas/devicePatch.json +2 -1
  54. data/schemas/devicePayloadCounts.json +24 -0
  55. data/schemas/devicePost.json +2 -1
  56. data/schemas/deviceRecipe.json +2 -1
  57. data/schemas/deviceRecipePatch.json +2 -1
  58. data/schemas/deviceRecipePost.json +2 -1
  59. data/schemas/deviceRecipes.json +2 -1
  60. data/schemas/devices.json +4 -2
  61. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  62. data/schemas/devicesPatch.json +4 -2
  63. data/schemas/edgeDeployment.json +20 -0
  64. data/schemas/edgeDeployments.json +20 -0
  65. data/schemas/embeddedDeployment.json +179 -0
  66. data/schemas/embeddedDeploymentExport.json +44 -0
  67. data/schemas/embeddedDeploymentRelease.json +58 -0
  68. data/schemas/embeddedDeploymentRemove.json +25 -0
  69. data/schemas/embeddedDeploymentReplace.json +29 -0
  70. data/schemas/embeddedDeployments.json +212 -0
  71. data/schemas/eventsDeleted.json +1 -1
  72. data/schemas/eventsExport.json +4 -0
  73. data/schemas/experienceEndpoint.json +6 -8
  74. data/schemas/experienceEndpointPatch.json +6 -8
  75. data/schemas/experienceEndpointPost.json +6 -8
  76. data/schemas/experienceEndpoints.json +6 -8
  77. data/schemas/experienceLinkedResources.json +790 -85
  78. data/schemas/flow.json +252 -16
  79. data/schemas/flowPatch.json +251 -16
  80. data/schemas/flowPost.json +252 -16
  81. data/schemas/flowVersion.json +503 -33
  82. data/schemas/flowVersionPost.json +251 -16
  83. data/schemas/flowVersions.json +503 -33
  84. data/schemas/flows.json +253 -16
  85. data/schemas/flowsImportPost.json +503 -32
  86. data/schemas/flowsImportResult.json +785 -79
  87. data/schemas/githubLogin.json +19 -0
  88. data/schemas/historicalSummary.json +147 -102
  89. data/schemas/instance.json +92 -79
  90. data/schemas/instanceMember.json +10 -0
  91. data/schemas/instanceMemberPost.json +18 -3
  92. data/schemas/instanceMembers.json +14 -0
  93. data/schemas/instanceOrg.json +87 -74
  94. data/schemas/instanceOrgMember.json +14 -0
  95. data/schemas/instanceOrgMembers.json +8 -0
  96. data/schemas/instanceOrgPatch.json +64 -26
  97. data/schemas/instanceOrgPost.json +65 -27
  98. data/schemas/instanceOrgs.json +91 -74
  99. data/schemas/instancePatch.json +2 -2
  100. data/schemas/me.json +134 -105
  101. data/schemas/notebook.json +32 -1
  102. data/schemas/notebookExecutionLogs.json +2 -1
  103. data/schemas/notebookPatch.json +32 -1
  104. data/schemas/notebookPost.json +32 -1
  105. data/schemas/notebooks.json +32 -1
  106. data/schemas/org.json +145 -110
  107. data/schemas/orgInvite.json +90 -0
  108. data/schemas/orgInviteCollection.json +130 -0
  109. data/schemas/orgInvites.json +82 -77
  110. data/schemas/orgRoleInfo.json +69 -0
  111. data/schemas/orgs.json +145 -110
  112. data/schemas/payloadStats.json +28 -12
  113. data/schemas/userCredentials.json +19 -0
  114. data/schemas/userPost.json +19 -0
  115. data/schemas/virtualButtonPress.json +4 -0
  116. metadata +27 -6
@@ -0,0 +1,280 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2021 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
@@ -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
@@ -331,7 +331,7 @@ module LosantRest
331
331
  # The client must be configured with a valid api
332
332
  # access token to call this action. The token
333
333
  # must include at least one of the following scopes:
334
- # all.Application, all.Organization, all.User, flow.*, or flow.getStorageEntriesMetadata.
334
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.getStorageEntriesMetadata.
335
335
  #
336
336
  # Parameters:
337
337
  # * {string} applicationId - ID associated with the application
@@ -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
@@ -47,7 +47,7 @@ module LosantRest
47
47
  # * {string} perPage - How many items to return per page
48
48
  # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
49
49
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
50
- # * {string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience
50
+ # * {string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience
51
51
  # * {hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (https://api.losant.com/#/definitions/flowTriggerFilter)
52
52
  # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
53
53
  # * {hash} query - Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. (https://api.losant.com/#/definitions/advancedFlowQuery)
@@ -114,7 +114,7 @@ module LosantRest
114
114
  # * {string} perPage - How many items to return per page
115
115
  # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
116
116
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
117
- # * {string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience
117
+ # * {string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience
118
118
  # * {string} version - Return the workflow versions for the given version.
119
119
  # * {hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (https://api.losant.com/#/definitions/flowTriggerFilter)
120
120
  # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
@@ -205,6 +205,7 @@ module LosantRest
205
205
  body = nil
206
206
 
207
207
  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
208
+ raise ArgumentError.new("instance is required") unless params.has_key?(:instance)
208
209
 
209
210
  body = params[:instance] if params.has_key?(:instance)
210
211
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
@@ -88,6 +88,7 @@ module LosantRest
88
88
  # Parameters:
89
89
  # * {string} instanceId - ID associated with the instance
90
90
  # * {string} orgId - ID associated with the organization
91
+ # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
91
92
  # * {string} losantdomain - Domain scope of request (rarely needed)
92
93
  # * {boolean} _actions - Return resource actions in response
93
94
  # * {boolean} _links - Return resource link in response
@@ -108,6 +109,7 @@ module LosantRest
108
109
  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
109
110
  raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
110
111
 
112
+ query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
111
113
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
112
114
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
113
115
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -134,6 +136,7 @@ module LosantRest
134
136
  # Parameters:
135
137
  # * {string} instanceId - ID associated with the instance
136
138
  # * {string} orgId - ID associated with the organization
139
+ # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
137
140
  # * {hash} organization - Object containing new organization properties (https://api.losant.com/#/definitions/instanceOrgPatch)
138
141
  # * {string} losantdomain - Domain scope of request (rarely needed)
139
142
  # * {boolean} _actions - Return resource actions in response
@@ -156,6 +159,7 @@ module LosantRest
156
159
  raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
157
160
  raise ArgumentError.new("organization is required") unless params.has_key?(:organization)
158
161
 
162
+ query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
159
163
  body = params[:organization] if params.has_key?(:organization)
160
164
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
161
165
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
@@ -0,0 +1,182 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2021 Losant IoT, Inc.
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
23
+ require "json"
24
+
25
+ module LosantRest
26
+
27
+ # Class containing all the actions for the Instance Org Invite Resource
28
+ class InstanceOrgInvite
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Revokes an instance org invitation
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} instanceId - ID associated with the instance
44
+ # * {string} orgId - ID associated with the organization
45
+ # * {string} inviteId - ID associated with the organization invite
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 an invite 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 instance, organization or invite 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("instanceId is required") unless params.has_key?(:instanceId)
64
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
65
+ raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)
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 = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites/#{params[:inviteId]}"
73
+
74
+ @client.request(
75
+ method: :delete,
76
+ path: path,
77
+ query: query_params,
78
+ headers: headers,
79
+ body: body)
80
+ end
81
+
82
+ # Returns an organization invite
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.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvite.*, or instanceOrgInvite.get.
89
+ #
90
+ # Parameters:
91
+ # * {string} instanceId - ID associated with the instance
92
+ # * {string} orgId - ID associated with the organization
93
+ # * {string} inviteId - ID associated with the organization invite
94
+ # * {string} losantdomain - Domain scope of request (rarely needed)
95
+ # * {boolean} _actions - Return resource actions in response
96
+ # * {boolean} _links - Return resource link in response
97
+ # * {boolean} _embedded - Return embedded resources in response
98
+ #
99
+ # Responses:
100
+ # * 200 - A single organization invite (https://api.losant.com/#/definitions/orgInvite)
101
+ #
102
+ # Errors:
103
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
104
+ # * 404 - Error if instance, organization, or invite was not found (https://api.losant.com/#/definitions/error)
105
+ def get(params = {})
106
+ params = Utils.symbolize_hash_keys(params)
107
+ query_params = { _actions: false, _links: true, _embedded: true }
108
+ headers = {}
109
+ body = nil
110
+
111
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
112
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
113
+ raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)
114
+
115
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
116
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
117
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
118
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
119
+
120
+ path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites/#{params[:inviteId]}"
121
+
122
+ @client.request(
123
+ method: :get,
124
+ path: path,
125
+ query: query_params,
126
+ headers: headers,
127
+ body: body)
128
+ end
129
+
130
+ # Resend an organization invite with modified role info
131
+ #
132
+ # Authentication:
133
+ # The client must be configured with a valid api
134
+ # access token to call this action. The token
135
+ # must include at least one of the following scopes:
136
+ # all.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.resendInvite.
137
+ #
138
+ # Parameters:
139
+ # * {string} instanceId - ID associated with the instance
140
+ # * {string} orgId - ID associated with the organization
141
+ # * {string} inviteId - ID associated with the organization invite
142
+ # * {hash} roleInfo - Object containing updated role info (https://api.losant.com/#/definitions/orgRoleInfo)
143
+ # * {string} losantdomain - Domain scope of request (rarely needed)
144
+ # * {boolean} _actions - Return resource actions in response
145
+ # * {boolean} _links - Return resource link in response
146
+ # * {boolean} _embedded - Return embedded resources in response
147
+ #
148
+ # Responses:
149
+ # * 201 - The new org invite (https://api.losant.com/#/definitions/orgInvite)
150
+ #
151
+ # Errors:
152
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
153
+ # * 404 - Error if instance, organization, or invite was not found (https://api.losant.com/#/definitions/error)
154
+ def resend_invite(params = {})
155
+ params = Utils.symbolize_hash_keys(params)
156
+ query_params = { _actions: false, _links: true, _embedded: true }
157
+ headers = {}
158
+ body = nil
159
+
160
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
161
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
162
+ raise ArgumentError.new("inviteId is required") unless params.has_key?(:inviteId)
163
+ raise ArgumentError.new("roleInfo is required") unless params.has_key?(:roleInfo)
164
+
165
+ body = params[:roleInfo] if params.has_key?(:roleInfo)
166
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
167
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
168
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
169
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
170
+
171
+ path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites/#{params[:inviteId]}"
172
+
173
+ @client.request(
174
+ method: :post,
175
+ path: path,
176
+ query: query_params,
177
+ headers: headers,
178
+ body: body)
179
+ end
180
+
181
+ end
182
+ end