losant_rest 1.9.2 → 1.10.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +38445 -24043
  3. data/docs/application.md +124 -2
  4. data/docs/applicationTemplates.md +50 -0
  5. data/docs/auth.md +72 -0
  6. data/docs/device.md +1 -0
  7. data/docs/devices.md +92 -3
  8. data/docs/experienceEndpoints.md +1 -0
  9. data/docs/file.md +4 -4
  10. data/docs/flow.md +94 -1
  11. data/docs/flowVersion.md +96 -1
  12. data/lib/losant_rest.rb +1 -0
  13. data/lib/losant_rest/application.rb +93 -2
  14. data/lib/losant_rest/application_templates.rb +88 -0
  15. data/lib/losant_rest/auth.rb +84 -0
  16. data/lib/losant_rest/client.rb +6 -2
  17. data/lib/losant_rest/device.rb +2 -0
  18. data/lib/losant_rest/devices.rb +105 -2
  19. data/lib/losant_rest/experience_endpoints.rb +2 -0
  20. data/lib/losant_rest/file.rb +3 -3
  21. data/lib/losant_rest/flow.rb +115 -1
  22. data/lib/losant_rest/flow_version.rb +115 -1
  23. data/lib/losant_rest/version.rb +2 -2
  24. data/schemas/advancedDeviceQuery.json +1018 -0
  25. data/schemas/advancedEventQuery.json +382 -13
  26. data/schemas/advancedQuery.json +37 -3
  27. data/schemas/application.json +7 -2
  28. data/schemas/applicationApiTokenPost.json +8 -1
  29. data/schemas/applicationCreationByTemplateResult.json +7 -2
  30. data/schemas/applicationPatch.json +7 -2
  31. data/schemas/applicationPost.json +11 -2
  32. data/schemas/applicationReadme.json +29 -0
  33. data/schemas/applicationReadmePatch.json +11 -0
  34. data/schemas/applicationTemplate.json +99 -0
  35. data/schemas/applicationTemplates.json +140 -0
  36. data/schemas/applications.json +7 -2
  37. data/schemas/dashboard.json +1168 -144
  38. data/schemas/dashboardPatch.json +1168 -144
  39. data/schemas/dashboardPost.json +1168 -144
  40. data/schemas/dashboards.json +1168 -144
  41. data/schemas/dataExport.json +11 -0
  42. data/schemas/dataTableRows.json +3 -0
  43. data/schemas/dataTableRowsExport.json +37 -3
  44. data/schemas/device.json +16 -3
  45. data/schemas/devicePatch.json +16 -3
  46. data/schemas/devicePost.json +16 -3
  47. data/schemas/deviceRecipe.json +16 -3
  48. data/schemas/deviceRecipePatch.json +16 -3
  49. data/schemas/deviceRecipePost.json +16 -3
  50. data/schemas/deviceRecipes.json +16 -3
  51. data/schemas/devices.json +19 -3
  52. data/schemas/devicesDataRemoved.json +12 -0
  53. data/schemas/devicesDeletePost.json +1034 -0
  54. data/schemas/devicesDeleted.json +12 -0
  55. data/schemas/devicesExportPost.json +1035 -0
  56. data/schemas/devicesPatch.json +1773 -7
  57. data/schemas/devicesRemoveDataPost.json +1056 -0
  58. data/schemas/devicesUpdated.json +18 -0
  59. data/schemas/eventPost.json +22 -0
  60. data/schemas/events.json +1 -816
  61. data/schemas/eventsExport.json +382 -13
  62. data/schemas/experienceDomain.json +1 -1
  63. data/schemas/experienceDomainPatch.json +1 -1
  64. data/schemas/experienceDomainPost.json +1 -1
  65. data/schemas/experienceDomains.json +1 -1
  66. data/schemas/experienceGroup.json +7 -0
  67. data/schemas/experienceGroupPatch.json +7 -0
  68. data/schemas/experienceGroupPost.json +7 -0
  69. data/schemas/experienceGroups.json +7 -0
  70. data/schemas/experienceLinkedResources.json +309 -3
  71. data/schemas/experienceVersion.json +1 -1
  72. data/schemas/experienceVersions.json +1 -1
  73. data/schemas/flow.json +103 -1
  74. data/schemas/flowErrors.json +87 -0
  75. data/schemas/flowPatch.json +103 -1
  76. data/schemas/flowPost.json +103 -1
  77. data/schemas/flowStats.json +54 -0
  78. data/schemas/flowVersion.json +206 -2
  79. data/schemas/flowVersionPost.json +103 -1
  80. data/schemas/flowVersions.json +206 -2
  81. data/schemas/flows.json +103 -1
  82. data/schemas/flowsImportPost.json +206 -2
  83. data/schemas/flowsImportResult.json +309 -3
  84. data/schemas/githubLogin.json +10 -1
  85. data/schemas/me.json +3 -0
  86. data/schemas/multiDeviceCommand.json +1019 -0
  87. data/schemas/notebook.json +99 -2
  88. data/schemas/notebookPatch.json +99 -2
  89. data/schemas/notebookPost.json +99 -2
  90. data/schemas/notebooks.json +99 -2
  91. data/schemas/org.json +8 -0
  92. data/schemas/orgPatch.json +9 -0
  93. data/schemas/orgs.json +8 -0
  94. data/schemas/samlResponse.json +21 -0
  95. data/schemas/ssoRequest.json +20 -0
  96. data/schemas/timeSeriesData.json +91 -12
  97. data/schemas/timeSeriesQuery.json +21 -12
  98. data/schemas/userCredentials.json +10 -1
  99. data/schemas/userPost.json +10 -1
  100. metadata +20 -4
