losant_rest 1.10.2 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/_schemas.md +21561 -8561
  4. data/docs/application.md +83 -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/applicationDashboard.md +133 -0
  9. data/docs/applicationDashboards.md +93 -0
  10. data/docs/applicationKeys.md +4 -3
  11. data/docs/applicationTemplate.md +46 -0
  12. data/docs/applicationTemplates.md +77 -2
  13. data/docs/applications.md +1 -1
  14. data/docs/auditLogs.md +1 -1
  15. data/docs/dashboards.md +1 -1
  16. data/docs/dataTables.md +1 -1
  17. data/docs/device.md +6 -3
  18. data/docs/deviceRecipes.md +1 -1
  19. data/docs/devices.md +130 -4
  20. data/docs/edgeDeployments.md +1 -1
  21. data/docs/events.md +1 -1
  22. data/docs/experienceEndpoint.md +1 -0
  23. data/docs/experienceEndpoints.md +1 -0
  24. data/docs/experienceGroups.md +1 -1
  25. data/docs/experienceUsers.md +1 -1
  26. data/docs/experienceVersions.md +1 -1
  27. data/docs/experienceViews.md +1 -1
  28. data/docs/file.md +4 -4
  29. data/docs/files.md +1 -1
  30. data/docs/flow.md +94 -1
  31. data/docs/flowVersion.md +96 -1
  32. data/docs/flowVersions.md +2 -1
  33. data/docs/flows.md +5 -2
  34. data/docs/integration.md +1 -0
  35. data/docs/integrations.md +1 -1
  36. data/docs/me.md +0 -36
  37. data/docs/notebooks.md +1 -1
  38. data/docs/orgs.md +1 -1
  39. data/docs/webhook.md +1 -0
  40. data/docs/webhooks.md +1 -1
  41. data/lib/losant_rest.rb +3 -0
  42. data/lib/losant_rest/application.rb +95 -0
  43. data/lib/losant_rest/application_api_tokens.rb +1 -1
  44. data/lib/losant_rest/application_dashboard.rb +176 -0
  45. data/lib/losant_rest/application_dashboards.rb +138 -0
  46. data/lib/losant_rest/application_keys.rb +3 -0
  47. data/lib/losant_rest/application_template.rb +79 -0
  48. data/lib/losant_rest/application_templates.rb +89 -1
  49. data/lib/losant_rest/client.rb +14 -2
  50. data/lib/losant_rest/device.rb +9 -3
  51. data/lib/losant_rest/devices.rb +154 -1
  52. data/lib/losant_rest/experience_endpoint.rb +2 -0
  53. data/lib/losant_rest/experience_endpoints.rb +2 -0
  54. data/lib/losant_rest/file.rb +3 -3
  55. data/lib/losant_rest/flow.rb +115 -1
  56. data/lib/losant_rest/flow_version.rb +115 -1
  57. data/lib/losant_rest/flow_versions.rb +3 -0
  58. data/lib/losant_rest/flows.rb +8 -0
  59. data/lib/losant_rest/integration.rb +2 -0
  60. data/lib/losant_rest/me.rb +0 -41
  61. data/lib/losant_rest/version.rb +1 -1
  62. data/lib/losant_rest/webhook.rb +2 -0
  63. data/schemas/advancedApplicationKeyQuery.json +1082 -0
  64. data/schemas/advancedFlowByVersionQuery.json +665 -0
  65. data/schemas/advancedFlowQuery.json +883 -0
  66. data/schemas/advancedFlowVersionQuery.json +925 -0
  67. data/schemas/application.json +8 -0
  68. data/schemas/applicationApiTokenPost.json +16 -1
  69. data/schemas/applicationApplyTemplatePatch.json +19 -0
  70. data/schemas/applicationCreationByTemplateResult.json +8 -0
  71. data/schemas/applicationDashboardPost.json +5665 -0
  72. data/schemas/applicationGlobalPatch.json +33 -0
  73. data/schemas/applicationPost.json +8 -0
  74. data/schemas/applicationTemplate.json +20 -0
  75. data/schemas/applicationTemplateCategories.json +43 -0
  76. data/schemas/applicationTemplateCategory.json +23 -0
  77. data/schemas/applicationTemplates.json +32 -0
  78. data/schemas/applications.json +8 -0
  79. data/schemas/attributeNamesResponse.json +14 -0
  80. data/schemas/authedUser.json +3 -0
  81. data/schemas/changePassword.json +2 -2
  82. data/schemas/dashboard.json +195 -26
  83. data/schemas/dashboardPatch.json +195 -26
  84. data/schemas/dashboardPost.json +195 -26
  85. data/schemas/dashboards.json +195 -26
  86. data/schemas/dataExport.json +132 -1
  87. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  88. data/schemas/deviceClassFilter.json +1 -2
  89. data/schemas/eventPost.json +22 -0
  90. data/schemas/experienceDomain.json +1 -1
  91. data/schemas/experienceDomainPatch.json +1 -1
  92. data/schemas/experienceDomainPost.json +1 -1
  93. data/schemas/experienceDomains.json +1 -1
  94. data/schemas/experienceLinkedResources.json +96 -0
  95. data/schemas/experienceVersion.json +10 -1
  96. data/schemas/experienceVersionPatch.json +9 -0
  97. data/schemas/experienceVersions.json +10 -1
  98. data/schemas/files.json +3 -0
  99. data/schemas/flow.json +32 -0
  100. data/schemas/flowErrors.json +87 -0
  101. data/schemas/flowPatch.json +32 -0
  102. data/schemas/flowPost.json +32 -0
  103. data/schemas/flowStats.json +54 -0
  104. data/schemas/flowVersion.json +64 -0
  105. data/schemas/flowVersionPost.json +32 -0
  106. data/schemas/flowVersions.json +64 -0
  107. data/schemas/flows.json +32 -0
  108. data/schemas/flowsImportPost.json +64 -0
  109. data/schemas/flowsImportResult.json +96 -0
  110. data/schemas/githubLogin.json +33 -4
  111. data/schemas/instance.json +132 -0
  112. data/schemas/instanceOrg.json +119 -0
  113. data/schemas/instanceOrgPatch.json +103 -0
  114. data/schemas/instanceOrgPost.json +114 -0
  115. data/schemas/instanceOrgs.json +160 -0
  116. data/schemas/instances.json +43 -0
  117. data/schemas/integration.json +3 -0
  118. data/schemas/integrationPatch.json +3 -0
  119. data/schemas/integrationPost.json +3 -0
  120. data/schemas/integrations.json +3 -0
  121. data/schemas/me.json +3 -3
  122. data/schemas/mePatch.json +2 -2
  123. data/schemas/notebook.json +96 -0
  124. data/schemas/notebookExecutionLogs.json +7 -0
  125. data/schemas/notebookPatch.json +96 -0
  126. data/schemas/notebookPost.json +96 -0
  127. data/schemas/notebooks.json +96 -0
  128. data/schemas/org.json +1 -1
  129. data/schemas/orgInviteInfo.json +3 -0
  130. data/schemas/orgInvitePost.json +3 -0
  131. data/schemas/orgInvites.json +3 -0
  132. data/schemas/orgPatch.json +1 -1
  133. data/schemas/orgs.json +1 -1
  134. data/schemas/passwordResetFinish.json +2 -2
  135. data/schemas/samlResponse.json +1 -1
  136. data/schemas/tagKeysResponse.json +14 -0
  137. data/schemas/tagValuesResponse.json +19 -0
  138. data/schemas/templateKeywords.json +14 -0
  139. data/schemas/timeSeriesData.json +12 -2
  140. data/schemas/timeSeriesQuery.json +94 -14
  141. data/schemas/userCredentials.json +31 -3
  142. data/schemas/userPost.json +39 -7
  143. metadata +34 -6
