losant_rest 1.12.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (124) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +4164 -701
  5. data/docs/events.md +3 -3
  6. data/docs/flow.md +41 -0
  7. data/docs/instance.md +128 -0
  8. data/docs/instanceMember.md +133 -0
  9. data/docs/instanceMembers.md +91 -0
  10. data/docs/instanceOrg.md +133 -0
  11. data/docs/instanceOrgMember.md +139 -0
  12. data/docs/instanceOrgMembers.md +96 -0
  13. data/docs/instanceOrgs.md +91 -0
  14. data/docs/instances.md +50 -0
  15. data/lib/losant_rest.rb +9 -1
  16. data/lib/losant_rest/application.rb +2 -2
  17. data/lib/losant_rest/application_api_token.rb +1 -1
  18. data/lib/losant_rest/application_api_tokens.rb +1 -1
  19. data/lib/losant_rest/application_certificate.rb +1 -1
  20. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  21. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  22. data/lib/losant_rest/application_certificates.rb +1 -1
  23. data/lib/losant_rest/application_dashboard.rb +1 -1
  24. data/lib/losant_rest/application_dashboards.rb +1 -1
  25. data/lib/losant_rest/application_key.rb +1 -1
  26. data/lib/losant_rest/application_keys.rb +1 -1
  27. data/lib/losant_rest/application_template.rb +1 -1
  28. data/lib/losant_rest/application_templates.rb +1 -1
  29. data/lib/losant_rest/applications.rb +1 -1
  30. data/lib/losant_rest/audit_log.rb +1 -1
  31. data/lib/losant_rest/audit_logs.rb +1 -1
  32. data/lib/losant_rest/auth.rb +1 -1
  33. data/lib/losant_rest/client.rb +35 -3
  34. data/lib/losant_rest/dashboard.rb +1 -1
  35. data/lib/losant_rest/dashboards.rb +1 -1
  36. data/lib/losant_rest/data.rb +1 -1
  37. data/lib/losant_rest/data_table.rb +1 -1
  38. data/lib/losant_rest/data_table_row.rb +1 -1
  39. data/lib/losant_rest/data_table_rows.rb +1 -1
  40. data/lib/losant_rest/data_tables.rb +1 -1
  41. data/lib/losant_rest/device.rb +1 -1
  42. data/lib/losant_rest/device_recipe.rb +1 -1
  43. data/lib/losant_rest/device_recipes.rb +1 -1
  44. data/lib/losant_rest/devices.rb +1 -1
  45. data/lib/losant_rest/edge_deployments.rb +1 -1
  46. data/lib/losant_rest/error.rb +1 -1
  47. data/lib/losant_rest/event.rb +1 -1
  48. data/lib/losant_rest/events.rb +4 -4
  49. data/lib/losant_rest/experience.rb +1 -1
  50. data/lib/losant_rest/experience_domain.rb +1 -1
  51. data/lib/losant_rest/experience_domains.rb +1 -1
  52. data/lib/losant_rest/experience_endpoint.rb +1 -1
  53. data/lib/losant_rest/experience_endpoints.rb +1 -1
  54. data/lib/losant_rest/experience_group.rb +1 -1
  55. data/lib/losant_rest/experience_groups.rb +1 -1
  56. data/lib/losant_rest/experience_slug.rb +1 -1
  57. data/lib/losant_rest/experience_slugs.rb +1 -1
  58. data/lib/losant_rest/experience_user.rb +1 -1
  59. data/lib/losant_rest/experience_users.rb +1 -1
  60. data/lib/losant_rest/experience_version.rb +1 -1
  61. data/lib/losant_rest/experience_versions.rb +1 -1
  62. data/lib/losant_rest/experience_view.rb +1 -1
  63. data/lib/losant_rest/experience_views.rb +1 -1
  64. data/lib/losant_rest/file.rb +1 -1
  65. data/lib/losant_rest/files.rb +1 -1
  66. data/lib/losant_rest/flow.rb +47 -1
  67. data/lib/losant_rest/flow_version.rb +1 -1
  68. data/lib/losant_rest/flow_versions.rb +1 -1
  69. data/lib/losant_rest/flows.rb +1 -1
  70. data/lib/losant_rest/instance.rb +181 -0
  71. data/lib/losant_rest/instance_member.rb +176 -0
  72. data/lib/losant_rest/instance_members.rb +134 -0
  73. data/lib/losant_rest/instance_org.rb +176 -0
  74. data/lib/losant_rest/instance_org_member.rb +182 -0
  75. data/lib/losant_rest/instance_org_members.rb +138 -0
  76. data/lib/losant_rest/instance_orgs.rb +139 -0
  77. data/lib/losant_rest/instances.rb +88 -0
  78. data/lib/losant_rest/integration.rb +1 -1
  79. data/lib/losant_rest/integrations.rb +1 -1
  80. data/lib/losant_rest/me.rb +2 -2
  81. data/lib/losant_rest/notebook.rb +1 -1
  82. data/lib/losant_rest/notebooks.rb +1 -1
  83. data/lib/losant_rest/org.rb +2 -2
  84. data/lib/losant_rest/org_invites.rb +1 -1
  85. data/lib/losant_rest/orgs.rb +1 -1
  86. data/lib/losant_rest/utils.rb +1 -1
  87. data/lib/losant_rest/version.rb +2 -2
  88. data/lib/losant_rest/webhook.rb +1 -1
  89. data/lib/losant_rest/webhooks.rb +1 -1
  90. data/schemas/advancedDeviceQuery.json +309 -0
  91. data/schemas/applicationApiTokenPost.json +1 -0
  92. data/schemas/applicationDashboardPost.json +19 -1
  93. data/schemas/dashboard.json +19 -1
  94. data/schemas/dashboardPatch.json +19 -1
  95. data/schemas/dashboardPost.json +19 -1
  96. data/schemas/dashboards.json +19 -1
  97. data/schemas/devicesDeletePost.json +309 -0
  98. data/schemas/devicesExportPost.json +309 -0
  99. data/schemas/devicesPatch.json +309 -0
  100. data/schemas/devicesRemoveDataPost.json +309 -0
  101. data/schemas/filePost.json +8 -2
  102. data/schemas/flowStorageMetadata.json +13 -0
  103. data/schemas/githubLogin.json +35 -11
  104. data/schemas/historicalSummaries.json +43 -0
  105. data/schemas/historicalSummary.json +455 -0
  106. data/schemas/instanceMember.json +37 -0
  107. data/schemas/instanceMemberPatch.json +17 -0
  108. data/schemas/instanceMemberPost.json +22 -0
  109. data/schemas/instanceMembers.json +69 -0
  110. data/schemas/instanceOrg.json +14 -0
  111. data/schemas/instanceOrgMember.json +37 -0
  112. data/schemas/instanceOrgMemberPatch.json +69 -0
  113. data/schemas/instanceOrgMemberPost.json +161 -0
  114. data/schemas/instanceOrgMembers.json +34 -0
  115. data/schemas/instanceOrgPatch.json +19 -0
  116. data/schemas/instanceOrgPost.json +11 -0
  117. data/schemas/instanceOrgs.json +14 -0
  118. data/schemas/instanceReportOptionsPost.json +40 -0
  119. data/schemas/multiDeviceCommand.json +309 -0
  120. data/schemas/orgPatch.json +0 -9
  121. data/schemas/payloadStats.json +110 -0
  122. data/schemas/userCredentials.json +35 -11
  123. data/schemas/userPost.json +35 -11
  124. metadata +31 -2