data/schemas/flowStats.json ADDED
@@ -0,0 +1,54 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "flowVersion": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "flowVersionId": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ },
14
+ "deviceId": {
15
+ "type": "string",
16
+ "pattern": "^[A-Fa-f\\d]{24}$"
17
+ },
18
+ "start": {
19
+ "type": "string",
20
+ "format": "date-time"
21
+ },
22
+ "end": {
23
+ "type": "string",
24
+ "format": "date-time"
25
+ },
26
+ "resolution": {
27
+ "type": "number"
28
+ },
29
+ "metrics": {
30
+ "type": "array",
31
+ "items": {
32
+ "type": "object",
33
+ "properties": {
34
+ "time": {
35
+ "type": "string",
36
+ "format": "date-time"
37
+ },
38
+ "pathsFailed": {
39
+ "type": "number"
40
+ },
41
+ "pathsCompleted": {
42
+ "type": "number"
43
+ },
44
+ "runCount": {
45
+ "type": "number"
46
+ },
47
+ "wallTime": {
48
+ "type": "number"
49
+ }
50
+ }
51
+ }
52
+ }
53
+ }
54
+ }
data/schemas/flowVersion.json CHANGED
@@ -62,7 +62,6 @@
62
62
  "deviceIdDisconnect",
63
63
  "deviceTagDisconnect",
64
64
  "integration",
65
- "mqttTopic",
66
65
  "notebook",
67
66
  "onBoot",
68
67
  "onConnect",
@@ -1008,6 +1007,109 @@
1008
1007
  ],
1009
1008
  "additionalProperties": false
1010
1009
  },
