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
data/schemas/experienceVersion.json CHANGED
@@ -37,6 +37,15 @@
37
37
  "endpointDefaultCors": {
38
38
  "type": "boolean"
39
39
  },
40
+ "allowedCorsOrigins": {
41
+ "type": "array",
42
+ "items": {
43
+ "type": "string",
44
+ "minLength": 8,
45
+ "maxLength": 270
46
+ },
47
+ "maxItems": 100
48
+ },
40
49
  "version": {
41
50
  "type": "string",
42
51
  "minLength": 1,
@@ -53,7 +62,7 @@
53
62
  "properties": {
54
63
  "domainName": {
55
64
  "type": "string",
56
- "maxLength": 1024,
65
+ "maxLength": 45,
57
66
  "minLength": 3
58
67
  },
59
68
  "id": {
data/schemas/experienceVersionPatch.json CHANGED
@@ -5,6 +5,15 @@
5
5
  "endpointDefaultCors": {
6
6
  "type": "boolean"
7
7
  },
8
+ "allowedCorsOrigins": {
9
+ "type": "array",
10
+ "items": {
11
+ "type": "string",
12
+ "minLength": 8,
13
+ "maxLength": 270
14
+ },
15
+ "maxItems": 100
16
+ },
8
17
  "description": {
9
18
  "type": "string",
10
19
  "maxLength": 32767
data/schemas/experienceVersions.json CHANGED
@@ -44,6 +44,15 @@
44
44
  "endpointDefaultCors": {
45
45
  "type": "boolean"
46
46
  },
47
+ "allowedCorsOrigins": {
48
+ "type": "array",
49
+ "items": {
50
+ "type": "string",
51
+ "minLength": 8,
52
+ "maxLength": 270
53
+ },
54
+ "maxItems": 100
55
+ },
47
56
  "version": {
48
57
  "type": "string",
49
58
  "minLength": 1,
@@ -60,7 +69,7 @@
60
69
  "properties": {
61
70
  "domainName": {
62
71
  "type": "string",
63
- "maxLength": 1024,
72
+ "maxLength": 45,
64
73
  "minLength": 3
65
74
  },
66
75
  "id": {
data/schemas/flow.json CHANGED
@@ -947,6 +947,17 @@
947
947
  },
948
948
  "config": {
949
949
  "type": "object",
950
+ "properties": {
951
+ "scope": {
952
+ "type": "string",
953
+ "enum": [
954
+ "local",
955
+ "global",
956
+ "experience",
957
+ "cloud"
958
+ ]
959
+ }
960
+ },
950
961
  "additionalProperties": false
951
962
  },
952
963
  "meta": {
@@ -1411,6 +1422,19 @@
1411
1422
  "baudRate": {
1412
1423
  "type": "number"
1413
1424
  },
1425
+ "dataBits": {
1426
+ "type": "number"
1427
+ },
1428
+ "stopBits": {
1429
+ "type": "number"
1430
+ },
1431
+ "parity": {
1432
+ "type": "string",
1433
+ "maxLength": 8
1434
+ },
1435
+ "rtscts": {
1436
+ "type": "boolean"
1437
+ },
1414
1438
  "encoding": {
1415
1439
  "type": "string",
1416
1440
  "maxLength": 48
@@ -1419,6 +1443,10 @@
1419
1443
  "type": "string",
1420
1444
  "maxLength": 1024
1421
1445
  },
1446
+ "writeOnOpenEncoding": {
1447
+ "type": "string",
1448
+ "maxLength": 48
1449
+ },
1422
1450
  "byteLength": {
1423
1451
  "type": "string",
1424
1452
  "maxLength": 48
@@ -1426,6 +1454,10 @@
1426
1454
  "delimiter": {
1427
1455
  "type": "string",
1428
1456
  "maxLength": 48
1457
+ },
1458
+ "delimiterEncoding": {
1459
+ "type": "string",
1460
+ "maxLength": 48
1429
1461
  }
1430
1462
  },
1431
1463
  "additionalProperties": false
data/schemas/flowErrors.json ADDED
@@ -0,0 +1,87 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "flowVersion": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "flowVersionId": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ },
14
+ "deviceId": {
15
+ "type": "string",
16
+ "pattern": "^[A-Fa-f\\d]{24}$"
17
+ },
18
+ "start": {
19
+ "type": "string",
20
+ "format": "date-time"
21
+ },
22
+ "end": {
23
+ "type": "string",
24
+ "format": "date-time"
25
+ },
26
+ "limit": {
27
+ "type": "number"
28
+ },
29
+ "sortDirection": {
30
+ "type": "string",
31
+ "enum": [
32
+ "asc",
33
+ "desc",
34
+ "ASC",
35
+ "DESC",
36
+ ""
37
+ ]
38
+ },
39
+ "errors": {
40
+ "type": "array",
41
+ "items": {
42
+ "type": "object",
43
+ "properties": {
44
+ "time": {
45
+ "type": "string",
46
+ "format": "date-time"
47
+ },
48
+ "deviceId": {
49
+ "type": "string",
50
+ "pattern": "^[A-Fa-f\\d]{24}$"
51
+ },
52
+ "deviceName": {
53
+ "type": "string",
54
+ "minLength": 1,
55
+ "maxLength": 255
56
+ },
57
+ "flowVersion": {
58
+ "type": "string",
59
+ "minLength": 1,
60
+ "maxLength": 255
61
+ },
62
+ "flowVersionId": {
63
+ "type": "string",
64
+ "pattern": "^[A-Fa-f\\d]{24}$"
65
+ },
66
+ "nodeId": {
67
+ "type": "string"
68
+ },
69
+ "nodeLabel": {
70
+ "type": "string"
71
+ },
72
+ "error": {
73
+ "type": "object",
74
+ "properties": {
75
+ "name": {
76
+ "type": "string"
77
+ },
78
+ "message": {
79
+ "type": "string"
80
+ }
81
+ }
82
+ }
83
+ }
84
+ }
85
+ }
86
+ }
87
+ }
data/schemas/flowPatch.json CHANGED
@@ -928,6 +928,17 @@
928
928
  },
929
929
  "config": {
930
930
  "type": "object",
931
+ "properties": {
932
+ "scope": {
933
+ "type": "string",
934
+ "enum": [
935
+ "local",
936
+ "global",
937
+ "experience",
938
+ "cloud"
939
+ ]
940
+ }
941
+ },
931
942
  "additionalProperties": false
932
943
  },
933
944
  "meta": {
@@ -1392,6 +1403,19 @@
1392
1403
  "baudRate": {
1393
1404
  "type": "number"
1394
1405
  },
1406
+ "dataBits": {
1407
+ "type": "number"
1408
+ },
1409
+ "stopBits": {
1410
+ "type": "number"
1411
+ },
1412
+ "parity": {
1413
+ "type": "string",
1414
+ "maxLength": 8
1415
+ },
1416
+ "rtscts": {
1417
+ "type": "boolean"
1418
+ },
1395
1419
  "encoding": {
1396
1420
  "type": "string",
1397
1421
  "maxLength": 48
@@ -1400,6 +1424,10 @@
1400
1424
  "type": "string",
1401
1425
  "maxLength": 1024
1402
1426
  },
1427
+ "writeOnOpenEncoding": {
1428
+ "type": "string",
1429
+ "maxLength": 48
1430
+ },
1403
1431
  "byteLength": {
1404
1432
  "type": "string",
1405
1433
  "maxLength": 48
@@ -1407,6 +1435,10 @@
1407
1435
  "delimiter": {
1408
1436
  "type": "string",
1409
1437
  "maxLength": 48
1438
+ },
1439
+ "delimiterEncoding": {
1440
+ "type": "string",
1441
+ "maxLength": 48
1410
1442
  }
1411
1443
  },
1412
1444
  "additionalProperties": false
data/schemas/flowPost.json CHANGED
@@ -917,6 +917,17 @@
917
917
  },
918
918
  "config": {
919
919
  "type": "object",
920
+ "properties": {
921
+ "scope": {
922
+ "type": "string",
923
+ "enum": [
924
+ "local",
925
+ "global",
926
+ "experience",
927
+ "cloud"
928
+ ]
929
+ }
930
+ },
920
931
  "additionalProperties": false
921
932
  },
922
933
  "meta": {
@@ -1381,6 +1392,19 @@
1381
1392
  "baudRate": {
1382
1393
  "type": "number"
1383
1394
  },
1395
+ "dataBits": {
1396
+ "type": "number"
1397
+ },
1398
+ "stopBits": {
1399
+ "type": "number"
1400
+ },
1401
+ "parity": {
1402
+ "type": "string",
1403
+ "maxLength": 8
1404
+ },
1405
+ "rtscts": {
1406
+ "type": "boolean"
1407
+ },
1384
1408
  "encoding": {
1385
1409
  "type": "string",
1386
1410
  "maxLength": 48
@@ -1389,6 +1413,10 @@
1389
1413
  "type": "string",
1390
1414
  "maxLength": 1024
1391
1415
  },
1416
+ "writeOnOpenEncoding": {
1417
+ "type": "string",
1418
+ "maxLength": 48
1419
+ },
1392
1420
  "byteLength": {
1393
1421
  "type": "string",
1394
1422
  "maxLength": 48
@@ -1396,6 +1424,10 @@
1396
1424
  "delimiter": {
1397
1425
  "type": "string",
1398
1426
  "maxLength": 48
1427
+ },
1428
+ "delimiterEncoding": {
1429
+ "type": "string",
1430
+ "maxLength": 48
1399
1431
  }
1400
1432
  },
1401
1433
  "additionalProperties": false
data/schemas/flowStats.json ADDED
@@ -0,0 +1,54 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "flowVersion": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "flowVersionId": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ },
14
+ "deviceId": {
15
+ "type": "string",
16
+ "pattern": "^[A-Fa-f\\d]{24}$"
17
+ },
18
+ "start": {
19
+ "type": "string",
20
+ "format": "date-time"
21
+ },
22
+ "end": {
23
+ "type": "string",
24
+ "format": "date-time"
25
+ },
26
+ "resolution": {
27
+ "type": "number"
28
+ },
29
+ "metrics": {
30
+ "type": "array",
31
+ "items": {
32
+ "type": "object",
33
+ "properties": {
34
+ "time": {
35
+ "type": "string",
36
+ "format": "date-time"
37
+ },
38
+ "pathsFailed": {
39
+ "type": "number"
40
+ },
41
+ "pathsCompleted": {
42
+ "type": "number"
43
+ },
44
+ "runCount": {
45
+ "type": "number"
46
+ },
47
+ "wallTime": {
48
+ "type": "number"
49
+ }
50
+ }
51
+ }
52
+ }
53
+ }
54
+ }
data/schemas/flowVersion.json CHANGED
@@ -932,6 +932,17 @@
932
932
  },
