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/devicesUpdated.json ADDED
@@ -0,0 +1,18 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "updated": {
6
+ "type": "number"
7
+ },
8
+ "failed": {
9
+ "type": "number"
10
+ },
11
+ "skipped": {
12
+ "type": "number"
13
+ },
14
+ "logLink": {
15
+ "type": "string"
16
+ }
17
+ }
18
+ }
data/schemas/eventPost.json CHANGED
@@ -43,6 +43,28 @@
43
43
  }
44
44
  },
45
45
  "additionalProperties": false
46
+ },
47
+ "creationDate": {
48
+ "oneOf": [
49
+ {
50
+ "type": "string"
51
+ },
52
+ {
53
+ "type": "number"
54
+ },
55
+ {
56
+ "type": "object",
57
+ "properties": {
58
+ "$date": {
59
+ "type": "string"
60
+ }
61
+ },
62
+ "additionalProperties": false,
63
+ "required": [
64
+ "$date"
65
+ ]
66
+ }
67
+ ]
46
68
  }
47
69
  },
48
70
  "required": [
data/schemas/eventsExport.json CHANGED
@@ -108,6 +108,28 @@
108
108
  },
109
109
  "$ci": {
110
110
  "type": "boolean"
111
+ },
112
+ "$in": {
113
+ "type": "array",
114
+ "maxItems": 100,
115
+ "items": {
116
+ "type": [
117
+ "string",
118
+ "number",
119
+ "boolean"
120
+ ]
121
+ }
122
+ },
123
+ "$nin": {
124
+ "type": "array",
125
+ "maxItems": 100,
126
+ "items": {
127
+ "type": [
128
+ "string",
129
+ "number",
130
+ "boolean"
131
+ ]
132
+ }
111
133
  }
112
134
  },
113
135
  "additionalProperties": false
@@ -189,6 +211,28 @@
189
211
  },
190
212
  "$ci": {
191
213
  "type": "boolean"
214
+ },
215
+ "$in": {
216
+ "type": "array",
217
+ "maxItems": 100,
218
+ "items": {
219
+ "type": [
220
+ "string",
221
+ "number",
222
+ "boolean"
223
+ ]
224
+ }
225
+ },
226
+ "$nin": {
227
+ "type": "array",
228
+ "maxItems": 100,
229
+ "items": {
230
+ "type": [
231
+ "string",
232
+ "number",
233
+ "boolean"
234
+ ]
235
+ }
192
236
  }
193
237
  },
194
238
  "additionalProperties": false
@@ -270,6 +314,28 @@
270
314
  },
271
315
  "$ci": {
272
316
  "type": "boolean"
317
+ },
318
+ "$in": {
319
+ "type": "array",
320
+ "maxItems": 100,
321
+ "items": {
322
+ "type": [
323
+ "string",
324
+ "number",
325
+ "boolean"
326
+ ]
327
+ }
328
+ },
329
+ "$nin": {
330
+ "type": "array",
331
+ "maxItems": 100,
332
+ "items": {
333
+ "type": [
334
+ "string",
335
+ "number",
336
+ "boolean"
337
+ ]
338
+ }
273
339
  }
274
340
  },
275
341
  "additionalProperties": false
@@ -351,6 +417,28 @@
351
417
  },
352
418
  "$ci": {
353
419
  "type": "boolean"
420
+ },
421
+ "$in": {
422
+ "type": "array",
423
+ "maxItems": 100,
424
+ "items": {
425
+ "type": [
426
+ "string",
427
+ "number",
428
+ "boolean"
429
+ ]
430
+ }
431
+ },
432
+ "$nin": {
433
+ "type": "array",
434
+ "maxItems": 100,
435
+ "items": {
436
+ "type": [
437
+ "string",
438
+ "number",
439
+ "boolean"
440
+ ]
441
+ }
354
442
  }
355
443
  },
356
444
  "additionalProperties": false
@@ -432,6 +520,28 @@
432
520
  },
433
521
  "$ci": {
434
522
  "type": "boolean"
523
+ },
524
+ "$in": {
525
+ "type": "array",
526
+ "maxItems": 100,
527
+ "items": {
528
+ "type": [
529
+ "string",
530
+ "number",
531
+ "boolean"
532
+ ]
533
+ }
534
+ },
535
+ "$nin": {
536
+ "type": "array",
537
+ "maxItems": 100,
538
+ "items": {
539
+ "type": [
540
+ "string",
541
+ "number",
542
+ "boolean"
543
+ ]
544
+ }
435
545
  }
