losant_rest 1.10.4 → 1.13.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (224) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +2 -2
  4. data/docs/_schemas.md +35272 -19039
  5. data/docs/application.md +45 -4
  6. data/docs/applicationApiTokens.md +2 -2
  7. data/docs/applicationCertificateAuthorities.md +1 -1
  8. data/docs/applicationCertificates.md +1 -1
  9. data/docs/applicationDashboard.md +133 -0
  10. data/docs/applicationDashboards.md +93 -0
  11. data/docs/applicationKeys.md +4 -3
  12. data/docs/applicationTemplates.md +1 -1
  13. data/docs/applications.md +2 -2
  14. data/docs/auditLogs.md +1 -1
  15. data/docs/dashboards.md +1 -1
  16. data/docs/dataTable.md +1 -1
  17. data/docs/dataTableRows.md +1 -1
  18. data/docs/dataTables.md +2 -2
  19. data/docs/deviceRecipes.md +1 -1
  20. data/docs/devices.md +127 -3
  21. data/docs/edgeDeployments.md +1 -1
  22. data/docs/events.md +4 -4
  23. data/docs/experience.md +1 -1
  24. data/docs/experienceDomains.md +1 -1
  25. data/docs/experienceEndpoint.md +1 -0
  26. data/docs/experienceGroup.md +2 -0
  27. data/docs/experienceGroups.md +1 -1
  28. data/docs/experienceSlugs.md +1 -1
  29. data/docs/experienceUsers.md +1 -1
  30. data/docs/experienceVersion.md +3 -3
  31. data/docs/experienceVersions.md +3 -3
  32. data/docs/experienceView.md +4 -4
  33. data/docs/experienceViews.md +3 -3
  34. data/docs/file.md +5 -5
  35. data/docs/files.md +3 -3
  36. data/docs/flow.md +41 -0
  37. data/docs/flowVersions.md +46 -1
  38. data/docs/flows.md +5 -2
  39. data/docs/instance.md +166 -0
  40. data/docs/instanceApiToken.md +133 -0
  41. data/docs/instanceApiTokens.md +91 -0
  42. data/docs/instanceMember.md +133 -0
  43. data/docs/instanceMembers.md +91 -0
  44. data/docs/instanceOrg.md +133 -0
  45. data/docs/instanceOrgMember.md +139 -0
  46. data/docs/instanceOrgMembers.md +96 -0
  47. data/docs/instanceOrgs.md +91 -0
  48. data/docs/instances.md +50 -0
  49. data/docs/integration.md +1 -0
  50. data/docs/integrations.md +1 -1
  51. data/docs/notebooks.md +1 -1
  52. data/docs/orgs.md +1 -1
  53. data/docs/userApiToken.md +125 -0
  54. data/docs/userApiTokens.md +87 -0
  55. data/docs/webhook.md +1 -0
  56. data/docs/webhooks.md +1 -1
  57. data/lib/losant_rest.rb +15 -1
  58. data/lib/losant_rest/application.rb +53 -6
  59. data/lib/losant_rest/application_api_token.rb +1 -1
  60. data/lib/losant_rest/application_api_tokens.rb +2 -2
  61. data/lib/losant_rest/application_certificate.rb +1 -1
  62. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  63. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  64. data/lib/losant_rest/application_certificates.rb +1 -1
  65. data/lib/losant_rest/application_dashboard.rb +176 -0
  66. data/lib/losant_rest/application_dashboards.rb +138 -0
  67. data/lib/losant_rest/application_key.rb +1 -1
  68. data/lib/losant_rest/application_keys.rb +4 -1
  69. data/lib/losant_rest/application_template.rb +1 -1
  70. data/lib/losant_rest/application_templates.rb +1 -1
  71. data/lib/losant_rest/applications.rb +2 -2
  72. data/lib/losant_rest/audit_log.rb +1 -1
  73. data/lib/losant_rest/audit_logs.rb +1 -1
  74. data/lib/losant_rest/auth.rb +1 -1
  75. data/lib/losant_rest/client.rb +59 -3
  76. data/lib/losant_rest/dashboard.rb +1 -1
  77. data/lib/losant_rest/dashboards.rb +1 -1
  78. data/lib/losant_rest/data.rb +1 -1
  79. data/lib/losant_rest/data_table.rb +2 -2
  80. data/lib/losant_rest/data_table_row.rb +1 -1
  81. data/lib/losant_rest/data_table_rows.rb +2 -2
  82. data/lib/losant_rest/data_tables.rb +2 -2
  83. data/lib/losant_rest/device.rb +1 -1
  84. data/lib/losant_rest/device_recipe.rb +1 -1
  85. data/lib/losant_rest/device_recipes.rb +1 -1
  86. data/lib/losant_rest/devices.rb +155 -3
  87. data/lib/losant_rest/edge_deployments.rb +1 -1
  88. data/lib/losant_rest/error.rb +1 -1
  89. data/lib/losant_rest/event.rb +1 -1
  90. data/lib/losant_rest/events.rb +4 -4
  91. data/lib/losant_rest/experience.rb +2 -2
  92. data/lib/losant_rest/experience_domain.rb +1 -1
  93. data/lib/losant_rest/experience_domains.rb +2 -2
  94. data/lib/losant_rest/experience_endpoint.rb +3 -1
  95. data/lib/losant_rest/experience_endpoints.rb +1 -1
  96. data/lib/losant_rest/experience_group.rb +5 -1
  97. data/lib/losant_rest/experience_groups.rb +1 -1
  98. data/lib/losant_rest/experience_slug.rb +1 -1
  99. data/lib/losant_rest/experience_slugs.rb +2 -2
  100. data/lib/losant_rest/experience_user.rb +1 -1
  101. data/lib/losant_rest/experience_users.rb +1 -1
  102. data/lib/losant_rest/experience_version.rb +4 -4
  103. data/lib/losant_rest/experience_versions.rb +3 -3
  104. data/lib/losant_rest/experience_view.rb +5 -5
  105. data/lib/losant_rest/experience_views.rb +3 -3
  106. data/lib/losant_rest/file.rb +5 -5
  107. data/lib/losant_rest/files.rb +3 -3
  108. data/lib/losant_rest/flow.rb +47 -1
  109. data/lib/losant_rest/flow_version.rb +1 -1
  110. data/lib/losant_rest/flow_versions.rb +54 -1
  111. data/lib/losant_rest/flows.rb +9 -1
  112. data/lib/losant_rest/instance.rb +226 -0
  113. data/lib/losant_rest/instance_api_token.rb +176 -0
  114. data/lib/losant_rest/instance_api_tokens.rb +136 -0
  115. data/lib/losant_rest/instance_member.rb +176 -0
  116. data/lib/losant_rest/instance_members.rb +134 -0
  117. data/lib/losant_rest/instance_org.rb +176 -0
  118. data/lib/losant_rest/instance_org_member.rb +182 -0
  119. data/lib/losant_rest/instance_org_members.rb +138 -0
  120. data/lib/losant_rest/instance_orgs.rb +139 -0
  121. data/lib/losant_rest/instances.rb +88 -0
  122. data/lib/losant_rest/integration.rb +3 -1
  123. data/lib/losant_rest/integrations.rb +1 -1
  124. data/lib/losant_rest/me.rb +2 -2
  125. data/lib/losant_rest/notebook.rb +1 -1
  126. data/lib/losant_rest/notebooks.rb +1 -1
  127. data/lib/losant_rest/org.rb +2 -2
  128. data/lib/losant_rest/org_invites.rb +1 -1
  129. data/lib/losant_rest/orgs.rb +1 -1
  130. data/lib/losant_rest/user_api_token.rb +170 -0
  131. data/lib/losant_rest/user_api_tokens.rb +132 -0
  132. data/lib/losant_rest/utils.rb +1 -1
  133. data/lib/losant_rest/version.rb +2 -2
  134. data/lib/losant_rest/webhook.rb +3 -1
  135. data/lib/losant_rest/webhooks.rb +1 -1
  136. data/schemas/advancedApplicationKeyQuery.json +1082 -0
  137. data/schemas/advancedDeviceQuery.json +309 -0
  138. data/schemas/advancedFlowByVersionQuery.json +665 -0
  139. data/schemas/advancedFlowQuery.json +883 -0
  140. data/schemas/advancedFlowVersionQuery.json +925 -0
  141. data/schemas/apiToken.json +2 -1
  142. data/schemas/apiTokenPost.json +420 -0
  143. data/schemas/apiTokens.json +4 -2
  144. data/schemas/applicationApiTokenPost.json +11 -0
  145. data/schemas/applicationDashboardPost.json +5687 -0
  146. data/schemas/applicationGlobalPatch.json +33 -0
  147. data/schemas/attributeNamesResponse.json +14 -0
  148. data/schemas/auditLog.json +4 -0
  149. data/schemas/auditLogFilter.json +4 -0
  150. data/schemas/auditLogs.json +4 -0
  151. data/schemas/authedUser.json +3 -0
  152. data/schemas/bulkDeleteResponse.json +12 -0
  153. data/schemas/changePassword.json +1 -1
  154. data/schemas/dashboard.json +72 -17
  155. data/schemas/dashboardPatch.json +72 -17
  156. data/schemas/dashboardPost.json +72 -17
  157. data/schemas/dashboardSendReport.json +4 -0
  158. data/schemas/dashboards.json +72 -17
  159. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  160. data/schemas/deviceClassFilter.json +1 -2
  161. data/schemas/devicesDeletePost.json +309 -0
  162. data/schemas/devicesExportPost.json +309 -0
  163. data/schemas/devicesPatch.json +309 -0
  164. data/schemas/devicesRemoveDataPost.json +309 -0
  165. data/schemas/experienceGroup.json +6 -0
  166. data/schemas/experienceGroups.json +6 -0
  167. data/schemas/experienceLinkedResources.json +57 -0
  168. data/schemas/experienceVersion.json +9 -0
  169. data/schemas/experienceVersionPatch.json +9 -0
  170. data/schemas/experienceVersions.json +9 -0
  171. data/schemas/filePost.json +8 -2
  172. data/schemas/files.json +3 -0
  173. data/schemas/flow.json +19 -0
  174. data/schemas/flowPatch.json +19 -0
  175. data/schemas/flowPost.json +19 -0
  176. data/schemas/flowStorageMetadata.json +13 -0
  177. data/schemas/flowVersion.json +38 -0
  178. data/schemas/flowVersionPost.json +19 -0
  179. data/schemas/flowVersions.json +38 -0
  180. data/schemas/flowVersionsDeletePost.json +941 -0
  181. data/schemas/flows.json +19 -0
  182. data/schemas/flowsImportPost.json +38 -0
  183. data/schemas/flowsImportResult.json +57 -0
  184. data/schemas/githubLogin.json +64 -1
  185. data/schemas/historicalSummaries.json +43 -0
  186. data/schemas/historicalSummary.json +458 -0
  187. data/schemas/instance.json +192 -0
  188. data/schemas/instanceMember.json +37 -0
  189. data/schemas/instanceMemberPatch.json +17 -0
  190. data/schemas/instanceMemberPost.json +22 -0
  191. data/schemas/instanceMembers.json +69 -0
  192. data/schemas/instanceOrg.json +133 -0
  193. data/schemas/instanceOrgMember.json +37 -0
  194. data/schemas/instanceOrgMemberPatch.json +69 -0
  195. data/schemas/instanceOrgMemberPost.json +161 -0
  196. data/schemas/instanceOrgMembers.json +34 -0
  197. data/schemas/instanceOrgPatch.json +122 -0
  198. data/schemas/instanceOrgPost.json +291 -0
  199. data/schemas/instanceOrgs.json +174 -0
  200. data/schemas/instancePatch.json +67 -0
  201. data/schemas/instanceReportOptionsPost.json +41 -0
  202. data/schemas/instances.json +43 -0
  203. data/schemas/integration.json +3 -0
  204. data/schemas/integrationPatch.json +3 -0
  205. data/schemas/integrationPost.json +3 -0
  206. data/schemas/integrations.json +3 -0
  207. data/schemas/me.json +3 -0
  208. data/schemas/mePatch.json +1 -1
  209. data/schemas/multiDeviceCommand.json +309 -0
  210. data/schemas/notebook.json +22 -0
  211. data/schemas/notebookExecutionLogs.json +7 -0
  212. data/schemas/notebookPatch.json +7 -0
  213. data/schemas/notebookPost.json +7 -0
  214. data/schemas/notebooks.json +22 -0
  215. data/schemas/orgPatch.json +0 -9
  216. data/schemas/passwordResetFinish.json +1 -1
  217. data/schemas/payloadStats.json +110 -0
  218. data/schemas/tagKeysResponse.json +14 -0
  219. data/schemas/tagValuesResponse.json +19 -0
  220. data/schemas/userCredentials.json +64 -1
  221. data/schemas/userPost.json +65 -2
  222. data/schemas/validateContextError.json +34 -0
  223. data/schemas/validateContextSuccess.json +34 -0
  224. metadata +64 -3