933
933
  "config": {
934
934
  "type": "object",
935
+ "properties": {
936
+ "scope": {
937
+ "type": "string",
938
+ "enum": [
939
+ "local",
940
+ "global",
941
+ "experience",
942
+ "cloud"
943
+ ]
944
+ }
945
+ },
935
946
  "additionalProperties": false
936
947
  },
937
948
  "meta": {
@@ -1396,6 +1407,19 @@
1396
1407
  "baudRate": {
1397
1408
  "type": "number"
1398
1409
  },
1410
+ "dataBits": {
1411
+ "type": "number"
1412
+ },
1413
+ "stopBits": {
1414
+ "type": "number"
1415
+ },
1416
+ "parity": {
1417
+ "type": "string",
1418
+ "maxLength": 8
1419
+ },
1420
+ "rtscts": {
1421
+ "type": "boolean"
1422
+ },
1399
1423
  "encoding": {
1400
1424
  "type": "string",
1401
1425
  "maxLength": 48
@@ -1404,6 +1428,10 @@
1404
1428
  "type": "string",
1405
1429
  "maxLength": 1024
1406
1430
  },
1431
+ "writeOnOpenEncoding": {
1432
+ "type": "string",
1433
+ "maxLength": 48
1434
+ },
1407
1435
  "byteLength": {
1408
1436
  "type": "string",
1409
1437
  "maxLength": 48
@@ -1411,6 +1439,10 @@
1411
1439
  "delimiter": {
1412
1440
  "type": "string",
1413
1441
  "maxLength": 48
1442
+ },
1443
+ "delimiterEncoding": {
1444
+ "type": "string",
1445
+ "maxLength": 48
1414
1446
  }
1415
1447
  },
1416
1448
  "additionalProperties": false
@@ -3098,6 +3130,17 @@
3098
3130
  },