436
546
  },
437
547
  "additionalProperties": false
@@ -513,6 +623,28 @@
513
623
  },
514
624
  "$ci": {
515
625
  "type": "boolean"
626
+ },
627
+ "$in": {
628
+ "type": "array",
629
+ "maxItems": 100,
630
+ "items": {
631
+ "type": [
632
+ "string",
633
+ "number",
634
+ "boolean"
635
+ ]
636
+ }
637
+ },
638
+ "$nin": {
639
+ "type": "array",
640
+ "maxItems": 100,
641
+ "items": {
642
+ "type": [
643
+ "string",
644
+ "number",
645
+ "boolean"
646
+ ]
647
+ }
516
648
  }
517
649
  },
518
650
  "additionalProperties": false
@@ -594,6 +726,28 @@
594
726
  },
595
727
  "$ci": {
596
728
  "type": "boolean"
729
+ },
730
+ "$in": {
731
+ "type": "array",
732
+ "maxItems": 100,
733
+ "items": {
734
+ "type": [
735
+ "string",
736
+ "number",
737
+ "boolean"
738
+ ]
739
+ }
740
+ },
741
+ "$nin": {
742
+ "type": "array",
743
+ "maxItems": 100,
744
+ "items": {
745
+ "type": [
746
+ "string",
747
+ "number",
748
+ "boolean"
749
+ ]
750
+ }
597
751
  }
598
752
  },
599
753
  "additionalProperties": false
@@ -675,6 +829,28 @@
675
829
  },
676
830
  "$ci": {
677
831
  "type": "boolean"
832
+ },
833
+ "$in": {
834
+ "type": "array",
835
+ "maxItems": 100,
836
+ "items": {
837
+ "type": [
838
+ "string",
839
+ "number",
840
+ "boolean"
841
+ ]
842
+ }
843
+ },
844
+ "$nin": {
845
+ "type": "array",
846
+ "maxItems": 100,
847
+ "items": {
848
+ "type": [
849
+ "string",
850
+ "number",
851
+ "boolean"
852
+ ]
853
+ }
678
854
  }
679
855
  },
680
856
  "additionalProperties": false
@@ -756,6 +932,28 @@
756
932
  },
757
933
  "$ci": {
758
934
  "type": "boolean"
935
+ },
936
+ "$in": {
937
+ "type": "array",
938
+ "maxItems": 100,
939
+ "items": {
940
+ "type": [
941
+ "string",
942
+ "number",
943
+ "boolean"
944
+ ]
945
+ }
946
+ },
947
+ "$nin": {
948
+ "type": "array",
949
+ "maxItems": 100,
950
+ "items": {
951
+ "type": [
952
+ "string",
953
+ "number",
954
+ "boolean"
955
+ ]
956
+ }
759
957
  }
760
958
  },
761
959
  "additionalProperties": false
data/schemas/experienceDomain.json CHANGED
@@ -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": {
data/schemas/experienceDomainPatch.json CHANGED
@@ -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
  },
data/schemas/experienceDomainPost.json CHANGED
@@ -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": {
data/schemas/experienceDomains.json CHANGED
@@ -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": {
data/schemas/experienceLinkedResources.json CHANGED
@@ -1330,6 +1330,17 @@
1330
1330
  },
1331
1331
  "config": {
1332
1332
  "type": "object",
1333
+ "properties": {
1334
+ "scope": {
1335
+ "type": "string",
1336
+ "enum": [
1337
+ "local",
1338
+ "global",
1339
+ "experience",
1340
+ "cloud"
1341
+ ]
1342
+ }
1343
+ },
1333
1344
  "additionalProperties": false
1334
1345
  },
