losant_rest 1.15.1 → 1.15.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/docs/_schemas.md +3003 -311
  4. data/docs/devices.md +40 -0
  5. data/lib/losant_rest/application.rb +1 -1
  6. data/lib/losant_rest/application_api_token.rb +1 -1
  7. data/lib/losant_rest/application_api_tokens.rb +1 -1
  8. data/lib/losant_rest/application_certificate.rb +1 -1
  9. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  10. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  11. data/lib/losant_rest/application_certificates.rb +1 -1
  12. data/lib/losant_rest/application_dashboard.rb +1 -1
  13. data/lib/losant_rest/application_dashboards.rb +1 -1
  14. data/lib/losant_rest/application_key.rb +1 -1
  15. data/lib/losant_rest/application_keys.rb +1 -1
  16. data/lib/losant_rest/application_template.rb +1 -1
  17. data/lib/losant_rest/application_templates.rb +1 -1
  18. data/lib/losant_rest/applications.rb +1 -1
  19. data/lib/losant_rest/audit_log.rb +1 -1
  20. data/lib/losant_rest/audit_logs.rb +1 -1
  21. data/lib/losant_rest/auth.rb +1 -1
  22. data/lib/losant_rest/client.rb +3 -3
  23. data/lib/losant_rest/dashboard.rb +1 -1
  24. data/lib/losant_rest/dashboards.rb +1 -1
  25. data/lib/losant_rest/data.rb +1 -1
  26. data/lib/losant_rest/data_table.rb +1 -1
  27. data/lib/losant_rest/data_table_row.rb +1 -1
  28. data/lib/losant_rest/data_table_rows.rb +1 -1
  29. data/lib/losant_rest/data_tables.rb +1 -1
  30. data/lib/losant_rest/device.rb +1 -1
  31. data/lib/losant_rest/device_recipe.rb +1 -1
  32. data/lib/losant_rest/device_recipes.rb +1 -1
  33. data/lib/losant_rest/devices.rb +50 -1
  34. data/lib/losant_rest/edge_deployment.rb +1 -1
  35. data/lib/losant_rest/edge_deployments.rb +1 -1
  36. data/lib/losant_rest/embedded_deployment.rb +1 -1
  37. data/lib/losant_rest/embedded_deployments.rb +1 -1
  38. data/lib/losant_rest/error.rb +1 -1
  39. data/lib/losant_rest/event.rb +1 -1
  40. data/lib/losant_rest/events.rb +1 -1
  41. data/lib/losant_rest/experience.rb +1 -1
  42. data/lib/losant_rest/experience_domain.rb +1 -1
  43. data/lib/losant_rest/experience_domains.rb +1 -1
  44. data/lib/losant_rest/experience_endpoint.rb +1 -1
  45. data/lib/losant_rest/experience_endpoints.rb +1 -1
  46. data/lib/losant_rest/experience_group.rb +1 -1
  47. data/lib/losant_rest/experience_groups.rb +1 -1
  48. data/lib/losant_rest/experience_slug.rb +1 -1
  49. data/lib/losant_rest/experience_slugs.rb +1 -1
  50. data/lib/losant_rest/experience_user.rb +1 -1
  51. data/lib/losant_rest/experience_users.rb +1 -1
  52. data/lib/losant_rest/experience_version.rb +1 -1
  53. data/lib/losant_rest/experience_versions.rb +1 -1
  54. data/lib/losant_rest/experience_view.rb +1 -1
  55. data/lib/losant_rest/experience_views.rb +1 -1
  56. data/lib/losant_rest/file.rb +1 -1
  57. data/lib/losant_rest/files.rb +1 -1
  58. data/lib/losant_rest/flow.rb +1 -1
  59. data/lib/losant_rest/flow_version.rb +1 -1
  60. data/lib/losant_rest/flow_versions.rb +1 -1
  61. data/lib/losant_rest/flows.rb +1 -1
  62. data/lib/losant_rest/instance.rb +1 -1
  63. data/lib/losant_rest/instance_api_token.rb +1 -1
  64. data/lib/losant_rest/instance_api_tokens.rb +1 -1
  65. data/lib/losant_rest/instance_member.rb +1 -1
  66. data/lib/losant_rest/instance_members.rb +1 -1
  67. data/lib/losant_rest/instance_org.rb +1 -1
  68. data/lib/losant_rest/instance_org_invite.rb +1 -1
  69. data/lib/losant_rest/instance_org_invites.rb +1 -1
  70. data/lib/losant_rest/instance_org_member.rb +1 -1
  71. data/lib/losant_rest/instance_org_members.rb +1 -1
  72. data/lib/losant_rest/instance_orgs.rb +1 -1
  73. data/lib/losant_rest/instances.rb +1 -1
  74. data/lib/losant_rest/integration.rb +1 -1
  75. data/lib/losant_rest/integrations.rb +1 -1
  76. data/lib/losant_rest/me.rb +1 -1
  77. data/lib/losant_rest/notebook.rb +1 -1
  78. data/lib/losant_rest/notebooks.rb +1 -1
  79. data/lib/losant_rest/org.rb +1 -1
  80. data/lib/losant_rest/org_invites.rb +1 -1
  81. data/lib/losant_rest/orgs.rb +1 -1
  82. data/lib/losant_rest/user_api_token.rb +1 -1
  83. data/lib/losant_rest/user_api_tokens.rb +1 -1
  84. data/lib/losant_rest/utils.rb +1 -1
  85. data/lib/losant_rest/version.rb +2 -2
  86. data/lib/losant_rest/webhook.rb +1 -1
  87. data/lib/losant_rest/webhooks.rb +1 -1
  88. data/lib/losant_rest.rb +1 -1
  89. data/schemas/apiTokenPost.json +1 -0
  90. data/schemas/deviceNamesResponse.json +36 -0
  91. data/schemas/experienceLinkedResources.json +465 -0
  92. data/schemas/flow.json +155 -0
  93. data/schemas/flowPatch.json +155 -0
  94. data/schemas/flowPost.json +155 -0
  95. data/schemas/flowVersion.json +310 -0
  96. data/schemas/flowVersionPost.json +155 -0
  97. data/schemas/flowVersions.json +310 -0
  98. data/schemas/flows.json +155 -0
  99. data/schemas/flowsImportPost.json +310 -0
  100. data/schemas/flowsImportResult.json +465 -0
  101. data/schemas/githubLogin.json +1 -0
  102. data/schemas/instanceMember.json +0 -1
  103. data/schemas/instanceMembers.json +0 -1
  104. data/schemas/instanceOrgMember.json +0 -1
  105. data/schemas/integration.json +1 -1
  106. data/schemas/integrationPatch.json +1 -1
  107. data/schemas/integrationPost.json +1 -1
  108. data/schemas/integrations.json +1 -1
  109. data/schemas/me.json +0 -1
  110. data/schemas/mePatch.json +0 -1
  111. data/schemas/org.json +0 -1
  112. data/schemas/orgs.json +0 -1
  113. data/schemas/userCredentials.json +1 -0
  114. data/schemas/userPost.json +1 -1
  115. metadata +3 -2
