losant_rest 1.9.1 → 1.10.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (166) hide show
  1. checksums.yaml +5 -5
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +41608 -19945
  5. data/docs/application.md +168 -4
  6. data/docs/applicationTemplates.md +50 -0
  7. data/docs/applications.md +46 -0
  8. data/docs/auth.md +72 -0
  9. data/docs/device.md +1 -0
  10. data/docs/devices.md +89 -2
  11. data/docs/experienceEndpoint.md +43 -0
  12. data/docs/experienceEndpoints.md +1 -1
  13. data/docs/experienceView.md +43 -0
  14. data/lib/losant_rest.rb +2 -1
  15. data/lib/losant_rest/application.rb +144 -5
  16. data/lib/losant_rest/application_api_token.rb +1 -1
  17. data/lib/losant_rest/application_api_tokens.rb +1 -1
  18. data/lib/losant_rest/application_certificate.rb +1 -1
  19. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  20. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  21. data/lib/losant_rest/application_certificates.rb +1 -1
  22. data/lib/losant_rest/application_key.rb +1 -1
  23. data/lib/losant_rest/application_keys.rb +1 -1
  24. data/lib/losant_rest/application_templates.rb +88 -0
  25. data/lib/losant_rest/applications.rb +1 -1
  26. data/lib/losant_rest/audit_log.rb +1 -1
  27. data/lib/losant_rest/audit_logs.rb +1 -1
  28. data/lib/losant_rest/auth.rb +85 -1
  29. data/lib/losant_rest/client.rb +7 -3
  30. data/lib/losant_rest/dashboard.rb +1 -1
  31. data/lib/losant_rest/dashboards.rb +1 -1
  32. data/lib/losant_rest/data.rb +1 -1
  33. data/lib/losant_rest/data_table.rb +1 -1
  34. data/lib/losant_rest/data_table_row.rb +1 -1
  35. data/lib/losant_rest/data_table_rows.rb +1 -1
  36. data/lib/losant_rest/data_tables.rb +1 -1
  37. data/lib/losant_rest/device.rb +3 -1
  38. data/lib/losant_rest/device_recipe.rb +1 -1
  39. data/lib/losant_rest/device_recipes.rb +1 -1
  40. data/lib/losant_rest/devices.rb +105 -3
  41. data/lib/losant_rest/edge_deployments.rb +1 -1
  42. data/lib/losant_rest/error.rb +1 -1
  43. data/lib/losant_rest/event.rb +1 -1
  44. data/lib/losant_rest/events.rb +1 -1
  45. data/lib/losant_rest/experience.rb +1 -1
  46. data/lib/losant_rest/experience_domain.rb +1 -1
  47. data/lib/losant_rest/experience_domains.rb +1 -1
  48. data/lib/losant_rest/experience_endpoint.rb +51 -1
  49. data/lib/losant_rest/experience_endpoints.rb +1 -1
  50. data/lib/losant_rest/experience_group.rb +1 -1
  51. data/lib/losant_rest/experience_groups.rb +1 -1
  52. data/lib/losant_rest/experience_slug.rb +1 -1
  53. data/lib/losant_rest/experience_slugs.rb +1 -1
  54. data/lib/losant_rest/experience_user.rb +1 -1
  55. data/lib/losant_rest/experience_users.rb +1 -1
  56. data/lib/losant_rest/experience_version.rb +1 -1
  57. data/lib/losant_rest/experience_versions.rb +1 -1
  58. data/lib/losant_rest/experience_view.rb +51 -1
  59. data/lib/losant_rest/experience_views.rb +1 -1
  60. data/lib/losant_rest/file.rb +1 -1
  61. data/lib/losant_rest/files.rb +1 -1
  62. data/lib/losant_rest/flow.rb +1 -1
  63. data/lib/losant_rest/flow_version.rb +1 -1
  64. data/lib/losant_rest/flow_versions.rb +1 -1
  65. data/lib/losant_rest/flows.rb +1 -1
  66. data/lib/losant_rest/integration.rb +1 -1
  67. data/lib/losant_rest/integrations.rb +1 -1
  68. data/lib/losant_rest/me.rb +1 -1
  69. data/lib/losant_rest/notebook.rb +1 -1
  70. data/lib/losant_rest/notebooks.rb +1 -1
  71. data/lib/losant_rest/org.rb +1 -1
  72. data/lib/losant_rest/org_invites.rb +1 -1
  73. data/lib/losant_rest/orgs.rb +1 -1
  74. data/lib/losant_rest/utils.rb +1 -1
  75. data/lib/losant_rest/version.rb +2 -2
  76. data/lib/losant_rest/webhook.rb +1 -1
  77. data/lib/losant_rest/webhooks.rb +1 -1
  78. data/schemas/advancedDeviceQuery.json +1018 -0
  79. data/schemas/advancedEventQuery.json +382 -13
  80. data/schemas/advancedQuery.json +37 -3
  81. data/schemas/application.json +10 -5
  82. data/schemas/applicationApiTokenPost.json +6 -0
  83. data/schemas/applicationCertificate.json +34 -0
  84. data/schemas/applicationCertificatePatch.json +34 -0
  85. data/schemas/applicationCertificatePost.json +34 -0
  86. data/schemas/applicationCertificates.json +34 -0
  87. data/schemas/{applicationCloneResult.json → applicationCreationByTemplateResult.json} +21 -8
  88. data/schemas/applicationExportPost.json +24 -0
  89. data/schemas/applicationExportResult.json +10 -0
  90. data/schemas/applicationKey.json +34 -0
  91. data/schemas/applicationKeyPatch.json +34 -0
  92. data/schemas/applicationKeyPost.json +34 -0
  93. data/schemas/applicationKeyPostResponse.json +34 -0
  94. data/schemas/applicationKeys.json +34 -0
  95. data/schemas/applicationPatch.json +10 -5
  96. data/schemas/applicationPost.json +14 -5
  97. data/schemas/applicationReadme.json +29 -0
  98. data/schemas/applicationReadmePatch.json +11 -0
  99. data/schemas/applicationTemplate.json +99 -0
  100. data/schemas/applicationTemplates.json +140 -0
  101. data/schemas/applications.json +10 -5
  102. data/schemas/authedDevice.json +34 -0
  103. data/schemas/dashboard.json +1228 -144
  104. data/schemas/dashboardPatch.json +1228 -144
  105. data/schemas/dashboardPost.json +1228 -144
  106. data/schemas/dashboards.json +1228 -144
  107. data/schemas/dataExport.json +11 -0
  108. data/schemas/dataTableRows.json +3 -0
  109. data/schemas/dataTableRowsExport.json +37 -3
  110. data/schemas/device.json +16 -3
  111. data/schemas/devicePatch.json +16 -3
  112. data/schemas/devicePost.json +16 -3
  113. data/schemas/deviceRecipe.json +16 -3
  114. data/schemas/deviceRecipePatch.json +16 -3
  115. data/schemas/deviceRecipePost.json +16 -3
  116. data/schemas/deviceRecipes.json +16 -3
  117. data/schemas/devices.json +19 -3
  118. data/schemas/devicesDataRemoved.json +12 -0
  119. data/schemas/devicesDeletePost.json +1034 -0
  120. data/schemas/devicesDeleted.json +12 -0
  121. data/schemas/devicesExportPost.json +1035 -0
  122. data/schemas/devicesPatch.json +1773 -7
  123. data/schemas/devicesRemoveDataPost.json +1056 -0
  124. data/schemas/devicesUpdated.json +18 -0
  125. data/schemas/events.json +1 -816
  126. data/schemas/eventsExport.json +382 -13
  127. data/schemas/experienceGroup.json +7 -0
  128. data/schemas/experienceGroupPatch.json +7 -0
  129. data/schemas/experienceGroupPost.json +7 -0
  130. data/schemas/experienceGroups.json +7 -0
  131. data/schemas/experienceLinkedResources.json +6659 -0
  132. data/schemas/flow.json +103 -1
  133. data/schemas/flowPatch.json +103 -1
  134. data/schemas/flowPost.json +103 -1
  135. data/schemas/flowVersion.json +206 -2
  136. data/schemas/flowVersionPost.json +103 -1
  137. data/schemas/flowVersions.json +206 -2
  138. data/schemas/flows.json +103 -1
  139. data/schemas/flowsImportPost.json +206 -2
  140. data/schemas/flowsImportResult.json +309 -3
  141. data/schemas/githubLogin.json +9 -0
  142. data/schemas/integration.json +4 -4
  143. data/schemas/integrationPatch.json +4 -4
  144. data/schemas/integrationPost.json +4 -4
  145. data/schemas/integrations.json +4 -4
  146. data/schemas/{applicationCloneEnqueued.json → jobEnqueuedResult.json} +0 -0
  147. data/schemas/me.json +3 -0
  148. data/schemas/multiDeviceCommand.json +1019 -0
  149. data/schemas/notebook.json +207 -35
  150. data/schemas/notebookDataExportOptions.json +4 -0
  151. data/schemas/notebookExecutionLogs.json +4 -0
  152. data/schemas/notebookExecutionOptions.json +4 -0
  153. data/schemas/notebookPatch.json +207 -35
  154. data/schemas/notebookPost.json +207 -35
  155. data/schemas/notebooks.json +207 -35
  156. data/schemas/org.json +8 -0
  157. data/schemas/orgPatch.json +9 -0
  158. data/schemas/orgs.json +8 -0
  159. data/schemas/samlResponse.json +21 -0
  160. data/schemas/ssoRequest.json +20 -0
  161. data/schemas/timeSeriesData.json +91 -12
  162. data/schemas/timeSeriesQuery.json +21 -12
  163. data/schemas/userCredentials.json +9 -0
  164. data/schemas/userPost.json +9 -0
  165. data/schemas/{validationCloneErrors.json → validationErrors.json} +9 -2
  166. metadata +24 -7
