losant_rest 1.10.1 → 1.11.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (135) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/_schemas.md +26941 -15658
  4. data/docs/application.md +42 -0
  5. data/docs/applicationApiTokens.md +2 -2
  6. data/docs/applicationCertificateAuthorities.md +1 -1
  7. data/docs/applicationCertificates.md +1 -1
  8. data/docs/applicationKeys.md +1 -1
  9. data/docs/applicationTemplate.md +46 -0
  10. data/docs/applicationTemplates.md +77 -2
  11. data/docs/applications.md +1 -1
  12. data/docs/auditLogs.md +1 -1
  13. data/docs/dashboards.md +1 -1
  14. data/docs/dataTables.md +1 -1
  15. data/docs/device.md +6 -3
  16. data/docs/deviceRecipes.md +1 -1
  17. data/docs/devices.md +217 -5
  18. data/docs/edgeDeployments.md +1 -1
  19. data/docs/events.md +1 -1
  20. data/docs/experienceEndpoints.md +1 -0
  21. data/docs/experienceGroups.md +1 -1
  22. data/docs/experienceUsers.md +1 -1
  23. data/docs/experienceVersions.md +1 -1
  24. data/docs/experienceViews.md +1 -1
  25. data/docs/file.md +4 -4
  26. data/docs/files.md +1 -1
  27. data/docs/flow.md +94 -1
  28. data/docs/flowVersion.md +96 -1
  29. data/docs/flowVersions.md +2 -1
  30. data/docs/flows.md +4 -2
  31. data/docs/integrations.md +1 -1
  32. data/docs/me.md +0 -36
  33. data/docs/notebooks.md +1 -1
  34. data/docs/orgs.md +1 -1
  35. data/docs/webhooks.md +1 -1
  36. data/lib/losant_rest.rb +1 -0
  37. data/lib/losant_rest/application.rb +48 -0
  38. data/lib/losant_rest/application_api_tokens.rb +1 -1
  39. data/lib/losant_rest/application_template.rb +79 -0
  40. data/lib/losant_rest/application_templates.rb +89 -1
  41. data/lib/losant_rest/client.rb +6 -2
  42. data/lib/losant_rest/device.rb +9 -3
  43. data/lib/losant_rest/devices.rb +255 -3
  44. data/lib/losant_rest/experience_endpoints.rb +2 -0
  45. data/lib/losant_rest/file.rb +3 -3
  46. data/lib/losant_rest/flow.rb +115 -1
  47. data/lib/losant_rest/flow_version.rb +115 -1
  48. data/lib/losant_rest/flow_versions.rb +3 -0
  49. data/lib/losant_rest/flows.rb +6 -0
  50. data/lib/losant_rest/me.rb +0 -41
  51. data/lib/losant_rest/version.rb +1 -1
  52. data/schemas/advancedDeviceQuery.json +110 -0
  53. data/schemas/advancedEventQuery.json +198 -0
  54. data/schemas/advancedFlowByVersionQuery.json +665 -0
  55. data/schemas/advancedFlowQuery.json +665 -0
  56. data/schemas/advancedFlowVersionQuery.json +707 -0
  57. data/schemas/advancedQuery.json +22 -0
  58. data/schemas/application.json +8 -0
  59. data/schemas/applicationApiTokenPost.json +11 -1
  60. data/schemas/applicationApplyTemplatePatch.json +19 -0
  61. data/schemas/applicationCreationByTemplateResult.json +8 -0
  62. data/schemas/applicationPost.json +8 -0
  63. data/schemas/applicationTemplate.json +20 -0
  64. data/schemas/applicationTemplateCategories.json +43 -0
  65. data/schemas/applicationTemplateCategory.json +23 -0
  66. data/schemas/applicationTemplates.json +32 -0
  67. data/schemas/applications.json +8 -0
  68. data/schemas/attributeNamesResponse.json +14 -0
  69. data/schemas/authedUser.json +3 -0
  70. data/schemas/changePassword.json +2 -2
  71. data/schemas/dashboard.json +175 -25
  72. data/schemas/dashboardPatch.json +175 -25
  73. data/schemas/dashboardPost.json +175 -25
  74. data/schemas/dashboards.json +175 -25
  75. data/schemas/dataExport.json +142 -0
  76. data/schemas/dataTableRowsExport.json +22 -0
  77. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  78. data/schemas/deviceClassFilter.json +1 -2
  79. data/schemas/devicesDataRemoved.json +12 -0
  80. data/schemas/devicesDeletePost.json +1034 -0
  81. data/schemas/devicesDeleted.json +12 -0
  82. data/schemas/devicesExportPost.json +1035 -0
  83. data/schemas/devicesPatch.json +1757 -4
  84. data/schemas/devicesRemoveDataPost.json +1056 -0
  85. data/schemas/devicesUpdated.json +18 -0
  86. data/schemas/eventPost.json +22 -0
  87. data/schemas/eventsExport.json +198 -0
  88. data/schemas/experienceDomain.json +1 -1
  89. data/schemas/experienceDomainPatch.json +1 -1
  90. data/schemas/experienceDomainPost.json +1 -1
  91. data/schemas/experienceDomains.json +1 -1
  92. data/schemas/experienceLinkedResources.json +96 -0
  93. data/schemas/experienceVersion.json +10 -1
  94. data/schemas/experienceVersionPatch.json +9 -0
  95. data/schemas/experienceVersions.json +10 -1
  96. data/schemas/flow.json +32 -0
  97. data/schemas/flowErrors.json +87 -0
  98. data/schemas/flowPatch.json +32 -0
  99. data/schemas/flowPost.json +32 -0
  100. data/schemas/flowStats.json +54 -0
  101. data/schemas/flowVersion.json +64 -0
  102. data/schemas/flowVersionPost.json +32 -0
  103. data/schemas/flowVersions.json +64 -0
  104. data/schemas/flows.json +32 -0
  105. data/schemas/flowsImportPost.json +64 -0
  106. data/schemas/flowsImportResult.json +96 -0
  107. data/schemas/githubLogin.json +17 -4
  108. data/schemas/integration.json +3 -0
  109. data/schemas/integrationPatch.json +3 -0
  110. data/schemas/integrationPost.json +3 -0
  111. data/schemas/integrations.json +3 -0
  112. data/schemas/me.json +3 -3
  113. data/schemas/mePatch.json +2 -2
  114. data/schemas/multiDeviceCommand.json +1019 -0
  115. data/schemas/notebook.json +96 -0
  116. data/schemas/notebookExecutionLogs.json +7 -0
  117. data/schemas/notebookPatch.json +96 -0
  118. data/schemas/notebookPost.json +96 -0
  119. data/schemas/notebooks.json +96 -0
  120. data/schemas/org.json +1 -1
  121. data/schemas/orgInviteInfo.json +3 -0
  122. data/schemas/orgInvitePost.json +3 -0
  123. data/schemas/orgInvites.json +3 -0
  124. data/schemas/orgPatch.json +1 -1
  125. data/schemas/orgs.json +1 -1
  126. data/schemas/passwordResetFinish.json +2 -2
  127. data/schemas/samlResponse.json +1 -1
  128. data/schemas/tagKeysResponse.json +14 -0
  129. data/schemas/tagValuesResponse.json +19 -0
  130. data/schemas/templateKeywords.json +14 -0
  131. data/schemas/timeSeriesData.json +12 -2
  132. data/schemas/timeSeriesQuery.json +94 -14
  133. data/schemas/userCredentials.json +15 -3
  134. data/schemas/userPost.json +23 -7
  135. metadata +27 -6
