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/dashboards.json CHANGED
@@ -356,8 +356,18 @@
356
356
  "type": "object",
357
357
  "properties": {
358
358
  "value": {
359
- "type": "string",
360
- "maxLength": 255
359
+ "oneOf": [
360
+ {
361
+ "type": "string",
362
+ "maxLength": 255
363
+ },
364
+ {
365
+ "type": "number"
366
+ },
367
+ {
368
+ "type": "boolean"
369
+ }
370
+ ]
361
371
  }
362
372
  },
363
373
  "additionalProperties": false,
@@ -412,6 +422,10 @@
412
422
  "type": "string",
413
423
  "maxLength": 255
414
424
  },
425
+ "expression": {
426
+ "type": "string",
427
+ "maxLength": 255
428
+ },
415
429
  "yAxisLabel": {
416
430
  "type": "string",
417
431
  "maxLength": 255
@@ -606,8 +620,18 @@
606
620
  "type": "object",
607
621
  "properties": {
608
622
  "value": {
609
- "type": "string",
610
- "maxLength": 255
623
+ "oneOf": [
624
+ {
625
+ "type": "string",
626
+ "maxLength": 255
627
+ },
628
+ {
629
+ "type": "number"
630
+ },
631
+ {
632
+ "type": "boolean"
633
+ }
634
+ ]
611
635
  }
612
636
  },
613
637
  "additionalProperties": false,
@@ -769,8 +793,18 @@
769
793
  "type": "object",
770
794
  "properties": {
771
795
  "value": {
772
- "type": "string",
773
- "maxLength": 255
796
+ "oneOf": [
797
+ {
798
+ "type": "string",
799
+ "maxLength": 255
800
+ },
801
+ {
802
+ "type": "number"
803
+ },
804
+ {
805
+ "type": "boolean"
806
+ }
807
+ ]
774
808
  }
775
809
  },
776
810
  "additionalProperties": false,
@@ -1274,6 +1308,9 @@
1274
1308
  "type": "string",
1275
1309
  "maxLength": 255
1276
1310
  }
1311
+ },
1312
+ "includeDeviceInfo": {
1313
+ "type": "boolean"
1277
1314
  }
1278
1315
  },
1279
1316
  "additionalProperties": false
@@ -1751,8 +1788,18 @@
1751
1788
  "type": "object",
1752
1789
  "properties": {
1753
1790
  "value": {
1754
- "type": "string",
1755
- "maxLength": 255
1791
+ "oneOf": [
1792
+ {
1793
+ "type": "string",
1794
+ "maxLength": 255
1795
+ },
1796
+ {
1797
+ "type": "number"
1798
+ },
1799
+ {
1800
+ "type": "boolean"
1801
+ }
1802
+ ]
1756
1803
  }
1757
1804
  },
1758
1805
  "additionalProperties": false,
@@ -1807,6 +1854,10 @@
1807
1854
  "type": "string",
1808
1855
  "maxLength": 255
1809
1856
  },
1857
+ "expression": {
1858
+ "type": "string",
1859
+ "maxLength": 255
1860
+ },
1810
1861
  "yAxisLabel": {
1811
1862
  "type": "string",
1812
1863
  "maxLength": 255
@@ -2037,8 +2088,18 @@
2037
2088
  "type": "object",
2038
2089
  "properties": {
2039
2090
  "value": {
2040
- "type": "string",
2041
- "maxLength": 255
2091
+ "oneOf": [
2092
+ {
2093
+ "type": "string",
2094
+ "maxLength": 255
2095
+ },
2096
+ {
2097
+ "type": "number"
2098
+ },
2099
+ {
2100
+ "type": "boolean"
2101
+ }
2102
+ ]
2042
2103
  }
2043
2104
  },
2044
2105
  "additionalProperties": false,
@@ -2312,6 +2373,10 @@
2312
2373
  "normal",
2313
2374
  "satellite"
2314
2375
  ]
2376
+ },
2377
+ "query": {
2378
+ "type": "string",
2379
+ "maxLength": 32767
2315
2380
  }
2316
2381
  },
2317
2382
  "additionalProperties": false
@@ -2519,7 +2584,7 @@
2519
2584
  },
