losant_rest 1.19.1 → 1.19.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +2373 -508
  3. data/docs/application.md +40 -0
  4. data/docs/me.md +6 -6
  5. data/lib/losant_rest/version.rb +1 -1
  6. data/lib/platform_rest/application.rb +48 -0
  7. data/lib/platform_rest/client.rb +2 -2
  8. data/lib/platform_rest/me.rb +6 -6
  9. data/schemas/apiTokenPost.json +1 -0
  10. data/schemas/application.json +166 -2
  11. data/schemas/applicationCreationByTemplateResult.json +166 -2
  12. data/schemas/applicationDashboardPost.json +6 -0
  13. data/schemas/applicationImportExecutions.json +205 -0
  14. data/schemas/applications.json +166 -2
  15. data/schemas/authedUser.json +4 -0
  16. data/schemas/credential.json +31 -1
  17. data/schemas/credentialPatch.json +28 -0
  18. data/schemas/credentialPost.json +35 -1
  19. data/schemas/credentials.json +31 -1
  20. data/schemas/dashboard.json +6 -0
  21. data/schemas/dashboardPatch.json +6 -0
  22. data/schemas/dashboardPost.json +6 -0
  23. data/schemas/dashboards.json +6 -0
  24. data/schemas/dataExport.json +1 -0
  25. data/schemas/devicesRemoveDataPost.json +2 -2
  26. data/schemas/githubLogin.json +1 -0
  27. data/schemas/historicalSummaries.json +16 -0
  28. data/schemas/historicalSummary.json +16 -0
  29. data/schemas/importIntoApplicationOptions.json +4 -0
  30. data/schemas/instance.json +21 -0
  31. data/schemas/instanceOrg.json +264 -0
  32. data/schemas/instanceOrgPatch.json +21 -0
  33. data/schemas/instanceOrgPost.json +21 -0
  34. data/schemas/instanceOrgs.json +264 -0
  35. data/schemas/instancePatch.json +21 -0
  36. data/schemas/instanceSandbox.json +46 -2
  37. data/schemas/instanceSandboxes.json +46 -2
  38. data/schemas/instances.json +21 -0
  39. data/schemas/me.json +46 -2
  40. data/schemas/multiFactorAuthDisable.json +20 -0
  41. data/schemas/multiFactorAuthEnable.json +25 -0
  42. data/schemas/multiFactorAuthInfo.json +15 -0
  43. data/schemas/org.json +55 -5
  44. data/schemas/orgPatch.json +8 -0
  45. data/schemas/orgPost.json +8 -0
  46. data/schemas/orgs.json +55 -5
  47. data/schemas/samlResponse.json +1 -0
  48. data/schemas/timeSeriesData.json +35 -2
  49. data/schemas/userCredentials.json +1 -0
  50. data/schemas/userPost.json +8 -0
  51. metadata +6 -2
@@ -0,0 +1,15 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "key": {
6
+ "type": "string",
7
+ "maxLength": 1024
8
+ },
9
+ "keyUri": {
10
+ "type": "string",
11
+ "maxLength": 1024
12
+ }
13
+ },
14
+ "additionalProperties": false
15
+ }
data/schemas/org.json CHANGED
@@ -137,6 +137,14 @@
137
137
  "type": "integer",
138
138
  "minimum": 0
139
139
  },
140
+ "applicationcertificate": {
141
+ "type": "integer",
142
+ "minimum": 0
143
+ },
144
+ "applicationcertificateauthority": {
145
+ "type": "integer",
146
+ "minimum": 0
147
+ },
140
148
  "applicationkey": {
141
149
  "type": "integer",
142
150
  "minimum": 0
@@ -248,6 +256,11 @@
248
256
  "applicationFlowSlots": {
249
257
  "type": "integer",
250
258
  "minimum": 0
259
+ },
260
+ "systemInterval": {
261
+ "type": "integer",
262
+ "minimum": 5,
263
+ "maximum": 3600
251
264
  }
252
265
  },
253
266
  "additionalProperties": false
@@ -261,6 +274,12 @@
261
274
  "appCount": {
262
275
  "type": "integer"
263
276
  },
277
+ "certificateCount": {
278
+ "type": "integer"
279
+ },
280
+ "certificateAuthorityCount": {
281
+ "type": "integer"
282
+ },
264
283
  "credentialCount": {
265
284
  "type": "integer"
266
285
  },
@@ -276,6 +295,9 @@
276
295
  "deviceRecipeCount": {
277
296
  "type": "integer"
278
297
  },
298
+ "eventCount": {
299
+ "type": "integer"
300
+ },
279
301
  "experienceDomainCount": {
280
302
  "type": "integer"
281
303
  },
@@ -309,9 +331,21 @@
309
331
  "keyCount": {
310
332
  "type": "integer"
311
333
  },
334
+ "notebookCount": {
335
+ "type": "integer"
336
+ },
337
+ "resourceJobCount": {
338
+ "type": "integer"
339
+ },
340
+ "webhookCount": {
341
+ "type": "integer"
342
+ },
312
343
  "memberCount": {
313
344
  "type": "integer"
314
345
  },
