losant_rest 1.13.0 → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (172) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +19437 -10622
  3. data/docs/application.md +6 -6
  4. data/docs/applicationApiTokens.md +1 -1
  5. data/docs/applications.md +1 -1
  6. data/docs/dataTable.md +1 -1
  7. data/docs/dataTableRows.md +1 -1
  8. data/docs/dataTables.md +1 -1
  9. data/docs/device.md +43 -0
  10. data/docs/devices.md +41 -2
  11. data/docs/edgeDeployment.md +49 -0
  12. data/docs/embeddedDeployment.md +49 -0
  13. data/docs/embeddedDeployments.md +215 -0
  14. data/docs/experience.md +1 -1
  15. data/docs/experienceDomains.md +1 -1
  16. data/docs/experienceGroup.md +2 -0
  17. data/docs/experienceSlugs.md +1 -1
  18. data/docs/experienceVersion.md +3 -3
  19. data/docs/experienceVersions.md +2 -2
  20. data/docs/experienceView.md +4 -4
  21. data/docs/experienceViews.md +2 -2
  22. data/docs/file.md +5 -5
  23. data/docs/files.md +2 -2
  24. data/docs/flow.md +3 -3
  25. data/docs/flowVersions.md +44 -0
  26. data/docs/flows.md +2 -2
  27. data/docs/instance.md +40 -0
  28. data/docs/instanceApiToken.md +133 -0
  29. data/docs/instanceApiTokens.md +91 -0
  30. data/docs/instanceMembers.md +1 -1
  31. data/docs/instanceOrg.md +2 -0
  32. data/docs/instanceOrgInvite.md +139 -0
  33. data/docs/instanceOrgInvites.md +96 -0
  34. data/docs/instanceOrgMembers.md +3 -3
  35. data/docs/instanceOrgs.md +1 -1
  36. data/docs/me.md +1 -1
  37. data/docs/org.md +1 -1
  38. data/docs/userApiToken.md +125 -0
  39. data/docs/userApiTokens.md +87 -0
  40. data/lib/losant_rest/application.rb +5 -5
  41. data/lib/losant_rest/application_api_tokens.rb +1 -1
  42. data/lib/losant_rest/applications.rb +1 -1
  43. data/lib/losant_rest/client.rb +38 -2
  44. data/lib/losant_rest/data_table.rb +1 -1
  45. data/lib/losant_rest/data_table_rows.rb +1 -1
  46. data/lib/losant_rest/data_tables.rb +1 -1
  47. data/lib/losant_rest/device.rb +50 -0
  48. data/lib/losant_rest/devices.rb +48 -2
  49. data/lib/losant_rest/edge_deployment.rb +81 -0
  50. data/lib/losant_rest/embedded_deployment.rb +81 -0
  51. data/lib/losant_rest/embedded_deployments.rb +280 -0
  52. data/lib/losant_rest/experience.rb +1 -1
  53. data/lib/losant_rest/experience_domains.rb +1 -1
  54. data/lib/losant_rest/experience_group.rb +4 -0
  55. data/lib/losant_rest/experience_slugs.rb +1 -1
  56. data/lib/losant_rest/experience_version.rb +3 -3
  57. data/lib/losant_rest/experience_versions.rb +2 -2
  58. data/lib/losant_rest/experience_view.rb +4 -4
  59. data/lib/losant_rest/experience_views.rb +2 -2
  60. data/lib/losant_rest/file.rb +4 -4
  61. data/lib/losant_rest/files.rb +2 -2
  62. data/lib/losant_rest/flow.rb +3 -3
  63. data/lib/losant_rest/flow_versions.rb +50 -0
  64. data/lib/losant_rest/flows.rb +2 -2
  65. data/lib/losant_rest/instance.rb +47 -1
  66. data/lib/losant_rest/instance_api_token.rb +176 -0
  67. data/lib/losant_rest/instance_api_tokens.rb +136 -0
  68. data/lib/losant_rest/instance_member.rb +1 -1
  69. data/lib/losant_rest/instance_members.rb +2 -2
  70. data/lib/losant_rest/instance_org.rb +5 -1
  71. data/lib/losant_rest/instance_org_invite.rb +182 -0
  72. data/lib/losant_rest/instance_org_invites.rb +138 -0
  73. data/lib/losant_rest/instance_org_member.rb +1 -1
  74. data/lib/losant_rest/instance_org_members.rb +4 -4
  75. data/lib/losant_rest/instance_orgs.rb +3 -3
  76. data/lib/losant_rest/instances.rb +1 -1
  77. data/lib/losant_rest/user_api_token.rb +170 -0
  78. data/lib/losant_rest/user_api_tokens.rb +132 -0
  79. data/lib/losant_rest/version.rb +1 -1
  80. data/lib/losant_rest.rb +9 -0
  81. data/schemas/apiToken.json +2 -1
  82. data/schemas/apiTokenPost.json +439 -0
  83. data/schemas/apiTokens.json +4 -2
  84. data/schemas/application.json +32 -32
  85. data/schemas/applicationCreationByTemplateResult.json +32 -32
  86. data/schemas/applicationDashboardPost.json +28 -21
  87. data/schemas/applicationPatch.json +13 -13
  88. data/schemas/applicationPost.json +13 -13
  89. data/schemas/applicationTemplate.json +16 -16
  90. data/schemas/applicationTemplates.json +16 -16
  91. data/schemas/applications.json +32 -32
  92. data/schemas/auditLog.json +4 -0
  93. data/schemas/auditLogFilter.json +4 -0
  94. data/schemas/auditLogs.json +4 -0
  95. data/schemas/authedDevice.json +2 -1
  96. data/schemas/bulkDeleteResponse.json +12 -0
  97. data/schemas/dashboard.json +28 -21
  98. data/schemas/dashboardPatch.json +28 -21
  99. data/schemas/dashboardPost.json +28 -21
  100. data/schemas/dashboardSendReport.json +9 -5
  101. data/schemas/dashboards.json +28 -21
  102. data/schemas/dataTableRowsDelete.json +1 -1
  103. data/schemas/device.json +2 -1
  104. data/schemas/deviceClassFilter.json +4 -2
  105. data/schemas/devicePatch.json +2 -1
  106. data/schemas/devicePayloadCounts.json +24 -0
  107. data/schemas/devicePost.json +2 -1
  108. data/schemas/deviceRecipe.json +2 -1
  109. data/schemas/deviceRecipePatch.json +2 -1
  110. data/schemas/deviceRecipePost.json +2 -1
  111. data/schemas/deviceRecipes.json +2 -1
  112. data/schemas/devices.json +4 -2
  113. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  114. data/schemas/devicesPatch.json +4 -2
  115. data/schemas/edgeDeployment.json +20 -0
  116. data/schemas/edgeDeployments.json +20 -0
  117. data/schemas/embeddedDeployment.json +179 -0
  118. data/schemas/embeddedDeploymentExport.json +44 -0
  119. data/schemas/embeddedDeploymentRelease.json +58 -0
  120. data/schemas/embeddedDeploymentRemove.json +25 -0
  121. data/schemas/embeddedDeploymentReplace.json +29 -0
  122. data/schemas/embeddedDeployments.json +212 -0
  123. data/schemas/eventsDeleted.json +1 -1
  124. data/schemas/experienceEndpoint.json +6 -8
  125. data/schemas/experienceEndpointPatch.json +6 -8
  126. data/schemas/experienceEndpointPost.json +6 -8
  127. data/schemas/experienceEndpoints.json +6 -8
  128. data/schemas/experienceGroup.json +6 -0
  129. data/schemas/experienceGroups.json +6 -0
  130. data/schemas/experienceLinkedResources.json +790 -85
  131. data/schemas/flow.json +252 -16
  132. data/schemas/flowPatch.json +251 -16
  133. data/schemas/flowPost.json +252 -16
  134. data/schemas/flowVersion.json +503 -33
  135. data/schemas/flowVersionPost.json +251 -16
  136. data/schemas/flowVersions.json +503 -33
  137. data/schemas/flowVersionsDeletePost.json +941 -0
  138. data/schemas/flows.json +253 -16
  139. data/schemas/flowsImportPost.json +503 -32
  140. data/schemas/flowsImportResult.json +785 -79
  141. data/schemas/githubLogin.json +38 -1
  142. data/schemas/historicalSummary.json +150 -102
  143. data/schemas/instance.json +150 -77
  144. data/schemas/instanceMember.json +10 -0
  145. data/schemas/instanceMemberPost.json +18 -3
  146. data/schemas/instanceMembers.json +14 -0
  147. data/schemas/instanceOrg.json +87 -74
  148. data/schemas/instanceOrgMember.json +14 -0
  149. data/schemas/instanceOrgMembers.json +8 -0
  150. data/schemas/instanceOrgPatch.json +64 -26
  151. data/schemas/instanceOrgPost.json +229 -25
  152. data/schemas/instanceOrgs.json +91 -74
  153. data/schemas/instancePatch.json +67 -0
  154. data/schemas/instanceReportOptionsPost.json +1 -0
  155. data/schemas/me.json +134 -105
  156. data/schemas/notebook.json +45 -0
  157. data/schemas/notebookPatch.json +30 -0
  158. data/schemas/notebookPost.json +30 -0
  159. data/schemas/notebooks.json +45 -0
  160. data/schemas/org.json +145 -110
  161. data/schemas/orgInvite.json +90 -0
  162. data/schemas/orgInviteCollection.json +130 -0
  163. data/schemas/orgInvites.json +82 -77
  164. data/schemas/orgRoleInfo.json +69 -0
  165. data/schemas/orgs.json +145 -110
  166. data/schemas/payloadStats.json +28 -12
  167. data/schemas/userCredentials.json +38 -1
  168. data/schemas/userPost.json +38 -1
  169. data/schemas/validateContextError.json +34 -0
  170. data/schemas/validateContextSuccess.json +34 -0
  171. data/schemas/virtualButtonPress.json +4 -0
  172. metadata +39 -6
