losant_rest 1.10.0 → 1.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (129) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +18838 -4104
  3. data/docs/application.md +85 -0
  4. data/docs/applicationApiTokens.md +2 -2
  5. data/docs/applicationCertificateAuthorities.md +1 -1
  6. data/docs/applicationCertificates.md +1 -1
  7. data/docs/applicationKeys.md +1 -1
  8. data/docs/applicationTemplate.md +46 -0
  9. data/docs/applicationTemplates.md +77 -2
  10. data/docs/applications.md +1 -1
  11. data/docs/auditLogs.md +1 -1
  12. data/docs/dashboards.md +1 -1
  13. data/docs/dataTables.md +1 -1
  14. data/docs/device.md +7 -3
  15. data/docs/deviceRecipes.md +1 -1
  16. data/docs/devices.md +93 -5
  17. data/docs/edgeDeployments.md +1 -1
  18. data/docs/events.md +1 -1
  19. data/docs/experienceEndpoints.md +1 -0
  20. data/docs/experienceGroups.md +1 -1
  21. data/docs/experienceUsers.md +1 -1
  22. data/docs/experienceVersions.md +1 -1
  23. data/docs/experienceViews.md +1 -1
  24. data/docs/file.md +4 -4
  25. data/docs/files.md +1 -1
  26. data/docs/flow.md +94 -1
  27. data/docs/flowVersion.md +96 -1
  28. data/docs/flowVersions.md +1 -1
  29. data/docs/flows.md +2 -2
  30. data/docs/integrations.md +1 -1
  31. data/docs/me.md +0 -36
  32. data/docs/notebooks.md +1 -1
  33. data/docs/orgs.md +1 -1
  34. data/docs/webhooks.md +1 -1
  35. data/lib/losant_rest.rb +1 -0
  36. data/lib/losant_rest/application.rb +48 -0
  37. data/lib/losant_rest/application_api_tokens.rb +1 -1
  38. data/lib/losant_rest/application_template.rb +79 -0
  39. data/lib/losant_rest/application_templates.rb +89 -1
  40. data/lib/losant_rest/client.rb +6 -2
  41. data/lib/losant_rest/device.rb +11 -3
  42. data/lib/losant_rest/devices.rb +103 -3
  43. data/lib/losant_rest/experience_endpoints.rb +2 -0
  44. data/lib/losant_rest/file.rb +3 -3
  45. data/lib/losant_rest/flow.rb +115 -1
  46. data/lib/losant_rest/flow_version.rb +115 -1
  47. data/lib/losant_rest/me.rb +0 -41
  48. data/lib/losant_rest/version.rb +1 -1
  49. data/schemas/advancedDeviceQuery.json +110 -0
  50. data/schemas/advancedEventQuery.json +198 -0
  51. data/schemas/advancedQuery.json +22 -0
  52. data/schemas/application.json +13 -0
  53. data/schemas/applicationApiTokenPost.json +10 -1
  54. data/schemas/applicationApplyTemplatePatch.json +19 -0
  55. data/schemas/applicationCreationByTemplateResult.json +13 -0
  56. data/schemas/applicationPatch.json +5 -0
  57. data/schemas/applicationPost.json +13 -0
  58. data/schemas/applicationTemplate.json +20 -0
  59. data/schemas/applicationTemplateCategories.json +43 -0
  60. data/schemas/applicationTemplateCategory.json +23 -0
  61. data/schemas/applicationTemplates.json +32 -0
  62. data/schemas/applications.json +13 -0
  63. data/schemas/authedUser.json +3 -0
  64. data/schemas/changePassword.json +2 -2
  65. data/schemas/dashboard.json +1288 -145
  66. data/schemas/dashboardPatch.json +1288 -145
  67. data/schemas/dashboardPost.json +1288 -145
  68. data/schemas/dashboards.json +1288 -145
  69. data/schemas/dataExport.json +142 -0
  70. data/schemas/dataTableRowsExport.json +22 -0
  71. data/schemas/device.json +16 -3
  72. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  73. data/schemas/deviceClassFilter.json +1 -2
  74. data/schemas/devicePatch.json +16 -3
  75. data/schemas/devicePost.json +16 -3
  76. data/schemas/deviceRecipe.json +16 -3
  77. data/schemas/deviceRecipePatch.json +16 -3
  78. data/schemas/deviceRecipePost.json +16 -3
  79. data/schemas/deviceRecipes.json +16 -3
  80. data/schemas/devices.json +16 -3
  81. data/schemas/devicesDataRemoved.json +12 -0
  82. data/schemas/devicesDeletePost.json +1034 -0
  83. data/schemas/devicesDeleted.json +12 -0
  84. data/schemas/devicesExportPost.json +1035 -0
  85. data/schemas/devicesPatch.json +1773 -7
  86. data/schemas/devicesRemoveDataPost.json +1056 -0
  87. data/schemas/devicesUpdated.json +18 -0
  88. data/schemas/eventPost.json +22 -0
  89. data/schemas/eventsExport.json +198 -0
  90. data/schemas/experienceDomain.json +1 -1
  91. data/schemas/experienceDomainPatch.json +1 -1
  92. data/schemas/experienceDomainPost.json +1 -1
  93. data/schemas/experienceDomains.json +1 -1
  94. data/schemas/experienceLinkedResources.json +372 -3
  95. data/schemas/experienceVersion.json +1 -1
  96. data/schemas/experienceVersions.json +1 -1
  97. data/schemas/flow.json +124 -1
  98. data/schemas/flowErrors.json +87 -0
  99. data/schemas/flowPatch.json +124 -1
  100. data/schemas/flowPost.json +124 -1
  101. data/schemas/flowStats.json +54 -0
  102. data/schemas/flowVersion.json +248 -2
  103. data/schemas/flowVersionPost.json +124 -1
  104. data/schemas/flowVersions.json +248 -2
  105. data/schemas/flows.json +124 -1
  106. data/schemas/flowsImportPost.json +248 -2
  107. data/schemas/flowsImportResult.json +372 -3
  108. data/schemas/githubLogin.json +16 -4
  109. data/schemas/me.json +3 -3
  110. data/schemas/mePatch.json +2 -2
  111. data/schemas/multiDeviceCommand.json +1019 -0
  112. data/schemas/notebook.json +89 -0
  113. data/schemas/notebookPatch.json +89 -0
  114. data/schemas/notebookPost.json +89 -0
  115. data/schemas/notebooks.json +89 -0
  116. data/schemas/org.json +1 -1
  117. data/schemas/orgInviteInfo.json +3 -0
  118. data/schemas/orgInvitePost.json +3 -0
  119. data/schemas/orgInvites.json +3 -0
  120. data/schemas/orgPatch.json +1 -1
  121. data/schemas/orgs.json +1 -1
  122. data/schemas/passwordResetFinish.json +2 -2
  123. data/schemas/samlResponse.json +1 -1
  124. data/schemas/templateKeywords.json +14 -0
  125. data/schemas/timeSeriesData.json +101 -12
  126. data/schemas/timeSeriesQuery.json +101 -12
  127. data/schemas/userCredentials.json +14 -3
  128. data/schemas/userPost.json +22 -7
  129. metadata +20 -5