1335
1346
  "meta": {
@@ -1794,6 +1805,19 @@
1794
1805
  "baudRate": {
1795
1806
  "type": "number"
1796
1807
  },
1808
+ "dataBits": {
1809
+ "type": "number"
1810
+ },
1811
+ "stopBits": {
1812
+ "type": "number"
1813
+ },
1814
+ "parity": {
1815
+ "type": "string",
1816
+ "maxLength": 8
1817
+ },
1818
+ "rtscts": {
1819
+ "type": "boolean"
1820
+ },
1797
1821
  "encoding": {
1798
1822
  "type": "string",
1799
1823
  "maxLength": 48
@@ -1802,6 +1826,10 @@
1802
1826
  "type": "string",
1803
1827
  "maxLength": 1024
1804
1828
  },
1829
+ "writeOnOpenEncoding": {
1830
+ "type": "string",
1831
+ "maxLength": 48
1832
+ },
1805
1833
  "byteLength": {
1806
1834
  "type": "string",
1807
1835
  "maxLength": 48
@@ -1809,6 +1837,10 @@
1809
1837
  "delimiter": {
1810
1838
  "type": "string",
1811
1839
  "maxLength": 48
1840
+ },
1841
+ "delimiterEncoding": {
1842
+ "type": "string",
1843
+ "maxLength": 48
1812
1844
  }
1813
1845
  },
1814
1846
  "additionalProperties": false
@@ -3546,6 +3578,17 @@
3546
3578
  },
3547
3579
  "config": {
3548
3580
  "type": "object",
3581
+ "properties": {
3582
+ "scope": {
3583
+ "type": "string",
3584
+ "enum": [
3585
+ "local",
3586
+ "global",
3587
+ "experience",
3588
+ "cloud"
3589
+ ]
3590
+ }
3591
+ },
3549
3592
  "additionalProperties": false
3550
3593
  },
3551
3594
  "meta": {
@@ -4010,6 +4053,19 @@
4010
4053
  "baudRate": {
4011
4054
  "type": "number"
4012
4055
  },
4056
+ "dataBits": {
4057
+ "type": "number"
4058
+ },
4059
+ "stopBits": {
4060
+ "type": "number"
4061
+ },
4062
+ "parity": {
4063
+ "type": "string",
4064
+ "maxLength": 8
4065
+ },
4066
+ "rtscts": {
4067
+ "type": "boolean"
4068
+ },
4013
4069
  "encoding": {
4014
4070
  "type": "string",
4015
4071
  "maxLength": 48
@@ -4018,6 +4074,10 @@
4018
4074
  "type": "string",
4019
4075
  "maxLength": 1024
4020
4076
  },
4077
+ "writeOnOpenEncoding": {
4078
+ "type": "string",
4079
+ "maxLength": 48
4080
+ },
4021
4081
  "byteLength": {
4022
4082
  "type": "string",
4023
4083
  "maxLength": 48
@@ -4025,6 +4085,10 @@
4025
4085
  "delimiter": {
4026
4086
  "type": "string",
4027
4087
  "maxLength": 48
4088
+ },
4089
+ "delimiterEncoding": {
4090
+ "type": "string",
4091
+ "maxLength": 48
4028
4092
  }
4029
4093
  },
4030
4094
  "additionalProperties": false
@@ -5712,6 +5776,17 @@
5712
5776
  },
5713
5777
  "config": {
5714
5778
  "type": "object",
5779
+ "properties": {
5780
+ "scope": {
5781
+ "type": "string",
5782
+ "enum": [
5783
+ "local",
5784
+ "global",
5785
+ "experience",
5786
+ "cloud"
5787
+ ]
5788
+ }
5789
+ },
5715
5790
  "additionalProperties": false
5716
5791
  },
5717
5792
  "meta": {
@@ -6176,6 +6251,19 @@
6176
6251
  "baudRate": {
6177
6252
  "type": "number"
6178
6253
  },
6254
+ "dataBits": {
6255
+ "type": "number"
6256
+ },
6257
+ "stopBits": {
6258
+ "type": "number"
6259
+ },
6260
+ "parity": {
6261
+ "type": "string",
6262
+ "maxLength": 8
6263
+ },
6264
+ "rtscts": {
6265
+ "type": "boolean"
6266
+ },
6179
6267
  "encoding": {
6180
6268
  "type": "string",
6181
6269
  "maxLength": 48
@@ -6184,6 +6272,10 @@
6184
6272
  "type": "string",
6185
6273
  "maxLength": 1024
6186
6274
  },
6275
+ "writeOnOpenEncoding": {
6276
+ "type": "string",
6277
+ "maxLength": 48
6278
+ },
6187
6279
  "byteLength": {
6188
6280
  "type": "string",
6189
6281
  "maxLength": 48
@@ -6191,6 +6283,10 @@
6191
6283
  "delimiter": {
6192
6284
  "type": "string",
6193
6285
  "maxLength": 48
6286
+ },
6287
+ "delimiterEncoding": {
6288
+ "type": "string",
6289
+ "maxLength": 48
6194
6290
  }
6195
6291
  },
6196
6292
  "additionalProperties": false