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/flowStorageMetadata.json ADDED
@@ -0,0 +1,13 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "memoryUsed": {
6
+ "type": "number"
7
+ },
8
+ "keysCount": {
9
+ "type": "number"
10
+ }
11
+ },
12
+ "additionalProperties": false
13
+ }
data/schemas/flowVersion.json CHANGED
@@ -66,7 +66,6 @@
66
66
  "onBoot",
67
67
  "onConnect",
68
68
  "onDisconnect",
69
- "request",
70
69
  "udp",
71
70
  "webhook"
72
71
  ]
@@ -100,7 +99,6 @@
100
99
  "onConnect",
101
100
  "onDisconnect",
102
101
  "particle",
103
- "request",
104
102
  "udp",
105
103
  "webhook"
106
104
  ]
@@ -306,6 +304,21 @@
306
304
  },
307
305
  "maxAge": {
308
306
  "type": "number"
307
+ },
308
+ "triggerOn": {
309
+ "type": "string",
310
+ "enum": [
311
+ "batch",
312
+ "individual",
313
+ "both"
314
+ ]
315
+ },
316
+ "batchBehavior": {
317
+ "type": "string",
318
+ "enum": [
319
+ "once",
320
+ "each"
321
+ ]
309
322
  }
310
323
  },
311
324
  "additionalProperties": false
@@ -1384,6 +1397,118 @@
1384
1397
  ],
1385
1398
  "additionalProperties": false
1386
1399
  },
1400
+ {
1401
+ "type": "object",
1402
+ "properties": {
1403
+ "key": {
1404
+ "type": "string",
1405
+ "maxLength": 1024
1406
+ },
1407
+ "type": {
1408
+ "type": "string",
1409
+ "enum": [
1410
+ "request"
1411
+ ]
1412
+ },
1413
+ "config": {
1414
+ "type": "object",
1415
+ "properties": {
1416
+ "method": {
1417
+ "type": "string",
1418
+ "enum": [
1419
+ "*",
1420
+ "delete",
1421
+ "get",
1422
+ "options",
1423
+ "patch",
1424
+ "post",
1425
+ "put"
1426
+ ]
1427
+ },
1428
+ "route": {
1429
+ "type": "string",
1430
+ "maxLength": 1024
1431
+ }
1432
+ },
1433
+ "additionalProperties": false
1434
+ },
1435
+ "meta": {
1436
+ "type": "object",
1437
+ "properties": {
1438
+ "category": {
1439
+ "type": "string",
1440
+ "enum": [
1441
+ "trigger"
1442
+ ]
1443
+ },
1444
+ "name": {
1445
+ "type": "string",
1446
+ "enum": [
1447
+ "request"
1448
+ ]
1449
+ },
1450
+ "label": {
1451
+ "type": "string",
1452
+ "minLength": 1,
1453
+ "maxLength": 255
1454
+ },
1455
+ "x": {
1456
+ "type": "number"
1457
+ },
1458
+ "y": {
1459
+ "type": "number"
1460
+ },
1461
+ "uiId": {
1462
+ "type": "string",
1463
+ "maxLength": 48
1464
+ },
1465
+ "description": {
1466
+ "type": "string",
1467
+ "maxLength": 32767
1468
+ },
1469
+ "icon": {
1470
+ "type": "string",
1471
+ "maxLength": 1024
1472
+ },
1473
+ "color": {
1474
+ "type": "string",
1475
+ "maxLength": 1024
1476
+ },
1477
+ "inputCount": {
1478
+ "type": "number"
1479
+ },
1480
+ "outputCount": {
1481
+ "type": "number"
1482
+ },
1483
+ "triggerId": {
1484
+ "type": "string",
1485
+ "maxLength": 48
1486
+ },
1487
+ "id": {
1488
+ "type": "string",
1489
+ "maxLength": 48
1490
+ }
1491
+ },
1492
+ "additionalProperties": false
1493
+ },
1494
+ "outputIds": {
1495
+ "type": "array",
1496
+ "items": {
1497
+ "type": "array",
1498
+ "items": {
1499
+ "type": "string",
1500
+ "maxLength": 255
1501
+ },
1502
+ "maxItems": 100
1503
+ },
1504
+ "maxItems": 100
1505
+ }
1506
+ },
1507
+ "required": [
1508
+ "type"
1509
+ ],
1510
+ "additionalProperties": false
1511
+ },
1387
1512
  {
1388
1513
  "type": "object",
1389
1514
  "properties": {
@@ -2264,7 +2389,6 @@
2264
2389
  "onBoot",
2265
2390
  "onConnect",
2266
2391
  "onDisconnect",
2267
- "request",
2268
2392
  "udp",
2269
2393
  "webhook"
2270
2394
  ]
@@ -2298,7 +2422,6 @@
2298
2422
  "onConnect",
2299
2423
  "onDisconnect",
2300
2424
  "particle",
2301
- "request",
2302
2425
  "udp",
2303
2426
  "webhook"
2304
2427
  ]
