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/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
  ]
@@ -76,6 +75,7 @@
76
75
  "deviceCommand",
77
76
  "deviceIdsTagsConnect",
78
77
  "deviceIdsTagsDisconnect",
78
+ "eeaInit",
79
79
  "flowError",
80
80
  "googlePubSub",
81
81
  "meridian",
@@ -85,7 +85,6 @@
85
85
  "onConnect",
86
86
  "onDisconnect",
87
87
  "particle",
88
- "request",
89
88
  "udp",
90
89
  "webhook"
91
90
  ]
@@ -140,7 +139,8 @@
140
139
  "type": "array",
141
140
  "items": {
142
141
  "type": "string",
143
- "maxLength": 255
142
+ "maxLength": 48,
143
+ "minLength": 1
144
144
  },
145
145
  "maxItems": 100
146
146
  },
@@ -244,7 +244,8 @@
244
244
  "type": "array",
245
245
  "items": {
246
246
  "type": "string",
247
- "maxLength": 255
247
+ "maxLength": 48,
248
+ "minLength": 1
248
249
  },
249
250
  "maxItems": 100
250
251
  },
@@ -291,6 +292,21 @@
291
292
  },
292
293
  "maxAge": {
293
294
  "type": "number"
295
+ },
296
+ "triggerOn": {
297
+ "type": "string",
298
+ "enum": [
299
+ "batch",
300
+ "individual",
301
+ "both"
302
+ ]
303
+ },
304
+ "batchBehavior": {
305
+ "type": "string",
306
+ "enum": [
307
+ "once",
308
+ "each"
309
+ ]
294
310
  }
295
311
  },
296
312
  "additionalProperties": false
@@ -373,7 +389,8 @@
373
389
  "type": "array",
374
390
  "items": {
375
391
  "type": "string",
376
- "maxLength": 255
392
+ "maxLength": 48,
393
+ "minLength": 1
377
394
  },
378
395
  "maxItems": 100
379
396
  },
@@ -469,8 +486,101 @@
469
486
  "type": "array",
470
487
  "items": {
471
488
  "type": "string",
489
+ "maxLength": 48,
490
+ "minLength": 1
491
+ },
492
+ "maxItems": 100
493
+ },
494
+ "maxItems": 100
495
+ }
496
+ },
497
+ "required": [
498
+ "type"
499
+ ],
500
+ "additionalProperties": false
501
+ },
502
+ {
503
+ "type": "object",
504
+ "properties": {
505
+ "key": {
506
+ "type": "string",
507
+ "maxLength": 1024
508
+ },
509
+ "type": {
510
+ "type": "string",
511
+ "enum": [
512
+ "direct"
513
+ ]
514
+ },
515
+ "config": {
516
+ "type": "object",
517
+ "properties": {},
518
+ "additionalProperties": false
519
+ },
520
+ "meta": {
521
+ "type": "object",
522
+ "properties": {
523
+ "category": {
524
+ "type": "string",
525
+ "enum": [
526
+ "trigger"
527
+ ]
528
+ },
529
+ "name": {
530
+ "type": "string",
531
+ "enum": [
532
+ "direct"
533
+ ]
534
+ },
535
+ "label": {
536
+ "type": "string",
537
+ "minLength": 1,
472
538
  "maxLength": 255
473
539
  },
540
+ "x": {
541
+ "type": "number"
542
+ },
543
+ "y": {
544
+ "type": "number"
545
+ },
546
+ "uiId": {
547
+ "type": "string",
548
+ "maxLength": 48
549
+ },
550
+ "description": {
551
+ "type": "string",
552
+ "maxLength": 32767
553
+ },
554
+ "icon": {
555
+ "type": "string",
556
+ "maxLength": 1024
557
+ },
558
+ "color": {
559
+ "type": "string",
560
+ "maxLength": 1024
561
+ },
562
+ "inputCount": {
563
+ "type": "number"
564
+ },
565
+ "outputCount": {
566
+ "type": "number"
567
+ },
568
+ "id": {
569
+ "type": "string",
570
+ "maxLength": 48
571
+ }
572
+ },
573
+ "additionalProperties": false
574
+ },
575
+ "outputIds": {
576
+ "type": "array",
577
+ "items": {
578
+ "type": "array",
579
+ "items": {
580
+ "type": "string",
581
+ "maxLength": 48,
582
+ "minLength": 1
583
+ },
474
584
  "maxItems": 100
475
585
  },
476
586
  "maxItems": 100
@@ -566,7 +676,8 @@
566
676
  "type": "array",
567
677
  "items": {
568
678
  "type": "string",
569
- "maxLength": 255
679
+ "maxLength": 48,
680
+ "minLength": 1
570
681
  },
571
682
  "maxItems": 100
572
683
  },
@@ -671,7 +782,8 @@
671
782
  "type": "array",
672
783
  "items": {
673
784
  "type": "string",
674
- "maxLength": 255
785
+ "maxLength": 48,
786
+ "minLength": 1
675
787
  },
676
788
  "maxItems": 100
677
789
  },
@@ -779,7 +891,8 @@
779
891
  "type": "array",
780
892
  "items": {
781
893
  "type": "string",
782
- "maxLength": 255
894
+ "maxLength": 48,
895
+ "minLength": 1
783
896
  },
784
897
  "maxItems": 100
785
898
  },
@@ -890,7 +1003,8 @@
890
1003
  "type": "array",
891
1004
  "items": {
892
1005
  "type": "string",
893
- "maxLength": 255
1006
+ "maxLength": 48,
1007
+ "minLength": 1
894
1008
  },
895
1009
  "maxItems": 100
896
1010
  },
@@ -991,7 +1105,8 @@
991
1105
  "type": "array",