@@ -95,8 +95,27 @@
95
95
  }
96
96
  }
97
97
  },
98
+ "whitelistedEmailDomains": {
99
+ "type": "array",
100
+ "items": {
101
+ "type": "string",
102
+ "maxLength": 45,
103
+ "minLength": 3
104
+ }
105
+ },
98
106
  "auditLogEnabled": {
99
107
  "type": "boolean"
108
+ },
109
+ "disabledAt": {
110
+ "oneOf": [
111
+ {
112
+ "type": "string",
113
+ "format": "date-time"
114
+ },
115
+ {
116
+ "type": "boolean"
117
+ }
118
+ ]
100
119
  }
101
120
  },
102
121
  "additionalProperties": false
@@ -105,6 +105,17 @@
105
105
  },
106
106
  "auditLogEnabled": {
107
107
  "type": "boolean"
108
+ },
109
+ "disabledAt": {
110
+ "oneOf": [
111
+ {
112
+ "type": "string",
113
+ "format": "date-time"
114
+ },
115
+ {
116
+ "type": "boolean"
117
+ }
118
+ ]
108
119
  }
109
120
  },
110
121
  "additionalProperties": false,
@@ -117,6 +117,20 @@
117
117
  },
118
118
  "auditLogEnabled": {
119
119
  "type": "boolean"
120
+ },
121
+ "disabledAt": {
122
+ "oneOf": [
123
+ {
124
+ "type": "boolean",
125
+ "enum": [
126
+ false
127
+ ]
128
+ },
129
+ {
130
+ "type": "string",
131
+ "format": "date-time"
132
+ }
133
+ ]
120
134
  }
