losant_rest 1.10.0 → 1.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (129) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +18838 -4104
  3. data/docs/application.md +85 -0
  4. data/docs/applicationApiTokens.md +2 -2
  5. data/docs/applicationCertificateAuthorities.md +1 -1
  6. data/docs/applicationCertificates.md +1 -1
  7. data/docs/applicationKeys.md +1 -1
  8. data/docs/applicationTemplate.md +46 -0
  9. data/docs/applicationTemplates.md +77 -2
  10. data/docs/applications.md +1 -1
  11. data/docs/auditLogs.md +1 -1
  12. data/docs/dashboards.md +1 -1
  13. data/docs/dataTables.md +1 -1
  14. data/docs/device.md +7 -3
  15. data/docs/deviceRecipes.md +1 -1
  16. data/docs/devices.md +93 -5
  17. data/docs/edgeDeployments.md +1 -1
  18. data/docs/events.md +1 -1
  19. data/docs/experienceEndpoints.md +1 -0
  20. data/docs/experienceGroups.md +1 -1
  21. data/docs/experienceUsers.md +1 -1
  22. data/docs/experienceVersions.md +1 -1
  23. data/docs/experienceViews.md +1 -1
  24. data/docs/file.md +4 -4
  25. data/docs/files.md +1 -1
  26. data/docs/flow.md +94 -1
  27. data/docs/flowVersion.md +96 -1
  28. data/docs/flowVersions.md +1 -1
  29. data/docs/flows.md +2 -2
  30. data/docs/integrations.md +1 -1
  31. data/docs/me.md +0 -36
  32. data/docs/notebooks.md +1 -1
  33. data/docs/orgs.md +1 -1
  34. data/docs/webhooks.md +1 -1
  35. data/lib/losant_rest.rb +1 -0
  36. data/lib/losant_rest/application.rb +48 -0
  37. data/lib/losant_rest/application_api_tokens.rb +1 -1
  38. data/lib/losant_rest/application_template.rb +79 -0
  39. data/lib/losant_rest/application_templates.rb +89 -1
  40. data/lib/losant_rest/client.rb +6 -2
  41. data/lib/losant_rest/device.rb +11 -3
  42. data/lib/losant_rest/devices.rb +103 -3
  43. data/lib/losant_rest/experience_endpoints.rb +2 -0
  44. data/lib/losant_rest/file.rb +3 -3
  45. data/lib/losant_rest/flow.rb +115 -1
  46. data/lib/losant_rest/flow_version.rb +115 -1
  47. data/lib/losant_rest/me.rb +0 -41
  48. data/lib/losant_rest/version.rb +1 -1
  49. data/schemas/advancedDeviceQuery.json +110 -0
  50. data/schemas/advancedEventQuery.json +198 -0
  51. data/schemas/advancedQuery.json +22 -0
  52. data/schemas/application.json +13 -0
  53. data/schemas/applicationApiTokenPost.json +10 -1
  54. data/schemas/applicationApplyTemplatePatch.json +19 -0
  55. data/schemas/applicationCreationByTemplateResult.json +13 -0
  56. data/schemas/applicationPatch.json +5 -0
  57. data/schemas/applicationPost.json +13 -0
  58. data/schemas/applicationTemplate.json +20 -0
  59. data/schemas/applicationTemplateCategories.json +43 -0
  60. data/schemas/applicationTemplateCategory.json +23 -0
  61. data/schemas/applicationTemplates.json +32 -0
  62. data/schemas/applications.json +13 -0
  63. data/schemas/authedUser.json +3 -0
  64. data/schemas/changePassword.json +2 -2
  65. data/schemas/dashboard.json +1288 -145
  66. data/schemas/dashboardPatch.json +1288 -145
  67. data/schemas/dashboardPost.json +1288 -145
  68. data/schemas/dashboards.json +1288 -145
  69. data/schemas/dataExport.json +142 -0
  70. data/schemas/dataTableRowsExport.json +22 -0
  71. data/schemas/device.json +16 -3
  72. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  73. data/schemas/deviceClassFilter.json +1 -2
  74. data/schemas/devicePatch.json +16 -3
  75. data/schemas/devicePost.json +16 -3
  76. data/schemas/deviceRecipe.json +16 -3
  77. data/schemas/deviceRecipePatch.json +16 -3
  78. data/schemas/deviceRecipePost.json +16 -3
  79. data/schemas/deviceRecipes.json +16 -3
  80. data/schemas/devices.json +16 -3
  81. data/schemas/devicesDataRemoved.json +12 -0
  82. data/schemas/devicesDeletePost.json +1034 -0
  83. data/schemas/devicesDeleted.json +12 -0
  84. data/schemas/devicesExportPost.json +1035 -0
  85. data/schemas/devicesPatch.json +1773 -7
  86. data/schemas/devicesRemoveDataPost.json +1056 -0
  87. data/schemas/devicesUpdated.json +18 -0
  88. data/schemas/eventPost.json +22 -0
  89. data/schemas/eventsExport.json +198 -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 +372 -3
  95. data/schemas/experienceVersion.json +1 -1
  96. data/schemas/experienceVersions.json +1 -1
  97. data/schemas/flow.json +124 -1
  98. data/schemas/flowErrors.json +87 -0
  99. data/schemas/flowPatch.json +124 -1
  100. data/schemas/flowPost.json +124 -1
  101. data/schemas/flowStats.json +54 -0
  102. data/schemas/flowVersion.json +248 -2
  103. data/schemas/flowVersionPost.json +124 -1
  104. data/schemas/flowVersions.json +248 -2
  105. data/schemas/flows.json +124 -1
  106. data/schemas/flowsImportPost.json +248 -2
  107. data/schemas/flowsImportResult.json +372 -3
  108. data/schemas/githubLogin.json +16 -4
  109. data/schemas/me.json +3 -3
  110. data/schemas/mePatch.json +2 -2
  111. data/schemas/multiDeviceCommand.json +1019 -0
  112. data/schemas/notebook.json +89 -0
  113. data/schemas/notebookPatch.json +89 -0
  114. data/schemas/notebookPost.json +89 -0
  115. data/schemas/notebooks.json +89 -0
  116. data/schemas/org.json +1 -1
  117. data/schemas/orgInviteInfo.json +3 -0
  118. data/schemas/orgInvitePost.json +3 -0
  119. data/schemas/orgInvites.json +3 -0
  120. data/schemas/orgPatch.json +1 -1
  121. data/schemas/orgs.json +1 -1
  122. data/schemas/passwordResetFinish.json +2 -2
  123. data/schemas/samlResponse.json +1 -1
  124. data/schemas/templateKeywords.json +14 -0
  125. data/schemas/timeSeriesData.json +101 -12
  126. data/schemas/timeSeriesQuery.json +101 -12
  127. data/schemas/userCredentials.json +14 -3
  128. data/schemas/userPost.json +22 -7
  129. metadata +20 -5