@@ -2156,6 +2156,161 @@
2156
2156
  ],
2157
2157
  "additionalProperties": false
2158
2158
  },
2159
+ {
2160
+ "type": "object",
2161
+ "properties": {
2162
+ "key": {
2163
+ "type": "string",
2164
+ "maxLength": 1024
2165
+ },
2166
+ "type": {
2167
+ "type": "string",
2168
+ "enum": [
2169
+ "snmpTrap"
2170
+ ]
2171
+ },
2172
+ "config": {
2173
+ "type": "object",
2174
+ "properties": {
2175
+ "udpPort": {
2176
+ "type": "string",
2177
+ "maxLength": 5
2178
+ },
2179
+ "snmpTrapConfig": {
2180
+ "type": "object",
2181
+ "properties": {
2182
+ "community": {
2183
+ "type": "string",
2184
+ "maxLength": 1024
2185
+ },
2186
+ "user": {
2187
+ "type": "object",
2188
+ "properties": {
2189
+ "name": {
2190
+ "type": "string",
2191
+ "maxLength": 1024
2192
+ },
2193
+ "securityLevel": {
2194
+ "type": "string",
2195
+ "enum": [
2196
+ "none",
2197
+ "auth",
2198
+ "authAndEncrypt"
2199
+ ]
2200
+ },
2201
+ "authMethod": {
2202
+ "type": "string",
2203
+ "enum": [
2204
+ "sha",
2205
+ "md5"
2206
+ ]
2207
+ },
2208
+ "authKey": {
2209
+ "type": "string",
2210
+ "maxLength": 1024
2211
+ },
2212
+ "encryptionMethod": {
2213
+ "type": "string",
2214
+ "enum": [
2215
+ "aes",
2216
+ "des"
2217
+ ]
2218
+ },
2219
+ "encryptionKey": {
2220
+ "type": "string",
2221
+ "maxLength": 1024
2222
+ }
2223
+ },
2224
+ "required": [
2225
+ "name",
2226
+ "securityLevel"
2227
+ ],
2228
+ "additionalProperties": false
2229
+ }
2230
+ },
2231
+ "additionalProperties": false
2232
+ }
2233
+ },
2234
+ "required": [
2235
+ "udpPort",
2236
+ "snmpTrapConfig"
2237
+ ],
2238
+ "additionalProperties": false
2239
+ },
2240
+ "meta": {
2241
+ "type": "object",
2242
+ "properties": {
2243
+ "category": {
2244
+ "type": "string",
2245
+ "enum": [
2246
+ "trigger"
2247
+ ]
2248
+ },
2249
+ "name": {
2250
+ "type": "string",
2251
+ "enum": [
2252
+ "snmpTrap"
2253
+ ]
2254
+ },
2255
+ "label": {
2256
+ "type": "string",
2257
+ "minLength": 1,
2258
+ "maxLength": 255
2259
+ },
2260
+ "x": {
2261
+ "type": "number"
2262
+ },
2263
+ "y": {
2264
+ "type": "number"
2265
+ },
2266
+ "uiId": {
2267
+ "type": "string",
2268
+ "maxLength": 48
2269
+ },
2270
+ "description": {
2271
+ "type": "string",
2272
+ "maxLength": 32767
2273
+ },
2274
+ "icon": {
2275
+ "type": "string",
2276
+ "maxLength": 1024
2277
+ },
2278
+ "color": {
2279
+ "type": "string",
2280
+ "maxLength": 1024
2281
+ },
2282
+ "inputCount": {
2283
+ "type": "number"
2284
+ },
2285
+ "outputCount": {
2286
+ "type": "number"
2287
+ },
2288
+ "id": {
2289
+ "type": "string",
2290
+ "maxLength": 48
2291
+ }
2292
+ },
2293
+ "additionalProperties": false
2294
+ },
2295
+ "outputIds": {
2296
+ "type": "array",
2297
+ "items": {
2298
+ "type": "array",
2299
+ "items": {
2300
+ "type": "string",
2301
+ "maxLength": 48,
2302
+ "minLength": 1
2303
+ },
2304
+ "maxItems": 100
2305
+ },
2306
+ "maxItems": 100
2307
+ }
2308
+ },
2309
+ "required": [
2310
+ "type"
2311
+ ],
2312
+ "additionalProperties": false
2313
+ },
2159
2314
  {
2160
2315
  "type": "object",
2161
2316
  "properties": {
@@ -4640,6 +4795,161 @@
4640
4795
  ],
4641
4796
  "additionalProperties": false
4642
4797
  },
