losant_rest 1.15.2 → 1.16.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +7912 -2208
  3. data/docs/application.md +3 -4
  4. data/docs/applicationDashboard.md +43 -0
  5. data/docs/applications.md +3 -2
  6. data/docs/flows.md +38 -0
  7. data/docs/instanceCustomNode.md +222 -0
  8. data/docs/instanceCustomNodes.md +91 -0
  9. data/docs/instanceSandbox.md +135 -0
  10. data/docs/instanceSandboxes.md +53 -0
  11. data/lib/losant_rest/application_dashboard.rb +49 -0
  12. data/lib/losant_rest/client.rb +18 -2
  13. data/lib/losant_rest/flows.rb +44 -0
  14. data/lib/losant_rest/instance_custom_node.rb +282 -0
  15. data/lib/losant_rest/instance_custom_nodes.rb +136 -0
  16. data/lib/losant_rest/instance_sandbox.rb +181 -0
  17. data/lib/losant_rest/instance_sandboxes.rb +94 -0
  18. data/lib/losant_rest/version.rb +1 -1
  19. data/lib/losant_rest.rb +4 -0
  20. data/schemas/apiTokenPost.json +18 -1
  21. data/schemas/application.json +1 -1
  22. data/schemas/applicationApplyTemplatePatch.json +5 -0
  23. data/schemas/applicationClonePost.json +5 -0
  24. data/schemas/applicationCreationByTemplateResult.json +1 -1
  25. data/schemas/applicationDashboardPost.json +165 -3
  26. data/schemas/applicationExportPost.json +5 -0
  27. data/schemas/applicationImportOptions.json +43 -0
  28. data/schemas/applicationPatch.json +1 -1
  29. data/schemas/applicationPost.json +1 -1
  30. data/schemas/applicationSearchResult.json +2 -1
  31. data/schemas/applicationTemplateCategories.json +11 -0
  32. data/schemas/applicationTemplateCategory.json +11 -0
  33. data/schemas/applications.json +1 -1
  34. data/schemas/dashboard.json +165 -3
  35. data/schemas/dashboardPatch.json +165 -3
  36. data/schemas/dashboardPost.json +165 -3
  37. data/schemas/dashboardSendReport.json +23 -3
  38. data/schemas/dashboards.json +165 -3
  39. data/schemas/dataExport.json +1 -0
  40. data/schemas/devicesDeletePost.json +5 -0
  41. data/schemas/devicesExportPayloadCountPost.json +1 -0
  42. data/schemas/devicesExportPost.json +1 -0
  43. data/schemas/devicesPatch.json +5 -0
  44. data/schemas/embeddedDeploymentExport.json +5 -0
  45. data/schemas/eventsExport.json +1 -0
  46. data/schemas/experienceBootstrapOptions.json +1 -1
  47. data/schemas/experienceLinkedResources.json +20 -5
  48. data/schemas/experienceSlug.json +1 -1
  49. data/schemas/experienceSlugPatch.json +1 -1
  50. data/schemas/experienceSlugPost.json +1 -1
  51. data/schemas/experienceSlugs.json +1 -1
  52. data/schemas/experienceUser.json +2 -1
  53. data/schemas/experienceUsers.json +2 -1
  54. data/schemas/flow.json +18 -0
  55. data/schemas/flowPatch.json +19 -0
  56. data/schemas/flowPost.json +19 -0
  57. data/schemas/flowVersion.json +2 -5
  58. data/schemas/flowVersionPost.json +1 -0
  59. data/schemas/flowVersions.json +2 -5
  60. data/schemas/flowVersionsDeletePost.json +5 -0
  61. data/schemas/flows.json +18 -0
  62. data/schemas/flowsImportPost.json +29 -2
  63. data/schemas/flowsImportResult.json +20 -5
  64. data/schemas/githubLogin.json +18 -1
  65. data/schemas/importIntoApplicationOptions.json +52 -0
  66. data/schemas/importNewApplicationOptions.json +44 -0
  67. data/schemas/instance.json +1 -0
  68. data/schemas/instanceCustomNode.json +589 -0
  69. data/schemas/instanceCustomNodePatch.json +674 -0
  70. data/schemas/instanceCustomNodePost.json +679 -0
  71. data/schemas/instanceCustomNodes.json +634 -0
  72. data/schemas/instanceMember.json +2 -1
  73. data/schemas/instanceMembers.json +2 -1
  74. data/schemas/instanceOrg.json +38 -0
  75. data/schemas/instanceOrgMember.json +2 -1
  76. data/schemas/instanceOrgPatch.json +29 -0
  77. data/schemas/instanceOrgPost.json +29 -0
  78. data/schemas/instanceOrgs.json +38 -0
  79. data/schemas/instancePatch.json +1 -0
  80. data/schemas/instanceReportOptionsPost.json +1 -0
  81. data/schemas/instanceSandbox.json +423 -0
  82. data/schemas/instanceSandboxes.json +48 -0
  83. data/schemas/integration.json +29 -1
  84. data/schemas/integrationPatch.json +29 -1
  85. data/schemas/integrationPost.json +29 -1
  86. data/schemas/integrations.json +29 -1
  87. data/schemas/me.json +2 -1
  88. data/schemas/notebookDataExportOptions.json +5 -0
  89. data/schemas/org.json +19 -1
  90. data/schemas/orgs.json +19 -1
  91. data/schemas/paletteResponse.json +785 -0
  92. data/schemas/userCredentials.json +18 -1
  93. data/schemas/userPost.json +18 -1
  94. metadata +20 -2