@@ -905,6 +905,17 @@
905
905
  },
906
906
  "config": {
907
907
  "type": "object",
908
+ "properties": {
909
+ "scope": {
910
+ "type": "string",
911
+ "enum": [
912
+ "local",
913
+ "global",
914
+ "experience",
915
+ "cloud"
916
+ ]
917
+ }
918
+ },
908
919
  "additionalProperties": false
909
920
  },
910
921
  "meta": {
@@ -1369,6 +1380,19 @@
1369
1380
  "baudRate": {
1370
1381
  "type": "number"
1371
1382
  },
1383
+ "dataBits": {
1384
+ "type": "number"
1385
+ },
1386
+ "stopBits": {
1387
+ "type": "number"
1388
+ },
1389
+ "parity": {
1390
+ "type": "string",
1391
+ "maxLength": 8
1392
+ },
1393
+ "rtscts": {
1394
+ "type": "boolean"
1395
+ },
1372
1396
  "encoding": {
1373
1397
  "type": "string",
1374
1398
  "maxLength": 48
@@ -1377,6 +1401,10 @@
1377
1401
  "type": "string",
1378
1402
  "maxLength": 1024
1379
1403
  },
1404
+ "writeOnOpenEncoding": {
1405
+ "type": "string",
1406
+ "maxLength": 48
1407
+ },
1380
1408
  "byteLength": {
1381
1409
  "type": "string",
1382
1410
  "maxLength": 48
@@ -1384,6 +1412,10 @@
1384
1412
  "delimiter": {
1385
1413
  "type": "string",
1386
1414
  "maxLength": 48
1415
+ },
1416
+ "delimiterEncoding": {
1417
+ "type": "string",
1418
+ "maxLength": 48
1387
1419
  }
1388
1420
  },
1389
1421
  "additionalProperties": false
@@ -939,6 +939,17 @@
939
939
  },
