losant_rest 1.19.1 → 1.19.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +1723 -148
  3. data/docs/me.md +6 -6
  4. data/lib/losant_rest/version.rb +1 -1
  5. data/lib/platform_rest/client.rb +2 -2
  6. data/lib/platform_rest/me.rb +6 -6
  7. data/schemas/application.json +166 -2
  8. data/schemas/applicationCreationByTemplateResult.json +166 -2
  9. data/schemas/applicationDashboardPost.json +6 -0
  10. data/schemas/applications.json +166 -2
  11. data/schemas/credential.json +31 -1
  12. data/schemas/credentialPatch.json +28 -0
  13. data/schemas/credentialPost.json +35 -1
  14. data/schemas/credentials.json +31 -1
  15. data/schemas/dashboard.json +6 -0
  16. data/schemas/dashboardPatch.json +6 -0
  17. data/schemas/dashboardPost.json +6 -0
  18. data/schemas/dashboards.json +6 -0
  19. data/schemas/historicalSummaries.json +16 -0
  20. data/schemas/historicalSummary.json +16 -0
  21. data/schemas/instance.json +13 -0
  22. data/schemas/instanceOrg.json +264 -0
  23. data/schemas/instanceOrgPatch.json +21 -0
  24. data/schemas/instanceOrgPost.json +21 -0
  25. data/schemas/instanceOrgs.json +264 -0
  26. data/schemas/instancePatch.json +13 -0
  27. data/schemas/instanceSandbox.json +46 -2
  28. data/schemas/instanceSandboxes.json +46 -2
  29. data/schemas/instances.json +13 -0
  30. data/schemas/me.json +46 -2
  31. data/schemas/multiFactorAuthDisable.json +20 -0
  32. data/schemas/multiFactorAuthEnable.json +25 -0
  33. data/schemas/multiFactorAuthInfo.json +15 -0
  34. data/schemas/org.json +55 -5
  35. data/schemas/orgPatch.json +8 -0
  36. data/schemas/orgPost.json +8 -0
  37. data/schemas/orgs.json +55 -5
  38. data/schemas/timeSeriesData.json +35 -2
  39. metadata +5 -2
data/schemas/applications.json CHANGED
@@ -117,9 +117,18 @@
117
117
  "apiTokenCount": {
118
118
  "type": "integer"
119
119
  },
120
+ "certificateCount": {
121
+ "type": "integer"
122
+ },
123
+ "certificateAuthorityCount": {
124
+ "type": "integer"
125
+ },
120
126
  "credentialCount": {
121
127
  "type": "integer"
122
128
  },
129
+ "dashCount": {
130
+ "type": "integer"
131
+ },
123
132
  "dataTableCount": {
124
133
  "type": "integer"
125
134
  },
@@ -165,6 +174,150 @@
165
174
  "keyCount": {
166
175
  "type": "integer"
167
176
  },
