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,634 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Instance Custom Node",
9
+ "description": "Schema for a single Instance Custom Node",
10
+ "type": "object",
11
+ "properties": {
12
+ "id": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "instanceCustomNodeId": {
17
+ "type": "string",
18
+ "pattern": "^[A-Fa-f\\d]{24}$"
19
+ },
20
+ "instanceId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ },
24
+ "creationDate": {
25
+ "type": "string",
26
+ "format": "date-time"
27
+ },
28
+ "createdById": {
29
+ "type": "string",
30
+ "pattern": "^[A-Fa-f\\d]{24}$"
31
+ },
32
+ "createdByType": {
33
+ "type": "string",
34
+ "enum": [
35
+ "apiToken",
36
+ "user"
37
+ ]
38
+ },
39
+ "lastUpdated": {
40
+ "type": "string",
41
+ "format": "date-time"
42
+ },
43
+ "lastUpdatedById": {
44
+ "type": "string",
45
+ "pattern": "^[A-Fa-f\\d]{24}$"
46
+ },
47
+ "lastUpdatedByType": {
48
+ "type": "string",
49
+ "enum": [
50
+ "apiToken",
51
+ "user"
52
+ ]
53
+ },
54
+ "name": {
55
+ "type": "string",
56
+ "minLength": 1,
57
+ "maxLength": 255
58
+ },
59
+ "description": {
60
+ "type": "string",
61
+ "maxLength": 32767
62
+ },
63
+ "shortDescription": {
64
+ "type": "string",
65
+ "maxLength": 1024
66
+ },
67
+ "iconData": {
68
+ "type": "string",
69
+ "maxLength": 32767,
70
+ "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
71
+ },
72
+ "docsUrl": {
73
+ "type": "string",
74
+ "maxLength": 1024
75
+ },
76
+ "category": {
77
+ "type": "string",
78
+ "enum": [
79
+ "data",
80
+ "experience",
81
+ "logic",
82
+ "output"
83
+ ]
84
+ },
85
+ "minimumAgentVersion": {
86
+ "type": "string",
87
+ "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$"
88
+ },
89
+ "triggers": {
90
+ "type": "array",
91
+ "items": {
92
+ "type": "object",
93
+ "properties": {
94
+ "key": {
95
+ "type": "string",
96
+ "maxLength": 1024
97
+ },
98
+ "type": {
99
+ "type": "string",
100
+ "enum": [
101
+ "customNodeStart"
102
+ ]
103
+ },
104
+ "config": {
105
+ "type": "object",
106
+ "additionalProperties": false
107
+ },
108
+ "meta": {
109
+ "type": "object",
110
+ "properties": {
111
+ "category": {
112
+ "type": "string",
113
+ "enum": [
114
+ "trigger"
115
+ ]
116
+ },
117
+ "name": {
118
+ "type": "string",
119
+ "enum": [
120
+ "customNodeStart"
121
+ ]
122
+ },
123
+ "label": {
124
+ "type": "string",
125
+ "minLength": 1,
126
+ "maxLength": 255
127
+ },
128
+ "x": {
129
+ "type": "number"
130
+ },
131
+ "y": {
132
+ "type": "number"
133
+ },
134
+ "uiId": {
135
+ "type": "string",
136
+ "maxLength": 48
137
+ },
138
+ "description": {
139
+ "type": "string",
140
+ "maxLength": 32767
141
+ }
142
+ },
143
+ "additionalProperties": false
144
+ },
145
+ "outputIds": {
146
+ "type": "array",
147
+ "items": {
148
+ "type": "array",
149
+ "items": {
150
+ "type": "string",
151
+ "maxLength": 48,
152
+ "minLength": 1
153
+ },
154
+ "maxItems": 100
155
+ },
156
+ "maxItems": 100
157
+ }
158
+ },
159
+ "required": [
160
+ "type"
161
+ ],
162
+ "additionalProperties": false
163
+ },
164
+ "maxItems": 1
165
+ },
166
+ "nodes": {
167
+ "type": "array",
168
+ "items": {
169
+ "type": "object",
170
+ "properties": {
171
+ "id": {
172
+ "type": "string",
173
+ "maxLength": 1024
174
+ },
175
+ "type": {
176
+ "type": "string",
177
+ "minLength": 1,
178
+ "maxLength": 1024
179
+ },
180
+ "config": {
181
+ "type": "object"
182
+ },
183
+ "meta": {
184
+ "type": "object"
185
+ },
186
+ "outputIds": {
187
+ "type": "array",
188
+ "items": {
189
+ "type": "array",
190
+ "items": {
191
+ "type": "string",
192
+ "maxLength": 48,
193
+ "minLength": 1
194
+ },
195
+ "maxItems": 100
196
+ },
197
+ "maxItems": 100
198
+ }
199
+ },
200
+ "additionalProperties": false,
201
+ "required": [
202
+ "type"
203
+ ]
204
+ }
205
+ },
206
+ "customNodeConfig": {
207
+ "type": "object",
208
+ "properties": {
209
+ "outputCount": {
210
+ "type": "number",
211
+ "enum": [
212
+ 1,
213
+ 2
214
+ ]
215
+ },
216
+ "resultMode": {
217
+ "type": "string",
218
+ "enum": [
219
+ "optional",
220
+ "required",
221
+ "none"
222
+ ]
223
+ },
224
+ "resultDescription": {
225
+ "type": "string",
226
+ "maxLength": 32767
227
+ },
228
+ "fields": {
229
+ "type": "array",
230
+ "maxItems": 100,
231
+ "items": {
232
+ "oneOf": [
233
+ {
234
+ "type": "object",
235
+ "properties": {
236
+ "type": {
237
+ "type": "string",
238
+ "enum": [
239
+ "checkbox"
240
+ ]
241
+ },
242
+ "label": {
243
+ "type": "string",
244
+ "minLength": 1,
245
+ "maxLength": 1024
246
+ },
247
+ "id": {
248
+ "type": "string",
249
+ "minLength": 1,
250
+ "maxLength": 1024
251
+ },
252
+ "description": {
253
+ "type": "string",
254
+ "maxLength": 32767
255
+ },
256
+ "defaultValue": {
257
+ "type": "boolean"
258
+ }
259
+ },
260
+ "additionalProperties": false,
261
+ "required": [
262
+ "type",
263
+ "label"
264
+ ]
265
+ },
266
+ {
267
+ "type": "object",
268
+ "properties": {
269
+ "type": {
270
+ "type": "string",
271
+ "enum": [
272
+ "select"
273
+ ]
274
+ },
275
+ "label": {
276
+ "type": "string",
277
+ "minLength": 1,
278
+ "maxLength": 1024
279
+ },
280
+ "id": {
281
+ "type": "string",
282
+ "minLength": 1,
283
+ "maxLength": 1024
284
+ },
285
+ "description": {
286
+ "type": "string",
287
+ "maxLength": 32767
288
+ },
289
+ "defaultValue": {
290
+ "type": "string",
291
+ "minLength": 1,
292
+ "maxLength": 1024
293
+ },
294
+ "options": {
295
+ "type": "array",
296
+ "minItems": 1,
297
+ "maxItems": 100,
298
+ "items": {
299
+ "type": "object",
300
+ "properties": {
301
+ "label": {
302
+ "type": "string",
303
+ "maxLength": 1024
304
+ },
305
+ "value": {
306
+ "type": "string",
307
+ "minLength": 1,
308
+ "maxLength": 1024
309
+ }
310
+ },
311
+ "additionalProperties": false,
312
+ "required": [
313
+ "value"
314
+ ]
315
+ }
316
+ }
317
+ },
318
+ "additionalProperties": false,
319
+ "required": [
320
+ "type",
321
+ "label",
322
+ "defaultValue",
323
+ "options"
324
+ ]
325
+ },
326
+ {
327
+ "type": "object",
328
+ "properties": {
329
+ "type": {
330
+ "type": "string",
331
+ "enum": [
332
+ "stringTemplate"
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": "string",
351
+ "maxLength": 1024
352
+ },
353
+ "required": {
354
+ "type": "boolean"
355
+ },
356
+ "validRegExp": {
357
+ "type": "string",
358
+ "maxLength": 1024
359
+ }
360
+ },
361
+ "additionalProperties": false,
362
+ "required": [
363
+ "type",
364
+ "label"
365
+ ]
366
+ },
367
+ {
368
+ "type": "object",
369
+ "properties": {
370
+ "type": {
371
+ "type": "string",
372
+ "enum": [
373
+ "numberTemplate"
374
+ ]
375
+ },
376
+ "label": {
377
+ "type": "string",
378
+ "minLength": 1,
379
+ "maxLength": 1024
380
+ },
381
+ "id": {
382
+ "type": "string",
383
+ "minLength": 1,
384
+ "maxLength": 1024
385
+ },
386
+ "description": {
387
+ "type": "string",
388
+ "maxLength": 32767
389
+ },
390
+ "defaultValue": {
391
+ "type": "number"
392
+ },
393
+ "required": {
394
+ "type": "boolean"
395
+ },
396
+ "validMin": {
397
+ "type": "number"
398
+ },
399
+ "validMax": {
400
+ "type": "number"
401
+ }
402
+ },
403
+ "additionalProperties": false,
404
+ "required": [
405
+ "type",
406
+ "label"
407
+ ]
408
+ },
409
+ {
410
+ "type": "object",
411
+ "properties": {
412
+ "type": {
413
+ "type": "string",
414
+ "enum": [
415
+ "jsonTemplate"
416
+ ]
417
+ },
418
+ "label": {
419
+ "type": "string",
420
+ "minLength": 1,
421
+ "maxLength": 1024
422
+ },
423
+ "id": {
424
+ "type": "string",
425
+ "minLength": 1,
426
+ "maxLength": 1024
427
+ },
428
+ "description": {
429
+ "type": "string",
430
+ "maxLength": 32767
431
+ },
432
+ "defaultValue": {
433
+ "type": "string",
434
+ "maxLength": 32767
435
+ },
436
+ "required": {
437
+ "type": "boolean"
438
+ }
439
+ },
440
+ "additionalProperties": false,
441
+ "required": [
442
+ "type",
443
+ "label"
444
+ ]
445
+ },
446
+ {
447
+ "type": "object",
448
+ "properties": {
449
+ "type": {
450
+ "type": "string",
451
+ "enum": [
452
+ "payloadPath"
453
+ ]
454
+ },
455
+ "label": {
456
+ "type": "string",
457
+ "minLength": 1,
458
+ "maxLength": 1024
459
+ },
460
+ "id": {
461
+ "type": "string",
462
+ "minLength": 1,
463
+ "maxLength": 1024
464
+ },
465
+ "description": {
466
+ "type": "string",
467
+ "maxLength": 32767
468
+ },
469
+ "required": {
470
+ "type": "boolean"
471
+ }
472
+ },
473
+ "additionalProperties": false,
474
+ "required": [
475
+ "type",
476
+ "label"
477
+ ]
478
+ },
479
+ {
480
+ "type": "object",
481
+ "properties": {
482
+ "type": {
483
+ "type": "string",
484
+ "enum": [
485
+ "section"
486
+ ]
487
+ },
488
+ "label": {
489
+ "type": "string",
490
+ "minLength": 1,
491
+ "maxLength": 1024
492
+ },
493
+ "id": {
494
+ "type": "string",
495
+ "minLength": 1,
496
+ "maxLength": 1024
497
+ },
498
+ "description": {
499
+ "type": "string",
500
+ "maxLength": 32767
501
+ }
502
+ },
503
+ "additionalProperties": false,
504
+ "required": [
505
+ "type",
506
+ "label"
507
+ ]
508
+ }
509
+ ]
510
+ }
511
+ }
512
+ },
513
+ "additionalProperties": false,
514
+ "required": [
515
+ "outputCount",
516
+ "resultMode",
517
+ "fields"
518
+ ]
519
+ },
520
+ "customNodeSupports": {
521
+ "type": "array",
522
+ "items": {
523
+ "type": "string",
524
+ "enum": [
525
+ "cloud"
526
+ ]
527
+ }
528
+ },
529
+ "sourceApplicationId": {
530
+ "type": "string",
531
+ "pattern": "^[A-Fa-f\\d]{24}$"
532
+ },
533
+ "sourceFlowId": {
534
+ "type": "string",
535
+ "pattern": "^[A-Fa-f\\d]{24}$"
536
+ },
537
+ "sourceFlowVersion": {
538
+ "type": "string",
539
+ "minLength": 1,
540
+ "maxLength": 255
541
+ },
542
+ "stats": {
543
+ "type": "object",
544
+ "properties": {
545
+ "errorCount": {
546
+ "type": "integer"
547
+ },
548
+ "runCount": {
549
+ "type": "integer"
550
+ }
551
+ },
552
+ "additionalProperties": false
553
+ },
554
+ "usage": {
555
+ "type": "object",
556
+ "properties": {
557
+ "sandbox": {
558
+ "type": "object",
559
+ "properties": {
560
+ "appCount": {
561
+ "type": "integer"
562
+ },
563
+ "flowCount": {
564
+ "type": "integer"
565
+ }
566
+ },
567
+ "additionalProperties": false
568
+ }
569
+ },
570
+ "patternProperties": {
571
+ "^[A-Fa-f\\d]{24}$": {
572
+ "type": "object",
573
+ "properties": {
574
+ "appCount": {
575
+ "type": "integer"
576
+ },
577
+ "flowCount": {
578
+ "type": "integer"
579
+ },
580
+ "orgName": {
581
+ "type": "string",
582
+ "minLength": 1,
583
+ "maxLength": 255
584
+ },
585
+ "orgIconColor": {
586
+ "type": "string",
587
+ "maxLength": 64
588
+ }
589
+ },
590
+ "additionalProperties": false
591
+ }
592
+ },
593
+ "additionalProperties": false
594
+ }
595
+ }
596
+ }
597
+ },
598
+ "instanceId": {
599
+ "type": "string",
600
+ "pattern": "^[A-Fa-f\\d]{24}$"
601
+ },
602
+ "count": {
603
+ "type": "integer"
604
+ },
605
+ "totalCount": {
606
+ "type": "integer"
607
+ },
608
+ "perPage": {
609
+ "type": "integer"
610
+ },
611
+ "page": {
612
+ "type": "integer"
613
+ },
614
+ "filter": {
615
+ "type": "string"
616
+ },
617
+ "filterField": {
618
+ "type": "string"
619
+ },
620
+ "sortField": {
621
+ "type": "string"
622
+ },
623
+ "sortDirection": {
624
+ "type": "string",
625
+ "enum": [
626
+ "asc",
627
+ "desc",
628
+ "ASC",
629
+ "DESC",
630
+ ""
631
+ ]
632
+ }
633
+ }
634
+ }
@@ -33,7 +33,8 @@
33
33
  },
34
34
  "avatarUrl": {
35
35
  "type": "string",
36
- "format": "url"
36
+ "format": "uri",
37
+ "maxLength": 1024
37
38
  },
38
39
  "twoFactorAuthEnabled": {
39
40
  "type": "boolean"
@@ -40,7 +40,8 @@
40
40
  },
41
41
  "avatarUrl": {
42
42
  "type": "string",
43
- "format": "url"
43
+ "format": "uri",
44
+ "maxLength": 1024
44
45
  },
45
46
  "twoFactorAuthEnabled": {
46
47
  "type": "boolean"