data/schemas/flowVersions.json CHANGED
@@ -69,7 +69,6 @@
69
69
  "deviceIdDisconnect",
70
70
  "deviceTagDisconnect",
71
71
  "integration",
72
- "mqttTopic",
73
72
  "notebook",
74
73
  "onBoot",
75
74
  "onConnect",
@@ -1015,6 +1014,109 @@
1015
1014
  ],
1016
1015
  "additionalProperties": false
1017
1016
  },
1017
+ {
1018
+ "type": "object",
1019
+ "properties": {
1020
+ "key": {
1021
+ "type": "string",
1022
+ "maxLength": 1024
1023
+ },
1024
+ "type": {
1025
+ "type": "string",
1026
+ "enum": [
1027
+ "mqttTopic"
1028
+ ]
1029
+ },
1030
+ "config": {
1031
+ "type": "object",
1032
+ "properties": {
1033
+ "integrationId": {
1034
+ "type": "string",
1035
+ "enum": [
1036
+ "losant",
1037
+ "local"
1038
+ ]
1039
+ }
1040
+ },
1041
+ "additionalProperties": false
1042
+ },
1043
+ "meta": {
1044
+ "type": "object",
1045
+ "properties": {
1046
+ "category": {
1047
+ "type": "string",
1048
+ "enum": [
1049
+ "trigger"
1050
+ ]
1051
+ },
1052
+ "name": {
1053
+ "type": "string",
1054
+ "enum": [
1055
+ "mqtt"
1056
+ ]
1057
+ },
1058
+ "label": {
1059
+ "type": "string",
1060
+ "minLength": 1,
1061
+ "maxLength": 255
1062
+ },
1063
+ "x": {
1064
+ "type": "number"
1065
+ },
1066
+ "y": {
1067
+ "type": "number"
1068
+ },
1069
+ "uiId": {
1070
+ "type": "string",
1071
+ "maxLength": 48
1072
+ },
1073
+ "description": {
1074
+ "type": "string",
1075
+ "maxLength": 32767
1076
+ },
1077
+ "icon": {
1078
+ "type": "string",
1079
+ "maxLength": 1024
1080
+ },
1081
+ "color": {
1082
+ "type": "string",
1083
+ "maxLength": 1024
1084
+ },
1085
+ "inputCount": {
1086
+ "type": "number"
1087
+ },
1088
+ "outputCount": {
1089
+ "type": "number"
1090
+ },
1091
+ "triggerId": {
1092
+ "type": "string",
1093
+ "maxLength": 48
1094
+ },
1095
+ "id": {
1096
+ "type": "string",
1097
+ "maxLength": 48
1098
+ }
1099
+ },
1100
+ "additionalProperties": false
1101
+ },
1102
+ "outputIds": {
1103
+ "type": "array",
1104
+ "items": {
1105
+ "type": "array",
1106
+ "items": {
1107
+ "type": "string",
1108
+ "maxLength": 255
1109
+ },
1110
+ "maxItems": 100
1111
+ },
1112
+ "maxItems": 100
1113
+ }
1114
+ },
1115
+ "required": [
1116
+ "type"
1117
+ ],
1118
+ "additionalProperties": false
1119
+ },
1018
1120
  {
1019
1121
  "type": "object",
1020
1122
  "properties": {
@@ -1301,6 +1403,19 @@
1301
1403
  "baudRate": {
1302
1404
  "type": "number"
1303
1405
  },
1406
+ "dataBits": {
1407
+ "type": "number"
1408
+ },
1409
+ "stopBits": {
1410
+ "type": "number"
1411
+ },
1412
+ "parity": {
1413
+ "type": "string",
1414
+ "maxLength": 8
1415
+ },
1416
+ "rtscts": {
1417
+ "type": "boolean"
1418
+ },
1304
1419
  "encoding": {
1305
1420
  "type": "string",
1306
1421
  "maxLength": 48
@@ -1309,6 +1424,10 @@
1309
1424
  "type": "string",
1310
1425
  "maxLength": 1024
1311
1426
  },
1427
+ "writeOnOpenEncoding": {
1428
+ "type": "string",
1429
+ "maxLength": 48
1430
+ },
1312
1431
  "byteLength": {
1313
1432
  "type": "string",
1314
1433
  "maxLength": 48
@@ -1316,6 +1435,10 @@
1316
1435
  "delimiter": {
1317
1436
  "type": "string",
1318
1437
  "maxLength": 48
1438
+ },
1439
+ "delimiterEncoding": {
1440
+ "type": "string",
1441
+ "maxLength": 48
1319
1442
  }
1320
1443
  },
1321
1444
  "additionalProperties": false
@@ -2133,7 +2256,6 @@
2133
2256
  "deviceIdDisconnect",
2134
2257
  "deviceTagDisconnect",
2135
2258
  "integration",
2136
- "mqttTopic",
2137
2259
  "notebook",
2138
2260
  "onBoot",
2139
2261
  "onConnect",
@@ -3079,6 +3201,109 @@
3079
3201
  ],
3080
3202
  "additionalProperties": false
3081
3203
  },