1010
+ {
1011
+ "type": "object",
1012
+ "properties": {
1013
+ "key": {
1014
+ "type": "string",
1015
+ "maxLength": 1024
1016
+ },
1017
+ "type": {
1018
+ "type": "string",
1019
+ "enum": [
1020
+ "mqttTopic"
1021
+ ]
1022
+ },
1023
+ "config": {
1024
+ "type": "object",
1025
+ "properties": {
1026
+ "integrationId": {
1027
+ "type": "string",
1028
+ "enum": [
1029
+ "losant",
1030
+ "local"
1031
+ ]
1032
+ }
1033
+ },
1034
+ "additionalProperties": false
1035
+ },
1036
+ "meta": {
1037
+ "type": "object",
1038
+ "properties": {
1039
+ "category": {
1040
+ "type": "string",
1041
+ "enum": [
1042
+ "trigger"
1043
+ ]
1044
+ },
1045
+ "name": {
1046
+ "type": "string",
1047
+ "enum": [
1048
+ "mqtt"
1049
+ ]
1050
+ },
1051
+ "label": {
1052
+ "type": "string",
1053
+ "minLength": 1,
1054
+ "maxLength": 255
1055
+ },
1056
+ "x": {
1057
+ "type": "number"
1058
+ },
1059
+ "y": {
1060
+ "type": "number"
1061
+ },
1062
+ "uiId": {
1063
+ "type": "string",
1064
+ "maxLength": 48
1065
+ },
1066
+ "description": {
1067
+ "type": "string",
1068
+ "maxLength": 32767
1069
+ },
1070
+ "icon": {
1071
+ "type": "string",
1072
+ "maxLength": 1024
1073
+ },
1074
+ "color": {
1075
+ "type": "string",
1076
+ "maxLength": 1024
1077
+ },
1078
+ "inputCount": {
1079
+ "type": "number"
1080
+ },
1081
+ "outputCount": {
1082
+ "type": "number"
1083
+ },
1084
+ "triggerId": {
1085
+ "type": "string",
1086
+ "maxLength": 48
1087
+ },
1088
+ "id": {
1089
+ "type": "string",
1090
+ "maxLength": 48
1091
+ }
1092
+ },
1093
+ "additionalProperties": false
1094
+ },
1095
+ "outputIds": {
1096
+ "type": "array",
1097
+ "items": {
1098
+ "type": "array",
1099
+ "items": {
1100
+ "type": "string",
1101
+ "maxLength": 255
1102
+ },
1103
+ "maxItems": 100
1104
+ },
1105
+ "maxItems": 100
1106
+ }
1107
+ },
1108
+ "required": [
1109
+ "type"
1110
+ ],
1111
+ "additionalProperties": false
1112
+ },
1011
1113
  {
1012
1114
  "type": "object",
1013
1115
  "properties": {
@@ -2126,7 +2228,6 @@
2126
2228
  "deviceIdDisconnect",
2127
2229
  "deviceTagDisconnect",
2128
2230
  "integration",
2129
- "mqttTopic",
2130
2231
  "notebook",
2131
2232
  "onBoot",
2132
2233
  "onConnect",
@@ -3072,6 +3173,109 @@
3072
3173
  ],
3073
3174
  "additionalProperties": false
3074
3175
  },