121
135
  },
122
136
  "additionalProperties": false,
@@ -0,0 +1,40 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "email": {
6
+ "type": "string",
7
+ "format": "email",
8
+ "maxLength": 1024
9
+ },
10
+ "callbackUrl": {
11
+ "type": "string",
12
+ "maxLength": 1024
13
+ },
14
+ "resourceGroupBy": {
15
+ "type": "string",
16
+ "enum": [
17
+ "application",
18
+ "organization"
19
+ ]
20
+ },
21
+ "dateGroupBy": {
22
+ "type": "string",
23
+ "enum": [
24
+ "month"
25
+ ]
26
+ },
27
+ "includeSandbox": {
28
+ "type": "boolean"
29
+ },
30
+ "start": {
31
+ "type": "string",
32
+ "format": "date-time"
33
+ },
34
+ "end": {
35
+ "type": "string",
36
+ "format": "date-time"
37
+ }
38
+ },
39
+ "additionalProperties": false
40
+ }
@@ -1072,6 +1072,315 @@
1072
1072
  "additionalProperties": false
1073
1073
  }
1074
1074
  ]
1075
+ },
1076
+ "disconnectedAt": {
1077
+ "oneOf": [
1078
+ {
1079
+ "type": [
1080
+ "string",
1081
+ "number",
1082
+ "boolean",
1083
+ "null"
1084
+ ]
1085
+ },
1086
+ {
1087
+ "type": "object",
1088
+ "properties": {
1089
+ "$eq": {
1090
+ "type": [
1091
+ "string",
1092
+ "number",
1093
+ "boolean",
1094
+ "null"
1095
+ ]
1096
+ },
1097
+ "$ne": {
1098
+ "type": [
1099
+ "string",
1100
+ "number",
1101
+ "boolean",
1102
+ "null"
1103
+ ]
1104
+ },
1105
+ "$gt": {
1106
+ "type": [
1107
+ "string",
1108
+ "number",
1109
+ "boolean",
1110
+ "null"
1111
+ ]
1112
+ },
1113
+ "$lt": {
1114
+ "type": [
1115
+ "string",
1116
+ "number",
1117
+ "boolean",
1118
+ "null"
1119
+ ]
1120
+ },
1121
+ "$gte": {
1122
+ "type": [
1123
+ "string",
1124
+ "number",
1125
+ "boolean",
1126
+ "null"
1127
+ ]
1128
+ },
1129
+ "$lte": {
1130
+ "type": [
1131
+ "string",
1132
+ "number",
1133
+ "boolean",
1134
+ "null"
1135
+ ]
1136
+ },
1137
+ "$startsWith": {
1138
+ "type": "string",
1139
+ "minLength": 1
1140
+ },
1141
+ "$endsWith": {
1142
+ "type": "string",
1143
+ "minLength": 1
1144
+ },
1145
+ "$contains": {
1146
+ "type": "string",
1147
+ "minLength": 1
1148
+ },
1149
+ "$ci": {
1150
+ "type": "boolean"
1151
+ },
1152
+ "$in": {
1153
+ "type": "array",
1154
+ "maxItems": 100,
1155
+ "items": {
1156
+ "type": [
1157
+ "string",
1158
+ "number",
1159
+ "boolean"
1160
+ ]
1161
+ }
1162
+ },
1163
+ "$nin": {
1164
+ "type": "array",
1165
+ "maxItems": 100,
1166
+ "items": {
1167
+ "type": [
1168
+ "string",
1169
+ "number",
1170
+ "boolean"
1171
+ ]
1172
+ }
1173
+ }
1174
+ },
1175
+ "additionalProperties": false
1176
+ }
1177
+ ]
1178
+ },
1179
+ "connectedAt": {
1180
+ "oneOf": [
1181
+ {
1182
+ "type": [
1183
+ "string",
1184
+ "number",
1185
+ "boolean",
1186
+ "null"
1187
+ ]
1188
+ },
1189
+ {
1190
+ "type": "object",
1191
+ "properties": {
1192
+ "$eq": {
1193
+ "type": [
1194
+ "string",
1195
+ "number",
1196
+ "boolean",
1197
+ "null"
1198
+ ]
1199
+ },
1200
+ "$ne": {
1201
+ "type": [
1202
+ "string",
1203
+ "number",
1204
+ "boolean",
1205
+ "null"
1206
+ ]
1207
+ },
1208
+ "$gt": {
1209
+ "type": [
1210
+ "string",
1211
+ "number",
1212
+ "boolean",
1213
+ "null"
1214
+ ]
1215
+ },
1216
+ "$lt": {
1217
+ "type": [
1218
+ "string",
1219
+ "number",
1220
+ "boolean",
1221
+ "null"
1222
+ ]
1223
+ },
1224
+ "$gte": {
1225
+ "type": [
1226
+ "string",
1227
+ "number",
1228
+ "boolean",
1229
+ "null"
1230
+ ]
1231
+ },
1232
+ "$lte": {
1233
+ "type": [
1234
+ "string",
1235
+ "number",
1236
+ "boolean",
1237
+ "null"
1238
+ ]
1239
+ },
1240
+ "$startsWith": {
1241
+ "type": "string",
1242
+ "minLength": 1
1243
+ },
1244
+ "$endsWith": {
1245
+ "type": "string",
1246
+ "minLength": 1
1247
+ },
1248
+ "$contains": {
1249
+ "type": "string",
1250
+ "minLength": 1
1251
+ },
1252
+ "$ci": {
1253
+ "type": "boolean"
1254
+ },
1255
+ "$in": {
1256
+ "type": "array",
1257
+ "maxItems": 100,
1258
+ "items": {
1259
+ "type": [
1260
+ "string",
1261
+ "number",
1262
+ "boolean"
1263
+ ]
1264
+ }
1265
+ },
1266
+ "$nin": {
1267
+ "type": "array",
1268
+ "maxItems": 100,
1269
+ "items": {
1270
+ "type": [
1271
+ "string",
1272
+ "number",
1273
+ "boolean"
1274
+ ]
1275
+ }
1276
+ }
1277
+ },
1278
+ "additionalProperties": false
1279
+ }
1280
+ ]
1281
+ },
1282
+ "connectionStatus": {
1283
+ "oneOf": [
1284
+ {
1285
+ "type": [
1286
+ "string",
1287
+ "number",
1288
+ "boolean",
1289
+ "null"
1290
+ ]
1291
+ },
1292
+ {
1293
+ "type": "object",
1294
+ "properties": {
1295
+ "$eq": {
1296
+ "type": [
1297
+ "string",
1298
+ "number",
1299
+ "boolean",
1300
+ "null"
1301
+ ]
1302
+ },
1303
+ "$ne": {
1304
+ "type": [
1305
+ "string",
1306
+ "number",
1307
+ "boolean",
1308
+ "null"
1309
+ ]
1310
+ },
1311
+ "$gt": {
1312
+ "type": [
1313
+ "string",
1314
+ "number",
1315
+ "boolean",
1316
+ "null"
1317
+ ]
1318
+ },
1319
+ "$lt": {
1320
+ "type": [
1321
+ "string",
1322
+ "number",
1323
+ "boolean",
1324
+ "null"
1325
+ ]
1326
+ },
1327
+ "$gte": {
1328
+ "type": [
1329
+ "string",
1330
+ "number",
1331
+ "boolean",
1332
+ "null"
1333
+ ]
1334
+ },
1335
+ "$lte": {
1336
+ "type": [
1337
+ "string",
1338
+ "number",
1339
+ "boolean",
1340
+ "null"
1341
+ ]
1342
+ },
1343
+ "$startsWith": {
1344
+ "type": "string",
1345
+ "minLength": 1
1346
+ },
1347
+ "$endsWith": {
1348
+ "type": "string",
1349
+ "minLength": 1
1350
+ },
1351
+ "$contains": {
1352
+ "type": "string",
1353
+ "minLength": 1
1354
+ },
1355
+ "$ci": {
1356
+ "type": "boolean"
1357
+ },
1358
+ "$in": {
1359
+ "type": "array",
1360
+ "maxItems": 100,
1361
+ "items": {
1362
+ "type": [
1363
+ "string",
1364
+ "number",
1365
+ "boolean"
1366
+ ]
1367
+ }
1368
+ },
1369
+ "$nin": {
1370
+ "type": "array",
1371
+ "maxItems": 100,
1372
+ "items": {
1373
+ "type": [
1374
+ "string",
1375
+ "number",
1376
+ "boolean"
1377
+ ]
1378
+ }
1379
+ }
1380
+ },
1381
+ "additionalProperties": false
1382
+ }
1383
+ ]
1075
1384
  }
