losant_rest 1.19.1 → 1.19.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +2373 -508
  3. data/docs/application.md +40 -0
  4. data/docs/me.md +6 -6
  5. data/lib/losant_rest/version.rb +1 -1
  6. data/lib/platform_rest/application.rb +48 -0
  7. data/lib/platform_rest/client.rb +2 -2
  8. data/lib/platform_rest/me.rb +6 -6
  9. data/schemas/apiTokenPost.json +1 -0
  10. data/schemas/application.json +166 -2
  11. data/schemas/applicationCreationByTemplateResult.json +166 -2
  12. data/schemas/applicationDashboardPost.json +6 -0
  13. data/schemas/applicationImportExecutions.json +205 -0
  14. data/schemas/applications.json +166 -2
  15. data/schemas/authedUser.json +4 -0
  16. data/schemas/credential.json +31 -1
  17. data/schemas/credentialPatch.json +28 -0
  18. data/schemas/credentialPost.json +35 -1
  19. data/schemas/credentials.json +31 -1
  20. data/schemas/dashboard.json +6 -0
  21. data/schemas/dashboardPatch.json +6 -0
  22. data/schemas/dashboardPost.json +6 -0
  23. data/schemas/dashboards.json +6 -0
  24. data/schemas/dataExport.json +1 -0
  25. data/schemas/devicesRemoveDataPost.json +2 -2
  26. data/schemas/githubLogin.json +1 -0
  27. data/schemas/historicalSummaries.json +16 -0
  28. data/schemas/historicalSummary.json +16 -0
  29. data/schemas/importIntoApplicationOptions.json +4 -0
  30. data/schemas/instance.json +21 -0
  31. data/schemas/instanceOrg.json +264 -0
  32. data/schemas/instanceOrgPatch.json +21 -0
  33. data/schemas/instanceOrgPost.json +21 -0
  34. data/schemas/instanceOrgs.json +264 -0
  35. data/schemas/instancePatch.json +21 -0
  36. data/schemas/instanceSandbox.json +46 -2
  37. data/schemas/instanceSandboxes.json +46 -2
  38. data/schemas/instances.json +21 -0
  39. data/schemas/me.json +46 -2
  40. data/schemas/multiFactorAuthDisable.json +20 -0
  41. data/schemas/multiFactorAuthEnable.json +25 -0
  42. data/schemas/multiFactorAuthInfo.json +15 -0
  43. data/schemas/org.json +55 -5
  44. data/schemas/orgPatch.json +8 -0
  45. data/schemas/orgPost.json +8 -0
  46. data/schemas/orgs.json +55 -5
  47. data/schemas/samlResponse.json +1 -0
  48. data/schemas/timeSeriesData.json +35 -2
  49. data/schemas/userCredentials.json +1 -0
  50. data/schemas/userPost.json +8 -0
  51. metadata +6 -2
data/schemas/instanceOrgs.json CHANGED
@@ -49,6 +49,14 @@
49
49
  "type": "integer",
50
50
  "minimum": 0
51
51
  },
52
+ "applicationcertificate": {
53
+ "type": "integer",
54
+ "minimum": 0
55
+ },
56
+ "applicationcertificateauthority": {
57
+ "type": "integer",
58
+ "minimum": 0
59
+ },
52
60
  "applicationkey": {
53
61
  "type": "integer",
54
62
  "minimum": 0
@@ -160,10 +168,258 @@
160
168
  "applicationFlowSlots": {
161
169
  "type": "integer",
162
170
  "minimum": 0
171
+ },
172
+ "systemInterval": {
173
+ "type": "integer",
174
+ "minimum": 5,
175
+ "maximum": 3600
163
176
  }
164
177
  },
165
178
  "additionalProperties": false
166
179
  },