data/schemas/flows.json CHANGED
@@ -954,6 +954,17 @@
954
954
  },
955
955
  "config": {
956
956
  "type": "object",
957
+ "properties": {
958
+ "scope": {
959
+ "type": "string",
960
+ "enum": [
961
+ "local",
962
+ "global",
963
+ "experience",
964
+ "cloud"
965
+ ]
966
+ }
967
+ },
957
968
  "additionalProperties": false
958
969
  },
959
970
  "meta": {
@@ -1439,6 +1450,10 @@
1439
1450
  "type": "string",
1440
1451
  "maxLength": 1024
1441
1452
  },
1453
+ "writeOnOpenEncoding": {
1454
+ "type": "string",
1455
+ "maxLength": 48
1456
+ },
1442
1457
  "byteLength": {
1443
1458
  "type": "string",
1444
1459
  "maxLength": 48
@@ -1446,6 +1461,10 @@
1446
1461
  "delimiter": {
1447
1462
  "type": "string",
1448
1463
  "maxLength": 48
1464
+ },
1465
+ "delimiterEncoding": {
1466
+ "type": "string",
1467
+ "maxLength": 48
1449
1468
  }
1450
1469
  },
1451
1470
  "additionalProperties": false
@@ -924,6 +924,17 @@
924
924
  },
