losant_rest 1.19.1 → 1.19.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/_schemas.md +1723 -148
- data/docs/me.md +6 -6
- data/lib/losant_rest/version.rb +1 -1
- data/lib/platform_rest/client.rb +2 -2
- data/lib/platform_rest/me.rb +6 -6
- data/schemas/application.json +166 -2
- data/schemas/applicationCreationByTemplateResult.json +166 -2
- data/schemas/applicationDashboardPost.json +6 -0
- data/schemas/applications.json +166 -2
- data/schemas/credential.json +31 -1
- data/schemas/credentialPatch.json +28 -0
- data/schemas/credentialPost.json +35 -1
- data/schemas/credentials.json +31 -1
- data/schemas/dashboard.json +6 -0
- data/schemas/dashboardPatch.json +6 -0
- data/schemas/dashboardPost.json +6 -0
- data/schemas/dashboards.json +6 -0
- data/schemas/historicalSummaries.json +16 -0
- data/schemas/historicalSummary.json +16 -0
- data/schemas/instance.json +13 -0
- data/schemas/instanceOrg.json +264 -0
- data/schemas/instanceOrgPatch.json +21 -0
- data/schemas/instanceOrgPost.json +21 -0
- data/schemas/instanceOrgs.json +264 -0
- data/schemas/instancePatch.json +13 -0
- data/schemas/instanceSandbox.json +46 -2
- data/schemas/instanceSandboxes.json +46 -2
- data/schemas/instances.json +13 -0
- data/schemas/me.json +46 -2
- data/schemas/multiFactorAuthDisable.json +20 -0
- data/schemas/multiFactorAuthEnable.json +25 -0
- data/schemas/multiFactorAuthInfo.json +15 -0
- data/schemas/org.json +55 -5
- data/schemas/orgPatch.json +8 -0
- data/schemas/orgPost.json +8 -0
- data/schemas/orgs.json +55 -5
- data/schemas/timeSeriesData.json +35 -2
- metadata +5 -2
data/docs/me.md
CHANGED
@@ -176,7 +176,7 @@ all.User, all.User.read, me.*, or me.deviceCounts.
|
|
176
176
|
|
177
177
|
## Disable Two Factor Auth
|
178
178
|
|
179
|
-
Disables
|
179
|
+
Disables multi-factor authentication for the current user
|
180
180
|
|
181
181
|
```ruby
|
182
182
|
result = client.me.disable_two_factor_auth(data: my_data)
|
@@ -193,7 +193,7 @@ all.User, me.*, or me.disableTwoFactorAuth.
|
|
193
193
|
|
194
194
|
| Name | Type | Required | Description | Default | Example |
|
195
195
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
196
|
-
| data | [Disable
|
196
|
+
| data | [Disable Multi-Factor Authentication](_schemas.md#disable-multi-factor-authentication) | Y | Object containing multi-factor authentication properties | | [Disable Multi-Factor Authentication Example](_schemas.md#disable-multi-factor-authentication-example) |
|
197
197
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
198
198
|
|
199
199
|
#### Successful Responses
|
@@ -247,7 +247,7 @@ all.User, me.*, or me.disconnectGithub.
|
|
247
247
|
|
248
248
|
## Enable Two Factor Auth
|
249
249
|
|
250
|
-
Enables
|
250
|
+
Enables multi-factor authentication for the current user
|
251
251
|
|
252
252
|
```ruby
|
253
253
|
result = client.me.enable_two_factor_auth(data: my_data)
|
@@ -264,7 +264,7 @@ all.User, me.*, or me.enableTwoFactorAuth.
|
|
264
264
|
|
265
265
|
| Name | Type | Required | Description | Default | Example |
|
266
266
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
267
|
-
| data | [Enable
|
267
|
+
| data | [Enable Multi-Factor Authentication](_schemas.md#enable-multi-factor-authentication) | Y | Object containing multi-factor authentication properties | | [Enable Multi-Factor Authentication Example](_schemas.md#enable-multi-factor-authentication-example) |
|
268
268
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
269
269
|
|
270
270
|
#### Successful Responses
|
@@ -320,7 +320,7 @@ all.User, all.User.read, me.*, or me.fetchRecentItems.
|
|
320
320
|
|
321
321
|
## Generate Two Factor Auth
|
322
322
|
|
323
|
-
Returns the
|
323
|
+
Returns the multi-factor authentication key for the current user
|
324
324
|
|
325
325
|
```ruby
|
326
326
|
result = client.me.generate_two_factor_auth(optional_params)
|
@@ -343,7 +343,7 @@ all.User, me.*, or me.generateTwoFactorAuth.
|
|
343
343
|
|
344
344
|
| Code | Type | Description |
|
345
345
|
| ---- | ---- | ----------- |
|
346
|
-
| 200 | [
|
346
|
+
| 200 | [Multi-Factor Authentication Info](_schemas.md#multi-factor-authentication-info) | Multi-factor authentication info |
|
347
347
|
|
348
348
|
#### Error Responses
|
349
349
|
|
data/lib/losant_rest/version.rb
CHANGED
data/lib/platform_rest/client.rb
CHANGED
@@ -27,7 +27,7 @@ module PlatformRest
|
|
27
27
|
#
|
28
28
|
# User API for accessing platform data
|
29
29
|
#
|
30
|
-
# Built For Version 1.26.
|
30
|
+
# Built For Version 1.26.2
|
31
31
|
class Client
|
32
32
|
attr_accessor :auth_token, :url
|
33
33
|
|
@@ -390,7 +390,7 @@ module PlatformRest
|
|
390
390
|
|
391
391
|
headers["Accept"] = "application/json"
|
392
392
|
headers["Content-Type"] = "application/json"
|
393
|
-
headers["Accept-Version"] = "^1.26.
|
393
|
+
headers["Accept-Version"] = "^1.26.2"
|
394
394
|
headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
|
395
395
|
path = self.url + options.fetch(:path, "")
|
396
396
|
|
data/lib/platform_rest/me.rb
CHANGED
@@ -208,7 +208,7 @@ module PlatformRest
|
|
208
208
|
body: body)
|
209
209
|
end
|
210
210
|
|
211
|
-
# Disables
|
211
|
+
# Disables multi-factor authentication for the current user
|
212
212
|
#
|
213
213
|
# Authentication:
|
214
214
|
# The client must be configured with a valid api
|
@@ -217,7 +217,7 @@ module PlatformRest
|
|
217
217
|
# all.User, me.*, or me.disableTwoFactorAuth.
|
218
218
|
#
|
219
219
|
# Parameters:
|
220
|
-
# * {hash} data - Object containing
|
220
|
+
# * {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthDisable)
|
221
221
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
222
222
|
# * {boolean} _actions - Return resource actions in response
|
223
223
|
# * {boolean} _links - Return resource link in response
|
@@ -293,7 +293,7 @@ module PlatformRest
|
|
293
293
|
body: body)
|
294
294
|
end
|
295
295
|
|
296
|
-
# Enables
|
296
|
+
# Enables multi-factor authentication for the current user
|
297
297
|
#
|
298
298
|
# Authentication:
|
299
299
|
# The client must be configured with a valid api
|
@@ -302,7 +302,7 @@ module PlatformRest
|
|
302
302
|
# all.User, me.*, or me.enableTwoFactorAuth.
|
303
303
|
#
|
304
304
|
# Parameters:
|
305
|
-
# * {hash} data - Object containing
|
305
|
+
# * {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthEnable)
|
306
306
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
307
307
|
# * {boolean} _actions - Return resource actions in response
|
308
308
|
# * {boolean} _links - Return resource link in response
|
@@ -383,7 +383,7 @@ module PlatformRest
|
|
383
383
|
body: body)
|
384
384
|
end
|
385
385
|
|
386
|
-
# Returns the
|
386
|
+
# Returns the multi-factor authentication key for the current user
|
387
387
|
#
|
388
388
|
# Authentication:
|
389
389
|
# The client must be configured with a valid api
|
@@ -398,7 +398,7 @@ module PlatformRest
|
|
398
398
|
# * {boolean} _embedded - Return embedded resources in response
|
399
399
|
#
|
400
400
|
# Responses:
|
401
|
-
# * 200 -
|
401
|
+
# * 200 - Multi-factor authentication info (https://api.losant.com/#/definitions/multiFactorAuthInfo)
|
402
402
|
#
|
403
403
|
# Errors:
|
404
404
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
data/schemas/application.json
CHANGED
@@ -110,9 +110,18 @@
|
|
110
110
|
"apiTokenCount": {
|
111
111
|
"type": "integer"
|
112
112
|
},
|
113
|
+
"certificateCount": {
|
114
|
+
"type": "integer"
|
115
|
+
},
|
116
|
+
"certificateAuthorityCount": {
|
117
|
+
"type": "integer"
|
118
|
+
},
|
113
119
|
"credentialCount": {
|
114
120
|
"type": "integer"
|
115
121
|
},
|
122
|
+
"dashCount": {
|
123
|
+
"type": "integer"
|
124
|
+
},
|
116
125
|
"dataTableCount": {
|
117
126
|
"type": "integer"
|
118
127
|
},
|
@@ -158,6 +167,150 @@
|
|
158
167
|
"keyCount": {
|
159
168
|
"type": "integer"
|
160
169
|
},
|
170
|
+
"notebookCount": {
|
171
|
+
"type": "integer"
|
172
|
+
},
|
173
|
+
"resourceJobCount": {
|
174
|
+
"type": "integer"
|
175
|
+
},
|
176
|
+
"webhookCount": {
|
177
|
+
"type": "integer"
|
178
|
+
},
|
179
|
+
"payloadCount": {
|
180
|
+
"title": "Payload Stats",
|
181
|
+
"description": "Schema for the result of a payload stats request",
|
182
|
+
"type": "object",
|
183
|
+
"properties": {
|
184
|
+
"dataTable": {
|
185
|
+
"type": "object",
|
186
|
+
"patternProperties": {
|
187
|
+
".*": {
|
188
|
+
"type": "number"
|
189
|
+
}
|
190
|
+
}
|
191
|
+
},
|
192
|
+
"deviceCommand": {
|
193
|
+
"type": "object",
|
194
|
+
"patternProperties": {
|
195
|
+
".*": {
|
196
|
+
"type": "number"
|
197
|
+
}
|
198
|
+
}
|
199
|
+
},
|
200
|
+
"deviceConnect": {
|
201
|
+
"type": "object",
|
202
|
+
"patternProperties": {
|
203
|
+
".*": {
|
204
|
+
"type": "number"
|
205
|
+
}
|
206
|
+
}
|
207
|
+
},
|
208
|
+
"deviceDisconnect": {
|
209
|
+
"type": "object",
|
210
|
+
"patternProperties": {
|
211
|
+
".*": {
|
212
|
+
"type": "number"
|
213
|
+
}
|
214
|
+
}
|
215
|
+
},
|
216
|
+
"deviceState": {
|
217
|
+
"type": "object",
|
218
|
+
"patternProperties": {
|
219
|
+
".*": {
|
220
|
+
"type": "number"
|
221
|
+
}
|
222
|
+
}
|
223
|
+
},
|
224
|
+
"endpoint": {
|
225
|
+
"type": "object",
|
226
|
+
"patternProperties": {
|
227
|
+
".*": {
|
228
|
+
"type": "number"
|
229
|
+
}
|
230
|
+
}
|
231
|
+
},
|
232
|
+
"event": {
|
233
|
+
"type": "object",
|
234
|
+
"patternProperties": {
|
235
|
+
".*": {
|
236
|
+
"type": "number"
|
237
|
+
}
|
238
|
+
}
|
239
|
+
},
|
240
|
+
"flowError": {
|
241
|
+
"type": "object",
|
242
|
+
"patternProperties": {
|
243
|
+
".*": {
|
244
|
+
"type": "number"
|
245
|
+
}
|
246
|
+
}
|
247
|
+
},
|
248
|
+
"integration": {
|
249
|
+
"type": "object",
|
250
|
+
"patternProperties": {
|
251
|
+
".*": {
|
252
|
+
"type": "number"
|
253
|
+
}
|
254
|
+
}
|
255
|
+
},
|
256
|
+
"mqttIn": {
|
257
|
+
"type": "object",
|
258
|
+
"patternProperties": {
|
259
|
+
".*": {
|
260
|
+
"type": "number"
|
261
|
+
}
|
262
|
+
}
|
263
|
+
},
|
264
|
+
"mqttOut": {
|
265
|
+
"type": "object",
|
266
|
+
"patternProperties": {
|
267
|
+
".*": {
|
268
|
+
"type": "number"
|
269
|
+
}
|
270
|
+
}
|
271
|
+
},
|
272
|
+
"notebook": {
|
273
|
+
"type": "object",
|
274
|
+
"patternProperties": {
|
275
|
+
".*": {
|
276
|
+
"type": "number"
|
277
|
+
}
|
278
|
+
}
|
279
|
+
},
|
280
|
+
"timer": {
|
281
|
+
"type": "object",
|
282
|
+
"patternProperties": {
|
283
|
+
".*": {
|
284
|
+
"type": "number"
|
285
|
+
}
|
286
|
+
}
|
287
|
+
},
|
288
|
+
"virtualButton": {
|
289
|
+
"type": "object",
|
290
|
+
"patternProperties": {
|
291
|
+
".*": {
|
292
|
+
"type": "number"
|
293
|
+
}
|
294
|
+
}
|
295
|
+
},
|
296
|
+
"webhook": {
|
297
|
+
"type": "object",
|
298
|
+
"patternProperties": {
|
299
|
+
".*": {
|
300
|
+
"type": "number"
|
301
|
+
}
|
302
|
+
}
|
303
|
+
},
|
304
|
+
"resourceJob": {
|
305
|
+
"type": "object",
|
306
|
+
"patternProperties": {
|
307
|
+
".*": {
|
308
|
+
"type": "number"
|
309
|
+
}
|
310
|
+
}
|
311
|
+
}
|
312
|
+
}
|
313
|
+
},
|
161
314
|
"storageStats": {
|
162
315
|
"type": "object",
|
163
316
|
"properties": {
|
@@ -169,8 +322,19 @@
|
|
169
322
|
}
|
170
323
|
}
|
171
324
|
},
|
172
|
-
"
|
173
|
-
"type": "
|
325
|
+
"notebookStats": {
|
326
|
+
"type": "object",
|
327
|
+
"properties": {
|
328
|
+
"awaitingCompletion": {
|
329
|
+
"type": "integer"
|
330
|
+
},
|
331
|
+
"minutesThisPeriod": {
|
332
|
+
"type": "integer"
|
333
|
+
},
|
334
|
+
"runsThisPeriod": {
|
335
|
+
"type": "integer"
|
336
|
+
}
|
337
|
+
}
|
174
338
|
}
|
175
339
|
}
|
176
340
|
},
|
@@ -115,9 +115,18 @@
|
|
115
115
|
"apiTokenCount": {
|
116
116
|
"type": "integer"
|
117
117
|
},
|
118
|
+
"certificateCount": {
|
119
|
+
"type": "integer"
|
120
|
+
},
|
121
|
+
"certificateAuthorityCount": {
|
122
|
+
"type": "integer"
|
123
|
+
},
|
118
124
|
"credentialCount": {
|
119
125
|
"type": "integer"
|
120
126
|
},
|
127
|
+
"dashCount": {
|
128
|
+
"type": "integer"
|
129
|
+
},
|
121
130
|
"dataTableCount": {
|
122
131
|
"type": "integer"
|
123
132
|
},
|
@@ -163,6 +172,150 @@
|
|
163
172
|
"keyCount": {
|
164
173
|
"type": "integer"
|
165
174
|
},
|
175
|
+
"notebookCount": {
|
176
|
+
"type": "integer"
|
177
|
+
},
|
178
|
+
"resourceJobCount": {
|
179
|
+
"type": "integer"
|
180
|
+
},
|
181
|
+
"webhookCount": {
|
182
|
+
"type": "integer"
|
183
|
+
},
|
184
|
+
"payloadCount": {
|
185
|
+
"title": "Payload Stats",
|
186
|
+
"description": "Schema for the result of a payload stats request",
|
187
|
+
"type": "object",
|
188
|
+
"properties": {
|
189
|
+
"dataTable": {
|
190
|
+
"type": "object",
|
191
|
+
"patternProperties": {
|
192
|
+
".*": {
|
193
|
+
"type": "number"
|
194
|
+
}
|
195
|
+
}
|
196
|
+
},
|
197
|
+
"deviceCommand": {
|
198
|
+
"type": "object",
|
199
|
+
"patternProperties": {
|
200
|
+
".*": {
|
201
|
+
"type": "number"
|
202
|
+
}
|
203
|
+
}
|
204
|
+
},
|
205
|
+
"deviceConnect": {
|
206
|
+
"type": "object",
|
207
|
+
"patternProperties": {
|
208
|
+
".*": {
|
209
|
+
"type": "number"
|
210
|
+
}
|
211
|
+
}
|
212
|
+
},
|
213
|
+
"deviceDisconnect": {
|
214
|
+
"type": "object",
|
215
|
+
"patternProperties": {
|
216
|
+
".*": {
|
217
|
+
"type": "number"
|
218
|
+
}
|
219
|
+
}
|
220
|
+
},
|
221
|
+
"deviceState": {
|
222
|
+
"type": "object",
|
223
|
+
"patternProperties": {
|
224
|
+
".*": {
|
225
|
+
"type": "number"
|
226
|
+
}
|
227
|
+
}
|
228
|
+
},
|
229
|
+
"endpoint": {
|
230
|
+
"type": "object",
|
231
|
+
"patternProperties": {
|
232
|
+
".*": {
|
233
|
+
"type": "number"
|
234
|
+
}
|
235
|
+
}
|
236
|
+
},
|
237
|
+
"event": {
|
238
|
+
"type": "object",
|
239
|
+
"patternProperties": {
|
240
|
+
".*": {
|
241
|
+
"type": "number"
|
242
|
+
}
|
243
|
+
}
|
244
|
+
},
|
245
|
+
"flowError": {
|
246
|
+
"type": "object",
|
247
|
+
"patternProperties": {
|
248
|
+
".*": {
|
249
|
+
"type": "number"
|
250
|
+
}
|
251
|
+
}
|
252
|
+
},
|
253
|
+
"integration": {
|
254
|
+
"type": "object",
|
255
|
+
"patternProperties": {
|
256
|
+
".*": {
|
257
|
+
"type": "number"
|
258
|
+
}
|
259
|
+
}
|
260
|
+
},
|
261
|
+
"mqttIn": {
|
262
|
+
"type": "object",
|
263
|
+
"patternProperties": {
|
264
|
+
".*": {
|
265
|
+
"type": "number"
|
266
|
+
}
|
267
|
+
}
|
268
|
+
},
|
269
|
+
"mqttOut": {
|
270
|
+
"type": "object",
|
271
|
+
"patternProperties": {
|
272
|
+
".*": {
|
273
|
+
"type": "number"
|
274
|
+
}
|
275
|
+
}
|
276
|
+
},
|
277
|
+
"notebook": {
|
278
|
+
"type": "object",
|
279
|
+
"patternProperties": {
|
280
|
+
".*": {
|
281
|
+
"type": "number"
|
282
|
+
}
|
283
|
+
}
|
284
|
+
},
|
285
|
+
"timer": {
|
286
|
+
"type": "object",
|
287
|
+
"patternProperties": {
|
288
|
+
".*": {
|
289
|
+
"type": "number"
|
290
|
+
}
|
291
|
+
}
|
292
|
+
},
|
293
|
+
"virtualButton": {
|
294
|
+
"type": "object",
|
295
|
+
"patternProperties": {
|
296
|
+
".*": {
|
297
|
+
"type": "number"
|
298
|
+
}
|
299
|
+
}
|
300
|
+
},
|
301
|
+
"webhook": {
|
302
|
+
"type": "object",
|
303
|
+
"patternProperties": {
|
304
|
+
".*": {
|
305
|
+
"type": "number"
|
306
|
+
}
|
307
|
+
}
|
308
|
+
},
|
309
|
+
"resourceJob": {
|
310
|
+
"type": "object",
|
311
|
+
"patternProperties": {
|
312
|
+
".*": {
|
313
|
+
"type": "number"
|
314
|
+
}
|
315
|
+
}
|
316
|
+
}
|
317
|
+
}
|
318
|
+
},
|
166
319
|
"storageStats": {
|
167
320
|
"type": "object",
|
168
321
|
"properties": {
|
@@ -174,8 +327,19 @@
|
|
174
327
|
}
|
175
328
|
}
|
176
329
|
},
|
177
|
-
"
|
178
|
-
"type": "
|
330
|
+
"notebookStats": {
|
331
|
+
"type": "object",
|
332
|
+
"properties": {
|
333
|
+
"awaitingCompletion": {
|
334
|
+
"type": "integer"
|
335
|
+
},
|
336
|
+
"minutesThisPeriod": {
|
337
|
+
"type": "integer"
|
338
|
+
},
|
339
|
+
"runsThisPeriod": {
|
340
|
+
"type": "integer"
|
341
|
+
}
|
342
|
+
}
|
179
343
|
}
|
180
344
|
}
|
181
345
|
},
|
@@ -880,6 +880,9 @@
|
|
880
880
|
"vega4",
|
881
881
|
"vega5"
|
882
882
|
]
|
883
|
+
},
|
884
|
+
"tooltipEventSubscribe": {
|
885
|
+
"type": "boolean"
|
883
886
|
}
|
884
887
|
},
|
885
888
|
"additionalProperties": false
|
@@ -2176,6 +2179,9 @@
|
|
2176
2179
|
"realTime": {
|
2177
2180
|
"type": "boolean"
|
2178
2181
|
},
|
2182
|
+
"hideLegend": {
|
2183
|
+
"type": "boolean"
|
2184
|
+
},
|
2179
2185
|
"disallowUserSelectedDuration": {
|
2180
2186
|
"type": "boolean"
|
2181
2187
|
},
|