3099
3131
  "config": {
3100
3132
  "type": "object",
3133
+ "properties": {
3134
+ "scope": {
3135
+ "type": "string",
3136
+ "enum": [
3137
+ "local",
3138
+ "global",
3139
+ "experience",
3140
+ "cloud"
3141
+ ]
3142
+ }
3143
+ },
3101
3144
  "additionalProperties": false
3102
3145
  },
3103
3146
  "meta": {
@@ -3562,6 +3605,19 @@
3562
3605
  "baudRate": {
3563
3606
  "type": "number"
3564
3607
  },
3608
+ "dataBits": {
3609
+ "type": "number"
3610
+ },
3611
+ "stopBits": {
3612
+ "type": "number"
3613
+ },
3614
+ "parity": {
3615
+ "type": "string",
3616
+ "maxLength": 8
3617
+ },
3618
+ "rtscts": {
3619
+ "type": "boolean"
3620
+ },
3565
3621
  "encoding": {
3566
3622
  "type": "string",
3567
3623
  "maxLength": 48
@@ -3570,6 +3626,10 @@
3570
3626
  "type": "string",
3571
3627
  "maxLength": 1024
3572
3628
  },
3629
+ "writeOnOpenEncoding": {
3630
+ "type": "string",
3631
+ "maxLength": 48
3632
+ },
3573
3633
  "byteLength": {
3574
3634
  "type": "string",
3575
3635
  "maxLength": 48
@@ -3577,6 +3637,10 @@
3577
3637
  "delimiter": {
3578
3638
  "type": "string",
3579
3639
  "maxLength": 48
3640
+ },
3641
+ "delimiterEncoding": {
3642
+ "type": "string",
3643
+ "maxLength": 48
3580
3644
  }
3581
3645
  },
3582
3646
  "additionalProperties": false