925
925
  "config": {
926
926
  "type": "object",
927
+ "properties": {
928
+ "scope": {
929
+ "type": "string",
930
+ "enum": [
931
+ "local",
932
+ "global",
933
+ "experience",
934
+ "cloud"
935
+ ]
936
+ }
937
+ },
927
938
  "additionalProperties": false
928
939
  },
929
940
  "meta": {
@@ -1409,6 +1420,10 @@
1409
1420
  "type": "string",
1410
1421
  "maxLength": 1024
1411
1422
  },
1423
+ "writeOnOpenEncoding": {
1424
+ "type": "string",
1425
+ "maxLength": 48
1426
+ },
1412
1427
  "byteLength": {
1413
1428
  "type": "string",
1414
1429
  "maxLength": 48
@@ -1416,6 +1431,10 @@
1416
1431
  "delimiter": {
1417
1432
  "type": "string",
1418
1433
  "maxLength": 48
1434
+ },
1435
+ "delimiterEncoding": {
1436
+ "type": "string",
1437
+ "maxLength": 48
1419
1438
  }
1420
1439
  },
1421
1440
  "additionalProperties": false
@@ -3084,6 +3103,17 @@
3084
3103
  },
3085
3104
  "config": {
3086
3105
  "type": "object",
3106
+ "properties": {
3107
+ "scope": {
3108
+ "type": "string",
3109
+ "enum": [
3110
+ "local",
3111
+ "global",
3112
+ "experience",
3113
+ "cloud"
3114
+ ]
3115
+ }
3116
+ },
3087
3117
  "additionalProperties": false
3088
3118
  },