180
+ "summary": {
181
+ "type": "object",
182
+ "properties": {
183
+ "apiTokenCount": {
184
+ "type": "integer"
185
+ },
186
+ "appCount": {
187
+ "type": "integer"
188
+ },
189
+ "certificateCount": {
190
+ "type": "integer"
191
+ },
192
+ "certificateAuthorityCount": {
193
+ "type": "integer"
194
+ },
195
+ "credentialCount": {
196
+ "type": "integer"
197
+ },
198
+ "dashCount": {
199
+ "type": "integer"
200
+ },
201
+ "dataTableCount": {
202
+ "type": "integer"
203
+ },
204
+ "deviceCount": {
205
+ "type": "integer"
206
+ },
207
+ "deviceRecipeCount": {
208
+ "type": "integer"
209
+ },
210
+ "eventCount": {
211
+ "type": "integer"
212
+ },
213
+ "experienceDomainCount": {
214
+ "type": "integer"
215
+ },
216
+ "experienceEndpointCount": {
217
+ "type": "integer"
218
+ },
219
+ "experienceGroupCount": {
220
+ "type": "integer"
221
+ },
222
+ "experienceSlugCount": {
223
+ "type": "integer"
224
+ },
225
+ "experienceUserCount": {
226
+ "type": "integer"
227
+ },
228
+ "experienceVersionCount": {
229
+ "type": "integer"
230
+ },
231
+ "experienceViewCount": {
232
+ "type": "integer"
233
+ },
234
+ "fileCount": {
235
+ "type": "integer"
236
+ },
237
+ "flowCount": {
238
+ "type": "integer"
239
+ },
240
+ "integrationCount": {
241
+ "type": "integer"
242
+ },
243
+ "keyCount": {
244
+ "type": "integer"
245
+ },
246
+ "notebookCount": {
247
+ "type": "integer"
248
+ },
249
+ "resourceJobCount": {
250
+ "type": "integer"
251
+ },
252
+ "webhookCount": {
253
+ "type": "integer"
254
+ },
255
+ "memberCount": {
256
+ "type": "integer"
257
+ },
258
+ "pendingInviteCount": {
259
+ "type": "integer"
260
+ },
261
+ "payloadCount": {
262
+ "title": "Payload Stats",
263
+ "description": "Schema for the result of a payload stats request",
264
+ "type": "object",
265
+ "properties": {
266
+ "dataTable": {
267
+ "type": "object",
268
+ "patternProperties": {
269
+ ".*": {
270
+ "type": "number"
271
+ }
272
+ }
273
+ },
274
+ "deviceCommand": {
275
+ "type": "object",
276
+ "patternProperties": {
277
+ ".*": {
278
+ "type": "number"
279
+ }
280
+ }
281
+ },
282
+ "deviceConnect": {
283
+ "type": "object",
284
+ "patternProperties": {
285
+ ".*": {
286
+ "type": "number"
287
+ }
288
+ }
289
+ },
290
+ "deviceDisconnect": {
291
+ "type": "object",
292
+ "patternProperties": {
293
+ ".*": {
294
+ "type": "number"
295
+ }
296
+ }
297
+ },
298
+ "deviceState": {
299
+ "type": "object",
300
+ "patternProperties": {
301
+ ".*": {
302
+ "type": "number"
303
+ }
304
+ }
305
+ },
306
+ "endpoint": {
307
+ "type": "object",
308
+ "patternProperties": {
309
+ ".*": {
310
+ "type": "number"
311
+ }
312
+ }
313
+ },
314
+ "event": {
315
+ "type": "object",
316
+ "patternProperties": {
317
+ ".*": {
318
+ "type": "number"
319
+ }
320
+ }
321
+ },
322
+ "flowError": {
323
+ "type": "object",
324
+ "patternProperties": {
325
+ ".*": {
326
+ "type": "number"
327
+ }
328
+ }
329
+ },
330
+ "integration": {
331
+ "type": "object",
332
+ "patternProperties": {
333
+ ".*": {
334
+ "type": "number"
335
+ }
336
+ }
337
+ },
338
+ "mqttIn": {
339
+ "type": "object",
340
+ "patternProperties": {
341
+ ".*": {
342
+ "type": "number"
343
+ }
344
+ }
345
+ },
346
+ "mqttOut": {
347
+ "type": "object",
348
+ "patternProperties": {
349
+ ".*": {
350
+ "type": "number"
351
+ }
352
+ }
353
+ },
354
+ "notebook": {
355
+ "type": "object",
356
+ "patternProperties": {
357
+ ".*": {
358
+ "type": "number"
359
+ }
360
+ }
361
+ },
362
+ "timer": {
363
+ "type": "object",
364
+ "patternProperties": {
365
+ ".*": {
366
+ "type": "number"
367
+ }
368
+ }
369
+ },
370
+ "virtualButton": {
371
+ "type": "object",
372
+ "patternProperties": {
373
+ ".*": {
374
+ "type": "number"
375
+ }
376
+ }
377
+ },
378
+ "webhook": {
379
+ "type": "object",
380
+ "patternProperties": {
381
+ ".*": {
382
+ "type": "number"
383
+ }
384
+ }
385
+ },
386
+ "resourceJob": {
387
+ "type": "object",
388
+ "patternProperties": {
389
+ ".*": {
390
+ "type": "number"
391
+ }
392
+ }
393
+ }
394
+ }
395
+ },
396
+ "storageStats": {
397
+ "type": "object",
398
+ "properties": {
399
+ "count": {
400
+ "type": "integer"
401
+ },
402
+ "size": {
403
+ "type": "integer"
404
+ }
405
+ }
406
+ },
407
+ "notebookStats": {
408
+ "type": "object",
409
+ "properties": {
410
+ "awaitingCompletion": {
411
+ "type": "integer"
412
+ },
413
+ "minutesThisPeriod": {
414
+ "type": "integer"
415
+ },
416
+ "runsThisPeriod": {
417
+ "type": "integer"
418
+ }
419
+ }
420
+ }
421
+ }
422
+ },
167
423
  "whitelistedEmailDomains": {
168
424
  "type": "array",
169
425
  "items": {
@@ -218,6 +474,14 @@
218
474
  "referralId": {
219
475
  "type": "string",
220
476
  "maxLength": 1024
477
+ },
478
+ "mfaMode": {
479
+ "type": "string",
480
+ "enum": [
481
+ "notRequired",
482
+ "adminRequired",
483
+ "required"
484
+ ]
221
485
  }
222
486
  },
223
487
  "additionalProperties": false,
data/schemas/instancePatch.json CHANGED
@@ -74,6 +74,14 @@
74
74
  "type": "integer",
75
75
  "minimum": 0
76
76
  },
