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/flows.json CHANGED
@@ -88,7 +88,6 @@
88
88
  "onBoot",
89
89
  "onConnect",
90
90
  "onDisconnect",
91
- "request",
92
91
  "udp",
93
92
  "webhook"
94
93
  ]
@@ -122,7 +121,6 @@
122
121
  "onConnect",
123
122
  "onDisconnect",
124
123
  "particle",
125
- "request",
126
124
  "udp",
127
125
  "webhook"
128
126
  ]
@@ -328,6 +326,21 @@
328
326
  },
329
327
  "maxAge": {
330
328
  "type": "number"
329
+ },
330
+ "triggerOn": {
331
+ "type": "string",
332
+ "enum": [
333
+ "batch",
334
+ "individual",
335
+ "both"
336
+ ]
337
+ },
338
+ "batchBehavior": {
339
+ "type": "string",
340
+ "enum": [
341
+ "once",
342
+ "each"
343
+ ]
331
344
  }
332
345
  },
333
346
  "additionalProperties": false
@@ -1406,6 +1419,118 @@
1406
1419
  ],
1407
1420
  "additionalProperties": false
1408
1421
  },
1422
+ {
1423
+ "type": "object",
1424
+ "properties": {
1425
+ "key": {
1426
+ "type": "string",
1427
+ "maxLength": 1024
1428
+ },
1429
+ "type": {
1430
+ "type": "string",
1431
+ "enum": [
1432
+ "request"
1433
+ ]
1434
+ },
1435
+ "config": {
1436
+ "type": "object",
1437
+ "properties": {
1438
+ "method": {
1439
+ "type": "string",
1440
+ "enum": [
1441
+ "*",
1442
+ "delete",
1443
+ "get",
1444
+ "options",
1445
+ "patch",
1446
+ "post",
1447
+ "put"
1448
+ ]
1449
+ },
1450
+ "route": {
1451
+ "type": "string",
1452
+ "maxLength": 1024
1453
+ }
1454
+ },
1455
+ "additionalProperties": false
1456
+ },
1457
+ "meta": {
1458
+ "type": "object",
1459
+ "properties": {
1460
+ "category": {
1461
+ "type": "string",
1462
+ "enum": [
1463
+ "trigger"
1464
+ ]
1465
+ },
1466
+ "name": {
1467
+ "type": "string",
1468
+ "enum": [
1469
+ "request"
1470
+ ]
1471
+ },
1472
+ "label": {
1473
+ "type": "string",
1474
+ "minLength": 1,
1475
+ "maxLength": 255
1476
+ },
1477
+ "x": {
1478
+ "type": "number"
1479
+ },
1480
+ "y": {
1481
+ "type": "number"
1482
+ },
1483
+ "uiId": {
1484
+ "type": "string",
1485
+ "maxLength": 48
1486
+ },
1487
+ "description": {
1488
+ "type": "string",
1489
+ "maxLength": 32767
1490
+ },
1491
+ "icon": {
1492
+ "type": "string",
1493
+ "maxLength": 1024
1494
+ },
1495
+ "color": {
1496
+ "type": "string",
1497
+ "maxLength": 1024
1498
+ },
1499
+ "inputCount": {
1500
+ "type": "number"
1501
+ },
1502
+ "outputCount": {
1503
+ "type": "number"
1504
+ },
1505
+ "triggerId": {
1506
+ "type": "string",
1507
+ "maxLength": 48
1508
+ },
1509
+ "id": {
1510
+ "type": "string",
1511
+ "maxLength": 48
1512
+ }
1513
+ },
1514
+ "additionalProperties": false
1515
+ },
1516
+ "outputIds": {
1517
+ "type": "array",
1518
+ "items": {
1519
+ "type": "array",
1520
+ "items": {
1521
+ "type": "string",
1522
+ "maxLength": 255
1523
+ },
1524
+ "maxItems": 100
1525
+ },
1526
+ "maxItems": 100
1527
+ }
1528
+ },
1529
+ "required": [
1530
+ "type"
1531
+ ],
1532
+ "additionalProperties": false
1533
+ },
1409
1534
  {
1410
1535
  "type": "object",
1411
1536
  "properties": {
data/schemas/flowsImportPost.json CHANGED
@@ -58,7 +58,6 @@
58
58
  "onBoot",
59
59
  "onConnect",
60
60
  "onDisconnect",
61
- "request",
62
61
  "udp",
63
62
  "webhook"
64
63
  ]
@@ -92,7 +91,6 @@
92
91
  "onConnect",
93
92
  "onDisconnect",
94
93
  "particle",
95
- "request",
96
94
  "udp",
97
95
  "webhook"
98
96
  ]
