losant_rest 1.22.0 → 1.22.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/_schemas.md +766 -0
- data/lib/platform_rest/client.rb +2 -2
- data/lib/platform_rest/version.rb +1 -1
- data/schemas/apiTokenPost.json +1 -0
- data/schemas/applicationDashboardPost.json +120 -0
- data/schemas/dashboard.json +120 -0
- data/schemas/dashboardPatch.json +120 -0
- data/schemas/dashboardPost.json +120 -0
- data/schemas/dashboards.json +120 -0
- data/schemas/dataExport.json +4 -0
- data/schemas/devicesPatch.json +65 -0
- data/schemas/githubLogin.json +1 -0
- data/schemas/samlResponse.json +1 -0
- data/schemas/suggestFunctionPost.json +15 -0
- data/schemas/suggestFunctionResponse.json +37 -0
- data/schemas/userCredentials.json +1 -0
- data/schemas/userPost.json +1 -0
- metadata +4 -2
data/lib/platform_rest/client.rb
CHANGED
|
@@ -27,7 +27,7 @@ module PlatformRest
|
|
|
27
27
|
#
|
|
28
28
|
# User API for accessing platform data
|
|
29
29
|
#
|
|
30
|
-
# Built For Version 1.28.
|
|
30
|
+
# Built For Version 1.28.1
|
|
31
31
|
class Client
|
|
32
32
|
attr_accessor :auth_token, :url
|
|
33
33
|
|
|
@@ -414,7 +414,7 @@ module PlatformRest
|
|
|
414
414
|
|
|
415
415
|
headers["Accept"] = "application/json"
|
|
416
416
|
headers["Content-Type"] = "application/json"
|
|
417
|
-
headers["Accept-Version"] = "^1.28.
|
|
417
|
+
headers["Accept-Version"] = "^1.28.1"
|
|
418
418
|
headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
|
|
419
419
|
path = self.url + options.fetch(:path, "")
|
|
420
420
|
|
data/schemas/apiTokenPost.json
CHANGED
|
@@ -880,6 +880,45 @@
|
|
|
880
880
|
}
|
|
881
881
|
},
|
|
882
882
|
"additionalProperties": false
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"type": "object",
|
|
886
|
+
"properties": {
|
|
887
|
+
"queryType": {
|
|
888
|
+
"type": "string",
|
|
889
|
+
"enum": [
|
|
890
|
+
"events"
|
|
891
|
+
]
|
|
892
|
+
},
|
|
893
|
+
"id": {
|
|
894
|
+
"type": "string",
|
|
895
|
+
"maxLength": 48
|
|
896
|
+
},
|
|
897
|
+
"sortField": {
|
|
898
|
+
"type": "string",
|
|
899
|
+
"maxLength": 255
|
|
900
|
+
},
|
|
901
|
+
"sortDirection": {
|
|
902
|
+
"type": "string",
|
|
903
|
+
"maxLength": 255
|
|
904
|
+
},
|
|
905
|
+
"page": {
|
|
906
|
+
"type": "string",
|
|
907
|
+
"maxLength": 255
|
|
908
|
+
},
|
|
909
|
+
"perPage": {
|
|
910
|
+
"type": "string",
|
|
911
|
+
"maxLength": 255
|
|
912
|
+
},
|
|
913
|
+
"query": {
|
|
914
|
+
"type": "string",
|
|
915
|
+
"maxLength": 32767
|
|
916
|
+
},
|
|
917
|
+
"includeExtendedEventInfo": {
|
|
918
|
+
"type": "boolean"
|
|
919
|
+
}
|
|
920
|
+
},
|
|
921
|
+
"additionalProperties": false
|
|
883
922
|
}
|
|
884
923
|
]
|
|
885
924
|
}
|
|
@@ -2553,6 +2592,18 @@
|
|
|
2553
2592
|
"format": {
|
|
2554
2593
|
"type": "string",
|
|
2555
2594
|
"maxLength": 255
|
|
2595
|
+
},
|
|
2596
|
+
"scale": {
|
|
2597
|
+
"type": "string",
|
|
2598
|
+
"enum": [
|
|
2599
|
+
"linear",
|
|
2600
|
+
"log",
|
|
2601
|
+
"sqrt"
|
|
2602
|
+
],
|
|
2603
|
+
"default": "linear"
|
|
2604
|
+
},
|
|
2605
|
+
"stacked": {
|
|
2606
|
+
"type": "boolean"
|
|
2556
2607
|
}
|
|
2557
2608
|
},
|
|
2558
2609
|
"additionalProperties": false,
|
|
@@ -2560,6 +2611,75 @@
|
|
|
2560
2611
|
"id"
|
|
2561
2612
|
]
|
|
2562
2613
|
}
|
|
2614
|
+
},
|
|
2615
|
+
"decorators": {
|
|
2616
|
+
"type": "array",
|
|
2617
|
+
"maxItems": 10,
|
|
2618
|
+
"items": {
|
|
2619
|
+
"type": "object",
|
|
2620
|
+
"properties": {
|
|
2621
|
+
"type": {
|
|
2622
|
+
"type": "string",
|
|
2623
|
+
"enum": [
|
|
2624
|
+
"line",
|
|
2625
|
+
"area"
|
|
2626
|
+
]
|
|
2627
|
+
},
|
|
2628
|
+
"yAxisId": {
|
|
2629
|
+
"type": "string",
|
|
2630
|
+
"maxLength": 48
|
|
2631
|
+
},
|
|
2632
|
+
"label": {
|
|
2633
|
+
"type": "string",
|
|
2634
|
+
"maxLength": 255
|
|
2635
|
+
},
|
|
2636
|
+
"color": {
|
|
2637
|
+
"type": "string",
|
|
2638
|
+
"maxLength": 64
|
|
2639
|
+
},
|
|
2640
|
+
"lineStyle": {
|
|
2641
|
+
"type": "string",
|
|
2642
|
+
"enum": [
|
|
2643
|
+
"solid",
|
|
2644
|
+
"dotted",
|
|
2645
|
+
"dashed"
|
|
2646
|
+
]
|
|
2647
|
+
},
|
|
2648
|
+
"lineWeight": {
|
|
2649
|
+
"type": "integer",
|
|
2650
|
+
"minimum": 0,
|
|
2651
|
+
"maximum": 5
|
|
2652
|
+
},
|
|
2653
|
+
"y1": {
|
|
2654
|
+
"oneOf": [
|
|
2655
|
+
{
|
|
2656
|
+
"type": "number"
|
|
2657
|
+
},
|
|
2658
|
+
{
|
|
2659
|
+
"type": "string",
|
|
2660
|
+
"maxLength": 128
|
|
2661
|
+
}
|
|
2662
|
+
]
|
|
2663
|
+
},
|
|
2664
|
+
"y2": {
|
|
2665
|
+
"oneOf": [
|
|
2666
|
+
{
|
|
2667
|
+
"type": "number"
|
|
2668
|
+
},
|
|
2669
|
+
{
|
|
2670
|
+
"type": "string",
|
|
2671
|
+
"maxLength": 128
|
|
2672
|
+
}
|
|
2673
|
+
]
|
|
2674
|
+
}
|
|
2675
|
+
},
|
|
2676
|
+
"required": [
|
|
2677
|
+
"type",
|
|
2678
|
+
"yAxisId",
|
|
2679
|
+
"y1"
|
|
2680
|
+
],
|
|
2681
|
+
"additionalProperties": false
|
|
2682
|
+
}
|
|
2563
2683
|
}
|
|
2564
2684
|
},
|
|
2565
2685
|
"additionalProperties": false
|
data/schemas/dashboard.json
CHANGED
|
@@ -1086,6 +1086,45 @@
|
|
|
1086
1086
|
}
|
|
1087
1087
|
},
|
|
1088
1088
|
"additionalProperties": false
|
|
1089
|
+
},
|
|
1090
|
+
{
|
|
1091
|
+
"type": "object",
|
|
1092
|
+
"properties": {
|
|
1093
|
+
"queryType": {
|
|
1094
|
+
"type": "string",
|
|
1095
|
+
"enum": [
|
|
1096
|
+
"events"
|
|
1097
|
+
]
|
|
1098
|
+
},
|
|
1099
|
+
"id": {
|
|
1100
|
+
"type": "string",
|
|
1101
|
+
"maxLength": 48
|
|
1102
|
+
},
|
|
1103
|
+
"sortField": {
|
|
1104
|
+
"type": "string",
|
|
1105
|
+
"maxLength": 255
|
|
1106
|
+
},
|
|
1107
|
+
"sortDirection": {
|
|
1108
|
+
"type": "string",
|
|
1109
|
+
"maxLength": 255
|
|
1110
|
+
},
|
|
1111
|
+
"page": {
|
|
1112
|
+
"type": "string",
|
|
1113
|
+
"maxLength": 255
|
|
1114
|
+
},
|
|
1115
|
+
"perPage": {
|
|
1116
|
+
"type": "string",
|
|
1117
|
+
"maxLength": 255
|
|
1118
|
+
},
|
|
1119
|
+
"query": {
|
|
1120
|
+
"type": "string",
|
|
1121
|
+
"maxLength": 32767
|
|
1122
|
+
},
|
|
1123
|
+
"includeExtendedEventInfo": {
|
|
1124
|
+
"type": "boolean"
|
|
1125
|
+
}
|
|
1126
|
+
},
|
|
1127
|
+
"additionalProperties": false
|
|
1089
1128
|
}
|
|
1090
1129
|
]
|
|
1091
1130
|
}
|
|
@@ -2759,6 +2798,18 @@
|
|
|
2759
2798
|
"format": {
|
|
2760
2799
|
"type": "string",
|
|
2761
2800
|
"maxLength": 255
|
|
2801
|
+
},
|
|
2802
|
+
"scale": {
|
|
2803
|
+
"type": "string",
|
|
2804
|
+
"enum": [
|
|
2805
|
+
"linear",
|
|
2806
|
+
"log",
|
|
2807
|
+
"sqrt"
|
|
2808
|
+
],
|
|
2809
|
+
"default": "linear"
|
|
2810
|
+
},
|
|
2811
|
+
"stacked": {
|
|
2812
|
+
"type": "boolean"
|
|
2762
2813
|
}
|
|
2763
2814
|
},
|
|
2764
2815
|
"additionalProperties": false,
|
|
@@ -2766,6 +2817,75 @@
|
|
|
2766
2817
|
"id"
|
|
2767
2818
|
]
|
|
2768
2819
|
}
|
|
2820
|
+
},
|
|
2821
|
+
"decorators": {
|
|
2822
|
+
"type": "array",
|
|
2823
|
+
"maxItems": 10,
|
|
2824
|
+
"items": {
|
|
2825
|
+
"type": "object",
|
|
2826
|
+
"properties": {
|
|
2827
|
+
"type": {
|
|
2828
|
+
"type": "string",
|
|
2829
|
+
"enum": [
|
|
2830
|
+
"line",
|
|
2831
|
+
"area"
|
|
2832
|
+
]
|
|
2833
|
+
},
|
|
2834
|
+
"yAxisId": {
|
|
2835
|
+
"type": "string",
|
|
2836
|
+
"maxLength": 48
|
|
2837
|
+
},
|
|
2838
|
+
"label": {
|
|
2839
|
+
"type": "string",
|
|
2840
|
+
"maxLength": 255
|
|
2841
|
+
},
|
|
2842
|
+
"color": {
|
|
2843
|
+
"type": "string",
|
|
2844
|
+
"maxLength": 64
|
|
2845
|
+
},
|
|
2846
|
+
"lineStyle": {
|
|
2847
|
+
"type": "string",
|
|
2848
|
+
"enum": [
|
|
2849
|
+
"solid",
|
|
2850
|
+
"dotted",
|
|
2851
|
+
"dashed"
|
|
2852
|
+
]
|
|
2853
|
+
},
|
|
2854
|
+
"lineWeight": {
|
|
2855
|
+
"type": "integer",
|
|
2856
|
+
"minimum": 0,
|
|
2857
|
+
"maximum": 5
|
|
2858
|
+
},
|
|
2859
|
+
"y1": {
|
|
2860
|
+
"oneOf": [
|
|
2861
|
+
{
|
|
2862
|
+
"type": "number"
|
|
2863
|
+
},
|
|
2864
|
+
{
|
|
2865
|
+
"type": "string",
|
|
2866
|
+
"maxLength": 128
|
|
2867
|
+
}
|
|
2868
|
+
]
|
|
2869
|
+
},
|
|
2870
|
+
"y2": {
|
|
2871
|
+
"oneOf": [
|
|
2872
|
+
{
|
|
2873
|
+
"type": "number"
|
|
2874
|
+
},
|
|
2875
|
+
{
|
|
2876
|
+
"type": "string",
|
|
2877
|
+
"maxLength": 128
|
|
2878
|
+
}
|
|
2879
|
+
]
|
|
2880
|
+
}
|
|
2881
|
+
},
|
|
2882
|
+
"required": [
|
|
2883
|
+
"type",
|
|
2884
|
+
"yAxisId",
|
|
2885
|
+
"y1"
|
|
2886
|
+
],
|
|
2887
|
+
"additionalProperties": false
|
|
2888
|
+
}
|
|
2769
2889
|
}
|
|
2770
2890
|
},
|
|
2771
2891
|
"additionalProperties": false
|
data/schemas/dashboardPatch.json
CHANGED
|
@@ -880,6 +880,45 @@
|
|
|
880
880
|
}
|
|
881
881
|
},
|
|
882
882
|
"additionalProperties": false
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"type": "object",
|
|
886
|
+
"properties": {
|
|
887
|
+
"queryType": {
|
|
888
|
+
"type": "string",
|
|
889
|
+
"enum": [
|
|
890
|
+
"events"
|
|
891
|
+
]
|
|
892
|
+
},
|
|
893
|
+
"id": {
|
|
894
|
+
"type": "string",
|
|
895
|
+
"maxLength": 48
|
|
896
|
+
},
|
|
897
|
+
"sortField": {
|
|
898
|
+
"type": "string",
|
|
899
|
+
"maxLength": 255
|
|
900
|
+
},
|
|
901
|
+
"sortDirection": {
|
|
902
|
+
"type": "string",
|
|
903
|
+
"maxLength": 255
|
|
904
|
+
},
|
|
905
|
+
"page": {
|
|
906
|
+
"type": "string",
|
|
907
|
+
"maxLength": 255
|
|
908
|
+
},
|
|
909
|
+
"perPage": {
|
|
910
|
+
"type": "string",
|
|
911
|
+
"maxLength": 255
|
|
912
|
+
},
|
|
913
|
+
"query": {
|
|
914
|
+
"type": "string",
|
|
915
|
+
"maxLength": 32767
|
|
916
|
+
},
|
|
917
|
+
"includeExtendedEventInfo": {
|
|
918
|
+
"type": "boolean"
|
|
919
|
+
}
|
|
920
|
+
},
|
|
921
|
+
"additionalProperties": false
|
|
883
922
|
}
|
|
884
923
|
]
|
|
885
924
|
}
|
|
@@ -2553,6 +2592,18 @@
|
|
|
2553
2592
|
"format": {
|
|
2554
2593
|
"type": "string",
|
|
2555
2594
|
"maxLength": 255
|
|
2595
|
+
},
|
|
2596
|
+
"scale": {
|
|
2597
|
+
"type": "string",
|
|
2598
|
+
"enum": [
|
|
2599
|
+
"linear",
|
|
2600
|
+
"log",
|
|
2601
|
+
"sqrt"
|
|
2602
|
+
],
|
|
2603
|
+
"default": "linear"
|
|
2604
|
+
},
|
|
2605
|
+
"stacked": {
|
|
2606
|
+
"type": "boolean"
|
|
2556
2607
|
}
|
|
2557
2608
|
},
|
|
2558
2609
|
"additionalProperties": false,
|
|
@@ -2560,6 +2611,75 @@
|
|
|
2560
2611
|
"id"
|
|
2561
2612
|
]
|
|
2562
2613
|
}
|
|
2614
|
+
},
|
|
2615
|
+
"decorators": {
|
|
2616
|
+
"type": "array",
|
|
2617
|
+
"maxItems": 10,
|
|
2618
|
+
"items": {
|
|
2619
|
+
"type": "object",
|
|
2620
|
+
"properties": {
|
|
2621
|
+
"type": {
|
|
2622
|
+
"type": "string",
|
|
2623
|
+
"enum": [
|
|
2624
|
+
"line",
|
|
2625
|
+
"area"
|
|
2626
|
+
]
|
|
2627
|
+
},
|
|
2628
|
+
"yAxisId": {
|
|
2629
|
+
"type": "string",
|
|
2630
|
+
"maxLength": 48
|
|
2631
|
+
},
|
|
2632
|
+
"label": {
|
|
2633
|
+
"type": "string",
|
|
2634
|
+
"maxLength": 255
|
|
2635
|
+
},
|
|
2636
|
+
"color": {
|
|
2637
|
+
"type": "string",
|
|
2638
|
+
"maxLength": 64
|
|
2639
|
+
},
|
|
2640
|
+
"lineStyle": {
|
|
2641
|
+
"type": "string",
|
|
2642
|
+
"enum": [
|
|
2643
|
+
"solid",
|
|
2644
|
+
"dotted",
|
|
2645
|
+
"dashed"
|
|
2646
|
+
]
|
|
2647
|
+
},
|
|
2648
|
+
"lineWeight": {
|
|
2649
|
+
"type": "integer",
|
|
2650
|
+
"minimum": 0,
|
|
2651
|
+
"maximum": 5
|
|
2652
|
+
},
|
|
2653
|
+
"y1": {
|
|
2654
|
+
"oneOf": [
|
|
2655
|
+
{
|
|
2656
|
+
"type": "number"
|
|
2657
|
+
},
|
|
2658
|
+
{
|
|
2659
|
+
"type": "string",
|
|
2660
|
+
"maxLength": 128
|
|
2661
|
+
}
|
|
2662
|
+
]
|
|
2663
|
+
},
|
|
2664
|
+
"y2": {
|
|
2665
|
+
"oneOf": [
|
|
2666
|
+
{
|
|
2667
|
+
"type": "number"
|
|
2668
|
+
},
|
|
2669
|
+
{
|
|
2670
|
+
"type": "string",
|
|
2671
|
+
"maxLength": 128
|
|
2672
|
+
}
|
|
2673
|
+
]
|
|
2674
|
+
}
|
|
2675
|
+
},
|
|
2676
|
+
"required": [
|
|
2677
|
+
"type",
|
|
2678
|
+
"yAxisId",
|
|
2679
|
+
"y1"
|
|
2680
|
+
],
|
|
2681
|
+
"additionalProperties": false
|
|
2682
|
+
}
|
|
2563
2683
|
}
|
|
2564
2684
|
},
|
|
2565
2685
|
"additionalProperties": false
|
data/schemas/dashboardPost.json
CHANGED
|
@@ -888,6 +888,45 @@
|
|
|
888
888
|
}
|
|
889
889
|
},
|
|
890
890
|
"additionalProperties": false
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
"type": "object",
|
|
894
|
+
"properties": {
|
|
895
|
+
"queryType": {
|
|
896
|
+
"type": "string",
|
|
897
|
+
"enum": [
|
|
898
|
+
"events"
|
|
899
|
+
]
|
|
900
|
+
},
|
|
901
|
+
"id": {
|
|
902
|
+
"type": "string",
|
|
903
|
+
"maxLength": 48
|
|
904
|
+
},
|
|
905
|
+
"sortField": {
|
|
906
|
+
"type": "string",
|
|
907
|
+
"maxLength": 255
|
|
908
|
+
},
|
|
909
|
+
"sortDirection": {
|
|
910
|
+
"type": "string",
|
|
911
|
+
"maxLength": 255
|
|
912
|
+
},
|
|
913
|
+
"page": {
|
|
914
|
+
"type": "string",
|
|
915
|
+
"maxLength": 255
|
|
916
|
+
},
|
|
917
|
+
"perPage": {
|
|
918
|
+
"type": "string",
|
|
919
|
+
"maxLength": 255
|
|
920
|
+
},
|
|
921
|
+
"query": {
|
|
922
|
+
"type": "string",
|
|
923
|
+
"maxLength": 32767
|
|
924
|
+
},
|
|
925
|
+
"includeExtendedEventInfo": {
|
|
926
|
+
"type": "boolean"
|
|
927
|
+
}
|
|
928
|
+
},
|
|
929
|
+
"additionalProperties": false
|
|
891
930
|
}
|
|
892
931
|
]
|
|
893
932
|
}
|
|
@@ -2561,6 +2600,18 @@
|
|
|
2561
2600
|
"format": {
|
|
2562
2601
|
"type": "string",
|
|
2563
2602
|
"maxLength": 255
|
|
2603
|
+
},
|
|
2604
|
+
"scale": {
|
|
2605
|
+
"type": "string",
|
|
2606
|
+
"enum": [
|
|
2607
|
+
"linear",
|
|
2608
|
+
"log",
|
|
2609
|
+
"sqrt"
|
|
2610
|
+
],
|
|
2611
|
+
"default": "linear"
|
|
2612
|
+
},
|
|
2613
|
+
"stacked": {
|
|
2614
|
+
"type": "boolean"
|
|
2564
2615
|
}
|
|
2565
2616
|
},
|
|
2566
2617
|
"additionalProperties": false,
|
|
@@ -2568,6 +2619,75 @@
|
|
|
2568
2619
|
"id"
|
|
2569
2620
|
]
|
|
2570
2621
|
}
|
|
2622
|
+
},
|
|
2623
|
+
"decorators": {
|
|
2624
|
+
"type": "array",
|
|
2625
|
+
"maxItems": 10,
|
|
2626
|
+
"items": {
|
|
2627
|
+
"type": "object",
|
|
2628
|
+
"properties": {
|
|
2629
|
+
"type": {
|
|
2630
|
+
"type": "string",
|
|
2631
|
+
"enum": [
|
|
2632
|
+
"line",
|
|
2633
|
+
"area"
|
|
2634
|
+
]
|
|
2635
|
+
},
|
|
2636
|
+
"yAxisId": {
|
|
2637
|
+
"type": "string",
|
|
2638
|
+
"maxLength": 48
|
|
2639
|
+
},
|
|
2640
|
+
"label": {
|
|
2641
|
+
"type": "string",
|
|
2642
|
+
"maxLength": 255
|
|
2643
|
+
},
|
|
2644
|
+
"color": {
|
|
2645
|
+
"type": "string",
|
|
2646
|
+
"maxLength": 64
|
|
2647
|
+
},
|
|
2648
|
+
"lineStyle": {
|
|
2649
|
+
"type": "string",
|
|
2650
|
+
"enum": [
|
|
2651
|
+
"solid",
|
|
2652
|
+
"dotted",
|
|
2653
|
+
"dashed"
|
|
2654
|
+
]
|
|
2655
|
+
},
|
|
2656
|
+
"lineWeight": {
|
|
2657
|
+
"type": "integer",
|
|
2658
|
+
"minimum": 0,
|
|
2659
|
+
"maximum": 5
|
|
2660
|
+
},
|
|
2661
|
+
"y1": {
|
|
2662
|
+
"oneOf": [
|
|
2663
|
+
{
|
|
2664
|
+
"type": "number"
|
|
2665
|
+
},
|
|
2666
|
+
{
|
|
2667
|
+
"type": "string",
|
|
2668
|
+
"maxLength": 128
|
|
2669
|
+
}
|
|
2670
|
+
]
|
|
2671
|
+
},
|
|
2672
|
+
"y2": {
|
|
2673
|
+
"oneOf": [
|
|
2674
|
+
{
|
|
2675
|
+
"type": "number"
|
|
2676
|
+
},
|
|
2677
|
+
{
|
|
2678
|
+
"type": "string",
|
|
2679
|
+
"maxLength": 128
|
|
2680
|
+
}
|
|
2681
|
+
]
|
|
2682
|
+
}
|
|
2683
|
+
},
|
|
2684
|
+
"required": [
|
|
2685
|
+
"type",
|
|
2686
|
+
"yAxisId",
|
|
2687
|
+
"y1"
|
|
2688
|
+
],
|
|
2689
|
+
"additionalProperties": false
|
|
2690
|
+
}
|
|
2571
2691
|
}
|
|
2572
2692
|
},
|
|
2573
2693
|
"additionalProperties": false
|