losant_rest 1.21.3 → 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.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +1796 -152
  3. data/docs/deviceAttribute.md +139 -0
  4. data/docs/deviceAttributes.md +96 -0
  5. data/lib/platform_rest/client.rb +10 -2
  6. data/lib/platform_rest/device_attribute.rb +182 -0
  7. data/lib/platform_rest/device_attributes.rb +138 -0
  8. data/lib/platform_rest/version.rb +1 -1
  9. data/lib/platform_rest.rb +2 -0
  10. data/schemas/apiTokenPost.json +8 -0
  11. data/schemas/applicationDashboardPost.json +120 -0
  12. data/schemas/applicationExportPost.json +29 -0
  13. data/schemas/applicationImportExecutions.json +18 -1
  14. data/schemas/credential.json +39 -1
  15. data/schemas/credentialPatch.json +37 -0
  16. data/schemas/credentialPost.json +54 -1
  17. data/schemas/credentials.json +39 -1
  18. data/schemas/dashboard.json +120 -0
  19. data/schemas/dashboardPatch.json +120 -0
  20. data/schemas/dashboardPost.json +120 -0
  21. data/schemas/dashboards.json +120 -0
  22. data/schemas/dataExport.json +4 -0
  23. data/schemas/device.json +0 -1
  24. data/schemas/deviceAttribute.json +128 -0
  25. data/schemas/deviceAttributePatch.json +111 -0
  26. data/schemas/deviceAttributePost.json +125 -0
  27. data/schemas/deviceAttributes.json +171 -0
  28. data/schemas/devicePatch.json +0 -1
  29. data/schemas/devicePost.json +0 -1
  30. data/schemas/deviceRecipe.json +0 -1
  31. data/schemas/deviceRecipePatch.json +0 -1
  32. data/schemas/deviceRecipePost.json +0 -1
  33. data/schemas/deviceRecipes.json +0 -1
  34. data/schemas/devices.json +0 -1
  35. data/schemas/devicesPatch.json +65 -3
  36. data/schemas/githubLogin.json +8 -0
  37. data/schemas/importIntoApplicationOptions.json +17 -0
  38. data/schemas/samlResponse.json +8 -0
  39. data/schemas/suggestFunctionPost.json +15 -0
  40. data/schemas/suggestFunctionResponse.json +37 -0
  41. data/schemas/userCredentials.json +8 -0
  42. data/schemas/userPost.json +8 -0
  43. metadata +12 -2
@@ -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
@@ -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
@@ -1093,6 +1093,45 @@
1093
1093
  }
1094
1094
  },
1095
1095
  "additionalProperties": false
1096
+ },
1097
+ {
1098
+ "type": "object",
1099
+ "properties": {
1100
+ "queryType": {
1101
+ "type": "string",
1102
+ "enum": [
1103
+ "events"
1104
+ ]
1105
+ },
1106
+ "id": {
1107
+ "type": "string",
1108
+ "maxLength": 48
1109
+ },
1110
+ "sortField": {
1111
+ "type": "string",
1112
+ "maxLength": 255
1113
+ },
1114
+ "sortDirection": {
1115
+ "type": "string",
1116
+ "maxLength": 255
1117
+ },
1118
+ "page": {
1119
+ "type": "string",
1120
+ "maxLength": 255
1121
+ },
1122
+ "perPage": {
1123
+ "type": "string",
1124
+ "maxLength": 255
1125
+ },
1126
+ "query": {
1127
+ "type": "string",
1128
+ "maxLength": 32767
1129
+ },
1130
+ "includeExtendedEventInfo": {
1131
+ "type": "boolean"
1132
+ }
1133
+ },
1134
+ "additionalProperties": false
1096
1135
  }
1097
1136
  ]
1098
1137
  }
@@ -2766,6 +2805,18 @@
2766
2805
  "format": {
2767
2806
  "type": "string",
2768
2807
  "maxLength": 255
2808
+ },
2809
+ "scale": {
2810
+ "type": "string",
2811
+ "enum": [
2812
+ "linear",
2813
+ "log",
2814
+ "sqrt"
2815
+ ],
2816
+ "default": "linear"
2817
+ },
2818
+ "stacked": {
2819
+ "type": "boolean"
2769
2820
  }
2770
2821
  },