3089
3119
  "meta": {
@@ -3569,6 +3599,10 @@
3569
3599
  "type": "string",
3570
3600
  "maxLength": 1024
3571
3601
  },
3602
+ "writeOnOpenEncoding": {
3603
+ "type": "string",
3604
+ "maxLength": 48
3605
+ },
3572
3606
  "byteLength": {
3573
3607
  "type": "string",
3574
3608
  "maxLength": 48
@@ -3576,6 +3610,10 @@
3576
3610
  "delimiter": {
3577
3611
  "type": "string",
3578
3612
  "maxLength": 48
3613
+ },
3614
+ "delimiterEncoding": {
3615
+ "type": "string",
3616
+ "maxLength": 48
3579
3617
  }
3580
3618
  },
3581
3619
  "additionalProperties": false
@@ -955,6 +955,17 @@
955
955
  },
956
956
  "config": {
957
957
  "type": "object",
958
+ "properties": {
959
+ "scope": {
960
+ "type": "string",
961
+ "enum": [
962
+ "local",
963
+ "global",
964
+ "experience",
965
+ "cloud"
966
+ ]
967
+ }
968
+ },
958
969
  "additionalProperties": false
959
970
  },
960
971
  "meta": {
@@ -1440,6 +1451,10 @@
1440
1451
  "type": "string",
1441
1452
  "maxLength": 1024
1442
1453
  },
1454
+ "writeOnOpenEncoding": {
1455
+ "type": "string",
1456
+ "maxLength": 48
1457
+ },
1443
1458
  "byteLength": {
1444
1459
  "type": "string",
1445
1460
  "maxLength": 48
@@ -1447,6 +1462,10 @@
1447
1462
  "delimiter": {
1448
1463
  "type": "string",
1449
1464
  "maxLength": 48
1465
+ },
1466
+ "delimiterEncoding": {
1467
+ "type": "string",
1468
+ "maxLength": 48
1450
1469
  }
1451
1470
  },
1452
1471
  "additionalProperties": false
@@ -3134,6 +3153,17 @@
3134
3153
  },
3135
3154
  "config": {
3136
3155
  "type": "object",
3156
+ "properties": {
3157
+ "scope": {
3158
+ "type": "string",
3159
+ "enum": [
3160
+ "local",
3161
+ "global",
3162
+ "experience",
3163
+ "cloud"
3164
+ ]
3165
+ }
3166
+ },
3137
3167
  "additionalProperties": false
3138
3168
  },
3139
3169
  "meta": {
@@ -3619,6 +3649,10 @@
3619
3649
  "type": "string",
3620
3650
  "maxLength": 1024
3621
3651
  },