data/schemas/flowVersionPost.json CHANGED
@@ -39,7 +39,6 @@
39
39
  "onBoot",
40
40
  "onConnect",
41
41
  "onDisconnect",
42
- "request",
43
42
  "udp",
44
43
  "webhook"
45
44
  ]
@@ -64,6 +63,7 @@
64
63
  "deviceCommand",
65
64
  "deviceIdsTagsConnect",
66
65
  "deviceIdsTagsDisconnect",
66
+ "eeaInit",
67
67
  "flowError",
68
68
  "googlePubSub",
69
69
  "meridian",
@@ -73,7 +73,6 @@
73
73
  "onConnect",
74
74
  "onDisconnect",
75
75
  "particle",
76
- "request",
77
76
  "udp",
78
77
  "webhook"
79
78
  ]
@@ -128,7 +127,8 @@
128
127
  "type": "array",
129
128
  "items": {
130
129
  "type": "string",
131
- "maxLength": 255
130
+ "maxLength": 48,
131
+ "minLength": 1
132
132
  },
133
133
  "maxItems": 100
134
134
  },
@@ -232,7 +232,8 @@
232
232
  "type": "array",
233
233
  "items": {
234
234
  "type": "string",
235
- "maxLength": 255
235
+ "maxLength": 48,
236
+ "minLength": 1
236
237
  },