992
1106
  "items": {
993
1107
  "type": "string",
994
- "maxLength": 255
1108
+ "maxLength": 48,
1109
+ "minLength": 1
995
1110
  },
996
1111
  "maxItems": 100
997
1112
  },
@@ -1094,7 +1209,8 @@
1094
1209
  "type": "array",
1095
1210
  "items": {
1096
1211
  "type": "string",
1097
- "maxLength": 255
1212
+ "maxLength": 48,
1213
+ "minLength": 1
1098
1214
  },
1099
1215
  "maxItems": 100
1100
1216
  },
@@ -1234,7 +1350,8 @@
1234
1350
  "type": "array",
1235
1351
  "items": {
1236
1352
  "type": "string",
1237
- "maxLength": 255
1353
+ "maxLength": 48,
1354
+ "minLength": 1
1238
1355
  },
1239
1356
  "maxItems": 100
1240
1357
  },
@@ -1357,8 +1474,122 @@
1357
1474
  "type": "array",
1358
1475
  "items": {
1359
1476
  "type": "string",
1477
+ "maxLength": 48,
1478
+ "minLength": 1
1479
+ },
1480
+ "maxItems": 100
1481
+ },
1482
+ "maxItems": 100
1483
+ }
1484
+ },
1485
+ "required": [
1486
+ "type"
1487
+ ],
1488
+ "additionalProperties": false
1489
+ },
1490
+ {
1491
+ "type": "object",
1492
+ "properties": {
1493
+ "key": {
1494
+ "type": "string",
1495
+ "maxLength": 1024
1496
+ },
1497
+ "type": {
1498
+ "type": "string",
1499
+ "enum": [
1500
+ "request"
1501
+ ]
1502
+ },
1503
+ "config": {
1504
+ "type": "object",
1505
+ "properties": {
1506
+ "method": {
1507
+ "type": "string",
1508
+ "enum": [
1509
+ "*",
1510
+ "delete",
1511
+ "get",
1512
+ "options",
1513
+ "patch",
1514
+ "post",
1515
+ "put"
1516
+ ]
1517
+ },
1518
+ "route": {
1519
+ "type": "string",
1520
+ "maxLength": 1024
1521
+ }
1522
+ },
1523
+ "additionalProperties": false
1524
+ },
1525
+ "meta": {
1526
+ "type": "object",
1527
+ "properties": {
1528
+ "category": {
1529
+ "type": "string",
1530
+ "enum": [
1531
+ "trigger"
1532
+ ]
1533
+ },
1534
+ "name": {
1535
+ "type": "string",
1536
+ "enum": [
1537
+ "request"
1538
+ ]
1539
+ },
1540
+ "label": {
1541
+ "type": "string",
1542
+ "minLength": 1,
1360
1543
  "maxLength": 255
1361
1544
  },
1545
+ "x": {
1546
+ "type": "number"
1547
+ },
1548
+ "y": {
1549
+ "type": "number"
1550
+ },
1551
+ "uiId": {
1552
+ "type": "string",
1553
+ "maxLength": 48
1554
+ },
1555
+ "description": {
1556
+ "type": "string",
1557
+ "maxLength": 32767
1558
+ },
1559
+ "icon": {
1560
+ "type": "string",
1561
+ "maxLength": 1024
1562
+ },
1563
+ "color": {
1564
+ "type": "string",
1565
+ "maxLength": 1024
1566
+ },
1567
+ "inputCount": {
1568
+ "type": "number"
1569
+ },
1570
+ "outputCount": {
1571
+ "type": "number"
1572
+ },
1573
+ "triggerId": {
1574
+ "type": "string",
1575
+ "maxLength": 48
1576
+ },
1577
+ "id": {
1578
+ "type": "string",
1579
+ "maxLength": 48
1580
+ }
1581
+ },
1582
+ "additionalProperties": false
1583
+ },
1584
+ "outputIds": {
1585
+ "type": "array",
1586
+ "items": {
1587
+ "type": "array",
1588
+ "items": {
1589
+ "type": "string",
1590
+ "maxLength": 48,
1591
+ "minLength": 1
1592
+ },
1362
1593
  "maxItems": 100
1363
1594
  },
1364
1595
  "maxItems": 100
@@ -1500,7 +1731,8 @@
1500
1731
  "type": "array",
1501
1732
  "items": {
1502
1733
  "type": "string",
1503
- "maxLength": 255
1734
+ "maxLength": 48,
1735
+ "minLength": 1
1504
1736
  },
1505
1737
  "maxItems": 100
1506
1738
  },
@@ -1626,7 +1858,8 @@
1626
1858
  "type": "array",
1627
1859
  "items": {
1628
1860
  "type": "string",
1629
- "maxLength": 255
1861
+ "maxLength": 48,
1862
+ "minLength": 1
1630
1863
  },
1631
1864
  "maxItems": 100
1632
1865
  },
@@ -1741,7 +1974,8 @@
1741
1974
  "type": "array",
1742
1975
  "items": {
1743
1976
  "type": "string",
1744
- "maxLength": 255
1977
+ "maxLength": 48,
1978
+ "minLength": 1
1745
1979
  },
1746
1980
  "maxItems": 100
1747
1981
  },
@@ -1782,7 +2016,8 @@
1782
2016
  "type": "array",
1783
2017
  "items": {
1784
2018
  "type": "string",
1785
- "maxLength": 255
2019
+ "maxLength": 48,
2020
+ "minLength": 1
1786
2021
  },
1787
2022
  "maxItems": 100
1788
2023
  },
@@ -1823,6 +2058,7 @@
1823
2058
  "enum": [
1824
2059
  "cloud",
1825
2060
  "edge",
2061
+ "embedded",
1826
2062
  "experience",
1827
2063
  "customNode"
1828
2064
  ]