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/filePost.json CHANGED
@@ -34,7 +34,13 @@
34
34
  "height": {
35
35
  "type": "number"
36
36
  }
37
- }
37
+ },
38
+ "additionalProperties": false
38
39
  }
39
- }
40
+ },
41
+ "additionalProperties": false,
42
+ "required": [
43
+ "name",
44
+ "type"
45
+ ]
40
46
  }
data/schemas/flow.json CHANGED
@@ -81,7 +81,6 @@
81
81
  "onBoot",
82
82
  "onConnect",
83
83
  "onDisconnect",
84
- "request",
85
84
  "udp",
86
85
  "webhook"
87
86
  ]
@@ -115,7 +114,6 @@
115
114
  "onConnect",
116
115
  "onDisconnect",
117
116
  "particle",
118
- "request",
119
117
  "udp",
120
118
  "webhook"
121
119
  ]
@@ -321,6 +319,21 @@
321
319
  },
322
320
  "maxAge": {
323
321
  "type": "number"
322
+ },
323
+ "triggerOn": {
324
+ "type": "string",
325
+ "enum": [
326
+ "batch",
327
+ "individual",
328
+ "both"
329
+ ]
330
+ },
331
+ "batchBehavior": {
332
+ "type": "string",
333
+ "enum": [
334
+ "once",
335
+ "each"
336
+ ]
324
337
  }
325
338
  },
326
339
  "additionalProperties": false
@@ -1399,6 +1412,118 @@
1399
1412
  ],
1400
1413
  "additionalProperties": false
1401
1414
  },
1415
+ {
1416
+ "type": "object",
1417
+ "properties": {
1418
+ "key": {
1419
+ "type": "string",
1420
+ "maxLength": 1024
1421
+ },
1422
+ "type": {
1423
+ "type": "string",
1424
+ "enum": [
1425
+ "request"
1426
+ ]
1427
+ },
1428
+ "config": {
1429
+ "type": "object",
1430
+ "properties": {
1431
+ "method": {
1432
+ "type": "string",
1433
+ "enum": [
1434
+ "*",
1435
+ "delete",
1436
+ "get",
1437
+ "options",
1438
+ "patch",
1439
+ "post",
1440
+ "put"
1441
+ ]
1442
+ },
1443
+ "route": {
1444
+ "type": "string",
1445
+ "maxLength": 1024
1446
+ }
1447
+ },
1448
+ "additionalProperties": false
1449
+ },
1450
+ "meta": {
1451
+ "type": "object",
1452
+ "properties": {
1453
+ "category": {
1454
+ "type": "string",
1455
+ "enum": [
1456
+ "trigger"
1457
+ ]
1458
+ },
1459
+ "name": {
1460
+ "type": "string",
1461
+ "enum": [
1462
+ "request"
1463
+ ]
1464
+ },
1465
+ "label": {
1466
+ "type": "string",
1467
+ "minLength": 1,
1468
+ "maxLength": 255
1469
+ },
1470
+ "x": {
1471
+ "type": "number"
1472
+ },
1473
+ "y": {
1474
+ "type": "number"
1475
+ },
1476
+ "uiId": {
1477
+ "type": "string",
1478
+ "maxLength": 48
1479
+ },
1480
+ "description": {
1481
+ "type": "string",
1482
+ "maxLength": 32767
1483
+ },
1484
+ "icon": {
1485
+ "type": "string",
1486
+ "maxLength": 1024
1487
+ },
1488
+ "color": {
1489
+ "type": "string",
1490
+ "maxLength": 1024
1491
+ },
1492
+ "inputCount": {
1493
+ "type": "number"
1494
+ },
1495
+ "outputCount": {
1496
+ "type": "number"
1497
+ },
1498
+ "triggerId": {
1499
+ "type": "string",
1500
+ "maxLength": 48
1501
+ },
1502
+ "id": {
1503
+ "type": "string",
1504
+ "maxLength": 48
1505
+ }
1506
+ },
1507
+ "additionalProperties": false
1508
+ },
1509
+ "outputIds": {
1510
+ "type": "array",
1511
+ "items": {
1512
+ "type": "array",
1513
+ "items": {
1514
+ "type": "string",
1515
+ "maxLength": 255
1516
+ },
1517
+ "maxItems": 100
1518
+ },
1519
+ "maxItems": 100
1520
+ }
1521
+ },
1522
+ "required": [
1523
+ "type"
1524
+ ],
1525
+ "additionalProperties": false
1526
+ },
1402
1527
  {
1403
1528
  "type": "object",
1404
1529
  "properties": {
data/schemas/flowPatch.json CHANGED
@@ -62,7 +62,6 @@
62
62
  "onBoot",
63
63
  "onConnect",
64
64
  "onDisconnect",
65
- "request",
66
65
  "udp",
67
66
  "webhook"
68
67
  ]
@@ -96,7 +95,6 @@
96
95
  "onConnect",
97
96
  "onDisconnect",
98
97
  "particle",
99
- "request",
100
98
  "udp",
101
99
  "webhook"
102
100
  ]