77
+ "applicationcertificate": {
78
+ "type": "integer",
79
+ "minimum": 0
80
+ },
81
+ "applicationcertificateauthority": {
82
+ "type": "integer",
83
+ "minimum": 0
84
+ },
77
85
  "applicationkey": {
78
86
  "type": "integer",
79
87
  "minimum": 0
@@ -185,9 +193,22 @@
185
193
  "applicationFlowSlots": {
186
194
  "type": "integer",
187
195
  "minimum": 0
196
+ },
197
+ "systemInterval": {
198
+ "type": "integer",
199
+ "minimum": 5,
200
+ "maximum": 3600
188
201
  }
189
202
  },
190
203
  "additionalProperties": false
204
+ },
205
+ "mfaMode": {
206
+ "type": "string",
207
+ "enum": [
208
+ "notRequired",
209
+ "adminRequired",
210
+ "required"
211
+ ]
191
212
  }
192
213
  },
193
214
  "additionalProperties": false
data/schemas/instanceSandbox.json CHANGED
@@ -112,6 +112,12 @@
112
112
  "application": {
113
113
  "type": "integer"
114
114
  },
115
+ "applicationcertificate": {
116
+ "type": "integer"
117
+ },
118
+ "applicationcertificateauthority": {
119
+ "type": "integer"
120
+ },
115
121
  "applicationkey": {
116
122
  "type": "integer"
117
123
  },
@@ -192,6 +198,9 @@
192
198
  },
193
199
  "applicationFlowSlots": {
194
200
  "type": "integer"
201
+ },
202
+ "systemInterval": {
203
+ "type": "integer"
195
204
  }
196
205
  },
197
206
  "additionalProperties": false
@@ -205,6 +214,12 @@
205
214
  "appCount": {
206
215
  "type": "integer"
207
216
  },
217
+ "certificateCount": {
218
+ "type": "integer"
219
+ },
220
+ "certificateAuthorityCount": {
221
+ "type": "integer"
222
+ },
208
223
  "credentialCount": {
209
224
  "type": "integer"
210
225
  },
@@ -220,6 +235,12 @@
220
235
  "deviceRecipeCount": {
221
236
  "type": "integer"
222
237
  },
238
+ "eventCount": {
239
+ "type": "integer"
240
+ },
241
+ "experienceDomainCount": {
242
+ "type": "integer"
243
+ },
223
244
  "experienceEndpointCount": {
224
245
  "type": "integer"
225
246
  },
@@ -250,9 +271,21 @@
250
271
  "keyCount": {
251
272
  "type": "integer"
252
273
  },
