losant_rest 1.11.1 → 1.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (213) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +34959 -19022
  5. data/docs/application.md +46 -5
  6. data/docs/applicationApiTokens.md +1 -1
  7. data/docs/applicationDashboard.md +133 -0
  8. data/docs/applicationDashboards.md +93 -0
  9. data/docs/applicationKeys.md +3 -2
  10. data/docs/applications.md +1 -1
  11. data/docs/dataTable.md +1 -1
  12. data/docs/dataTableRows.md +1 -1
  13. data/docs/dataTables.md +1 -1
  14. data/docs/device.md +43 -0
  15. data/docs/devices.md +41 -2
  16. data/docs/edgeDeployment.md +49 -0
  17. data/docs/events.md +3 -3
  18. data/docs/experience.md +1 -1
  19. data/docs/experienceDomains.md +1 -1
  20. data/docs/experienceEndpoint.md +1 -0
  21. data/docs/experienceGroup.md +2 -0
  22. data/docs/experienceSlugs.md +1 -1
  23. data/docs/experienceVersion.md +3 -3
  24. data/docs/experienceVersions.md +2 -2
  25. data/docs/experienceView.md +4 -4
  26. data/docs/experienceViews.md +2 -2
  27. data/docs/file.md +5 -5
  28. data/docs/files.md +2 -2
  29. data/docs/flow.md +41 -0
  30. data/docs/flowVersions.md +44 -0
  31. data/docs/flows.md +1 -0
  32. data/docs/instance.md +166 -0
  33. data/docs/instanceApiToken.md +133 -0
  34. data/docs/instanceApiTokens.md +91 -0
  35. data/docs/instanceMember.md +133 -0
  36. data/docs/instanceMembers.md +91 -0
  37. data/docs/instanceOrg.md +135 -0
  38. data/docs/instanceOrgInvite.md +139 -0
  39. data/docs/instanceOrgInvites.md +96 -0
  40. data/docs/instanceOrgMember.md +139 -0
  41. data/docs/instanceOrgMembers.md +96 -0
  42. data/docs/instanceOrgs.md +91 -0
  43. data/docs/instances.md +50 -0
  44. data/docs/integration.md +1 -0
  45. data/docs/me.md +1 -1
  46. data/docs/org.md +1 -1
  47. data/docs/userApiToken.md +125 -0
  48. data/docs/userApiTokens.md +87 -0
  49. data/docs/webhook.md +1 -0
  50. data/lib/losant_rest.rb +18 -1
  51. data/lib/losant_rest/application.rb +53 -6
  52. data/lib/losant_rest/application_api_token.rb +1 -1
  53. data/lib/losant_rest/application_api_tokens.rb +2 -2
  54. data/lib/losant_rest/application_certificate.rb +1 -1
  55. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  56. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  57. data/lib/losant_rest/application_certificates.rb +1 -1
  58. data/lib/losant_rest/application_dashboard.rb +176 -0
  59. data/lib/losant_rest/application_dashboards.rb +138 -0
  60. data/lib/losant_rest/application_key.rb +1 -1
  61. data/lib/losant_rest/application_keys.rb +4 -1
  62. data/lib/losant_rest/application_template.rb +1 -1
  63. data/lib/losant_rest/application_templates.rb +1 -1
  64. data/lib/losant_rest/applications.rb +2 -2
  65. data/lib/losant_rest/audit_log.rb +1 -1
  66. data/lib/losant_rest/audit_logs.rb +1 -1
  67. data/lib/losant_rest/auth.rb +1 -1
  68. data/lib/losant_rest/client.rb +71 -3
  69. data/lib/losant_rest/dashboard.rb +1 -1
  70. data/lib/losant_rest/dashboards.rb +1 -1
  71. data/lib/losant_rest/data.rb +1 -1
  72. data/lib/losant_rest/data_table.rb +2 -2
  73. data/lib/losant_rest/data_table_row.rb +1 -1
  74. data/lib/losant_rest/data_table_rows.rb +2 -2
  75. data/lib/losant_rest/data_tables.rb +2 -2
  76. data/lib/losant_rest/device.rb +51 -1
  77. data/lib/losant_rest/device_recipe.rb +1 -1
  78. data/lib/losant_rest/device_recipes.rb +1 -1
  79. data/lib/losant_rest/devices.rb +49 -3
  80. data/lib/losant_rest/edge_deployment.rb +81 -0
  81. data/lib/losant_rest/edge_deployments.rb +1 -1
  82. data/lib/losant_rest/error.rb +1 -1
  83. data/lib/losant_rest/event.rb +1 -1
  84. data/lib/losant_rest/events.rb +4 -4
  85. data/lib/losant_rest/experience.rb +2 -2
  86. data/lib/losant_rest/experience_domain.rb +1 -1
  87. data/lib/losant_rest/experience_domains.rb +2 -2
  88. data/lib/losant_rest/experience_endpoint.rb +3 -1
  89. data/lib/losant_rest/experience_endpoints.rb +1 -1
  90. data/lib/losant_rest/experience_group.rb +5 -1
  91. data/lib/losant_rest/experience_groups.rb +1 -1
  92. data/lib/losant_rest/experience_slug.rb +1 -1
  93. data/lib/losant_rest/experience_slugs.rb +2 -2
  94. data/lib/losant_rest/experience_user.rb +1 -1
  95. data/lib/losant_rest/experience_users.rb +1 -1
  96. data/lib/losant_rest/experience_version.rb +4 -4
  97. data/lib/losant_rest/experience_versions.rb +3 -3
  98. data/lib/losant_rest/experience_view.rb +5 -5
  99. data/lib/losant_rest/experience_views.rb +3 -3
  100. data/lib/losant_rest/file.rb +5 -5
  101. data/lib/losant_rest/files.rb +3 -3
  102. data/lib/losant_rest/flow.rb +47 -1
  103. data/lib/losant_rest/flow_version.rb +1 -1
  104. data/lib/losant_rest/flow_versions.rb +51 -1
  105. data/lib/losant_rest/flows.rb +3 -1
  106. data/lib/losant_rest/instance.rb +226 -0
  107. data/lib/losant_rest/instance_api_token.rb +176 -0
  108. data/lib/losant_rest/instance_api_tokens.rb +136 -0
  109. data/lib/losant_rest/instance_member.rb +176 -0
  110. data/lib/losant_rest/instance_members.rb +134 -0
  111. data/lib/losant_rest/instance_org.rb +180 -0
  112. data/lib/losant_rest/instance_org_invite.rb +182 -0
  113. data/lib/losant_rest/instance_org_invites.rb +138 -0
  114. data/lib/losant_rest/instance_org_member.rb +182 -0
  115. data/lib/losant_rest/instance_org_members.rb +138 -0
  116. data/lib/losant_rest/instance_orgs.rb +139 -0
  117. data/lib/losant_rest/instances.rb +88 -0
  118. data/lib/losant_rest/integration.rb +3 -1
  119. data/lib/losant_rest/integrations.rb +1 -1
  120. data/lib/losant_rest/me.rb +2 -2
  121. data/lib/losant_rest/notebook.rb +1 -1
  122. data/lib/losant_rest/notebooks.rb +1 -1
  123. data/lib/losant_rest/org.rb +2 -2
  124. data/lib/losant_rest/org_invites.rb +1 -1
  125. data/lib/losant_rest/orgs.rb +1 -1
  126. data/lib/losant_rest/user_api_token.rb +170 -0
  127. data/lib/losant_rest/user_api_tokens.rb +132 -0
  128. data/lib/losant_rest/utils.rb +1 -1
  129. data/lib/losant_rest/version.rb +2 -2
  130. data/lib/losant_rest/webhook.rb +3 -1
  131. data/lib/losant_rest/webhooks.rb +1 -1
  132. data/schemas/advancedApplicationKeyQuery.json +1082 -0
  133. data/schemas/advancedDeviceQuery.json +309 -0
  134. data/schemas/advancedFlowQuery.json +218 -0
  135. data/schemas/advancedFlowVersionQuery.json +218 -0
  136. data/schemas/apiToken.json +2 -1
  137. data/schemas/apiTokenPost.json +431 -0
  138. data/schemas/apiTokens.json +4 -2
  139. data/schemas/applicationApiTokenPost.json +8 -0
  140. data/schemas/applicationDashboardPost.json +5687 -0
  141. data/schemas/applicationGlobalPatch.json +33 -0
  142. data/schemas/auditLog.json +4 -0
  143. data/schemas/auditLogFilter.json +4 -0
  144. data/schemas/auditLogs.json +4 -0
  145. data/schemas/bulkDeleteResponse.json +12 -0
  146. data/schemas/dashboard.json +66 -17
  147. data/schemas/dashboardPatch.json +66 -17
  148. data/schemas/dashboardPost.json +66 -17
  149. data/schemas/dashboardSendReport.json +4 -0
  150. data/schemas/dashboards.json +66 -17
  151. data/schemas/devicePayloadCounts.json +24 -0
  152. data/schemas/devicesDeletePost.json +309 -0
  153. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  154. data/schemas/devicesExportPost.json +309 -0
  155. data/schemas/devicesPatch.json +309 -0
  156. data/schemas/devicesRemoveDataPost.json +309 -0
  157. data/schemas/edgeDeployment.json +16 -0
  158. data/schemas/edgeDeployments.json +16 -0
  159. data/schemas/experienceGroup.json +6 -0
  160. data/schemas/experienceGroups.json +6 -0
  161. data/schemas/experienceLinkedResources.json +45 -0
  162. data/schemas/filePost.json +8 -2
  163. data/schemas/files.json +3 -0
  164. data/schemas/flow.json +15 -0
  165. data/schemas/flowPatch.json +15 -0
  166. data/schemas/flowPost.json +15 -0
  167. data/schemas/flowStorageMetadata.json +13 -0
  168. data/schemas/flowVersion.json +30 -0
  169. data/schemas/flowVersionPost.json +15 -0
  170. data/schemas/flowVersions.json +30 -0
  171. data/schemas/flowVersionsDeletePost.json +941 -0
  172. data/schemas/flows.json +15 -0
  173. data/schemas/flowsImportPost.json +30 -0
  174. data/schemas/flowsImportResult.json +45 -0
  175. data/schemas/githubLogin.json +72 -1
  176. data/schemas/historicalSummaries.json +43 -0
  177. data/schemas/historicalSummary.json +490 -0
  178. data/schemas/instance.json +192 -0
  179. data/schemas/instanceMember.json +41 -0
  180. data/schemas/instanceMemberPatch.json +17 -0
  181. data/schemas/instanceMemberPost.json +37 -0
  182. data/schemas/instanceMembers.json +77 -0
  183. data/schemas/instanceOrg.json +133 -0
  184. data/schemas/instanceOrgMember.json +45 -0
  185. data/schemas/instanceOrgMemberPatch.json +69 -0
  186. data/schemas/instanceOrgMemberPost.json +161 -0
  187. data/schemas/instanceOrgMembers.json +42 -0
  188. data/schemas/instanceOrgPatch.json +122 -0
  189. data/schemas/instanceOrgPost.json +291 -0
  190. data/schemas/instanceOrgs.json +178 -0
  191. data/schemas/instancePatch.json +67 -0
  192. data/schemas/instanceReportOptionsPost.json +41 -0
  193. data/schemas/instances.json +43 -0
  194. data/schemas/me.json +30 -14
  195. data/schemas/multiDeviceCommand.json +309 -0
  196. data/schemas/notebook.json +45 -0
  197. data/schemas/notebookPatch.json +30 -0
  198. data/schemas/notebookPost.json +30 -0
  199. data/schemas/notebooks.json +45 -0
  200. data/schemas/org.json +30 -14
  201. data/schemas/orgInvite.json +90 -0
  202. data/schemas/orgInviteCollection.json +130 -0
  203. data/schemas/orgInvites.json +82 -77
  204. data/schemas/orgPatch.json +0 -9
  205. data/schemas/orgRoleInfo.json +69 -0
  206. data/schemas/orgs.json +30 -14
  207. data/schemas/payloadStats.json +126 -0
  208. data/schemas/userCredentials.json +72 -1
  209. data/schemas/userPost.json +72 -1
  210. data/schemas/validateContextError.json +34 -0
  211. data/schemas/validateContextSuccess.json +34 -0
  212. data/schemas/virtualButtonPress.json +4 -0
  213. metadata +68 -3