@@ -2504,6 +2627,21 @@
2504
2627
  },
2505
2628
  "maxAge": {
2506
2629
  "type": "number"
2630
+ },
2631
+ "triggerOn": {
2632
+ "type": "string",
2633
+ "enum": [
2634
+ "batch",
2635
+ "individual",
2636
+ "both"
2637
+ ]
2638
+ },
2639
+ "batchBehavior": {
2640
+ "type": "string",
2641
+ "enum": [
2642
+ "once",
2643
+ "each"
2644
+ ]
2507
2645
  }
2508
2646
  },
2509
2647
  "additionalProperties": false
@@ -3582,6 +3720,118 @@
3582
3720
  ],
3583
3721
  "additionalProperties": false
3584
3722
  },
3723
+ {
3724
+ "type": "object",
3725
+ "properties": {
3726
+ "key": {
3727
+ "type": "string",
3728
+ "maxLength": 1024
3729
+ },
3730
+ "type": {
3731
+ "type": "string",
3732
+ "enum": [
3733
+ "request"
3734
+ ]
3735
+ },
3736
+ "config": {
3737
+ "type": "object",
3738
+ "properties": {
3739
+ "method": {
3740
+ "type": "string",
3741
+ "enum": [
3742
+ "*",
3743
+ "delete",
3744
+ "get",
3745
+ "options",
3746
+ "patch",
3747
+ "post",
3748
+ "put"
3749
+ ]
3750
+ },
3751
+ "route": {
3752
+ "type": "string",
3753
+ "maxLength": 1024
3754
+ }
3755
+ },
3756
+ "additionalProperties": false
3757
+ },
3758
+ "meta": {
3759
+ "type": "object",
3760
+ "properties": {
3761
+ "category": {
3762
+ "type": "string",
3763
+ "enum": [
3764
+ "trigger"
3765
+ ]
3766
+ },
3767
+ "name": {
3768
+ "type": "string",
3769
+ "enum": [
3770
+ "request"
3771
+ ]
3772
+ },
3773
+ "label": {
3774
+ "type": "string",
3775
+ "minLength": 1,
3776
+ "maxLength": 255
3777
+ },
3778
+ "x": {
3779
+ "type": "number"
3780
+ },
3781
+ "y": {
3782
+ "type": "number"
3783
+ },
3784
+ "uiId": {
3785
+ "type": "string",
3786
+ "maxLength": 48
3787
+ },
3788
+ "description": {
3789
+ "type": "string",
3790
+ "maxLength": 32767
3791
+ },
3792
+ "icon": {
3793
+ "type": "string",
3794
+ "maxLength": 1024
3795
+ },
3796
+ "color": {
3797
+ "type": "string",
3798
+ "maxLength": 1024
3799
+ },
3800
+ "inputCount": {
3801
+ "type": "number"
3802
+ },
3803
+ "outputCount": {
3804
+ "type": "number"
3805
+ },
3806
+ "triggerId": {
3807
+ "type": "string",
3808
+ "maxLength": 48
3809
+ },
3810
+ "id": {
3811
+ "type": "string",
3812
+ "maxLength": 48
3813
+ }
3814
+ },
3815
+ "additionalProperties": false
3816
+ },
3817
+ "outputIds": {
3818
+ "type": "array",
3819
+ "items": {
3820
+ "type": "array",
3821
+ "items": {
3822
+ "type": "string",
3823
+ "maxLength": 255
3824
+ },
3825
+ "maxItems": 100
3826
+ },
3827
+ "maxItems": 100
3828
+ }
3829
+ },
3830
+ "required": [
3831
+ "type"
3832
+ ],
3833
+ "additionalProperties": false
3834
+ },
3585
3835
  {
3586
3836
  "type": "object",
3587
3837
  "properties": {
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
  ]
@@ -73,7 +72,6 @@
73
72
  "onConnect",
74
73
  "onDisconnect",
75
74
  "particle",
76
- "request",
77
75
  "udp",
78
76
  "webhook"
79
77
  ]
