losant_rest 1.12.0 → 1.14.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (202) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +17509 -8097
  5. data/docs/application.md +6 -6
  6. data/docs/applicationApiTokens.md +1 -1
  7. data/docs/applications.md +1 -1
  8. data/docs/dataTable.md +1 -1
  9. data/docs/dataTableRows.md +1 -1
  10. data/docs/dataTables.md +1 -1
  11. data/docs/device.md +43 -0
  12. data/docs/devices.md +41 -2
  13. data/docs/edgeDeployment.md +49 -0
  14. data/docs/events.md +3 -3
  15. data/docs/experience.md +1 -1
  16. data/docs/experienceDomains.md +1 -1
  17. data/docs/experienceGroup.md +2 -0
  18. data/docs/experienceSlugs.md +1 -1
  19. data/docs/experienceVersion.md +3 -3
  20. data/docs/experienceVersions.md +2 -2
  21. data/docs/experienceView.md +4 -4
  22. data/docs/experienceViews.md +2 -2
  23. data/docs/file.md +5 -5
  24. data/docs/files.md +2 -2
  25. data/docs/flow.md +41 -0
  26. data/docs/flowVersions.md +44 -0
  27. data/docs/instance.md +168 -0
  28. data/docs/instanceApiToken.md +133 -0
  29. data/docs/instanceApiTokens.md +91 -0
  30. data/docs/instanceMember.md +133 -0
  31. data/docs/instanceMembers.md +91 -0
  32. data/docs/instanceOrg.md +135 -0
  33. data/docs/instanceOrgInvite.md +139 -0
  34. data/docs/instanceOrgInvites.md +96 -0
  35. data/docs/instanceOrgMember.md +139 -0
  36. data/docs/instanceOrgMembers.md +96 -0
  37. data/docs/instanceOrgs.md +91 -0
  38. data/docs/instances.md +50 -0
  39. data/docs/me.md +1 -1
  40. data/docs/org.md +1 -1
  41. data/docs/userApiToken.md +125 -0
  42. data/docs/userApiTokens.md +87 -0
  43. data/lib/losant_rest/application.rb +7 -7
  44. data/lib/losant_rest/application_api_token.rb +1 -1
  45. data/lib/losant_rest/application_api_tokens.rb +2 -2
  46. data/lib/losant_rest/application_certificate.rb +1 -1
  47. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  48. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  49. data/lib/losant_rest/application_certificates.rb +1 -1
  50. data/lib/losant_rest/application_dashboard.rb +1 -1
  51. data/lib/losant_rest/application_dashboards.rb +1 -1
  52. data/lib/losant_rest/application_key.rb +1 -1
  53. data/lib/losant_rest/application_keys.rb +1 -1
  54. data/lib/losant_rest/application_template.rb +1 -1
  55. data/lib/losant_rest/application_templates.rb +1 -1
  56. data/lib/losant_rest/applications.rb +2 -2
  57. data/lib/losant_rest/audit_log.rb +1 -1
  58. data/lib/losant_rest/audit_logs.rb +1 -1
  59. data/lib/losant_rest/auth.rb +1 -1
  60. data/lib/losant_rest/client.rb +63 -3
  61. data/lib/losant_rest/dashboard.rb +1 -1
  62. data/lib/losant_rest/dashboards.rb +1 -1
  63. data/lib/losant_rest/data.rb +1 -1
  64. data/lib/losant_rest/data_table.rb +2 -2
  65. data/lib/losant_rest/data_table_row.rb +1 -1
  66. data/lib/losant_rest/data_table_rows.rb +2 -2
  67. data/lib/losant_rest/data_tables.rb +2 -2
  68. data/lib/losant_rest/device.rb +51 -1
  69. data/lib/losant_rest/device_recipe.rb +1 -1
  70. data/lib/losant_rest/device_recipes.rb +1 -1
  71. data/lib/losant_rest/devices.rb +49 -3
  72. data/lib/losant_rest/edge_deployment.rb +81 -0
  73. data/lib/losant_rest/edge_deployments.rb +1 -1
  74. data/lib/losant_rest/error.rb +1 -1
  75. data/lib/losant_rest/event.rb +1 -1
  76. data/lib/losant_rest/events.rb +4 -4
  77. data/lib/losant_rest/experience.rb +2 -2
  78. data/lib/losant_rest/experience_domain.rb +1 -1
  79. data/lib/losant_rest/experience_domains.rb +2 -2
  80. data/lib/losant_rest/experience_endpoint.rb +1 -1
  81. data/lib/losant_rest/experience_endpoints.rb +1 -1
  82. data/lib/losant_rest/experience_group.rb +5 -1
  83. data/lib/losant_rest/experience_groups.rb +1 -1
  84. data/lib/losant_rest/experience_slug.rb +1 -1
  85. data/lib/losant_rest/experience_slugs.rb +2 -2
  86. data/lib/losant_rest/experience_user.rb +1 -1
  87. data/lib/losant_rest/experience_users.rb +1 -1
  88. data/lib/losant_rest/experience_version.rb +4 -4
  89. data/lib/losant_rest/experience_versions.rb +3 -3
  90. data/lib/losant_rest/experience_view.rb +5 -5
  91. data/lib/losant_rest/experience_views.rb +3 -3
  92. data/lib/losant_rest/file.rb +5 -5
  93. data/lib/losant_rest/files.rb +3 -3
  94. data/lib/losant_rest/flow.rb +47 -1
  95. data/lib/losant_rest/flow_version.rb +1 -1
  96. data/lib/losant_rest/flow_versions.rb +51 -1
  97. data/lib/losant_rest/flows.rb +1 -1
  98. data/lib/losant_rest/instance.rb +227 -0
  99. data/lib/losant_rest/instance_api_token.rb +176 -0
  100. data/lib/losant_rest/instance_api_tokens.rb +136 -0
  101. data/lib/losant_rest/instance_member.rb +176 -0
  102. data/lib/losant_rest/instance_members.rb +134 -0
  103. data/lib/losant_rest/instance_org.rb +180 -0
  104. data/lib/losant_rest/instance_org_invite.rb +182 -0
  105. data/lib/losant_rest/instance_org_invites.rb +138 -0
  106. data/lib/losant_rest/instance_org_member.rb +182 -0
  107. data/lib/losant_rest/instance_org_members.rb +138 -0
  108. data/lib/losant_rest/instance_orgs.rb +139 -0
  109. data/lib/losant_rest/instances.rb +88 -0
  110. data/lib/losant_rest/integration.rb +1 -1
  111. data/lib/losant_rest/integrations.rb +1 -1
  112. data/lib/losant_rest/me.rb +2 -2
  113. data/lib/losant_rest/notebook.rb +1 -1
  114. data/lib/losant_rest/notebooks.rb +1 -1
  115. data/lib/losant_rest/org.rb +2 -2
  116. data/lib/losant_rest/org_invites.rb +1 -1
  117. data/lib/losant_rest/orgs.rb +1 -1
  118. data/lib/losant_rest/user_api_token.rb +170 -0
  119. data/lib/losant_rest/user_api_tokens.rb +132 -0
  120. data/lib/losant_rest/utils.rb +1 -1
  121. data/lib/losant_rest/version.rb +2 -2
  122. data/lib/losant_rest/webhook.rb +1 -1
  123. data/lib/losant_rest/webhooks.rb +1 -1
  124. data/lib/losant_rest.rb +16 -1
  125. data/schemas/advancedDeviceQuery.json +309 -0
  126. data/schemas/apiToken.json +2 -1
  127. data/schemas/apiTokenPost.json +431 -0
  128. data/schemas/apiTokens.json +4 -2
  129. data/schemas/applicationApiTokenPost.json +1 -0
  130. data/schemas/applicationDashboardPost.json +39 -17
  131. data/schemas/auditLog.json +4 -0
  132. data/schemas/auditLogFilter.json +4 -0
  133. data/schemas/auditLogs.json +4 -0
  134. data/schemas/bulkDeleteResponse.json +12 -0
  135. data/schemas/dashboard.json +39 -17
  136. data/schemas/dashboardPatch.json +39 -17
  137. data/schemas/dashboardPost.json +39 -17
  138. data/schemas/dashboardSendReport.json +4 -0
  139. data/schemas/dashboards.json +39 -17
  140. data/schemas/dataTableRowsDelete.json +1 -1
  141. data/schemas/devicePayloadCounts.json +24 -0
  142. data/schemas/devicesDeletePost.json +309 -0
  143. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  144. data/schemas/devicesExportPost.json +309 -0
  145. data/schemas/devicesPatch.json +309 -0
  146. data/schemas/devicesRemoveDataPost.json +309 -0
  147. data/schemas/edgeDeployment.json +16 -0
  148. data/schemas/edgeDeployments.json +16 -0
  149. data/schemas/eventsDeleted.json +1 -1
  150. data/schemas/experienceGroup.json +6 -0
  151. data/schemas/experienceGroups.json +6 -0
  152. data/schemas/experienceLinkedResources.json +381 -6
  153. data/schemas/filePost.json +8 -2
  154. data/schemas/flow.json +127 -2
  155. data/schemas/flowPatch.json +127 -2
  156. data/schemas/flowPost.json +127 -2
  157. data/schemas/flowStorageMetadata.json +13 -0
  158. data/schemas/flowVersion.json +254 -4
  159. data/schemas/flowVersionPost.json +127 -2
  160. data/schemas/flowVersions.json +254 -4
  161. data/schemas/flowVersionsDeletePost.json +941 -0
  162. data/schemas/flows.json +127 -2
  163. data/schemas/flowsImportPost.json +254 -4
  164. data/schemas/flowsImportResult.json +381 -6
  165. data/schemas/githubLogin.json +64 -11
  166. data/schemas/historicalSummaries.json +43 -0
  167. data/schemas/historicalSummary.json +490 -0
  168. data/schemas/instance.json +60 -0
  169. data/schemas/instanceMember.json +41 -0
  170. data/schemas/instanceMemberPatch.json +17 -0
  171. data/schemas/instanceMemberPost.json +37 -0
  172. data/schemas/instanceMembers.json +77 -0
  173. data/schemas/instanceOrg.json +14 -0
  174. data/schemas/instanceOrgMember.json +45 -0
  175. data/schemas/instanceOrgMemberPatch.json +69 -0
  176. data/schemas/instanceOrgMemberPost.json +161 -0
  177. data/schemas/instanceOrgMembers.json +42 -0
  178. data/schemas/instanceOrgPatch.json +19 -0
  179. data/schemas/instanceOrgPost.json +177 -0
  180. data/schemas/instanceOrgs.json +18 -0
  181. data/schemas/instancePatch.json +67 -0
  182. data/schemas/instanceReportOptionsPost.json +41 -0
  183. data/schemas/me.json +30 -14
  184. data/schemas/multiDeviceCommand.json +309 -0
  185. data/schemas/notebook.json +45 -0
  186. data/schemas/notebookPatch.json +30 -0
  187. data/schemas/notebookPost.json +30 -0
  188. data/schemas/notebooks.json +45 -0
  189. data/schemas/org.json +30 -14
  190. data/schemas/orgInvite.json +90 -0
  191. data/schemas/orgInviteCollection.json +130 -0
  192. data/schemas/orgInvites.json +82 -77
  193. data/schemas/orgPatch.json +0 -9
  194. data/schemas/orgRoleInfo.json +69 -0
  195. data/schemas/orgs.json +30 -14
  196. data/schemas/payloadStats.json +126 -0
  197. data/schemas/userCredentials.json +64 -11
  198. data/schemas/userPost.json +64 -11
  199. data/schemas/validateContextError.json +34 -0
  200. data/schemas/validateContextSuccess.json +34 -0
  201. data/schemas/virtualButtonPress.json +4 -0
  202. metadata +55 -3