@@ -0,0 +1,785 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "customNodes": {
6
+ "type": "array",
7
+ "items": {
8
+ "type": "object",
9
+ "properties": {
10
+ "id": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ },
14
+ "name": {
15
+ "type": "string",
16
+ "minLength": 1,
17
+ "maxLength": 255
18
+ },
19
+ "description": {
20
+ "type": "string",
21
+ "maxLength": 32767
22
+ },
23
+ "shortDescription": {
24
+ "type": "string",
25
+ "maxLength": 1024
26
+ },
27
+ "iconData": {
28
+ "type": "string",
29
+ "maxLength": 32767,
30
+ "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
31
+ },
32
+ "docsUrl": {
33
+ "type": "string",
34
+ "maxLength": 1024
35
+ },
36
+ "category": {
37
+ "type": "string",
38
+ "enum": [
39
+ "data",
40
+ "experience",
41
+ "logic",
42
+ "output"
43
+ ]
44
+ },
45
+ "customNodeConfig": {
46
+ "type": "object",
47
+ "properties": {
48
+ "outputCount": {
49
+ "type": "number",
50
+ "enum": [
51
+ 1,
52
+ 2
53
+ ]
54
+ },
55
+ "resultMode": {
56
+ "type": "string",
57
+ "enum": [
58
+ "optional",
59
+ "required",
60
+ "none"
61
+ ]
62
+ },
63
+ "resultDescription": {
64
+ "type": "string",
65
+ "maxLength": 32767
66
+ },
67
+ "fields": {
68
+ "type": "array",
69
+ "maxItems": 100,
70
+ "items": {
71
+ "oneOf": [
72
+ {
73
+ "type": "object",
74
+ "properties": {
75
+ "type": {
76
+ "type": "string",
77
+ "enum": [
78
+ "checkbox"
79
+ ]
80
+ },
81
+ "label": {
82
+ "type": "string",
83
+ "minLength": 1,
84
+ "maxLength": 1024
85
+ },
86
+ "id": {
87
+ "type": "string",
88
+ "minLength": 1,
89
+ "maxLength": 1024
90
+ },
91
+ "description": {
92
+ "type": "string",
93
+ "maxLength": 32767
94
+ },
95
+ "defaultValue": {
96
+ "type": "boolean"
97
+ }
98
+ },
99
+ "additionalProperties": false,
100
+ "required": [
101
+ "type",
102
+ "label"
103
+ ]
104
+ },
105
+ {
106
+ "type": "object",
107
+ "properties": {
108
+ "type": {
109
+ "type": "string",
110
+ "enum": [
111
+ "select"
112
+ ]
113
+ },
114
+ "label": {
115
+ "type": "string",
116
+ "minLength": 1,
117
+ "maxLength": 1024
118
+ },
119
+ "id": {
120
+ "type": "string",
121
+ "minLength": 1,
122
+ "maxLength": 1024
123
+ },
124
+ "description": {
125
+ "type": "string",
126
+ "maxLength": 32767
127
+ },
128
+ "defaultValue": {
129
+ "type": "string",
130
+ "minLength": 1,
131
+ "maxLength": 1024
132
+ },
133
+ "options": {
134
+ "type": "array",
135
+ "minItems": 1,
136
+ "maxItems": 100,
137
+ "items": {
138
+ "type": "object",
139
+ "properties": {
140
+ "label": {
141
+ "type": "string",
142
+ "maxLength": 1024
143
+ },
144
+ "value": {
145
+ "type": "string",
146
+ "minLength": 1,
147
+ "maxLength": 1024
148
+ }
149
+ },
150
+ "additionalProperties": false,
151
+ "required": [
152
+ "value"
153
+ ]
154
+ }
155
+ }
156
+ },
157
+ "additionalProperties": false,
158
+ "required": [
159
+ "type",
160
+ "label",
161
+ "defaultValue",
162
+ "options"
163
+ ]
164
+ },
165
+ {
166
+ "type": "object",
167
+ "properties": {
168
+ "type": {
169
+ "type": "string",
170
+ "enum": [
171
+ "stringTemplate"
172
+ ]
173
+ },
174
+ "label": {
175
+ "type": "string",
176
+ "minLength": 1,
177
+ "maxLength": 1024
178
+ },
179
+ "id": {
180
+ "type": "string",
181
+ "minLength": 1,
182
+ "maxLength": 1024
183
+ },
184
+ "description": {
185
+ "type": "string",
186
+ "maxLength": 32767
187
+ },
188
+ "defaultValue": {
189
+ "type": "string",
190
+ "maxLength": 1024
191
+ },
192
+ "required": {
193
+ "type": "boolean"
194
+ },
195
+ "validRegExp": {
196
+ "type": "string",
197
+ "maxLength": 1024
198
+ }
199
+ },
200
+ "additionalProperties": false,
201
+ "required": [
202
+ "type",
203
+ "label"
204
+ ]
205
+ },
206
+ {
207
+ "type": "object",
208
+ "properties": {
209
+ "type": {
210
+ "type": "string",
211
+ "enum": [
212
+ "numberTemplate"
213
+ ]
214
+ },
215
+ "label": {
216
+ "type": "string",
217
+ "minLength": 1,
218
+ "maxLength": 1024
219
+ },
220
+ "id": {
221
+ "type": "string",
222
+ "minLength": 1,
223
+ "maxLength": 1024
224
+ },
225
+ "description": {
226
+ "type": "string",
227
+ "maxLength": 32767
228
+ },
229
+ "defaultValue": {
230
+ "type": "number"
231
+ },
232
+ "required": {
233
+ "type": "boolean"
234
+ },
235
+ "validMin": {
236
+ "type": "number"
237
+ },
238
+ "validMax": {
239
+ "type": "number"
240
+ }
241
+ },
242
+ "additionalProperties": false,
243
+ "required": [
244
+ "type",
245
+ "label"
246
+ ]
247
+ },
248
+ {
249
+ "type": "object",
250
+ "properties": {
251
+ "type": {
252
+ "type": "string",
253
+ "enum": [
254
+ "jsonTemplate"
255
+ ]
256
+ },
257
+ "label": {
258
+ "type": "string",
259
+ "minLength": 1,
260
+ "maxLength": 1024
261
+ },
262
+ "id": {
263
+ "type": "string",
264
+ "minLength": 1,
265
+ "maxLength": 1024
266
+ },
267
+ "description": {
268
+ "type": "string",
269
+ "maxLength": 32767
270
+ },
271
+ "defaultValue": {
272
+ "type": "string",
273
+ "maxLength": 32767
274
+ },
275
+ "required": {
276
+ "type": "boolean"
277
+ }
278
+ },
279
+ "additionalProperties": false,
280
+ "required": [
281
+ "type",
282
+ "label"
283
+ ]
284
+ },
285
+ {
286
+ "type": "object",
287
+ "properties": {
288
+ "type": {
289
+ "type": "string",
290
+ "enum": [
291
+ "payloadPath"
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
+ "required": {
309
+ "type": "boolean"
310
+ }
311
+ },
312
+ "additionalProperties": false,
313
+ "required": [
314
+ "type",
315
+ "label"
316
+ ]
317
+ },
318
+ {
319
+ "type": "object",
320
+ "properties": {
321
+ "type": {
322
+ "type": "string",
323
+ "enum": [
324
+ "section"
325
+ ]
326
+ },
327
+ "label": {
328
+ "type": "string",
329
+ "minLength": 1,
330
+ "maxLength": 1024
331
+ },
332
+ "id": {
333
+ "type": "string",
334
+ "minLength": 1,
335
+ "maxLength": 1024
336
+ },
337
+ "description": {
338
+ "type": "string",
339
+ "maxLength": 32767
340
+ }
341
+ },
342
+ "additionalProperties": false,
343
+ "required": [
344
+ "type",
345
+ "label"
346
+ ]
347
+ }
348
+ ]
349
+ }
350
+ }
351
+ },
352
+ "additionalProperties": false,
353
+ "required": [
354
+ "outputCount",
355
+ "resultMode",
356
+ "fields"
357
+ ]
358
+ },
359
+ "flowVersionId": {
360
+ "type": "string",
361
+ "pattern": "^[A-Fa-f\\d]{24}$"
362
+ },
363
+ "version": {
364
+ "type": "string",
365
+ "minLength": 1,
366
+ "maxLength": 255
367
+ },
368
+ "compatibleFlowClasses": {
369
+ "type": "object",
370
+ "properties": {
371
+ "cloud": {
372
+ "type": "boolean"
373
+ },
374
+ "experience": {
375
+ "type": "boolean"
376
+ },
377
+ "customNode": {
378
+ "type": "boolean"
379
+ },
380
+ "edge": {
381
+ "type": [
382
+ "boolean",
383
+ "string"
384
+ ]
385
+ },
386
+ "embedded": {
387
+ "type": [
388
+ "boolean",
389
+ "string"
390
+ ]
391
+ }
392
+ }
393
+ }
394
+ }
395
+ },
396
+ "instanceNodes": {
397
+ "type": "array",
398
+ "items": {
399
+ "type": "object",
400
+ "properties": {
401
+ "id": {
402
+ "type": "string",
403
+ "pattern": "^[A-Fa-f\\d]{24}$"
404
+ },
405
+ "name": {
406
+ "type": "string",
407
+ "minLength": 1,
408
+ "maxLength": 255
409
+ },
410
+ "description": {
411
+ "type": "string",
412
+ "maxLength": 32767
413
+ },
414
+ "shortDescription": {
415
+ "type": "string",
416
+ "maxLength": 1024
417
+ },
418
+ "iconData": {
419
+ "type": "string",
420
+ "maxLength": 32767,
421
+ "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
422
+ },
423
+ "docsUrl": {
424
+ "type": "string",
425
+ "maxLength": 1024
426
+ },
427
+ "category": {
428
+ "type": "string",
429
+ "enum": [
430
+ "data",
431
+ "experience",
432
+ "logic",
433
+ "output"
434
+ ]
435
+ },
436
+ "customNodeConfig": {
437
+ "type": "object",
438
+ "properties": {
439
+ "outputCount": {
440
+ "type": "number",
441
+ "enum": [
442
+ 1,
443
+ 2
444
+ ]
445
+ },
446
+ "resultMode": {
447
+ "type": "string",
448
+ "enum": [
449
+ "optional",
450
+ "required",
451
+ "none"
452
+ ]
453
+ },
454
+ "resultDescription": {
455
+ "type": "string",
456
+ "maxLength": 32767
457
+ },
458
+ "fields": {
459
+ "type": "array",
460
+ "maxItems": 100,
461
+ "items": {
462
+ "oneOf": [
463
+ {
464
+ "type": "object",
465
+ "properties": {
466
+ "type": {
467
+ "type": "string",
468
+ "enum": [
469
+ "checkbox"
470
+ ]
471
+ },
472
+ "label": {
473
+ "type": "string",
474
+ "minLength": 1,
475
+ "maxLength": 1024
476
+ },
477
+ "id": {
478
+ "type": "string",
479
+ "minLength": 1,
480
+ "maxLength": 1024
481
+ },
482
+ "description": {
483
+ "type": "string",
484
+ "maxLength": 32767
485
+ },
486
+ "defaultValue": {
487
+ "type": "boolean"
488
+ }
489
+ },
490
+ "additionalProperties": false,
491
+ "required": [
492
+ "type",
493
+ "label"
494
+ ]
495
+ },
496
+ {
497
+ "type": "object",
498
+ "properties": {
499
+ "type": {
500
+ "type": "string",
501
+ "enum": [
502
+ "select"
503
+ ]
504
+ },
505
+ "label": {
506
+ "type": "string",
507
+ "minLength": 1,
508
+ "maxLength": 1024
509
+ },
510
+ "id": {
511
+ "type": "string",
512
+ "minLength": 1,
513
+ "maxLength": 1024
514
+ },
515
+ "description": {
516
+ "type": "string",
517
+ "maxLength": 32767
518
+ },
519
+ "defaultValue": {
520
+ "type": "string",
521
+ "minLength": 1,
522
+ "maxLength": 1024
523
+ },
524
+ "options": {
525
+ "type": "array",
526
+ "minItems": 1,
527
+ "maxItems": 100,
528
+ "items": {
529
+ "type": "object",
530
+ "properties": {
531
+ "label": {
532
+ "type": "string",
533
+ "maxLength": 1024
534
+ },
535
+ "value": {
536
+ "type": "string",
537
+ "minLength": 1,
538
+ "maxLength": 1024
539
+ }
540
+ },
541
+ "additionalProperties": false,
542
+ "required": [
543
+ "value"
544
+ ]
545
+ }
546
+ }
547
+ },
548
+ "additionalProperties": false,
549
+ "required": [
550
+ "type",
551
+ "label",
552
+ "defaultValue",
553
+ "options"
554
+ ]
555
+ },
556
+ {
557
+ "type": "object",
558
+ "properties": {
559
+ "type": {
560
+ "type": "string",
561
+ "enum": [
562
+ "stringTemplate"
563
+ ]
564
+ },
565
+ "label": {
566
+ "type": "string",
567
+ "minLength": 1,
568
+ "maxLength": 1024
569
+ },
570
+ "id": {
571
+ "type": "string",
572
+ "minLength": 1,
573
+ "maxLength": 1024
574
+ },
575
+ "description": {
576
+ "type": "string",
577
+ "maxLength": 32767
578
+ },
579
+ "defaultValue": {
580
+ "type": "string",
581
+ "maxLength": 1024
582
+ },
583
+ "required": {
584
+ "type": "boolean"
585
+ },
586
+ "validRegExp": {
587
+ "type": "string",
588
+ "maxLength": 1024
589
+ }
590
+ },
591
+ "additionalProperties": false,
592
+ "required": [
593
+ "type",
594
+ "label"
595
+ ]
596
+ },
597
+ {
598
+ "type": "object",
599
+ "properties": {
600
+ "type": {
601
+ "type": "string",
602
+ "enum": [
603
+ "numberTemplate"
604
+ ]
605
+ },
606
+ "label": {
607
+ "type": "string",
608
+ "minLength": 1,
609
+ "maxLength": 1024
610
+ },
611
+ "id": {
612
+ "type": "string",
613
+ "minLength": 1,
614
+ "maxLength": 1024
615
+ },
616
+ "description": {
617
+ "type": "string",
618
+ "maxLength": 32767
619
+ },
620
+ "defaultValue": {
621
+ "type": "number"
622
+ },
623
+ "required": {
624
+ "type": "boolean"
625
+ },
626
+ "validMin": {
627
+ "type": "number"
628
+ },
629
+ "validMax": {
630
+ "type": "number"
631
+ }
632
+ },
633
+ "additionalProperties": false,
634
+ "required": [
635
+ "type",
636
+ "label"
637
+ ]
638
+ },
639
+ {
640
+ "type": "object",
641
+ "properties": {
642
+ "type": {
643
+ "type": "string",
644
+ "enum": [
645
+ "jsonTemplate"
646
+ ]
647
+ },
648
+ "label": {
649
+ "type": "string",
650
+ "minLength": 1,
651
+ "maxLength": 1024
652
+ },
653
+ "id": {
654
+ "type": "string",
655
+ "minLength": 1,
656
+ "maxLength": 1024
657
+ },
658
+ "description": {
659
+ "type": "string",
660
+ "maxLength": 32767
661
+ },
662
+ "defaultValue": {
663
+ "type": "string",
664
+ "maxLength": 32767
665
+ },
666
+ "required": {
667
+ "type": "boolean"
668
+ }
669
+ },
670
+ "additionalProperties": false,
671
+ "required": [
672
+ "type",
673
+ "label"
674
+ ]
675
+ },
676
+ {
677
+ "type": "object",
678
+ "properties": {
679
+ "type": {
680
+ "type": "string",
681
+ "enum": [
682
+ "payloadPath"
683
+ ]
684
+ },
685
+ "label": {
686
+ "type": "string",
687
+ "minLength": 1,
688
+ "maxLength": 1024
689
+ },
690
+ "id": {
691
+ "type": "string",
692
+ "minLength": 1,
693
+ "maxLength": 1024
694
+ },
695
+ "description": {
696
+ "type": "string",
697
+ "maxLength": 32767
698
+ },
699
+ "required": {
700
+ "type": "boolean"
701
+ }
702
+ },
703
+ "additionalProperties": false,
704
+ "required": [
705
+ "type",
706
+ "label"
707
+ ]
708
+ },
709
+ {
710
+ "type": "object",
711
+ "properties": {
712
+ "type": {
713
+ "type": "string",
714
+ "enum": [
715
+ "section"
716
+ ]
717
+ },
718
+ "label": {
719
+ "type": "string",
720
+ "minLength": 1,
721
+ "maxLength": 1024
722
+ },
723
+ "id": {
724
+ "type": "string",
725
+ "minLength": 1,
726
+ "maxLength": 1024
727
+ },
728
+ "description": {
729
+ "type": "string",
730
+ "maxLength": 32767
731
+ }
732
+ },
733
+ "additionalProperties": false,
734
+ "required": [
735
+ "type",
736
+ "label"
737
+ ]
738
+ }
739
+ ]
740
+ }
741
+ }
742
+ },
743
+ "additionalProperties": false,
744
+ "required": [
745
+ "outputCount",
746
+ "resultMode",
747
+ "fields"
748
+ ]
749
+ },
750
+ "compatibleFlowClasses": {
751
+ "type": "object",
752
+ "properties": {
753
+ "cloud": {
754
+ "type": "boolean"
755
+ },
756
+ "experience": {
757
+ "type": "boolean"
758
+ },
759
+ "customNode": {
760
+ "type": "boolean"
761
+ },
762
+ "edge": {
763
+ "type": [
764
+ "boolean",
765
+ "string"
766
+ ]
767
+ },
768
+ "embedded": {
769
+ "type": [
770
+ "boolean",
771
+ "string"
772
+ ]
773
+ }
774
+ }
775
+ }
776
+ }
777
+ }
778
+ }
779
+ },
780
+ "applicationId": {
781
+ "type": "string",
782
+ "pattern": "^[A-Fa-f\\d]{24}$"
783
+ }
784
+ }
785
+ }