losant_rest 1.16.1 → 1.16.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +5525 -738
  3. data/docs/applications.md +1 -1
  4. data/docs/dashboard.md +2 -0
  5. data/docs/device.md +4 -0
  6. data/docs/devices.md +4 -0
  7. data/docs/instanceSandbox.md +135 -0
  8. data/docs/instanceSandboxes.md +55 -0
  9. data/docs/me.md +36 -0
  10. data/lib/losant_rest/client.rb +10 -2
  11. data/lib/losant_rest/dashboard.rb +4 -0
  12. data/lib/losant_rest/device.rb +8 -0
  13. data/lib/losant_rest/devices.rb +8 -0
  14. data/lib/losant_rest/instance_sandbox.rb +181 -0
  15. data/lib/losant_rest/instance_sandboxes.rb +98 -0
  16. data/lib/losant_rest/me.rb +41 -0
  17. data/lib/losant_rest/version.rb +1 -1
  18. data/lib/losant_rest.rb +2 -0
  19. data/schemas/advancedApplicationKeyQuery.json +88 -0
  20. data/schemas/advancedDeviceQuery.json +264 -0
  21. data/schemas/advancedEventQuery.json +88 -0
  22. data/schemas/advancedFlowByVersionQuery.json +88 -0
  23. data/schemas/advancedFlowQuery.json +88 -0
  24. data/schemas/advancedFlowVersionQuery.json +44 -0
  25. data/schemas/apiTokenPost.json +8 -1
  26. data/schemas/applicationDashboardPost.json +155 -24
  27. data/schemas/applicationExportPost.json +1 -0
  28. data/schemas/applicationSearchResult.json +2 -1
  29. data/schemas/applicationTemplateCategories.json +11 -0
  30. data/schemas/applicationTemplateCategory.json +11 -0
  31. data/schemas/dashboard.json +155 -24
  32. data/schemas/dashboardPatch.json +155 -24
  33. data/schemas/dashboardPost.json +155 -24
  34. data/schemas/dashboardSendReport.json +3 -0
  35. data/schemas/dashboards.json +155 -24
  36. data/schemas/dataExport.json +1 -0
  37. data/schemas/dataTableRowsExport.json +5 -0
  38. data/schemas/deviceRecipeBulkCreatePost.json +5 -0
  39. data/schemas/devicesDeletePost.json +269 -0
  40. data/schemas/devicesExportPayloadCountPost.json +265 -0
  41. data/schemas/devicesExportPost.json +265 -0
  42. data/schemas/devicesPatch.json +269 -0
  43. data/schemas/devicesRemoveDataPost.json +264 -0
  44. data/schemas/embeddedDeploymentExport.json +5 -0
  45. data/schemas/enableTwoFactorAuth.json +5 -1
  46. data/schemas/eventsExport.json +89 -0
  47. data/schemas/experienceLinkedResources.json +3 -0
  48. data/schemas/experienceUser.json +11 -0
  49. data/schemas/experienceUsers.json +11 -0
  50. data/schemas/experienceVersion.json +27 -0
  51. data/schemas/experienceVersionPatch.json +27 -0
  52. data/schemas/experienceVersionPost.json +39 -0
  53. data/schemas/experienceVersions.json +27 -0
  54. data/schemas/flow.json +1 -0
  55. data/schemas/flowPatch.json +1 -0
  56. data/schemas/flowPost.json +1 -0
  57. data/schemas/flowVersion.json +2 -0
  58. data/schemas/flowVersionPost.json +1 -0
  59. data/schemas/flowVersions.json +2 -0
  60. data/schemas/flowVersionsDeletePost.json +49 -0
  61. data/schemas/flows.json +1 -0
  62. data/schemas/flowsImportPost.json +2 -0
  63. data/schemas/flowsImportResult.json +3 -0
  64. data/schemas/githubLogin.json +8 -1
  65. data/schemas/importIntoApplicationOptions.json +58 -0
  66. data/schemas/importNewApplicationOptions.json +45 -0
  67. data/schemas/instance.json +1 -0
  68. data/schemas/instanceCustomNodePatch.json +1 -0
  69. data/schemas/instanceCustomNodePost.json +1 -0
  70. data/schemas/instanceOrg.json +30 -0
  71. data/schemas/instanceOrgPatch.json +29 -0
  72. data/schemas/instanceOrgPost.json +29 -0
  73. data/schemas/instanceOrgs.json +30 -0
  74. data/schemas/instancePatch.json +1 -0
  75. data/schemas/instanceReportOptionsPost.json +1 -0
  76. data/schemas/instanceSandbox.json +423 -0
  77. data/schemas/instanceSandboxes.json +48 -0
  78. data/schemas/integration.json +34 -1
  79. data/schemas/integrationPatch.json +34 -1
  80. data/schemas/integrationPost.json +34 -1
  81. data/schemas/integrations.json +34 -1
  82. data/schemas/multiDeviceCommand.json +264 -0
  83. data/schemas/notebookDataExportOptions.json +5 -0
  84. data/schemas/org.json +17 -0
  85. data/schemas/orgs.json +17 -0
  86. data/schemas/samlResponse.json +432 -0
  87. data/schemas/twoFactorAuthInfo.json +15 -0
  88. data/schemas/userCredentials.json +8 -1
  89. data/schemas/userPost.json +8 -1
  90. data/schemas/validateContextError.json +3 -0
  91. data/schemas/validateContextSuccess.json +27 -0
  92. metadata +12 -3