4798
+ {
4799
+ "type": "object",
4800
+ "properties": {
4801
+ "key": {
4802
+ "type": "string",
4803
+ "maxLength": 1024
4804
+ },
4805
+ "type": {
4806
+ "type": "string",
4807
+ "enum": [
4808
+ "snmpTrap"
4809
+ ]
4810
+ },
4811
+ "config": {
4812
+ "type": "object",
4813
+ "properties": {
4814
+ "udpPort": {
4815
+ "type": "string",
4816
+ "maxLength": 5
4817
+ },
4818
+ "snmpTrapConfig": {
4819
+ "type": "object",
4820
+ "properties": {
4821
+ "community": {
4822
+ "type": "string",
4823
+ "maxLength": 1024
4824
+ },
4825
+ "user": {
4826
+ "type": "object",
4827
+ "properties": {
4828
+ "name": {
4829
+ "type": "string",
4830
+ "maxLength": 1024
4831
+ },
4832
+ "securityLevel": {
4833
+ "type": "string",
4834
+ "enum": [
4835
+ "none",
4836
+ "auth",
4837
+ "authAndEncrypt"
4838
+ ]
4839
+ },
4840
+ "authMethod": {
4841
+ "type": "string",
4842
+ "enum": [
4843
+ "sha",
4844
+ "md5"
4845
+ ]
4846
+ },
4847
+ "authKey": {
4848
+ "type": "string",
4849
+ "maxLength": 1024
4850
+ },
4851
+ "encryptionMethod": {
4852
+ "type": "string",
4853
+ "enum": [
4854
+ "aes",
4855
+ "des"
4856
+ ]
4857
+ },
4858
+ "encryptionKey": {
4859
+ "type": "string",
4860
+ "maxLength": 1024
4861
+ }
4862
+ },
4863
+ "required": [
4864
+ "name",
4865
+ "securityLevel"
4866
+ ],
4867
+ "additionalProperties": false
4868
+ }
4869
+ },
4870
+ "additionalProperties": false
4871
+ }
4872
+ },
4873
+ "required": [
4874
+ "udpPort",
4875
+ "snmpTrapConfig"
4876
+ ],
4877
+ "additionalProperties": false
4878
+ },
4879
+ "meta": {
4880
+ "type": "object",
4881
+ "properties": {
4882
+ "category": {
4883
+ "type": "string",
4884
+ "enum": [
4885
+ "trigger"
4886
+ ]
4887
+ },
4888
+ "name": {
4889
+ "type": "string",
4890
+ "enum": [
4891
+ "snmpTrap"
4892
+ ]
4893
+ },
4894
+ "label": {
4895
+ "type": "string",
4896
+ "minLength": 1,
4897
+ "maxLength": 255
4898
+ },
4899
+ "x": {
4900
+ "type": "number"
4901
+ },
4902
+ "y": {
4903
+ "type": "number"
4904
+ },
4905
+ "uiId": {
4906
+ "type": "string",
4907
+ "maxLength": 48
4908
+ },
4909
+ "description": {
4910
+ "type": "string",
4911
+ "maxLength": 32767
4912
+ },
4913
+ "icon": {
4914
+ "type": "string",
4915
+ "maxLength": 1024
4916
+ },
4917
+ "color": {
4918
+ "type": "string",
4919
+ "maxLength": 1024
4920
+ },
4921
+ "inputCount": {
4922
+ "type": "number"
4923
+ },
4924
+ "outputCount": {
4925
+ "type": "number"
4926
+ },
4927
+ "id": {
4928
+ "type": "string",
4929
+ "maxLength": 48
4930
+ }
4931
+ },
4932
+ "additionalProperties": false
4933
+ },
4934
+ "outputIds": {
4935
+ "type": "array",
4936
+ "items": {
4937
+ "type": "array",
4938
+ "items": {
4939
+ "type": "string",
4940
+ "maxLength": 48,
4941
+ "minLength": 1
4942
+ },
4943
+ "maxItems": 100
4944
+ },
4945
+ "maxItems": 100
4946
+ }
4947
+ },
4948
+ "required": [
4949
+ "type"
4950
+ ],
4951
+ "additionalProperties": false
4952
+ },
4643
4953
  {
4644
4954
  "type": "object",
4645
4955
  "properties": {
@@ -7073,6 +7383,161 @@
7073
7383
  ],
7074
7384
  "additionalProperties": false
7075
7385
  },