data/schemas/advancedEventQuery.json CHANGED
@@ -98,6 +98,28 @@
98
98
  },
99
99
  "$ci": {
100
100
  "type": "boolean"
101
+ },
102
+ "$in": {
103
+ "type": "array",
104
+ "maxItems": 100,
105
+ "items": {
106
+ "type": [
107
+ "string",
108
+ "number",
109
+ "boolean"
110
+ ]
111
+ }
112
+ },
113
+ "$nin": {
114
+ "type": "array",
115
+ "maxItems": 100,
116
+ "items": {
117
+ "type": [
118
+ "string",
119
+ "number",
120
+ "boolean"
121
+ ]
122
+ }
101
123
  }
102
124
  },
103
125
  "additionalProperties": false
@@ -179,6 +201,28 @@
179
201
  },
180
202
  "$ci": {
181
203
  "type": "boolean"
204
+ },
205
+ "$in": {
206
+ "type": "array",
207
+ "maxItems": 100,
208
+ "items": {
209
+ "type": [
210
+ "string",
211
+ "number",
212
+ "boolean"
213
+ ]
214
+ }
215
+ },
216
+ "$nin": {
217
+ "type": "array",
218
+ "maxItems": 100,
219
+ "items": {
220
+ "type": [
221
+ "string",
222
+ "number",
223
+ "boolean"
224
+ ]
225
+ }
182
226
  }
183
227
  },
184
228
  "additionalProperties": false
@@ -260,6 +304,28 @@
260
304
  },
261
305
  "$ci": {
262
306
  "type": "boolean"
307
+ },
308
+ "$in": {
309
+ "type": "array",
310
+ "maxItems": 100,
311
+ "items": {
312
+ "type": [
313
+ "string",
314
+ "number",
315
+ "boolean"
316
+ ]
317
+ }
318
+ },
319
+ "$nin": {
320
+ "type": "array",
321
+ "maxItems": 100,
322
+ "items": {
323
+ "type": [
324
+ "string",
325
+ "number",
326
+ "boolean"
327
+ ]
328
+ }
263
329
  }
264
330
  },
265
331
  "additionalProperties": false
@@ -341,6 +407,28 @@
341
407
  },
342
408
  "$ci": {
343
409
  "type": "boolean"
410
+ },
411
+ "$in": {
412
+ "type": "array",
413
+ "maxItems": 100,
414
+ "items": {
415
+ "type": [
416
+ "string",
417
+ "number",
418
+ "boolean"
419
+ ]
420
+ }
421
+ },
422
+ "$nin": {
423
+ "type": "array",
424
+ "maxItems": 100,
425
+ "items": {
426
+ "type": [
427
+ "string",
428
+ "number",
429
+ "boolean"
430
+ ]
431
+ }
344
432
  }
