losant_rest 1.9.3 → 1.10.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (110) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +17405 -2766
  3. data/docs/application.md +85 -0
  4. data/docs/applicationApiTokens.md +1 -1
  5. data/docs/applicationTemplate.md +46 -0
  6. data/docs/applicationTemplates.md +76 -1
  7. data/docs/device.md +7 -3
  8. data/docs/devices.md +92 -4
  9. data/docs/experienceEndpoints.md +1 -0
  10. data/docs/file.md +4 -4
  11. data/docs/flow.md +94 -1
  12. data/docs/flowVersion.md +96 -1
  13. data/docs/me.md +0 -36
  14. data/lib/losant_rest.rb +1 -0
  15. data/lib/losant_rest/application.rb +48 -0
  16. data/lib/losant_rest/application_api_tokens.rb +1 -1
  17. data/lib/losant_rest/application_template.rb +79 -0
  18. data/lib/losant_rest/application_templates.rb +89 -1
  19. data/lib/losant_rest/client.rb +6 -2
  20. data/lib/losant_rest/device.rb +11 -3
  21. data/lib/losant_rest/devices.rb +103 -3
  22. data/lib/losant_rest/experience_endpoints.rb +2 -0
  23. data/lib/losant_rest/file.rb +3 -3
  24. data/lib/losant_rest/flow.rb +115 -1
  25. data/lib/losant_rest/flow_version.rb +115 -1
  26. data/lib/losant_rest/me.rb +0 -41
  27. data/lib/losant_rest/version.rb +1 -1
  28. data/schemas/advancedDeviceQuery.json +117 -0
  29. data/schemas/advancedEventQuery.json +205 -0
  30. data/schemas/advancedQuery.json +34 -3
  31. data/schemas/application.json +13 -0
  32. data/schemas/applicationApiTokenPost.json +9 -1
  33. data/schemas/applicationApplyTemplatePatch.json +19 -0
  34. data/schemas/applicationCreationByTemplateResult.json +13 -0
  35. data/schemas/applicationPatch.json +5 -0
  36. data/schemas/applicationPost.json +13 -0
  37. data/schemas/applicationTemplate.json +32 -0
  38. data/schemas/applicationTemplateCategories.json +43 -0
  39. data/schemas/applicationTemplateCategory.json +23 -0
  40. data/schemas/applicationTemplates.json +44 -0
  41. data/schemas/applications.json +13 -0
  42. data/schemas/changePassword.json +2 -2
  43. data/schemas/dashboard.json +1285 -145
  44. data/schemas/dashboardPatch.json +1285 -145
  45. data/schemas/dashboardPost.json +1285 -145
  46. data/schemas/dashboards.json +1285 -145
  47. data/schemas/dataExport.json +142 -0
  48. data/schemas/dataTableRowsExport.json +34 -3
  49. data/schemas/device.json +16 -3
  50. data/schemas/devicePatch.json +16 -3
  51. data/schemas/devicePost.json +16 -3
  52. data/schemas/deviceRecipe.json +16 -3
  53. data/schemas/deviceRecipePatch.json +16 -3
  54. data/schemas/deviceRecipePost.json +16 -3
  55. data/schemas/deviceRecipes.json +16 -3
  56. data/schemas/devices.json +16 -3
  57. data/schemas/devicesDataRemoved.json +12 -0
  58. data/schemas/devicesDeletePost.json +1034 -0
  59. data/schemas/devicesDeleted.json +12 -0
  60. data/schemas/devicesExportPost.json +1035 -0
  61. data/schemas/devicesPatch.json +1773 -7
  62. data/schemas/devicesRemoveDataPost.json +1056 -0
  63. data/schemas/devicesUpdated.json +18 -0
  64. data/schemas/eventPost.json +22 -0
  65. data/schemas/eventsExport.json +205 -0
  66. data/schemas/experienceDomain.json +1 -1
  67. data/schemas/experienceDomainPatch.json +1 -1
  68. data/schemas/experienceDomainPost.json +1 -1
  69. data/schemas/experienceDomains.json +1 -1
  70. data/schemas/experienceGroup.json +7 -0
  71. data/schemas/experienceGroupPatch.json +7 -0
  72. data/schemas/experienceGroupPost.json +7 -0
  73. data/schemas/experienceGroups.json +7 -0
  74. data/schemas/experienceLinkedResources.json +348 -3
  75. data/schemas/experienceVersion.json +1 -1
  76. data/schemas/experienceVersions.json +1 -1
  77. data/schemas/flow.json +116 -1
  78. data/schemas/flowErrors.json +87 -0
  79. data/schemas/flowPatch.json +116 -1
  80. data/schemas/flowPost.json +116 -1
  81. data/schemas/flowStats.json +54 -0
  82. data/schemas/flowVersion.json +232 -2
  83. data/schemas/flowVersionPost.json +116 -1
  84. data/schemas/flowVersions.json +232 -2
  85. data/schemas/flows.json +116 -1
  86. data/schemas/flowsImportPost.json +232 -2
  87. data/schemas/flowsImportResult.json +348 -3
  88. data/schemas/githubLogin.json +15 -4
  89. data/schemas/me.json +0 -3
  90. data/schemas/mePatch.json +2 -2
  91. data/schemas/multiDeviceCommand.json +1019 -0
  92. data/schemas/notebook.json +99 -2
  93. data/schemas/notebookPatch.json +99 -2
  94. data/schemas/notebookPost.json +99 -2
  95. data/schemas/notebooks.json +99 -2
  96. data/schemas/org.json +1 -1
  97. data/schemas/orgInviteInfo.json +3 -0
  98. data/schemas/orgInvitePost.json +3 -0
  99. data/schemas/orgInvites.json +3 -0
  100. data/schemas/orgPatch.json +1 -1
  101. data/schemas/orgPost.json +0 -9
  102. data/schemas/orgs.json +1 -1
  103. data/schemas/passwordResetFinish.json +2 -2
  104. data/schemas/samlResponse.json +1 -1
  105. data/schemas/templateKeywords.json +14 -0
  106. data/schemas/timeSeriesData.json +101 -12
  107. data/schemas/timeSeriesQuery.json +101 -12
  108. data/schemas/userCredentials.json +13 -3
  109. data/schemas/userPost.json +21 -7
  110. metadata +19 -5
