losant_rest 1.9.2 → 1.10.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +38445 -24043
  3. data/docs/application.md +124 -2
  4. data/docs/applicationTemplates.md +50 -0
  5. data/docs/auth.md +72 -0
  6. data/docs/device.md +1 -0
  7. data/docs/devices.md +92 -3
  8. data/docs/experienceEndpoints.md +1 -0
  9. data/docs/file.md +4 -4
  10. data/docs/flow.md +94 -1
  11. data/docs/flowVersion.md +96 -1
  12. data/lib/losant_rest.rb +1 -0
  13. data/lib/losant_rest/application.rb +93 -2
  14. data/lib/losant_rest/application_templates.rb +88 -0
  15. data/lib/losant_rest/auth.rb +84 -0
  16. data/lib/losant_rest/client.rb +6 -2
  17. data/lib/losant_rest/device.rb +2 -0
  18. data/lib/losant_rest/devices.rb +105 -2
  19. data/lib/losant_rest/experience_endpoints.rb +2 -0
  20. data/lib/losant_rest/file.rb +3 -3
  21. data/lib/losant_rest/flow.rb +115 -1
  22. data/lib/losant_rest/flow_version.rb +115 -1
  23. data/lib/losant_rest/version.rb +2 -2
  24. data/schemas/advancedDeviceQuery.json +1018 -0
  25. data/schemas/advancedEventQuery.json +382 -13
  26. data/schemas/advancedQuery.json +37 -3
  27. data/schemas/application.json +7 -2
  28. data/schemas/applicationApiTokenPost.json +8 -1
  29. data/schemas/applicationCreationByTemplateResult.json +7 -2
  30. data/schemas/applicationPatch.json +7 -2
  31. data/schemas/applicationPost.json +11 -2
  32. data/schemas/applicationReadme.json +29 -0
  33. data/schemas/applicationReadmePatch.json +11 -0
  34. data/schemas/applicationTemplate.json +99 -0
  35. data/schemas/applicationTemplates.json +140 -0
  36. data/schemas/applications.json +7 -2
  37. data/schemas/dashboard.json +1168 -144
  38. data/schemas/dashboardPatch.json +1168 -144
  39. data/schemas/dashboardPost.json +1168 -144
  40. data/schemas/dashboards.json +1168 -144
  41. data/schemas/dataExport.json +11 -0
  42. data/schemas/dataTableRows.json +3 -0
  43. data/schemas/dataTableRowsExport.json +37 -3
  44. data/schemas/device.json +16 -3
  45. data/schemas/devicePatch.json +16 -3
  46. data/schemas/devicePost.json +16 -3
  47. data/schemas/deviceRecipe.json +16 -3
  48. data/schemas/deviceRecipePatch.json +16 -3
  49. data/schemas/deviceRecipePost.json +16 -3
  50. data/schemas/deviceRecipes.json +16 -3
  51. data/schemas/devices.json +19 -3
  52. data/schemas/devicesDataRemoved.json +12 -0
  53. data/schemas/devicesDeletePost.json +1034 -0
  54. data/schemas/devicesDeleted.json +12 -0
  55. data/schemas/devicesExportPost.json +1035 -0
  56. data/schemas/devicesPatch.json +1773 -7
  57. data/schemas/devicesRemoveDataPost.json +1056 -0
  58. data/schemas/devicesUpdated.json +18 -0
  59. data/schemas/eventPost.json +22 -0
  60. data/schemas/events.json +1 -816
  61. data/schemas/eventsExport.json +382 -13
  62. data/schemas/experienceDomain.json +1 -1
  63. data/schemas/experienceDomainPatch.json +1 -1
  64. data/schemas/experienceDomainPost.json +1 -1
  65. data/schemas/experienceDomains.json +1 -1
  66. data/schemas/experienceGroup.json +7 -0
  67. data/schemas/experienceGroupPatch.json +7 -0
  68. data/schemas/experienceGroupPost.json +7 -0
  69. data/schemas/experienceGroups.json +7 -0
  70. data/schemas/experienceLinkedResources.json +309 -3
  71. data/schemas/experienceVersion.json +1 -1
  72. data/schemas/experienceVersions.json +1 -1
  73. data/schemas/flow.json +103 -1
  74. data/schemas/flowErrors.json +87 -0
  75. data/schemas/flowPatch.json +103 -1
  76. data/schemas/flowPost.json +103 -1
  77. data/schemas/flowStats.json +54 -0
  78. data/schemas/flowVersion.json +206 -2
  79. data/schemas/flowVersionPost.json +103 -1
  80. data/schemas/flowVersions.json +206 -2
  81. data/schemas/flows.json +103 -1
  82. data/schemas/flowsImportPost.json +206 -2
  83. data/schemas/flowsImportResult.json +309 -3
  84. data/schemas/githubLogin.json +10 -1
  85. data/schemas/me.json +3 -0
  86. data/schemas/multiDeviceCommand.json +1019 -0
  87. data/schemas/notebook.json +99 -2
  88. data/schemas/notebookPatch.json +99 -2
  89. data/schemas/notebookPost.json +99 -2
  90. data/schemas/notebooks.json +99 -2
  91. data/schemas/org.json +8 -0
  92. data/schemas/orgPatch.json +9 -0
  93. data/schemas/orgs.json +8 -0
  94. data/schemas/samlResponse.json +21 -0
  95. data/schemas/ssoRequest.json +20 -0
  96. data/schemas/timeSeriesData.json +91 -12
  97. data/schemas/timeSeriesQuery.json +21 -12
  98. data/schemas/userCredentials.json +10 -1
  99. data/schemas/userPost.json +10 -1
  100. metadata +20 -4