3204
+ {
3205
+ "type": "object",
3206
+ "properties": {
3207
+ "key": {
3208
+ "type": "string",
3209
+ "maxLength": 1024
3210
+ },
3211
+ "type": {
3212
+ "type": "string",
3213
+ "enum": [
3214
+ "mqttTopic"
3215
+ ]
3216
+ },
3217
+ "config": {
3218
+ "type": "object",
3219
+ "properties": {
3220
+ "integrationId": {
3221
+ "type": "string",
3222
+ "enum": [
3223
+ "losant",
3224
+ "local"
3225
+ ]
3226
+ }
3227
+ },
3228
+ "additionalProperties": false
3229
+ },
3230
+ "meta": {
3231
+ "type": "object",
3232
+ "properties": {
3233
+ "category": {
3234
+ "type": "string",
3235
+ "enum": [
3236
+ "trigger"
3237
+ ]
3238
+ },
3239
+ "name": {
3240
+ "type": "string",
3241
+ "enum": [
3242
+ "mqtt"
3243
+ ]
3244
+ },
3245
+ "label": {
3246
+ "type": "string",
3247
+ "minLength": 1,
3248
+ "maxLength": 255
3249
+ },
3250
+ "x": {
3251
+ "type": "number"
3252
+ },
3253
+ "y": {
3254
+ "type": "number"
3255
+ },
3256
+ "uiId": {
3257
+ "type": "string",
3258
+ "maxLength": 48
3259
+ },
3260
+ "description": {
3261
+ "type": "string",
3262
+ "maxLength": 32767
3263
+ },
3264
+ "icon": {
3265
+ "type": "string",
3266
+ "maxLength": 1024
3267
+ },
3268
+ "color": {
3269
+ "type": "string",
3270
+ "maxLength": 1024
3271
+ },
3272
+ "inputCount": {
3273
+ "type": "number"
3274
+ },
3275
+ "outputCount": {
3276
+ "type": "number"
3277
+ },
3278
+ "triggerId": {
3279
+ "type": "string",
3280
+ "maxLength": 48
3281
+ },
3282
+ "id": {
3283
+ "type": "string",
3284
+ "maxLength": 48
3285
+ }
3286
+ },
3287
+ "additionalProperties": false
3288
+ },
3289
+ "outputIds": {
3290
+ "type": "array",
3291
+ "items": {
3292
+ "type": "array",
3293
+ "items": {
3294
+ "type": "string",
3295
+ "maxLength": 255
3296
+ },
3297
+ "maxItems": 100
3298
+ },
3299
+ "maxItems": 100
3300
+ }
3301
+ },
3302
+ "required": [
3303
+ "type"
3304
+ ],
3305
+ "additionalProperties": false
3306
+ },
3082
3307
  {
3083
3308
  "type": "object",
3084
3309
  "properties": {
@@ -3365,6 +3590,19 @@
3365
3590
  "baudRate": {
3366
3591
  "type": "number"
3367
3592
  },
3593
+ "dataBits": {
3594
+ "type": "number"
3595
+ },
3596
+ "stopBits": {
3597
+ "type": "number"
3598
+ },
3599
+ "parity": {
3600
+ "type": "string",
3601
+ "maxLength": 8
3602
+ },
3603
+ "rtscts": {
3604
+ "type": "boolean"
3605
+ },
3368
3606
  "encoding": {
3369
3607
  "type": "string",
3370
3608
  "maxLength": 48
@@ -3373,6 +3611,10 @@
3373
3611
  "type": "string",
3374
3612
  "maxLength": 1024
3375
3613
  },
3614
+ "writeOnOpenEncoding": {
3615
+ "type": "string",
3616
+ "maxLength": 48
3617
+ },
3376
3618
  "byteLength": {
3377
3619
  "type": "string",
3378
3620
  "maxLength": 48
@@ -3380,6 +3622,10 @@
3380
3622
  "delimiter": {
3381
3623
  "type": "string",
3382
3624
  "maxLength": 48
3625
+ },
3626
+ "delimiterEncoding": {
3627
+ "type": "string",
3628
+ "maxLength": 48
3383
3629
  }
3384
3630
  },
3385
3631
  "additionalProperties": false
data/schemas/flows.json CHANGED
@@ -84,7 +84,6 @@
84
84
  "deviceIdDisconnect",
85
85
  "deviceTagDisconnect",
86
86
  "integration",
87
- "mqttTopic",
88
87
  "notebook",
89
88
  "onBoot",
90
89
  "onConnect",
@@ -1030,6 +1029,109 @@
1030
1029
  ],
1031
1030
  "additionalProperties": false
1032
1031
  },
