losant_rest 1.17.5 → 1.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +707 -99
  3. data/docs/application.md +43 -0
  4. data/docs/applicationDashboards.md +1 -1
  5. data/docs/dashboards.md +1 -1
  6. data/docs/device.md +44 -0
  7. data/docs/devices.md +46 -0
  8. data/docs/instance.md +43 -0
  9. data/docs/instanceOrg.md +46 -0
  10. data/docs/me.md +41 -0
  11. data/docs/org.md +43 -0
  12. data/lib/losant_rest/application.rb +54 -0
  13. data/lib/losant_rest/application_dashboards.rb +1 -1
  14. data/lib/losant_rest/client.rb +2 -2
  15. data/lib/losant_rest/dashboards.rb +1 -1
  16. data/lib/losant_rest/device.rb +52 -0
  17. data/lib/losant_rest/devices.rb +61 -0
  18. data/lib/losant_rest/instance.rb +54 -0
  19. data/lib/losant_rest/instance_org.rb +56 -0
  20. data/lib/losant_rest/me.rb +51 -0
  21. data/lib/losant_rest/org.rb +54 -0
  22. data/lib/losant_rest/version.rb +1 -1
  23. data/schemas/advancedFlowQuery.json +103 -0
  24. data/schemas/advancedFlowVersionQuery.json +103 -0
  25. data/schemas/apiTokenPost.json +7 -0
  26. data/schemas/compositeDevicesState.json +97 -0
  27. data/schemas/deviceCredentials.json +1 -0
  28. data/schemas/edgeDeployment.json +7 -0
  29. data/schemas/edgeDeployments.json +7 -0
  30. data/schemas/experienceLinkedResources.json +3 -1
  31. data/schemas/flow.json +3 -1
  32. data/schemas/flowPost.json +3 -1
  33. data/schemas/flowVersionsDeletePost.json +103 -0
  34. data/schemas/flows.json +3 -1
  35. data/schemas/flowsImportPost.json +3 -1
  36. data/schemas/flowsImportResult.json +3 -1
  37. data/schemas/githubLogin.json +7 -0
  38. data/schemas/instanceCustomNode.json +1 -0
  39. data/schemas/instanceCustomNodePatch.json +1 -0
  40. data/schemas/instanceCustomNodePost.json +1 -0
  41. data/schemas/instanceCustomNodes.json +1 -0
  42. data/schemas/lastValueQuery.json +3 -0
  43. data/schemas/notebookExecutionOptions.json +10 -0
  44. data/schemas/payloadCountsBreakdown.json +53 -0
  45. data/schemas/samlResponse.json +7 -0
  46. data/schemas/userCredentials.json +7 -0
  47. data/schemas/userPost.json +7 -0
  48. metadata +4 -2
data/schemas/flow.json CHANGED
@@ -2674,10 +2674,12 @@
2674
2674
  },
2675
2675
  "customNodeSupports": {
2676
2676
  "type": "array",
2677
+ "maxItems": 1,
2677
2678
  "items": {
2678
2679
  "type": "string",
2679
2680
  "enum": [
2680
- "cloud"
2681
+ "cloud",
2682
+ "edge"
2681
2683
  ]
2682
2684
  }
2683
2685
  },
data/schemas/flowPost.json CHANGED
@@ -2657,10 +2657,12 @@
2657
2657
  },
2658
2658
  "customNodeSupports": {
2659
2659
  "type": "array",
2660
+ "maxItems": 1,
2660
2661
  "items": {
2661
2662
  "type": "string",
2662
2663
  "enum": [
2663
- "cloud"
2664
+ "cloud",
2665
+ "edge"
2664
2666
  ]
2665
2667
  }
2666
2668
  }
data/schemas/flowVersionsDeletePost.json CHANGED
@@ -973,6 +973,109 @@
973
973
  "additionalProperties": false
974
974
  }
975
975
  ]