1076
1385
  },
1077
1386
  "additionalProperties": false
@@ -27,15 +27,6 @@
27
27
  "iconColor": {
28
28
  "type": "string",
29
29
  "maxLength": 64
30
- },
31
- "whitelistedEmailDomains": {
32
- "type": "array",
33
- "maxItems": 25,
34
- "items": {
35
- "type": "string",
36
- "maxLength": 45,
37
- "minLength": 3
38
- }
39
30
  }
40
31
  },
41
32
  "additionalProperties": false
@@ -0,0 +1,110 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "mqttOut": {
6
+ "type": "object",
7
+ "patternProperties": {
8
+ ".*": {
9
+ "type": "number"
10
+ }
11
+ }
12
+ },
13
+ "mqttIn": {
14
+ "type": "object",
15
+ "patternProperties": {
16
+ ".*": {
17
+ "type": "number"
18
+ }
19
+ }
20
+ },
21
+ "dataTable": {
22
+ "type": "object",
23
+ "patternProperties": {
24
+ ".*": {
25
+ "type": "number"
26
+ }
27
+ }
28
+ },
29
+ "deviceState": {
30
+ "type": "object",
31
+ "patternProperties": {
32
+ ".*": {
33
+ "type": "number"
34
+ }
35
+ }
36
+ },
37
+ "deviceCommand": {
38
+ "type": "object",
39
+ "patternProperties": {
40
+ ".*": {
41
+ "type": "number"
42
+ }
43
+ }
44
+ },
45
+ "webhook": {
46
+ "type": "object",
47
+ "patternProperties": {
48
+ ".*": {
49
+ "type": "number"
50
+ }
51
+ }
52
+ },
53
+ "timer": {
54
+ "type": "object",
55
+ "patternProperties": {
56
+ ".*": {
57
+ "type": "number"
58
+ }
59
+ }
60
+ },
61
+ "event": {
62
+ "type": "object",
63
+ "patternProperties": {
64
+ ".*": {
65
+ "type": "number"
66
+ }
67
+ }
68
+ },
69
+ "virtualButton": {
70
+ "type": "object",
71
+ "patternProperties": {
72
+ ".*": {
73
+ "type": "number"
74
+ }
75
+ }
76
+ },
77
+ "deviceConnect": {
78
+ "type": "object",
79
+ "patternProperties": {
80
+ ".*": {
81
+ "type": "number"
82
+ }
83
+ }
84
+ },
85
+ "deviceDisconnect": {
86
+ "type": "object",
87
+ "patternProperties": {
88
+ ".*": {
89
+ "type": "number"
90
+ }
91
+ }
92
+ },
93
+ "endpoint": {
94
+ "type": "object",
95
+ "patternProperties": {
96
+ ".*": {
97
+ "type": "number"
98
+ }
99
+ }
100
+ },
101
+ "integration": {
102
+ "type": "object",
103
+ "patternProperties": {
104
+ ".*": {
105
+ "type": "number"
106
+ }
107
+ }
108
+ }
109
+ }
110
+ }