1032
+ {
1033
+ "type": "object",
1034
+ "properties": {
1035
+ "key": {
1036
+ "type": "string",
1037
+ "maxLength": 1024
1038
+ },
1039
+ "type": {
1040
+ "type": "string",
1041
+ "enum": [
1042
+ "mqttTopic"
1043
+ ]
1044
+ },
1045
+ "config": {
1046
+ "type": "object",
1047
+ "properties": {
1048
+ "integrationId": {
1049
+ "type": "string",
1050
+ "enum": [
1051
+ "losant",
1052
+ "local"
1053
+ ]
1054
+ }
1055
+ },
1056
+ "additionalProperties": false
1057
+ },
1058
+ "meta": {
1059
+ "type": "object",
1060
+ "properties": {
1061
+ "category": {
1062
+ "type": "string",
1063
+ "enum": [
1064
+ "trigger"
1065
+ ]
1066
+ },
1067
+ "name": {
1068
+ "type": "string",
1069
+ "enum": [
1070
+ "mqtt"
1071
+ ]
1072
+ },
1073
+ "label": {
1074
+ "type": "string",
1075
+ "minLength": 1,
1076
+ "maxLength": 255
1077
+ },
1078
+ "x": {
1079
+ "type": "number"
1080
+ },
1081
+ "y": {
1082
+ "type": "number"
1083
+ },
1084
+ "uiId": {
1085
+ "type": "string",
1086
+ "maxLength": 48
1087
+ },
1088
+ "description": {
1089
+ "type": "string",
1090
+ "maxLength": 32767
1091
+ },
1092
+ "icon": {
1093
+ "type": "string",
1094
+ "maxLength": 1024
1095
+ },
1096
+ "color": {
1097
+ "type": "string",
1098
+ "maxLength": 1024
1099
+ },
1100
+ "inputCount": {
1101
+ "type": "number"
1102
+ },
1103
+ "outputCount": {
1104
+ "type": "number"
1105
+ },
1106
+ "triggerId": {
1107
+ "type": "string",
1108
+ "maxLength": 48
1109
+ },
1110
+ "id": {
1111
+ "type": "string",
1112
+ "maxLength": 48
1113
+ }
1114
+ },
1115
+ "additionalProperties": false
1116
+ },
1117
+ "outputIds": {
1118
+ "type": "array",
1119
+ "items": {
1120
+ "type": "array",
1121
+ "items": {
1122
+ "type": "string",
1123
+ "maxLength": 255
1124
+ },
1125
+ "maxItems": 100
1126
+ },
1127
+ "maxItems": 100
1128
+ }
1129
+ },
1130
+ "required": [
1131
+ "type"
1132
+ ],
1133
+ "additionalProperties": false
1134
+ },
1033
1135
  {
1034
1136
  "type": "object",
1035
1137
  "properties": {
@@ -1316,6 +1418,19 @@
1316
1418
  "baudRate": {
1317
1419
  "type": "number"
1318
1420
  },
1421
+ "dataBits": {
1422
+ "type": "number"
1423
+ },
1424
+ "stopBits": {
1425
+ "type": "number"
1426
+ },
1427
+ "parity": {
1428
+ "type": "string",
1429
+ "maxLength": 8
1430
+ },
1431
+ "rtscts": {
1432
+ "type": "boolean"
1433
+ },
1319
1434
  "encoding": {
1320
1435
  "type": "string",
1321
1436
  "maxLength": 48
@@ -1324,6 +1439,10 @@
1324
1439
  "type": "string",
1325
1440
  "maxLength": 1024
1326
1441
  },
1442
+ "writeOnOpenEncoding": {
1443
+ "type": "string",
1444
+ "maxLength": 48
1445
+ },
1327
1446
  "byteLength": {
1328
1447
  "type": "string",
1329
1448
  "maxLength": 48
@@ -1331,6 +1450,10 @@
1331
1450
  "delimiter": {
1332
1451
  "type": "string",
1333
1452
  "maxLength": 48
1453
+ },
1454
+ "delimiterEncoding": {
1455
+ "type": "string",
1456
+ "maxLength": 48
1334
1457
  }
1335
1458
  },
1336
1459
  "additionalProperties": false