@@ -298,6 +296,21 @@
298
296
  },
299
297
  "maxAge": {
300
298
  "type": "number"
299
+ },
300
+ "triggerOn": {
301
+ "type": "string",
302
+ "enum": [
303
+ "batch",
304
+ "individual",
305
+ "both"
306
+ ]
307
+ },
308
+ "batchBehavior": {
309
+ "type": "string",
310
+ "enum": [
311
+ "once",
312
+ "each"
313
+ ]
301
314
  }
302
315
  },
303
316
  "additionalProperties": false
@@ -1376,6 +1389,118 @@
1376
1389
  ],
1377
1390
  "additionalProperties": false
1378
1391
  },
1392
+ {
1393
+ "type": "object",
1394
+ "properties": {
1395
+ "key": {
1396
+ "type": "string",
1397
+ "maxLength": 1024
1398
+ },
1399
+ "type": {
1400
+ "type": "string",
1401
+ "enum": [
1402
+ "request"
1403
+ ]
1404
+ },
1405
+ "config": {
1406
+ "type": "object",
1407
+ "properties": {
1408
+ "method": {
1409
+ "type": "string",
1410
+ "enum": [
1411
+ "*",
1412
+ "delete",
1413
+ "get",
1414
+ "options",
1415
+ "patch",
1416
+ "post",
1417
+ "put"
1418
+ ]
1419
+ },
1420
+ "route": {
1421
+ "type": "string",
1422
+ "maxLength": 1024
1423
+ }
1424
+ },
1425
+ "additionalProperties": false
1426
+ },
1427
+ "meta": {
1428
+ "type": "object",
1429
+ "properties": {
1430
+ "category": {
1431
+ "type": "string",
1432
+ "enum": [
1433
+ "trigger"
1434
+ ]
1435
+ },
1436
+ "name": {
1437
+ "type": "string",
1438
+ "enum": [
1439
+ "request"
1440
+ ]
1441
+ },
1442
+ "label": {
1443
+ "type": "string",
1444
+ "minLength": 1,
1445
+ "maxLength": 255
1446
+ },
1447
+ "x": {
1448
+ "type": "number"
1449
+ },
1450
+ "y": {
1451
+ "type": "number"
1452
+ },
1453
+ "uiId": {
1454
+ "type": "string",
1455
+ "maxLength": 48
1456
+ },
1457
+ "description": {
1458
+ "type": "string",
1459
+ "maxLength": 32767
1460
+ },
1461
+ "icon": {
1462
+ "type": "string",
1463
+ "maxLength": 1024
1464
+ },
1465
+ "color": {
1466
+ "type": "string",
1467
+ "maxLength": 1024
1468
+ },
1469
+ "inputCount": {
1470
+ "type": "number"
1471
+ },
1472
+ "outputCount": {
1473
+ "type": "number"
1474
+ },
1475
+ "triggerId": {
1476
+ "type": "string",
1477
+ "maxLength": 48
1478
+ },
1479
+ "id": {
1480
+ "type": "string",
1481
+ "maxLength": 48
1482
+ }
1483
+ },
1484
+ "additionalProperties": false
1485
+ },
1486
+ "outputIds": {
1487
+ "type": "array",
1488
+ "items": {
1489
+ "type": "array",
1490
+ "items": {
1491
+ "type": "string",
1492
+ "maxLength": 255
1493
+ },
1494
+ "maxItems": 100
1495
+ },
1496
+ "maxItems": 100
1497
+ }
1498
+ },
1499
+ "required": [
1500
+ "type"
1501
+ ],
1502
+ "additionalProperties": false
1503
+ },
1379
1504
  {
1380
1505
  "type": "object",
1381
1506
  "properties": {
@@ -2237,7 +2362,6 @@
2237
2362
  "onBoot",
2238
2363
  "onConnect",
2239
2364
  "onDisconnect",
2240
- "request",
2241
2365
  "udp",
2242
2366
  "webhook"
2243
2367
  ]
@@ -2271,7 +2395,6 @@
2271
2395
  "onConnect",
2272
2396
  "onDisconnect",
2273
2397
  "particle",
2274
- "request",
2275
2398
  "udp",
2276
2399
  "webhook"
2277
2400
  ]
