losant_rest 1.6.0 → 1.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +5644 -846
  3. data/docs/applicationApiTokens.md +1 -1
  4. data/docs/applicationKeys.md +1 -1
  5. data/docs/applications.md +1 -1
  6. data/docs/dataTables.md +1 -1
  7. data/docs/deviceRecipes.md +1 -1
  8. data/docs/devices.md +1 -1
  9. data/docs/experienceEndpoints.md +1 -1
  10. data/docs/experienceGroups.md +1 -1
  11. data/docs/experienceUsers.md +1 -1
  12. data/docs/flow.md +2 -0
  13. data/docs/flowVersion.md +6 -4
  14. data/docs/flowVersions.md +4 -2
  15. data/docs/flows.md +44 -2
  16. data/docs/integrations.md +1 -1
  17. data/docs/orgs.md +1 -1
  18. data/docs/solutionUsers.md +1 -1
  19. data/docs/solutions.md +1 -1
  20. data/docs/webhooks.md +1 -1
  21. data/lib/losant_rest/application_api_tokens.rb +1 -1
  22. data/lib/losant_rest/application_keys.rb +1 -1
  23. data/lib/losant_rest/applications.rb +1 -1
  24. data/lib/losant_rest/client.rb +2 -2
  25. data/lib/losant_rest/data_tables.rb +1 -1
  26. data/lib/losant_rest/device_recipes.rb +1 -1
  27. data/lib/losant_rest/devices.rb +1 -1
  28. data/lib/losant_rest/experience_endpoints.rb +1 -1
  29. data/lib/losant_rest/experience_groups.rb +1 -1
  30. data/lib/losant_rest/experience_users.rb +1 -1
  31. data/lib/losant_rest/flow.rb +4 -0
  32. data/lib/losant_rest/flow_version.rb +8 -4
  33. data/lib/losant_rest/flow_versions.rb +6 -2
  34. data/lib/losant_rest/flows.rb +53 -2
  35. data/lib/losant_rest/integrations.rb +1 -1
  36. data/lib/losant_rest/orgs.rb +1 -1
  37. data/lib/losant_rest/solution_users.rb +1 -1
  38. data/lib/losant_rest/solutions.rb +1 -1
  39. data/lib/losant_rest/version.rb +1 -1
  40. data/lib/losant_rest/webhooks.rb +1 -1
  41. data/schemas/applicationApiTokenPost.json +2 -0
  42. data/schemas/auditLog.json +1 -0
  43. data/schemas/auditLogFilter.json +1 -0
  44. data/schemas/auditLogs.json +1 -0
  45. data/schemas/dashboard.json +7 -0
  46. data/schemas/dashboardPatch.json +7 -0
  47. data/schemas/dashboardPost.json +7 -0
  48. data/schemas/dashboards.json +7 -0
  49. data/schemas/deviceState.json +54 -0
  50. data/schemas/flow.json +334 -1
  51. data/schemas/flowPatch.json +327 -0
  52. data/schemas/flowPost.json +338 -1
  53. data/schemas/flowVersion.json +315 -0
  54. data/schemas/flowVersionPost.json +315 -0
  55. data/schemas/flowVersions.json +315 -0
  56. data/schemas/flows.json +336 -2
  57. data/schemas/flowsImportPost.json +994 -0
  58. data/schemas/flowsImportResult.json +1048 -0
  59. data/schemas/org.json +59 -1
  60. data/schemas/orgInviteInfo.json +3 -1
  61. data/schemas/orgInvitePost.json +59 -1
  62. data/schemas/orgInvites.json +59 -1
  63. data/schemas/orgMemberPatch.json +60 -3
  64. data/schemas/orgs.json +59 -1
  65. metadata +5 -2
@@ -11,6 +11,18 @@
11
11
  "type": "string",
12
12
  "maxLength": 32767
13
13
  },
14
+ "iconData": {
15
+ "oneOf": [
16
+ {
17
+ "type": "string",
18
+ "maxLength": 32767,
19
+ "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
20
+ },
21
+ {
22
+ "type": "null"
23
+ }
24
+ ]
25
+ },
14
26
  "enabled": {
15
27
  "type": "boolean"
16
28
  },
@@ -52,6 +64,7 @@
52
64
  "integration",
