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/advancedEventQuery.json CHANGED
@@ -6,13 +6,22 @@
6
6
  "type": "array",
7
7
  "items": {
8
8
  "$ref": "#/definitions/advancedEventQuery"
9
- }
9
+ },
10
+ "maxItems": 100
10
11
  },
11
12
  "$or": {
12
13
  "type": "array",
13
14
  "items": {
14
15
  "$ref": "#/definitions/advancedEventQuery"
15
- }
16
+ },
17
+ "maxItems": 100
18
+ },
19
+ "$nor": {
20
+ "type": "array",
21
+ "items": {
22
+ "$ref": "#/definitions/advancedEventQuery"
23
+ },
24
+ "maxItems": 100
16
25
  },
17
26
  "id": {
18
27
  "oneOf": [
@@ -86,6 +95,31 @@
86
95
  "$contains": {
87
96
  "type": "string",
88
97
  "minLength": 1
98
+ },
99
+ "$ci": {
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
+ }
89
123
  }
90
124
  },
91
125
  "additionalProperties": false
@@ -164,6 +198,31 @@
164
198
  "$contains": {
165
199
  "type": "string",
166
200
  "minLength": 1
201
+ },
202
+ "$ci": {
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
+ }
167
226
  }
168
227
  },
169
228
  "additionalProperties": false
@@ -242,6 +301,31 @@
242
301
  "$contains": {
243
302
  "type": "string",
244
303
  "minLength": 1
304
+ },
305
+ "$ci": {
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
+ }
245
329
  }
246
330
  },
247
331
  "additionalProperties": false
@@ -320,6 +404,31 @@
320
404
  "$contains": {
321
405
  "type": "string",
322
406
  "minLength": 1
407
+ },
408
+ "$ci": {
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
+ }
323
432
  }
324
433
  },
325
434
  "additionalProperties": false
@@ -398,6 +507,31 @@
398
507
  "$contains": {
399
508
  "type": "string",
400
509
  "minLength": 1
510
+ },
511
+ "$ci": {
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
+ }
401
535
  }
402
536
  },
403
537
  "additionalProperties": false
@@ -476,6 +610,31 @@
476
610
  "$contains": {
477
611
  "type": "string",
478
612
  "minLength": 1
613
+ },
614
+ "$ci": {
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
+ }
479
638
  }
480
639
  },
481
640
  "additionalProperties": false
@@ -554,6 +713,31 @@
554
713
  "$contains": {
555
714
  "type": "string",
556
715
  "minLength": 1
716
+ },
717
+ "$ci": {
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
+ }
557
741
  }
558
742
  },
559
743
  "additionalProperties": false
@@ -632,6 +816,31 @@
632
816
  "$contains": {
633
817
  "type": "string",
634
818
  "minLength": 1
819
+ },
820
+ "$ci": {
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
+ }
635
844
  }
636
845
  },
637
846
  "additionalProperties": false
@@ -710,12 +919,159 @@
710
919
  "$contains": {
711
920
  "type": "string",
712
921
  "minLength": 1
922
+ },
923
+ "$ci": {
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
+ }
713
947
  }
714
948
  },
715
949
  "additionalProperties": false
716
950
  }
717
951
  ]
718
952
  },
