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/flowsImportResult.json CHANGED
@@ -89,7 +89,6 @@
89
89
  "onBoot",
90
90
  "onConnect",
91
91
  "onDisconnect",
92
- "request",
93
92
  "udp",
94
93
  "webhook"
95
94
  ]
@@ -123,7 +122,6 @@
123
122
  "onConnect",
124
123
  "onDisconnect",
125
124
  "particle",
126
- "request",
127
125
  "udp",
128
126
  "webhook"
129
127
  ]
@@ -329,6 +327,21 @@
329
327
  },
330
328
  "maxAge": {
331
329
  "type": "number"
330
+ },
331
+ "triggerOn": {
332
+ "type": "string",
333
+ "enum": [
334
+ "batch",
335
+ "individual",
336
+ "both"
337
+ ]
338
+ },
339
+ "batchBehavior": {
340
+ "type": "string",
341
+ "enum": [
342
+ "once",
343
+ "each"
344
+ ]
332
345
  }
333
346
  },
334
347
  "additionalProperties": false
@@ -1407,6 +1420,118 @@
1407
1420
  ],
1408
1421
  "additionalProperties": false
1409
1422
  },
1423
+ {
1424
+ "type": "object",
1425
+ "properties": {
1426
+ "key": {
1427
+ "type": "string",
1428
+ "maxLength": 1024
1429
+ },
1430
+ "type": {
1431
+ "type": "string",
1432
+ "enum": [
1433
+ "request"
1434
+ ]
1435
+ },
1436
+ "config": {
1437
+ "type": "object",
1438
+ "properties": {
1439
+ "method": {
1440
+ "type": "string",
1441
+ "enum": [
1442
+ "*",
1443
+ "delete",
1444
+ "get",
1445
+ "options",
1446
+ "patch",
1447
+ "post",
1448
+ "put"
1449
+ ]
1450
+ },
1451
+ "route": {
1452
+ "type": "string",
1453
+ "maxLength": 1024
1454
+ }
1455
+ },
1456
+ "additionalProperties": false
1457
+ },
1458
+ "meta": {
1459
+ "type": "object",
1460
+ "properties": {
1461
+ "category": {
1462
+ "type": "string",
1463
+ "enum": [
1464
+ "trigger"
1465
+ ]
1466
+ },
1467
+ "name": {
1468
+ "type": "string",
1469
+ "enum": [
1470
+ "request"
1471
+ ]
1472
+ },
1473
+ "label": {
1474
+ "type": "string",
1475
+ "minLength": 1,
1476
+ "maxLength": 255
1477
+ },
1478
+ "x": {
1479
+ "type": "number"
1480
+ },
1481
+ "y": {
1482
+ "type": "number"
1483
+ },
1484
+ "uiId": {
1485
+ "type": "string",
1486
+ "maxLength": 48
1487
+ },
1488
+ "description": {
1489
+ "type": "string",
1490
+ "maxLength": 32767
1491
+ },
1492
+ "icon": {
1493
+ "type": "string",
1494
+ "maxLength": 1024
1495
+ },
1496
+ "color": {
1497
+ "type": "string",
1498
+ "maxLength": 1024
1499
+ },
1500
+ "inputCount": {
1501
+ "type": "number"
1502
+ },
1503
+ "outputCount": {
1504
+ "type": "number"
1505
+ },
1506
+ "triggerId": {
1507
+ "type": "string",
1508
+ "maxLength": 48
1509
+ },
1510
+ "id": {
1511
+ "type": "string",
1512
+ "maxLength": 48
1513
+ }
1514
+ },
1515
+ "additionalProperties": false
1516
+ },
1517
+ "outputIds": {
1518
+ "type": "array",
1519
+ "items": {
1520
+ "type": "array",
1521
+ "items": {
1522
+ "type": "string",
1523
+ "maxLength": 255
1524
+ },
1525
+ "maxItems": 100
1526
+ },
1527
+ "maxItems": 100
1528
+ }
1529
+ },
1530
+ "required": [
1531
+ "type"
1532
+ ],
1533
+ "additionalProperties": false
1534
+ },
1410
1535
  {
1411
1536
  "type": "object",
1412
1537
  "properties": {
@@ -2287,7 +2412,6 @@
2287
2412
  "onBoot",
2288
2413
  "onConnect",
2289
2414
  "onDisconnect",
2290
- "request",
2291
2415
  "udp",
2292
2416
  "webhook"
2293
2417
  ]
@@ -2321,7 +2445,6 @@
2321
2445
  "onConnect",
2322
2446
  "onDisconnect",
2323
2447
  "particle",
2324
- "request",
2325
2448
  "udp",
2326
2449
  "webhook"
2327
2450
  ]