940
940
  "config": {
941
941
  "type": "object",
942
+ "properties": {
943
+ "scope": {
944
+ "type": "string",
945
+ "enum": [
946
+ "local",
947
+ "global",
948
+ "experience",
949
+ "cloud"
950
+ ]
951
+ }
952
+ },
942
953
  "additionalProperties": false
943
954
  },
944
955
  "meta": {
@@ -1403,6 +1414,19 @@
1403
1414
  "baudRate": {
1404
1415
  "type": "number"
1405
1416
  },
1417
+ "dataBits": {
1418
+ "type": "number"
1419
+ },
1420
+ "stopBits": {
1421
+ "type": "number"
1422
+ },
1423
+ "parity": {
1424
+ "type": "string",
1425
+ "maxLength": 8
1426
+ },
1427
+ "rtscts": {
1428
+ "type": "boolean"
1429
+ },
1406
1430
  "encoding": {
1407
1431
  "type": "string",
1408
1432
  "maxLength": 48
@@ -1411,6 +1435,10 @@
1411
1435
  "type": "string",
1412
1436
  "maxLength": 1024
1413
1437
  },
1438
+ "writeOnOpenEncoding": {
1439
+ "type": "string",
1440
+ "maxLength": 48
1441
+ },
1414
1442
  "byteLength": {
1415
1443
  "type": "string",
1416
1444
  "maxLength": 48
@@ -1418,6 +1446,10 @@
1418
1446
  "delimiter": {
1419
1447
  "type": "string",
1420
1448
  "maxLength": 48
1449
+ },
1450
+ "delimiterEncoding": {
1451
+ "type": "string",
1452
+ "maxLength": 48
1421
1453
  }
1422
1454
  },
1423
1455
  "additionalProperties": false
@@ -3105,6 +3137,17 @@
3105
3137
  },
3106
3138
  "config": {
3107
3139
  "type": "object",
3140
+ "properties": {
3141
+ "scope": {
3142
+ "type": "string",
3143
+ "enum": [
3144
+ "local",
3145
+ "global",
3146
+ "experience",
3147
+ "cloud"
3148
+ ]
3149
+ }
3150
+ },
3108
3151
  "additionalProperties": false
3109
3152
  },