976
+ },
977
+ "customNodeSupports": {
978
+ "oneOf": [
979
+ {
980
+ "type": [
981
+ "string",
982
+ "number",
983
+ "boolean",
984
+ "null"
985
+ ]
986
+ },
987
+ {
988
+ "type": "object",
989
+ "properties": {
990
+ "$eq": {
991
+ "type": [
992
+ "string",
993
+ "number",
994
+ "boolean",
995
+ "null"
996
+ ]
997
+ },
998
+ "$ne": {
999
+ "type": [
1000
+ "string",
1001
+ "number",
1002
+ "boolean",
1003
+ "null"
1004
+ ]
1005
+ },
1006
+ "$gt": {
1007
+ "type": [
1008
+ "string",
1009
+ "number",
1010
+ "boolean",
1011
+ "null"
1012
+ ]
1013
+ },
1014
+ "$lt": {
1015
+ "type": [
1016
+ "string",
1017
+ "number",
1018
+ "boolean",
1019
+ "null"
1020
+ ]
1021
+ },
1022
+ "$gte": {
1023
+ "type": [
1024
+ "string",
1025
+ "number",
1026
+ "boolean",
1027
+ "null"
1028
+ ]
1029
+ },
1030
+ "$lte": {
1031
+ "type": [
1032
+ "string",
1033
+ "number",
1034
+ "boolean",
1035
+ "null"
1036
+ ]
1037
+ },
1038
+ "$startsWith": {
1039
+ "type": "string",
1040
+ "minLength": 1
1041
+ },
1042
+ "$endsWith": {
1043
+ "type": "string",
1044
+ "minLength": 1
1045
+ },
1046
+ "$contains": {
1047
+ "type": "string",
1048
+ "minLength": 1
1049
+ },
1050
+ "$ci": {
1051
+ "type": "boolean"
1052
+ },
1053
+ "$in": {
1054
+ "type": "array",
1055
+ "maxItems": 100,
1056
+ "items": {
1057
+ "type": [
1058
+ "string",
1059
+ "number",
1060
+ "boolean"
1061
+ ]
1062
+ }
1063
+ },
1064
+ "$nin": {
1065
+ "type": "array",
1066
+ "maxItems": 100,
1067
+ "items": {
1068
+ "type": [
1069
+ "string",
1070
+ "number",
1071
+ "boolean"
1072
+ ]
1073
+ }
1074
+ }
1075
+ },
1076
+ "additionalProperties": false
1077
+ }
1078
+ ]
976
1079
  }
977
1080
  },
978
1081
  "additionalProperties": false
data/schemas/flows.json CHANGED
@@ -2681,10 +2681,12 @@
2681
2681
  },
2682
2682
  "customNodeSupports": {
2683
2683
  "type": "array",
2684
+ "maxItems": 1,
2684
2685
  "items": {
2685
2686
  "type": "string",
2686
2687
  "enum": [
2687
- "cloud"
2688
+ "cloud",
2689
+ "edge"
2688
2690
  ]
2689
2691
  }
2690
2692
  },
data/schemas/flowsImportPost.json CHANGED
@@ -2682,10 +2682,12 @@
2682
2682
  },
2683
2683
  "customNodeSupports": {
2684
2684
  "type": "array",
2685
+ "maxItems": 1,
2685
2686
  "items": {
2686
2687
  "type": "string",
2687
2688
  "enum": [
2688
- "cloud"
2689
+ "cloud",
2690
+ "edge"
2689
2691
  ]
2690
2692
  }
2691
2693
  }
data/schemas/flowsImportResult.json CHANGED
@@ -2682,10 +2682,12 @@
2682
2682
  },
2683
2683
  "customNodeSupports": {
2684
2684
  "type": "array",
2685
+ "maxItems": 1,
2685
2686
  "items": {
2686
2687
  "type": "string",
2687
2688
  "enum": [
2688
- "cloud"
2689
+ "cloud",
2690
+ "edge"
2689
2691
  ]
2690
2692
  }
2691
2693
  },
data/schemas/githubLogin.json CHANGED
@@ -92,6 +92,7 @@
92
92
  "application.mqttSubscriptionStream",
93
93
  "application.patch",
94
94
  "application.payloadCounts",
95
+ "application.payloadCountsBreakdown",
95
96
  "application.deviceCounts",
96
97
  "application.notebookMinuteCounts",
97
98
  "application.search",
@@ -151,6 +152,7 @@
151
152
  "device.getState",
152
153
  "device.patch",
153
154
  "device.payloadCounts",
155
+ "device.payloadCountsBreakdown",
154
156
  "device.removeData",
155
157
  "device.sendCommand",
156
158
  "device.sendState",
