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,336 @@
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 Instance Org Resource
28
+ class InstanceOrg
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Deletes an organization
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, instanceOrg.*, or instanceOrg.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} instanceId - ID associated with the instance
44
+ # * {string} orgId - ID associated with the organization
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 organization was successfully deleted (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 organization was not found (https://api.losant.com/#/definitions/error)
56
+ def delete(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("instanceId is required") unless params.has_key?(:instanceId)
63
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
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 = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}"
71
+
72
+ @client.request(
73
+ method: :delete,
74
+ path: path,
75
+ query: query_params,
76
+ headers: headers,
77
+ body: body)
78
+ end
79
+
80
+ # Returns device counts by day for the time range specified for this organization
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.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.deviceCounts.
87
+ #
88
+ # Parameters:
89
+ # * {string} instanceId - ID associated with the instance
90
+ # * {string} orgId - ID associated with the organization
91
+ # * {string} start - Start of range for device count query (ms since epoch)
92
+ # * {string} end - End of range for device count query (ms since epoch)
93
+ # * {string} losantdomain - Domain scope of request (rarely needed)
94
+ # * {boolean} _actions - Return resource actions in response
95
+ # * {boolean} _links - Return resource link in response
96
+ # * {boolean} _embedded - Return embedded resources in response
97
+ #
98
+ # Responses:
99
+ # * 200 - Device counts by day (https://api.losant.com/#/definitions/deviceCounts)
100
+ #
101
+ # Errors:
102
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
103
+ # * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
104
+ def device_counts(params = {})
105
+ params = Utils.symbolize_hash_keys(params)
106
+ query_params = { _actions: false, _links: true, _embedded: true }
107
+ headers = {}
108
+ body = nil
109
+
110
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
111
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
112
+
113
+ query_params[:start] = params[:start] if params.has_key?(:start)
114
+ query_params[:end] = params[:end] if params.has_key?(:end)
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]}/deviceCounts"
121
+
122
+ @client.request(
123
+ method: :get,
124
+ path: path,
125
+ query: query_params,
126
+ headers: headers,
127
+ body: body)
128
+ end
129
+
130
+ # Retrieves information on an organization
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.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.get.
137
+ #
138
+ # Parameters:
139
+ # * {string} instanceId - ID associated with the instance
140
+ # * {string} orgId - ID associated with the organization
141
+ # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
142
+ # * {string} losantdomain - Domain scope of request (rarely needed)
143
+ # * {boolean} _actions - Return resource actions in response
144
+ # * {boolean} _links - Return resource link in response
145
+ # * {boolean} _embedded - Return embedded resources in response
146
+ #
147
+ # Responses:
148
+ # * 200 - A single organization (https://api.losant.com/#/definitions/instanceOrg)
149
+ #
150
+ # Errors:
151
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
152
+ # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
153
+ def get(params = {})
154
+ params = Utils.symbolize_hash_keys(params)
155
+ query_params = { _actions: false, _links: true, _embedded: true }
156
+ headers = {}
157
+ body = nil
158
+
159
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
160
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
161
+
162
+ query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
163
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
164
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
165
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
166
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
167
+
168
+ path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}"
169
+
170
+ @client.request(
171
+ method: :get,
172
+ path: path,
173
+ query: query_params,
174
+ headers: headers,
175
+ body: body)
176
+ end
177
+
178
+ # Returns notebook execution usage by day for the time range specified for this organization
179
+ #
180
+ # Authentication:
181
+ # The client must be configured with a valid api
182
+ # access token to call this action. The token
183
+ # must include at least one of the following scopes:
184
+ # all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.notebookMinuteCounts.
185
+ #
186
+ # Parameters:
187
+ # * {string} instanceId - ID associated with the instance
188
+ # * {string} orgId - ID associated with the organization
189
+ # * {string} start - Start of range for notebook execution query (ms since epoch)
190
+ # * {string} end - End of range for notebook execution query (ms since epoch)
191
+ # * {string} losantdomain - Domain scope of request (rarely needed)
192
+ # * {boolean} _actions - Return resource actions in response
193
+ # * {boolean} _links - Return resource link in response
194
+ # * {boolean} _embedded - Return embedded resources in response
195
+ #
196
+ # Responses:
197
+ # * 200 - Notebook usage information (https://api.losant.com/#/definitions/notebookMinuteCounts)
198
+ #
199
+ # Errors:
200
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
201
+ # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
202
+ def notebook_minute_counts(params = {})
203
+ params = Utils.symbolize_hash_keys(params)
204
+ query_params = { _actions: false, _links: true, _embedded: true }
205
+ headers = {}
206
+ body = nil
207
+
208
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
209
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
210
+
211
+ query_params[:start] = params[:start] if params.has_key?(:start)
212
+ query_params[:end] = params[:end] if params.has_key?(:end)
213
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
214
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
215
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
216
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
217
+
218
+ path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/notebookMinuteCounts"
219
+
220
+ @client.request(
221
+ method: :get,
222
+ path: path,
223
+ query: query_params,
224
+ headers: headers,
225
+ body: body)
226
+ end
227
+
228
+ # Updates information about an organization
229
+ #
230
+ # Authentication:
231
+ # The client must be configured with a valid api
232
+ # access token to call this action. The token
233
+ # must include at least one of the following scopes:
234
+ # all.Instance, all.User, instanceOrg.*, or instanceOrg.patch.
235
+ #
236
+ # Parameters:
237
+ # * {string} instanceId - ID associated with the instance
238
+ # * {string} orgId - ID associated with the organization
239
+ # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
240
+ # * {hash} organization - Object containing new organization properties (https://api.losant.com/#/definitions/instanceOrgPatch)
241
+ # * {string} losantdomain - Domain scope of request (rarely needed)
242
+ # * {boolean} _actions - Return resource actions in response
243
+ # * {boolean} _links - Return resource link in response
244
+ # * {boolean} _embedded - Return embedded resources in response
245
+ #
246
+ # Responses:
247
+ # * 200 - Updated organization information (https://api.losant.com/#/definitions/instanceOrg)
248
+ #
249
+ # Errors:
250
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
251
+ # * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
252
+ def patch(params = {})
253
+ params = Utils.symbolize_hash_keys(params)
254
+ query_params = { _actions: false, _links: true, _embedded: true }
255
+ headers = {}
256
+ body = nil
257
+
258
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
259
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
260
+ raise ArgumentError.new("organization is required") unless params.has_key?(:organization)
261
+
262
+ query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
263
+ body = params[:organization] if params.has_key?(:organization)
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 = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}"
270
+
271
+ @client.request(
272
+ method: :patch,
273
+ path: path,
274
+ query: query_params,
275
+ headers: headers,
276
+ body: body)
277
+ end
278
+
279
+ # Returns payload counts per resolution in the time range specified for all application this organization owns
280
+ #
281
+ # Authentication:
282
+ # The client must be configured with a valid api
283
+ # access token to call this action. The token
284
+ # must include at least one of the following scopes:
285
+ # all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.payloadCountsBreakdown.
286
+ #
287
+ # Parameters:
288
+ # * {string} instanceId - ID associated with the instance
289
+ # * {string} orgId - ID associated with the organization
290
+ # * {string} start - Start of range for payload count query (ms since epoch)
291
+ # * {string} end - End of range for payload count query (ms since epoch)
292
+ # * {string} resolution - Resolution in milliseconds. Accepted values are: 86400000, 3600000
293
+ # * {string} asBytes - If the resulting stats should be returned as bytes
294
+ # * {string} includeNonBillable - If non-billable payloads should be included in the result
295
+ # * {string} losantdomain - Domain scope of request (rarely needed)
296
+ # * {boolean} _actions - Return resource actions in response
297
+ # * {boolean} _links - Return resource link in response
298
+ # * {boolean} _embedded - Return embedded resources in response
299
+ #
300
+ # Responses:
301
+ # * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadCountsBreakdown)
302
+ #
303
+ # Errors:
304
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
305
+ # * 404 - Error if instance was not found (https://api.losant.com/#/definitions/error)
306
+ def payload_counts_breakdown(params = {})
307
+ params = Utils.symbolize_hash_keys(params)
308
+ query_params = { _actions: false, _links: true, _embedded: true }
309
+ headers = {}
310
+ body = nil
311
+
312
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
313
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
314
+
315
+ query_params[:start] = params[:start] if params.has_key?(:start)
316
+ query_params[:end] = params[:end] if params.has_key?(:end)
317
+ query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
318
+ query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
319
+ query_params[:includeNonBillable] = params[:includeNonBillable] if params.has_key?(:includeNonBillable)
320
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
321
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
322
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
323
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
324
+
325
+ path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/payloadCountsBreakdown"
326
+
327
+ @client.request(
328
+ method: :get,
329
+ path: path,
330
+ query: query_params,
331
+ headers: headers,
332
+ body: body)
333
+ end
334
+
335
+ end
336
+ end
@@ -0,0 +1,182 @@
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 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
@@ -0,0 +1,138 @@
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 Instance Org Invites Resource
28
+ class InstanceOrgInvites
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Returns a collection of instance organization invites
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.Instance.read, all.User, all.User.read, instanceOrgInvites.*, or instanceOrgInvites.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} instanceId - ID associated with the instance
44
+ # * {string} orgId - ID associated with the organization
45
+ # * {string} sortField - Field to sort the results by. Accepted values are: email, role, inviteDate
46
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
47
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role
48
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
49
+ # * {string} losantdomain - Domain scope of request (rarely needed)
50
+ # * {boolean} _actions - Return resource actions in response
51
+ # * {boolean} _links - Return resource link in response
52
+ # * {boolean} _embedded - Return embedded resources in response
53
+ #
54
+ # Responses:
55
+ # * 200 - A collection of instance organization invitations (https://api.losant.com/#/definitions/orgInviteCollection)
56
+ #
57
+ # Errors:
58
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
59
+ # * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
60
+ def get(params = {})
61
+ params = Utils.symbolize_hash_keys(params)
62
+ query_params = { _actions: false, _links: true, _embedded: true }
63
+ headers = {}
64
+ body = nil
65
+
66
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
67
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
68
+
69
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
70
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
71
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
72
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
73
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
74
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
75
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
76
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
77
+
78
+ path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites"
79
+
80
+ @client.request(
81
+ method: :get,
82
+ path: path,
83
+ query: query_params,
84
+ headers: headers,
85
+ body: body)
86
+ end
87
+
88
+ # Invites a member to an instance organization
89
+ #
90
+ # Authentication:
91
+ # The client must be configured with a valid api
92
+ # access token to call this action. The token
93
+ # must include at least one of the following scopes:
94
+ # all.Instance, all.User, instanceOrgInvites.*, or instanceOrgInvites.post.
95
+ #
96
+ # Parameters:
97
+ # * {string} instanceId - ID associated with the instance
98
+ # * {string} orgId - ID associated with the organization
99
+ # * {hash} invite - Object containing new invite info (https://api.losant.com/#/definitions/orgInvitePost)
100
+ # * {string} losantdomain - Domain scope of request (rarely needed)
101
+ # * {boolean} _actions - Return resource actions in response
102
+ # * {boolean} _links - Return resource link in response
103
+ # * {boolean} _embedded - Return embedded resources in response
104
+ #
105
+ # Responses:
106
+ # * 201 - The new organization invite (https://api.losant.com/#/definitions/orgInviteCollection)
107
+ #
108
+ # Errors:
109
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
110
+ # * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
111
+ def post(params = {})
112
+ params = Utils.symbolize_hash_keys(params)
113
+ query_params = { _actions: false, _links: true, _embedded: true }
114
+ headers = {}
115
+ body = nil
116
+
117
+ raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
118
+ raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
119
+ raise ArgumentError.new("invite is required") unless params.has_key?(:invite)
120
+
121
+ body = params[:invite] if params.has_key?(:invite)
122
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
123
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
124
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
125
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
126
+
127
+ path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/invites"
128
+
129
+ @client.request(
130
+ method: :post,
131
+ path: path,
132
+ query: query_params,
133
+ headers: headers,
134
+ body: body)
135
+ end
136
+
137
+ end
138
+ end