data/schemas/flows.json CHANGED
@@ -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
data/schemas/flowsImportPost.json CHANGED
@@ -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
data/schemas/flowsImportResult.json CHANGED
@@ -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
data/schemas/githubLogin.json CHANGED
@@ -4,7 +4,8 @@
4
4
  "properties": {
5
5
  "accessToken": {
6
6
  "type": "string",
7
- "minLength": 1
7
+ "minLength": 1,
8
+ "maxLength": 1024
8
9
  },
9
10
  "requestedScopes": {
10
11
  "type": "array",
@@ -27,6 +28,8 @@
27
28
  "applicationCertificates.*",
28
29
  "applicationCertificateAuthority.*",
29
30
  "applicationCertificateAuthorities.*",
31
+ "applicationDashboards.*",
32
+ "applicationDashboard.*",
30
33
  "applicationKey.*",
31
34
  "applicationKeys.*",
32
35
  "data.*",
@@ -68,6 +71,7 @@
68
71
  "notebooks.*",
69
72
  "webhook.*",
70
73
  "webhooks.*",
74
+ "application.applyTemplate",
71
75
  "application.archiveData",
72
76
  "application.backfillArchiveData",
73
77
  "application.clone",
@@ -98,6 +102,11 @@
98
102
  "applicationCertificateAuthority.patch",
99
103
  "applicationCertificateAuthorities.get",
100
104
  "applicationCertificateAuthorities.post",
105
+ "applicationDashboard.get",
106
+ "applicationDashboard.patch",
107
+ "applicationDashboard.delete",
108
+ "applicationDashboards.get",
109
+ "applicationDashboards.post",
101
110
  "applicationKey.delete",
102
111
  "applicationKey.get",
103
112
  "applicationKey.patch",
@@ -143,6 +152,7 @@
143
152
  "deviceRecipe.patch",
144
153
  "deviceRecipes.get",
145
154
  "deviceRecipes.post",
155
+ "devices.attributeNames",
146
156
  "devices.patch",
147
157
  "devices.delete",
148
158
  "devices.removeData",
@@ -151,6 +161,8 @@
151
161
  "devices.get",
152
162
  "devices.post",
153
163
  "devices.sendCommand",
164
+ "devices.tagKeys",
165
+ "devices.tagValues",
154
166
  "edgeDeployments.get",
155
167
  "edgeDeployments.release",
156
168
  "edgeDeployments.remove",
@@ -216,23 +228,27 @@
216
228
  "file.upload",
217
229
  "files.get",
218
230
  "files.post",
231
+ "flow.clearStorageEntries",
219
232
  "flow.debug",
220
233
  "flow.delete",
221
- "flow.clearStorageEntries",
234
+ "flow.errors",
222
235
  "flow.get",
223
236
  "flow.getStorageEntries",
224
237
  "flow.log",
225
238
  "flow.patch",
226
239
  "flow.pressVirtualButton",
227
240
  "flow.setStorageEntry",
241
+ "flow.stats",
228
242
  "flows.get",
229
243
  "flows.getByVersion",
230
244
  "flows.import",
231
245
  "flows.post",
232
246
  "flowVersion.delete",
247
+ "flowVersion.errors",
233
248
  "flowVersion.get",
234
249
  "flowVersion.log",
235
250
  "flowVersion.patch",
251
+ "flowVersion.stats",
236
252
  "flowVersions.get",
237
253
  "flowVersions.post",
238
254
  "integration.delete",
@@ -300,10 +316,25 @@
300
316
  "enum": [
301
317
  "all.User",
302
318
  "all.User.read",
319
+ "applicationTemplate.*",
320
+ "applicationTemplate.get",
303
321
  "applicationTemplates.*",
304
322
  "applicationTemplates.get",
323
+ "applicationTemplates.getCategories",
324
+ "applicationTemplates.getUniqueKeywords",
305
325
  "me.*",
306
326
  "orgs.*",
327
+ "instance.*",
328
+ "instance.get",
329
+ "instances.*",
330
+ "instances.get",
331
+ "instanceOrg.*",
332
+ "instanceOrg.get",
333
+ "instanceOrg.patch",
334
+ "instanceOrg.delete",
335
+ "instanceOrgs.*",
336
+ "instanceOrgs.get",
337
+ "instanceOrgs.post",
307
338
  "me.get",
308
339
  "me.patch",
309
340
  "me.delete",
@@ -313,8 +344,6 @@
313
344
  "me.disableTwoFactorAuth",
314
345
  "me.disconnectGithub",
315
346
  "me.connectGithub",
316
- "me.disconnectTwitter",
317
- "me.connectTwitter",
318
347
  "me.addRecentItem",
319
348
  "me.fetchRecentItems",
320
349
  "me.payloadCounts",