53
65
  "mqttTopic",
54
66
  "request",
67
+ "customNodeStart",
55
68
  "timer",
56
69
  "udp",
57
70
  "virtualButton",
@@ -148,6 +161,320 @@
148
161
  "minimumAgentVersion": {
149
162
  "type": "string",
150
163
  "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$"
164
+ },
165
+ "customNodeConfig": {
166
+ "type": "object",
167
+ "properties": {
168
+ "outputCount": {
169
+ "type": "number",
170
+ "enum": [
171
+ 1,
172
+ 2
173
+ ]
174
+ },
175
+ "resultMode": {
176
+ "type": "string",
177
+ "enum": [
178
+ "optional",
179
+ "required",
180
+ "none"
181
+ ]
182
+ },
183
+ "resultDescription": {
184
+ "type": "string",
185
+ "maxLength": 32767
186
+ },
187
+ "fields": {
188
+ "type": "array",
189
+ "maxItems": 100,
190
+ "items": {
191
+ "oneOf": [
192
+ {
193
+ "type": "object",
194
+ "properties": {
195
+ "type": {
196
+ "type": "string",
197
+ "enum": [
198
+ "checkbox"
199
+ ]
200
+ },
201
+ "label": {
202
+ "type": "string",
203
+ "minLength": 1,
204
+ "maxLength": 1024
205
+ },
206
+ "id": {
207
+ "type": "string",
208
+ "minLength": 1,
209
+ "maxLength": 1024
210
+ },
211
+ "description": {
212
+ "type": "string",
213
+ "maxLength": 32767
214
+ },
215
+ "defaultValue": {
216
+ "type": "boolean"
217
+ }
218
+ },
219
+ "additionalProperties": false,
220
+ "required": [
221
+ "type",
222
+ "label"
223
+ ]
224
+ },
225
+ {
226
+ "type": "object",
227
+ "properties": {
228
+ "type": {
229
+ "type": "string",
230
+ "enum": [
231
+ "select"
232
+ ]
233
+ },
234
+ "label": {
235
+ "type": "string",
236
+ "minLength": 1,
237
+ "maxLength": 1024
238
+ },
239
+ "id": {
240
+ "type": "string",
241
+ "minLength": 1,
242
+ "maxLength": 1024
243
+ },
244
+ "description": {
245
+ "type": "string",
246
+ "maxLength": 32767
247
+ },
248
+ "defaultValue": {
249
+ "type": "string",
250
+ "minLength": 1,
251
+ "maxLength": 1024
252
+ },
253
+ "options": {
254
+ "type": "array",
255
+ "minItems": 1,
256
+ "maxItems": 100,
257
+ "items": {
258
+ "type": "object",
259
+ "properties": {
260
+ "label": {
261
+ "type": "string",
262
+ "maxLength": 1024
263
+ },
264
+ "value": {
265
+ "type": "string",
266
+ "minLength": 1,
267
+ "maxLength": 1024
268
+ }
269
+ },
270
+ "additionalProperties": false,
271
+ "required": [
272
+ "value"
273
+ ]
274
+ }
275
+ }
276
+ },
277
+ "additionalProperties": false,
278
+ "required": [
279
+ "type",
280
+ "label",
281
+ "defaultValue",
282
+ "options"
283
+ ]
284
+ },
285
+ {
286
+ "type": "object",
287
+ "properties": {
288
+ "type": {
289
+ "type": "string",
290
+ "enum": [
291
+ "stringTemplate"
292
+ ]
293
+ },
294
+ "label": {
295
+ "type": "string",
296
+ "minLength": 1,
297
+ "maxLength": 1024
298
+ },
299
+ "id": {
300
+ "type": "string",
301
+ "minLength": 1,
302
+ "maxLength": 1024
303
+ },
304
+ "description": {
305
+ "type": "string",
306
+ "maxLength": 32767
307
+ },
308
+ "defaultValue": {
309
+ "type": "string",
310
+ "maxLength": 1024
311
+ },
312
+ "required": {
313
+ "type": "boolean"
314
+ },
315
+ "validRegExp": {
316
+ "type": "string",
317
+ "maxLength": 1024
318
+ }
319
+ },
320
+ "additionalProperties": false,
321
+ "required": [
322
+ "type",
323
+ "label"
324
+ ]
325
+ },
326
+ {
327
+ "type": "object",
328
+ "properties": {
329
+ "type": {
330
+ "type": "string",
331
+ "enum": [
332
+ "numberTemplate"
333
+ ]
334
+ },
335
+ "label": {
336
+ "type": "string",
337
+ "minLength": 1,
338
+ "maxLength": 1024
339
+ },
340
+ "id": {
341
+ "type": "string",
342
+ "minLength": 1,
343
+ "maxLength": 1024
344
+ },
345
+ "description": {
346
+ "type": "string",
347
+ "maxLength": 32767
348
+ },
349
+ "defaultValue": {
350
+ "type": "number"
351
+ },
352
+ "required": {
353
+ "type": "boolean"
354
+ },
355
+ "validMin": {
356
+ "type": "number"
357
+ },
358
+ "validMax": {
359
+ "type": "number"
360
+ }
361
+ },
362
+ "additionalProperties": false,
363
+ "required": [
364
+ "type",
365
+ "label"
366
+ ]
367
+ },
368
+ {
369
+ "type": "object",
370
+ "properties": {
371
+ "type": {
372
+ "type": "string",
373
+ "enum": [
374
+ "jsonTemplate"
375
+ ]
376
+ },
377
+ "label": {
378
+ "type": "string",
379
+ "minLength": 1,
380
+ "maxLength": 1024
381
+ },
382
+ "id": {
383
+ "type": "string",
384
+ "minLength": 1,
385
+ "maxLength": 1024
386
+ },
387
+ "description": {
388
+ "type": "string",
389
+ "maxLength": 32767
390
+ },
391
+ "defaultValue": {
392
+ "type": "string",
393
+ "maxLength": 32767
394
+ },
395
+ "required": {
396
+ "type": "boolean"
397
+ }
398
+ },
399
+ "additionalProperties": false,
400
+ "required": [
401
+ "type",
402
+ "label"
403
+ ]
404
+ },
405
+ {
406
+ "type": "object",
407
+ "properties": {
408
+ "type": {
409
+ "type": "string",
410
+ "enum": [
411
+ "payloadPath"
412
+ ]
413
+ },
414
+ "label": {
415
+ "type": "string",
416
+ "minLength": 1,
417
+ "maxLength": 1024
418
+ },
419
+ "id": {
420
+ "type": "string",
421
+ "minLength": 1,
422
+ "maxLength": 1024
423
+ },
424
+ "description": {
425
+ "type": "string",
426
+ "maxLength": 32767
427
+ },
428
+ "required": {
429
+ "type": "boolean"
430
+ }
431
+ },
432
+ "additionalProperties": false,
433
+ "required": [
434
+ "type",
435
+ "label"
436
+ ]
437
+ },
438
+ {
439
+ "type": "object",
440
+ "properties": {
441
+ "type": {
442
+ "type": "string",
443
+ "enum": [
444
+ "section"
445
+ ]
446
+ },
447
+ "label": {
448
+ "type": "string",
449
+ "minLength": 1,
450
+ "maxLength": 1024
451
+ },
452
+ "id": {
453
+ "type": "string",
454
+ "minLength": 1,
455
+ "maxLength": 1024
456
+ },
457
+ "description": {
458
+ "type": "string",
459
+ "maxLength": 32767
460
+ }
461
+ },
462
+ "additionalProperties": false,
463
+ "required": [
464
+ "type",
465
+ "label"
466
+ ]
467
+ }
468
+ ]
469
+ }
470
+ }
471
+ },
472
+ "additionalProperties": false,
473
+ "required": [
474
+ "outputCount",
475
+ "resultMode",
476
+ "fields"
477
+ ]
151
478
  }