data/schemas/dashboardPost.json CHANGED
@@ -120,8 +120,18 @@
120
120
  "type": "boolean"
121
121
  },
122
122
  "duration": {
123
- "type": "integer",
124
- "minimum": 0
123
+ "oneOf": [
124
+ {
125
+ "type": "integer",
126
+ "minimum": 0
127
+ },
128
+ {
129
+ "type": "string",
130
+ "enum": [
131
+ "{{dashboard.duration}}"
132
+ ]
133
+ }
134
+ ]
125
135
  },
126
136
  "xAxisFormat": {
127
137
  "type": "string",
@@ -562,8 +572,18 @@
562
572
  }
563
573
  },
564
574
  "duration": {
565
- "type": "integer",
566
- "minimum": 0
575
+ "oneOf": [
576
+ {
577
+ "type": "integer",
578
+ "minimum": 0
579
+ },
580
+ {
581
+ "type": "string",
582
+ "enum": [
583
+ "{{dashboard.duration}}"
584
+ ]
585
+ }
586
+ ]
567
587
  },
568
588
  "resolution": {
569
589
  "oneOf": [
@@ -735,8 +755,18 @@
735
755
  }
736
756
  },
737
757
  "duration": {
738
- "type": "integer",
739
- "minimum": 0
758
+ "oneOf": [
759
+ {
760
+ "type": "integer",
761
+ "minimum": 0
762
+ },
763
+ {
764
+ "type": "string",
765
+ "enum": [
766
+ "{{dashboard.duration}}"
767
+ ]
768
+ }
769
+ ]
740
770
  }
741
771
  },
742
772
  "additionalProperties": false
@@ -1471,8 +1501,18 @@
1471
1501
  }
1472
1502
  },
1473
1503
  "duration": {
1474
- "type": "integer",
1475
- "minimum": 0
1504
+ "oneOf": [
1505
+ {
1506
+ "type": "integer",
1507
+ "minimum": 0
1508
+ },
1509
+ {
1510
+ "type": "string",
1511
+ "enum": [
1512
+ "{{dashboard.duration}}"
1513
+ ]
1514
+ }
1515
+ ]
1476
1516
  },
1477
1517
  "sortDirection": {
1478
1518
  "type": "integer",
@@ -1721,8 +1761,18 @@
1721
1761
  "type": "boolean"
1722
1762
  },
1723
1763
  "duration": {
1724
- "type": "integer",
1725
- "minimum": 0
1764
+ "oneOf": [
1765
+ {
1766
+ "type": "integer",
1767
+ "minimum": 0
1768
+ },
1769
+ {
1770
+ "type": "string",
1771
+ "enum": [
1772
+ "{{dashboard.duration}}"
1773
+ ]
1774
+ }
1775
+ ]
1726
1776
  },