3652
+ "writeOnOpenEncoding": {
3653
+ "type": "string",
3654
+ "maxLength": 48
3655
+ },
3622
3656
  "byteLength": {
3623
3657
  "type": "string",
3624
3658
  "maxLength": 48
@@ -3626,6 +3660,10 @@
3626
3660
  "delimiter": {
3627
3661
  "type": "string",
3628
3662
  "maxLength": 48
3663
+ },
3664
+ "delimiterEncoding": {
3665
+ "type": "string",
3666
+ "maxLength": 48
3629
3667
  }
3630
3668
  },
3631
3669
  "additionalProperties": false
@@ -5313,6 +5351,17 @@
5313
5351
  },
5314
5352
  "config": {
5315
5353
  "type": "object",
5354
+ "properties": {
5355
+ "scope": {
5356
+ "type": "string",
5357
+ "enum": [
5358
+ "local",
5359
+ "global",
5360
+ "experience",
5361
+ "cloud"
5362
+ ]
5363
+ }
5364
+ },
5316
5365
  "additionalProperties": false
5317
5366
  },
5318
5367
  "meta": {
@@ -5798,6 +5847,10 @@
5798
5847
  "type": "string",
5799
5848
  "maxLength": 1024
5800
5849
  },
5850
+ "writeOnOpenEncoding": {
5851
+ "type": "string",
5852
+ "maxLength": 48
5853
+ },
5801
5854
  "byteLength": {
5802
5855
  "type": "string",
5803
5856
  "maxLength": 48
@@ -5805,6 +5858,10 @@
5805
5858
  "delimiter": {
5806
5859
  "type": "string",
5807
5860
  "maxLength": 48
5861
+ },
5862
+ "delimiterEncoding": {
5863
+ "type": "string",
5864
+ "maxLength": 48
5808
5865
  }
5809
5866
  },
5810
5867
  "additionalProperties": false
@@ -19,6 +19,7 @@
19
19
  "enum": [
20
20
  "all.Application",
21
21
  "all.Application.read",
22
+ "all.Application.cli",
22
23
  "all.Device",
23
24
  "all.Device.read",
24
25
  "application.*",
@@ -28,6 +29,8 @@
28
29
  "applicationCertificates.*",
29
30
  "applicationCertificateAuthority.*",
30
31
  "applicationCertificateAuthorities.*",
32
+ "applicationDashboards.*",
33
+ "applicationDashboard.*",
31
34
  "applicationKey.*",
32
35
  "applicationKeys.*",
33
36
  "data.*",
@@ -100,6 +103,11 @@
100
103
  "applicationCertificateAuthority.patch",
101
104
  "applicationCertificateAuthorities.get",
102
105
  "applicationCertificateAuthorities.post",
106
+ "applicationDashboard.get",
107
+ "applicationDashboard.patch",
108
+ "applicationDashboard.delete",
109
+ "applicationDashboards.get",
110
+ "applicationDashboards.post",
103
111
  "applicationKey.delete",
104
112
  "applicationKey.get",
105
113
  "applicationKey.patch",
@@ -145,6 +153,7 @@
145
153
  "deviceRecipe.patch",
146
154
  "deviceRecipes.get",
147
155
  "deviceRecipes.post",
156
+ "devices.attributeNames",
148
157
  "devices.patch",
149
158
  "devices.delete",
150
159
  "devices.removeData",
@@ -153,6 +162,8 @@
153
162
  "devices.get",
154
163
  "devices.post",
155
164
  "devices.sendCommand",
165
+ "devices.tagKeys",
166
+ "devices.tagValues",
156
167
  "edgeDeployments.get",
157
168
  "edgeDeployments.release",
158
169
  "edgeDeployments.remove",
@@ -228,6 +239,7 @@
228
239
  "flow.patch",
229
240
  "flow.pressVirtualButton",
230
241
  "flow.setStorageEntry",
242
+ "flow.getStorageEntriesMetadata",
231
243
  "flow.stats",
232
244
  "flows.get",
233
245
  "flows.getByVersion",
@@ -239,6 +251,7 @@
239
251
  "flowVersion.log",
240
252
  "flowVersion.patch",
241
253
  "flowVersion.stats",
254
+ "flowVersions.delete",
242
255
  "flowVersions.get",
243
256
  "flowVersions.post",
244
257
  "integration.delete",
@@ -301,19 +314,68 @@
301
314
  }
302
315
  ]
303
316
  },