7386
+ {
7387
+ "type": "object",
7388
+ "properties": {
7389
+ "key": {
7390
+ "type": "string",
7391
+ "maxLength": 1024
7392
+ },
7393
+ "type": {
7394
+ "type": "string",
7395
+ "enum": [
7396
+ "snmpTrap"
7397
+ ]
7398
+ },
7399
+ "config": {
7400
+ "type": "object",
7401
+ "properties": {
7402
+ "udpPort": {
7403
+ "type": "string",
7404
+ "maxLength": 5
7405
+ },
7406
+ "snmpTrapConfig": {
7407
+ "type": "object",
7408
+ "properties": {
7409
+ "community": {
7410
+ "type": "string",
7411
+ "maxLength": 1024
7412
+ },
7413
+ "user": {
7414
+ "type": "object",
7415
+ "properties": {
7416
+ "name": {
7417
+ "type": "string",
7418
+ "maxLength": 1024
7419
+ },
7420
+ "securityLevel": {
7421
+ "type": "string",
7422
+ "enum": [
7423
+ "none",
7424
+ "auth",
7425
+ "authAndEncrypt"
7426
+ ]
7427
+ },
7428
+ "authMethod": {
7429
+ "type": "string",
7430
+ "enum": [
7431
+ "sha",
7432
+ "md5"
7433
+ ]
7434
+ },
7435
+ "authKey": {
7436
+ "type": "string",
7437
+ "maxLength": 1024
7438
+ },
7439
+ "encryptionMethod": {
7440
+ "type": "string",
7441
+ "enum": [
7442
+ "aes",
7443
+ "des"
7444
+ ]
7445
+ },
7446
+ "encryptionKey": {
7447
+ "type": "string",
7448
+ "maxLength": 1024
7449
+ }
7450
+ },
7451
+ "required": [
7452
+ "name",
7453
+ "securityLevel"
7454
+ ],
7455
+ "additionalProperties": false
7456
+ }
7457
+ },
7458
+ "additionalProperties": false
7459
+ }
7460
+ },
7461
+ "required": [
7462
+ "udpPort",
7463
+ "snmpTrapConfig"
7464
+ ],
7465
+ "additionalProperties": false
7466
+ },
7467
+ "meta": {
7468
+ "type": "object",
7469
+ "properties": {
7470
+ "category": {
7471
+ "type": "string",
7472
+ "enum": [
7473
+ "trigger"
7474
+ ]
7475
+ },
7476
+ "name": {
7477
+ "type": "string",
7478
+ "enum": [
7479
+ "snmpTrap"
7480
+ ]
7481
+ },
7482
+ "label": {
7483
+ "type": "string",
7484
+ "minLength": 1,
7485
+ "maxLength": 255
7486
+ },
7487
+ "x": {
7488
+ "type": "number"
7489
+ },
7490
+ "y": {
7491
+ "type": "number"
7492
+ },
7493
+ "uiId": {
7494
+ "type": "string",
7495
+ "maxLength": 48
7496
+ },
7497
+ "description": {
7498
+ "type": "string",
7499
+ "maxLength": 32767
7500
+ },
7501
+ "icon": {
7502
+ "type": "string",
7503
+ "maxLength": 1024
7504
+ },
7505
+ "color": {
7506
+ "type": "string",
7507
+ "maxLength": 1024
7508
+ },
7509
+ "inputCount": {
7510
+ "type": "number"
7511
+ },
7512
+ "outputCount": {
7513
+ "type": "number"
7514
+ },
7515
+ "id": {
7516
+ "type": "string",
7517
+ "maxLength": 48
7518
+ }
7519
+ },
7520
+ "additionalProperties": false
7521
+ },
7522
+ "outputIds": {
7523
+ "type": "array",
7524
+ "items": {
7525
+ "type": "array",
7526
+ "items": {
7527
+ "type": "string",
7528
+ "maxLength": 48,
7529
+ "minLength": 1
7530
+ },
7531
+ "maxItems": 100
7532
+ },
7533
+ "maxItems": 100
7534
+ }
7535
+ },
7536
+ "required": [
7537
+ "type"
7538
+ ],
7539
+ "additionalProperties": false
7540
+ },
7076
7541
  {
7077
7542
  "type": "object",
7078
7543
  "properties": {
data/schemas/flow.json CHANGED
@@ -1775,6 +1775,161 @@
1775
1775
  ],
1776
1776
  "additionalProperties": false
1777
1777
  },