3110
3153
  "meta": {
@@ -3569,6 +3612,19 @@
3569
3612
  "baudRate": {
3570
3613
  "type": "number"
3571
3614
  },
3615
+ "dataBits": {
3616
+ "type": "number"
3617
+ },
3618
+ "stopBits": {
3619
+ "type": "number"
3620
+ },
3621
+ "parity": {
3622
+ "type": "string",
3623
+ "maxLength": 8
3624
+ },
3625
+ "rtscts": {
3626
+ "type": "boolean"
3627
+ },
3572
3628
  "encoding": {
3573
3629
  "type": "string",
3574
3630
  "maxLength": 48
@@ -3577,6 +3633,10 @@
3577
3633
  "type": "string",
3578
3634
  "maxLength": 1024
3579
3635
  },
3636
+ "writeOnOpenEncoding": {
3637
+ "type": "string",
3638
+ "maxLength": 48
3639
+ },
3580
3640
  "byteLength": {
3581
3641
  "type": "string",
3582
3642
  "maxLength": 48
@@ -3584,6 +3644,10 @@
3584
3644
  "delimiter": {
3585
3645
  "type": "string",
3586
3646
  "maxLength": 48
3647
+ },
3648
+ "delimiterEncoding": {
3649
+ "type": "string",
3650
+ "maxLength": 48
3587
3651
  }
3588
3652
  },
3589
3653
  "additionalProperties": false
@@ -954,6 +954,17 @@
954
954
  },
955
955
  "config": {
956
956
  "type": "object",
957
+ "properties": {
958
+ "scope": {
959
+ "type": "string",
960
+ "enum": [
961
+ "local",
962
+ "global",
963
+ "experience",
964
+ "cloud"
965
+ ]
966
+ }
967
+ },
957
968
  "additionalProperties": false
958
969
  },
959
970
  "meta": {
@@ -1418,6 +1429,19 @@
1418
1429
  "baudRate": {
1419
1430
  "type": "number"
1420
1431
  },
1432
+ "dataBits": {
1433
+ "type": "number"
1434
+ },
1435
+ "stopBits": {
1436
+ "type": "number"
1437
+ },
1438
+ "parity": {
1439
+ "type": "string",
1440
+ "maxLength": 8
1441
+ },
1442
+ "rtscts": {
1443
+ "type": "boolean"
1444
+ },
1421
1445
  "encoding": {
1422
1446
  "type": "string",
1423
1447
  "maxLength": 48
@@ -1426,6 +1450,10 @@
1426
1450
  "type": "string",
1427
1451
  "maxLength": 1024
1428
1452
  },
1453
+ "writeOnOpenEncoding": {
1454
+ "type": "string",
1455
+ "maxLength": 48
1456
+ },
1429
1457
  "byteLength": {
1430
1458
  "type": "string",
1431
1459
  "maxLength": 48
@@ -1433,6 +1461,10 @@
1433
1461
  "delimiter": {
1434
1462
  "type": "string",
1435
1463
  "maxLength": 48
1464
+ },
1465
+ "delimiterEncoding": {
1466
+ "type": "string",
1467
+ "maxLength": 48
1436
1468
  }
1437
1469
  },
1438
1470
  "additionalProperties": false
@@ -924,6 +924,17 @@
924
924
  },
925
925
  "config": {
926
926
  "type": "object",
927
+ "properties": {
928
+ "scope": {
929
+ "type": "string",
930
+ "enum": [
931
+ "local",
932
+ "global",
933
+ "experience",
934
+ "cloud"
935
+ ]
936
+ }
937
+ },
927
938
  "additionalProperties": false
928
939
  },
929
940
  "meta": {
@@ -1388,6 +1399,19 @@
1388
1399
  "baudRate": {
1389
1400
  "type": "number"
1390
1401
  },
1402
+ "dataBits": {
1403
+ "type": "number"
1404
+ },
1405
+ "stopBits": {
1406
+ "type": "number"
1407
+ },
1408
+ "parity": {
1409
+ "type": "string",
1410
+ "maxLength": 8
1411
+ },
1412
+ "rtscts": {
1413
+ "type": "boolean"
1414
+ },
1391
1415
  "encoding": {
1392
1416
  "type": "string",
1393
1417
  "maxLength": 48
@@ -1396,6 +1420,10 @@
1396
1420
  "type": "string",
1397
1421
  "maxLength": 1024
1398
1422
  },
1423
+ "writeOnOpenEncoding": {
1424
+ "type": "string",
1425
+ "maxLength": 48
1426
+ },
1399
1427
  "byteLength": {
1400
1428
  "type": "string",
1401
1429
  "maxLength": 48
@@ -1403,6 +1431,10 @@
1403
1431
  "delimiter": {
1404
1432
  "type": "string",
1405
1433
  "maxLength": 48
1434
+ },
1435
+ "delimiterEncoding": {
1436
+ "type": "string",
1437
+ "maxLength": 48
1406
1438
  }
1407
1439
  },
1408
1440
  "additionalProperties": false
@@ -3071,6 +3103,17 @@
3071
3103
  },