data/schemas/flowsImportResult.json CHANGED
@@ -85,7 +85,6 @@
85
85
  "deviceIdDisconnect",
86
86
  "deviceTagDisconnect",
87
87
  "integration",
88
- "mqttTopic",
89
88
  "notebook",
90
89
  "onBoot",
91
90
  "onConnect",
@@ -1031,6 +1030,109 @@
1031
1030
  ],
1032
1031
  "additionalProperties": false
1033
1032
  },
1033
+ {
1034
+ "type": "object",
1035
+ "properties": {
1036
+ "key": {
1037
+ "type": "string",
1038
+ "maxLength": 1024
1039
+ },
1040
+ "type": {
1041
+ "type": "string",
1042
+ "enum": [
1043
+ "mqttTopic"
1044
+ ]
1045
+ },
1046
+ "config": {
1047
+ "type": "object",
1048
+ "properties": {
1049
+ "integrationId": {
1050
+ "type": "string",
1051
+ "enum": [
1052
+ "losant",
1053
+ "local"
1054
+ ]
1055
+ }
1056
+ },
1057
+ "additionalProperties": false
1058
+ },
1059
+ "meta": {
1060
+ "type": "object",
1061
+ "properties": {
1062
+ "category": {
1063
+ "type": "string",
1064
+ "enum": [
1065
+ "trigger"
1066
+ ]
1067
+ },
1068
+ "name": {
1069
+ "type": "string",
1070
+ "enum": [
1071
+ "mqtt"
1072
+ ]
1073
+ },
1074
+ "label": {
1075
+ "type": "string",
1076
+ "minLength": 1,
1077
+ "maxLength": 255
1078
+ },
1079
+ "x": {
1080
+ "type": "number"
1081
+ },
1082
+ "y": {
1083
+ "type": "number"
1084
+ },
1085
+ "uiId": {
1086
+ "type": "string",
1087
+ "maxLength": 48
1088
+ },
1089
+ "description": {
1090
+ "type": "string",
1091
+ "maxLength": 32767
1092
+ },
1093
+ "icon": {
1094
+ "type": "string",
1095
+ "maxLength": 1024
1096
+ },
1097
+ "color": {
1098
+ "type": "string",
1099
+ "maxLength": 1024
1100
+ },
1101
+ "inputCount": {
1102
+ "type": "number"
1103
+ },
1104
+ "outputCount": {
1105
+ "type": "number"
1106
+ },
1107
+ "triggerId": {
1108
+ "type": "string",
1109
+ "maxLength": 48
1110
+ },
1111
+ "id": {
1112
+ "type": "string",
1113
+ "maxLength": 48
1114
+ }
1115
+ },
1116
+ "additionalProperties": false
1117
+ },
1118
+ "outputIds": {
1119
+ "type": "array",
1120
+ "items": {
1121
+ "type": "array",
1122
+ "items": {
1123
+ "type": "string",
1124
+ "maxLength": 255
1125
+ },
1126
+ "maxItems": 100
1127
+ },
1128
+ "maxItems": 100
1129
+ }
1130
+ },
1131
+ "required": [
1132
+ "type"
1133
+ ],
1134
+ "additionalProperties": false
1135
+ },
1034
1136
  {
1035
1137
  "type": "object",
1036
1138
  "properties": {
@@ -1317,6 +1419,19 @@
1317
1419
  "baudRate": {
1318
1420
  "type": "number"
1319
1421
  },
1422
+ "dataBits": {
1423
+ "type": "number"
1424
+ },
1425
+ "stopBits": {
1426
+ "type": "number"
1427
+ },
1428
+ "parity": {
1429
+ "type": "string",
1430
+ "maxLength": 8
1431
+ },
1432
+ "rtscts": {
1433
+ "type": "boolean"
1434
+ },
1320
1435
  "encoding": {
1321
1436
  "type": "string",
1322
1437
  "maxLength": 48
@@ -2149,7 +2264,6 @@
2149
2264
  "deviceIdDisconnect",
2150
2265
  "deviceTagDisconnect",
2151
2266
  "integration",
2152
- "mqttTopic",
2153
2267
  "notebook",
2154
2268
  "onBoot",
2155
2269
  "onConnect",
@@ -3095,6 +3209,109 @@
3095
3209
  ],
3096
3210
  "additionalProperties": false
3097
3211
  },
3212
+ {
3213
+ "type": "object",
3214
+ "properties": {
3215
+ "key": {
3216
+ "type": "string",
3217
+ "maxLength": 1024
3218
+ },
3219
+ "type": {
3220
+ "type": "string",
3221
+ "enum": [
3222
+ "mqttTopic"
3223
+ ]
3224
+ },
3225
+ "config": {
3226
+ "type": "object",
3227
+ "properties": {
3228
+ "integrationId": {
3229
+ "type": "string",
3230
+ "enum": [
3231
+ "losant",
3232
+ "local"
3233
+ ]
3234
+ }
3235
+ },
3236
+ "additionalProperties": false
3237
+ },
3238
+ "meta": {
3239
+ "type": "object",
3240
+ "properties": {
3241
+ "category": {
3242
+ "type": "string",
3243
+ "enum": [
3244
+ "trigger"
3245
+ ]
3246
+ },
3247
+ "name": {
3248
+ "type": "string",
3249
+ "enum": [
3250
+ "mqtt"
3251
+ ]
3252
+ },
3253
+ "label": {
3254
+ "type": "string",
3255
+ "minLength": 1,
3256
+ "maxLength": 255
3257
+ },
3258
+ "x": {
3259
+ "type": "number"
3260
+ },
3261
+ "y": {
3262
+ "type": "number"
3263
+ },
3264
+ "uiId": {
3265
+ "type": "string",
3266
+ "maxLength": 48
3267
+ },
3268
+ "description": {
3269
+ "type": "string",
3270
+ "maxLength": 32767
3271
+ },
3272
+ "icon": {
3273
+ "type": "string",
3274
+ "maxLength": 1024
3275
+ },
3276
+ "color": {
3277
+ "type": "string",
3278
+ "maxLength": 1024
3279
+ },
3280
+ "inputCount": {
3281
+ "type": "number"
3282
+ },
3283
+ "outputCount": {
3284
+ "type": "number"
3285
+ },
3286
+ "triggerId": {
3287
+ "type": "string",
3288
+ "maxLength": 48
3289
+ },
3290
+ "id": {
3291
+ "type": "string",
3292
+ "maxLength": 48
3293
+ }
3294
+ },
3295
+ "additionalProperties": false
3296
+ },
3297
+ "outputIds": {
3298
+ "type": "array",
3299
+ "items": {
3300
+ "type": "array",
3301
+ "items": {
3302
+ "type": "string",
3303
+ "maxLength": 255
3304
+ },
3305
+ "maxItems": 100
3306
+ },
3307
+ "maxItems": 100
3308
+ }
3309
+ },
3310
+ "required": [
3311
+ "type"
3312
+ ],
3313
+ "additionalProperties": false
3314
+ },
3098
3315
  {
3099
3316
  "type": "object",
3100
3317
  "properties": {
@@ -3381,6 +3598,19 @@
3381
3598
  "baudRate": {
3382
3599
  "type": "number"
3383
3600
  },
3601
+ "dataBits": {
3602
+ "type": "number"
3603
+ },
3604
+ "stopBits": {
3605
+ "type": "number"
3606
+ },
3607
+ "parity": {
3608
+ "type": "string",
3609
+ "maxLength": 8
3610
+ },
3611
+ "rtscts": {
3612
+ "type": "boolean"
3613
+ },
3384
3614
  "encoding": {
3385
3615
  "type": "string",
3386
3616
  "maxLength": 48
@@ -4213,7 +4443,6 @@
4213
4443
  "deviceIdDisconnect",
4214
4444
  "deviceTagDisconnect",
4215
4445
  "integration",
4216
- "mqttTopic",
4217
4446
  "notebook",
4218
4447
  "onBoot",
4219
4448
  "onConnect",
@@ -5159,6 +5388,109 @@
5159
5388
  ],
5160
5389
  "additionalProperties": false
5161
5390
  },
5391
+ {
5392
+ "type": "object",
5393
+ "properties": {
5394
+ "key": {
5395
+ "type": "string",
5396
+ "maxLength": 1024
5397
+ },
5398
+ "type": {
5399
+ "type": "string",
5400
+ "enum": [
5401
+ "mqttTopic"
5402
+ ]
5403
+ },
5404
+ "config": {
5405
+ "type": "object",
5406
+ "properties": {
5407
+ "integrationId": {
5408
+ "type": "string",
5409
+ "enum": [
5410
+ "losant",
5411
+ "local"
5412
+ ]
5413
+ }
5414
+ },
5415
+ "additionalProperties": false
5416
+ },
5417
+ "meta": {
5418
+ "type": "object",
5419
+ "properties": {
5420
+ "category": {
5421
+ "type": "string",
5422
+ "enum": [
5423
+ "trigger"
5424
+ ]
5425
+ },
5426
+ "name": {
5427
+ "type": "string",
5428
+ "enum": [
5429
+ "mqtt"
5430
+ ]
5431
+ },
5432
+ "label": {
5433
+ "type": "string",
5434
+ "minLength": 1,
5435
+ "maxLength": 255
5436
+ },
5437
+ "x": {
5438
+ "type": "number"
5439
+ },
5440
+ "y": {
5441
+ "type": "number"
5442
+ },
5443
+ "uiId": {
5444
+ "type": "string",
5445
+ "maxLength": 48
5446
+ },
5447
+ "description": {
5448
+ "type": "string",
5449
+ "maxLength": 32767
5450
+ },
5451
+ "icon": {
5452
+ "type": "string",
5453
+ "maxLength": 1024
5454
+ },
5455
+ "color": {
5456
+ "type": "string",
5457
+ "maxLength": 1024
5458
+ },
5459
+ "inputCount": {
5460
+ "type": "number"
5461
+ },
5462
+ "outputCount": {
5463
+ "type": "number"
5464
+ },
5465
+ "triggerId": {
5466
+ "type": "string",
5467
+ "maxLength": 48
5468
+ },
5469
+ "id": {
5470
+ "type": "string",
5471
+ "maxLength": 48
5472
+ }
5473
+ },
5474
+ "additionalProperties": false
5475
+ },
5476
+ "outputIds": {
5477
+ "type": "array",
5478
+ "items": {
5479
+ "type": "array",
5480
+ "items": {
5481
+ "type": "string",
5482
+ "maxLength": 255
5483
+ },
5484
+ "maxItems": 100
5485
+ },
5486
+ "maxItems": 100
5487
+ }
5488
+ },
5489
+ "required": [
5490
+ "type"
5491
+ ],
5492
+ "additionalProperties": false
5493
+ },
5162
5494
  {
5163
5495
  "type": "object",
5164
5496
  "properties": {
@@ -5445,6 +5777,19 @@
5445
5777
  "baudRate": {
5446
5778
  "type": "number"
5447
5779
  },
5780
+ "dataBits": {
5781
+ "type": "number"
5782
+ },
5783
+ "stopBits": {
5784
+ "type": "number"
5785
+ },
5786
+ "parity": {
5787
+ "type": "string",
5788
+ "maxLength": 8
5789
+ },
5790
+ "rtscts": {
5791
+ "type": "boolean"
5792
+ },
5448
5793
  "encoding": {
5449
5794
  "type": "string",
5450
5795
  "maxLength": 48
data/schemas/githubLogin.json CHANGED
@@ -4,7 +4,8 @@
4
4
  "properties": {
5
5
  "accessToken": {
6
6
  "type": "string",
7
- "minLength": 1
7
+ "minLength": 1,
8
+ "maxLength": 1024
8
9
  },
9
10
  "requestedScopes": {
10
11
  "type": "array",
@@ -68,10 +69,12 @@
68
69
  "notebooks.*",
69
70
  "webhook.*",
70
71
  "webhooks.*",
72
+ "application.applyTemplate",
71
73
  "application.archiveData",
72
74
  "application.backfillArchiveData",
73
75
  "application.clone",
74
76
  "application.export",
77
+ "application.import",
75
78
  "application.fullEventsArchive",
76
79
  "application.fullDataTablesArchive",
77
80
  "application.debug",
@@ -143,6 +146,8 @@
143
146
  "deviceRecipes.get",
144
147
  "deviceRecipes.post",
145
148
  "devices.patch",
149
+ "devices.delete",
150
+ "devices.removeData",
146
151
  "devices.detailedSummary",
147
152
  "devices.export",
148
153
  "devices.get",
@@ -213,23 +218,27 @@
213
218
  "file.upload",
214
219
  "files.get",
215
220
  "files.post",
221
+ "flow.clearStorageEntries",
216
222
  "flow.debug",
217
223
  "flow.delete",
218
- "flow.clearStorageEntries",
224
+ "flow.errors",
219
225
  "flow.get",
220
226
  "flow.getStorageEntries",
221
227
  "flow.log",
222
228
  "flow.patch",
223
229
  "flow.pressVirtualButton",
224
230
  "flow.setStorageEntry",
231
+ "flow.stats",
225
232
  "flows.get",
226
233
  "flows.getByVersion",
227
234
  "flows.import",
228
235
  "flows.post",
229
236
  "flowVersion.delete",
237
+ "flowVersion.errors",
230
238
  "flowVersion.get",
231
239
  "flowVersion.log",
232
240
  "flowVersion.patch",
241
+ "flowVersion.stats",
233
242
  "flowVersions.get",
234
243
  "flowVersions.post",
235
244
  "integration.delete",
@@ -297,8 +306,12 @@
297
306
  "enum": [
298
307
  "all.User",
299
308
  "all.User.read",
309
+ "applicationTemplate.*",
310
+ "applicationTemplate.get",
300
311
  "applicationTemplates.*",
301
312
  "applicationTemplates.get",
313
+ "applicationTemplates.getCategories",
314
+ "applicationTemplates.getUniqueKeywords",
302
315
  "me.*",
303
316
  "orgs.*",
304
317
  "me.get",
@@ -310,8 +323,6 @@
310
323
  "me.disableTwoFactorAuth",
311
324
  "me.disconnectGithub",
312
325
  "me.connectGithub",
313
- "me.disconnectTwitter",
314
- "me.connectTwitter",
315
326
  "me.addRecentItem",
316
327
  "me.fetchRecentItems",
317
328
  "me.payloadCounts",