177
+ "notebookCount": {
178
+ "type": "integer"
179
+ },
180
+ "resourceJobCount": {
181
+ "type": "integer"
182
+ },
183
+ "webhookCount": {
184
+ "type": "integer"
185
+ },
186
+ "payloadCount": {
187
+ "title": "Payload Stats",
188
+ "description": "Schema for the result of a payload stats request",
189
+ "type": "object",
190
+ "properties": {
191
+ "dataTable": {
192
+ "type": "object",
193
+ "patternProperties": {
194
+ ".*": {
195
+ "type": "number"
196
+ }
197
+ }
198
+ },
199
+ "deviceCommand": {
200
+ "type": "object",
201
+ "patternProperties": {
202
+ ".*": {
203
+ "type": "number"
204
+ }
205
+ }
206
+ },
207
+ "deviceConnect": {
208
+ "type": "object",
209
+ "patternProperties": {
210
+ ".*": {
211
+ "type": "number"
212
+ }
213
+ }
214
+ },
215
+ "deviceDisconnect": {
216
+ "type": "object",
217
+ "patternProperties": {
218
+ ".*": {
219
+ "type": "number"
220
+ }
221
+ }
222
+ },
223
+ "deviceState": {
224
+ "type": "object",
225
+ "patternProperties": {
226
+ ".*": {
227
+ "type": "number"
228
+ }
229
+ }
230
+ },
231
+ "endpoint": {
232
+ "type": "object",
233
+ "patternProperties": {
234
+ ".*": {
235
+ "type": "number"
236
+ }
237
+ }
238
+ },
239
+ "event": {
240
+ "type": "object",
241
+ "patternProperties": {
242
+ ".*": {
243
+ "type": "number"
244
+ }
245
+ }
246
+ },
247
+ "flowError": {
248
+ "type": "object",
249
+ "patternProperties": {
250
+ ".*": {
251
+ "type": "number"
252
+ }
253
+ }
254
+ },
255
+ "integration": {
256
+ "type": "object",
257
+ "patternProperties": {
258
+ ".*": {
259
+ "type": "number"
260
+ }
261
+ }
262
+ },
263
+ "mqttIn": {
264
+ "type": "object",
265
+ "patternProperties": {
266
+ ".*": {
267
+ "type": "number"
268
+ }
269
+ }
270
+ },
271
+ "mqttOut": {
272
+ "type": "object",
273
+ "patternProperties": {
274
+ ".*": {
275
+ "type": "number"
276
+ }
277
+ }
278
+ },
279
+ "notebook": {
280
+ "type": "object",
281
+ "patternProperties": {
282
+ ".*": {
283
+ "type": "number"
284
+ }
285
+ }
286
+ },
287
+ "timer": {
288
+ "type": "object",
289
+ "patternProperties": {
290
+ ".*": {
291
+ "type": "number"
292
+ }
293
+ }
294
+ },
295
+ "virtualButton": {
296
+ "type": "object",
297
+ "patternProperties": {
298
+ ".*": {
299
+ "type": "number"
300
+ }
301
+ }
302
+ },
303
+ "webhook": {
304
+ "type": "object",
305
+ "patternProperties": {
306
+ ".*": {
307
+ "type": "number"
308
+ }
309
+ }
310
+ },
311
+ "resourceJob": {
312
+ "type": "object",
313
+ "patternProperties": {
314
+ ".*": {
315
+ "type": "number"
316
+ }
317
+ }
318
+ }
319
+ }
320
+ },
168
321
  "storageStats": {
169
322
  "type": "object",
170
323
  "properties": {
@@ -176,8 +329,19 @@
176
329
  }
177
330
  }
178
331
  },
179
- "webhookCount": {
180
- "type": "integer"
332
+ "notebookStats": {
333
+ "type": "object",
334
+ "properties": {
335
+ "awaitingCompletion": {
336
+ "type": "integer"
337
+ },
338
+ "minutesThisPeriod": {
339
+ "type": "integer"
340
+ },
341
+ "runsThisPeriod": {
342
+ "type": "integer"
343
+ }
344
+ }
181
345
  }
182
346
  }
183
347
  },
data/schemas/credential.json CHANGED
@@ -59,7 +59,8 @@
59
59
  "enum": [
60
60
  "aws",
61
61
  "azure",
62
- "gcp"
62
+ "gcp",
63
+ "http"
63
64
  ]
64
65
  },
65
66
  "awsConfig": {
@@ -105,6 +106,35 @@
105
106
  "required": [
106
107
  "keyMetaJson"
107
108
  ]
109
+ },
110
+ "httpConfig": {
111
+ "type": "object",
112
+ "properties": {
113
+ "uriMatch": {
114
+ "type": "string",
115
+ "minLength": 8,
116
+ "maxLength": 1024
117
+ },
118
+ "authMethod": {
119
+ "type": "string",
120
+ "enum": [
121
+ "header",
122
+ "queryParam",
123
+ "basicAuth",
124
+ "clientCertificate"
125
+ ]
126
+ },
127
+ "publicValue": {
128
+ "type": "string",
129
+ "maxLength": 8196
130
+ }
131
+ },
132
+ "additionalProperties": false,
133
+ "required": [
134
+ "uriMatch",
135
+ "authMethod",
136
+ "publicValue"
137
+ ]
108
138
  }
109
139
  },
110
140
  "additionalProperties": false,
data/schemas/credentialPatch.json CHANGED
@@ -60,6 +60,34 @@
60
60
  }
61
61
  },
62
62
  "additionalProperties": false
63
+ },
64
+ "httpConfig": {
65
+ "type": "object",
66
+ "properties": {
67
+ "uriMatch": {
68
+ "type": "string",
69
+ "minLength": 8,
70
+ "maxLength": 1024
71
+ },
72
+ "authMethod": {
73
+ "type": "string",
74
+ "enum": [
75
+ "header",
76
+ "queryParam",
77
+ "basicAuth",
78
+ "clientCertificate"
79
+ ]
80
+ },
81
+ "publicValue": {
82
+ "type": "string",
83
+ "maxLength": 8196
84
+ },
85
+ "secretValue": {
86
+ "type": "string",
87
+ "maxLength": 8196
88
+ }
89
+ },
90
+ "additionalProperties": false
63
91
  }