data/schemas/eventsExport.json CHANGED
@@ -16,13 +16,22 @@
16
16
  "type": "array",
17
17
  "items": {
18
18
  "$ref": "#/definitions/advancedEventQuery"
19
- }
19
+ },
20
+ "maxItems": 100
20
21
  },
21
22
  "$or": {
22
23
  "type": "array",
23
24
  "items": {
24
25
  "$ref": "#/definitions/advancedEventQuery"
25
- }
26
+ },
27
+ "maxItems": 100
28
+ },
29
+ "$nor": {
30
+ "type": "array",
31
+ "items": {
32
+ "$ref": "#/definitions/advancedEventQuery"
33
+ },
34
+ "maxItems": 100
26
35
  },
27
36
  "id": {
28
37
  "oneOf": [
@@ -96,6 +105,31 @@
96
105
  "$contains": {
97
106
  "type": "string",
98
107
  "minLength": 1
108
+ },
109
+ "$ci": {
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
+ }
99
133
  }
100
134
  },
101
135
  "additionalProperties": false
@@ -174,6 +208,31 @@
174
208
  "$contains": {
175
209
  "type": "string",
176
210
  "minLength": 1
211
+ },
212
+ "$ci": {
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
+ }
177
236
  }
178
237
  },
179
238
  "additionalProperties": false