237
238
  "maxItems": 100
238
239
  },
@@ -279,6 +280,21 @@
279
280
  },
280
281
  "maxAge": {
281
282
  "type": "number"
283
+ },
284
+ "triggerOn": {
285
+ "type": "string",
286
+ "enum": [
287
+ "batch",
288
+ "individual",
289
+ "both"
290
+ ]
291
+ },
292
+ "batchBehavior": {
293
+ "type": "string",
294
+ "enum": [
295
+ "once",
296
+ "each"
297
+ ]
282
298
  }
283
299
  },
284
300
  "additionalProperties": false
@@ -361,7 +377,8 @@
361
377
  "type": "array",
362
378
  "items": {
363
379
  "type": "string",
364
- "maxLength": 255
380
+ "maxLength": 48,
381
+ "minLength": 1
365
382
  },
366
383
  "maxItems": 100
367
384
  },
@@ -457,8 +474,101 @@
457
474
  "type": "array",
458
475
  "items": {
459
476
  "type": "string",
477
+ "maxLength": 48,
478
+ "minLength": 1
479
+ },
480
+ "maxItems": 100
481
+ },
482
+ "maxItems": 100
483
+ }
484
+ },
485
+ "required": [
486
+ "type"
487
+ ],
488
+ "additionalProperties": false
489
+ },
490
+ {
491
+ "type": "object",
492
+ "properties": {
493
+ "key": {
494
+ "type": "string",
495
+ "maxLength": 1024
496
+ },
497
+ "type": {
498
+ "type": "string",
499
+ "enum": [
500
+ "direct"
501
+ ]
502
+ },
503
+ "config": {
504
+ "type": "object",
505
+ "properties": {},
506
+ "additionalProperties": false
507
+ },
508
+ "meta": {
509
+ "type": "object",
510
+ "properties": {
511
+ "category": {
512
+ "type": "string",
513
+ "enum": [
514
+ "trigger"
515
+ ]
516
+ },
517
+ "name": {
518
+ "type": "string",
519
+ "enum": [
520
+ "direct"
521
+ ]
522
+ },
523
+ "label": {
524
+ "type": "string",
525
+ "minLength": 1,
460
526
  "maxLength": 255
461
527
  },
528
+ "x": {
529
+ "type": "number"
530
+ },
531
+ "y": {
532
+ "type": "number"
533
+ },
534
+ "uiId": {
535
+ "type": "string",
536
+ "maxLength": 48
537
+ },
538
+ "description": {
539
+ "type": "string",
540
+ "maxLength": 32767
541
+ },
542
+ "icon": {
543
+ "type": "string",
544
+ "maxLength": 1024
545
+ },
546
+ "color": {
547
+ "type": "string",
548
+ "maxLength": 1024
549
+ },
550
+ "inputCount": {
551
+ "type": "number"
552
+ },
553
+ "outputCount": {
554
+ "type": "number"
555
+ },
556
+ "id": {
557
+ "type": "string",
558
+ "maxLength": 48
559
+ }
560
+ },
561
+ "additionalProperties": false
562
+ },
563
+ "outputIds": {
564
+ "type": "array",
565
+ "items": {
566
+ "type": "array",
567
+ "items": {
568
+ "type": "string",
569
+ "maxLength": 48,
570
+ "minLength": 1
571
+ },
462
572
  "maxItems": 100
463
573
  },
464
574
  "maxItems": 100
@@ -554,7 +664,8 @@
554
664
  "type": "array",
555
665
  "items": {
556
666
  "type": "string",
557
- "maxLength": 255
667
+ "maxLength": 48,
668
+ "minLength": 1
558
669
  },
559
670
  "maxItems": 100
560
671
  },
@@ -659,7 +770,8 @@
659
770
  "type": "array",
660
771
  "items": {
661
772
  "type": "string",
662
- "maxLength": 255
773
+ "maxLength": 48,
774
+ "minLength": 1
663
775
  },
664
776
  "maxItems": 100
665
777
  },
@@ -767,7 +879,8 @@
767
879
  "type": "array",
768
880
  "items": {
769
881
  "type": "string",
770
- "maxLength": 255
882
+ "maxLength": 48,
883
+ "minLength": 1
771
884
  },
772
885
  "maxItems": 100
773
886
  },