64
92
  },
65
93
  "additionalProperties": false
data/schemas/credentialPost.json CHANGED
@@ -19,7 +19,8 @@
19
19
  "enum": [
20
20
  "aws",
21
21
  "azure",
22
- "gcp"
22
+ "gcp",
23
+ "http"
23
24
  ]
24
25
  },
25
26
  "awsConfig": {
@@ -79,6 +80,39 @@
79
80
  "required": [
80
81
  "keyJson"
81
82
  ]
83
+ },
84
+ "httpConfig": {
85
+ "type": "object",
86
+ "properties": {
87
+ "uriMatch": {
88
+ "type": "string",
89
+ "minLength": 8,
90
+ "maxLength": 1024
91
+ },
92
+ "authMethod": {
93
+ "type": "string",
94
+ "enum": [
95
+ "header",
96
+ "queryParam",
97
+ "basicAuth",
98
+ "clientCertificate"
99
+ ]
100
+ },
101
+ "publicValue": {
102
+ "type": "string",
103
+ "maxLength": 8196
104
+ },
105
+ "secretValue": {
106
+ "type": "string",
107
+ "maxLength": 8196
108
+ }
109
+ },
110
+ "additionalProperties": false,
111
+ "required": [
112
+ "uriMatch",
113
+ "authMethod",
114
+ "secretValue"
115
+ ]
82
116
  }
83
117
  },
84
118
  "additionalProperties": false,
data/schemas/credentials.json CHANGED
@@ -66,7 +66,8 @@
66
66
  "enum": [
67
67
  "aws",
68
68
  "azure",
69
- "gcp"
69
+ "gcp",
70
+ "http"
70
71
  ]
71
72
  },
72
73
  "awsConfig": {
@@ -112,6 +113,35 @@
112
113
  "required": [
113
114
  "keyMetaJson"
114
115
  ]
116
+ },
117
+ "httpConfig": {
118
+ "type": "object",
119
+ "properties": {
120
+ "uriMatch": {
121
+ "type": "string",
122
+ "minLength": 8,
123
+ "maxLength": 1024
124
+ },
125
+ "authMethod": {
126
+ "type": "string",
127
+ "enum": [
128
+ "header",
129
+ "queryParam",
130
+ "basicAuth",
131
+ "clientCertificate"
132
+ ]
133
+ },
134
+ "publicValue": {
135
+ "type": "string",
136
+ "maxLength": 8196
137
+ }
138
+ },
139
+ "additionalProperties": false,
140
+ "required": [
141
+ "uriMatch",
142
+ "authMethod",
143
+ "publicValue"
144
+ ]
115
145
  }
116
146
  },
117
147
  "additionalProperties": false,
data/schemas/dashboard.json CHANGED
@@ -1086,6 +1086,9 @@
1086
1086
  "vega4",
1087
1087
  "vega5"
1088
1088
  ]
1089
+ },
1090
+ "tooltipEventSubscribe": {
1091
+ "type": "boolean"
1089
1092
  }
1090
1093
  },
1091
1094
  "additionalProperties": false
@@ -2382,6 +2385,9 @@
2382
2385
  "realTime": {
2383
2386
  "type": "boolean"
2384
2387
  },
2388
+ "hideLegend": {
2389
+ "type": "boolean"
2390
+ },
2385
2391
  "disallowUserSelectedDuration": {
2386
2392
  "type": "boolean"
2387
2393
  },
data/schemas/dashboardPatch.json CHANGED
@@ -880,6 +880,9 @@
880
880
  "vega4",
881
881
  "vega5"
882
882
  ]
883
+ },
884
+ "tooltipEventSubscribe": {
885
+ "type": "boolean"
883
886
  }
884
887
  },
885
888
  "additionalProperties": false
@@ -2176,6 +2179,9 @@
2176
2179
  "realTime": {
2177
2180
  "type": "boolean"
2178
2181
  },
2182
+ "hideLegend": {
2183
+ "type": "boolean"
2184
+ },
2179
2185
  "disallowUserSelectedDuration": {
2180
2186
  "type": "boolean"
2181
2187
  },
data/schemas/dashboardPost.json CHANGED
@@ -888,6 +888,9 @@
888
888
  "vega4",
889
889
  "vega5"