data/schemas/multiDeviceCommand.json CHANGED
@@ -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
data/schemas/notebook.json CHANGED
@@ -608,9 +608,54 @@
608
608
  "outputType"
609
609
  ],
610
610
  "additionalProperties": false
611
+ },
612
+ {
613
+ "type": "object",
614
+ "properties": {
615
+ "outputType": {
616
+ "type": "string",
617
+ "enum": [
618
+ "temporaryUrl"
619
+ ]
620
+ },
621
+ "fileName": {
622
+ "oneOf": [
623
+ {
624
+ "type": "string",
625
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
626
+ },
627
+ {
628
+ "type": "string",
629
+ "minLength": 4,
630
+ "maxLength": 255,
631
+ "pattern": ".*{{.+}}.*"
632
+ }
633
+ ]
634
+ }
635
+ },
636
+ "required": [
637
+ "fileName",
638
+ "outputType"
639
+ ],
640
+ "additionalProperties": false
611
641
  }
612
642
  ]
613
643
  }
644
+ },
645
+ "stats": {
646
+ "type": "object",
647
+ "properties": {
648
+ "minutesThisPeriod": {
649
+ "type": "number"
650
+ },
651
+ "runsThisPeriod": {
652
+ "type": "number"
653
+ },
654
+ "errorsThisPeriod": {
655
+ "type": "number"
656
+ }
657
+ },
658
+ "additionalProperties": false
614
659
  }