3176
+ {
3177
+ "type": "object",
3178
+ "properties": {
3179
+ "key": {
3180
+ "type": "string",
3181
+ "maxLength": 1024
3182
+ },
3183
+ "type": {
3184
+ "type": "string",
3185
+ "enum": [
3186
+ "mqttTopic"
3187
+ ]
3188
+ },
3189
+ "config": {
3190
+ "type": "object",
3191
+ "properties": {
3192
+ "integrationId": {
3193
+ "type": "string",
3194
+ "enum": [
3195
+ "losant",
3196
+ "local"
3197
+ ]
3198
+ }
3199
+ },
3200
+ "additionalProperties": false
3201
+ },
3202
+ "meta": {
3203
+ "type": "object",
3204
+ "properties": {
3205
+ "category": {
3206
+ "type": "string",
3207
+ "enum": [
3208
+ "trigger"
3209
+ ]
3210
+ },
3211
+ "name": {
3212
+ "type": "string",
3213
+ "enum": [
3214
+ "mqtt"
3215
+ ]
3216
+ },
3217
+ "label": {
3218
+ "type": "string",
3219
+ "minLength": 1,
3220
+ "maxLength": 255
3221
+ },
3222
+ "x": {
3223
+ "type": "number"
3224
+ },
3225
+ "y": {
3226
+ "type": "number"
3227
+ },
3228
+ "uiId": {
3229
+ "type": "string",
3230
+ "maxLength": 48
3231
+ },
3232
+ "description": {
3233
+ "type": "string",
3234
+ "maxLength": 32767
3235
+ },
3236
+ "icon": {
3237
+ "type": "string",
3238
+ "maxLength": 1024
3239
+ },
3240
+ "color": {
3241
+ "type": "string",
3242
+ "maxLength": 1024
3243
+ },
3244
+ "inputCount": {
3245
+ "type": "number"
3246
+ },
3247
+ "outputCount": {
3248
+ "type": "number"
3249
+ },
3250
+ "triggerId": {
3251
+ "type": "string",
3252
+ "maxLength": 48
3253
+ },
3254
+ "id": {
3255
+ "type": "string",
3256
+ "maxLength": 48
3257
+ }
3258
+ },
3259
+ "additionalProperties": false
3260
+ },
3261
+ "outputIds": {
3262
+ "type": "array",
3263
+ "items": {
3264
+ "type": "array",
3265
+ "items": {
3266
+ "type": "string",
3267
+ "maxLength": 255
3268
+ },
3269
+ "maxItems": 100
3270
+ },
3271
+ "maxItems": 100
3272
+ }
3273
+ },
3274
+ "required": [
3275
+ "type"
3276
+ ],
3277
+ "additionalProperties": false
3278
+ },
3075
3279
  {
3076
3280
  "type": "object",
3077
3281
  "properties": {
data/schemas/flowVersionPost.json CHANGED
@@ -35,7 +35,6 @@
35
35
  "deviceIdDisconnect",
36
36
  "deviceTagDisconnect",
37
37
  "integration",
38
- "mqttTopic",
39
38
  "notebook",
40
39
  "onBoot",
41
40
  "onConnect",
@@ -981,6 +980,109 @@
981
980
  ],
982
981
  "additionalProperties": false
983
982
  },
983
+ {
984
+ "type": "object",
985
+ "properties": {
986
+ "key": {
987
+ "type": "string",
988
+ "maxLength": 1024
989
+ },
990
+ "type": {
991
+ "type": "string",
992
+ "enum": [
993
+ "mqttTopic"
994
+ ]
995
+ },
996
+ "config": {
997
+ "type": "object",
998
+ "properties": {
999
+ "integrationId": {
1000
+ "type": "string",
1001
+ "enum": [
1002
+ "losant",
1003
+ "local"
1004
+ ]
1005
+ }
1006
+ },
1007
+ "additionalProperties": false
1008
+ },
1009
+ "meta": {
1010
+ "type": "object",
1011
+ "properties": {
1012
+ "category": {
1013
+ "type": "string",
1014
+ "enum": [
1015
+ "trigger"
1016
+ ]
1017
+ },
1018
+ "name": {
1019
+ "type": "string",
1020
+ "enum": [
1021
+ "mqtt"
1022
+ ]
1023
+ },
1024
+ "label": {
1025
+ "type": "string",
1026
+ "minLength": 1,
1027
+ "maxLength": 255
1028
+ },
1029
+ "x": {
1030
+ "type": "number"
1031
+ },
1032
+ "y": {
1033
+ "type": "number"
1034
+ },
1035
+ "uiId": {
1036
+ "type": "string",
1037
+ "maxLength": 48
1038
+ },
1039
+ "description": {
1040
+ "type": "string",
1041
+ "maxLength": 32767
1042
+ },
1043
+ "icon": {
1044
+ "type": "string",
1045
+ "maxLength": 1024
1046
+ },
1047
+ "color": {
1048
+ "type": "string",
1049
+ "maxLength": 1024
1050
+ },
1051
+ "inputCount": {
1052
+ "type": "number"
1053
+ },
1054
+ "outputCount": {
1055
+ "type": "number"
1056
+ },
1057
+ "triggerId": {
1058
+ "type": "string",
1059
+ "maxLength": 48
1060
+ },
1061
+ "id": {
1062
+ "type": "string",
1063
+ "maxLength": 48
1064
+ }
1065
+ },
1066
+ "additionalProperties": false
1067
+ },
1068
+ "outputIds": {
1069
+ "type": "array",
1070
+ "items": {
1071
+ "type": "array",
1072
+ "items": {
1073
+ "type": "string",
1074
+ "maxLength": 255
1075
+ },
1076
+ "maxItems": 100
1077
+ },
1078
+ "maxItems": 100
1079
+ }
1080
+ },
1081
+ "required": [
1082
+ "type"
1083
+ ],
1084
+ "additionalProperties": false
1085
+ },
984
1086
  {
985
1087
  "type": "object",
986
1088
  "properties": {
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": {
@@ -2133,7 +2235,6 @@
2133
2235
  "deviceIdDisconnect",
2134
2236
  "deviceTagDisconnect",
2135
2237
  "integration",
2136
- "mqttTopic",
2137
2238
  "notebook",
2138
2239
  "onBoot",
2139
2240
  "onConnect",
@@ -3079,6 +3180,109 @@
3079
3180
  ],
3080
3181
  "additionalProperties": false
3081
3182
  },
