losant_rest 1.19.8 → 1.20.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/test.yml +1 -1
  3. data/docs/_schemas.md +9774 -1641
  4. data/lib/platform_rest/client.rb +2 -2
  5. data/lib/platform_rest/version.rb +1 -1
  6. data/losant_rest.gemspec +2 -2
  7. data/schemas/advancedApplicationKeyQuery.json +360 -18
  8. data/schemas/advancedDeviceQuery.json +360 -18
  9. data/schemas/advancedEventQuery.json +360 -18
  10. data/schemas/advancedExperienceGroupQuery.json +360 -18
  11. data/schemas/advancedExperienceUserQuery.json +360 -18
  12. data/schemas/advancedInstanceOrgQuery.json +360 -18
  13. data/schemas/apiTokenPost.json +1 -1
  14. data/schemas/application.json +28 -4
  15. data/schemas/applicationCreationByTemplateResult.json +28 -4
  16. data/schemas/applicationDashboardPost.json +2 -1
  17. data/schemas/applicationTemplate.json +4 -0
  18. data/schemas/applicationTemplates.json +4 -0
  19. data/schemas/applications.json +28 -4
  20. data/schemas/credential.json +7 -1
  21. data/schemas/credentialLinkedResources.json +336 -18
  22. data/schemas/credentialPatch.json +11 -0
  23. data/schemas/credentialPost.json +16 -1
  24. data/schemas/credentials.json +7 -1
  25. data/schemas/dashboard.json +2 -1
  26. data/schemas/dashboardPatch.json +2 -1
  27. data/schemas/dashboardPost.json +2 -1
  28. data/schemas/dashboards.json +2 -1
  29. data/schemas/dataExport.json +360 -18
  30. data/schemas/devicesDeletePost.json +360 -18
  31. data/schemas/devicesExportPayloadCountPost.json +360 -18
  32. data/schemas/devicesExportPost.json +360 -18
  33. data/schemas/devicesPatch.json +360 -18
  34. data/schemas/devicesRemoveDataPost.json +360 -18
  35. data/schemas/eventsExport.json +360 -18
  36. data/schemas/experienceLinkedResources.json +336 -18
  37. data/schemas/flow.json +112 -6
  38. data/schemas/flowPatch.json +112 -6
  39. data/schemas/flowPost.json +112 -6
  40. data/schemas/flowVersion.json +224 -12
  41. data/schemas/flowVersionPost.json +112 -6
  42. data/schemas/flowVersions.json +224 -12
  43. data/schemas/flows.json +112 -6
  44. data/schemas/flowsImportPost.json +224 -12
  45. data/schemas/flowsImportResult.json +336 -18
  46. data/schemas/githubLogin.json +1 -1
  47. data/schemas/historicalSummaries.json +56 -8
  48. data/schemas/historicalSummary.json +56 -8
  49. data/schemas/instanceCustomNodePatch.json +10 -6
  50. data/schemas/instanceCustomNodePost.json +10 -6
  51. data/schemas/instanceOrg.json +63 -4
  52. data/schemas/instanceOrgs.json +63 -4
  53. data/schemas/instanceSandbox.json +28 -4
  54. data/schemas/instanceSandboxes.json +28 -4
  55. data/schemas/lastValueQuery.json +360 -18
  56. data/schemas/me.json +28 -4
  57. data/schemas/multiDeviceCommand.json +360 -18
  58. data/schemas/org.json +28 -4
  59. data/schemas/orgs.json +28 -4
  60. data/schemas/payloadStats.json +28 -4
  61. data/schemas/samlResponse.json +1 -1
  62. data/schemas/timeSeriesQuery.json +360 -18
  63. data/schemas/userCredentials.json +1 -1
  64. data/schemas/userPost.json +1 -1
  65. data/schemas/webhook.json +13 -0
  66. data/schemas/webhookPatch.json +13 -0
  67. data/schemas/webhookPost.json +13 -0
  68. data/schemas/webhooks.json +13 -0
  69. metadata +5 -5
data/schemas/historicalSummary.json CHANGED
@@ -304,6 +304,14 @@
304
304
  "description": "Schema for the result of a payload stats request",
305
305
  "type": "object",
306
306
  "properties": {
307
+ "appFile": {
308
+ "type": "object",
309
+ "patternProperties": {
310
+ ".*": {
311
+ "type": "number"
312
+ }
313
+ }
314
+ },
307
315
  "dataTable": {
308
316
  "type": "object",
309
317
  "patternProperties": {
@@ -312,6 +320,14 @@
312
320
  }
313
321
  }
314
322
  },
