losant_rest 1.22.0 → 1.22.2

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 (40) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +8258 -5884
  3. data/docs/applicationJobLog.md +49 -0
  4. data/docs/applicationJobLogs.md +51 -0
  5. data/docs/data.md +1 -1
  6. data/docs/device.md +1 -0
  7. data/docs/events.md +3 -0
  8. data/lib/platform_rest/application_job_log.rb +81 -0
  9. data/lib/platform_rest/application_job_logs.rb +90 -0
  10. data/lib/platform_rest/client.rb +10 -2
  11. data/lib/platform_rest/data.rb +1 -1
  12. data/lib/platform_rest/device.rb +2 -0
  13. data/lib/platform_rest/events.rb +5 -0
  14. data/lib/platform_rest/version.rb +1 -1
  15. data/lib/platform_rest.rb +2 -0
  16. data/schemas/advancedApplicationJobLogQuery.json +855 -0
  17. data/schemas/apiTokenPost.json +5 -0
  18. data/schemas/application.json +4 -0
  19. data/schemas/applicationCreationByTemplateResult.json +4 -0
  20. data/schemas/applicationDashboardPost.json +120 -0
  21. data/schemas/applicationJobLog.json +250 -0
  22. data/schemas/applicationJobLogs.json +292 -0
  23. data/schemas/applicationPatch.json +4 -0
  24. data/schemas/applicationPost.json +4 -0
  25. data/schemas/applications.json +4 -0
  26. data/schemas/dashboard.json +120 -0
  27. data/schemas/dashboardPatch.json +120 -0
  28. data/schemas/dashboardPost.json +120 -0
  29. data/schemas/dashboards.json +120 -0
  30. data/schemas/dataExport.json +4 -0
  31. data/schemas/deviceDataExport.json +48 -0
  32. data/schemas/devicesDataExport.json +2116 -0
  33. data/schemas/devicesPatch.json +65 -0
  34. data/schemas/githubLogin.json +5 -0
  35. data/schemas/samlResponse.json +5 -0
  36. data/schemas/suggestFunctionPost.json +15 -0
  37. data/schemas/suggestFunctionResponse.json +37 -0
  38. data/schemas/userCredentials.json +5 -0
  39. data/schemas/userPost.json +5 -0
  40. metadata +13 -2