@@ -2527,6 +2650,21 @@
2527
2650
  },
2528
2651
  "maxAge": {
2529
2652
  "type": "number"
2653
+ },
2654
+ "triggerOn": {
2655
+ "type": "string",
2656
+ "enum": [
2657
+ "batch",
2658
+ "individual",
2659
+ "both"
2660
+ ]
2661
+ },
2662
+ "batchBehavior": {
2663
+ "type": "string",
2664
+ "enum": [
2665
+ "once",
2666
+ "each"
2667
+ ]
2530
2668
  }
2531
2669
  },
2532
2670
  "additionalProperties": false
@@ -3605,6 +3743,118 @@
3605
3743
  ],
3606
3744
  "additionalProperties": false
3607
3745
  },
3746
+ {
3747
+ "type": "object",
3748
+ "properties": {
3749
+ "key": {
3750
+ "type": "string",
3751
+ "maxLength": 1024
3752
+ },
3753
+ "type": {
3754
+ "type": "string",
3755
+ "enum": [
3756
+ "request"
3757
+ ]
3758
+ },
3759
+ "config": {
3760
+ "type": "object",
3761
+ "properties": {
3762
+ "method": {
3763
+ "type": "string",
3764
+ "enum": [
3765
+ "*",
3766
+ "delete",
3767
+ "get",
3768
+ "options",
3769
+ "patch",
3770
+ "post",
3771
+ "put"
3772
+ ]
3773
+ },
3774
+ "route": {
3775
+ "type": "string",
3776
+ "maxLength": 1024
3777
+ }
3778
+ },
3779
+ "additionalProperties": false
3780
+ },
3781
+ "meta": {
3782
+ "type": "object",
3783
+ "properties": {
3784
+ "category": {
3785
+ "type": "string",
3786
+ "enum": [
3787
+ "trigger"
3788
+ ]
3789
+ },
3790
+ "name": {
3791
+ "type": "string",
3792
+ "enum": [
3793
+ "request"
3794
+ ]
3795
+ },
3796
+ "label": {
3797
+ "type": "string",
3798
+ "minLength": 1,
3799
+ "maxLength": 255
3800
+ },
3801
+ "x": {
3802
+ "type": "number"
3803
+ },
3804
+ "y": {
3805
+ "type": "number"
3806
+ },
3807
+ "uiId": {
3808
+ "type": "string",
3809
+ "maxLength": 48
3810
+ },
3811
+ "description": {
3812
+ "type": "string",
3813
+ "maxLength": 32767
3814
+ },
3815
+ "icon": {
3816
+ "type": "string",
3817
+ "maxLength": 1024
3818
+ },
3819
+ "color": {
3820
+ "type": "string",
3821
+ "maxLength": 1024
3822
+ },
3823
+ "inputCount": {
3824
+ "type": "number"
3825
+ },
3826
+ "outputCount": {
3827
+ "type": "number"
3828
+ },
3829
+ "triggerId": {
3830
+ "type": "string",
3831
+ "maxLength": 48
3832
+ },
3833
+ "id": {
3834
+ "type": "string",
3835
+ "maxLength": 48
3836
+ }
3837
+ },
3838
+ "additionalProperties": false
3839
+ },
3840
+ "outputIds": {
3841
+ "type": "array",
3842
+ "items": {
3843
+ "type": "array",
3844
+ "items": {
3845
+ "type": "string",
3846
+ "maxLength": 255
3847
+ },
3848
+ "maxItems": 100
3849
+ },
3850
+ "maxItems": 100
3851
+ }
3852
+ },
3853
+ "required": [
3854
+ "type"
3855
+ ],
3856
+ "additionalProperties": false
3857
+ },
3608
3858
  {
3609
3859
  "type": "object",
3610
3860
  "properties": {
@@ -4485,7 +4735,6 @@
4485
4735
  "onBoot",
4486
4736
  "onConnect",
4487
4737
  "onDisconnect",
4488
- "request",
4489
4738
  "udp",
4490
4739
  "webhook"
4491
4740
  ]
@@ -4519,7 +4768,6 @@
4519
4768
  "onConnect",
4520
4769
  "onDisconnect",
4521
4770
  "particle",
4522
- "request",
4523
4771
  "udp",
4524
4772
  "webhook"
4525
4773
  ]