3072
3104
  "config": {
3073
3105
  "type": "object",
3106
+ "properties": {
3107
+ "scope": {
3108
+ "type": "string",
3109
+ "enum": [
3110
+ "local",
3111
+ "global",
3112
+ "experience",
3113
+ "cloud"
3114
+ ]
3115
+ }
3116
+ },
3074
3117
  "additionalProperties": false
3075
3118
  },
3076
3119
  "meta": {
@@ -3535,6 +3578,19 @@
3535
3578
  "baudRate": {
3536
3579
  "type": "number"
3537
3580
  },
3581
+ "dataBits": {
3582
+ "type": "number"
3583
+ },
3584
+ "stopBits": {
3585
+ "type": "number"
3586
+ },
3587
+ "parity": {
3588
+ "type": "string",
3589
+ "maxLength": 8
3590
+ },
3591
+ "rtscts": {
3592
+ "type": "boolean"
3593
+ },
3538
3594
  "encoding": {
3539
3595
  "type": "string",
3540
3596
  "maxLength": 48
@@ -3543,6 +3599,10 @@
3543
3599
  "type": "string",
3544
3600
  "maxLength": 1024
3545
3601
  },
3602
+ "writeOnOpenEncoding": {
3603
+ "type": "string",
3604
+ "maxLength": 48
3605
+ },
3546
3606
  "byteLength": {
3547
3607
  "type": "string",
3548
3608
  "maxLength": 48
@@ -3550,6 +3610,10 @@
3550
3610
  "delimiter": {
3551
3611
  "type": "string",
3552
3612
  "maxLength": 48
3613
+ },
3614
+ "delimiterEncoding": {
3615
+ "type": "string",
3616
+ "maxLength": 48
3553
3617
  }
3554
3618
  },
3555
3619
  "additionalProperties": false
@@ -955,6 +955,17 @@
955
955
  },
956
956
  "config": {
957
957
  "type": "object",
958
+ "properties": {
959
+ "scope": {
960
+ "type": "string",
961
+ "enum": [
962
+ "local",
963
+ "global",
964
+ "experience",
965
+ "cloud"
966
+ ]
967
+ }
968
+ },
958
969
  "additionalProperties": false
959
970
  },
960
971
  "meta": {
@@ -1419,6 +1430,19 @@
1419
1430
  "baudRate": {
1420
1431
  "type": "number"
1421
1432
  },
1433
+ "dataBits": {
1434
+ "type": "number"
1435
+ },
1436
+ "stopBits": {
1437
+ "type": "number"
1438
+ },
1439
+ "parity": {
1440
+ "type": "string",
1441
+ "maxLength": 8
1442
+ },
1443
+ "rtscts": {
1444
+ "type": "boolean"
1445
+ },
1422
1446
  "encoding": {
1423
1447
  "type": "string",
1424
1448
  "maxLength": 48
@@ -1427,6 +1451,10 @@
1427
1451
  "type": "string",
1428
1452
  "maxLength": 1024
1429
1453
  },
1454
+ "writeOnOpenEncoding": {
1455
+ "type": "string",
1456
+ "maxLength": 48
1457
+ },
1430
1458
  "byteLength": {
1431
1459
  "type": "string",
1432
1460
  "maxLength": 48
@@ -1434,6 +1462,10 @@
1434
1462
  "delimiter": {
1435
1463
  "type": "string",
1436
1464
  "maxLength": 48
1465
+ },
1466
+ "delimiterEncoding": {
1467
+ "type": "string",
1468
+ "maxLength": 48
1437
1469
  }
1438
1470
  },
1439
1471
  "additionalProperties": false
@@ -3121,6 +3153,17 @@
3121
3153
  },