@@ -34,7 +34,7 @@
34
34
  },
35
35
  "domainName": {
36
36
  "type": "string",
37
- "maxLength": 1024,
37
+ "maxLength": 45,
38
38
  "minLength": 3
39
39
  },
40
40
  "version": {
@@ -52,7 +52,7 @@
52
52
  },
53
53
  "domainName": {
54
54
  "type": "string",
55
- "maxLength": 1024,
55
+ "maxLength": 45,
56
56
  "minLength": 3
57
57
  }
58
58
  },
@@ -19,7 +19,7 @@
19
19
  },
20
20
  "domainName": {
21
21
  "type": "string",
22
- "maxLength": 1024,
22
+ "maxLength": 45,
23
23
  "minLength": 3
24
24
  },
25
25
  "version": {
@@ -41,7 +41,7 @@
41
41
  },
42
42
  "domainName": {
43
43
  "type": "string",
44
- "maxLength": 1024,
44
+ "maxLength": 45,
45
45
  "minLength": 3
46
46
  },
47
47
  "version": {
@@ -85,6 +85,13 @@
85
85
  },
86
86
  "maxItems": 100
87
87
  },
88
+ "deviceQueryJson": {
89
+ "type": [
90
+ "string",
91
+ "null"
92
+ ],
93
+ "maxLength": 8192
94
+ },
88
95
  "parentId": {
89
96
  "oneOf": [
90
97
  {
@@ -65,6 +65,13 @@
65
65
  },
66
66
  "maxItems": 100
67
67
  },
68
+ "deviceQueryJson": {
69
+ "type": [
70
+ "string",
71
+ "null"
72
+ ],
73
+ "maxLength": 8192
74
+ },
68
75
  "parentId": {
69
76
  "oneOf": [
70
77
  {
@@ -65,6 +65,13 @@
65
65
  },
66
66
  "maxItems": 100
67
67
  },
68
+ "deviceQueryJson": {
69
+ "type": [
70
+ "string",
71
+ "null"
72
+ ],
73
+ "maxLength": 8192
74
+ },
68
75
  "parentId": {
69
76
  "oneOf": [
70
77
  {
@@ -92,6 +92,13 @@
92
92
  },
93
93
  "maxItems": 100
94
94
  },
95
+ "deviceQueryJson": {
96
+ "type": [
97
+ "string",
98
+ "null"
99
+ ],
100
+ "maxLength": 8192
101
+ },
95
102
  "parentId": {
96
103
  "oneOf": [
97
104
  {
@@ -460,7 +460,6 @@
460
460
  "deviceIdDisconnect",
461
461
  "deviceTagDisconnect",
462
462
  "integration",
463
- "mqttTopic",
464
463
  "notebook",
465
464
  "onBoot",
466
465
  "onConnect",
@@ -1406,6 +1405,109 @@
1406
1405
  ],
1407
1406
  "additionalProperties": false
1408
1407
  },
1408
+ {
1409
+ "type": "object",
1410
+ "properties": {
1411
+ "key": {
1412
+ "type": "string",
1413
+ "maxLength": 1024
1414
+ },
1415
+ "type": {
1416
+ "type": "string",
1417
+ "enum": [
1418
+ "mqttTopic"
1419
+ ]
1420
+ },
1421
+ "config": {
1422
+ "type": "object",
1423
+ "properties": {
1424
+ "integrationId": {
1425
+ "type": "string",
1426
+ "enum": [
1427
+ "losant",
1428
+ "local"
1429
+ ]
1430
+ }
1431
+ },
1432
+ "additionalProperties": false
1433
+ },
1434
+ "meta": {
1435
+ "type": "object",
1436
+ "properties": {
1437
+ "category": {
1438
+ "type": "string",
1439
+ "enum": [
1440
+ "trigger"
1441
+ ]
1442
+ },
1443
+ "name": {
1444
+ "type": "string",
1445
+ "enum": [
1446
+ "mqtt"
1447
+ ]
1448
+ },
1449
+ "label": {
1450
+ "type": "string",
1451
+ "minLength": 1,
1452
+ "maxLength": 255
1453
+ },
1454
+ "x": {
1455
+ "type": "number"
1456
+ },
1457
+ "y": {
1458
+ "type": "number"
1459
+ },
1460
+ "uiId": {
1461
+ "type": "string",
1462
+ "maxLength": 48
1463
+ },
1464
+ "description": {
1465
+ "type": "string",
1466
+ "maxLength": 32767
1467
+ },
1468
+ "icon": {
1469
+ "type": "string",
1470
+ "maxLength": 1024
1471
+ },
1472
+ "color": {
1473
+ "type": "string",
1474
+ "maxLength": 1024
1475
+ },
1476
+ "inputCount": {
1477
+ "type": "number"
1478
+ },
1479
+ "outputCount": {
1480
+ "type": "number"
1481
+ },
1482
+ "triggerId": {
1483
+ "type": "string",
1484
+ "maxLength": 48
1485
+ },
1486
+ "id": {
1487
+ "type": "string",
1488
+ "maxLength": 48
1489
+ }
1490
+ },
1491
+ "additionalProperties": false
1492
+ },
1493
+ "outputIds": {
1494
+ "type": "array",
1495
+ "items": {
1496
+ "type": "array",
1497
+ "items": {
1498
+ "type": "string",
1499
+ "maxLength": 255
1500
+ },
1501
+ "maxItems": 100
1502
+ },
1503
+ "maxItems": 100
1504
+ }
1505
+ },
1506
+ "required": [
1507
+ "type"
1508
+ ],
1509
+ "additionalProperties": false
1510
+ },
1409
1511
  {
1410
1512
  "type": "object",
1411
1513
  "properties": {
@@ -2574,7 +2676,6 @@
2574
2676
  "deviceIdDisconnect",
2575
2677
  "deviceTagDisconnect",
2576
2678
  "integration",
2577
- "mqttTopic",
2578
2679
  "notebook",
2579
2680
  "onBoot",
2580
2681
  "onConnect",
@@ -3520,6 +3621,109 @@
3520
3621
  ],
3521
3622
  "additionalProperties": false
3522
3623
  },
3624
+ {
3625
+ "type": "object",
3626
+ "properties": {
3627
+ "key": {
3628
+ "type": "string",
3629
+ "maxLength": 1024
3630
+ },
3631
+ "type": {
3632
+ "type": "string",
3633
+ "enum": [
3634
+ "mqttTopic"
3635
+ ]
3636
+ },
3637
+ "config": {
3638
+ "type": "object",
3639
+ "properties": {
3640
+ "integrationId": {
3641
+ "type": "string",
3642
+ "enum": [
3643
+ "losant",
3644
+ "local"
3645
+ ]
3646
+ }
3647
+ },
3648
+ "additionalProperties": false
3649
+ },
3650
+ "meta": {
3651
+ "type": "object",
3652
+ "properties": {
3653
+ "category": {
3654
+ "type": "string",
3655
+ "enum": [
3656
+ "trigger"
3657
+ ]
3658
+ },
3659
+ "name": {
3660
+ "type": "string",
3661
+ "enum": [
3662
+ "mqtt"
3663
+ ]
3664
+ },
3665
+ "label": {
3666
+ "type": "string",
3667
+ "minLength": 1,
3668
+ "maxLength": 255
3669
+ },
3670
+ "x": {
3671
+ "type": "number"
3672
+ },
3673
+ "y": {
3674
+ "type": "number"
3675
+ },
3676
+ "uiId": {
3677
+ "type": "string",
3678
+ "maxLength": 48
3679
+ },
3680
+ "description": {
3681
+ "type": "string",
3682
+ "maxLength": 32767
3683
+ },
3684
+ "icon": {
3685
+ "type": "string",
3686
+ "maxLength": 1024
3687
+ },
3688
+ "color": {
3689
+ "type": "string",
3690
+ "maxLength": 1024
3691
+ },
3692
+ "inputCount": {
3693
+ "type": "number"
3694
+ },
3695
+ "outputCount": {
3696
+ "type": "number"
3697
+ },
3698
+ "triggerId": {
3699
+ "type": "string",
3700
+ "maxLength": 48
3701
+ },
3702
+ "id": {
3703
+ "type": "string",
3704
+ "maxLength": 48
3705
+ }
3706
+ },
3707
+ "additionalProperties": false
3708
+ },
3709
+ "outputIds": {
3710
+ "type": "array",
3711
+ "items": {
3712
+ "type": "array",
3713
+ "items": {
3714
+ "type": "string",
3715
+ "maxLength": 255
3716
+ },
3717
+ "maxItems": 100
3718
+ },
3719
+ "maxItems": 100
3720
+ }
3721
+ },
3722
+ "required": [
3723
+ "type"
3724
+ ],
3725
+ "additionalProperties": false
3726
+ },
3523
3727
  {
3524
3728
  "type": "object",
3525
3729
  "properties": {
@@ -4638,7 +4842,6 @@
4638
4842
  "deviceIdDisconnect",
4639
4843
  "deviceTagDisconnect",
4640
4844
  "integration",
4641
- "mqttTopic",
4642
4845
  "notebook",
4643
4846
  "onBoot",
4644
4847
  "onConnect",
@@ -5584,6 +5787,109 @@
5584
5787
  ],
5585
5788
  "additionalProperties": false
5586
5789
  },
5790
+ {
5791
+ "type": "object",
5792
+ "properties": {
5793
+ "key": {
5794
+ "type": "string",
5795
+ "maxLength": 1024
5796
+ },
5797
+ "type": {
5798
+ "type": "string",
5799
+ "enum": [
5800
+ "mqttTopic"
5801
+ ]
5802
+ },
5803
+ "config": {
5804
+ "type": "object",
5805
+ "properties": {
5806
+ "integrationId": {
5807
+ "type": "string",
5808
+ "enum": [
5809
+ "losant",
5810
+ "local"
5811
+ ]
5812
+ }
5813
+ },
5814
+ "additionalProperties": false
5815
+ },
5816
+ "meta": {
5817
+ "type": "object",
5818
+ "properties": {
5819
+ "category": {
5820
+ "type": "string",
5821
+ "enum": [
5822
+ "trigger"
5823
+ ]
5824
+ },
5825
+ "name": {
5826
+ "type": "string",
5827
+ "enum": [
5828
+ "mqtt"
5829
+ ]
5830
+ },
5831
+ "label": {
5832
+ "type": "string",
5833
+ "minLength": 1,
5834
+ "maxLength": 255
5835
+ },
5836
+ "x": {
5837
+ "type": "number"
5838
+ },
5839
+ "y": {
5840
+ "type": "number"
5841
+ },
5842
+ "uiId": {
5843
+ "type": "string",
5844
+ "maxLength": 48
5845
+ },
5846
+ "description": {
5847
+ "type": "string",
5848
+ "maxLength": 32767
5849
+ },
5850
+ "icon": {
5851
+ "type": "string",
5852
+ "maxLength": 1024
5853
+ },
5854
+ "color": {
5855
+ "type": "string",
5856
+ "maxLength": 1024
5857
+ },
5858
+ "inputCount": {
5859
+ "type": "number"
5860
+ },
5861
+ "outputCount": {
5862
+ "type": "number"
5863
+ },
5864
+ "triggerId": {
5865
+ "type": "string",
5866
+ "maxLength": 48
5867
+ },
5868
+ "id": {
5869
+ "type": "string",
5870
+ "maxLength": 48
5871
+ }
5872
+ },
5873
+ "additionalProperties": false
5874
+ },
5875
+ "outputIds": {
5876
+ "type": "array",
5877
+ "items": {
5878
+ "type": "array",
5879
+ "items": {
5880
+ "type": "string",
5881
+ "maxLength": 255
5882
+ },
5883
+ "maxItems": 100
5884
+ },
5885
+ "maxItems": 100
5886
+ }
5887
+ },
5888
+ "required": [
5889
+ "type"
5890
+ ],
5891
+ "additionalProperties": false
5892
+ },
5587
5893
  {
5588
5894
  "type": "object",
5589
5895
  "properties": {
@@ -53,7 +53,7 @@
53
53
  "properties": {
54
54
  "domainName": {
55
55
  "type": "string",
56
- "maxLength": 1024,
56
+ "maxLength": 45,
57
57
  "minLength": 3
58
58
  },
59
59
  "id": {