323
+ "deviceCreate": {
324
+ "type": "object",
325
+ "patternProperties": {
326
+ ".*": {
327
+ "type": "number"
328
+ }
329
+ }
330
+ },
315
331
  "deviceCommand": {
316
332
  "type": "object",
317
333
  "patternProperties": {
@@ -368,6 +384,14 @@
368
384
  }
369
385
  }
370
386
  },
387
+ "inboundEmail": {
388
+ "type": "object",
389
+ "patternProperties": {
390
+ ".*": {
391
+ "type": "number"
392
+ }
393
+ }
394
+ },
371
395
  "integration": {
372
396
  "type": "object",
373
397
  "patternProperties": {
@@ -400,7 +424,7 @@
400
424
  }
401
425
  }
402
426
  },
403
- "timer": {
427
+ "resourceJob": {
404
428
  "type": "object",
405
429
  "patternProperties": {
406
430
  ".*": {
@@ -408,7 +432,7 @@
408
432
  }
409
433
  }
410
434
  },
411
- "virtualButton": {
435
+ "timer": {
412
436
  "type": "object",
413
437
  "patternProperties": {
414
438
  ".*": {
@@ -416,7 +440,7 @@
416
440
  }
417
441
  }
418
442
  },
419
- "webhook": {
443
+ "virtualButton": {
420
444
  "type": "object",
421
445
  "patternProperties": {
422
446
  ".*": {
@@ -424,7 +448,7 @@
424
448
  }
425
449
  }
426
450
  },
427
- "resourceJob": {
451
+ "webhook": {
428
452
  "type": "object",
429
453
  "patternProperties": {
430
454
  ".*": {
@@ -439,6 +463,14 @@
439
463
  "description": "Schema for the result of a payload stats request",
440
464
  "type": "object",
441
465
  "properties": {
466
+ "appFile": {
467
+ "type": "object",
468
+ "patternProperties": {
469
+ ".*": {
470
+ "type": "number"
471
+ }
472
+ }
473
+ },
442
474
  "dataTable": {
443
475
  "type": "object",
444
476
  "patternProperties": {
@@ -447,6 +479,14 @@
447
479
  }
448
480
  }
449
481
  },
482
+ "deviceCreate": {
483
+ "type": "object",
484
+ "patternProperties": {
485
+ ".*": {
486
+ "type": "number"
487
+ }
488
+ }
489
+ },
450
490
  "deviceCommand": {
451
491
  "type": "object",
452
492
  "patternProperties": {
@@ -503,6 +543,14 @@
503
543
  }
504
544
  }
505
545
  },
546
+ "inboundEmail": {
547
+ "type": "object",
548
+ "patternProperties": {
549
+ ".*": {
550
+ "type": "number"
551
+ }
552
+ }
553
+ },
506
554
  "integration": {
507
555
  "type": "object",
508
556
  "patternProperties": {
@@ -535,7 +583,7 @@
535
583
  }
536
584
  }
537
585
  },
538
- "timer": {
586
+ "resourceJob": {
539
587
  "type": "object",
540
588
  "patternProperties": {
541
589
  ".*": {
@@ -543,7 +591,7 @@
543
591
  }
544
592
  }
545
593
  },
546
- "virtualButton": {
594
+ "timer": {
547
595
  "type": "object",
548
596
  "patternProperties": {
549
597
  ".*": {
@@ -551,7 +599,7 @@
551
599
  }
552
600
  }
553
601
  },
554
- "webhook": {
602
+ "virtualButton": {
555
603
  "type": "object",
556
604
  "patternProperties": {
557
605
  ".*": {
@@ -559,7 +607,7 @@
559
607
  }
560
608
  }
561
609
  },
562
- "resourceJob": {
610
+ "webhook": {
563
611
  "type": "object",
564
612
  "patternProperties": {
565
613
  ".*": {
data/schemas/instanceCustomNodePatch.json CHANGED
@@ -61,20 +61,22 @@
61
61
  "type": "string",
62
62
  "enum": [
63
63
  "customNodeStart",
64
+ "deviceCreate",
64
65
  "deviceCommand",
65
66
  "deviceIdConnect",
66
67
  "deviceTagConnect",
67
68
  "deviceIdDisconnect",
68
69
  "deviceTagDisconnect",
70
+ "inboundEmail",
69
71
  "notebook",
70
72
  "onBoot",
71
73
  "onConnect",
72
74
  "onDisconnect",
73
- "udp",
74
- "webhook",
75
+ "resourceJobComplete",
75
76
  "resourceJobIteration",
76
77
  "resourceJobIterationTimeout",
77
- "resourceJobComplete"
78
+ "udp",
79
+ "webhook"
78
80
  ]
79
81
  },
80
82
  "config": {
@@ -94,20 +96,22 @@
94
96
  "type": "string",
95
97
  "enum": [
96
98
  "customNodeStart",
99
+ "deviceCreate",
97
100
  "deviceCommand",
98
101
  "deviceIdsTagsConnect",
99
102
  "deviceIdsTagsDisconnect",
100
103
  "eeaInit",
101
104
  "flowError",
105
+ "inboundEmail",
102
106
  "notebook",
103
107
  "onBoot",
104
108
  "onConnect",
105
109
  "onDisconnect",
106
- "udp",
107
- "webhook",
110
+ "resourceJobComplete",
108
111
  "resourceJobIteration",
109
112
  "resourceJobIterationTimeout",
110
- "resourceJobComplete"
113
+ "udp",
114
+ "webhook"
111
115
  ]
112
116
  },
113
117
  "label": {
data/schemas/instanceCustomNodePost.json CHANGED
@@ -61,20 +61,22 @@
61
61
  "type": "string",
62
62
  "enum": [
63
63
  "customNodeStart",
64
+ "deviceCreate",
64
65
  "deviceCommand",
65
66
  "deviceIdConnect",
66
67
  "deviceTagConnect",
67
68
  "deviceIdDisconnect",
68
69
  "deviceTagDisconnect",
70
+ "inboundEmail",
69
71
  "notebook",
70
72
  "onBoot",
71
73
  "onConnect",
72
74
  "onDisconnect",
73
- "udp",
74
- "webhook",
75
+ "resourceJobComplete",
75
76
  "resourceJobIteration",
76
77
  "resourceJobIterationTimeout",
77
- "resourceJobComplete"
78
+ "udp",
79
+ "webhook"
78
80
  ]
79
81
  },
80
82
  "config": {
@@ -94,20 +96,22 @@
94
96
  "type": "string",
95
97
  "enum": [
96
98
  "customNodeStart",
99
+ "deviceCreate",
97
100
  "deviceCommand",
98
101
  "deviceIdsTagsConnect",
99
102
  "deviceIdsTagsDisconnect",
100
103
  "eeaInit",
101
104
  "flowError",
105
+ "inboundEmail",
102
106
  "notebook",
103
107
  "onBoot",
104
108
  "onConnect",
105
109
  "onDisconnect",
106
- "udp",
107
- "webhook",
110
+ "resourceJobComplete",
108
111
  "resourceJobIteration",
109
112
  "resourceJobIterationTimeout",
110
- "resourceJobComplete"
113
+ "udp",
114
+ "webhook"
111
115
  ]
112
116
  },
113
117
  "label": {
data/schemas/instanceOrg.json CHANGED
@@ -256,6 +256,14 @@
256
256
  "description": "Schema for the result of a payload stats request",
257
257
  "type": "object",
258
258
  "properties": {
259
+ "appFile": {
260
+ "type": "object",
261
+ "patternProperties": {
262
+ ".*": {
263
+ "type": "number"
264
+ }
265
+ }
266
+ },
259
267
  "dataTable": {
260
268
  "type": "object",
261
269
  "patternProperties": {
@@ -264,6 +272,14 @@
264
272
  }
265
273
  }
266
274
  },
275
+ "deviceCreate": {
276
+ "type": "object",
277
+ "patternProperties": {
278
+ ".*": {
279
+ "type": "number"
280
+ }
281
+ }
282
+ },
267
283
  "deviceCommand": {
268
284
  "type": "object",
269
285
  "patternProperties": {
@@ -320,6 +336,14 @@
320
336
  }
321
337
  }
322
338
  },
339
+ "inboundEmail": {
340
+ "type": "object",
341
+ "patternProperties": {
342
+ ".*": {
343
+ "type": "number"
344
+ }
345
+ }
346
+ },
323
347
  "integration": {
324
348
  "type": "object",
325
349
  "patternProperties": {
@@ -352,7 +376,7 @@
352
376
  }
353
377
  }
354
378
  },
355
- "timer": {
379
+ "resourceJob": {
356
380
  "type": "object",
357
381
  "patternProperties": {
358
382
  ".*": {
@@ -360,7 +384,7 @@
360
384
  }
361
385
  }
362
386
  },
363
- "virtualButton": {
387
+ "timer": {
364
388
  "type": "object",
365
389
  "patternProperties": {
366
390
  ".*": {
@@ -368,7 +392,7 @@
368
392
  }
369
393
  }
370
394
  },
371
- "webhook": {
395
+ "virtualButton": {
372
396
  "type": "object",
373
397
  "patternProperties": {
374
398
  ".*": {
@@ -376,7 +400,7 @@
376
400
  }
377
401
  }
378
402
  },
379
- "resourceJob": {
403
+ "webhook": {
380
404
  "type": "object",
381
405
  "patternProperties": {
382
406
  ".*": {
@@ -493,6 +517,41 @@
493
517
  }
494
518
  },
495
519
  "additionalProperties": false
520
+ },
521
+ "planId": {
522
+ "type": "string",
523
+ "maxLength": 1024
524
+ },
525
+ "customerId": {
526
+ "type": "string",
527
+ "maxLength": 1024
528
+ },
529
+ "subscriptionId": {
530
+ "type": "string",
531
+ "maxLength": 1024
532
+ },
533
+ "billingEmail": {
534
+ "type": "string",
535
+ "format": "email",
536
+ "maxLength": 1024
537
+ },
538
+ "subscriptionStatus": {
539
+ "type": "string",
540
+ "enum": [
541
+ "trialing",
542
+ "active",
543
+ "past_due",
544
+ "canceled",
545
+ "unpaid"
546
+ ]
547
+ },
548
+ "currentPeriodStart": {
549
+ "type": "string",
550
+ "format": "date-time"
551
+ },
552
+ "currentPeriodEnd": {
553
+ "type": "string",
554
+ "format": "date-time"
496
555
  }
497
556
  },
498
557
  "additionalProperties": false,
data/schemas/instanceOrgs.json CHANGED
@@ -263,6 +263,14 @@
263
263
  "description": "Schema for the result of a payload stats request",
264
264
  "type": "object",
265
265
  "properties": {
266
+ "appFile": {
267
+ "type": "object",
268
+ "patternProperties": {
269
+ ".*": {
270
+ "type": "number"
271
+ }
272
+ }
273
+ },
266
274
  "dataTable": {
267
275
  "type": "object",
268
276
  "patternProperties": {
@@ -271,6 +279,14 @@
271
279
  }
272
280
  }
273
281
  },
282
+ "deviceCreate": {
283
+ "type": "object",
284
+ "patternProperties": {
285
+ ".*": {
286
+ "type": "number"
287
+ }
288
+ }
289
+ },
274
290
  "deviceCommand": {
275
291
  "type": "object",
276
292
  "patternProperties": {
@@ -327,6 +343,14 @@
327
343
  }
328
344
  }
329
345
  },
346
+ "inboundEmail": {
347
+ "type": "object",
348
+ "patternProperties": {
349
+ ".*": {
350
+ "type": "number"
351
+ }
352
+ }
353
+ },
330
354
  "integration": {
331
355
  "type": "object",
332
356
  "patternProperties": {
@@ -359,7 +383,7 @@
359
383
  }
360
384
  }
361
385
  },
362
- "timer": {
386
+ "resourceJob": {
363
387
  "type": "object",
364
388
  "patternProperties": {
365
389
  ".*": {
@@ -367,7 +391,7 @@
367
391
  }
368
392
  }
369
393
  },
370
- "virtualButton": {
394
+ "timer": {
371
395
  "type": "object",
372
396
  "patternProperties": {
373
397
  ".*": {
@@ -375,7 +399,7 @@
375
399
  }
376
400
  }
377
401
  },
378
- "webhook": {
402
+ "virtualButton": {
379
403
  "type": "object",
380
404
  "patternProperties": {
381
405
  ".*": {
@@ -383,7 +407,7 @@
383
407
  }
384
408
  }
385
409
  },
386
- "resourceJob": {
410
+ "webhook": {
387
411
  "type": "object",
388
412
  "patternProperties": {
389
413
  ".*": {
@@ -500,6 +524,41 @@
500
524
  }
501
525
  },
502
526
  "additionalProperties": false
527
+ },
528
+ "planId": {
529
+ "type": "string",
530
+ "maxLength": 1024
531
+ },
532
+ "customerId": {
533
+ "type": "string",
534
+ "maxLength": 1024
535
+ },
536
+ "subscriptionId": {
537
+ "type": "string",
538
+ "maxLength": 1024
539
+ },
540
+ "billingEmail": {
541
+ "type": "string",
542
+ "format": "email",
543
+ "maxLength": 1024
544
+ },
545
+ "subscriptionStatus": {
546
+ "type": "string",
547
+ "enum": [
548
+ "trialing",
549
+ "active",
550
+ "past_due",
551
+ "canceled",
552
+ "unpaid"
553
+ ]
554
+ },
555
+ "currentPeriodStart": {
556
+ "type": "string",
557
+ "format": "date-time"
558
+ },
559
+ "currentPeriodEnd": {
560
+ "type": "string",
561
+ "format": "date-time"
503
562
  }
504
563
  },
505
564
  "additionalProperties": false,
data/schemas/instanceSandbox.json CHANGED
@@ -291,6 +291,14 @@
291
291
  "description": "Schema for the result of a payload stats request",
292
292
  "type": "object",
293
293
  "properties": {
294
+ "appFile": {
295
+ "type": "object",
296
+ "patternProperties": {
297
+ ".*": {
298
+ "type": "number"
299
+ }
300
+ }
301
+ },
294
302
  "dataTable": {
295
303
  "type": "object",
296
304
  "patternProperties": {
@@ -299,6 +307,14 @@
299
307
  }
300
308
  }
301
309
  },
310
+ "deviceCreate": {
311
+ "type": "object",
312
+ "patternProperties": {
313
+ ".*": {
314
+ "type": "number"
315
+ }
316
+ }
317
+ },
302
318
  "deviceCommand": {
303
319
  "type": "object",
304
320
  "patternProperties": {
@@ -355,6 +371,14 @@
355
371
  }
356
372
  }
357
373
  },
374
+ "inboundEmail": {
375
+ "type": "object",
376
+ "patternProperties": {
377
+ ".*": {
378
+ "type": "number"
379
+ }
380
+ }
381
+ },
358
382
  "integration": {
359
383
  "type": "object",
360
384
  "patternProperties": {
@@ -387,7 +411,7 @@
387
411
  }
388
412
  }
389
413
  },
390
- "timer": {
414
+ "resourceJob": {
391
415
  "type": "object",
392
416
  "patternProperties": {
393
417
  ".*": {
@@ -395,7 +419,7 @@
395
419
  }
396
420
  }
397
421
  },
398
- "virtualButton": {
422
+ "timer": {
399
423
  "type": "object",
400
424
  "patternProperties": {
401
425
  ".*": {
@@ -403,7 +427,7 @@
403
427
  }
404
428
  }
405
429
  },
406
- "webhook": {
430
+ "virtualButton": {
407
431
  "type": "object",
408
432
  "patternProperties": {
409
433
  ".*": {
@@ -411,7 +435,7 @@
411
435
  }
412
436
  }
413
437
  },
414
- "resourceJob": {
438
+ "webhook": {
415
439
  "type": "object",
416
440
  "patternProperties": {
417
441
  ".*": {
data/schemas/instanceSandboxes.json CHANGED
@@ -298,6 +298,14 @@
298
298
  "description": "Schema for the result of a payload stats request",
299
299
  "type": "object",
300
300
  "properties": {
301
+ "appFile": {
302
+ "type": "object",
303
+ "patternProperties": {
304
+ ".*": {
305
+ "type": "number"
306
+ }
307
+ }
308
+ },
301
309
  "dataTable": {
302
310
  "type": "object",
303
311
  "patternProperties": {
@@ -306,6 +314,14 @@
306
314
  }
307
315
  }
308
316
  },
317
+ "deviceCreate": {
318
+ "type": "object",
319
+ "patternProperties": {
320
+ ".*": {
321
+ "type": "number"
322
+ }
323
+ }
324
+ },
309
325
  "deviceCommand": {
310
326
  "type": "object",
311
327
  "patternProperties": {
@@ -362,6 +378,14 @@
362
378
  }
363
379
  }
364
380
  },
381
+ "inboundEmail": {
382
+ "type": "object",
383
+ "patternProperties": {
384
+ ".*": {
385
+ "type": "number"
386
+ }
387
+ }
388
+ },
365
389
  "integration": {
366
390
  "type": "object",
367
391
  "patternProperties": {
@@ -394,7 +418,7 @@
394
418
  }
395
419
  }
396
420
  },
397
- "timer": {
421
+ "resourceJob": {
398
422
  "type": "object",
399
423
  "patternProperties": {
400
424
  ".*": {
@@ -402,7 +426,7 @@
402
426
  }
403
427
  }
404
428
  },
405
- "virtualButton": {
429
+ "timer": {
406
430
  "type": "object",
407
431
  "patternProperties": {
408
432
  ".*": {
@@ -410,7 +434,7 @@
410
434
  }
411
435
  }
412
436
  },
413
- "webhook": {
437
+ "virtualButton": {
414
438
  "type": "object",
415
439
  "patternProperties": {
416
440
  ".*": {
@@ -418,7 +442,7 @@
418
442
  }
419
443
  }
420
444
  },
421
- "resourceJob": {
445
+ "webhook": {
422
446
  "type": "object",
423
447
  "patternProperties": {
424
448
  ".*": {