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,343 @@
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 Data Table Rows Resource
28
+ class DataTableRows
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Delete rows from a data table
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.Application, all.Organization, all.User, dataTableRows.*, or dataTableRows.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} dataTableId - ID associated with the data table
45
+ # * {hash} query - Query to apply to filter the data table (https://api.losant.com/#/definitions/advancedQuery)
46
+ # * {string} limit - Limit number of rows to delete from data table
47
+ # * {string} losantdomain - Domain scope of request (rarely needed)
48
+ # * {boolean} _actions - Return resource actions in response
49
+ # * {boolean} _links - Return resource link in response
50
+ # * {boolean} _embedded - Return embedded resources in response
51
+ #
52
+ # Responses:
53
+ # * 200 - If request successfully deletes a set of Data Table rows (https://api.losant.com/#/definitions/dataTableRowsDelete)
54
+ #
55
+ # Errors:
56
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
57
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
58
+ def delete(params = {})
59
+ params = Utils.symbolize_hash_keys(params)
60
+ query_params = { _actions: false, _links: true, _embedded: true }
61
+ headers = {}
62
+ body = nil
63
+
64
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
65
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
66
+
67
+ body = params[:query] if params.has_key?(:query)
68
+ query_params[:limit] = params[:limit] if params.has_key?(:limit)
69
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
70
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
71
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
72
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
73
+
74
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/rows/delete"
75
+
76
+ @client.request(
77
+ method: :post,
78
+ path: path,
79
+ query: query_params,
80
+ headers: headers,
81
+ body: body)
82
+ end
83
+
84
+ # Request an export of the data table's data
85
+ #
86
+ # Authentication:
87
+ # The client must be configured with a valid api
88
+ # access token to call this action. The token
89
+ # must include at least one of the following scopes:
90
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTableRows.*, or dataTableRows.export.
91
+ #
92
+ # Parameters:
93
+ # * {string} applicationId - ID associated with the application
94
+ # * {string} dataTableId - ID associated with the data table
95
+ # * {hash} exportData - Object containing export specifications (https://api.losant.com/#/definitions/dataTableRowsExport)
96
+ # * {string} losantdomain - Domain scope of request (rarely needed)
97
+ # * {boolean} _actions - Return resource actions in response
98
+ # * {boolean} _links - Return resource link in response
99
+ # * {boolean} _embedded - Return embedded resources in response
100
+ #
101
+ # Responses:
102
+ # * 202 - If request was successfully queued (https://api.losant.com/#/definitions/jobEnqueuedResult)
103
+ #
104
+ # Errors:
105
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
106
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
107
+ def export(params = {})
108
+ params = Utils.symbolize_hash_keys(params)
109
+ query_params = { _actions: false, _links: true, _embedded: true }
110
+ headers = {}
111
+ body = nil
112
+
113
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
114
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
115
+ raise ArgumentError.new("exportData is required") unless params.has_key?(:exportData)
116
+
117
+ body = params[:exportData] if params.has_key?(:exportData)
118
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
119
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
120
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
121
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
122
+
123
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/rows/export"
124
+
125
+ @client.request(
126
+ method: :post,
127
+ path: path,
128
+ query: query_params,
129
+ headers: headers,
130
+ body: body)
131
+ end
132
+
133
+ # Returns the rows for a data table
134
+ #
135
+ # Authentication:
136
+ # The client must be configured with a valid api
137
+ # access token to call this action. The token
138
+ # must include at least one of the following scopes:
139
+ # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTableRows.*, or dataTableRows.get.
140
+ #
141
+ # Parameters:
142
+ # * {string} applicationId - ID associated with the application
143
+ # * {string} dataTableId - ID associated with the data table
144
+ # * {string} sortColumn - Column to sort the rows by
145
+ # * {string} sortDirection - Direction to sort the rows by. Accepted values are: asc, desc
146
+ # * {string} limit - How many rows to return
147
+ # * {string} offset - How many rows to skip
148
+ # * {string} includeFields - Comma-separated list of fields to include in resulting rows. When not provided, returns all fields.
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
+ # * 200 - Collection of data table rows (https://api.losant.com/#/definitions/dataTableRows)
156
+ #
157
+ # Errors:
158
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
159
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
160
+ def get(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("dataTableId is required") unless params.has_key?(:dataTableId)
168
+
169
+ query_params[:sortColumn] = params[:sortColumn] if params.has_key?(:sortColumn)
170
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
171
+ query_params[:limit] = params[:limit] if params.has_key?(:limit)
172
+ query_params[:offset] = params[:offset] if params.has_key?(:offset)
173
+ query_params[:includeFields] = params[:includeFields] if params.has_key?(:includeFields)
174
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
175
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
176
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
177
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
178
+
179
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/rows"
180
+
181
+ @client.request(
182
+ method: :get,
183
+ path: path,
184
+ query: query_params,
185
+ headers: headers,
186
+ body: body)
187
+ end
188
+
189
+ # Inserts a new row(s) into a data table
190
+ #
191
+ # Authentication:
192
+ # The client must be configured with a valid api
193
+ # access token to call this action. The token
194
+ # must include at least one of the following scopes:
195
+ # all.Application, all.Organization, all.User, dataTableRows.*, or dataTableRows.post.
196
+ #
197
+ # Parameters:
198
+ # * {string} applicationId - ID associated with the application
199
+ # * {string} dataTableId - ID associated with the data table
200
+ # * {hash} dataTableRow - The row(s) to insert (https://api.losant.com/#/definitions/dataTableRowInsert)
201
+ # * {string} losantdomain - Domain scope of request (rarely needed)
202
+ # * {boolean} _actions - Return resource actions in response
203
+ # * {boolean} _links - Return resource link in response
204
+ # * {boolean} _embedded - Return embedded resources in response
205
+ #
206
+ # Responses:
207
+ # * 201 - Successfully created data table row, or bulk insert count (https://api.losant.com/#/definitions/dataTableRowInsertResult)
208
+ #
209
+ # Errors:
210
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
211
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
212
+ def post(params = {})
213
+ params = Utils.symbolize_hash_keys(params)
214
+ query_params = { _actions: false, _links: true, _embedded: true }
215
+ headers = {}
216
+ body = nil
217
+
218
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
219
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
220
+ raise ArgumentError.new("dataTableRow is required") unless params.has_key?(:dataTableRow)
221
+
222
+ body = params[:dataTableRow] if params.has_key?(:dataTableRow)
223
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
224
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
225
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
226
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
227
+
228
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/rows"
229
+
230
+ @client.request(
231
+ method: :post,
232
+ path: path,
233
+ query: query_params,
234
+ headers: headers,
235
+ body: body)
236
+ end
237
+
238
+ # Queries for rows from a data table
239
+ #
240
+ # Authentication:
241
+ # The client must be configured with a valid api
242
+ # access token to call this action. The token
243
+ # must include at least one of the following scopes:
244
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTableRows.*, or dataTableRows.query.
245
+ #
246
+ # Parameters:
247
+ # * {string} applicationId - ID associated with the application
248
+ # * {string} dataTableId - ID associated with the data table
249
+ # * {string} sortColumn - Column to sort the rows by
250
+ # * {string} sortDirection - Direction to sort the rows by. Accepted values are: asc, desc
251
+ # * {string} limit - How many rows to return
252
+ # * {string} offset - How many rows to skip
253
+ # * {string} includeFields - Comma-separated list of fields to include in resulting rows. When not provided, returns all fields.
254
+ # * {hash} query - Query to apply to filter the data table (https://api.losant.com/#/definitions/advancedQuery)
255
+ # * {string} losantdomain - Domain scope of request (rarely needed)
256
+ # * {boolean} _actions - Return resource actions in response
257
+ # * {boolean} _links - Return resource link in response
258
+ # * {boolean} _embedded - Return embedded resources in response
259
+ #
260
+ # Responses:
261
+ # * 200 - Collection of data table rows (https://api.losant.com/#/definitions/dataTableRows)
262
+ #
263
+ # Errors:
264
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
265
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
266
+ def query(params = {})
267
+ params = Utils.symbolize_hash_keys(params)
268
+ query_params = { _actions: false, _links: true, _embedded: true }
269
+ headers = {}
270
+ body = nil
271
+
272
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
273
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
274
+
275
+ query_params[:sortColumn] = params[:sortColumn] if params.has_key?(:sortColumn)
276
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
277
+ query_params[:limit] = params[:limit] if params.has_key?(:limit)
278
+ query_params[:offset] = params[:offset] if params.has_key?(:offset)
279
+ query_params[:includeFields] = params[:includeFields] if params.has_key?(:includeFields)
280
+ body = params[:query] if params.has_key?(:query)
281
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
282
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
283
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
284
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
285
+
286
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/rows/query"
287
+
288
+ @client.request(
289
+ method: :post,
290
+ path: path,
291
+ query: query_params,
292
+ headers: headers,
293
+ body: body)
294
+ end
295
+
296
+ # Delete all data in the data table
297
+ #
298
+ # Authentication:
299
+ # The client must be configured with a valid api
300
+ # access token to call this action. The token
301
+ # must include at least one of the following scopes:
302
+ # all.Application, all.Organization, all.User, dataTableRows.*, or dataTableRows.truncate.
303
+ #
304
+ # Parameters:
305
+ # * {string} applicationId - ID associated with the application
306
+ # * {string} dataTableId - ID associated with the data table
307
+ # * {string} losantdomain - Domain scope of request (rarely needed)
308
+ # * {boolean} _actions - Return resource actions in response
309
+ # * {boolean} _links - Return resource link in response
310
+ # * {boolean} _embedded - Return embedded resources in response
311
+ #
312
+ # Responses:
313
+ # * 200 - If request successfully deleted **all** rows in the data table, this will **not** send workflow data table deletion triggers (https://api.losant.com/#/definitions/success)
314
+ #
315
+ # Errors:
316
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
317
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
318
+ def truncate(params = {})
319
+ params = Utils.symbolize_hash_keys(params)
320
+ query_params = { _actions: false, _links: true, _embedded: true }
321
+ headers = {}
322
+ body = nil
323
+
324
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
325
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
326
+
327
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
328
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
329
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
330
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
331
+
332
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/rows/truncate"
333
+
334
+ @client.request(
335
+ method: :post,
336
+ path: path,
337
+ query: query_params,
338
+ headers: headers,
339
+ body: body)
340
+ end
341
+
342
+ end
343
+ 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 Data Tables Resource
28
+ class DataTables
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Returns the data tables 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.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTables.*, or dataTables.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, id, 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} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
49
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
50
+ # * {string} losantdomain - Domain scope of request (rarely needed)
51
+ # * {boolean} _actions - Return resource actions in response
52
+ # * {boolean} _links - Return resource link in response
53
+ # * {boolean} _embedded - Return embedded resources in response
54
+ #
55
+ # Responses:
56
+ # * 200 - Collection of data tables (https://api.losant.com/#/definitions/dataTables)
57
+ #
58
+ # Errors:
59
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
60
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
61
+ def get(params = {})
62
+ params = Utils.symbolize_hash_keys(params)
63
+ query_params = { _actions: false, _links: true, _embedded: true }
64
+ headers = {}
65
+ body = nil
66
+
67
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
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[:page] = params[:page] if params.has_key?(:page)
72
+ query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
73
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
74
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
75
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
76
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
77
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
78
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
79
+
80
+ path = "/applications/#{params[:applicationId]}/data-tables"
81
+
82
+ @client.request(
83
+ method: :get,
84
+ path: path,
85
+ query: query_params,
86
+ headers: headers,
87
+ body: body)
88
+ end
89
+
90
+ # Create a new data table for an application
91
+ #
92
+ # Authentication:
93
+ # The client must be configured with a valid api
94
+ # access token to call this action. The token
95
+ # must include at least one of the following scopes:
96
+ # all.Application, all.Organization, all.User, dataTables.*, or dataTables.post.
97
+ #
98
+ # Parameters:
99
+ # * {string} applicationId - ID associated with the application
100
+ # * {hash} dataTable - New data table information (https://api.losant.com/#/definitions/dataTablePost)
101
+ # * {string} losantdomain - Domain scope of request (rarely needed)
102
+ # * {boolean} _actions - Return resource actions in response
103
+ # * {boolean} _links - Return resource link in response
104
+ # * {boolean} _embedded - Return embedded resources in response
105
+ #
106
+ # Responses:
107
+ # * 201 - Successfully created data table (https://api.losant.com/#/definitions/dataTable)
108
+ #
109
+ # Errors:
110
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
111
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
112
+ def post(params = {})
113
+ params = Utils.symbolize_hash_keys(params)
114
+ query_params = { _actions: false, _links: true, _embedded: true }
115
+ headers = {}
116
+ body = nil
117
+
118
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
119
+ raise ArgumentError.new("dataTable is required") unless params.has_key?(:dataTable)
120
+
121
+ body = params[:dataTable] if params.has_key?(:dataTable)
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 = "/applications/#{params[:applicationId]}/data-tables"
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