@@ -878,7 +991,8 @@
878
991
  "type": "array",
879
992
  "items": {
880
993
  "type": "string",
881
- "maxLength": 255
994
+ "maxLength": 48,
995
+ "minLength": 1
882
996
  },
883
997
  "maxItems": 100
884
998
  },
@@ -979,7 +1093,8 @@
979
1093
  "type": "array",
980
1094
  "items": {
981
1095
  "type": "string",
982
- "maxLength": 255
1096
+ "maxLength": 48,
1097
+ "minLength": 1
983
1098
  },
984
1099
  "maxItems": 100
985
1100
  },
@@ -1082,7 +1197,8 @@
1082
1197
  "type": "array",
1083
1198
  "items": {
1084
1199
  "type": "string",
1085
- "maxLength": 255
1200
+ "maxLength": 48,
1201
+ "minLength": 1
1086
1202
  },
1087
1203
  "maxItems": 100
1088
1204
  },
@@ -1222,7 +1338,8 @@
1222
1338
  "type": "array",
1223
1339
  "items": {
1224
1340
  "type": "string",
1225
- "maxLength": 255
1341
+ "maxLength": 48,
1342
+ "minLength": 1
1226
1343
  },
1227
1344
  "maxItems": 100
1228
1345
  },
@@ -1345,8 +1462,122 @@
1345
1462
  "type": "array",