@@ -170,6 +172,7 @@
170
172
  "devices.deviceNames",
171
173
  "devices.export",
172
174
  "devices.get",
175
+ "devices.getCompositeState",
173
176
  "devices.payloadCounts",
174
177
  "devices.post",
175
178
  "devices.sendCommand",
@@ -334,6 +337,7 @@
334
337
  "org.modifyMember",
335
338
  "org.removeMember",
336
339
  "org.payloadCounts",
340
+ "org.payloadCountsBreakdown",
337
341
  "org.deviceCounts",
338
342
  "org.notebookMinuteCounts",
339
343
  "org.invoices",
@@ -354,12 +358,14 @@
354
358
  "instance.patch",
355
359
  "instance.historicalSummaries",
356
360
  "instance.generateReport",
361
+ "instance.payloadCountsBreakdown",
357
362
  "instance.deviceCounts",
358
363
  "instance.notebookMinuteCounts",
359
364
  "instanceOrg.*",
360
365
  "instanceOrg.get",
361
366
  "instanceOrg.patch",
362
367
  "instanceOrg.delete",
368
+ "instanceOrg.payloadCountsBreakdown",
363
369
  "instanceOrg.deviceCounts",
364
370
  "instanceOrg.notebookMinuteCounts",
365
371
  "instanceOrgs.*",
@@ -445,6 +451,7 @@
445
451
  "me.addRecentItem",
446
452
  "me.fetchRecentItems",
447
453
  "me.payloadCounts",
454
+ "me.payloadCountsBreakdown",
448
455
  "me.deviceCounts",
449
456
  "me.notebookMinuteCounts",
450
457
  "me.transferResources",
data/schemas/instanceCustomNode.json CHANGED
@@ -513,6 +513,7 @@
513
513
  },