2520
2585
  "segments": {
2521
2586
  "type": "array",
2522
- "maxItems": 100,
2587
+ "maxItems": 300,
2523
2588
  "items": {
2524
2589
  "oneOf": [
2525
2590
  {
@@ -2615,8 +2680,18 @@
2615
2680
  "type": "object",
2616
2681
  "properties": {
2617
2682
  "value": {
2618
- "type": "string",
2619
- "maxLength": 255
2683
+ "oneOf": [
2684
+ {
2685
+ "type": "string",
2686
+ "maxLength": 255
2687
+ },
2688
+ {
2689
+ "type": "number"
2690
+ },
2691
+ {
2692
+ "type": "boolean"
2693
+ }
2694
+ ]
2620
2695
  }
2621
2696
  },
2622
2697
  "additionalProperties": false,
@@ -3209,8 +3284,18 @@
3209
3284
  "type": "object",
3210
3285
  "properties": {
3211
3286
  "value": {
3212
- "type": "string",
3213
- "maxLength": 255
3287
+ "oneOf": [
3288
+ {
3289
+ "type": "string",
3290
+ "maxLength": 255
3291
+ },
3292
+ {
3293
+ "type": "number"
3294
+ },
3295
+ {
3296
+ "type": "boolean"
3297
+ }
3298
+ ]
3214
3299
  }
3215
3300
  },
3216
3301
  "additionalProperties": false,
@@ -3265,6 +3350,10 @@
3265
3350
  "type": "string",
3266
3351
  "maxLength": 255
3267
3352
  },
3353
+ "expression": {
3354
+ "type": "string",
3355
+ "maxLength": 255
3356
+ },
3268
3357
  "yAxisLabel": {
3269
3358
  "type": "string",
3270
3359
  "maxLength": 255
@@ -3552,8 +3641,18 @@
3552
3641
  "type": "object",
3553
3642
  "properties": {
3554
3643
  "value": {
3555
- "type": "string",
3556
- "maxLength": 255
3644
+ "oneOf": [
3645
+ {
3646
+ "type": "string",
3647
+ "maxLength": 255
3648
+ },
3649
+ {
3650
+ "type": "number"
3651
+ },
3652
+ {
3653
+ "type": "boolean"
3654
+ }
3655
+ ]
3557
3656
  }
3558
3657
  },
3559
3658
  "additionalProperties": false,
@@ -3776,8 +3875,18 @@
3776
3875
  "type": "object",
3777
3876
  "properties": {
3778
3877
  "value": {
3779
- "type": "string",
3780
- "maxLength": 255
3878
+ "oneOf": [
3879
+ {
3880
+ "type": "string",
3881
+ "maxLength": 255
3882
+ },
3883
+ {
3884
+ "type": "number"
3885
+ },
3886
+ {
3887
+ "type": "boolean"
3888
+ }
3889
+ ]
3781
3890
  }
3782
3891
  },
3783
3892
  "additionalProperties": false,
@@ -3829,6 +3938,9 @@
3829
3938
  },
3830
3939
  "defaultValue": {
3831
3940
  "type": "boolean"
3941
+ },
3942
+ "includeLabel": {
3943
+ "type": "boolean"
3832
3944
  }
3833
3945
  },
3834
3946
  "additionalProperties": false
@@ -3955,8 +4067,18 @@
3955
4067
  "type": "object",
3956
4068
  "properties": {
3957
4069
  "value": {
3958
- "type": "string",
3959
- "maxLength": 255
4070
+ "oneOf": [
4071
+ {
4072
+ "type": "string",
4073
+ "maxLength": 255
4074
+ },
4075
+ {
4076
+ "type": "number"
4077
+ },
4078
+ {
4079
+ "type": "boolean"
4080
+ }
4081
+ ]
3960
4082
  }
3961
4083
  },
3962
4084
  "additionalProperties": false,
@@ -4135,8 +4257,18 @@
4135
4257
  "type": "object",
4136
4258
  "properties": {
4137
4259
  "value": {
4138
- "type": "string",
4139
- "maxLength": 255
4260
+ "oneOf": [
4261
+ {
4262
+ "type": "string",
4263
+ "maxLength": 255
4264
+ },
4265
+ {
4266
+ "type": "number"
4267
+ },
4268
+ {
4269
+ "type": "boolean"
4270
+ }
4271
+ ]
4140
4272
  }
4141
4273
  },
4142
4274
  "additionalProperties": false,
@@ -4541,6 +4673,10 @@
4541
4673
  "type": "string",
4542
4674
  "maxLength": 32767
4543
4675
  },
4676
+ "query": {
4677
+ "type": "string",
4678
+ "maxLength": 32767
4679
+ },
4544
4680
  "resizedPins": {
4545
4681
  "type": "boolean"
4546
4682
  },
@@ -4781,8 +4917,18 @@
4781
4917
  "type": "object",
4782
4918
  "properties": {
4783
4919
  "value": {
4784
- "type": "string",
4785
- "maxLength": 255
4920
+ "oneOf": [
4921
+ {
4922
+ "type": "string",
4923
+ "maxLength": 255
4924
+ },
4925
+ {
4926
+ "type": "number"
4927
+ },
4928
+ {
4929
+ "type": "boolean"
4930
+ }
4931
+ ]
4786
4932
  }
4787
4933
  },
4788
4934
  "additionalProperties": false,
@@ -4837,6 +4983,10 @@
4837
4983
  "type": "string",
4838
4984
  "maxLength": 255
4839
4985
  },
