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/notebook.json CHANGED
@@ -114,6 +114,10 @@
114
114
  ]
115
115
  }
116
116
  },
117
+ "queryJson": {
118
+ "type": "string",
119
+ "maxLength": 8192
120
+ },
117
121
  "attributes": {
118
122
  "type": "array",
119
123
  "maxItems": 100,
@@ -137,6 +141,95 @@
137
141
  ],
138
142
  "additionalProperties": false
139
143
  },
144
+ {
145
+ "type": "object",
146
+ "properties": {
147
+ "inputType": {
148
+ "type": "string",
149
+ "enum": [
150
+ "deviceConnectionHistory"
151
+ ]
152
+ },
153
+ "fileName": {
154
+ "oneOf": [
155
+ {
156
+ "type": "string",
157
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
158
+ },
159
+ {
160
+ "type": "string",
161
+ "minLength": 4,
162
+ "maxLength": 255,
163
+ "pattern": ".*{{.+}}.*"
164
+ }
165
+ ]
166
+ },
167
+ "deviceTags": {
168
+ "type": "array",
169
+ "maxItems": 100,
170
+ "items": {
171
+ "type": "object",
172
+ "properties": {
173
+ "key": {
174
+ "oneOf": [
175
+ {
176
+ "type": "string",
177
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
178
+ },
179
+ {
180
+ "type": "string",
181
+ "minLength": 4,
182
+ "maxLength": 255,
183
+ "pattern": ".*{{.+}}.*"
184
+ }
185
+ ]
186
+ },
187
+ "value": {
188
+ "type": "string",
189
+ "minLength": 1,
190
+ "maxLength": 255
191
+ }
192
+ },
193
+ "additionalProperties": false
194
+ }
195
+ },
196
+ "deviceIds": {
197
+ "type": "array",
198
+ "maxItems": 100,
199
+ "items": {
200
+ "oneOf": [
201
+ {
202
+ "type": "string",
203
+ "pattern": "^[A-Fa-f\\d]{24}$"
204
+ },
205
+ {
206
+ "type": "string",
207
+ "minLength": 4,
208
+ "maxLength": 255,
209
+ "pattern": ".*{{.+}}.*"
210
+ }
211
+ ]
212
+ }
213
+ },
214
+ "queryJson": {
215
+ "type": "string",
216
+ "maxLength": 8192
217
+ },
218
+ "start": {
219
+ "type": "number"
220
+ },
221
+ "end": {
222
+ "type": "number"
223
+ }
224
+ },
225
+ "required": [
226
+ "inputType",
227
+ "fileName",
228
+ "start",
229
+ "end"
230
+ ],
231
+ "additionalProperties": false
232
+ },
140
233
  {
141
234
  "type": "object",
142
235
  "properties": {
@@ -206,6 +299,10 @@
206
299
  }
207
300
  ]
208
301
  }
302
+ },
303
+ "queryJson": {
304
+ "type": "string",
305
+ "maxLength": 8192
209
306
  }
210
307
  },
211
308
  "required": [
@@ -253,7 +350,7 @@
253
350
  },
254
351
  "queryJson": {
255
352
  "type": "string",
256
- "maxLength": 32767
353
+ "maxLength": 8192
257
354
  }
258
355
  },
259
356
  "required": [
@@ -288,7 +385,7 @@
288
385
  },
289
386
  "queryJson": {
290
387
  "type": "string",
291
- "maxLength": 32767
388
+ "maxLength": 8192
292
389
  }
293
390
  },
294
391
  "required": [
data/schemas/notebookPatch.json CHANGED
@@ -86,6 +86,10 @@
86
86
  ]
87
87
  }
88
88
  },
89
+ "queryJson": {
90
+ "type": "string",
91
+ "maxLength": 8192
92
+ },
89
93
  "attributes": {
90
94
  "type": "array",
91
95
  "maxItems": 100,
@@ -109,6 +113,95 @@
109
113
  ],
110
114
  "additionalProperties": false
111
115
  },