1778
+ {
1779
+ "type": "object",
1780
+ "properties": {
1781
+ "key": {
1782
+ "type": "string",
1783
+ "maxLength": 1024
1784
+ },
1785
+ "type": {
1786
+ "type": "string",
1787
+ "enum": [
1788
+ "snmpTrap"
1789
+ ]
1790
+ },
1791
+ "config": {
1792
+ "type": "object",
1793
+ "properties": {
1794
+ "udpPort": {
1795
+ "type": "string",
1796
+ "maxLength": 5
1797
+ },
1798
+ "snmpTrapConfig": {
1799
+ "type": "object",
1800
+ "properties": {
1801
+ "community": {
1802
+ "type": "string",
1803
+ "maxLength": 1024
1804
+ },
1805
+ "user": {
1806
+ "type": "object",
1807
+ "properties": {
1808
+ "name": {
1809
+ "type": "string",
1810
+ "maxLength": 1024
1811
+ },
1812
+ "securityLevel": {
1813
+ "type": "string",
1814
+ "enum": [
1815
+ "none",
1816
+ "auth",
1817
+ "authAndEncrypt"
1818
+ ]
1819
+ },
1820
+ "authMethod": {
1821
+ "type": "string",
1822
+ "enum": [
1823
+ "sha",
1824
+ "md5"
1825
+ ]
1826
+ },
1827
+ "authKey": {
1828
+ "type": "string",
1829
+ "maxLength": 1024
1830
+ },
1831
+ "encryptionMethod": {
1832
+ "type": "string",
1833
+ "enum": [
1834
+ "aes",
1835
+ "des"
1836
+ ]
1837
+ },
1838
+ "encryptionKey": {
1839
+ "type": "string",
1840
+ "maxLength": 1024
1841
+ }
1842
+ },
1843
+ "required": [
1844
+ "name",
1845
+ "securityLevel"
1846
+ ],
1847
+ "additionalProperties": false
1848
+ }
1849
+ },
1850
+ "additionalProperties": false
1851
+ }
1852
+ },
1853
+ "required": [
1854
+ "udpPort",
1855
+ "snmpTrapConfig"
1856
+ ],
1857
+ "additionalProperties": false
1858
+ },
1859
+ "meta": {
1860
+ "type": "object",
1861
+ "properties": {
1862
+ "category": {
1863
+ "type": "string",
1864
+ "enum": [
1865
+ "trigger"
1866
+ ]
1867
+ },
1868
+ "name": {
1869
+ "type": "string",
1870
+ "enum": [
1871
+ "snmpTrap"
1872
+ ]
1873
+ },
1874
+ "label": {
1875
+ "type": "string",
1876
+ "minLength": 1,
1877
+ "maxLength": 255
1878
+ },
1879
+ "x": {
1880
+ "type": "number"
1881
+ },
1882
+ "y": {
1883
+ "type": "number"
1884
+ },
1885
+ "uiId": {
1886
+ "type": "string",
1887
+ "maxLength": 48
1888
+ },
1889
+ "description": {
1890
+ "type": "string",
1891
+ "maxLength": 32767
1892
+ },
1893
+ "icon": {
1894
+ "type": "string",
1895
+ "maxLength": 1024
1896
+ },
1897
+ "color": {
1898
+ "type": "string",
1899
+ "maxLength": 1024
1900
+ },
1901
+ "inputCount": {
1902
+ "type": "number"
1903
+ },
1904
+ "outputCount": {
1905
+ "type": "number"
1906
+ },
1907
+ "id": {
1908
+ "type": "string",
1909
+ "maxLength": 48
1910
+ }
1911
+ },
1912
+ "additionalProperties": false
1913
+ },
1914
+ "outputIds": {
1915
+ "type": "array",
1916
+ "items": {
1917
+ "type": "array",
1918
+ "items": {
1919
+ "type": "string",
1920
+ "maxLength": 48,
1921
+ "minLength": 1
1922
+ },
1923
+ "maxItems": 100
1924
+ },
1925
+ "maxItems": 100
1926
+ }
1927
+ },
1928
+ "required": [
1929
+ "type"
1930
+ ],
1931
+ "additionalProperties": false
1932
+ },
1778
1933
  {
1779
1934
  "type": "object",
1780
1935
  "properties": {