4986
+ "expression": {
4987
+ "type": "string",
4988
+ "maxLength": 255
4989
+ },
4840
4990
  "yAxisLabel": {
4841
4991
  "type": "string",
4842
4992
  "maxLength": 255
data/schemas/dataExport.json CHANGED
@@ -7,6 +7,10 @@
7
7
  "format": "email",
8
8
  "maxLength": 1024
9
9
  },
10
+ "callbackUrl": {
11
+ "type": "string",
12
+ "maxLength": 1024
13
+ },
10
14
  "deviceIds": {
11
15
  "type": "array",
12
16
  "items": {
@@ -34,6 +38,140 @@
34
38
  },
35
39
  "maxItems": 100
36
40
  },
41
+ "deviceQuery": {
42
+ "title": "Advanced Query",
43
+ "description": "Schema for advanced filters and queries",
44
+ "type": "object",
45
+ "properties": {
46
+ "$and": {
47
+ "type": "array",
48
+ "items": {
49
+ "$ref": "#/definitions/advancedQuery"
50
+ },
51
+ "maxItems": 100
52
+ },
53
+ "$or": {
54
+ "type": "array",
55
+ "items": {
56
+ "$ref": "#/definitions/advancedQuery"
57
+ },
58
+ "maxItems": 100
59
+ },
60
+ "$nor": {
61
+ "type": "array",
62
+ "items": {
63
+ "$ref": "#/definitions/advancedQuery"
64
+ },
65
+ "maxItems": 100
66
+ }
67
+ },
68
+ "patternProperties": {
69
+ "^[0-9a-zA-Z_-]{1,255}$": {
70
+ "oneOf": [
71
+ {
72
+ "type": [
73
+ "string",
74
+ "number",
75
+ "boolean",
76
+ "null"
77
+ ]
78
+ },
79
+ {
80
+ "type": "object",
81
+ "properties": {
82
+ "$eq": {
83
+ "type": [
84
+ "string",
85
+ "number",
86
+ "boolean",
87
+ "null"
88
+ ]
89
+ },
90
+ "$ne": {
91
+ "type": [
92
+ "string",
93
+ "number",
94
+ "boolean",
95
+ "null"
96
+ ]
97
+ },
98
+ "$gt": {
99
+ "type": [
100
+ "string",
101
+ "number",
102
+ "boolean",
103
+ "null"
104
+ ]
105
+ },
106
+ "$lt": {
107
+ "type": [
108
+ "string",
109
+ "number",
110
+ "boolean",
111
+ "null"
112
+ ]
113
+ },
114
+ "$gte": {
115
+ "type": [
116
+ "string",
117
+ "number",
118
+ "boolean",
119
+ "null"
120
+ ]
121
+ },
122
+ "$lte": {
123
+ "type": [
124
+ "string",
125
+ "number",
126
+ "boolean",
127
+ "null"
128
+ ]
129
+ },
130
+ "$startsWith": {
131
+ "type": "string",
132
+ "minLength": 1
133
+ },
134
+ "$endsWith": {
135
+ "type": "string",
136
+ "minLength": 1
137
+ },
138
+ "$contains": {
139
+ "type": "string",
140
+ "minLength": 1
141
+ },
142
+ "$ci": {
143
+ "type": "boolean"
144
+ },
145
+ "$in": {
146
+ "type": "array",
147
+ "maxItems": 100,
148
+ "items": {
149
+ "type": [
150
+ "string",
151
+ "number",
152
+ "boolean"
153
+ ]
154
+ }
155
+ },
156
+ "$nin": {
157
+ "type": "array",
158
+ "maxItems": 100,
159
+ "items": {
160
+ "type": [
161
+ "string",
162
+ "number",
163
+ "boolean"
164
+ ]
165
+ }
166
+ }
167
+ },
168
+ "additionalProperties": false
169
+ }
170
+ ]
171
+ }
172
+ },
173
+ "additionalProperties": false
174
+ },
37
175
  "attributes": {
38
176
  "type": "array",
39
177
  "items": {
@@ -57,6 +195,10 @@
57
195
  "includeID": {
58
196
  "type": "boolean",
59
197
  "default": true
198
+ },
199
+ "includeBlobData": {
200
+ "type": "boolean",
201
+ "default": false
60
202
  }
61
203
  }
62
204
  }