data/schemas/devicesRemoveDataPost.json CHANGED
@@ -1017,6 +1017,315 @@
1017
1017
  "additionalProperties": false
1018
1018
  }
1019
1019
  ]
1020
+ },
1021
+ "disconnectedAt": {
1022
+ "oneOf": [
1023
+ {
1024
+ "type": [
1025
+ "string",
1026
+ "number",
1027
+ "boolean",
1028
+ "null"
1029
+ ]
1030
+ },
1031
+ {
1032
+ "type": "object",
1033
+ "properties": {
1034
+ "$eq": {
1035
+ "type": [
1036
+ "string",
1037
+ "number",
1038
+ "boolean",
1039
+ "null"
1040
+ ]
1041
+ },
1042
+ "$ne": {
1043
+ "type": [
1044
+ "string",
1045
+ "number",
1046
+ "boolean",
1047
+ "null"
1048
+ ]
1049
+ },
1050
+ "$gt": {
1051
+ "type": [
1052
+ "string",
1053
+ "number",
1054
+ "boolean",
1055
+ "null"
1056
+ ]
1057
+ },
1058
+ "$lt": {
1059
+ "type": [
1060
+ "string",
1061
+ "number",
1062
+ "boolean",
1063
+ "null"
1064
+ ]
1065
+ },
1066
+ "$gte": {
1067
+ "type": [
1068
+ "string",
1069
+ "number",
1070
+ "boolean",
1071
+ "null"
1072
+ ]
1073
+ },
1074
+ "$lte": {
1075
+ "type": [
1076
+ "string",
1077
+ "number",
1078
+ "boolean",
1079
+ "null"
1080
+ ]
1081
+ },
1082
+ "$startsWith": {
1083
+ "type": "string",
1084
+ "minLength": 1
1085
+ },
1086
+ "$endsWith": {
1087
+ "type": "string",
1088
+ "minLength": 1
1089
+ },
1090
+ "$contains": {
1091
+ "type": "string",
1092
+ "minLength": 1
1093
+ },
1094
+ "$ci": {
1095
+ "type": "boolean"
1096
+ },
1097
+ "$in": {
1098
+ "type": "array",
1099
+ "maxItems": 100,
1100
+ "items": {
1101
+ "type": [
1102
+ "string",
1103
+ "number",
1104
+ "boolean"
1105
+ ]
1106
+ }
1107
+ },
1108
+ "$nin": {
1109
+ "type": "array",
1110
+ "maxItems": 100,
1111
+ "items": {
1112
+ "type": [
1113
+ "string",
1114
+ "number",
1115
+ "boolean"
1116
+ ]
1117
+ }
1118
+ }
1119
+ },
1120
+ "additionalProperties": false
1121
+ }
1122
+ ]
1123
+ },
1124
+ "connectedAt": {
1125
+ "oneOf": [
1126
+ {
1127
+ "type": [
1128
+ "string",
1129
+ "number",
1130
+ "boolean",
1131
+ "null"
1132
+ ]
1133
+ },
1134
+ {
1135
+ "type": "object",
1136
+ "properties": {
1137
+ "$eq": {
1138
+ "type": [
1139
+ "string",
1140
+ "number",
1141
+ "boolean",
1142
+ "null"
1143
+ ]
1144
+ },
1145
+ "$ne": {
1146
+ "type": [
1147
+ "string",
1148
+ "number",
1149
+ "boolean",
1150
+ "null"
1151
+ ]
1152
+ },
1153
+ "$gt": {
1154
+ "type": [
1155
+ "string",
1156
+ "number",
1157
+ "boolean",
1158
+ "null"
1159
+ ]
1160
+ },
1161
+ "$lt": {
1162
+ "type": [
1163
+ "string",
1164
+ "number",
1165
+ "boolean",
1166
+ "null"
1167
+ ]
1168
+ },
1169
+ "$gte": {
1170
+ "type": [
1171
+ "string",
1172
+ "number",
1173
+ "boolean",
1174
+ "null"
1175
+ ]
1176
+ },
1177
+ "$lte": {
1178
+ "type": [
1179
+ "string",
1180
+ "number",
1181
+ "boolean",
1182
+ "null"
1183
+ ]
1184
+ },
1185
+ "$startsWith": {
1186
+ "type": "string",
1187
+ "minLength": 1
1188
+ },
1189
+ "$endsWith": {
1190
+ "type": "string",
1191
+ "minLength": 1
1192
+ },
1193
+ "$contains": {
1194
+ "type": "string",
1195
+ "minLength": 1
1196
+ },
1197
+ "$ci": {
1198
+ "type": "boolean"
1199
+ },
1200
+ "$in": {
1201
+ "type": "array",
1202
+ "maxItems": 100,
1203
+ "items": {
1204
+ "type": [
1205
+ "string",
1206
+ "number",
1207
+ "boolean"
1208
+ ]
1209
+ }
1210
+ },
1211
+ "$nin": {
1212
+ "type": "array",
1213
+ "maxItems": 100,
1214
+ "items": {
1215
+ "type": [
1216
+ "string",
1217
+ "number",
1218
+ "boolean"
1219
+ ]
1220
+ }
1221
+ }
1222
+ },
1223
+ "additionalProperties": false
1224
+ }
1225
+ ]
1226
+ },
1227
+ "connectionStatus": {
1228
+ "oneOf": [
1229
+ {
1230
+ "type": [
1231
+ "string",
1232
+ "number",
1233
+ "boolean",
1234
+ "null"
1235
+ ]
1236
+ },
1237
+ {
1238
+ "type": "object",
1239
+ "properties": {
1240
+ "$eq": {
1241
+ "type": [
1242
+ "string",
1243
+ "number",
1244
+ "boolean",
1245
+ "null"
1246
+ ]
1247
+ },
1248
+ "$ne": {
1249
+ "type": [
1250
+ "string",
1251
+ "number",
1252
+ "boolean",
1253
+ "null"
1254
+ ]
1255
+ },
1256
+ "$gt": {
1257
+ "type": [
1258
+ "string",
1259
+ "number",
1260
+ "boolean",
1261
+ "null"
1262
+ ]
1263
+ },
1264
+ "$lt": {
1265
+ "type": [
1266
+ "string",
1267
+ "number",
1268
+ "boolean",
1269
+ "null"
1270
+ ]
1271
+ },
1272
+ "$gte": {
1273
+ "type": [
1274
+ "string",
1275
+ "number",
1276
+ "boolean",
1277
+ "null"
1278
+ ]
1279
+ },
1280
+ "$lte": {
1281
+ "type": [
1282
+ "string",
1283
+ "number",
1284
+ "boolean",
1285
+ "null"
1286
+ ]
1287
+ },
1288
+ "$startsWith": {
1289
+ "type": "string",
1290
+ "minLength": 1
1291
+ },
1292
+ "$endsWith": {
1293
+ "type": "string",
1294
+ "minLength": 1
1295
+ },
1296
+ "$contains": {
1297
+ "type": "string",
1298
+ "minLength": 1
1299
+ },
1300
+ "$ci": {
1301
+ "type": "boolean"
1302
+ },
1303
+ "$in": {
1304
+ "type": "array",
1305
+ "maxItems": 100,
1306
+ "items": {
1307
+ "type": [
1308
+ "string",
1309
+ "number",
1310
+ "boolean"
1311
+ ]
1312
+ }
1313
+ },
1314
+ "$nin": {
1315
+ "type": "array",
1316
+ "maxItems": 100,
1317
+ "items": {
1318
+ "type": [
1319
+ "string",
1320
+ "number",
1321
+ "boolean"
1322
+ ]
1323
+ }
1324
+ }
1325
+ },
1326
+ "additionalProperties": false
1327
+ }
1328
+ ]
1020
1329
  }