2771
2822
  "additionalProperties": false,
@@ -2773,6 +2824,75 @@
2773
2824
  "id"
2774
2825
  ]
2775
2826
  }
2827
+ },
2828
+ "decorators": {
2829
+ "type": "array",
2830
+ "maxItems": 10,
2831
+ "items": {
2832
+ "type": "object",
2833
+ "properties": {
2834
+ "type": {
2835
+ "type": "string",
2836
+ "enum": [
2837
+ "line",
2838
+ "area"
2839
+ ]
2840
+ },
2841
+ "yAxisId": {
2842
+ "type": "string",
2843
+ "maxLength": 48
2844
+ },
2845
+ "label": {
2846
+ "type": "string",
2847
+ "maxLength": 255
2848
+ },
2849
+ "color": {
2850
+ "type": "string",
2851
+ "maxLength": 64
2852
+ },
2853
+ "lineStyle": {
2854
+ "type": "string",
2855
+ "enum": [
2856
+ "solid",
2857
+ "dotted",
2858
+ "dashed"
2859
+ ]
2860
+ },
2861
+ "lineWeight": {
2862
+ "type": "integer",
2863
+ "minimum": 0,
2864
+ "maximum": 5
2865
+ },
2866
+ "y1": {
2867
+ "oneOf": [
2868
+ {
2869
+ "type": "number"
2870
+ },
2871
+ {
2872
+ "type": "string",
2873
+ "maxLength": 128
2874
+ }
2875
+ ]
2876
+ },
2877
+ "y2": {
2878
+ "oneOf": [
2879
+ {
2880
+ "type": "number"
2881
+ },
2882
+ {
2883
+ "type": "string",
2884
+ "maxLength": 128
2885
+ }
2886
+ ]
2887
+ }
2888
+ },
2889
+ "required": [
2890
+ "type",
2891
+ "yAxisId",
2892
+ "y1"
2893
+ ],
2894
+ "additionalProperties": false
2895
+ }
2776
2896
  }
2777
2897
  },
2778
2898
  "additionalProperties": false
@@ -2104,6 +2104,10 @@
2104
2104
  "includeBlobData": {
2105
2105
  "type": "boolean",
2106
2106
  "default": false
2107
+ },
2108
+ "filePerDevice": {
2109
+ "type": "boolean",
2110
+ "default": false
2107
2111
  }
2108
2112
  }
2109
2113
  }
data/schemas/device.json CHANGED
@@ -119,7 +119,6 @@
119
119
  "type": "object",
120
120
  "additionalProperties": false
121
121
  },
122
- "additionalProperties": false,
123
122
  "maxItems": 0
124
123
  },