3122
3154
  "config": {
3123
3155
  "type": "object",
3156
+ "properties": {
3157
+ "scope": {
3158
+ "type": "string",
3159
+ "enum": [
3160
+ "local",
3161
+ "global",
3162
+ "experience",
3163
+ "cloud"
3164
+ ]
3165
+ }
3166
+ },
3124
3167
  "additionalProperties": false
3125
3168
  },
3126
3169
  "meta": {
@@ -3585,6 +3628,19 @@
3585
3628
  "baudRate": {
3586
3629
  "type": "number"
3587
3630
  },
3631
+ "dataBits": {
3632
+ "type": "number"
3633
+ },
3634
+ "stopBits": {
3635
+ "type": "number"
3636
+ },
3637
+ "parity": {
3638
+ "type": "string",
3639
+ "maxLength": 8
3640
+ },
3641
+ "rtscts": {
3642
+ "type": "boolean"
3643
+ },
3588
3644
  "encoding": {
3589
3645
  "type": "string",
3590
3646
  "maxLength": 48
@@ -3593,6 +3649,10 @@
3593
3649
  "type": "string",
3594
3650
  "maxLength": 1024
3595
3651
  },
3652
+ "writeOnOpenEncoding": {
3653
+ "type": "string",
3654
+ "maxLength": 48
3655
+ },
3596
3656
  "byteLength": {
3597
3657
  "type": "string",
3598
3658
  "maxLength": 48
@@ -3600,6 +3660,10 @@
3600
3660
  "delimiter": {
3601
3661
  "type": "string",
3602
3662
  "maxLength": 48
3663
+ },
3664
+ "delimiterEncoding": {
3665
+ "type": "string",
3666
+ "maxLength": 48
3603
3667
  }
3604
3668
  },
3605
3669
  "additionalProperties": false
@@ -5287,6 +5351,17 @@
5287
5351
  },
5288
5352
  "config": {
5289
5353
  "type": "object",
5354
+ "properties": {
5355
+ "scope": {
5356
+ "type": "string",
5357
+ "enum": [
5358
+ "local",
5359
+ "global",
5360
+ "experience",
5361
+ "cloud"
5362
+ ]
5363
+ }
5364
+ },
5290
5365
  "additionalProperties": false
5291
5366
  },
5292
5367
  "meta": {
@@ -5751,6 +5826,19 @@
5751
5826
  "baudRate": {
5752
5827
  "type": "number"
5753
5828
  },
5829
+ "dataBits": {
5830
+ "type": "number"
5831
+ },
5832
+ "stopBits": {
5833
+ "type": "number"
5834
+ },
5835
+ "parity": {
5836
+ "type": "string",
5837
+ "maxLength": 8
5838
+ },
5839
+ "rtscts": {
5840
+ "type": "boolean"
5841
+ },
5754
5842
  "encoding": {
5755
5843
  "type": "string",
5756
5844
  "maxLength": 48
@@ -5759,6 +5847,10 @@
5759
5847
  "type": "string",
5760
5848
  "maxLength": 1024
5761
5849
  },
5850
+ "writeOnOpenEncoding": {
5851
+ "type": "string",
5852
+ "maxLength": 48
5853
+ },
5762
5854
  "byteLength": {
5763
5855
  "type": "string",
5764
5856
  "maxLength": 48
@@ -5766,6 +5858,10 @@
5766
5858
  "delimiter": {
5767
5859
  "type": "string",
5768
5860
  "maxLength": 48
5861
+ },
5862
+ "delimiterEncoding": {
5863
+ "type": "string",
5864
+ "maxLength": 48
5769
5865
  }
5770
5866
  },
5771
5867
  "additionalProperties": false