346
+ "pendingInviteCount": {
347
+ "type": "integer"
348
+ },
315
349
  "payloadCount": {
316
350
  "title": "Payload Stats",
317
351
  "description": "Schema for the result of a payload stats request",
@@ -447,9 +481,6 @@
447
481
  }
448
482
  }
449
483
  },
450
- "pendingInviteCount": {
451
- "type": "integer"
452
- },
453
484
  "storageStats": {
454
485
  "type": "object",
455
486
  "properties": {
@@ -461,8 +492,19 @@
461
492
  }
462
493
  }
463
494
  },
464
- "webhookCount": {
465
- "type": "integer"
495
+ "notebookStats": {
496
+ "type": "object",
497
+ "properties": {
498
+ "awaitingCompletion": {
499
+ "type": "integer"
500
+ },
501
+ "minutesThisPeriod": {
502
+ "type": "integer"
503
+ },
504
+ "runsThisPeriod": {
505
+ "type": "integer"
506
+ }
507
+ }
466
508
  }
467
509
  }
468
510
  },
@@ -524,6 +566,14 @@
524
566
  },
525
567
  "isReadOnly": {
526
568
  "type": "boolean"
569
+ },
570
+ "mfaMode": {
571
+ "type": "string",
572
+ "enum": [
573
+ "notRequired",
574
+ "adminRequired",
575
+ "required"
576
+ ]
527
577
  }
528
578
  }
529
579
  }
@@ -27,6 +27,14 @@
27
27
  "iconColor": {
28
28
  "type": "string",
29
29
  "maxLength": 64
30
+ },
31
+ "mfaMode": {
32
+ "type": "string",
33
+ "enum": [
34
+ "notRequired",
35
+ "adminRequired",
36
+ "required"
37
+ ]
30
38
  }
31
39
  },
32
40
  "additionalProperties": false
data/schemas/orgPost.json CHANGED
@@ -27,6 +27,14 @@
27
27
  "iconColor": {
28
28
  "type": "string",
29
29
  "maxLength": 64
30
+ },
31
+ "mfaMode": {
32
+ "type": "string",
33
+ "enum": [
34
+ "notRequired",
35
+ "adminRequired",
36
+ "required"
37
+ ]
30
38
  }
31
39
  },
32
40
  "additionalProperties": false,
data/schemas/orgs.json CHANGED
@@ -144,6 +144,14 @@
144
144
  "type": "integer",
145
145
  "minimum": 0
146
146
  },
147
+ "applicationcertificate": {
148
+ "type": "integer",
149
+ "minimum": 0
150
+ },
151
+ "applicationcertificateauthority": {
152
+ "type": "integer",
153
+ "minimum": 0
154
+ },
147
155
  "applicationkey": {
148
156
  "type": "integer",
149
157
  "minimum": 0
@@ -255,6 +263,11 @@
255
263
  "applicationFlowSlots": {
256
264
  "type": "integer",
257
265
  "minimum": 0
266
+ },
267
+ "systemInterval": {
268
+ "type": "integer",
269
+ "minimum": 5,
270
+ "maximum": 3600
258
271
  }
259
272
  },
260
273
  "additionalProperties": false
@@ -268,6 +281,12 @@
268
281
  "appCount": {
269
282
  "type": "integer"
270
283
  },
284
+ "certificateCount": {
285
+ "type": "integer"
286
+ },
287
+ "certificateAuthorityCount": {
288
+ "type": "integer"
289
+ },
271
290
  "credentialCount": {
272
291
  "type": "integer"
273
292
  },
@@ -283,6 +302,9 @@
283
302
  "deviceRecipeCount": {
284
303
  "type": "integer"
285
304
  },
305
+ "eventCount": {
306
+ "type": "integer"
307
+ },
286
308
  "experienceDomainCount": {
287
309
  "type": "integer"
288
310
  },
@@ -316,9 +338,21 @@
316
338
  "keyCount": {
317
339
  "type": "integer"
318
340
  },
341
+ "notebookCount": {
342
+ "type": "integer"
343
+ },
344
+ "resourceJobCount": {
345
+ "type": "integer"
346
+ },
347
+ "webhookCount": {
348
+ "type": "integer"
349
+ },
319
350
  "memberCount": {
320
351
  "type": "integer"
321
352
  },
353
+ "pendingInviteCount": {
354
+ "type": "integer"
355
+ },
322
356
  "payloadCount": {
323
357
  "title": "Payload Stats",
324
358
  "description": "Schema for the result of a payload stats request",
@@ -454,9 +488,6 @@
454
488
  }
455
489
  }
456
490
  },
457
- "pendingInviteCount": {
458
- "type": "integer"
459
- },
460
491
  "storageStats": {
461
492
  "type": "object",
462
493
  "properties": {
@@ -468,8 +499,19 @@
468
499
  }
469
500
  }
470
501
  },