116
+ {
117
+ "type": "object",
118
+ "properties": {
119
+ "inputType": {
120
+ "type": "string",
121
+ "enum": [
122
+ "deviceConnectionHistory"
123
+ ]
124
+ },
125
+ "fileName": {
126
+ "oneOf": [
127
+ {
128
+ "type": "string",
129
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
130
+ },
131
+ {
132
+ "type": "string",
133
+ "minLength": 4,
134
+ "maxLength": 255,
135
+ "pattern": ".*{{.+}}.*"
136
+ }
137
+ ]
138
+ },
139
+ "deviceTags": {
140
+ "type": "array",
141
+ "maxItems": 100,
142
+ "items": {
143
+ "type": "object",
144
+ "properties": {
145
+ "key": {
146
+ "oneOf": [
147
+ {
148
+ "type": "string",
149
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
150
+ },
151
+ {
152
+ "type": "string",
153
+ "minLength": 4,
154
+ "maxLength": 255,
155
+ "pattern": ".*{{.+}}.*"
156
+ }
157
+ ]
158
+ },
159
+ "value": {
160
+ "type": "string",
161
+ "minLength": 1,
162
+ "maxLength": 255
163
+ }
164
+ },
165
+ "additionalProperties": false
166
+ }
167
+ },
168
+ "deviceIds": {
169
+ "type": "array",
170
+ "maxItems": 100,
171
+ "items": {
172
+ "oneOf": [
173
+ {
174
+ "type": "string",
175
+ "pattern": "^[A-Fa-f\\d]{24}$"
176
+ },
177
+ {
178
+ "type": "string",
179
+ "minLength": 4,
180
+ "maxLength": 255,
181
+ "pattern": ".*{{.+}}.*"
182
+ }
183
+ ]
184
+ }
185
+ },
186
+ "queryJson": {
187
+ "type": "string",
188
+ "maxLength": 8192
189
+ },
190
+ "start": {
191
+ "type": "number"
192
+ },
193
+ "end": {
194
+ "type": "number"
195
+ }
196
+ },
197
+ "required": [
198
+ "inputType",
199
+ "fileName",
200
+ "start",
201
+ "end"
202
+ ],
203
+ "additionalProperties": false
204
+ },
112
205
  {
113
206
  "type": "object",
114
207
  "properties": {
@@ -178,6 +271,10 @@
178
271
  }
179
272
  ]
180
273
  }
274
+ },
275
+ "queryJson": {
276
+ "type": "string",
277
+ "maxLength": 8192
181
278
  }
182
279
  },
183
280
  "required": [
@@ -225,7 +322,7 @@
225
322
  },
226
323
  "queryJson": {
227
324
  "type": "string",
228
- "maxLength": 32767
325
+ "maxLength": 8192
229
326
  }
230
327
  },
231
328
  "required": [
@@ -260,7 +357,7 @@
260
357
  },
261
358
  "queryJson": {
262
359
  "type": "string",
263
- "maxLength": 32767
360
+ "maxLength": 8192
264
361
  }
265
362
  },
266
363
  "required": [
data/schemas/notebookPost.json CHANGED
@@ -86,6 +86,10 @@
86
86
  ]
87
87
  }
88
88
  },
89
+ "queryJson": {
90
+ "type": "string",
91
+ "maxLength": 8192
92
+ },
89
93
  "attributes": {
90
94
  "type": "array",
91
95
  "maxItems": 100,
@@ -109,6 +113,95 @@
109
113
  ],
110
114
  "additionalProperties": false
111
115
  },
116
+ {
117
+ "type": "object",
118
+ "properties": {
119
+ "inputType": {
120
+ "type": "string",
121
+ "enum": [
122
+ "deviceConnectionHistory"
123
+ ]
124
+ },
125
+ "fileName": {
126
+ "oneOf": [
127
+ {
128
+ "type": "string",
129
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
130
+ },
131
+ {
132
+ "type": "string",
133
+ "minLength": 4,
134
+ "maxLength": 255,
135
+ "pattern": ".*{{.+}}.*"
136
+ }
137
+ ]
138
+ },
139
+ "deviceTags": {
140
+ "type": "array",
141
+ "maxItems": 100,
142
+ "items": {
143
+ "type": "object",
144
+ "properties": {
145
+ "key": {
146
+ "oneOf": [
147
+ {
148
+ "type": "string",
149
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
150
+ },
151
+ {
152
+ "type": "string",
153
+ "minLength": 4,
154
+ "maxLength": 255,
155
+ "pattern": ".*{{.+}}.*"
156
+ }
157
+ ]
158
+ },
159
+ "value": {
160
+ "type": "string",
161
+ "minLength": 1,
162
+ "maxLength": 255
163
+ }
164
+ },
165
+ "additionalProperties": false
166
+ }
167
+ },
168
+ "deviceIds": {
169
+ "type": "array",
170
+ "maxItems": 100,
171
+ "items": {
172
+ "oneOf": [
173
+ {
174
+ "type": "string",
175
+ "pattern": "^[A-Fa-f\\d]{24}$"
176
+ },
177
+ {
178
+ "type": "string",
179
+ "minLength": 4,
180
+ "maxLength": 255,
181
+ "pattern": ".*{{.+}}.*"
182
+ }
183
+ ]
184
+ }
185
+ },
186
+ "queryJson": {
187
+ "type": "string",
188
+ "maxLength": 8192
189
+ },
190
+ "start": {
191
+ "type": "number"
192
+ },
193
+ "end": {
194
+ "type": "number"
195
+ }
196
+ },
197
+ "required": [
198
+ "inputType",
199
+ "fileName",
200
+ "start",
201
+ "end"
202
+ ],
203
+ "additionalProperties": false
204
+ },
112
205
  {
113
206
  "type": "object",
114
207
  "properties": {
@@ -178,6 +271,10 @@
178
271
  }
179
272
  ]