953
+ "experienceUserId": {
954
+ "oneOf": [
955
+ {
956
+ "oneOf": [
957
+ {
958
+ "type": "string",
959
+ "pattern": "^[A-Fa-f\\d]{24}$"
960
+ },
961
+ {
962
+ "type": "null"
963
+ }
964
+ ]
965
+ },
966
+ {
967
+ "type": "object",
968
+ "properties": {
969
+ "$eq": {
970
+ "oneOf": [
971
+ {
972
+ "type": "string",
973
+ "pattern": "^[A-Fa-f\\d]{24}$"
974
+ },
975
+ {
976
+ "type": "null"
977
+ }
978
+ ]
979
+ },
980
+ "$ne": {
981
+ "oneOf": [
982
+ {
983
+ "type": "string",
984
+ "pattern": "^[A-Fa-f\\d]{24}$"
985
+ },
986
+ {
987
+ "type": "null"
988
+ }
989
+ ]
990
+ },
991
+ "$in": {
992
+ "type": "array",
993
+ "maxItems": 100,
994
+ "items": {
995
+ "type": "string",
996
+ "pattern": "^[A-Fa-f\\d]{24}$"
997
+ }
998
+ },
999
+ "$nin": {
1000
+ "type": "array",
1001
+ "maxItems": 100,
1002
+ "items": {
1003
+ "type": "string",
1004
+ "pattern": "^[A-Fa-f\\d]{24}$"
1005
+ }
1006
+ }
1007
+ },
1008
+ "additionalProperties": false,
1009
+ "minProperties": 1,
1010
+ "maxProperties": 1
1011
+ }
1012
+ ]
1013
+ },
1014
+ "experienceGroupId": {
1015
+ "oneOf": [
1016
+ {
1017
+ "oneOf": [
1018
+ {
1019
+ "type": "string",
1020
+ "pattern": "^[A-Fa-f\\d]{24}$"
1021
+ },
1022
+ {
1023
+ "type": "null"
1024
+ }
1025
+ ]
1026
+ },
1027
+ {
1028
+ "type": "object",
1029
+ "properties": {
1030
+ "$eq": {
1031
+ "oneOf": [
1032
+ {
1033
+ "type": "string",
1034
+ "pattern": "^[A-Fa-f\\d]{24}$"
1035
+ },
1036
+ {
1037
+ "type": "null"
1038
+ }
1039
+ ]
1040
+ },
1041
+ "$ne": {
1042
+ "oneOf": [
1043
+ {
1044
+ "type": "string",
1045
+ "pattern": "^[A-Fa-f\\d]{24}$"
1046
+ },
1047
+ {
1048
+ "type": "null"
1049
+ }
1050
+ ]
1051
+ },
1052
+ "$in": {
1053
+ "type": "array",
1054
+ "maxItems": 100,
1055
+ "items": {
1056
+ "type": "string",
1057
+ "pattern": "^[A-Fa-f\\d]{24}$"
1058
+ }
1059
+ },
1060
+ "$nin": {
1061
+ "type": "array",
1062
+ "maxItems": 100,
1063
+ "items": {
1064
+ "type": "string",
1065
+ "pattern": "^[A-Fa-f\\d]{24}$"
1066
+ }
1067
+ }
1068
+ },
1069
+ "additionalProperties": false,
1070
+ "minProperties": 1,
1071
+ "maxProperties": 1
1072
+ }
1073
+ ]
1074
+ },
719
1075
  "eventTags": {
720
1076
  "oneOf": [
721
1077
  {
@@ -724,10 +1080,12 @@
724
1080
  "type": "object",
725
1081
  "properties": {
726
1082
  "$tagKey": {
727
- "type": "string"
1083
+ "type": "string",
1084
+ "maxLength": 255
728
1085
  },
729
1086
  "$tagValue": {
730
- "type": "string"
1087
+ "type": "string",
1088
+ "maxLength": 255
731
1089
  }
732
1090
  },
733
1091
  "additionalProperties": false,
@@ -737,7 +1095,8 @@
737
1095
  "type": "object",
738
1096
  "patternProperties": {
739
1097
  "^[0-9a-zA-Z_-]{1,255}": {
740
- "type": "string"
1098
+ "type": "string",
1099
+ "maxLength": 255
741
1100
  }
742
1101
  },
743
1102
  "additionalProperties": false
@@ -753,10 +1112,12 @@
753
1112
  "type": "object",
754
1113
  "properties": {
755
1114
  "$tagKey": {
756
- "type": "string"
1115
+ "type": "string",
1116
+ "maxLength": 255
757
1117
  },
758
1118
  "$tagValue": {
759
- "type": "string"
1119
+ "type": "string",
1120
+ "maxLength": 255
760
1121
  }
761
1122
  },
762
1123
  "additionalProperties": false,
@@ -766,7 +1127,8 @@
766
1127
  "type": "object",
767
1128
  "patternProperties": {
768
1129
  "^[0-9a-zA-Z_-]{1,255}": {
769
- "type": "string"
1130
+ "type": "string",
1131
+ "maxLength": 255
770
1132
  }
771
1133
  },
772
1134
  "additionalProperties": false
@@ -774,7 +1136,9 @@
774
1136
  ]
775
1137
  }
776
1138
  },
777
- "minProperties": 1,
1139
+ "required": [
1140
+ "$eq"
1141
+ ],
778
1142
  "additionalProperties": false
779
1143
  },
780
1144
  {
@@ -786,10 +1150,12 @@
786
1150
  "type": "object",
787
1151
  "properties": {
788
1152
  "$tagKey": {
789
- "type": "string"
1153
+ "type": "string",
1154
+ "maxLength": 255
790
1155
  },
791
1156
  "$tagValue": {
792
- "type": "string"
1157
+ "type": "string",
1158
+ "maxLength": 255
793
1159
  }
794
1160
  },
795
1161
  "additionalProperties": false,
@@ -799,7 +1165,8 @@
799
1165
  "type": "object",
800
1166
  "patternProperties": {
801
1167
  "^[0-9a-zA-Z_-]{1,255}": {
802
- "type": "string"
1168
+ "type": "string",
1169
+ "maxLength": 255
803
1170
  }
804
1171
  },
805
1172
  "additionalProperties": false
@@ -807,7 +1174,9 @@
807
1174
  ]
808
1175
  }
809
1176
  },
810
- "minProperties": 1,
1177
+ "required": [
1178
+ "$ne"
1179
+ ],
811
1180
  "additionalProperties": false
812
1181
  }
813
1182
  ]