3183
+ {
3184
+ "type": "object",
3185
+ "properties": {
3186
+ "key": {
3187
+ "type": "string",
3188
+ "maxLength": 1024
3189
+ },
3190
+ "type": {
3191
+ "type": "string",
3192
+ "enum": [
3193
+ "mqttTopic"
3194
+ ]
3195
+ },
3196
+ "config": {
3197
+ "type": "object",
3198
+ "properties": {
3199
+ "integrationId": {
3200
+ "type": "string",
3201
+ "enum": [
3202
+ "losant",
3203
+ "local"
3204
+ ]
3205
+ }
3206
+ },
3207
+ "additionalProperties": false
3208
+ },
3209
+ "meta": {
3210
+ "type": "object",
3211
+ "properties": {
3212
+ "category": {
3213
+ "type": "string",
3214
+ "enum": [
3215
+ "trigger"
3216
+ ]
3217
+ },
3218
+ "name": {
3219
+ "type": "string",
3220
+ "enum": [
3221
+ "mqtt"
3222
+ ]
3223
+ },
3224
+ "label": {
3225
+ "type": "string",
3226
+ "minLength": 1,
3227
+ "maxLength": 255
3228
+ },
3229
+ "x": {
3230
+ "type": "number"
3231
+ },
3232
+ "y": {
3233
+ "type": "number"
3234
+ },
3235
+ "uiId": {
3236
+ "type": "string",
3237
+ "maxLength": 48
3238
+ },
3239
+ "description": {
3240
+ "type": "string",
3241
+ "maxLength": 32767
3242
+ },
3243
+ "icon": {
3244
+ "type": "string",
3245
+ "maxLength": 1024
3246
+ },
3247
+ "color": {
3248
+ "type": "string",
3249
+ "maxLength": 1024
3250
+ },
3251
+ "inputCount": {
3252
+ "type": "number"
3253
+ },
3254
+ "outputCount": {
3255
+ "type": "number"
3256
+ },
3257
+ "triggerId": {
3258
+ "type": "string",
3259
+ "maxLength": 48
3260
+ },
3261
+ "id": {
3262
+ "type": "string",
3263
+ "maxLength": 48
3264
+ }
3265
+ },
3266
+ "additionalProperties": false
3267
+ },
3268
+ "outputIds": {
3269
+ "type": "array",
3270
+ "items": {
3271
+ "type": "array",
3272
+ "items": {
3273
+ "type": "string",
3274
+ "maxLength": 255
3275
+ },
3276
+ "maxItems": 100
3277
+ },
3278
+ "maxItems": 100
3279
+ }
3280
+ },
3281
+ "required": [
3282
+ "type"
3283
+ ],
3284
+ "additionalProperties": false
3285
+ },
3082
3286
  {
3083
3287
  "type": "object",
3084
3288
  "properties": {