@@ -252,6 +311,31 @@
252
311
  "$contains": {
253
312
  "type": "string",
254
313
  "minLength": 1
314
+ },
315
+ "$ci": {
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
+ }
255
339
  }
256
340
  },
257
341
  "additionalProperties": false
@@ -330,6 +414,31 @@
330
414
  "$contains": {
331
415
  "type": "string",
332
416
  "minLength": 1
417
+ },
418
+ "$ci": {
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
+ }
333
442
  }
334
443
  },
335
444
  "additionalProperties": false
@@ -408,6 +517,31 @@
408
517
  "$contains": {
409
518
  "type": "string",
410
519
  "minLength": 1
520
+ },
521
+ "$ci": {
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
+ }
411
545
  }
412
546
  },
413
547
  "additionalProperties": false
@@ -486,6 +620,31 @@
486
620
  "$contains": {
487
621
  "type": "string",
488
622
  "minLength": 1
623
+ },
624
+ "$ci": {
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
+ }
489
648
  }
490
649
  },
491
650
  "additionalProperties": false
@@ -564,6 +723,31 @@
564
723
  "$contains": {
565
724
  "type": "string",
566
725
  "minLength": 1
726
+ },
727
+ "$ci": {
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
+ }
567
751
  }
568
752
  },
569
753
  "additionalProperties": false