@@ -302,6 +300,21 @@
302
300
  },
303
301
  "maxAge": {
304
302
  "type": "number"
303
+ },
304
+ "triggerOn": {
305
+ "type": "string",
306
+ "enum": [
307
+ "batch",
308
+ "individual",
309
+ "both"
310
+ ]
311
+ },
312
+ "batchBehavior": {
313
+ "type": "string",
314
+ "enum": [
315
+ "once",
316
+ "each"
317
+ ]
305
318
  }
306
319
  },
307
320
  "additionalProperties": false
@@ -1380,6 +1393,118 @@
1380
1393
  ],
1381
1394
  "additionalProperties": false
1382
1395
  },
1396
+ {
1397
+ "type": "object",
1398
+ "properties": {
1399
+ "key": {
1400
+ "type": "string",
1401
+ "maxLength": 1024
1402
+ },
1403
+ "type": {
1404
+ "type": "string",
1405
+ "enum": [
1406
+ "request"
1407
+ ]
1408
+ },
1409
+ "config": {
1410
+ "type": "object",
1411
+ "properties": {
1412
+ "method": {
1413
+ "type": "string",
1414
+ "enum": [
1415
+ "*",
1416
+ "delete",
1417
+ "get",
1418
+ "options",
1419
+ "patch",
1420
+ "post",
1421
+ "put"
1422
+ ]
1423
+ },
1424
+ "route": {
1425
+ "type": "string",
1426
+ "maxLength": 1024
1427
+ }
1428
+ },
1429
+ "additionalProperties": false
1430
+ },
1431
+ "meta": {
1432
+ "type": "object",
1433
+ "properties": {
1434
+ "category": {
1435
+ "type": "string",
1436
+ "enum": [
1437
+ "trigger"
1438
+ ]
1439
+ },
1440
+ "name": {
1441
+ "type": "string",
1442
+ "enum": [
1443
+ "request"
1444
+ ]
1445
+ },
1446
+ "label": {
1447
+ "type": "string",
1448
+ "minLength": 1,
1449
+ "maxLength": 255
1450
+ },
1451
+ "x": {
1452
+ "type": "number"
1453
+ },
1454
+ "y": {
1455
+ "type": "number"
1456
+ },
1457
+ "uiId": {
1458
+ "type": "string",
1459
+ "maxLength": 48
1460
+ },
1461
+ "description": {
1462
+ "type": "string",
1463
+ "maxLength": 32767
1464
+ },
1465
+ "icon": {
1466
+ "type": "string",
1467
+ "maxLength": 1024
1468
+ },
1469
+ "color": {
1470
+ "type": "string",
1471
+ "maxLength": 1024
1472
+ },
1473
+ "inputCount": {
1474
+ "type": "number"
1475
+ },
1476
+ "outputCount": {
1477
+ "type": "number"
1478
+ },
1479
+ "triggerId": {
1480
+ "type": "string",
1481
+ "maxLength": 48
1482
+ },
1483
+ "id": {
1484
+ "type": "string",
1485
+ "maxLength": 48
1486
+ }
1487
+ },
1488
+ "additionalProperties": false
1489
+ },
1490
+ "outputIds": {
1491
+ "type": "array",
1492
+ "items": {
1493
+ "type": "array",
1494
+ "items": {
1495
+ "type": "string",
1496
+ "maxLength": 255
1497
+ },
1498
+ "maxItems": 100
1499
+ },
1500
+ "maxItems": 100
1501
+ }
1502
+ },
1503
+ "required": [
1504
+ "type"
1505
+ ],
1506
+ "additionalProperties": false
1507
+ },
1383
1508
  {
1384
1509
  "type": "object",
1385
1510
  "properties": {
data/schemas/flowPost.json CHANGED
@@ -51,7 +51,6 @@
51
51
  "onBoot",
52
52
  "onConnect",
53
53
  "onDisconnect",
54
- "request",
55
54
  "udp",
56
55
  "webhook"
57
56
  ]
@@ -85,7 +84,6 @@
85
84
  "onConnect",
86
85
  "onDisconnect",
87
86
  "particle",
88
- "request",
89
87
  "udp",
90
88
  "webhook"
91
89
  ]