180
273
  }
274
+ },
275
+ "queryJson": {
276
+ "type": "string",
277
+ "maxLength": 8192
181
278
  }
182
279
  },
183
280
  "required": [
@@ -225,7 +322,7 @@
225
322
  },
226
323
  "queryJson": {
227
324
  "type": "string",
228
- "maxLength": 32767
325
+ "maxLength": 8192
229
326
  }
230
327
  },
231
328
  "required": [
@@ -260,7 +357,7 @@
260
357
  },
261
358
  "queryJson": {
262
359
  "type": "string",
263
- "maxLength": 32767
360
+ "maxLength": 8192
264
361
  }
265
362
  },
266
363
  "required": [
data/schemas/notebooks.json CHANGED
@@ -121,6 +121,10 @@
121
121
  ]
122
122
  }
123
123
  },
124
+ "queryJson": {
125
+ "type": "string",
126
+ "maxLength": 8192
127
+ },
124
128
  "attributes": {
125
129
  "type": "array",
126
130
  "maxItems": 100,
@@ -144,6 +148,95 @@
144
148
  ],
145
149
  "additionalProperties": false
146
150
  },
151
+ {
152
+ "type": "object",
153
+ "properties": {
154
+ "inputType": {
155
+ "type": "string",
156
+ "enum": [
157
+ "deviceConnectionHistory"
158
+ ]
159
+ },
160
+ "fileName": {
161
+ "oneOf": [
162
+ {
163
+ "type": "string",
164
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
165
+ },
166
+ {
167
+ "type": "string",
168
+ "minLength": 4,
169
+ "maxLength": 255,
170
+ "pattern": ".*{{.+}}.*"
171
+ }
172
+ ]
173
+ },
174
+ "deviceTags": {
175
+ "type": "array",
176
+ "maxItems": 100,
177
+ "items": {
178
+ "type": "object",
179
+ "properties": {
180
+ "key": {
181
+ "oneOf": [
182
+ {
183
+ "type": "string",
184
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
185
+ },
186
+ {
187
+ "type": "string",
188
+ "minLength": 4,
189
+ "maxLength": 255,
190
+ "pattern": ".*{{.+}}.*"
191
+ }
192
+ ]
193
+ },
194
+ "value": {
195
+ "type": "string",
196
+ "minLength": 1,
197
+ "maxLength": 255
198
+ }
199
+ },
200
+ "additionalProperties": false
201
+ }
202
+ },
203
+ "deviceIds": {
204
+ "type": "array",
205
+ "maxItems": 100,
206
+ "items": {
207
+ "oneOf": [
208
+ {
209
+ "type": "string",
210
+ "pattern": "^[A-Fa-f\\d]{24}$"
211
+ },
212
+ {
213
+ "type": "string",
214
+ "minLength": 4,
215
+ "maxLength": 255,
216
+ "pattern": ".*{{.+}}.*"
217
+ }
218
+ ]
219
+ }
220
+ },
221
+ "queryJson": {
222
+ "type": "string",
223
+ "maxLength": 8192
224
+ },
225
+ "start": {
226
+ "type": "number"
227
+ },
228
+ "end": {
229
+ "type": "number"
230
+ }
231
+ },
232
+ "required": [
233
+ "inputType",
234
+ "fileName",
235
+ "start",
236
+ "end"
237
+ ],
238
+ "additionalProperties": false
239
+ },
147
240
  {
148
241
  "type": "object",
149
242
  "properties": {
@@ -213,6 +306,10 @@
213
306
  }
214
307
  ]
215
308
  }
309
+ },
310
+ "queryJson": {
311
+ "type": "string",
312
+ "maxLength": 8192
216
313
  }
217
314
  },
218
315
  "required": [
@@ -260,7 +357,7 @@
260
357
  },
261
358
  "queryJson": {
262
359
  "type": "string",
263
- "maxLength": 32767
360
+ "maxLength": 8192
264
361
  }
265
362
  },
266
363
  "required": [
@@ -295,7 +392,7 @@
295
392
  },
296
393
  "queryJson": {
297
394
  "type": "string",
298
- "maxLength": 32767
395
+ "maxLength": 8192
299
396
  }
300
397
  },
301
398
  "required": [