125
124
  "childAttributes": {
@@ -0,0 +1,128 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
8
+ },
9
+ "dataType": {
10
+ "type": "string",
11
+ "enum": [
12
+ "string",
13
+ "number",
14
+ "gps",
15
+ "boolean",
16
+ "blob"
17
+ ]
18
+ },
19
+ "contentType": {
20
+ "type": "string",
21
+ "maxLength": 64
22
+ },
23
+ "description": {
24
+ "type": "string",
25
+ "maxLength": 32767
26
+ },
27
+ "attributeTags": {
28
+ "type": "object",
29
+ "patternProperties": {
30
+ "^[0-9a-zA-Z_-]{1,255}$": {
31
+ "type": "string",
32
+ "minLength": 1,
33
+ "maxLength": 255
34
+ }
35
+ },
36
+ "additionalProperties": false
37
+ },
38
+ "system": {
39
+ "type": "object",
40
+ "properties": {
41
+ "aggregation": {
42
+ "type": "string",
43
+ "enum": [
44
+ "FIRST",
45
+ "LAST",
46
+ "COUNT",
47
+ "MAX",
48
+ "MIN",
49
+ "MEDIAN",
50
+ "MEAN",
51
+ "SUM",
52
+ "STD_DEV"
53
+ ]
54
+ },
55
+ "aggregationOptions": {
56
+ "type": "array",
57
+ "items": {
58
+ "type": "object",
59
+ "additionalProperties": false
60
+ },
61
+ "maxItems": 0
62
+ },
63
+ "childAttributes": {
64
+ "type": "array",
65
+ "items": {
66
+ "type": "object",
67
+ "properties": {
68
+ "name": {
69
+ "type": "string",
70
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
71
+ },
72
+ "mode": {
73
+ "type": "string",
74
+ "enum": [
75
+ "all",
76
+ "whitelist",
77
+ "blacklist"
78
+ ]
79
+ },
80
+ "deviceIds": {
81
+ "type": "array",
82
+ "items": {
83
+ "type": "string",
84
+ "pattern": "^[A-Fa-f\\d]{24}$"
85
+ },
86
+ "maxItems": 1000
87
+ },
88
+ "deviceTags": {
89
+ "type": "array",
90
+ "items": {
91
+ "type": "object",
92
+ "properties": {
93
+ "key": {
94
+ "type": "string",
95
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
96
+ },
97
+ "value": {
98
+ "type": "string",
99
+ "minLength": 1,
100
+ "maxLength": 255
101
+ }
102
+ },
103
+ "additionalProperties": false
104
+ },
105
+ "maxItems": 100
106
+ }
107
+ },
108
+ "required": [
109
+ "name",
110
+ "mode"
111
+ ],
112
+ "additionalProperties": false
113
+ },
114
+ "maxItems": 256
115
+ }
116
+ },
117
+ "additionalProperties": false
118
+ },
119
+ "applicationId": {
120
+ "type": "string",
121
+ "pattern": "^[A-Fa-f\\d]{24}$"
122
+ },
123
+ "deviceId": {
124
+ "type": "string",
125
+ "pattern": "^[A-Fa-f\\d]{24}$"
126
+ }
127
+ }
128
+ }
@@ -0,0 +1,111 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
8
+ },
9
+ "contentType": {
10
+ "type": "string",
11
+ "maxLength": 64
12
+ },
13
+ "description": {
14
+ "type": "string",
15
+ "maxLength": 32767
16
+ },
17
+ "attributeTags": {
18
+ "type": "object",
19
+ "patternProperties": {
20
+ "^[0-9a-zA-Z_-]{1,255}$": {
21
+ "type": "string",
22
+ "minLength": 1,
23
+ "maxLength": 255
24
+ }
25
+ },
26
+ "additionalProperties": false
27
+ },
28
+ "system": {
29
+ "type": "object",
30
+ "properties": {
31
+ "aggregation": {
32
+ "type": "string",
33
+ "enum": [
34
+ "FIRST",
35
+ "LAST",
36
+ "COUNT",
37
+ "MAX",
38
+ "MIN",
39
+ "MEDIAN",
40
+ "MEAN",
41
+ "SUM",
42
+ "STD_DEV"
43
+ ]
44
+ },
45
+ "aggregationOptions": {
46
+ "type": "array",
47
+ "items": {
48
+ "type": "object",
49
+ "additionalProperties": false
50
+ },
51
+ "maxItems": 0
52
+ },
53
+ "childAttributes": {
54
+ "type": "array",
55
+ "items": {
56
+ "type": "object",
57
+ "properties": {
58
+ "name": {
59
+ "type": "string",
60
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
61
+ },
62
+ "mode": {
63
+ "type": "string",
64
+ "enum": [
65
+ "all",
66
+ "whitelist",
67
+ "blacklist"
68
+ ]
69
+ },
70
+ "deviceIds": {
71
+ "type": "array",
72
+ "items": {
73
+ "type": "string",
74
+ "pattern": "^[A-Fa-f\\d]{24}$"
75
+ },
76
+ "maxItems": 1000
77
+ },
78
+ "deviceTags": {
79
+ "type": "array",
80
+ "items": {
81
+ "type": "object",
82
+ "properties": {
83
+ "key": {
84
+ "type": "string",
85
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
86
+ },
87
+ "value": {
88
+ "type": "string",
89
+ "minLength": 1,
90
+ "maxLength": 255
91
+ }
92
+ },
93
+ "additionalProperties": false
94
+ },
95
+ "maxItems": 100
96
+ }
97
+ },
98
+ "required": [
99
+ "name",
100
+ "mode"
101
+ ],
102
+ "additionalProperties": false
103
+ },
104
+ "maxItems": 256
105
+ }
106
+ },
107
+ "additionalProperties": false
108
+ }
109
+ },
110
+ "additionalProperties": false
111
+ }