losant_rest 1.7.1 → 1.7.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (19) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +713 -12
  3. data/docs/device.md +1 -0
  4. data/docs/devices.md +1 -0
  5. data/lib/losant_rest/client.rb +2 -2
  6. data/lib/losant_rest/device.rb +2 -0
  7. data/lib/losant_rest/devices.rb +2 -0
  8. data/lib/losant_rest/version.rb +1 -1
  9. data/schemas/applicationApiTokenPost.json +13 -0
  10. data/schemas/changePassword.json +4 -0
  11. data/schemas/dashboard.json +28 -3
  12. data/schemas/dashboardPatch.json +28 -3
  13. data/schemas/dashboardPost.json +28 -3
  14. data/schemas/dashboards.json +28 -3
  15. data/schemas/deviceCredentials.json +30 -0
  16. data/schemas/githubLogin.json +275 -0
  17. data/schemas/solutionUserCredentials.json +4 -0
  18. data/schemas/userCredentials.json +275 -0
  19. metadata +3 -3
data/docs/device.md CHANGED
@@ -126,6 +126,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
126
126
  | ---- | ---- | -------- | ----------- | ------- | ------- |
127
127
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
128
128
  | deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
129
+ | excludeConnectionInfo | string | N | If set, do not return connection info | | true |
129
130
 
130
131
  #### Successful Responses
131
132
 
data/docs/devices.md CHANGED
@@ -79,6 +79,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
79
79
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * device |
80
80
  | deviceClass | string | N | Filter the devices by the given device class. Accepted values are: standalone, gateway, peripheral, floating, edgeCompute | | standalone |
81
81
  | tagFilter | [Device Tag Filter](_schemas.md#device-tag-filter) | N | Array of tag pairs to filter by. | | [Device Tag Filter Example](_schemas.md#device-tag-filter-example) |
82
+ | excludeConnectionInfo | string | N | If set, do not return connection info | | true |
82
83
 
83
84
  #### Successful Responses
84
85
 
data/lib/losant_rest/client.rb CHANGED
@@ -27,7 +27,7 @@ module LosantRest
27
27
  #
28
28
  # User API for accessing Losant data
29
29
  #
30
- # Built For Version 1.12.1
30
+ # Built For Version 1.12.2
31
31
  class Client
32
32
  attr_accessor :auth_token, :url
33
33
 
@@ -250,7 +250,7 @@ module LosantRest
250
250
 
251
251
  headers["Accept"] = "application/json"
252
252
  headers["Content-Type"] = "application/json"
253
- headers["Accept-Version"] = "^1.12.1"
253
+ headers["Accept-Version"] = "^1.12.2"
254
254
  headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
255
255
  path = self.url + options.fetch(:path, "")
256
256
 
data/lib/losant_rest/device.rb CHANGED
@@ -140,6 +140,7 @@ module LosantRest
140
140
  # Parameters:
141
141
  # * {string} applicationId - ID associated with the application
142
142
  # * {string} deviceId - ID associated with the device
143
+ # * {string} excludeConnectionInfo - If set, do not return connection info
143
144
  # * {string} losantdomain - Domain scope of request (rarely needed)
144
145
  # * {boolean} _actions - Return resource actions in response
145
146
  # * {boolean} _links - Return resource link in response
@@ -160,6 +161,7 @@ module LosantRest
160
161
  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
161
162
  raise ArgumentError.new("deviceId is required") unless params.has_key?(:deviceId)
162
163
 
164
+ query_params[:excludeConnectionInfo] = params[:excludeConnectionInfo] if params.has_key?(:excludeConnectionInfo)
163
165
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
164
166
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
165
167
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
data/lib/losant_rest/devices.rb CHANGED
@@ -95,6 +95,7 @@ module LosantRest
95
95
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
96
96
  # * {string} deviceClass - Filter the devices by the given device class. Accepted values are: standalone, gateway, peripheral, floating, edgeCompute
97
97
  # * {hash} tagFilter - Array of tag pairs to filter by. (https://api.losant.com/#/definitions/deviceTagFilter)
98
+ # * {string} excludeConnectionInfo - If set, do not return connection info
98
99
  # * {string} losantdomain - Domain scope of request (rarely needed)
99
100
  # * {boolean} _actions - Return resource actions in response
100
101
  # * {boolean} _links - Return resource link in response
@@ -122,6 +123,7 @@ module LosantRest
122
123
  query_params[:filter] = params[:filter] if params.has_key?(:filter)
123
124
  query_params[:deviceClass] = params[:deviceClass] if params.has_key?(:deviceClass)
124
125
  query_params[:tagFilter] = params[:tagFilter] if params.has_key?(:tagFilter)
126
+ query_params[:excludeConnectionInfo] = params[:excludeConnectionInfo] if params.has_key?(:excludeConnectionInfo)
125
127
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
126
128
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
127
129
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
data/lib/losant_rest/version.rb CHANGED
@@ -21,5 +21,5 @@
21
21
  # SOFTWARE.
22
22
 
23
23
  module LosantRest
24
- VERSION = "1.7.1"
24
+ VERSION = "1.7.2"
25
25
  end
data/schemas/applicationApiTokenPost.json CHANGED
@@ -17,6 +17,7 @@
17
17
  },