@@ -279,6 +277,21 @@
279
277
  },
280
278
  "maxAge": {
281
279
  "type": "number"
280
+ },
281
+ "triggerOn": {
282
+ "type": "string",
283
+ "enum": [
284
+ "batch",
285
+ "individual",
286
+ "both"
287
+ ]
288
+ },
289
+ "batchBehavior": {
290
+ "type": "string",
291
+ "enum": [
292
+ "once",
293
+ "each"
294
+ ]
282
295
  }
283
296
  },
284
297
  "additionalProperties": false
@@ -1357,6 +1370,118 @@
1357
1370
  ],
1358
1371
  "additionalProperties": false
1359
1372
  },
1373
+ {
1374
+ "type": "object",
1375
+ "properties": {
1376
+ "key": {
1377
+ "type": "string",
1378
+ "maxLength": 1024
1379
+ },
1380
+ "type": {
1381
+ "type": "string",
1382
+ "enum": [
1383
+ "request"
1384
+ ]
1385
+ },
1386
+ "config": {
1387
+ "type": "object",
1388
+ "properties": {
1389
+ "method": {
1390
+ "type": "string",
1391
+ "enum": [
1392
+ "*",
1393
+ "delete",
1394
+ "get",
1395
+ "options",
1396
+ "patch",
1397
+ "post",
1398
+ "put"
1399
+ ]
1400
+ },
1401
+ "route": {
1402
+ "type": "string",
1403
+ "maxLength": 1024
1404
+ }
1405
+ },
1406
+ "additionalProperties": false
1407
+ },
1408
+ "meta": {
1409
+ "type": "object",
1410
+ "properties": {
1411
+ "category": {
1412
+ "type": "string",
1413
+ "enum": [
1414
+ "trigger"
1415
+ ]
1416
+ },
1417
+ "name": {
1418
+ "type": "string",
1419
+ "enum": [
1420
+ "request"
1421
+ ]
1422
+ },
1423
+ "label": {
1424
+ "type": "string",
1425
+ "minLength": 1,
1426
+ "maxLength": 255
1427
+ },
1428
+ "x": {
1429
+ "type": "number"
1430
+ },
1431
+ "y": {
1432
+ "type": "number"
1433
+ },
1434
+ "uiId": {
1435
+ "type": "string",
1436
+ "maxLength": 48
1437
+ },
1438
+ "description": {
1439
+ "type": "string",
1440
+ "maxLength": 32767
1441
+ },
1442
+ "icon": {
1443
+ "type": "string",
1444
+ "maxLength": 1024
1445
+ },
1446
+ "color": {
1447
+ "type": "string",
1448
+ "maxLength": 1024
1449
+ },
1450
+ "inputCount": {
1451
+ "type": "number"
1452
+ },
1453
+ "outputCount": {
1454
+ "type": "number"
1455
+ },
1456
+ "triggerId": {
1457
+ "type": "string",
1458
+ "maxLength": 48
1459
+ },
1460
+ "id": {
1461
+ "type": "string",
1462
+ "maxLength": 48
1463
+ }
1464
+ },
1465
+ "additionalProperties": false
1466
+ },
1467
+ "outputIds": {
1468
+ "type": "array",
1469
+ "items": {
1470
+ "type": "array",
1471
+ "items": {
1472
+ "type": "string",
1473
+ "maxLength": 255
1474
+ },
1475
+ "maxItems": 100
1476
+ },
1477
+ "maxItems": 100
1478
+ }
1479
+ },
1480
+ "required": [
1481
+ "type"
1482
+ ],
1483
+ "additionalProperties": false
1484
+ },
1360
1485
  {
1361
1486
  "type": "object",
1362
1487
  "properties": {