1021
1330
  },
1022
1331
  "additionalProperties": false
data/schemas/edgeDeployment.json CHANGED
@@ -23,6 +23,22 @@
23
23
  "minLength": 1,
24
24
  "maxLength": 255
25
25
  },
26
+ "deviceConnectionInfo": {
27
+ "type": "object",
28
+ "properties": {
29
+ "time": {
30
+ "type": "string",
31
+ "format": "date-time"
32
+ },
33
+ "connected": {
34
+ "enum": [
35
+ 1,
36
+ 0,
37
+ null
38
+ ]
39
+ }
40
+ }
41
+ },
26
42
  "flowId": {
27
43
  "type": "string",
28
44
  "pattern": "^[A-Fa-f\\d]{24}$"
data/schemas/edgeDeployments.json CHANGED
@@ -30,6 +30,22 @@
30
30
  "minLength": 1,
31
31
  "maxLength": 255
32
32
  },
33
+ "deviceConnectionInfo": {
34
+ "type": "object",
35
+ "properties": {
36
+ "time": {
37
+ "type": "string",
38
+ "format": "date-time"
39
+ },
40
+ "connected": {
41
+ "enum": [
42
+ 1,
43
+ 0,
44
+ null
45
+ ]
46
+ }
47
+ }
48
+ },
33
49
  "flowId": {
34
50
  "type": "string",
35
51
  "pattern": "^[A-Fa-f\\d]{24}$"
data/schemas/experienceGroup.json CHANGED
@@ -102,6 +102,12 @@
102
102
  "type": "null"
103
103
  }