274
+ "notebookCount": {
275
+ "type": "integer"
276
+ },
277
+ "resourceJobCount": {
278
+ "type": "integer"
279
+ },
280
+ "webhookCount": {
281
+ "type": "integer"
282
+ },
253
283
  "orgCount": {
254
284
  "type": "integer"
255
285
  },
286
+ "instanceCount": {
287
+ "type": "integer"
288
+ },
256
289
  "payloadCount": {
257
290
  "title": "Payload Stats",
258
291
  "description": "Schema for the result of a payload stats request",
@@ -399,8 +432,19 @@
399
432
  }
400
433
  }
401
434
  },
402
- "webhookCount": {
403
- "type": "integer"
435
+ "notebookStats": {
436
+ "type": "object",
437
+ "properties": {
438
+ "awaitingCompletion": {
439
+ "type": "integer"
440
+ },
441
+ "minutesThisPeriod": {
442
+ "type": "integer"
443
+ },
444
+ "runsThisPeriod": {
445
+ "type": "integer"
446
+ }
447
+ }
404
448
  }
405
449
  }
406
450
  },
data/schemas/instanceSandboxes.json CHANGED
@@ -119,6 +119,12 @@
119
119
  "application": {
120
120
  "type": "integer"
121
121
  },
122
+ "applicationcertificate": {
123
+ "type": "integer"
124
+ },
125
+ "applicationcertificateauthority": {
126
+ "type": "integer"
127
+ },
122
128
  "applicationkey": {
123
129
  "type": "integer"
124
130
  },
@@ -199,6 +205,9 @@
199
205
  },
200
206
  "applicationFlowSlots": {
201
207
  "type": "integer"
208
+ },
209
+ "systemInterval": {
210
+ "type": "integer"
202
211
  }
203
212
  },
204
213
  "additionalProperties": false
@@ -212,6 +221,12 @@
212
221
  "appCount": {
213
222
  "type": "integer"
214
223
  },
224
+ "certificateCount": {
225
+ "type": "integer"
226
+ },
227
+ "certificateAuthorityCount": {
228
+ "type": "integer"
229
+ },
215
230
  "credentialCount": {
216
231
  "type": "integer"
217
232
  },
@@ -227,6 +242,12 @@
227
242
  "deviceRecipeCount": {
228
243
  "type": "integer"
229
244
  },
245
+ "eventCount": {
246
+ "type": "integer"
247
+ },
248
+ "experienceDomainCount": {
249
+ "type": "integer"
250
+ },
230
251
  "experienceEndpointCount": {
231
252
  "type": "integer"
232
253
  },
@@ -257,9 +278,21 @@
257
278
  "keyCount": {
258
279
  "type": "integer"
259
280
  },
281
+ "notebookCount": {
282
+ "type": "integer"
283
+ },
284
+ "resourceJobCount": {
285
+ "type": "integer"
286
+ },
287
+ "webhookCount": {
288
+ "type": "integer"
289
+ },
260
290
  "orgCount": {
261
291
  "type": "integer"
262
292
  },
293
+ "instanceCount": {
294
+ "type": "integer"
295
+ },
263
296
  "payloadCount": {
264
297
  "title": "Payload Stats",
265
298
  "description": "Schema for the result of a payload stats request",
@@ -406,8 +439,19 @@
406
439
  }
407
440
  }
408
441
  },
409
- "webhookCount": {
410
- "type": "integer"
442
+ "notebookStats": {
443
+ "type": "object",
444
+ "properties": {
445
+ "awaitingCompletion": {
446
+ "type": "integer"
447
+ },
448
+ "minutesThisPeriod": {
449
+ "type": "integer"
450
+ },
451
+ "runsThisPeriod": {
452
+ "type": "integer"
453
+ }
454
+ }
411
455
  }
412
456
  }
413
457
  },
data/schemas/instances.json CHANGED
@@ -213,6 +213,14 @@
213
213
  "type": "integer",
214
214
  "minimum": 0
215
215
  },
216
+ "applicationcertificate": {
217
+ "type": "integer",
218
+ "minimum": 0
219
+ },
220
+ "applicationcertificateauthority": {
221
+ "type": "integer",
222
+ "minimum": 0
223
+ },
216
224
  "applicationkey": {
217
225
  "type": "integer",
218
226
  "minimum": 0
@@ -324,6 +332,11 @@
324
332
  "applicationFlowSlots": {
325
333
  "type": "integer",
326
334
  "minimum": 0
335
+ },
336
+ "systemInterval": {
337
+ "type": "integer",
338
+ "minimum": 5,
339
+ "maximum": 3600
327
340
  }
328
341
  },