@@ -2477,6 +2600,21 @@
2477
2600
  },
2478
2601
  "maxAge": {
2479
2602
  "type": "number"
2603
+ },
2604
+ "triggerOn": {
2605
+ "type": "string",
2606
+ "enum": [
2607
+ "batch",
2608
+ "individual",
2609
+ "both"
2610
+ ]
2611
+ },
2612
+ "batchBehavior": {
2613
+ "type": "string",
2614
+ "enum": [
2615
+ "once",
2616
+ "each"
2617
+ ]
2480
2618
  }
2481
2619
  },
2482
2620
  "additionalProperties": false
@@ -3555,6 +3693,118 @@
3555
3693
  ],
3556
3694
  "additionalProperties": false
3557
3695
  },
3696
+ {
3697
+ "type": "object",
3698
+ "properties": {
3699
+ "key": {
3700
+ "type": "string",
3701
+ "maxLength": 1024
3702
+ },
3703
+ "type": {
3704
+ "type": "string",
3705
+ "enum": [
3706
+ "request"
3707
+ ]
3708
+ },
3709
+ "config": {
3710
+ "type": "object",
3711
+ "properties": {
3712
+ "method": {
3713
+ "type": "string",
3714
+ "enum": [
3715
+ "*",
3716
+ "delete",
3717
+ "get",
3718
+ "options",
3719
+ "patch",
3720
+ "post",
3721
+ "put"
3722
+ ]
3723
+ },
3724
+ "route": {
3725
+ "type": "string",
3726
+ "maxLength": 1024
3727
+ }
3728
+ },
3729
+ "additionalProperties": false
3730
+ },
3731
+ "meta": {
3732
+ "type": "object",
3733
+ "properties": {
3734
+ "category": {
3735
+ "type": "string",
3736
+ "enum": [
3737
+ "trigger"
3738
+ ]
3739
+ },
3740
+ "name": {
3741
+ "type": "string",
3742
+ "enum": [
3743
+ "request"
3744
+ ]
3745
+ },
3746
+ "label": {
3747
+ "type": "string",
3748
+ "minLength": 1,
3749
+ "maxLength": 255
3750
+ },
3751
+ "x": {
3752
+ "type": "number"
3753
+ },
3754
+ "y": {
3755
+ "type": "number"
3756
+ },
3757
+ "uiId": {
3758
+ "type": "string",
3759
+ "maxLength": 48
3760
+ },
3761
+ "description": {
3762
+ "type": "string",
3763
+ "maxLength": 32767
3764
+ },
3765
+ "icon": {
3766
+ "type": "string",
3767
+ "maxLength": 1024
3768
+ },
3769
+ "color": {
3770
+ "type": "string",
3771
+ "maxLength": 1024
3772
+ },
3773
+ "inputCount": {
3774
+ "type": "number"
3775
+ },
3776
+ "outputCount": {
3777
+ "type": "number"
3778
+ },
3779
+ "triggerId": {
3780
+ "type": "string",
3781
+ "maxLength": 48
3782
+ },
3783
+ "id": {
3784
+ "type": "string",
3785
+ "maxLength": 48
3786
+ }
3787
+ },
3788
+ "additionalProperties": false
3789
+ },
3790
+ "outputIds": {
3791
+ "type": "array",
3792
+ "items": {
3793
+ "type": "array",
3794
+ "items": {
3795
+ "type": "string",
3796
+ "maxLength": 255
3797
+ },
3798
+ "maxItems": 100
3799
+ },
3800
+ "maxItems": 100
3801
+ }
3802
+ },
3803
+ "required": [
3804
+ "type"
3805
+ ],
3806
+ "additionalProperties": false
3807
+ },
3558
3808
  {
3559
3809
  "type": "object",
3560
3810
  "properties": {