890
890
  ]
891
+ },
892
+ "tooltipEventSubscribe": {
893
+ "type": "boolean"
891
894
  }
892
895
  },
893
896
  "additionalProperties": false
@@ -2184,6 +2187,9 @@
2184
2187
  "realTime": {
2185
2188
  "type": "boolean"
2186
2189
  },
2190
+ "hideLegend": {
2191
+ "type": "boolean"
2192
+ },
2187
2193
  "disallowUserSelectedDuration": {
2188
2194
  "type": "boolean"
2189
2195
  },
data/schemas/dashboards.json CHANGED
@@ -1093,6 +1093,9 @@
1093
1093
  "vega4",
1094
1094
  "vega5"
1095
1095
  ]
1096
+ },
1097
+ "tooltipEventSubscribe": {
1098
+ "type": "boolean"
1096
1099
  }
1097
1100
  },
1098
1101
  "additionalProperties": false
@@ -2389,6 +2392,9 @@
2389
2392
  "realTime": {
2390
2393
  "type": "boolean"
2391
2394
  },
2395
+ "hideLegend": {
2396
+ "type": "boolean"
2397
+ },
2392
2398
  "disallowUserSelectedDuration": {
2393
2399
  "type": "boolean"
2394
2400
  },
data/schemas/historicalSummaries.json CHANGED
@@ -56,6 +56,14 @@
56
56
  "type": "integer",
57
57
  "minimum": 0
58
58
  },
59
+ "applicationcertificate": {
60
+ "type": "integer",
61
+ "minimum": 0
62
+ },
63
+ "applicationcertificateauthority": {
64
+ "type": "integer",
65
+ "minimum": 0
66
+ },
59
67
  "applicationkey": {
60
68
  "type": "integer",
61
69
  "minimum": 0
@@ -167,6 +175,11 @@
167
175
  "applicationFlowSlots": {
168
176
  "type": "integer",
169
177
  "minimum": 0
178
+ },
179
+ "systemInterval": {
180
+ "type": "integer",
181
+ "minimum": 5,
182
+ "maximum": 3600
170
183
  }
171
184
  },
172
185
  "additionalProperties": false
@@ -203,6 +216,9 @@
203
216
  "certificateCount": {
204
217
  "type": "number"
205
218
  },
219
+ "credentialCount": {
220
+ "type": "integer"
221
+ },
206
222
  "dashboardCount": {
207
223
  "type": "number"
208
224
  },
data/schemas/historicalSummary.json CHANGED
@@ -49,6 +49,14 @@
49
49
  "type": "integer",
50
50
  "minimum": 0
51
51
  },
52
+ "applicationcertificate": {
53
+ "type": "integer",
54
+ "minimum": 0
55
+ },
56
+ "applicationcertificateauthority": {
57
+ "type": "integer",
58
+ "minimum": 0
59
+ },
52
60
  "applicationkey": {
53
61
  "type": "integer",
54
62
  "minimum": 0
@@ -160,6 +168,11 @@
160
168
  "applicationFlowSlots": {
161
169
  "type": "integer",
162
170
  "minimum": 0
171
+ },
172
+ "systemInterval": {
173
+ "type": "integer",
174
+ "minimum": 5,
175
+ "maximum": 3600
163
176
  }
164
177
  },
165
178
  "additionalProperties": false
@@ -196,6 +209,9 @@
196
209
  "certificateCount": {
197
210
  "type": "number"
198
211
  },
212
+ "credentialCount": {
213
+ "type": "integer"
214
+ },
199
215
  "dashboardCount": {
200
216
  "type": "number"
201
217
  },
data/schemas/instance.json CHANGED
@@ -206,6 +206,14 @@
206
206
  "type": "integer",
207
207
  "minimum": 0
208
208
  },
209
+ "applicationcertificate": {
210
+ "type": "integer",
211
+ "minimum": 0
212
+ },
213
+ "applicationcertificateauthority": {
214
+ "type": "integer",
215
+ "minimum": 0
216
+ },
209
217
  "applicationkey": {
210
218
  "type": "integer",
211
219
  "minimum": 0
@@ -317,6 +325,11 @@
317
325
  "applicationFlowSlots": {
318
326
  "type": "integer",
319
327
  "minimum": 0
328
+ },
329
+ "systemInterval": {
330
+ "type": "integer",
331
+ "minimum": 5,
332
+ "maximum": 3600
320
333
  }
321
334
  },
322
335
  "additionalProperties": false