514
514
  "customNodeSupports": {
515
515
  "type": "array",
516
+ "maxItems": 1,
516
517
  "items": {
517
518
  "type": "string",
518
519
  "enum": [
data/schemas/instanceCustomNodePatch.json CHANGED
@@ -654,6 +654,7 @@
654
654
  },
655
655
  "customNodeSupports": {
656
656
  "type": "array",
657
+ "maxItems": 1,
657
658
  "items": {
658
659
  "type": "string",
659
660
  "enum": [
data/schemas/instanceCustomNodePost.json CHANGED
@@ -654,6 +654,7 @@
654
654
  },
655
655
  "customNodeSupports": {
656
656
  "type": "array",
657
+ "maxItems": 1,
657
658
  "items": {
658
659
  "type": "string",
659
660
  "enum": [
data/schemas/instanceCustomNodes.json CHANGED
@@ -520,6 +520,7 @@
520
520
  },
521
521
  "customNodeSupports": {
522
522
  "type": "array",
523
+ "maxItems": 1,
523
524
  "items": {
524
525
  "type": "string",
525
526
  "enum": [
data/schemas/lastValueQuery.json CHANGED
@@ -1624,6 +1624,9 @@
1624
1624
  }
1625
1625
  },
1626
1626
  "additionalProperties": false
1627
+ },
1628
+ "end": {
1629
+ "type": "number"
1627
1630
  }
1628
1631
  },
1629
1632
  "additionalProperties": false
data/schemas/notebookExecutionOptions.json CHANGED
@@ -27,6 +27,16 @@
27
27
  "templateContext": {
28
28
  "type": "string",
29
29
  "maxLength": 32767
30
+ },
31
+ "email": {
32
+ "type": "string",
33
+ "format": "email",
34
+ "maxLength": 1024
35
+ },
36
+ "callbackUrl": {
37
+ "type": "string",
38
+ "format": "uri",
39
+ "maxLength": 1024
30
40
  }
31
41
  },
32
42
  "additionalProperties": false
data/schemas/payloadCountsBreakdown.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "start": {
6
+ "type": "string",
7
+ "format": "date-time"
8
+ },
9
+ "end": {
10
+ "type": "string",
11
+ "format": "date-time"
12
+ },
13
+ "resolution": {
14
+ "type": "number",
15
+ "enum": [
16
+ 86400000,
17
+ 3600000
18
+ ]
19
+ },
20
+ "asBytes": {
21
+ "type": "boolean",
22
+ "enum": [
23
+ true,
24
+ false
25
+ ]
26
+ },
27
+ "includeNonBillable": {
28
+ "type": "boolean",
29
+ "enum": [
30
+ true,
31
+ false
32
+ ]
33
+ },
34
+ "counts": {
35
+ "type": "array",
36
+ "items": {
37
+ "type": "object",
38
+ "properties": {
39
+ "date": {
40
+ "type": "string",
41
+ "format": "date-time"
42
+ },
43
+ "payloads": {
44
+ "type": "integer"
45
+ },
46
+ "bytes": {
47
+ "type": "number"
48
+ }
49
+ }
50
+ }
51
+ }
52
+ }
53
+ }
data/schemas/samlResponse.json CHANGED
@@ -97,6 +97,7 @@
97
97
  "application.mqttSubscriptionStream",
98
98
  "application.patch",
99
99
  "application.payloadCounts",
100
+ "application.payloadCountsBreakdown",
100
101
  "application.deviceCounts",
101
102
  "application.notebookMinuteCounts",
102
103
  "application.search",
@@ -156,6 +157,7 @@
156
157
  "device.getState",
157
158
  "device.patch",
158
159
  "device.payloadCounts",
160
+ "device.payloadCountsBreakdown",
159
161
  "device.removeData",
160
162
  "device.sendCommand",
161
163
  "device.sendState",
@@ -175,6 +177,7 @@
175
177
  "devices.deviceNames",
176
178
  "devices.export",
177
179
  "devices.get",
180
+ "devices.getCompositeState",
178
181
  "devices.payloadCounts",
179
182
  "devices.post",
180
183
  "devices.sendCommand",
@@ -339,6 +342,7 @@
339
342
  "org.modifyMember",
340
343
  "org.removeMember",
341
344
  "org.payloadCounts",
345
+ "org.payloadCountsBreakdown",
342
346
  "org.deviceCounts",
343
347
  "org.notebookMinuteCounts",
344
348
  "org.invoices",
@@ -359,12 +363,14 @@
359
363
  "instance.patch",
360
364
  "instance.historicalSummaries",
361
365
  "instance.generateReport",
366
+ "instance.payloadCountsBreakdown",
362
367
  "instance.deviceCounts",
363
368
  "instance.notebookMinuteCounts",
364
369
  "instanceOrg.*",
365
370
  "instanceOrg.get",
366
371
  "instanceOrg.patch",
367
372
  "instanceOrg.delete",
373
+ "instanceOrg.payloadCountsBreakdown",
368
374
  "instanceOrg.deviceCounts",
369
375
  "instanceOrg.notebookMinuteCounts",
370
376
  "instanceOrgs.*",
@@ -450,6 +456,7 @@
450
456
  "me.addRecentItem",
451
457
  "me.fetchRecentItems",
452
458
  "me.payloadCounts",
459
+ "me.payloadCountsBreakdown",
453
460
  "me.deviceCounts",
454
461
  "me.notebookMinuteCounts",
455
462
  "me.transferResources",
data/schemas/userCredentials.json CHANGED
@@ -101,6 +101,7 @@
101
101
  "application.mqttSubscriptionStream",
102
102
  "application.patch",
103
103
  "application.payloadCounts",
104
+ "application.payloadCountsBreakdown",
104
105
  "application.deviceCounts",
105
106
  "application.notebookMinuteCounts",
106
107
  "application.search",
@@ -160,6 +161,7 @@
160
161
  "device.getState",
161
162
  "device.patch",
162
163
  "device.payloadCounts",
164
+ "device.payloadCountsBreakdown",
163
165
  "device.removeData",
164
166
  "device.sendCommand",
165
167
  "device.sendState",
@@ -179,6 +181,7 @@
179
181
  "devices.deviceNames",
180
182
  "devices.export",
181
183
  "devices.get",
184
+ "devices.getCompositeState",
182
185
  "devices.payloadCounts",
183
186
  "devices.post",
184
187
  "devices.sendCommand",
@@ -343,6 +346,7 @@
343
346
  "org.modifyMember",
344
347
  "org.removeMember",
345
348
  "org.payloadCounts",
349
+ "org.payloadCountsBreakdown",
346
350
  "org.deviceCounts",
347
351
  "org.notebookMinuteCounts",
348
352
  "org.invoices",
@@ -363,12 +367,14 @@
363
367
  "instance.patch",
364
368
  "instance.historicalSummaries",
365
369
  "instance.generateReport",
370
+ "instance.payloadCountsBreakdown",
366
371
  "instance.deviceCounts",
367
372
  "instance.notebookMinuteCounts",
368
373
  "instanceOrg.*",
369
374
  "instanceOrg.get",
370
375
  "instanceOrg.patch",
371
376
  "instanceOrg.delete",
377
+ "instanceOrg.payloadCountsBreakdown",
372
378
  "instanceOrg.deviceCounts",
373
379
  "instanceOrg.notebookMinuteCounts",
374
380
  "instanceOrgs.*",
@@ -454,6 +460,7 @@
454
460
  "me.addRecentItem",
455
461
  "me.fetchRecentItems",
456
462
  "me.payloadCounts",
463
+ "me.payloadCountsBreakdown",
457
464
  "me.deviceCounts",
458
465
  "me.notebookMinuteCounts",
459
466
  "me.transferResources",
data/schemas/userPost.json CHANGED
@@ -159,6 +159,7 @@
159
159
  "application.mqttSubscriptionStream",
160
160
  "application.patch",
161
161
  "application.payloadCounts",
162
+ "application.payloadCountsBreakdown",
162
163
  "application.deviceCounts",
163
164
  "application.notebookMinuteCounts",
164
165
  "application.search",
@@ -218,6 +219,7 @@
218
219
  "device.getState",
219
220
  "device.patch",
220
221
  "device.payloadCounts",
222
+ "device.payloadCountsBreakdown",
221
223
  "device.removeData",
222
224
  "device.sendCommand",
223
225
  "device.sendState",
@@ -237,6 +239,7 @@
237
239
  "devices.deviceNames",
238
240
  "devices.export",
239
241
  "devices.get",
242
+ "devices.getCompositeState",
240
243
  "devices.payloadCounts",
241
244
  "devices.post",
242
245
  "devices.sendCommand",
@@ -401,6 +404,7 @@
401
404
  "org.modifyMember",
402
405
  "org.removeMember",
403
406
  "org.payloadCounts",
407
+ "org.payloadCountsBreakdown",
404
408
  "org.deviceCounts",
405
409
  "org.notebookMinuteCounts",
406
410
  "org.invoices",
@@ -421,12 +425,14 @@
421
425
  "instance.patch",
422
426
  "instance.historicalSummaries",
423
427
  "instance.generateReport",
428
+ "instance.payloadCountsBreakdown",
424
429
  "instance.deviceCounts",
425
430
  "instance.notebookMinuteCounts",
426
431
  "instanceOrg.*",
427
432
  "instanceOrg.get",
428
433
  "instanceOrg.patch",
429
434
  "instanceOrg.delete",
435
+ "instanceOrg.payloadCountsBreakdown",
430
436
  "instanceOrg.deviceCounts",
431
437
  "instanceOrg.notebookMinuteCounts",
432
438
  "instanceOrgs.*",
@@ -512,6 +518,7 @@
512
518
  "me.addRecentItem",
513
519
  "me.fetchRecentItems",
514
520
  "me.payloadCounts",
521
+ "me.payloadCountsBreakdown",
515
522
  "me.deviceCounts",
516
523
  "me.notebookMinuteCounts",
517
524
  "me.transferResources",
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.17.5
4
+ version: 1.18.0
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-06-14 00:00:00.000000000 Z
11
+ date: 2023-07-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: httparty
@@ -315,6 +315,7 @@ files:
315
315
  - schemas/bulkDeleteResponse.json
316
316
  - schemas/changePassword.json
317
317
  - schemas/compositeDeviceState.json
318
+ - schemas/compositeDevicesState.json
318
319
  - schemas/dashboard.json
319
320
  - schemas/dashboardContextInstance.json
320
321
  - schemas/dashboardPatch.json
@@ -513,6 +514,7 @@ files:
513
514
  - schemas/passwordResetInput.json
514
515
  - schemas/passwordResetResponse.json
515
516
  - schemas/payloadCounts.json
517
+ - schemas/payloadCountsBreakdown.json
516
518
  - schemas/payloadStats.json
517
519
  - schemas/recentItem.json
518
520
  - schemas/recentItemList.json