1727
1777
  "gaugeMax": {
1728
1778
  "oneOf": [
@@ -2043,8 +2093,18 @@
2043
2093
  "type": "boolean"
2044
2094
  },
2045
2095
  "duration": {
2046
- "type": "integer",
2047
- "minimum": 0
2096
+ "oneOf": [
2097
+ {
2098
+ "type": "integer",
2099
+ "minimum": 0
2100
+ },
2101
+ {
2102
+ "type": "string",
2103
+ "enum": [
2104
+ "{{dashboard.duration}}"
2105
+ ]
2106
+ }
2107
+ ]
2048
2108
  },
2049
2109
  "resolution": {
2050
2110
  "oneOf": [
@@ -2419,8 +2479,18 @@
2419
2479
  }
2420
2480
  },
2421
2481
  "duration": {
2422
- "type": "integer",
2423
- "minimum": 0
2482
+ "oneOf": [
2483
+ {
2484
+ "type": "integer",
2485
+ "minimum": 0
2486
+ },
2487
+ {
2488
+ "type": "string",
2489
+ "enum": [
2490
+ "{{dashboard.duration}}"
2491
+ ]
2492
+ }
2493
+ ]
2424
2494
  },
2425
2495
  "locationTagKey": {
2426
2496
  "oneOf": [
@@ -2808,8 +2878,18 @@
2808
2878
  }
2809
2879
  },
2810
2880
  "duration": {
2811
- "type": "integer",
2812
- "minimum": 0
2881
+ "oneOf": [
2882
+ {
2883
+ "type": "integer",
2884
+ "minimum": 0
2885
+ },
2886
+ {
2887
+ "type": "string",
2888
+ "enum": [
2889
+ "{{dashboard.duration}}"
2890
+ ]
2891
+ }
2892
+ ]
2813
2893
  }
2814
2894
  },
2815
2895
  "additionalProperties": false
@@ -3264,8 +3344,18 @@
3264
3344
  "type": "boolean"
3265
3345
  },
3266
3346
  "duration": {
3267
- "type": "integer",
3268
- "minimum": 0
3347
+ "oneOf": [
3348
+ {
3349
+ "type": "integer",
3350
+ "minimum": 0
3351
+ },
3352
+ {
3353
+ "type": "string",
3354
+ "enum": [
3355
+ "{{dashboard.duration}}"
3356
+ ]
3357
+ }
3358
+ ]
3269
3359
  },
3270
3360
  "segments": {
3271
3361
  "type": "array",
@@ -4693,8 +4783,18 @@
4693
4783
  }
4694
4784
  },
4695
4785
  "duration": {
4696
- "type": "integer",
4697
- "minimum": 0
4786
+ "oneOf": [
4787
+ {
4788
+ "type": "integer",
4789
+ "minimum": 0
4790
+ },
4791
+ {
4792
+ "type": "string",
4793
+ "enum": [
4794
+ "{{dashboard.duration}}"
4795
+ ]
4796
+ }
4797
+ ]
4698
4798
  },
4699
4799
  "endColor": {
4700
4800
  "type": "string",
@@ -4889,8 +4989,18 @@
4889
4989
  "type": "boolean"
4890
4990
  },
4891
4991
  "duration": {
4892
- "type": "integer",
4893
- "minimum": 0
4992
+ "oneOf": [
4993
+ {
4994
+ "type": "integer",
4995
+ "minimum": 0
4996
+ },
4997
+ {
4998
+ "type": "string",
4999
+ "enum": [
5000
+ "{{dashboard.duration}}"
5001
+ ]
5002
+ }
5003
+ ]
4894
5004
  },
4895
5005
  "percentFormat": {
4896
5006
  "type": "string",
@@ -5204,8 +5314,18 @@
5204
5314
  }
5205
5315
  },
5206
5316
  "duration": {
5207
- "type": "integer",
5208
- "minimum": 0
5317
+ "oneOf": [
5318
+ {
5319
+ "type": "integer",
5320
+ "minimum": 0
5321
+ },
5322
+ {
5323
+ "type": "string",
5324
+ "enum": [
5325
+ "{{dashboard.duration}}"
5326
+ ]
5327
+ }
5328
+ ]
5209
5329
  },
5210
5330
  "endColor": {
5211
5331
  "type": "string",
@@ -5436,6 +5556,14 @@
5436
5556
  "minimum": 5,
5437
5557
  "maximum": 600
5438
5558
  },
5559
+ "duration": {
5560
+ "type": "integer",
5561
+ "minimum": 1
5562
+ },
5563
+ "resolution": {
5564
+ "type": "integer",
5565
+ "minimum": 1
5566
+ },
5439
5567
  "defaultTheme": {
5440
5568
  "type": "string",
5441
5569
  "enum": [
@@ -5497,6 +5625,9 @@
5497
5625
  },
5498
5626
  "ctx": {
5499
5627
  "ref": "#/definitions/dashboardContextInstance"
5628
+ },
5629
+ "branded": {
5630
+ "type": "boolean"
5500
5631
  }
5501
5632
  },
5502
5633
  "additionalProperties": false,
data/schemas/dashboardSendReport.json CHANGED
@@ -45,6 +45,9 @@
45
45
  },