345
433
  },
346
434
  "additionalProperties": false
@@ -422,6 +510,28 @@
422
510
  },
423
511
  "$ci": {
424
512
  "type": "boolean"
513
+ },
514
+ "$in": {
515
+ "type": "array",
516
+ "maxItems": 100,
517
+ "items": {
518
+ "type": [
519
+ "string",
520
+ "number",
521
+ "boolean"
522
+ ]
523
+ }
524
+ },
525
+ "$nin": {
526
+ "type": "array",
527
+ "maxItems": 100,
528
+ "items": {
529
+ "type": [
530
+ "string",
531
+ "number",
532
+ "boolean"
533
+ ]
534
+ }
425
535
  }
426
536
  },
427
537
  "additionalProperties": false
@@ -503,6 +613,28 @@
503
613
  },
504
614
  "$ci": {
505
615
  "type": "boolean"
616
+ },
617
+ "$in": {
618
+ "type": "array",
619
+ "maxItems": 100,
620
+ "items": {
621
+ "type": [
622
+ "string",
623
+ "number",
624
+ "boolean"
625
+ ]
626
+ }
627
+ },
628
+ "$nin": {
629
+ "type": "array",
630
+ "maxItems": 100,
631
+ "items": {
632
+ "type": [
633
+ "string",
634
+ "number",
635
+ "boolean"
636
+ ]
637
+ }
506
638
  }
507
639
  },
508
640
  "additionalProperties": false
@@ -584,6 +716,28 @@
584
716
  },
585
717
  "$ci": {
586
718
  "type": "boolean"
719
+ },
720
+ "$in": {
721
+ "type": "array",
722
+ "maxItems": 100,
723
+ "items": {
724
+ "type": [
725
+ "string",
726
+ "number",
727
+ "boolean"
728
+ ]
729
+ }
730
+ },
731
+ "$nin": {
732
+ "type": "array",
733
+ "maxItems": 100,
734
+ "items": {
735
+ "type": [
736
+ "string",
737
+ "number",
738
+ "boolean"
739
+ ]
740
+ }
587
741
  }
588
742
  },
589
743
  "additionalProperties": false
@@ -665,6 +819,28 @@
665
819
  },
666
820
  "$ci": {
667
821
  "type": "boolean"
822
+ },
823
+ "$in": {
824
+ "type": "array",
825
+ "maxItems": 100,
826
+ "items": {
827
+ "type": [
828
+ "string",
829
+ "number",
830
+ "boolean"
831
+ ]
832
+ }
833
+ },
834
+ "$nin": {
835
+ "type": "array",
836
+ "maxItems": 100,
837
+ "items": {
838
+ "type": [
839
+ "string",
840
+ "number",
841
+ "boolean"
842
+ ]
843
+ }
668
844
  }
669
845
  },
670
846
  "additionalProperties": false
@@ -746,6 +922,28 @@
746
922
  },
747
923
  "$ci": {
748
924
  "type": "boolean"
925
+ },
926
+ "$in": {
927
+ "type": "array",
928
+ "maxItems": 100,
929
+ "items": {
930
+ "type": [
931
+ "string",
932
+ "number",
933
+ "boolean"
934
+ ]
935
+ }
936
+ },
937
+ "$nin": {
938
+ "type": "array",
939
+ "maxItems": 100,
940
+ "items": {
941
+ "type": [
942
+ "string",
943
+ "number",
944
+ "boolean"
945
+ ]
946
+ }
749
947
  }
750
948
  },
751
949
  "additionalProperties": false
data/schemas/advancedQuery.json CHANGED
@@ -100,6 +100,28 @@
100
100
  },
101
101
  "$ci": {
102
102
  "type": "boolean"
103
+ },
104
+ "$in": {
105
+ "type": "array",
106
+ "maxItems": 100,
107
+ "items": {
108
+ "type": [
109
+ "string",
110
+ "number",
111
+ "boolean"
112
+ ]
113
+ }
114
+ },
115
+ "$nin": {
116
+ "type": "array",
117
+ "maxItems": 100,
118
+ "items": {
119
+ "type": [
120
+ "string",
121
+ "number",
122
+ "boolean"
123
+ ]
124
+ }
103
125
  }
104
126
  },
105
127
  "additionalProperties": false
data/schemas/application.json CHANGED
@@ -18,6 +18,14 @@
18
18
  "type": "string",
19
19
  "format": "date-time"
20
20
  },
21
+ "appliedTemplateIds": {
22
+ "type": "array",
23
+ "items": {
24
+ "type": "string",
25
+ "pattern": "^[A-Fa-f\\d]{24}$"
26
+ },
27
+ "maxItems": 1000
28
+ },
21
29
  "ownerId": {
22
30
  "type": "string",
23
31
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -91,6 +99,11 @@
91
99
  ]