152
479
  },
153
480
  "additionalProperties": false
@@ -11,6 +11,18 @@
11
11
  "type": "string",
12
12
  "maxLength": 32767
13
13
  },
14
+ "iconData": {
15
+ "oneOf": [
16
+ {
17
+ "type": "string",
18
+ "maxLength": 32767,
19
+ "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
20
+ },
21
+ {
22
+ "type": "null"
23
+ }
24
+ ]
25
+ },
14
26
  "enabled": {
15
27
  "type": "boolean"
16
28
  },
@@ -41,6 +53,7 @@
41
53
  "integration",
42
54
  "mqttTopic",
43
55
  "request",
56
+ "customNodeStart",
44
57
  "timer",
45
58
  "udp",
46
59
  "virtualButton",
@@ -138,12 +151,336 @@
138
151
  "type": "string",
139
152
  "enum": [
140
153
  "cloud",
141
- "edge"
154
+ "edge",
155
+ "customNode"
142
156
  ]
143
157
  },
144
158
  "minimumAgentVersion": {
145
159
  "type": "string",
146
160
  "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$"
161
+ },
162
+ "customNodeConfig": {
163
+ "type": "object",
164
+ "properties": {
165
+ "outputCount": {
166
+ "type": "number",
167
+ "enum": [
168
+ 1,
169
+ 2
170
+ ]
171
+ },
172
+ "resultMode": {
173
+ "type": "string",
174
+ "enum": [
175
+ "optional",
176
+ "required",
177
+ "none"
178
+ ]
179
+ },
180
+ "resultDescription": {
181
+ "type": "string",
182
+ "maxLength": 32767
183
+ },
184
+ "fields": {
185
+ "type": "array",
186
+ "maxItems": 100,
187
+ "items": {
188
+ "oneOf": [
189
+ {
190
+ "type": "object",
191
+ "properties": {
192
+ "type": {
193
+ "type": "string",
194
+ "enum": [
195
+ "checkbox"
196
+ ]
197
+ },
198
+ "label": {
199
+ "type": "string",
200
+ "minLength": 1,
201
+ "maxLength": 1024
202
+ },
203
+ "id": {
204
+ "type": "string",
205
+ "minLength": 1,
206
+ "maxLength": 1024
207
+ },
208
+ "description": {
209
+ "type": "string",
210
+ "maxLength": 32767
211
+ },
212
+ "defaultValue": {
213
+ "type": "boolean"
214
+ }
215
+ },
216
+ "additionalProperties": false,
217
+ "required": [
218
+ "type",
219
+ "label"
220
+ ]
221
+ },
222
+ {
223
+ "type": "object",
224
+ "properties": {
225
+ "type": {
226
+ "type": "string",
227
+ "enum": [
228
+ "select"
229
+ ]
230
+ },
231
+ "label": {
232
+ "type": "string",
233
+ "minLength": 1,
234
+ "maxLength": 1024
235
+ },
236
+ "id": {
237
+ "type": "string",
238
+ "minLength": 1,
239
+ "maxLength": 1024
240
+ },
241
+ "description": {
242
+ "type": "string",
243
+ "maxLength": 32767
244
+ },
245
+ "defaultValue": {
246
+ "type": "string",
247
+ "minLength": 1,
248
+ "maxLength": 1024
249
+ },
250
+ "options": {
251
+ "type": "array",
252
+ "minItems": 1,
253
+ "maxItems": 100,
254
+ "items": {
255
+ "type": "object",
256
+ "properties": {
257
+ "label": {
258
+ "type": "string",
259
+ "maxLength": 1024
260
+ },
261
+ "value": {
262
+ "type": "string",
263
+ "minLength": 1,
264
+ "maxLength": 1024
265
+ }
266
+ },
267
+ "additionalProperties": false,
268
+ "required": [
269
+ "value"
270
+ ]
271
+ }
272
+ }
273
+ },
274
+ "additionalProperties": false,
275
+ "required": [
276
+ "type",
277
+ "label",
278
+ "defaultValue",
279
+ "options"
280
+ ]
281
+ },
282
+ {
283
+ "type": "object",
284
+ "properties": {
285
+ "type": {
286
+ "type": "string",
287
+ "enum": [
288
+ "stringTemplate"
289
+ ]
290
+ },
291
+ "label": {
292
+ "type": "string",
293
+ "minLength": 1,
294
+ "maxLength": 1024
295
+ },
296
+ "id": {
297
+ "type": "string",
298
+ "minLength": 1,
299
+ "maxLength": 1024
300
+ },
301
+ "description": {
302
+ "type": "string",
303
+ "maxLength": 32767
304
+ },
305
+ "defaultValue": {
306
+ "type": "string",
307
+ "maxLength": 1024
308
+ },
309
+ "required": {
310
+ "type": "boolean"
311
+ },
312
+ "validRegExp": {
313
+ "type": "string",
314
+ "maxLength": 1024
315
+ }
316
+ },
317
+ "additionalProperties": false,
318
+ "required": [
319
+ "type",
320
+ "label"
321
+ ]
322
+ },
323
+ {
324
+ "type": "object",
325
+ "properties": {
326
+ "type": {
327
+ "type": "string",
328
+ "enum": [
329
+ "numberTemplate"
330
+ ]
331
+ },
332
+ "label": {
333
+ "type": "string",
334
+ "minLength": 1,
335
+ "maxLength": 1024
336
+ },
337
+ "id": {
338
+ "type": "string",
339
+ "minLength": 1,
340
+ "maxLength": 1024
341
+ },
342
+ "description": {
343
+ "type": "string",
344
+ "maxLength": 32767
345
+ },
346
+ "defaultValue": {
347
+ "type": "number"
348
+ },
349
+ "required": {
350
+ "type": "boolean"
351
+ },
352
+ "validMin": {
353
+ "type": "number"
354
+ },
355
+ "validMax": {
356
+ "type": "number"
357
+ }
358
+ },
359
+ "additionalProperties": false,
360
+ "required": [
361
+ "type",
362
+ "label"
363
+ ]
364
+ },
365
+ {
366
+ "type": "object",
367
+ "properties": {
368
+ "type": {
369
+ "type": "string",
370
+ "enum": [
371
+ "jsonTemplate"
372
+ ]
373
+ },
374
+ "label": {
375
+ "type": "string",
376
+ "minLength": 1,
377
+ "maxLength": 1024
378
+ },
379
+ "id": {
380
+ "type": "string",
381
+ "minLength": 1,
382
+ "maxLength": 1024
383
+ },
384
+ "description": {
385
+ "type": "string",
386
+ "maxLength": 32767
387
+ },
388
+ "defaultValue": {
389
+ "type": "string",
390
+ "maxLength": 32767
391
+ },
392
+ "required": {
393
+ "type": "boolean"
394
+ }
395
+ },
396
+ "additionalProperties": false,
397
+ "required": [
398
+ "type",
399
+ "label"
400
+ ]
401
+ },
402
+ {
403
+ "type": "object",
404
+ "properties": {
405
+ "type": {
406
+ "type": "string",
407
+ "enum": [
408
+ "payloadPath"
409
+ ]
410
+ },
411
+ "label": {
412
+ "type": "string",
413
+ "minLength": 1,
414
+ "maxLength": 1024
415
+ },
416
+ "id": {
417
+ "type": "string",
418
+ "minLength": 1,
419
+ "maxLength": 1024
420
+ },
421
+ "description": {
422
+ "type": "string",
423
+ "maxLength": 32767
424
+ },
425
+ "required": {
426
+ "type": "boolean"
427
+ }
428
+ },
429
+ "additionalProperties": false,
430
+ "required": [
431
+ "type",
432
+ "label"
433
+ ]
434
+ },
435
+ {
436
+ "type": "object",
437
+ "properties": {
438
+ "type": {
439
+ "type": "string",
440
+ "enum": [
441
+ "section"
442
+ ]
443
+ },
444
+ "label": {
445
+ "type": "string",
446
+ "minLength": 1,
447
+ "maxLength": 1024
448
+ },
449
+ "id": {
450
+ "type": "string",
451
+ "minLength": 1,
452
+ "maxLength": 1024
453
+ },
454
+ "description": {
455
+ "type": "string",
456
+ "maxLength": 32767
457
+ }
458
+ },
459
+ "additionalProperties": false,
460
+ "required": [
461
+ "type",
462
+ "label"
463
+ ]
464
+ }
465
+ ]
466
+ }
467
+ }
468
+ },
469
+ "additionalProperties": false,
470
+ "required": [
471
+ "outputCount",
472
+ "resultMode",
473
+ "fields"
474
+ ]
475
+ },
476
+ "customNodeSupports": {
477
+ "type": "array",
478
+ "items": {
479
+ "type": "string",
480
+ "enum": [
481
+ "cloud"
482
+ ]
483
+ }
147
484
  }
148
485
  },
149
486
  "additionalProperties": false,