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,176 @@
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 Resource
28
+ class Data
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Creates a csv file from a query of devices and attributes over a time range.
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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.export.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {hash} query - The query parameters (https://api.losant.com/#/definitions/dataExport)
45
+ # * {string} losantdomain - Domain scope of request (rarely needed)
46
+ # * {boolean} _actions - Return resource actions in response
47
+ # * {boolean} _links - Return resource link in response
48
+ # * {boolean} _embedded - Return embedded resources in response
49
+ #
50
+ # Responses:
51
+ # * 202 - If command was successfully sent (https://api.losant.com/#/definitions/jobEnqueuedResult)
52
+ #
53
+ # Errors:
54
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
55
+ # * 404 - Error if application 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
+ raise ArgumentError.new("query is required") unless params.has_key?(:query)
64
+
65
+ body = params[:query] if params.has_key?(:query)
66
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
67
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
68
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
69
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
70
+
71
+ path = "/applications/#{params[:applicationId]}/data/export"
72
+
73
+ @client.request(
74
+ method: :post,
75
+ path: path,
76
+ query: query_params,
77
+ headers: headers,
78
+ body: body)
79
+ end
80
+
81
+ # Returns the last known data for the given attribute
82
+ #
83
+ # Authentication:
84
+ # The client must be configured with a valid api
85
+ # access token to call this action. The token
86
+ # must include at least one of the following scopes:
87
+ # all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.lastValueQuery.
88
+ #
89
+ # Parameters:
90
+ # * {string} applicationId - ID associated with the application
91
+ # * {hash} query - The query parameters (https://api.losant.com/#/definitions/lastValueQuery)
92
+ # * {string} losantdomain - Domain scope of request (rarely needed)
93
+ # * {boolean} _actions - Return resource actions in response
94
+ # * {boolean} _links - Return resource link in response
95
+ # * {boolean} _embedded - Return embedded resources in response
96
+ #
97
+ # Responses:
98
+ # * 200 - Last known data for the requested attribute (https://api.losant.com/#/definitions/lastValueData)
99
+ #
100
+ # Errors:
101
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
102
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
103
+ def last_value_query(params = {})
104
+ params = Utils.symbolize_hash_keys(params)
105
+ query_params = { _actions: false, _links: true, _embedded: true }
106
+ headers = {}
107
+ body = nil
108
+
109
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
110
+ raise ArgumentError.new("query is required") unless params.has_key?(:query)
111
+
112
+ body = params[:query] if params.has_key?(:query)
113
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
114
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
115
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
116
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
117
+
118
+ path = "/applications/#{params[:applicationId]}/data/last-value-query"
119
+
120
+ @client.request(
121
+ method: :post,
122
+ path: path,
123
+ query: query_params,
124
+ headers: headers,
125
+ body: body)
126
+ end
127
+
128
+ # Returns the data for the given query
129
+ #
130
+ # Authentication:
131
+ # The client must be configured with a valid api
132
+ # access token to call this action. The token
133
+ # must include at least one of the following scopes:
134
+ # all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.timeSeriesQuery.
135
+ #
136
+ # Parameters:
137
+ # * {string} applicationId - ID associated with the application
138
+ # * {hash} query - The query parameters (https://api.losant.com/#/definitions/timeSeriesQuery)
139
+ # * {string} losantdomain - Domain scope of request (rarely needed)
140
+ # * {boolean} _actions - Return resource actions in response
141
+ # * {boolean} _links - Return resource link in response
142
+ # * {boolean} _embedded - Return embedded resources in response
143
+ #
144
+ # Responses:
145
+ # * 200 - Data for requested time range (https://api.losant.com/#/definitions/timeSeriesData)
146
+ #
147
+ # Errors:
148
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
149
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
150
+ def time_series_query(params = {})
151
+ params = Utils.symbolize_hash_keys(params)
152
+ query_params = { _actions: false, _links: true, _embedded: true }
153
+ headers = {}
154
+ body = nil
155
+
156
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
157
+ raise ArgumentError.new("query is required") unless params.has_key?(:query)
158
+
159
+ body = params[:query] if params.has_key?(:query)
160
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
161
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
162
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
163
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
164
+
165
+ path = "/applications/#{params[:applicationId]}/data/time-series-query"
166
+
167
+ @client.request(
168
+ method: :post,
169
+ path: path,
170
+ query: query_params,
171
+ headers: headers,
172
+ body: body)
173
+ end
174
+
175
+ end
176
+ end
@@ -0,0 +1,274 @@
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 Resource
28
+ class DataTable
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Adds a new column to this 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, dataTable.*, or dataTable.addColumn.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} dataTableId - ID associated with the data table
45
+ # * {hash} dataTableColumn - Object containing the new column properties (https://api.losant.com/#/definitions/dataTableColumn)
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 - Updated data table information (https://api.losant.com/#/definitions/dataTable)
53
+ #
54
+ # Errors:
55
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
56
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
57
+ def add_column(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("applicationId is required") unless params.has_key?(:applicationId)
64
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
65
+ raise ArgumentError.new("dataTableColumn is required") unless params.has_key?(:dataTableColumn)
66
+
67
+ body = params[:dataTableColumn] if params.has_key?(:dataTableColumn)
68
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
69
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
70
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
71
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
72
+
73
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/column"
74
+
75
+ @client.request(
76
+ method: :post,
77
+ path: path,
78
+ query: query_params,
79
+ headers: headers,
80
+ body: body)
81
+ end
82
+
83
+ # Deletes a data table
84
+ #
85
+ # Authentication:
86
+ # The client must be configured with a valid api
87
+ # access token to call this action. The token
88
+ # must include at least one of the following scopes:
89
+ # all.Application, all.Organization, all.User, dataTable.*, or dataTable.delete.
90
+ #
91
+ # Parameters:
92
+ # * {string} applicationId - ID associated with the application
93
+ # * {string} dataTableId - ID associated with the data table
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 - If data table was successfully deleted (https://api.losant.com/#/definitions/success)
101
+ #
102
+ # Errors:
103
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
104
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
105
+ def delete(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("applicationId is required") unless params.has_key?(:applicationId)
112
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
113
+
114
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
115
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
116
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
117
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
118
+
119
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}"
120
+
121
+ @client.request(
122
+ method: :delete,
123
+ path: path,
124
+ query: query_params,
125
+ headers: headers,
126
+ body: body)
127
+ end
128
+
129
+ # Retrieves information on a data table
130
+ #
131
+ # Authentication:
132
+ # The client must be configured with a valid api
133
+ # access token to call this action. The token
134
+ # must include at least one of the following scopes:
135
+ # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTable.*, or dataTable.get.
136
+ #
137
+ # Parameters:
138
+ # * {string} applicationId - ID associated with the application
139
+ # * {string} dataTableId - ID associated with the data table
140
+ # * {string} losantdomain - Domain scope of request (rarely needed)
141
+ # * {boolean} _actions - Return resource actions in response
142
+ # * {boolean} _links - Return resource link in response
143
+ # * {boolean} _embedded - Return embedded resources in response
144
+ #
145
+ # Responses:
146
+ # * 200 - Data table information (https://api.losant.com/#/definitions/dataTable)
147
+ #
148
+ # Errors:
149
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
150
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
151
+ def get(params = {})
152
+ params = Utils.symbolize_hash_keys(params)
153
+ query_params = { _actions: false, _links: true, _embedded: true }
154
+ headers = {}
155
+ body = nil
156
+
157
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
158
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
159
+
160
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
161
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
162
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
163
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
164
+
165
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}"
166
+
167
+ @client.request(
168
+ method: :get,
169
+ path: path,
170
+ query: query_params,
171
+ headers: headers,
172
+ body: body)
173
+ end
174
+
175
+ # Updates information about a data table
176
+ #
177
+ # Authentication:
178
+ # The client must be configured with a valid api
179
+ # access token to call this action. The token
180
+ # must include at least one of the following scopes:
181
+ # all.Application, all.Organization, all.User, dataTable.*, or dataTable.patch.
182
+ #
183
+ # Parameters:
184
+ # * {string} applicationId - ID associated with the application
185
+ # * {string} dataTableId - ID associated with the data table
186
+ # * {hash} dataTable - Object containing updated properties of the data table (https://api.losant.com/#/definitions/dataTablePatch)
187
+ # * {string} losantdomain - Domain scope of request (rarely needed)
188
+ # * {boolean} _actions - Return resource actions in response
189
+ # * {boolean} _links - Return resource link in response
190
+ # * {boolean} _embedded - Return embedded resources in response
191
+ #
192
+ # Responses:
193
+ # * 200 - Updated data table information (https://api.losant.com/#/definitions/dataTable)
194
+ #
195
+ # Errors:
196
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
197
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
198
+ def patch(params = {})
199
+ params = Utils.symbolize_hash_keys(params)
200
+ query_params = { _actions: false, _links: true, _embedded: true }
201
+ headers = {}
202
+ body = nil
203
+
204
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
205
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
206
+ raise ArgumentError.new("dataTable is required") unless params.has_key?(:dataTable)
207
+
208
+ body = params[:dataTable] if params.has_key?(:dataTable)
209
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
210
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
211
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
212
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
213
+
214
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}"
215
+
216
+ @client.request(
217
+ method: :patch,
218
+ path: path,
219
+ query: query_params,
220
+ headers: headers,
221
+ body: body)
222
+ end
223
+
224
+ # Removes a column from this data table
225
+ #
226
+ # Authentication:
227
+ # The client must be configured with a valid api
228
+ # access token to call this action. The token
229
+ # must include at least one of the following scopes:
230
+ # all.Application, all.Organization, all.User, dataTable.*, or dataTable.removeColumn.
231
+ #
232
+ # Parameters:
233
+ # * {string} applicationId - ID associated with the application
234
+ # * {string} dataTableId - ID associated with the data table
235
+ # * {string} columnName - Name of the column to remove
236
+ # * {string} losantdomain - Domain scope of request (rarely needed)
237
+ # * {boolean} _actions - Return resource actions in response
238
+ # * {boolean} _links - Return resource link in response
239
+ # * {boolean} _embedded - Return embedded resources in response
240
+ #
241
+ # Responses:
242
+ # * 200 - Updated data table information (https://api.losant.com/#/definitions/dataTable)
243
+ #
244
+ # Errors:
245
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
246
+ # * 404 - Error if data table was not found (https://api.losant.com/#/definitions/error)
247
+ def remove_column(params = {})
248
+ params = Utils.symbolize_hash_keys(params)
249
+ query_params = { _actions: false, _links: true, _embedded: true }
250
+ headers = {}
251
+ body = nil
252
+
253
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
254
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
255
+ raise ArgumentError.new("columnName is required") unless params.has_key?(:columnName)
256
+
257
+ query_params[:columnName] = params[:columnName] if params.has_key?(:columnName)
258
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
259
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
260
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
261
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
262
+
263
+ path = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/column"
264
+
265
+ @client.request(
266
+ method: :delete,
267
+ path: path,
268
+ query: query_params,
269
+ headers: headers,
270
+ body: body)
271
+ end
272
+
273
+ end
274
+ 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 Data Table Row Resource
28
+ class DataTableRow
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Deletes a data table row
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, dataTableRow.*, or dataTableRow.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} dataTableId - ID associated with the data table
45
+ # * {string} rowId - ID associated with the data table row
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 data table row 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 data table row 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("applicationId is required") unless params.has_key?(:applicationId)
64
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
65
+ raise ArgumentError.new("rowId is required") unless params.has_key?(:rowId)
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 = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/rows/#{params[:rowId]}"
73
+
74
+ @client.request(
75
+ method: :delete,
76
+ path: path,
77
+ query: query_params,
78
+ headers: headers,
79
+ body: body)
80
+ end
81
+
82
+ # Retrieves the data table row
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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTableRow.*, or dataTableRow.get.
89
+ #
90
+ # Parameters:
91
+ # * {string} applicationId - ID associated with the application
92
+ # * {string} dataTableId - ID associated with the data table
93
+ # * {string} rowId - ID associated with the data table row
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 - Data table row information (https://api.losant.com/#/definitions/dataTableRow)
101
+ #
102
+ # Errors:
103
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
104
+ # * 404 - Error if data table row 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("applicationId is required") unless params.has_key?(:applicationId)
112
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
113
+ raise ArgumentError.new("rowId is required") unless params.has_key?(:rowId)
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 = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/rows/#{params[:rowId]}"
121
+
122
+ @client.request(
123
+ method: :get,
124
+ path: path,
125
+ query: query_params,
126
+ headers: headers,
127
+ body: body)
128
+ end
129
+
130
+ # Updates the data table row
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.Application, all.Organization, all.User, dataTableRow.*, or dataTableRow.patch.
137
+ #
138
+ # Parameters:
139
+ # * {string} applicationId - ID associated with the application
140
+ # * {string} dataTableId - ID associated with the data table
141
+ # * {string} rowId - ID associated with the data table row
142
+ # * {hash} dataTableRow - Object containing updated properties for the data table row (https://api.losant.com/#/definitions/dataTableRowInsertUpdate)
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
+ # * 200 - Updated data table row information (https://api.losant.com/#/definitions/dataTableRow)
150
+ #
151
+ # Errors:
152
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
153
+ # * 404 - Error if data table row was not found (https://api.losant.com/#/definitions/error)
154
+ def patch(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("applicationId is required") unless params.has_key?(:applicationId)
161
+ raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
162
+ raise ArgumentError.new("rowId is required") unless params.has_key?(:rowId)
163
+ raise ArgumentError.new("dataTableRow is required") unless params.has_key?(:dataTableRow)
164
+
165
+ body = params[:dataTableRow] if params.has_key?(:dataTableRow)
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 = "/applications/#{params[:applicationId]}/data-tables/#{params[:dataTableId]}/rows/#{params[:rowId]}"
172
+
173
+ @client.request(
174
+ method: :patch,
175
+ path: path,
176
+ query: query_params,
177
+ headers: headers,
178
+ body: body)
179
+ end
180
+
181
+ end
182
+ end