1346
1463
  "items": {
1347
1464
  "type": "string",
1465
+ "maxLength": 48,
1466
+ "minLength": 1
1467
+ },
1468
+ "maxItems": 100
1469
+ },
1470
+ "maxItems": 100
1471
+ }
1472
+ },
1473
+ "required": [
1474
+ "type"
1475
+ ],
1476
+ "additionalProperties": false
1477
+ },
1478
+ {
1479
+ "type": "object",
1480
+ "properties": {
1481
+ "key": {
1482
+ "type": "string",
1483
+ "maxLength": 1024
1484
+ },
1485
+ "type": {
1486
+ "type": "string",
1487
+ "enum": [
1488
+ "request"
1489
+ ]
1490
+ },
1491
+ "config": {
1492
+ "type": "object",
1493
+ "properties": {
1494
+ "method": {
1495
+ "type": "string",
1496
+ "enum": [
1497
+ "*",
1498
+ "delete",
1499
+ "get",
1500
+ "options",
1501
+ "patch",
1502
+ "post",
1503
+ "put"
1504
+ ]
1505
+ },
1506
+ "route": {
1507
+ "type": "string",
1508
+ "maxLength": 1024
1509
+ }
1510
+ },
1511
+ "additionalProperties": false
1512
+ },
1513
+ "meta": {
1514
+ "type": "object",
1515
+ "properties": {
1516
+ "category": {
1517
+ "type": "string",
1518
+ "enum": [
1519
+ "trigger"
1520
+ ]
1521
+ },
1522
+ "name": {
1523
+ "type": "string",
1524
+ "enum": [
1525
+ "request"
1526
+ ]
1527
+ },
1528
+ "label": {
1529
+ "type": "string",
1530
+ "minLength": 1,
1348
1531
  "maxLength": 255
1349
1532
  },
1533
+ "x": {
1534
+ "type": "number"
1535
+ },
1536
+ "y": {
1537
+ "type": "number"
1538
+ },
1539
+ "uiId": {
1540
+ "type": "string",
1541
+ "maxLength": 48
1542
+ },
1543
+ "description": {
1544
+ "type": "string",
1545
+ "maxLength": 32767
1546
+ },
1547
+ "icon": {
1548
+ "type": "string",
1549
+ "maxLength": 1024
1550
+ },
1551
+ "color": {
1552
+ "type": "string",
1553
+ "maxLength": 1024
1554
+ },
1555
+ "inputCount": {
1556
+ "type": "number"
1557
+ },
1558
+ "outputCount": {
1559
+ "type": "number"
1560
+ },
1561
+ "triggerId": {
1562
+ "type": "string",
1563
+ "maxLength": 48
1564
+ },
1565
+ "id": {
1566
+ "type": "string",
1567
+ "maxLength": 48
1568
+ }
1569
+ },
1570
+ "additionalProperties": false
1571
+ },
1572
+ "outputIds": {
1573
+ "type": "array",
1574
+ "items": {
1575
+ "type": "array",
1576
+ "items": {
1577
+ "type": "string",
1578
+ "maxLength": 48,
1579
+ "minLength": 1
1580
+ },
1350
1581
  "maxItems": 100
1351
1582
  },
1352
1583
  "maxItems": 100
@@ -1488,7 +1719,8 @@
1488
1719
  "type": "array",
1489
1720
  "items": {
1490
1721
  "type": "string",
1491
- "maxLength": 255
1722
+ "maxLength": 48,
1723
+ "minLength": 1
1492
1724
  },
1493
1725
  "maxItems": 100
1494
1726
  },
@@ -1614,7 +1846,8 @@
1614
1846
  "type": "array",
1615
1847
  "items": {
1616
1848
  "type": "string",
1617
- "maxLength": 255
1849
+ "maxLength": 48,
1850
+ "minLength": 1
1618
1851
  },
1619
1852
  "maxItems": 100
1620
1853
  },
@@ -1729,7 +1962,8 @@
1729
1962
  "type": "array",
1730
1963
  "items": {
1731
1964
  "type": "string",
1732
- "maxLength": 255
1965
+ "maxLength": 48,
1966
+ "minLength": 1
1733
1967
  },
1734
1968
  "maxItems": 100
1735
1969
  },
@@ -1770,7 +2004,8 @@
1770
2004
  "type": "array",
1771
2005
  "items": {
1772
2006
  "type": "string",
1773
- "maxLength": 255
2007
+ "maxLength": 48,
2008
+ "minLength": 1
1774
2009
  },
1775
2010
  "maxItems": 100
1776
2011
  },