92
100
  }
93
101
  },
102
+ "blobUrlTTL": {
103
+ "type": "number",
104
+ "minimum": 3600,
105
+ "maximum": 604800
106
+ },
94
107
  "summary": {
95
108
  "type": "object",
96
109
  "properties": {
data/schemas/applicationApiTokenPost.json CHANGED
@@ -73,10 +73,12 @@
73
73
  "notebooks.*",
74
74
  "webhook.*",
75
75
  "webhooks.*",
76
+ "application.applyTemplate",
76
77
  "application.archiveData",
77
78
  "application.backfillArchiveData",
78
79
  "application.clone",
79
80
  "application.export",
81
+ "application.import",
80
82
  "application.fullEventsArchive",
81
83
  "application.fullDataTablesArchive",
82
84
  "application.debug",
@@ -147,7 +149,10 @@
147
149
  "deviceRecipe.patch",
148
150
  "deviceRecipes.get",
149
151
  "deviceRecipes.post",
152
+ "devices.attributeNames",
150
153
  "devices.patch",
154
+ "devices.delete",
155
+ "devices.removeData",
151
156
  "devices.detailedSummary",
152
157
  "devices.export",
153
158
  "devices.get",
@@ -218,23 +223,27 @@
218
223
  "file.upload",
219
224
  "files.get",
220
225
  "files.post",
226
+ "flow.clearStorageEntries",
221
227
  "flow.debug",
222
228
  "flow.delete",
223
- "flow.clearStorageEntries",
229
+ "flow.errors",
224
230
  "flow.get",
225
231
  "flow.getStorageEntries",
226
232
  "flow.log",
227
233
  "flow.patch",
228
234
  "flow.pressVirtualButton",
229
235
  "flow.setStorageEntry",
236
+ "flow.stats",
230
237
  "flows.get",
231
238
  "flows.getByVersion",
232
239
  "flows.import",
233
240
  "flows.post",
234
241
  "flowVersion.delete",
242
+ "flowVersion.errors",
235
243
  "flowVersion.get",
236
244
  "flowVersion.log",
237
245
  "flowVersion.patch",
246
+ "flowVersion.stats",
238
247
  "flowVersions.get",
239
248
  "flowVersions.post",
240
249
  "integration.delete",
data/schemas/applicationApplyTemplatePatch.json ADDED
@@ -0,0 +1,19 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "templateId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "email": {
10
+ "type": "string",
11
+ "format": "email",
12
+ "maxLength": 1024
13
+ }
14
+ },
15
+ "required": [
16
+ "templateId"
17
+ ],
18
+ "additionalProperties": false
19
+ }
data/schemas/applicationCreationByTemplateResult.json CHANGED
@@ -23,6 +23,14 @@
23
23
  "type": "string",
24
24
  "format": "date-time"
25
25
  },
26
+ "appliedTemplateIds": {
27
+ "type": "array",
28
+ "items": {
29
+ "type": "string",
30
+ "pattern": "^[A-Fa-f\\d]{24}$"
31
+ },
32
+ "maxItems": 1000
33
+ },
26
34
  "ownerId": {
27
35
  "type": "string",
28
36
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -96,6 +104,11 @@
96
104
  ]
97
105
  }
98
106
  },
107
+ "blobUrlTTL": {
108
+ "type": "number",
109
+ "minimum": 3600,
110
+ "maximum": 604800
111
+ },
99
112
  "summary": {
100
113
  "type": "object",
101
114
  "properties": {
data/schemas/applicationPatch.json CHANGED
@@ -236,6 +236,11 @@
236
236
  }
237
237
  },
238
238
  "additionalProperties": false
239
+ },
240
+ "blobUrlTTL": {
241
+ "type": "number",
242
+ "minimum": 3600,
243
+ "maximum": 604800
239
244
  }
240
245
  },
241
246
  "additionalProperties": false
data/schemas/applicationPost.json CHANGED
@@ -19,6 +19,14 @@
19
19
  "type": "string",
20
20
  "maxLength": 1024
21
21
  },
22
+ "appliedTemplateIds": {
23
+ "type": "array",
24
+ "items": {
25
+ "type": "string",
26
+ "pattern": "^[A-Fa-f\\d]{24}$"
27
+ },
28
+ "maxItems": 1000
29
+ },
22
30
  "endpointSlug": {
23
31
  "type": "string",
24
32
  "minLength": 4,
@@ -215,6 +223,11 @@
215
223
  }
216
224
  },
217
225
  "additionalProperties": false
226
+ },
227
+ "blobUrlTTL": {
228
+ "type": "number",
229
+ "minimum": 3600,
230
+ "maximum": 604800
218
231
  }
219
232
  },
220
233
  "additionalProperties": false,