615
660
  }
616
661
  }
data/schemas/notebookPatch.json CHANGED
@@ -573,6 +573,36 @@
573
573
  "outputType"
574
574
  ],
575
575
  "additionalProperties": false
576
+ },
577
+ {
578
+ "type": "object",
579
+ "properties": {
580
+ "outputType": {
581
+ "type": "string",
582
+ "enum": [
583
+ "temporaryUrl"
584
+ ]
585
+ },
586
+ "fileName": {
587
+ "oneOf": [
588
+ {
589
+ "type": "string",
590
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
591
+ },
592
+ {
593
+ "type": "string",
594
+ "minLength": 4,
595
+ "maxLength": 255,
596
+ "pattern": ".*{{.+}}.*"
597
+ }
598
+ ]
599
+ }
600
+ },
601
+ "required": [
602
+ "fileName",
603
+ "outputType"
604
+ ],
605
+ "additionalProperties": false
576
606
  }
577
607
  ]
578
608
  }
data/schemas/notebookPost.json CHANGED
@@ -580,6 +580,36 @@
580
580
  "outputType"
581
581
  ],
582
582
  "additionalProperties": false
583
+ },
584
+ {
585
+ "type": "object",
586
+ "properties": {
587
+ "outputType": {
588
+ "type": "string",
589
+ "enum": [
590
+ "temporaryUrl"
591
+ ]
592
+ },
593
+ "fileName": {
594
+ "oneOf": [
595
+ {
596
+ "type": "string",
597
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
598
+ },
599
+ {
600
+ "type": "string",
601
+ "minLength": 4,
602
+ "maxLength": 255,
603
+ "pattern": ".*{{.+}}.*"
604
+ }
605
+ ]
606
+ }
607
+ },
608
+ "required": [
609
+ "fileName",
610
+ "outputType"
611
+ ],
612
+ "additionalProperties": false
583
613
  }