@@ -4725,6 +4973,21 @@
4725
4973
  },
4726
4974
  "maxAge": {
4727
4975
  "type": "number"
4976
+ },
4977
+ "triggerOn": {
4978
+ "type": "string",
4979
+ "enum": [
4980
+ "batch",
4981
+ "individual",
4982
+ "both"
4983
+ ]
4984
+ },
4985
+ "batchBehavior": {
4986
+ "type": "string",
4987
+ "enum": [
4988
+ "once",
4989
+ "each"
4990
+ ]
4728
4991
  }
4729
4992
  },
4730
4993
  "additionalProperties": false
@@ -5803,6 +6066,118 @@
5803
6066
  ],
5804
6067
  "additionalProperties": false
5805
6068
  },
6069
+ {
6070
+ "type": "object",
6071
+ "properties": {
6072
+ "key": {
6073
+ "type": "string",
6074
+ "maxLength": 1024
6075
+ },
6076
+ "type": {
6077
+ "type": "string",
6078
+ "enum": [
6079
+ "request"
6080
+ ]
6081
+ },
6082
+ "config": {
6083
+ "type": "object",
6084
+ "properties": {
6085
+ "method": {
6086
+ "type": "string",
6087
+ "enum": [
6088
+ "*",
6089
+ "delete",
6090
+ "get",
6091
+ "options",
6092
+ "patch",
6093
+ "post",
6094
+ "put"
6095
+ ]
6096
+ },
6097
+ "route": {
6098
+ "type": "string",
6099
+ "maxLength": 1024
6100
+ }
6101
+ },
6102
+ "additionalProperties": false
6103
+ },
6104
+ "meta": {
6105
+ "type": "object",
6106
+ "properties": {
6107
+ "category": {
6108
+ "type": "string",
6109
+ "enum": [
6110
+ "trigger"
6111
+ ]
6112
+ },
6113
+ "name": {
6114
+ "type": "string",
6115
+ "enum": [
6116
+ "request"
6117
+ ]
6118
+ },
6119
+ "label": {
6120
+ "type": "string",
6121
+ "minLength": 1,
6122
+ "maxLength": 255
6123
+ },
6124
+ "x": {
6125
+ "type": "number"
6126
+ },
6127
+ "y": {
6128
+ "type": "number"
6129
+ },
6130
+ "uiId": {
6131
+ "type": "string",
6132
+ "maxLength": 48
6133
+ },
6134
+ "description": {
6135
+ "type": "string",
6136
+ "maxLength": 32767
6137
+ },
6138
+ "icon": {
6139
+ "type": "string",
6140
+ "maxLength": 1024
6141
+ },
6142
+ "color": {
6143
+ "type": "string",
6144
+ "maxLength": 1024
6145
+ },
6146
+ "inputCount": {
6147
+ "type": "number"
6148
+ },
6149
+ "outputCount": {
6150
+ "type": "number"
6151
+ },
6152
+ "triggerId": {
6153
+ "type": "string",
6154
+ "maxLength": 48
6155
+ },
6156
+ "id": {
6157
+ "type": "string",
6158
+ "maxLength": 48
6159
+ }
6160
+ },
6161
+ "additionalProperties": false
6162
+ },
6163
+ "outputIds": {
6164
+ "type": "array",
6165
+ "items": {
6166
+ "type": "array",
6167
+ "items": {
6168
+ "type": "string",
6169
+ "maxLength": 255
6170
+ },
6171
+ "maxItems": 100
6172
+ },
6173
+ "maxItems": 100
6174
+ }
6175
+ },
6176
+ "required": [
6177
+ "type"
6178
+ ],
6179
+ "additionalProperties": false
6180
+ },
5806
6181
  {
5807
6182
  "type": "object",
5808
6183
  "properties": {