46
46
  "ctx": {
47
47
  "ref": "#/definitions/dashboardContextInstance"
48
+ },
49
+ "branded": {
50
+ "type": "boolean"
48
51
  }
49
52
  },
50
53
  "anyOf": [
data/schemas/dashboards.json CHANGED
@@ -68,6 +68,14 @@
68
68
  "minimum": 5,
69
69
  "maximum": 600
70
70
  },
71
+ "duration": {
72
+ "type": "integer",
73
+ "minimum": 1
74
+ },
75
+ "resolution": {
76
+ "type": "integer",
77
+ "minimum": 1
78
+ },
71
79
  "defaultTheme": {
72
80
  "type": "string",
73
81
  "enum": [
@@ -135,6 +143,9 @@
135
143
  },
136
144
  "ctx": {
137
145
  "ref": "#/definitions/dashboardContextInstance"
146
+ },
147
+ "branded": {
148
+ "type": "boolean"
138
149
  }
139
150
  },
140
151
  "additionalProperties": false,
@@ -259,8 +270,18 @@
259
270
  "type": "boolean"
260
271
  },
261
272
  "duration": {
262
- "type": "integer",
263
- "minimum": 0
273
+ "oneOf": [
274
+ {
275
+ "type": "integer",
276
+ "minimum": 0
277
+ },
278
+ {
279
+ "type": "string",
280
+ "enum": [
281
+ "{{dashboard.duration}}"
282
+ ]
283
+ }
284
+ ]
264
285
  },
265
286
  "xAxisFormat": {
266
287
  "type": "string",
@@ -701,8 +722,18 @@
701
722
  }
702
723
  },
703
724
  "duration": {
704
- "type": "integer",
705
- "minimum": 0
725
+ "oneOf": [
726
+ {
727
+ "type": "integer",
728
+ "minimum": 0
729
+ },
730
+ {
731
+ "type": "string",
732
+ "enum": [
733
+ "{{dashboard.duration}}"
734
+ ]
735
+ }
736
+ ]
706
737
  },
707
738
  "resolution": {
708
739
  "oneOf": [
@@ -874,8 +905,18 @@
874
905
  }
875
906
  },
876
907
  "duration": {
877
- "type": "integer",
878
- "minimum": 0
908
+ "oneOf": [
909
+ {
910
+ "type": "integer",
911
+ "minimum": 0
912
+ },
913
+ {
914
+ "type": "string",
915
+ "enum": [
916
+ "{{dashboard.duration}}"
917
+ ]
918
+ }
919
+ ]
879
920
  }
880
921
  },
881
922
  "additionalProperties": false
@@ -1610,8 +1651,18 @@
1610
1651
  }
1611
1652
  },
1612
1653
  "duration": {
1613
- "type": "integer",
1614
- "minimum": 0
1654
+ "oneOf": [
1655
+ {
1656
+ "type": "integer",
1657
+ "minimum": 0
1658
+ },
1659
+ {
1660
+ "type": "string",
1661
+ "enum": [
1662
+ "{{dashboard.duration}}"
1663
+ ]
1664
+ }
1665
+ ]
1615
1666
  },
1616
1667
  "sortDirection": {
1617
1668
  "type": "integer",
@@ -1860,8 +1911,18 @@
1860
1911
  "type": "boolean"
1861
1912
  },
1862
1913
  "duration": {
1863
- "type": "integer",
1864
- "minimum": 0
1914
+ "oneOf": [
1915
+ {
1916
+ "type": "integer",
1917
+ "minimum": 0
1918
+ },
1919
+ {
1920
+ "type": "string",
1921
+ "enum": [
1922
+ "{{dashboard.duration}}"
1923
+ ]
1924
+ }
1925
+ ]
1865
1926
  },