317
+ {
318
+ "type": "string",
319
+ "enum": [
320
+ "all.Instance",
321
+ "all.Instance.read",
322
+ "instance.*",
323
+ "instance.get",
324
+ "instance.patch",
325
+ "instance.historicalSummaries",
326
+ "instance.generateReport",
327
+ "instanceOrg.*",
328
+ "instanceOrg.get",
329
+ "instanceOrg.patch",
330
+ "instanceOrg.delete",
331
+ "instanceOrgs.*",
332
+ "instanceOrgs.get",
333
+ "instanceOrgs.post",
334
+ "instanceMember.*",
335
+ "instanceMember.get",
336
+ "instanceMember.patch",
337
+ "instanceMember.delete",
338
+ "instanceMembers.*",
339
+ "instanceMembers.get",
340
+ "instanceMembers.post",
341
+ "instanceOrgMember.*",
342
+ "instanceOrgMember.get",
343
+ "instanceOrgMember.patch",
344
+ "instanceOrgMember.delete",
345
+ "instanceOrgMembers.*",
346
+ "instanceOrgMembers.get",
347
+ "instanceOrgMembers.post",
348
+ "instanceApiTokens.*",
349
+ "instanceApiTokens.get",
350
+ "instanceApiTokens.post",
351
+ "instanceApiToken.*",
352
+ "instanceApiToken.get",
353
+ "instanceApiToken.patch",
354
+ "instanceApiToken.delete"
355
+ ]
356
+ },
304
357
  {
305
358
  "type": "string",
306
359
  "enum": [
307
360
  "all.User",
308
361
  "all.User.read",
362
+ "all.User.cli",
363
+ "userApiToken.*",
364
+ "userApiToken.get",
365
+ "userApiToken.patch",
366
+ "userApiToken.delete",
367
+ "userApiTokens.*",
368
+ "userApiTokens.get",
369
+ "userApiTokens.post",
309
370
  "applicationTemplate.*",
310
371
  "applicationTemplate.get",
311
372
  "applicationTemplates.*",
312
373
  "applicationTemplates.get",
313
374
  "applicationTemplates.getCategories",
314
375
  "applicationTemplates.getUniqueKeywords",
376
+ "instances.*",
377
+ "instances.get",
315
378
  "me.*",
316
- "orgs.*",
317
379
  "me.get",
318
380
  "me.patch",
319
381
  "me.delete",
@@ -327,6 +389,7 @@
327
389
  "me.fetchRecentItems",
328
390
  "me.payloadCounts",
329
391
  "me.transferResources",
392
+ "orgs.*",
330
393
  "orgs.get",
331
394
  "orgs.post"
332
395
  ]
@@ -0,0 +1,43 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "type": "#/definitions/historicalSummary"
9
+ }
10
+ },
11
+ "count": {
12
+ "type": "integer"
13
+ },
14
+ "totalCount": {
15
+ "type": "integer"
16
+ },
17
+ "perPage": {
18
+ "type": "integer"
19
+ },
20
+ "page": {
21
+ "type": "integer"
22
+ },
23
+ "filter": {
24
+ "type": "string"
25
+ },
26
+ "filterField": {
27
+ "type": "string"
28
+ },
29
+ "sortField": {
30
+ "type": "string"
31
+ },
32
+ "sortDirection": {
33
+ "type": "string",
34
+ "enum": [
35
+ "asc",
36
+ "desc",
37
+ "ASC",
38
+ "DESC",
39
+ ""
40
+ ]
41
+ }
42
+ }
43
+ }
@@ -0,0 +1,458 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "resourceType": {
6
+ "type": "string",
7
+ "enum": [
8
+ "application",
9
+ "organization",
10
+ "whitelabel"
11
+ ]
12
+ },
13
+ "resourceId": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ },
17
+ "resourceName": {
18
+ "type": "string",
19
+ "minLength": 1,
20
+ "maxLength": 255
21
+ },
22
+ "resourceProration": {
23
+ "type": "number"
24
+ },
25
+ "ownerType": {
26
+ "type": "string",
27
+ "enum": [
28
+ "organization",
29
+ "user"
30
+ ]
31
+ },
32
+ "ownerId": {
33
+ "type": "string",
34
+ "pattern": "^[A-Fa-f\\d]{24}$"
35
+ },
36
+ "ownerName": {
37
+ "type": "string",
38
+ "minLength": 1,
39
+ "maxLength": 255
40
+ },
41
+ "limits": {
42
+ "apitoken": {
43
+ "type": "number"
44
+ },
45
+ "application": {
46
+ "type": "number"
47
+ },
48
+ "applicationkey": {
49
+ "type": "number"
50
+ },
51
+ "dashboard": {
52
+ "type": "number"
53
+ },
54
+ "datatable": {
55
+ "type": "number"
56
+ },
57
+ "device": {
58
+ "type": "number"
59
+ },
60
+ "devicerecipe": {
61
+ "type": "number"
62
+ },
63
+ "experiencedomain": {
64
+ "type": "number"
65
+ },
66
+ "experienceendpoint": {
67
+ "type": "number"
68
+ },
69
+ "experiencegroup": {
70
+ "type": "number"
71
+ },
72
+ "experienceslug": {
73
+ "type": "number"
74
+ },
75
+ "experienceuser": {
76
+ "type": "number"
77
+ },
78
+ "experienceversion": {
79
+ "type": "number"
80
+ },
81
+ "experienceview": {
82
+ "type": "number"
83
+ },
84
+ "file": {
85
+ "type": "number"
86
+ },
87
+ "flow": {
88
+ "type": "number"
89
+ },
90
+ "integration": {
91
+ "type": "number"
92
+ },
93
+ "notebook": {
94
+ "type": "number"
95
+ },
96
+ "webhook": {
97
+ "type": "number"
98
+ },
99
+ "dataTTL": {
100
+ "type": "number"
101
+ },
102
+ "member": {
103
+ "type": "number"
104
+ },
105
+ "payload": {
106
+ "type": "number"
107
+ },
108
+ "notebookMinutesPerRun": {
109
+ "type": "number"
110
+ },
111
+ "notebookMinutesPerMonth": {
112
+ "type": "number"
113
+ },
114
+ "notebookInParallel": {
115
+ "type": "number"
116
+ }
117
+ },
118
+ "currentPeriodStart": {
119
+ "type": "string",
120
+ "format": "date-time"
121
+ },
122
+ "currentPeriodEnd": {
123
+ "type": "string",
124
+ "format": "date-time"
125
+ },
126
+ "applicationCount": {
127
+ "type": "number"
128
+ },
129
+ "applicationCountProrated": {
130
+ "type": "number"
131
+ },
132
+ "userCount": {
133
+ "type": "number"
134
+ },
135
+ "userCountProrated": {
136
+ "type": "number"
137
+ },
138
+ "apiTokenCount": {
139
+ "type": "number"
140
+ },
141
+ "applicationKeyCount": {
142
+ "type": "number"
143
+ },
144
+ "certificateAuthorityCount": {
145
+ "type": "number"
146
+ },
147
+ "certificateCount": {
148
+ "type": "number"
149
+ },
150
+ "dashboardCount": {
151
+ "type": "number"
152
+ },
153
+ "dashboardCountProrated": {
154
+ "type": "number"
155
+ },
156
+ "dataTableCount": {
157
+ "type": "number"
158
+ },
159
+ "dataTableRowCount": {
160
+ "type": "number"
161
+ },
162
+ "dataTableTotalSizeMb": {
163
+ "type": "number"
164
+ },
165
+ "deviceCount": {
166
+ "type": "number"
167
+ },
168
+ "deviceCountProrated": {
169
+ "type": "number"
170
+ },
171
+ "deviceRecipeCount": {
172
+ "type": "number"
173
+ },
174
+ "eventCount": {
175
+ "type": "number"
176
+ },
177
+ "experienceDomainCount": {
178
+ "type": "number"
179
+ },
180
+ "experienceEndpointCount": {
181
+ "type": "number"
182
+ },
183
+ "experienceGroupCount": {
184
+ "type": "number"
185
+ },
186
+ "experienceSlugCount": {
187
+ "type": "number"
188
+ },
189
+ "experienceUserCount": {
190
+ "type": "number"
191
+ },
192
+ "experienceVersionCount": {
193
+ "type": "number"
194
+ },
195
+ "experienceViewCount": {
196
+ "type": "number"
197
+ },
198
+ "fileCount": {
199
+ "type": "number"
200
+ },
201
+ "fileTotalSizeMb": {
202
+ "type": "number"
203
+ },
204
+ "integrationCount": {
205
+ "type": "number"
206
+ },
207
+ "notebookCount": {
208
+ "type": "number"
209
+ },
210
+ "notebookRunCount": {
211
+ "type": "number"
212
+ },
213
+ "notebookMinutesCount": {
214
+ "type": "number"
215
+ },
216
+ "webhookCount": {
217
+ "type": "number"
218
+ },
219
+ "workflowCount": {
220
+ "type": "number"
221
+ },
222
+ "payloadBillableCount": {
223
+ "type": "number"
224
+ },
225
+ "payloadNonbillableCount": {
226
+ "type": "number"
227
+ },
228
+ "payloadBillableSizeMb": {
229
+ "type": "number"
230
+ },
231
+ "payloadNonbillableSizeMb": {
232
+ "type": "number"
233
+ },
234
+ "payloadCountDetails": {
235
+ "title": "Payload Counts",
236
+ "description": "Schema for the result of a payload count request",
237
+ "type": "object",
238
+ "properties": {
239
+ "mqttOut": {
240
+ "type": "object",
241
+ "patternProperties": {
242
+ ".*": {
243
+ "type": "number"
244
+ }
245
+ }
246
+ },
247
+ "mqttIn": {
248
+ "type": "object",
249
+ "patternProperties": {
250
+ ".*": {
251
+ "type": "number"
252
+ }
253
+ }
254
+ },
255
+ "dataTable": {
256
+ "type": "object",
257
+ "patternProperties": {
258
+ ".*": {
259
+ "type": "number"
260
+ }
261
+ }
262
+ },
263
+ "deviceState": {
264
+ "type": "object",
265
+ "patternProperties": {
266
+ ".*": {
267
+ "type": "number"
268
+ }
269
+ }
270
+ },
271
+ "deviceCommand": {
272
+ "type": "object",
273
+ "patternProperties": {
274
+ ".*": {
275
+ "type": "number"
276
+ }
277
+ }
278
+ },
279
+ "webhook": {
280
+ "type": "object",
281
+ "patternProperties": {
282
+ ".*": {
283
+ "type": "number"
284
+ }
285
+ }
286
+ },
287
+ "timer": {
288
+ "type": "object",
289
+ "patternProperties": {
290
+ ".*": {
291
+ "type": "number"
292
+ }
293
+ }
294
+ },
295
+ "event": {
296
+ "type": "object",
297
+ "patternProperties": {
298
+ ".*": {
299
+ "type": "number"
300
+ }
301
+ }
302
+ },
303
+ "virtualButton": {
304
+ "type": "object",
305
+ "patternProperties": {
306
+ ".*": {
307
+ "type": "number"
308
+ }
309
+ }
310
+ },
311
+ "deviceConnect": {
312
+ "type": "object",
313
+ "patternProperties": {
314
+ ".*": {
315
+ "type": "number"
316
+ }
317
+ }
318
+ },
319
+ "deviceDisconnect": {
320
+ "type": "object",
321
+ "patternProperties": {
322
+ ".*": {
323
+ "type": "number"
324
+ }
325
+ }
326
+ },
327
+ "endpoint": {
328
+ "type": "object",
329
+ "patternProperties": {
330
+ ".*": {
331
+ "type": "number"
332
+ }
333
+ }
334
+ },
335
+ "integration": {
336
+ "type": "object",
337
+ "patternProperties": {
338
+ ".*": {
339
+ "type": "number"
340
+ }
341
+ }
342
+ }
343
+ }
344
+ },
345
+ "payloadSizeDetails": {
346
+ "title": "Payload Counts",
347
+ "description": "Schema for the result of a payload count request",
348
+ "type": "object",
349
+ "properties": {
350
+ "mqttOut": {
351
+ "type": "object",
352
+ "patternProperties": {
353
+ ".*": {
354
+ "type": "number"
355
+ }
356
+ }
357
+ },
358
+ "mqttIn": {
359
+ "type": "object",
360
+ "patternProperties": {
361
+ ".*": {
362
+ "type": "number"
363
+ }
364
+ }
365
+ },
366
+ "dataTable": {
367
+ "type": "object",
368
+ "patternProperties": {
369
+ ".*": {
370
+ "type": "number"
371
+ }
372
+ }
373
+ },
374
+ "deviceState": {
375
+ "type": "object",
376
+ "patternProperties": {
377
+ ".*": {
378
+ "type": "number"
379
+ }
380
+ }
381
+ },
382
+ "deviceCommand": {
383
+ "type": "object",
384
+ "patternProperties": {
385
+ ".*": {
386
+ "type": "number"
387
+ }
388
+ }
389
+ },
390
+ "webhook": {
391
+ "type": "object",
392
+ "patternProperties": {
393
+ ".*": {
394
+ "type": "number"
395
+ }
396
+ }
397
+ },
398
+ "timer": {
399
+ "type": "object",
400
+ "patternProperties": {
401
+ ".*": {
402
+ "type": "number"
403
+ }
404
+ }
405
+ },
406
+ "event": {
407
+ "type": "object",
408
+ "patternProperties": {
409
+ ".*": {
410
+ "type": "number"
411
+ }
412
+ }
413
+ },
414
+ "virtualButton": {
415
+ "type": "object",
416
+ "patternProperties": {
417
+ ".*": {
418
+ "type": "number"
419
+ }
420
+ }
421
+ },
422
+ "deviceConnect": {
423
+ "type": "object",
424
+ "patternProperties": {
425
+ ".*": {
426
+ "type": "number"
427
+ }
428
+ }
429
+ },
430
+ "deviceDisconnect": {
431
+ "type": "object",
432
+ "patternProperties": {
433
+ ".*": {
434
+ "type": "number"
435
+ }
436
+ }
437
+ },
438
+ "endpoint": {
439
+ "type": "object",
440
+ "patternProperties": {
441
+ ".*": {
442
+ "type": "number"
443
+ }
444
+ }
445
+ },
446
+ "integration": {
447
+ "type": "object",
448
+ "patternProperties": {
449
+ ".*": {
450
+ "type": "number"
451
+ }
452
+ }
453
+ }
454
+ }
455
+ }
456
+ },
457
+ "additionalProperties": false
458
+ }