@@ -642,6 +826,31 @@
642
826
  "$contains": {
643
827
  "type": "string",
644
828
  "minLength": 1
829
+ },
830
+ "$ci": {
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
+ }
645
854
  }
646
855
  },
647
856
  "additionalProperties": false
@@ -720,12 +929,159 @@
720
929
  "$contains": {
721
930
  "type": "string",
722
931
  "minLength": 1
932
+ },
933
+ "$ci": {
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
+ }
723
957
  }
724
958
  },
725
959
  "additionalProperties": false
726
960
  }
727
961
  ]
728
962
  },
963
+ "experienceUserId": {
964
+ "oneOf": [
965
+ {
966
+ "oneOf": [
967
+ {
968
+ "type": "string",
969
+ "pattern": "^[A-Fa-f\\d]{24}$"
970
+ },
971
+ {
972
+ "type": "null"
973
+ }
974
+ ]
975
+ },
976
+ {
977
+ "type": "object",
978
+ "properties": {
979
+ "$eq": {
980
+ "oneOf": [
981
+ {
982
+ "type": "string",
983
+ "pattern": "^[A-Fa-f\\d]{24}$"
984
+ },
985
+ {
986
+ "type": "null"
987
+ }
988
+ ]
989
+ },
990
+ "$ne": {
991
+ "oneOf": [
992
+ {
993
+ "type": "string",
994
+ "pattern": "^[A-Fa-f\\d]{24}$"
995
+ },
996
+ {
997
+ "type": "null"
998
+ }
999
+ ]
1000
+ },
1001
+ "$in": {
1002
+ "type": "array",
1003
+ "maxItems": 100,
1004
+ "items": {
1005
+ "type": "string",
1006
+ "pattern": "^[A-Fa-f\\d]{24}$"
1007
+ }
1008
+ },
1009
+ "$nin": {
1010
+ "type": "array",
1011
+ "maxItems": 100,
1012
+ "items": {
1013
+ "type": "string",
1014
+ "pattern": "^[A-Fa-f\\d]{24}$"
1015
+ }
1016
+ }
1017
+ },
1018
+ "additionalProperties": false,
1019
+ "minProperties": 1,
1020
+ "maxProperties": 1
1021
+ }
1022
+ ]
1023
+ },
1024
+ "experienceGroupId": {
1025
+ "oneOf": [
1026
+ {
1027
+ "oneOf": [
1028
+ {
1029
+ "type": "string",
1030
+ "pattern": "^[A-Fa-f\\d]{24}$"
1031
+ },
1032
+ {
1033
+ "type": "null"
1034
+ }
1035
+ ]
1036
+ },
1037
+ {
1038
+ "type": "object",
1039
+ "properties": {
1040
+ "$eq": {
1041
+ "oneOf": [
1042
+ {
1043
+ "type": "string",
1044
+ "pattern": "^[A-Fa-f\\d]{24}$"
1045
+ },
1046
+ {
1047
+ "type": "null"
1048
+ }
1049
+ ]
1050
+ },
1051
+ "$ne": {
1052
+ "oneOf": [
1053
+ {
1054
+ "type": "string",
1055
+ "pattern": "^[A-Fa-f\\d]{24}$"
1056
+ },
1057
+ {
1058
+ "type": "null"
1059
+ }
1060
+ ]
1061
+ },
1062
+ "$in": {
1063
+ "type": "array",
1064
+ "maxItems": 100,
1065
+ "items": {
1066
+ "type": "string",
1067
+ "pattern": "^[A-Fa-f\\d]{24}$"
1068
+ }
1069
+ },
1070
+ "$nin": {
1071
+ "type": "array",
1072
+ "maxItems": 100,
1073
+ "items": {
1074
+ "type": "string",
1075
+ "pattern": "^[A-Fa-f\\d]{24}$"
1076
+ }
1077
+ }
1078
+ },
1079
+ "additionalProperties": false,
1080
+ "minProperties": 1,
1081
+ "maxProperties": 1
1082
+ }
1083
+ ]
1084
+ },
729
1085
  "eventTags": {
730
1086
  "oneOf": [
731
1087
  {
@@ -734,10 +1090,12 @@
734
1090
  "type": "object",
735
1091
  "properties": {
736
1092
  "$tagKey": {
737
- "type": "string"
1093
+ "type": "string",
1094
+ "maxLength": 255
738
1095
  },
739
1096
  "$tagValue": {
740
- "type": "string"
1097
+ "type": "string",
1098
+ "maxLength": 255
741
1099
  }
742
1100
  },
743
1101
  "additionalProperties": false,
@@ -747,7 +1105,8 @@
747
1105
  "type": "object",
748
1106
  "patternProperties": {
749
1107
  "^[0-9a-zA-Z_-]{1,255}": {
750
- "type": "string"
1108
+ "type": "string",
1109
+ "maxLength": 255
751
1110
  }
752
1111
  },
753
1112
  "additionalProperties": false
@@ -763,10 +1122,12 @@
763
1122
  "type": "object",
764
1123
  "properties": {
765
1124
  "$tagKey": {
766
- "type": "string"
1125
+ "type": "string",
1126
+ "maxLength": 255
767
1127
  },
768
1128
  "$tagValue": {
769
- "type": "string"
1129
+ "type": "string",
1130
+ "maxLength": 255
770
1131
  }
771
1132
  },
772
1133
  "additionalProperties": false,
@@ -776,7 +1137,8 @@
776
1137
  "type": "object",
777
1138
  "patternProperties": {
778
1139
  "^[0-9a-zA-Z_-]{1,255}": {
779
- "type": "string"
1140
+ "type": "string",
1141
+ "maxLength": 255
780
1142
  }
781
1143
  },
782
1144
  "additionalProperties": false
@@ -784,7 +1146,9 @@
784
1146
  ]
785
1147
  }
786
1148
  },