18
18
  "scope": {
19
19
  "type": "array",
20
+ "uniqueItems": true,
20
21
  "items": {
21
22
  "type": "string",
22
23
  "enum": [
@@ -32,6 +33,8 @@
32
33
  "data.*",
33
34
  "dataTable.*",
34
35
  "dataTables.*",
36
+ "dataTableRow.*",
37
+ "dataTableRows.*",
35
38
  "device.*",
36
39
  "deviceRecipe.*",
37
40
  "deviceRecipes.*",
@@ -62,6 +65,7 @@
62
65
  "webhooks.*",
63
66
  "application.archiveData",
64
67
  "application.backfillArchiveData",
68
+ "application.debug",
65
69
  "application.delete",
66
70
  "application.get",
67
71
  "application.patch",
@@ -95,6 +99,7 @@
95
99
  "dataTables.get",
96
100
  "dataTables.post",
97
101
  "device.commandStream",
102
+ "device.debug",
98
103
  "device.delete",
99
104
  "device.export",
100
105
  "device.get",
@@ -114,6 +119,7 @@
114
119
  "deviceRecipe.patch",
115
120
  "deviceRecipes.get",
116
121
  "deviceRecipes.post",
122
+ "devices.detailedSummary",
117
123
  "devices.export",
118
124
  "devices.get",
119
125
  "devices.post",
@@ -144,16 +150,21 @@
144
150
  "experienceGroup.delete",
145
151
  "experienceGroup.get",
146
152
  "experienceGroup.patch",
153
+ "experienceGroups.detailedSummary",
147
154
  "experienceGroups.get",
148
155
  "experienceGroups.post",
149
156
  "experienceUser.delete",
150
157
  "experienceUser.get",
151
158
  "experienceUser.patch",
159
+ "experienceUsers.detailedSummary",
152
160
  "experienceUsers.get",
153
161
  "experienceUsers.post",
162
+ "experienceView.debug",
154
163
  "experienceView.delete",
155
164
  "experienceView.get",
156
165
  "experienceView.patch",
166
+ "experienceViews.debug",
167
+ "experienceViews.detailedSummary",
157
168
  "experienceViews.get",
158
169
  "experienceViews.post",
159
170
  "file.get",
@@ -162,6 +173,7 @@
162
173
  "file.delete",
163
174
  "files.get",
164
175
  "files.post",
176
+ "flow.debug",
165
177
  "flow.delete",
166
178
  "flow.clearStorageEntries",
167
179
  "flow.get",
@@ -171,6 +183,7 @@
171
183
  "flow.pressVirtualButton",
172
184
  "flow.setStorageEntry",
173
185
  "flows.get",
186
+ "flows.import",
174
187
  "flows.post",
175
188
  "flowVersion.delete",
176
189
  "flowVersion.get",
data/schemas/changePassword.json CHANGED
@@ -19,6 +19,10 @@
19
19
  },
20
20
  "invalidateExistingTokens": {
21
21
  "type": "boolean"
22
+ },
23
+ "tokenTTL": {
24
+ "type": "integer",
25
+ "minimum": 0
22
26
  }
23
27
  },
24
28
  "required": [
data/schemas/dashboard.json CHANGED
@@ -72,7 +72,8 @@
72
72
  "max": 14
73
73
  },
74
74
  "cron": {
75
- "type": "string"
75
+ "type": "string",
76
+ "max": 255
76
77
  },
77
78
  "toEmail": {
78
79
  "type": "array",
@@ -112,10 +113,34 @@
112
113
  "type": "object",
113
114
  "properties": {
114
115
  "id": {
115
- "type": "string"
116
+ "type": "string",
117
+ "maxLength": 255
116
118
  },
117
119
  "blockType": {
118
- "type": "string"
120
+ "type": "string",
121
+ "enum": [
122
+ "application-list",
123
+ "bar",
124
+ "custom-chart",
125
+ "dashboard-list",
126
+ "data-table",
127
+ "device-list",
128
+ "device-log",
129
+ "device-state-table",
130
+ "event-list",
131
+ "gauge",
132
+ "graph",
133
+ "heatmap",
134
+ "iframe",
135
+ "indicator",
136
+ "input",
137
+ "map",
138
+ "open-event-indicator",
139
+ "pie",
140
+ "position-chart",
141
+ "section-header",
142
+ "workflow-list"
143
+ ]
119
144
  },
120
145
  "title": {
121
146
  "type": "string",
data/schemas/dashboardPatch.json CHANGED
@@ -13,10 +13,34 @@
13
13
  "type": "object",
14
14
  "properties": {
15
15
  "id": {
16
- "type": "string"
16
+ "type": "string",
17
+ "maxLength": 255
17
18
  },
18
19
  "blockType": {
19
- "type": "string"
20
+ "type": "string",
21
+ "enum": [
22
+ "application-list",
23
+ "bar",
24
+ "custom-chart",
25
+ "dashboard-list",
26
+ "data-table",
27
+ "device-list",
28
+ "device-log",
29
+ "device-state-table",
30
+ "event-list",
31
+ "gauge",
32
+ "graph",
33
+ "heatmap",
34
+ "iframe",
35
+ "indicator",
36
+ "input",
37
+ "map",
38
+ "open-event-indicator",
39
+ "pie",
40
+ "position-chart",
41
+ "section-header",
42
+ "workflow-list"
43
+ ]
20
44
  },
21
45
  "title": {
22
46
  "type": "string",
@@ -72,7 +96,8 @@
72
96
  "max": 14
73
97
  },
74
98
  "cron": {
75
- "type": "string"
99
+ "type": "string",
100
+ "max": 255
76
101
  },
77
102
  "toEmail": {
78
103
  "type": "array",
data/schemas/dashboardPost.json CHANGED
@@ -17,10 +17,34 @@
17
17
  "type": "object",
18
18
  "properties": {
19
19
  "id": {
20
- "type": "string"
20
+ "type": "string",
21
+ "maxLength": 255
21
22
  },
22
23
  "blockType": {
23
- "type": "string"
24
+ "type": "string",
25
+ "enum": [
26
+ "application-list",
27
+ "bar",
28
+ "custom-chart",
29
+ "dashboard-list",
30
+ "data-table",
31
+ "device-list",
32
+ "device-log",
33
+ "device-state-table",
34
+ "event-list",
35
+ "gauge",
36
+ "graph",
37
+ "heatmap",
38
+ "iframe",
39
+ "indicator",
40
+ "input",
41
+ "map",
42
+ "open-event-indicator",
43
+ "pie",
44
+ "position-chart",
45
+ "section-header",
46
+ "workflow-list"
47
+ ]
24
48
  },
25
49
  "title": {
26
50
  "type": "string",
@@ -92,7 +116,8 @@
92
116
  "max": 14
93
117
  },
94
118
  "cron": {
95
- "type": "string"
119
+ "type": "string",
120
+ "max": 255
96
121
  },
97
122
  "toEmail": {
98
123
  "type": "array",
data/schemas/dashboards.json CHANGED
@@ -79,7 +79,8 @@
79
79
  "max": 14
80
80
  },
81
81
  "cron": {
82
- "type": "string"
82
+ "type": "string",
83
+ "max": 255
83
84
  },
84
85
  "toEmail": {
85
86
  "type": "array",
@@ -119,10 +120,34 @@
119
120
  "type": "object",
120
121
  "properties": {
121
122
  "id": {
122
- "type": "string"
123
+ "type": "string",
124
+ "maxLength": 255
123
125
  },
124
126
  "blockType": {
125
- "type": "string"
127
+ "type": "string",
128
+ "enum": [
129
+ "application-list",
130
+ "bar",
131
+ "custom-chart",
132
+ "dashboard-list",
133
+ "data-table",
134
+ "device-list",
135
+ "device-log",
136
+ "device-state-table",
137
+ "event-list",
138
+ "gauge",
139
+ "graph",
140
+ "heatmap",
141
+ "iframe",
142
+ "indicator",
143
+ "input",
144
+ "map",
145
+ "open-event-indicator",
146
+ "pie",
147
+ "position-chart",
148
+ "section-header",
149
+ "workflow-list"
150
+ ]
126
151
  },
127
152
  "title": {
128
153
  "type": "string",
data/schemas/deviceCredentials.json CHANGED
@@ -11,6 +11,36 @@
11
11
  },
12
12
  "secret": {
13
13
  "type": "string"
14
+ },
15
+ "tokenTTL": {
16
+ "type": "integer",
17
+ "minimum": 0
18
+ },
19
+ "requestedScopes": {
20
+ "type": "array",
21
+ "uniqueItems": true,
22
+ "items": {
23
+ "type": "string",
24
+ "enum": [
25
+ "all.Device",
26
+ "all.Device.read",
27
+ "data.timeSeriesQuery",
28
+ "data.lastValueQuery",
29
+ "device.commandStream",
30
+ "device.get",
31
+ "device.getCompositeState",
32
+ "device.getState",
33
+ "device.stateStream",
34
+ "device.getLogEntries",
35
+ "device.getCommand",
36
+ "device.debug",
37
+ "device.sendState",
38
+ "device.sendCommand",
39
+ "device.setConnectionStatus",
40
+ "devices.get",
41
+ "devices.sendCommand"
42
+ ]
43
+ }
14
44
  }
15
45
  },
16
46
  "required": [
data/schemas/githubLogin.json CHANGED
@@ -5,6 +5,281 @@
5
5
  "accessToken": {
6
6
  "type": "string",
7
7
  "minLength": 1
8
+ },
9
+ "requestedScopes": {
10
+ "type": "array",
11
+ "uniqueItems": true,
12
+ "items": {
13
+ "oneOf": [
14
+ {
15
+ "oneOf": [
16
+ {
17
+ "type": "string",
18
+ "enum": [
19
+ "all.Application",
20
+ "all.Application.read",
21
+ "all.Device",
22
+ "all.Device.read",
23
+ "application.*",
24
+ "applicationApiToken.*",
25
+ "applicationApiTokens.*",
26
+ "applicationKey.*",
27
+ "applicationKeys.*",
28
+ "data.*",
29
+ "dataTable.*",
30
+ "dataTables.*",
31
+ "dataTableRow.*",
32
+ "dataTableRows.*",
33
+ "device.*",
34
+ "deviceRecipe.*",
35
+ "deviceRecipes.*",
36
+ "devices.*",
37
+ "edgeDeployments.*",
38
+ "event.*",
39
+ "events.*",
40
+ "experience.*",
41
+ "experienceDomain.*",
42
+ "experienceDomains.*",
43
+ "experienceEndpoint.*",
44
+ "experienceEndpoints.*",
45
+ "experienceGroup.*",
46
+ "experienceGroups.*",
47
+ "experienceUser.*",
48
+ "experienceUsers.*",
49
+ "experienceView.*",
50
+ "experienceViews.*",
51
+ "integration.*",
52
+ "integrations.*",
53
+ "file.*",
54
+ "files.*",
55
+ "flow.*",
56
+ "flows.*",
57
+ "flowVersion.*",
58
+ "flowVersions.*",
59
+ "webhook.*",
60
+ "webhooks.*",
61
+ "application.archiveData",
62
+ "application.backfillArchiveData",
63
+ "application.debug",
64
+ "application.delete",
65
+ "application.get",
66
+ "application.patch",
67
+ "application.payloadCounts",
68
+ "applicationApiToken.delete",
69
+ "applicationApiToken.get",
70
+ "applicationApiToken.patch",
71
+ "applicationApiTokens.get",
72
+ "applicationApiTokens.post",
73
+ "applicationKey.delete",
74
+ "applicationKey.get",
75
+ "applicationKey.patch",
76
+ "applicationKeys.get",
77
+ "applicationKeys.post",
78
+ "data.lastValueQuery",
79
+ "data.timeSeriesQuery",
80
+ "dataTable.addColumn",
81
+ "dataTable.delete",
82
+ "dataTable.get",
83
+ "dataTable.patch",
84
+ "dataTable.removeColumn",
85
+ "dataTableRow.delete",
86
+ "dataTableRow.get",
87
+ "dataTableRow.patch",
88
+ "dataTableRows.get",
89
+ "dataTableRows.post",
90
+ "dataTableRows.query",
91
+ "dataTableRows.export",
92
+ "dataTableRows.delete",
93
+ "dataTableRows.truncate",
94
+ "dataTables.get",
95
+ "dataTables.post",
96
+ "device.commandStream",
97
+ "device.debug",
98
+ "device.delete",
99
+ "device.export",
100
+ "device.get",
101
+ "device.getCommand",
102
+ "device.getCompositeState",
103
+ "device.getLogEntries",
104
+ "device.getState",
105
+ "device.patch",
106
+ "device.removeData",
107
+ "device.sendCommand",
108
+ "device.sendState",
109
+ "device.setConnectionStatus",
110
+ "device.stateStream",
111
+ "deviceRecipe.bulkCreate",
112
+ "deviceRecipe.delete",
113
+ "deviceRecipe.get",
114
+ "deviceRecipe.patch",
115
+ "deviceRecipes.get",
116
+ "deviceRecipes.post",
117
+ "devices.detailedSummary",
118
+ "devices.export",
119
+ "devices.get",
120
+ "devices.post",
121
+ "devices.sendCommand",
122
+ "edgeDeployments.get",
123
+ "edgeDeployments.release",
124
+ "edgeDeployments.remove",
125
+ "edgeDeployments.replace",
126
+ "event.delete",
127
+ "event.get",
128
+ "event.patch",
129
+ "events.get",
130
+ "events.mostRecentBySeverity",
131
+ "events.patch",
132
+ "events.post",
133
+ "experience.delete",
134
+ "experienceDomain.delete",
135
+ "experienceDomain.get",
136
+ "experienceDomain.patch",
137
+ "experienceDomains.get",
138
+ "experienceDomains.post",
139
+ "experienceEndpoint.delete",
140
+ "experienceEndpoint.get",
141
+ "experienceEndpoint.patch",
142
+ "experienceEndpoints.get",
143
+ "experienceEndpoints.post",
144
+ "experienceEndpoints.stats",
145
+ "experienceGroup.delete",
146
+ "experienceGroup.get",
147
+ "experienceGroup.patch",
148
+ "experienceGroups.detailedSummary",
149
+ "experienceGroups.get",
150
+ "experienceGroups.post",
151
+ "experienceUser.delete",
152
+ "experienceUser.get",
153
+ "experienceUser.patch",
154
+ "experienceUsers.detailedSummary",
155
+ "experienceUsers.get",
156
+ "experienceUsers.post",
157
+ "experienceView.debug",
158
+ "experienceView.delete",
159
+ "experienceView.get",
160
+ "experienceView.patch",
161
+ "experienceViews.debug",
162
+ "experienceViews.detailedSummary",
163
+ "experienceViews.get",
164
+ "experienceViews.post",
165
+ "file.get",
166
+ "file.patch",
167
+ "file.move",
168
+ "file.delete",
169
+ "files.get",
170
+ "files.post",
171
+ "flow.debug",
172
+ "flow.delete",
173
+ "flow.clearStorageEntries",
174
+ "flow.get",
175
+ "flow.getStorageEntries",
176
+ "flow.log",
177
+ "flow.patch",
178
+ "flow.pressVirtualButton",
179
+ "flow.setStorageEntry",
180
+ "flows.get",
181
+ "flows.import",
182
+ "flows.post",
183
+ "flowVersion.delete",
184
+ "flowVersion.get",
185
+ "flowVersion.log",
186
+ "flowVersion.patch",
187
+ "flowVersions.get",
188
+ "flowVersions.post",
189
+ "integration.delete",
190
+ "integration.get",
191
+ "integration.patch",
192
+ "integrations.get",
193
+ "integrations.post",
194
+ "webhook.delete",
195
+ "webhook.get",
196
+ "webhook.patch",
197
+ "webhooks.get",
198
+ "webhooks.post"
199
+ ]
200
+ },
201
+ {
202
+ "type": "string",
203
+ "enum": [
204
+ "all.Organization",
205
+ "all.Organization.read",
206
+ "applications.*",
207
+ "auditLog.*",
208
+ "auditLogs.*",
209
+ "dashboard.*",
210
+ "dashboards.*",
211
+ "org.*",
212
+ "solution.*",
213
+ "solutions.*",
214
+ "solutionUser.*",
215
+ "solutionUsers.*",
216
+ "applications.get",
217
+ "applications.post",
218
+ "auditLog.get",
219
+ "auditLogs.get",
220
+ "dashboard.patch",
221
+ "dashboard.delete",
222
+ "dashboards.get",
223
+ "dashboards.post",
224
+ "org.get",
225
+ "org.patch",
226
+ "org.delete",
227
+ "org.pendingInvites",
228
+ "org.inviteMember",
229
+ "org.revokeInvite",
230
+ "org.modifyMember",
231
+ "org.removeMember",
232
+ "org.payloadCounts",
233
+ "org.invoices",
234
+ "org.currentCard",
235
+ "org.chargeDetails",
236
+ "org.transferResources",
237
+ "solutionUser.get",
238
+ "solutionUser.patch",
239
+ "solutionUser.delete",
240
+ "solutionUsers.get",
241
+ "solutionUsers.post",
242
+ "solution.get",
243
+ "solution.patch",
244
+ "solution.delete",
245
+ "solutions.get",
246
+ "solutions.post"
247
+ ]
248
+ }
249
+ ]
250
+ },
251
+ {
252
+ "type": "string",
253
+ "enum": [
254
+ "all.User",
255
+ "all.User.read",
256
+ "me.*",
257
+ "orgs.*",
258
+ "me.get",
259
+ "me.patch",
260
+ "me.delete",
261
+ "me.verifyEmail",
262
+ "me.changePassword",
263
+ "me.enableTwoFactorAuth",
264
+ "me.disableTwoFactorAuth",
265
+ "me.disconnectGithub",
266
+ "me.connectGithub",
267
+ "me.disconnectTwitter",
268
+ "me.connectTwitter",
269
+ "me.addRecentItem",
270
+ "me.fetchRecentItems",
271
+ "me.payloadCounts",
272
+ "me.transferResources",
273
+ "orgs.get",
274
+ "orgs.post"
275
+ ]
276
+ }
277
+ ]
278
+ }
279
+ },
280
+ "tokenTTL": {
281
+ "type": "integer",
282
+ "minimum": 0
8
283
  }
9
284
  },
10
285
  "required": [