losant_rest 1.9.1 → 1.10.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (166) hide show
  1. checksums.yaml +5 -5
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +41608 -19945
  5. data/docs/application.md +168 -4
  6. data/docs/applicationTemplates.md +50 -0
  7. data/docs/applications.md +46 -0
  8. data/docs/auth.md +72 -0
  9. data/docs/device.md +1 -0
  10. data/docs/devices.md +89 -2
  11. data/docs/experienceEndpoint.md +43 -0
  12. data/docs/experienceEndpoints.md +1 -1
  13. data/docs/experienceView.md +43 -0
  14. data/lib/losant_rest.rb +2 -1
  15. data/lib/losant_rest/application.rb +144 -5
  16. data/lib/losant_rest/application_api_token.rb +1 -1
  17. data/lib/losant_rest/application_api_tokens.rb +1 -1
  18. data/lib/losant_rest/application_certificate.rb +1 -1
  19. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  20. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  21. data/lib/losant_rest/application_certificates.rb +1 -1
  22. data/lib/losant_rest/application_key.rb +1 -1
  23. data/lib/losant_rest/application_keys.rb +1 -1
  24. data/lib/losant_rest/application_templates.rb +88 -0
  25. data/lib/losant_rest/applications.rb +1 -1
  26. data/lib/losant_rest/audit_log.rb +1 -1
  27. data/lib/losant_rest/audit_logs.rb +1 -1
  28. data/lib/losant_rest/auth.rb +85 -1
  29. data/lib/losant_rest/client.rb +7 -3
  30. data/lib/losant_rest/dashboard.rb +1 -1
  31. data/lib/losant_rest/dashboards.rb +1 -1
  32. data/lib/losant_rest/data.rb +1 -1
  33. data/lib/losant_rest/data_table.rb +1 -1
  34. data/lib/losant_rest/data_table_row.rb +1 -1
  35. data/lib/losant_rest/data_table_rows.rb +1 -1
  36. data/lib/losant_rest/data_tables.rb +1 -1
  37. data/lib/losant_rest/device.rb +3 -1
  38. data/lib/losant_rest/device_recipe.rb +1 -1
  39. data/lib/losant_rest/device_recipes.rb +1 -1
  40. data/lib/losant_rest/devices.rb +105 -3
  41. data/lib/losant_rest/edge_deployments.rb +1 -1
  42. data/lib/losant_rest/error.rb +1 -1
  43. data/lib/losant_rest/event.rb +1 -1
  44. data/lib/losant_rest/events.rb +1 -1
  45. data/lib/losant_rest/experience.rb +1 -1
  46. data/lib/losant_rest/experience_domain.rb +1 -1
  47. data/lib/losant_rest/experience_domains.rb +1 -1
  48. data/lib/losant_rest/experience_endpoint.rb +51 -1
  49. data/lib/losant_rest/experience_endpoints.rb +1 -1
  50. data/lib/losant_rest/experience_group.rb +1 -1
  51. data/lib/losant_rest/experience_groups.rb +1 -1
  52. data/lib/losant_rest/experience_slug.rb +1 -1
  53. data/lib/losant_rest/experience_slugs.rb +1 -1
  54. data/lib/losant_rest/experience_user.rb +1 -1
  55. data/lib/losant_rest/experience_users.rb +1 -1
  56. data/lib/losant_rest/experience_version.rb +1 -1
  57. data/lib/losant_rest/experience_versions.rb +1 -1
  58. data/lib/losant_rest/experience_view.rb +51 -1
  59. data/lib/losant_rest/experience_views.rb +1 -1
  60. data/lib/losant_rest/file.rb +1 -1
  61. data/lib/losant_rest/files.rb +1 -1
  62. data/lib/losant_rest/flow.rb +1 -1
  63. data/lib/losant_rest/flow_version.rb +1 -1
  64. data/lib/losant_rest/flow_versions.rb +1 -1
  65. data/lib/losant_rest/flows.rb +1 -1
  66. data/lib/losant_rest/integration.rb +1 -1
  67. data/lib/losant_rest/integrations.rb +1 -1
  68. data/lib/losant_rest/me.rb +1 -1
  69. data/lib/losant_rest/notebook.rb +1 -1
  70. data/lib/losant_rest/notebooks.rb +1 -1
  71. data/lib/losant_rest/org.rb +1 -1
  72. data/lib/losant_rest/org_invites.rb +1 -1
  73. data/lib/losant_rest/orgs.rb +1 -1
  74. data/lib/losant_rest/utils.rb +1 -1
  75. data/lib/losant_rest/version.rb +2 -2
  76. data/lib/losant_rest/webhook.rb +1 -1
  77. data/lib/losant_rest/webhooks.rb +1 -1
  78. data/schemas/advancedDeviceQuery.json +1018 -0
  79. data/schemas/advancedEventQuery.json +382 -13
  80. data/schemas/advancedQuery.json +37 -3
  81. data/schemas/application.json +10 -5
  82. data/schemas/applicationApiTokenPost.json +6 -0
  83. data/schemas/applicationCertificate.json +34 -0
  84. data/schemas/applicationCertificatePatch.json +34 -0
  85. data/schemas/applicationCertificatePost.json +34 -0
  86. data/schemas/applicationCertificates.json +34 -0
  87. data/schemas/{applicationCloneResult.json → applicationCreationByTemplateResult.json} +21 -8
  88. data/schemas/applicationExportPost.json +24 -0
  89. data/schemas/applicationExportResult.json +10 -0
  90. data/schemas/applicationKey.json +34 -0
  91. data/schemas/applicationKeyPatch.json +34 -0
  92. data/schemas/applicationKeyPost.json +34 -0
  93. data/schemas/applicationKeyPostResponse.json +34 -0
  94. data/schemas/applicationKeys.json +34 -0
  95. data/schemas/applicationPatch.json +10 -5
  96. data/schemas/applicationPost.json +14 -5
  97. data/schemas/applicationReadme.json +29 -0
  98. data/schemas/applicationReadmePatch.json +11 -0
  99. data/schemas/applicationTemplate.json +99 -0
  100. data/schemas/applicationTemplates.json +140 -0
  101. data/schemas/applications.json +10 -5
  102. data/schemas/authedDevice.json +34 -0
  103. data/schemas/dashboard.json +1228 -144
  104. data/schemas/dashboardPatch.json +1228 -144
  105. data/schemas/dashboardPost.json +1228 -144
  106. data/schemas/dashboards.json +1228 -144
  107. data/schemas/dataExport.json +11 -0
  108. data/schemas/dataTableRows.json +3 -0
  109. data/schemas/dataTableRowsExport.json +37 -3
  110. data/schemas/device.json +16 -3
  111. data/schemas/devicePatch.json +16 -3
  112. data/schemas/devicePost.json +16 -3
  113. data/schemas/deviceRecipe.json +16 -3
  114. data/schemas/deviceRecipePatch.json +16 -3
  115. data/schemas/deviceRecipePost.json +16 -3
  116. data/schemas/deviceRecipes.json +16 -3
  117. data/schemas/devices.json +19 -3
  118. data/schemas/devicesDataRemoved.json +12 -0
  119. data/schemas/devicesDeletePost.json +1034 -0
  120. data/schemas/devicesDeleted.json +12 -0
  121. data/schemas/devicesExportPost.json +1035 -0
  122. data/schemas/devicesPatch.json +1773 -7
  123. data/schemas/devicesRemoveDataPost.json +1056 -0
  124. data/schemas/devicesUpdated.json +18 -0
  125. data/schemas/events.json +1 -816
  126. data/schemas/eventsExport.json +382 -13
  127. data/schemas/experienceGroup.json +7 -0
  128. data/schemas/experienceGroupPatch.json +7 -0
  129. data/schemas/experienceGroupPost.json +7 -0
  130. data/schemas/experienceGroups.json +7 -0
  131. data/schemas/experienceLinkedResources.json +6659 -0
  132. data/schemas/flow.json +103 -1
  133. data/schemas/flowPatch.json +103 -1
  134. data/schemas/flowPost.json +103 -1
  135. data/schemas/flowVersion.json +206 -2
  136. data/schemas/flowVersionPost.json +103 -1
  137. data/schemas/flowVersions.json +206 -2
  138. data/schemas/flows.json +103 -1
  139. data/schemas/flowsImportPost.json +206 -2
  140. data/schemas/flowsImportResult.json +309 -3
  141. data/schemas/githubLogin.json +9 -0
  142. data/schemas/integration.json +4 -4
  143. data/schemas/integrationPatch.json +4 -4
  144. data/schemas/integrationPost.json +4 -4
  145. data/schemas/integrations.json +4 -4
  146. data/schemas/{applicationCloneEnqueued.json → jobEnqueuedResult.json} +0 -0
  147. data/schemas/me.json +3 -0
  148. data/schemas/multiDeviceCommand.json +1019 -0
  149. data/schemas/notebook.json +207 -35
  150. data/schemas/notebookDataExportOptions.json +4 -0
  151. data/schemas/notebookExecutionLogs.json +4 -0
  152. data/schemas/notebookExecutionOptions.json +4 -0
  153. data/schemas/notebookPatch.json +207 -35
  154. data/schemas/notebookPost.json +207 -35
  155. data/schemas/notebooks.json +207 -35
  156. data/schemas/org.json +8 -0
  157. data/schemas/orgPatch.json +9 -0
  158. data/schemas/orgs.json +8 -0
  159. data/schemas/samlResponse.json +21 -0
  160. data/schemas/ssoRequest.json +20 -0
  161. data/schemas/timeSeriesData.json +91 -12
  162. data/schemas/timeSeriesQuery.json +21 -12
  163. data/schemas/userCredentials.json +9 -0
  164. data/schemas/userPost.json +9 -0
  165. data/schemas/{validationCloneErrors.json → validationErrors.json} +9 -2
  166. metadata +24 -7
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": {
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": {