@@ -0,0 +1,292 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Application Job Log",
9
+ "description": "Schema for a single Application Job Log",
10
+ "type": "object",
11
+ "properties": {
12
+ "id": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "jobId": {
17
+ "type": "string",
18
+ "pattern": "^[A-Fa-f\\d]{24}$"
19
+ },
20
+ "jobExecutionId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ },
24
+ "name": {
25
+ "type": "string"
26
+ },
27
+ "applicationId": {
28
+ "type": "string",
29
+ "pattern": "^[A-Fa-f\\d]{24}$"
30
+ },
31
+ "runQueuedAt": {
32
+ "type": "string",
33
+ "format": "date-time"
34
+ },
35
+ "runStartedAt": {
36
+ "type": "string",
37
+ "format": "date-time"
38
+ },
39
+ "runCompletedAt": {
40
+ "type": "string",
41
+ "format": "date-time"
42
+ },
43
+ "status": {
44
+ "type": "string",
45
+ "enum": [
46
+ "queued",
47
+ "inProgress",
48
+ "completed",
49
+ "errored",
50
+ "failed"
51
+ ]
52
+ },
53
+ "requestedById": {
54
+ "type": "string",
55
+ "pattern": "^[A-Fa-f\\d]{24}$"
56
+ },
57
+ "requestedByType": {
58
+ "type": "string",
59
+ "enum": [
60
+ "user",
61
+ "apiToken",
62
+ "flow",
63
+ "device",
64
+ "system"
65
+ ]
66
+ },
67
+ "ownerType": {
68
+ "type": "string",
69
+ "enum": [
70
+ "application",
71
+ "user",
72
+ "organization"
73
+ ]
74
+ },
75
+ "ownerId": {
76
+ "type": "string",
77
+ "pattern": "^[A-Fa-f\\d]{24}$"
78
+ },
79
+ "resourceType": {
80
+ "type": "string",
81
+ "enum": [
82
+ "application",
83
+ "dashboard",
84
+ "datatable",
85
+ "event",
86
+ "device",
87
+ "notebook",
88
+ "deviceRecipe"
89
+ ]
90
+ },
91
+ "resourceId": {
92
+ "type": "string",
93
+ "pattern": "^[A-Fa-f\\d]{24}$"
94
+ },
95
+ "progress": {
96
+ "type": "object",
97
+ "properties": {
98
+ "completed": {
99
+ "type": "number"
100
+ },
101
+ "total": {
102
+ "type": "number"
103
+ },
104
+ "status": {
105
+ "type": "string"
106
+ }
107
+ }
108
+ },
109
+ "error": {
110
+ "type": "object",
111
+ "properties": {
112
+ "name": {
113
+ "type": "string"
114
+ },
115
+ "message": {
116
+ "type": "string"
117
+ }
118
+ }
119
+ },
120
+ "input": {
121
+ "callbackUrl": {
122
+ "type": "string",
123
+ "format": "uri",
124
+ "maxLength": 1024
125
+ },
126
+ "emails": {
127
+ "type": "array",
128
+ "items": {
129
+ "type": "string",
130
+ "format": "email",
131
+ "maxLength": 1024
132
+ }
133
+ },
134
+ "start": {
135
+ "type": "number"
136
+ },
137
+ "end": {
138
+ "type": "number"
139
+ },
140
+ "gatewayId": {
141
+ "type": "string",
142
+ "pattern": "^[A-Fa-f\\d]{24}$"
143
+ },
144
+ "parentId": {
145
+ "type": "string",
146
+ "pattern": "^[A-Fa-f\\d]{24}$"
147
+ },
148
+ "query": {
149
+ "type": "string"
150
+ },
151
+ "ownerId": {
152
+ "type": "string",
153
+ "pattern": "^[A-Fa-f\\d]{24}$"
154
+ },
155
+ "ownerType": {
156
+ "type": "string",
157
+ "enum": [
158
+ "user",
159
+ "organization"
160
+ ]
161
+ },
162
+ "fileUrl": {
163
+ "type": "string",
164
+ "format": "uri",
165
+ "maxLength": 1024
166
+ },
167
+ "templateContext": {
168
+ "type": "string"
169
+ }
170
+ },
171
+ "output": {
172
+ "downloadUrls": {
173
+ "type": "array",
174
+ "items": {
175
+ "type": "string",
176
+ "format": "uri",
177
+ "maxLength": 1024
178
+ }
179
+ },
180
+ "devicesDirectory": {
181
+ "type": "string"
182
+ },
183
+ "eventsDirectory": {
184
+ "type": "string"
185
+ },
186
+ "dataTablesDirectory": {
187
+ "type": "string"
188
+ },
189
+ "created": {
190
+ "type": "number"
191
+ },
192
+ "failed": {
193
+ "type": "number"
194
+ },
195
+ "removed": {
196
+ "type": "number"
197
+ },
198
+ "restored": {
199
+ "type": "number"
200
+ },
201
+ "repoUrl": {
202
+ "type": "string"
203
+ },
204
+ "commit": {
205
+ "type": "string"
206
+ },
207
+ "noChanges": {
208
+ "type": "boolean"
209
+ },
210
+ "applicationId": {
211
+ "type": "string",
212
+ "pattern": "^[A-Fa-f\\d]{24}$"
213
+ },
214
+ "validationErrors": {
215
+ "type": "array",
216
+ "items": {
217
+ "type": "object",
218
+ "properties": {
219
+ "type": {
220
+ "type": "string"
221
+ },
222
+ "name": {
223
+ "type": "string"
224
+ },
225
+ "id": {
226
+ "type": "string"
227
+ },
228
+ "message": {
229
+ "type": "string"
230
+ }
231
+ }
232
+ }
233
+ },
234
+ "skippedDeviceNotFound": {
235
+ "type": "number"
236
+ },
237
+ "skippedDateTooOld": {
238
+ "type": "number"
239
+ },
240
+ "skippedDateInFuture": {
241
+ "type": "number"
242
+ },
243
+ "skippedInvalidDate": {
244
+ "type": "number"
245
+ },
246
+ "skippedNoValidAttributes": {
247
+ "type": "number"
248
+ },
249
+ "written": {
250
+ "type": "number"
251
+ },
252
+ "eeaBundleVersion": {
253
+ "type": "string"
254
+ }
255
+ }
256
+ }
257
+ }
258
+ },
259
+ "count": {
260
+ "type": "integer"
261
+ },
262
+ "totalCount": {
263
+ "type": "integer"
264
+ },
265
+ "query": {
266
+ "type": "object"
267
+ },
268
+ "perPage": {
269
+ "type": "integer"
270
+ },
271
+ "page": {
272
+ "type": "integer"
273
+ },
274
+ "sortField": {
275
+ "type": "string"
276
+ },
277
+ "sortDirection": {
278
+ "type": "string",
279
+ "enum": [
280
+ "asc",
281
+ "desc",
282
+ "ASC",
283
+ "DESC",
284
+ ""
285
+ ]
286
+ },
287
+ "applicationId": {
288
+ "type": "string",
289
+ "pattern": "^[A-Fa-f\\d]{24}$"
290
+ }
291
+ }
292
+ }
@@ -154,6 +154,10 @@
154
154
  },
155
155
  "maxItems": 1000
156
156
  },
157
+ "delayDays": {
158
+ "type": "integer",
159
+ "minimum": 1
160
+ },
157
161
  "s3": {
158
162
  "type": "object",
159
163
  "properties": {
@@ -141,6 +141,10 @@
141
141
  },
142
142
  "maxItems": 1000
143
143
  },
144
+ "delayDays": {
145
+ "type": "integer",
146
+ "minimum": 1
147
+ },
144
148
  "s3": {
145
149
  "type": "object",
146
150
  "properties": {
@@ -468,6 +468,10 @@
468
468
  },
469
469
  "maxItems": 1000
470
470
  },
471
+ "delayDays": {
472
+ "type": "integer",
473
+ "minimum": 1
474
+ },
471
475
  "s3": {
472
476
  "type": "object",
473
477
  "properties": {
@@ -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
@@ -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