1866
1927
  "gaugeMax": {
1867
1928
  "oneOf": [
@@ -2182,8 +2243,18 @@
2182
2243
  "type": "boolean"
2183
2244
  },
2184
2245
  "duration": {
2185
- "type": "integer",
2186
- "minimum": 0
2246
+ "oneOf": [
2247
+ {
2248
+ "type": "integer",
2249
+ "minimum": 0
2250
+ },
2251
+ {
2252
+ "type": "string",
2253
+ "enum": [
2254
+ "{{dashboard.duration}}"
2255
+ ]
2256
+ }
2257
+ ]
2187
2258
  },
2188
2259
  "resolution": {
2189
2260
  "oneOf": [
@@ -2558,8 +2629,18 @@
2558
2629
  }
2559
2630
  },
2560
2631
  "duration": {
2561
- "type": "integer",
2562
- "minimum": 0
2632
+ "oneOf": [
2633
+ {
2634
+ "type": "integer",
2635
+ "minimum": 0
2636
+ },
2637
+ {
2638
+ "type": "string",
2639
+ "enum": [
2640
+ "{{dashboard.duration}}"
2641
+ ]
2642
+ }
2643
+ ]
2563
2644
  },
2564
2645
  "locationTagKey": {
2565
2646
  "oneOf": [
@@ -2947,8 +3028,18 @@
2947
3028
  }
2948
3029
  },
2949
3030
  "duration": {
2950
- "type": "integer",
2951
- "minimum": 0
3031
+ "oneOf": [
3032
+ {
3033
+ "type": "integer",
3034
+ "minimum": 0
3035
+ },
3036
+ {
3037
+ "type": "string",
3038
+ "enum": [
3039
+ "{{dashboard.duration}}"
3040
+ ]
3041
+ }
3042
+ ]
2952
3043
  }
2953
3044
  },
2954
3045
  "additionalProperties": false
@@ -3403,8 +3494,18 @@
3403
3494
  "type": "boolean"
3404
3495
  },
3405
3496
  "duration": {
3406
- "type": "integer",
3407
- "minimum": 0
3497
+ "oneOf": [
3498
+ {
3499
+ "type": "integer",
3500
+ "minimum": 0
3501
+ },
3502
+ {
3503
+ "type": "string",
3504
+ "enum": [
3505
+ "{{dashboard.duration}}"
3506
+ ]
3507
+ }
3508
+ ]
3408
3509
  },
3409
3510
  "segments": {
3410
3511
  "type": "array",
@@ -4832,8 +4933,18 @@
4832
4933
  }
4833
4934
  },
4834
4935
  "duration": {
4835
- "type": "integer",
4836
- "minimum": 0
4936
+ "oneOf": [
4937
+ {
4938
+ "type": "integer",
4939
+ "minimum": 0
4940
+ },
4941
+ {
4942
+ "type": "string",
4943
+ "enum": [
4944
+ "{{dashboard.duration}}"
4945
+ ]
4946
+ }
4947
+ ]
4837
4948
  },
4838
4949
  "endColor": {
4839
4950
  "type": "string",
@@ -5028,8 +5139,18 @@
5028
5139
  "type": "boolean"
5029
5140
  },
5030
5141
  "duration": {
5031
- "type": "integer",
5032
- "minimum": 0
5142
+ "oneOf": [
5143
+ {
5144
+ "type": "integer",
5145
+ "minimum": 0
5146
+ },
5147
+ {
5148
+ "type": "string",
5149
+ "enum": [
5150
+ "{{dashboard.duration}}"
5151
+ ]
5152
+ }
5153
+ ]
5033
5154
  },
5034
5155
  "percentFormat": {
5035
5156
  "type": "string",
@@ -5343,8 +5464,18 @@
5343
5464
  }
5344
5465
  },
5345
5466
  "duration": {
5346
- "type": "integer",
5347
- "minimum": 0
5467
+ "oneOf": [
5468
+ {
5469
+ "type": "integer",
5470
+ "minimum": 0
5471
+ },
5472
+ {
5473
+ "type": "string",
5474
+ "enum": [
5475
+ "{{dashboard.duration}}"
5476
+ ]
5477
+ }
5478
+ ]
5348
5479
  },
5349
5480
  "endColor": {
5350
5481
  "type": "string",
data/schemas/dataExport.json CHANGED
@@ -9,6 +9,7 @@
9
9
  },
10
10
  "callbackUrl": {
11
11
  "type": "string",
12
+ "format": "uri",
12
13
  "maxLength": 1024
13
14
  },
14
15
  "deviceIds": {
data/schemas/dataTableRowsExport.json CHANGED
@@ -141,6 +141,11 @@
141
141
  },
142
142
  "additionalProperties": false
143
143
  },
144
+ "callbackUrl": {
145
+ "type": "string",
146
+ "format": "uri",
147
+ "maxLength": 1024
148
+ },
144
149
  "queryOptions": {
145
150
  "type": "object",
146
151
  "properties": {
data/schemas/deviceRecipeBulkCreatePost.json CHANGED
@@ -18,6 +18,11 @@
18
18
  "type": "string",
19
19
  "format": "email",
20
20
  "maxLength": 1024
21
+ },
22
+ "callbackUrl": {
23
+ "type": "string",
24
+ "format": "uri",
25
+ "maxLength": 1024
21
26
  }
22
27
  },
23
28
  "additionalProperties": false,