329
342
  "additionalProperties": false
@@ -349,6 +362,14 @@
349
362
  }
350
363
  }
351
364
  }
365
+ },
366
+ "mfaMode": {
367
+ "type": "string",
368
+ "enum": [
369
+ "notRequired",
370
+ "adminRequired",
371
+ "required"
372
+ ]
352
373
  }
353
374
  }
354
375
  }
data/schemas/me.json CHANGED
@@ -89,6 +89,12 @@
89
89
  "application": {
90
90
  "type": "integer"
91
91
  },
92
+ "applicationcertificate": {
93
+ "type": "integer"
94
+ },
95
+ "applicationcertificateauthority": {
96
+ "type": "integer"
97
+ },
92
98
  "applicationkey": {
93
99
  "type": "integer"
94
100
  },
@@ -169,6 +175,9 @@
169
175
  },
170
176
  "applicationFlowSlots": {
171
177
  "type": "integer"
178
+ },
179
+ "systemInterval": {
180
+ "type": "integer"
172
181
  }
173
182
  },
174
183
  "additionalProperties": false
@@ -296,6 +305,12 @@
296
305
  "appCount": {
297
306
  "type": "integer"
298
307
  },
308
+ "certificateCount": {
309
+ "type": "integer"
310
+ },
311
+ "certificateAuthorityCount": {
312
+ "type": "integer"
313
+ },
299
314
  "credentialCount": {
300
315
  "type": "integer"
301
316
  },
@@ -311,6 +326,12 @@
311
326
  "deviceRecipeCount": {
312
327
  "type": "integer"
313
328
  },
329
+ "eventCount": {
330
+ "type": "integer"
331
+ },
332
+ "experienceDomainCount": {
333
+ "type": "integer"
334
+ },
314
335
  "experienceEndpointCount": {
315
336
  "type": "integer"
316
337
  },
@@ -341,9 +362,21 @@
341
362
  "keyCount": {
342
363
  "type": "integer"
343
364
  },
365
+ "notebookCount": {
366
+ "type": "integer"
367
+ },
368
+ "resourceJobCount": {
369
+ "type": "integer"
370
+ },
371
+ "webhookCount": {
372
+ "type": "integer"
373
+ },
344
374
  "orgCount": {
345
375
  "type": "integer"
346
376
  },
377
+ "instanceCount": {
378
+ "type": "integer"
379
+ },
347
380
  "payloadCount": {
348
381
  "title": "Payload Stats",
349
382
  "description": "Schema for the result of a payload stats request",
@@ -490,8 +523,19 @@
490
523
  }
491
524
  }
492
525
  },
493
- "webhookCount": {
494
- "type": "integer"
526
+ "notebookStats": {
527
+ "type": "object",
528
+ "properties": {
529
+ "awaitingCompletion": {
530
+ "type": "integer"
531
+ },
532
+ "minutesThisPeriod": {
533
+ "type": "integer"
534
+ },
535
+ "runsThisPeriod": {
536
+ "type": "integer"
537
+ }
538
+ }
495
539
  }
496
540
  }
497
541
  },
data/schemas/multiFactorAuthDisable.json ADDED
@@ -0,0 +1,20 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "twoFactorCode": {
6
+ "type": "string",
7
+ "maxLength": 2048
8
+ },
9
+ "password": {
10
+ "type": "string",
11
+ "minLength": 8,
12
+ "maxLength": 2048
13
+ }
14
+ },
15
+ "required": [
16
+ "password",
17
+ "twoFactorCode"
18
+ ],
19
+ "additionalProperties": false
20
+ }
data/schemas/multiFactorAuthEnable.json ADDED
@@ -0,0 +1,25 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "twoFactorAuthKey": {
6
+ "type": "string",
7
+ "minLength": 52,
8
+ "maxLength": 52
9
+ },
10
+ "password": {
11
+ "type": "string",
12
+ "minLength": 8,
13
+ "maxLength": 2048
14
+ },
15
+ "twoFactorCode": {
16
+ "type": "string",
17
+ "maxLength": 2048
18
+ }
19
+ },
20
+ "required": [
21
+ "password",
22
+ "twoFactorCode"
23
+ ],
24
+ "additionalProperties": false
25
+ }