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
@@ -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
@@ -2133,7 +2248,6 @@
2133
2248
  "deviceIdDisconnect",
2134
2249
  "deviceTagDisconnect",
2135
2250
  "integration",
2136
- "mqttTopic",
2137
2251
  "notebook",
2138
2252
  "onBoot",
2139
2253
  "onConnect",
@@ -3079,6 +3193,109 @@
3079
3193
  ],
3080
3194
  "additionalProperties": false
3081
3195
  },
3196
+ {
3197
+ "type": "object",
3198
+ "properties": {
3199
+ "key": {
3200
+ "type": "string",
3201
+ "maxLength": 1024
3202
+ },
3203
+ "type": {
3204
+ "type": "string",
3205
+ "enum": [
3206
+ "mqttTopic"
3207
+ ]
3208
+ },
3209
+ "config": {
3210
+ "type": "object",
3211
+ "properties": {
3212
+ "integrationId": {
3213
+ "type": "string",
3214
+ "enum": [
3215
+ "losant",
3216
+ "local"
3217
+ ]
3218
+ }
3219
+ },
3220
+ "additionalProperties": false
3221
+ },
3222
+ "meta": {
3223
+ "type": "object",
3224
+ "properties": {
3225
+ "category": {
3226
+ "type": "string",
3227
+ "enum": [
3228
+ "trigger"
3229
+ ]
3230
+ },
3231
+ "name": {
3232
+ "type": "string",
3233
+ "enum": [
3234
+ "mqtt"
3235
+ ]
3236
+ },
3237
+ "label": {
3238
+ "type": "string",
3239
+ "minLength": 1,
3240
+ "maxLength": 255
3241
+ },
3242
+ "x": {
3243
+ "type": "number"
3244
+ },
3245
+ "y": {
3246
+ "type": "number"
3247
+ },
3248
+ "uiId": {
3249
+ "type": "string",
3250
+ "maxLength": 48
3251
+ },
3252
+ "description": {
3253
+ "type": "string",
3254
+ "maxLength": 32767
3255
+ },
3256
+ "icon": {
3257
+ "type": "string",
3258
+ "maxLength": 1024
3259
+ },
3260
+ "color": {
3261
+ "type": "string",
3262
+ "maxLength": 1024
3263
+ },
3264
+ "inputCount": {
3265
+ "type": "number"
3266
+ },
3267
+ "outputCount": {
3268
+ "type": "number"
3269
+ },
3270
+ "triggerId": {
3271
+ "type": "string",
3272
+ "maxLength": 48
3273
+ },
3274
+ "id": {
3275
+ "type": "string",
3276
+ "maxLength": 48
3277
+ }
3278
+ },
3279
+ "additionalProperties": false
3280
+ },
3281
+ "outputIds": {
3282
+ "type": "array",
3283
+ "items": {
3284
+ "type": "array",
3285
+ "items": {
3286
+ "type": "string",
3287
+ "maxLength": 255
3288
+ },
3289
+ "maxItems": 100
3290
+ },
3291
+ "maxItems": 100
3292
+ }
3293
+ },
3294
+ "required": [
3295
+ "type"
3296
+ ],
3297
+ "additionalProperties": false
3298
+ },
3082
3299
  {
3083
3300
  "type": "object",
3084
3301
  "properties": {
@@ -3365,6 +3582,19 @@
3365
3582
  "baudRate": {
3366
3583
  "type": "number"
3367
3584
  },
3585
+ "dataBits": {
3586
+ "type": "number"
3587
+ },
3588
+ "stopBits": {
3589
+ "type": "number"
3590
+ },
3591
+ "parity": {
3592
+ "type": "string",
3593
+ "maxLength": 8
3594
+ },
3595
+ "rtscts": {
3596
+ "type": "boolean"
3597
+ },
3368
3598
  "encoding": {
3369
3599
  "type": "string",
3370
3600
  "maxLength": 48
@@ -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
@@ -54,7 +54,6 @@
54
54
  "deviceIdDisconnect",
55
55
  "deviceTagDisconnect",
56
56
  "integration",
57
- "mqttTopic",
58
57
  "notebook",
59
58
  "onBoot",
60
59
  "onConnect",
@@ -1000,6 +999,109 @@
1000
999
  ],
1001
1000
  "additionalProperties": false
1002
1001
  },
1002
+ {
1003
+ "type": "object",
1004
+ "properties": {
1005
+ "key": {
1006
+ "type": "string",
1007
+ "maxLength": 1024
1008
+ },
1009
+ "type": {
1010
+ "type": "string",
1011
+ "enum": [
1012
+ "mqttTopic"
1013
+ ]
1014
+ },
1015
+ "config": {
1016
+ "type": "object",
1017
+ "properties": {
1018
+ "integrationId": {
1019
+ "type": "string",
1020
+ "enum": [
1021
+ "losant",
1022
+ "local"
1023
+ ]
1024
+ }
1025
+ },
1026
+ "additionalProperties": false
1027
+ },
1028
+ "meta": {
1029
+ "type": "object",
1030
+ "properties": {
1031
+ "category": {
1032
+ "type": "string",
1033
+ "enum": [
1034
+ "trigger"
1035
+ ]
1036
+ },
1037
+ "name": {
1038
+ "type": "string",
1039
+ "enum": [
1040
+ "mqtt"
1041
+ ]
1042
+ },
1043
+ "label": {
1044
+ "type": "string",
1045
+ "minLength": 1,
1046
+ "maxLength": 255
1047
+ },
1048
+ "x": {
1049
+ "type": "number"
1050
+ },
1051
+ "y": {
1052
+ "type": "number"
1053
+ },
1054
+ "uiId": {
1055
+ "type": "string",
1056
+ "maxLength": 48
1057
+ },
1058
+ "description": {
1059
+ "type": "string",
1060
+ "maxLength": 32767
1061
+ },
1062
+ "icon": {
1063
+ "type": "string",
1064
+ "maxLength": 1024
1065
+ },
1066
+ "color": {
1067
+ "type": "string",
1068
+ "maxLength": 1024
1069
+ },
1070
+ "inputCount": {
1071
+ "type": "number"
1072
+ },
1073
+ "outputCount": {
1074
+ "type": "number"
1075
+ },
1076
+ "triggerId": {
1077
+ "type": "string",
1078
+ "maxLength": 48
1079
+ },
1080
+ "id": {
1081
+ "type": "string",
1082
+ "maxLength": 48
1083
+ }
1084
+ },
1085
+ "additionalProperties": false
1086
+ },
1087
+ "outputIds": {
1088
+ "type": "array",
1089
+ "items": {
1090
+ "type": "array",
1091
+ "items": {
1092
+ "type": "string",
1093
+ "maxLength": 255
1094
+ },
1095
+ "maxItems": 100
1096
+ },
1097
+ "maxItems": 100
1098
+ }
1099
+ },
1100
+ "required": [
1101
+ "type"
1102
+ ],
1103
+ "additionalProperties": false
1104
+ },
1003
1105
  {
1004
1106
  "type": "object",
1005
1107
  "properties": {
@@ -1286,6 +1388,19 @@
1286
1388
  "baudRate": {
1287
1389
  "type": "number"
1288
1390
  },
1391
+ "dataBits": {
1392
+ "type": "number"
1393
+ },
1394
+ "stopBits": {
1395
+ "type": "number"
1396
+ },
1397
+ "parity": {
1398
+ "type": "string",
1399
+ "maxLength": 8
1400
+ },
1401
+ "rtscts": {
1402
+ "type": "boolean"
1403
+ },
1289
1404
  "encoding": {
1290
1405
  "type": "string",
1291
1406
  "maxLength": 48
@@ -2099,7 +2214,6 @@
2099
2214
  "deviceIdDisconnect",
2100
2215
  "deviceTagDisconnect",
2101
2216
  "integration",
2102
- "mqttTopic",
2103
2217
  "notebook",
2104
2218
  "onBoot",
2105
2219
  "onConnect",
@@ -3045,6 +3159,109 @@
3045
3159
  ],
3046
3160
  "additionalProperties": false
3047
3161
  },
3162
+ {
3163
+ "type": "object",
3164
+ "properties": {
3165
+ "key": {
3166
+ "type": "string",
3167
+ "maxLength": 1024
3168
+ },
3169
+ "type": {
3170
+ "type": "string",
3171
+ "enum": [
3172
+ "mqttTopic"
3173
+ ]
3174
+ },
3175
+ "config": {
3176
+ "type": "object",
3177
+ "properties": {
3178
+ "integrationId": {
3179
+ "type": "string",
3180
+ "enum": [
3181
+ "losant",
3182
+ "local"
3183
+ ]
3184
+ }
3185
+ },
3186
+ "additionalProperties": false
3187
+ },
3188
+ "meta": {
3189
+ "type": "object",
3190
+ "properties": {
3191
+ "category": {
3192
+ "type": "string",
3193
+ "enum": [
3194
+ "trigger"
3195
+ ]
3196
+ },
3197
+ "name": {
3198
+ "type": "string",
3199
+ "enum": [
3200
+ "mqtt"
3201
+ ]
3202
+ },
3203
+ "label": {
3204
+ "type": "string",
3205
+ "minLength": 1,
3206
+ "maxLength": 255
3207
+ },
3208
+ "x": {
3209
+ "type": "number"
3210
+ },
3211
+ "y": {
3212
+ "type": "number"
3213
+ },
3214
+ "uiId": {
3215
+ "type": "string",
3216
+ "maxLength": 48
3217
+ },
3218
+ "description": {
3219
+ "type": "string",
3220
+ "maxLength": 32767
3221
+ },
3222
+ "icon": {
3223
+ "type": "string",
3224
+ "maxLength": 1024
3225
+ },
3226
+ "color": {
3227
+ "type": "string",
3228
+ "maxLength": 1024
3229
+ },
3230
+ "inputCount": {
3231
+ "type": "number"
3232
+ },
3233
+ "outputCount": {
3234
+ "type": "number"
3235
+ },
3236
+ "triggerId": {
3237
+ "type": "string",
3238
+ "maxLength": 48
3239
+ },
3240
+ "id": {
3241
+ "type": "string",
3242
+ "maxLength": 48
3243
+ }
3244
+ },
3245
+ "additionalProperties": false
3246
+ },
3247
+ "outputIds": {
3248
+ "type": "array",
3249
+ "items": {
3250
+ "type": "array",
3251
+ "items": {
3252
+ "type": "string",
3253
+ "maxLength": 255
3254
+ },
3255
+ "maxItems": 100
3256
+ },
3257
+ "maxItems": 100
3258
+ }
3259
+ },
3260
+ "required": [
3261
+ "type"
3262
+ ],
3263
+ "additionalProperties": false
3264
+ },
3048
3265
  {
3049
3266
  "type": "object",
3050
3267
  "properties": {
@@ -3331,6 +3548,19 @@
3331
3548
  "baudRate": {
3332
3549
  "type": "number"
3333
3550
  },
3551
+ "dataBits": {
3552
+ "type": "number"
3553
+ },
3554
+ "stopBits": {
3555
+ "type": "number"
3556
+ },
3557
+ "parity": {
3558
+ "type": "string",
3559
+ "maxLength": 8
3560
+ },
3561
+ "rtscts": {
3562
+ "type": "boolean"
3563
+ },
3334
3564
  "encoding": {
3335
3565
  "type": "string",
3336
3566
  "maxLength": 48