471
- "webhookCount": {
472
- "type": "integer"
502
+ "notebookStats": {
503
+ "type": "object",
504
+ "properties": {
505
+ "awaitingCompletion": {
506
+ "type": "integer"
507
+ },
508
+ "minutesThisPeriod": {
509
+ "type": "integer"
510
+ },
511
+ "runsThisPeriod": {
512
+ "type": "integer"
513
+ }
514
+ }
473
515
  }
474
516
  }
475
517
  },
@@ -531,6 +573,14 @@
531
573
  },
532
574
  "isReadOnly": {
533
575
  "type": "boolean"
576
+ },
577
+ "mfaMode": {
578
+ "type": "string",
579
+ "enum": [
580
+ "notRequired",
581
+ "adminRequired",
582
+ "required"
583
+ ]
534
584
  }
535
585
  }
536
586
  }
@@ -103,6 +103,7 @@
103
103
  "application.deviceCounts",
104
104
  "application.notebookMinuteCounts",
105
105
  "application.search",
106
+ "application.importLogs",
106
107
  "applicationApiToken.delete",
107
108
  "applicationApiToken.get",
108
109
  "applicationApiToken.patch",
@@ -11,7 +11,10 @@
11
11
  "format": "date-time"
12
12
  },
13
13
  "resolution": {
14
- "type": "number"
14
+ "type": [
15
+ "number",
16
+ "null"
17
+ ]
15
18
  },
16
19
  "aggregation": {
17
20
  "oneOf": [
@@ -117,6 +120,19 @@
117
120
  }
118
121
  ]
119
122
  },
123
+ "limit": {
124
+ "type": [
125
+ "number",
126
+ "null"
127
+ ]
128
+ },
129
+ "order": {
130
+ "type": "string",
131
+ "enum": [
132
+ "asc",
133
+ "desc"
134
+ ]
135
+ },
120
136
  "devices": {
121
137
  "type": "object",
122
138
  "patternProperties": {
@@ -128,6 +144,20 @@
128
144
  "minLength": 1,
129
145
  "maxLength": 255
130
146
  },
147
+ "tags": {
148
+ "type": "object",
149
+ "patternProperties": {
150
+ "^[0-9a-zA-Z_-]{1,255}$": {
151
+ "type": "array",
152
+ "items": {
153
+ "type": "string",
154
+ "minLength": 1,
155
+ "maxLength": 255
156
+ }
157
+ }
158
+ },
159
+ "additionalProperties": false
160
+ },
131
161
  "points": {
132
162
  "type": "array",
133
163
  "items": {
@@ -162,7 +192,8 @@
162
192
  "additionalProperties": false,
163
193
  "required": [
164
194
  "name",
165
- "points"
195
+ "points",
196
+ "tags"
166
197
  ]
167
198
  }
168
199
  },
@@ -175,6 +206,8 @@
175
206
  "end",
176
207
  "resolution",
177
208
  "aggregation",
209
+ "limit",
210
+ "order",
178
211
  "devices"
179
212
  ]
180
213
  }
@@ -107,6 +107,7 @@
107
107
  "application.deviceCounts",
108
108
  "application.notebookMinuteCounts",
109
109
  "application.search",
110
+ "application.importLogs",
110
111
  "applicationApiToken.delete",
111
112
  "applicationApiToken.get",
112
113
  "applicationApiToken.patch",
@@ -165,6 +165,7 @@
165
165
  "application.deviceCounts",
166
166
  "application.notebookMinuteCounts",
167
167
  "application.search",
168
+ "application.importLogs",
168
169
  "applicationApiToken.delete",
169
170
  "applicationApiToken.get",
170
171
  "applicationApiToken.patch",
@@ -545,6 +546,13 @@
545
546
  "tokenTTL": {
546
547
  "type": "integer",
547
548
  "minimum": 0
549
+ },
550
+ "inviteToken": {
551
+ "type": "string",
552
+ "minLength": 1
553
+ },
554
+ "acceptInvite": {
555
+ "type": "boolean"
548
556
  }
549
557
  },
550
558
  "anyOf": [
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: losant_rest
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.19.1
4
+ version: 1.19.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Michael Kuehl
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-10-06 00:00:00.000000000 Z
11
+ date: 2023-12-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: httparty
@@ -385,6 +385,7 @@ files:
385
385
  - schemas/applicationExportPost.json
386
386
  - schemas/applicationExportResult.json
387
387
  - schemas/applicationGlobalPatch.json
388
+ - schemas/applicationImportExecutions.json
388
389
  - schemas/applicationImportOptions.json
389
390
  - schemas/applicationKey.json
390
391
  - schemas/applicationKeyPatch.json
@@ -588,6 +589,9 @@ files:
588
589
  - schemas/mePatch.json
589
590
  - schemas/mqttPublishBody.json
590
591
  - schemas/multiDeviceCommand.json
592
+ - schemas/multiFactorAuthDisable.json
593
+ - schemas/multiFactorAuthEnable.json
594
+ - schemas/multiFactorAuthInfo.json
591
595
  - schemas/notebook.json
592
596
  - schemas/notebookDataExportOptions.json
593
597
  - schemas/notebookExecutionLogs.json