584
614
  ]
585
615
  }
data/schemas/notebooks.json CHANGED
@@ -615,9 +615,54 @@
615
615
  "outputType"
616
616
  ],
617
617
  "additionalProperties": false
618
+ },
619
+ {
620
+ "type": "object",
621
+ "properties": {
622
+ "outputType": {
623
+ "type": "string",
624
+ "enum": [
625
+ "temporaryUrl"
626
+ ]
627
+ },
628
+ "fileName": {
629
+ "oneOf": [
630
+ {
631
+ "type": "string",
632
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
633
+ },
634
+ {
635
+ "type": "string",
636
+ "minLength": 4,
637
+ "maxLength": 255,
638
+ "pattern": ".*{{.+}}.*"
639
+ }
640
+ ]
641
+ }
642
+ },
643
+ "required": [
644
+ "fileName",
645
+ "outputType"
646
+ ],
647
+ "additionalProperties": false
618
648
  }
619
649
  ]
620
650
  }
651
+ },
652
+ "stats": {
653
+ "type": "object",
654
+ "properties": {
655
+ "minutesThisPeriod": {
656
+ "type": "number"
657
+ },
658
+ "runsThisPeriod": {
659
+ "type": "number"
660
+ },
661
+ "errorsThisPeriod": {
662
+ "type": "number"
663
+ }
664
+ },
665
+ "additionalProperties": false
621
666
  }
622
667
  }
623
668
  }