787
- "minProperties": 1,
1149
+ "required": [
1150
+ "$eq"
1151
+ ],
788
1152
  "additionalProperties": false
789
1153
  },
790
1154
  {
@@ -796,10 +1160,12 @@
796
1160
  "type": "object",
797
1161
  "properties": {
798
1162
  "$tagKey": {
799
- "type": "string"
1163
+ "type": "string",
1164
+ "maxLength": 255
800
1165
  },
801
1166
  "$tagValue": {
802
- "type": "string"
1167
+ "type": "string",
1168
+ "maxLength": 255
803
1169
  }
804
1170
  },
805
1171
  "additionalProperties": false,
@@ -809,7 +1175,8 @@
809
1175
  "type": "object",
810
1176
  "patternProperties": {
811
1177
  "^[0-9a-zA-Z_-]{1,255}": {
812
- "type": "string"
1178
+ "type": "string",
1179
+ "maxLength": 255
813
1180
  }
814
1181
  },
815
1182
  "additionalProperties": false
@@ -817,7 +1184,9 @@
817
1184
  ]
818
1185
  }
819
1186
  },
820
- "minProperties": 1,
1187
+ "required": [
1188
+ "$ne"
1189
+ ],
821
1190
  "additionalProperties": false
822
1191
  }
823
1192
  ]