104
104
  ]
105
+ },
106
+ "directDeviceCount": {
107
+ "type": "number"
108
+ },
109
+ "totalDeviceCount": {
110
+ "type": "number"
105
111
  }
106
112
  }
107
113
  }
data/schemas/experienceGroups.json CHANGED
@@ -109,6 +109,12 @@
109
109
  "type": "null"
110
110
  }
111
111
  ]
112
+ },
113
+ "directDeviceCount": {
114
+ "type": "number"
115
+ },
116
+ "totalDeviceCount": {
117
+ "type": "number"
112
118
  }
113
119
  }
114
120
  }
data/schemas/experienceLinkedResources.json CHANGED
@@ -704,6 +704,21 @@
704
704
  },
705
705
  "maxAge": {
706
706
  "type": "number"
707
+ },
708
+ "triggerOn": {
709
+ "type": "string",
710
+ "enum": [
711
+ "batch",
712
+ "individual",
713
+ "both"
714
+ ]
715
+ },
716
+ "batchBehavior": {
717
+ "type": "string",
718
+ "enum": [
719
+ "once",
720
+ "each"
721
+ ]
707
722
  }
708
723
  },
709
724
  "additionalProperties": false
@@ -2952,6 +2967,21 @@
2952
2967
  },
2953
2968
  "maxAge": {
2954
2969
  "type": "number"
2970
+ },
2971
+ "triggerOn": {
2972
+ "type": "string",
2973
+ "enum": [
2974
+ "batch",
2975
+ "individual",
2976
+ "both"
2977
+ ]
2978
+ },
2979
+ "batchBehavior": {
2980
+ "type": "string",
2981
+ "enum": [
2982
+ "once",
2983
+ "each"
2984
+ ]
2955
2985
  }
2956
2986
  },
2957
2987
  "additionalProperties": false
@@ -5150,6 +5180,21 @@
5150
5180
  },
5151
5181
  "maxAge": {
5152
5182
  "type": "number"
5183
+ },
5184
+ "triggerOn": {
5185
+ "type": "string",
5186
+ "enum": [
5187
+ "batch",
5188
+ "individual",
5189
+ "both"
5190
+ ]
5191
+ },
5192
+ "batchBehavior": {
5193
+ "type": "string",
5194
+ "enum": [
5195
+ "once",
5196
+ "each"
5197
+ ]
5153
5198
  }
5154
5199
  },
5155
5200
  "additionalProperties": false