@@ -291,6 +289,21 @@
291
289
  },
292
290
  "maxAge": {
293
291
  "type": "number"
292
+ },
293
+ "triggerOn": {
294
+ "type": "string",
295
+ "enum": [
296
+ "batch",
297
+ "individual",
298
+ "both"
299
+ ]
300
+ },
301
+ "batchBehavior": {
302
+ "type": "string",
303
+ "enum": [
304
+ "once",
305
+ "each"
306
+ ]
294
307
  }
295
308
  },
296
309
  "additionalProperties": false
@@ -1369,6 +1382,118 @@
1369
1382
  ],
1370
1383
  "additionalProperties": false
1371
1384
  },
1385
+ {
1386
+ "type": "object",
1387
+ "properties": {
1388
+ "key": {
1389
+ "type": "string",
1390
+ "maxLength": 1024
1391
+ },
1392
+ "type": {
1393
+ "type": "string",
1394
+ "enum": [
1395
+ "request"
1396
+ ]
1397
+ },
1398
+ "config": {
1399
+ "type": "object",
1400
+ "properties": {
1401
+ "method": {
1402
+ "type": "string",
1403
+ "enum": [
1404
+ "*",
1405
+ "delete",
1406
+ "get",
1407
+ "options",
1408
+ "patch",
1409
+ "post",
1410
+ "put"
1411
+ ]
1412
+ },
1413
+ "route": {
1414
+ "type": "string",
1415
+ "maxLength": 1024
1416
+ }
1417
+ },
1418
+ "additionalProperties": false
1419
+ },
1420
+ "meta": {
1421
+ "type": "object",
1422
+ "properties": {
1423
+ "category": {
1424
+ "type": "string",
1425
+ "enum": [
1426
+ "trigger"
1427
+ ]
1428
+ },
1429
+ "name": {
1430
+ "type": "string",
1431
+ "enum": [
1432
+ "request"
1433
+ ]
1434
+ },
1435
+ "label": {
1436
+ "type": "string",
1437
+ "minLength": 1,
1438
+ "maxLength": 255
1439
+ },
1440
+ "x": {
1441
+ "type": "number"
1442
+ },
1443
+ "y": {
1444
+ "type": "number"
1445
+ },
1446
+ "uiId": {
1447
+ "type": "string",
1448
+ "maxLength": 48
1449
+ },
1450
+ "description": {
1451
+ "type": "string",
1452
+ "maxLength": 32767
1453
+ },
1454
+ "icon": {
1455
+ "type": "string",
1456
+ "maxLength": 1024
1457
+ },
1458
+ "color": {
1459
+ "type": "string",
1460
+ "maxLength": 1024
1461
+ },
1462
+ "inputCount": {
1463
+ "type": "number"
1464
+ },
1465
+ "outputCount": {
1466
+ "type": "number"
1467
+ },
1468
+ "triggerId": {
1469
+ "type": "string",
1470
+ "maxLength": 48
1471
+ },
1472
+ "id": {
1473
+ "type": "string",
1474
+ "maxLength": 48
1475
+ }
1476
+ },
1477
+ "additionalProperties": false
1478
+ },
1479
+ "outputIds": {
1480
+ "type": "array",
1481
+ "items": {
1482
+ "type": "array",
1483
+ "items": {
1484
+ "type": "string",
1485
+ "maxLength": 255
1486
+ },
1487
+ "maxItems": 100
1488
+ },
1489
+ "maxItems": 100
1490
+ }
1491
+ },
1492
+ "required": [
1493
+ "type"
1494
+ ],
1495
+ "additionalProperties": false
1496
+ },
1372
1497
  {
1373
1498
  "type": "object",
1374
1499
  "properties": {