@voyant-travel/openapi 0.2.6 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/package.json +8 -5
  2. package/spec/admin/accommodations.json +1443 -0
  3. package/spec/admin/action-ledger.json +6285 -0
  4. package/spec/admin/booking-requirements.json +5975 -0
  5. package/spec/admin/bookings.json +19276 -0
  6. package/spec/admin/catalog.json +703 -0
  7. package/spec/admin/distribution.json +20434 -0
  8. package/spec/admin/external-refs.json +1437 -0
  9. package/spec/admin/extras.json +4787 -0
  10. package/spec/admin/finance.json +36583 -0
  11. package/spec/admin/identity.json +4141 -0
  12. package/spec/admin/legal.json +14821 -0
  13. package/spec/admin/markets.json +5551 -0
  14. package/spec/admin/notifications.json +8667 -0
  15. package/spec/admin/operations.json +41627 -0
  16. package/spec/admin/operator-settings.json +1451 -0
  17. package/spec/admin/pricing.json +11136 -0
  18. package/spec/admin/products.json +23257 -0
  19. package/spec/admin/promotions.json +2778 -0
  20. package/spec/admin/quotes.json +7333 -0
  21. package/spec/admin/relationships.json +14512 -0
  22. package/spec/admin/sellability.json +5056 -0
  23. package/spec/admin/storefront.json +1973 -0
  24. package/spec/admin/suppliers.json +6094 -0
  25. package/spec/admin/trips.json +9531 -0
  26. package/spec/framework-admin.json +12715 -1375
  27. package/spec/framework-openapi.json +13731 -1482
  28. package/spec/framework-storefront.json +1022 -107
  29. package/spec/storefront/booking-requirements.json +380 -0
  30. package/spec/storefront/bookings.json +6213 -0
  31. package/spec/storefront/catalog.json +703 -0
  32. package/spec/storefront/customer-portal.json +6177 -0
  33. package/spec/storefront/finance.json +4914 -0
  34. package/spec/storefront/legal.json +2165 -0
  35. package/spec/storefront/markets.json +269 -0
  36. package/spec/storefront/operator-settings.json +329 -0
  37. package/spec/storefront/pricing.json +598 -0
  38. package/spec/storefront/products.json +2965 -0
  39. package/spec/storefront/storefront-verification.json +943 -0
  40. package/spec/storefront/storefront.json +4157 -0
  41. package/spec/storefront/trips.json +9531 -0
@@ -0,0 +1,1973 @@
1
+ {
2
+ "openapi": "3.1.0",
3
+ "info": {
4
+ "title": "Voyant Framework API",
5
+ "version": "0.0.0",
6
+ "description": "Generated from the Voyant framework's standard module composition. Do not edit by hand."
7
+ },
8
+ "servers": [
9
+ {
10
+ "url": "/",
11
+ "description": "This deployment (same origin)"
12
+ }
13
+ ],
14
+ "components": {
15
+ "schemas": {
16
+ "CatalogSearchFilter": {
17
+ "anyOf": [
18
+ {
19
+ "type": "object",
20
+ "properties": {
21
+ "kind": {
22
+ "type": "string",
23
+ "enum": [
24
+ "eq"
25
+ ]
26
+ },
27
+ "field": {
28
+ "type": "string",
29
+ "minLength": 1
30
+ },
31
+ "value": {
32
+ "anyOf": [
33
+ {
34
+ "type": "string"
35
+ },
36
+ {
37
+ "type": "number"
38
+ },
39
+ {
40
+ "type": "boolean"
41
+ }
42
+ ]
43
+ }
44
+ },
45
+ "required": [
46
+ "kind",
47
+ "field",
48
+ "value"
49
+ ]
50
+ },
51
+ {
52
+ "type": "object",
53
+ "properties": {
54
+ "kind": {
55
+ "type": "string",
56
+ "enum": [
57
+ "in"
58
+ ]
59
+ },
60
+ "field": {
61
+ "type": "string",
62
+ "minLength": 1
63
+ },
64
+ "values": {
65
+ "type": "array",
66
+ "items": {
67
+ "anyOf": [
68
+ {
69
+ "type": "string"
70
+ },
71
+ {
72
+ "type": "number"
73
+ }
74
+ ]
75
+ }
76
+ }
77
+ },
78
+ "required": [
79
+ "kind",
80
+ "field",
81
+ "values"
82
+ ]
83
+ },
84
+ {
85
+ "type": "object",
86
+ "properties": {
87
+ "kind": {
88
+ "type": "string",
89
+ "enum": [
90
+ "range"
91
+ ]
92
+ },
93
+ "field": {
94
+ "type": "string",
95
+ "minLength": 1
96
+ },
97
+ "gte": {
98
+ "type": "number"
99
+ },
100
+ "lte": {
101
+ "type": "number"
102
+ }
103
+ },
104
+ "required": [
105
+ "kind",
106
+ "field"
107
+ ]
108
+ },
109
+ {
110
+ "type": "object",
111
+ "properties": {
112
+ "kind": {
113
+ "type": "string",
114
+ "enum": [
115
+ "and"
116
+ ]
117
+ },
118
+ "clauses": {
119
+ "type": "array",
120
+ "items": {
121
+ "$ref": "#/components/schemas/CatalogSearchFilter"
122
+ }
123
+ }
124
+ },
125
+ "required": [
126
+ "kind",
127
+ "clauses"
128
+ ]
129
+ },
130
+ {
131
+ "type": "object",
132
+ "properties": {
133
+ "kind": {
134
+ "type": "string",
135
+ "enum": [
136
+ "or"
137
+ ]
138
+ },
139
+ "clauses": {
140
+ "type": "array",
141
+ "items": {
142
+ "$ref": "#/components/schemas/CatalogSearchFilter"
143
+ }
144
+ }
145
+ },
146
+ "required": [
147
+ "kind",
148
+ "clauses"
149
+ ]
150
+ }
151
+ ]
152
+ }
153
+ },
154
+ "parameters": {}
155
+ },
156
+ "paths": {
157
+ "/v1/admin/storefront/settings": {
158
+ "get": {
159
+ "responses": {
160
+ "200": {
161
+ "description": "The deployment's storefront settings",
162
+ "content": {
163
+ "application/json": {
164
+ "schema": {
165
+ "type": "object",
166
+ "properties": {
167
+ "data": {
168
+ "type": "object",
169
+ "properties": {
170
+ "branding": {
171
+ "type": "object",
172
+ "properties": {
173
+ "logoUrl": {
174
+ "type": [
175
+ "string",
176
+ "null"
177
+ ],
178
+ "format": "uri"
179
+ },
180
+ "faviconUrl": {
181
+ "type": [
182
+ "string",
183
+ "null"
184
+ ],
185
+ "format": "uri"
186
+ },
187
+ "brandMarkUrl": {
188
+ "type": [
189
+ "string",
190
+ "null"
191
+ ],
192
+ "format": "uri"
193
+ },
194
+ "primaryColor": {
195
+ "type": [
196
+ "string",
197
+ "null"
198
+ ],
199
+ "pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
200
+ },
201
+ "accentColor": {
202
+ "type": [
203
+ "string",
204
+ "null"
205
+ ],
206
+ "pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
207
+ },
208
+ "supportedLanguages": {
209
+ "type": "array",
210
+ "items": {
211
+ "type": "string",
212
+ "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
213
+ }
214
+ }
215
+ },
216
+ "required": [
217
+ "logoUrl",
218
+ "faviconUrl",
219
+ "brandMarkUrl",
220
+ "primaryColor",
221
+ "accentColor",
222
+ "supportedLanguages"
223
+ ]
224
+ },
225
+ "support": {
226
+ "type": "object",
227
+ "properties": {
228
+ "email": {
229
+ "type": [
230
+ "string",
231
+ "null"
232
+ ],
233
+ "format": "email"
234
+ },
235
+ "phone": {
236
+ "type": [
237
+ "string",
238
+ "null"
239
+ ],
240
+ "minLength": 1
241
+ },
242
+ "links": {
243
+ "type": "array",
244
+ "items": {
245
+ "type": "object",
246
+ "properties": {
247
+ "label": {
248
+ "type": "string",
249
+ "minLength": 1
250
+ },
251
+ "url": {
252
+ "type": "string",
253
+ "format": "uri"
254
+ }
255
+ },
256
+ "required": [
257
+ "label",
258
+ "url"
259
+ ]
260
+ }
261
+ }
262
+ },
263
+ "required": [
264
+ "email",
265
+ "phone",
266
+ "links"
267
+ ]
268
+ },
269
+ "legal": {
270
+ "type": "object",
271
+ "properties": {
272
+ "termsUrl": {
273
+ "type": [
274
+ "string",
275
+ "null"
276
+ ],
277
+ "format": "uri"
278
+ },
279
+ "privacyUrl": {
280
+ "type": [
281
+ "string",
282
+ "null"
283
+ ],
284
+ "format": "uri"
285
+ },
286
+ "cancellationUrl": {
287
+ "type": [
288
+ "string",
289
+ "null"
290
+ ],
291
+ "format": "uri"
292
+ },
293
+ "defaultContractTemplateId": {
294
+ "type": [
295
+ "string",
296
+ "null"
297
+ ],
298
+ "minLength": 1
299
+ }
300
+ },
301
+ "required": [
302
+ "termsUrl",
303
+ "privacyUrl",
304
+ "cancellationUrl",
305
+ "defaultContractTemplateId"
306
+ ]
307
+ },
308
+ "localization": {
309
+ "type": "object",
310
+ "properties": {
311
+ "defaultLocale": {
312
+ "type": [
313
+ "string",
314
+ "null"
315
+ ],
316
+ "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
317
+ },
318
+ "currencyDisplay": {
319
+ "type": "string",
320
+ "enum": [
321
+ "code",
322
+ "symbol",
323
+ "name"
324
+ ]
325
+ }
326
+ },
327
+ "required": [
328
+ "defaultLocale",
329
+ "currencyDisplay"
330
+ ]
331
+ },
332
+ "forms": {
333
+ "type": "object",
334
+ "properties": {
335
+ "billing": {
336
+ "type": "object",
337
+ "properties": {
338
+ "fields": {
339
+ "type": "array",
340
+ "items": {
341
+ "type": "object",
342
+ "properties": {
343
+ "key": {
344
+ "type": "string",
345
+ "minLength": 1
346
+ },
347
+ "label": {
348
+ "type": "string",
349
+ "minLength": 1
350
+ },
351
+ "type": {
352
+ "type": "string",
353
+ "enum": [
354
+ "text",
355
+ "email",
356
+ "tel",
357
+ "textarea",
358
+ "select",
359
+ "checkbox",
360
+ "date",
361
+ "country"
362
+ ]
363
+ },
364
+ "required": {
365
+ "type": "boolean"
366
+ },
367
+ "placeholder": {
368
+ "type": [
369
+ "string",
370
+ "null"
371
+ ],
372
+ "minLength": 1
373
+ },
374
+ "description": {
375
+ "type": [
376
+ "string",
377
+ "null"
378
+ ],
379
+ "minLength": 1
380
+ },
381
+ "autocomplete": {
382
+ "type": [
383
+ "string",
384
+ "null"
385
+ ],
386
+ "minLength": 1
387
+ },
388
+ "options": {
389
+ "type": "array",
390
+ "items": {
391
+ "type": "object",
392
+ "properties": {
393
+ "value": {
394
+ "type": "string",
395
+ "minLength": 1
396
+ },
397
+ "label": {
398
+ "type": "string",
399
+ "minLength": 1
400
+ }
401
+ },
402
+ "required": [
403
+ "value",
404
+ "label"
405
+ ]
406
+ }
407
+ }
408
+ },
409
+ "required": [
410
+ "key",
411
+ "label",
412
+ "type",
413
+ "required",
414
+ "placeholder",
415
+ "description",
416
+ "autocomplete",
417
+ "options"
418
+ ]
419
+ }
420
+ }
421
+ },
422
+ "required": [
423
+ "fields"
424
+ ]
425
+ },
426
+ "travelers": {
427
+ "type": "object",
428
+ "properties": {
429
+ "fields": {
430
+ "type": "array",
431
+ "items": {
432
+ "type": "object",
433
+ "properties": {
434
+ "key": {
435
+ "type": "string",
436
+ "minLength": 1
437
+ },
438
+ "label": {
439
+ "type": "string",
440
+ "minLength": 1
441
+ },
442
+ "type": {
443
+ "type": "string",
444
+ "enum": [
445
+ "text",
446
+ "email",
447
+ "tel",
448
+ "textarea",
449
+ "select",
450
+ "checkbox",
451
+ "date",
452
+ "country"
453
+ ]
454
+ },
455
+ "required": {
456
+ "type": "boolean"
457
+ },
458
+ "placeholder": {
459
+ "type": [
460
+ "string",
461
+ "null"
462
+ ],
463
+ "minLength": 1
464
+ },
465
+ "description": {
466
+ "type": [
467
+ "string",
468
+ "null"
469
+ ],
470
+ "minLength": 1
471
+ },
472
+ "autocomplete": {
473
+ "type": [
474
+ "string",
475
+ "null"
476
+ ],
477
+ "minLength": 1
478
+ },
479
+ "options": {
480
+ "type": "array",
481
+ "items": {
482
+ "type": "object",
483
+ "properties": {
484
+ "value": {
485
+ "type": "string",
486
+ "minLength": 1
487
+ },
488
+ "label": {
489
+ "type": "string",
490
+ "minLength": 1
491
+ }
492
+ },
493
+ "required": [
494
+ "value",
495
+ "label"
496
+ ]
497
+ }
498
+ }
499
+ },
500
+ "required": [
501
+ "key",
502
+ "label",
503
+ "type",
504
+ "required",
505
+ "placeholder",
506
+ "description",
507
+ "autocomplete",
508
+ "options"
509
+ ]
510
+ }
511
+ }
512
+ },
513
+ "required": [
514
+ "fields"
515
+ ]
516
+ }
517
+ },
518
+ "required": [
519
+ "billing",
520
+ "travelers"
521
+ ]
522
+ },
523
+ "payment": {
524
+ "type": "object",
525
+ "properties": {
526
+ "defaultMethod": {
527
+ "type": [
528
+ "string",
529
+ "null"
530
+ ],
531
+ "enum": [
532
+ "card",
533
+ "bank_transfer",
534
+ "cash",
535
+ "voucher",
536
+ "invoice",
537
+ null
538
+ ]
539
+ },
540
+ "methods": {
541
+ "type": "array",
542
+ "items": {
543
+ "type": "object",
544
+ "properties": {
545
+ "code": {
546
+ "type": "string",
547
+ "enum": [
548
+ "card",
549
+ "bank_transfer",
550
+ "cash",
551
+ "voucher",
552
+ "invoice"
553
+ ]
554
+ },
555
+ "label": {
556
+ "type": "string",
557
+ "minLength": 1
558
+ },
559
+ "description": {
560
+ "type": [
561
+ "string",
562
+ "null"
563
+ ],
564
+ "minLength": 1
565
+ },
566
+ "enabled": {
567
+ "type": "boolean"
568
+ }
569
+ },
570
+ "required": [
571
+ "code",
572
+ "label",
573
+ "description",
574
+ "enabled"
575
+ ]
576
+ }
577
+ },
578
+ "structure": {
579
+ "type": "string",
580
+ "enum": [
581
+ "full",
582
+ "split"
583
+ ]
584
+ },
585
+ "schedule": {
586
+ "type": "array",
587
+ "items": {
588
+ "type": "object",
589
+ "properties": {
590
+ "percent": {
591
+ "type": "number",
592
+ "minimum": 0,
593
+ "maximum": 100
594
+ },
595
+ "dueInDays": {
596
+ "type": "integer",
597
+ "minimum": 0
598
+ },
599
+ "dueCondition": {
600
+ "type": "string",
601
+ "enum": [
602
+ "after_booking",
603
+ "before_departure"
604
+ ]
605
+ }
606
+ },
607
+ "required": [
608
+ "percent",
609
+ "dueInDays",
610
+ "dueCondition"
611
+ ]
612
+ }
613
+ },
614
+ "defaultSchedule": {
615
+ "type": [
616
+ "object",
617
+ "null"
618
+ ],
619
+ "properties": {
620
+ "depositPercent": {
621
+ "type": [
622
+ "number",
623
+ "null"
624
+ ],
625
+ "minimum": 0,
626
+ "maximum": 100
627
+ },
628
+ "balanceDueDaysBeforeDeparture": {
629
+ "type": [
630
+ "integer",
631
+ "null"
632
+ ],
633
+ "minimum": 0
634
+ }
635
+ },
636
+ "required": [
637
+ "depositPercent",
638
+ "balanceDueDaysBeforeDeparture"
639
+ ]
640
+ },
641
+ "bankTransfer": {
642
+ "type": [
643
+ "object",
644
+ "null"
645
+ ],
646
+ "properties": {
647
+ "dueDays": {
648
+ "type": [
649
+ "integer",
650
+ "null"
651
+ ],
652
+ "minimum": 0
653
+ },
654
+ "account": {
655
+ "type": [
656
+ "object",
657
+ "null"
658
+ ],
659
+ "properties": {
660
+ "provider": {
661
+ "type": [
662
+ "string",
663
+ "null"
664
+ ],
665
+ "minLength": 1
666
+ },
667
+ "currency": {
668
+ "type": [
669
+ "string",
670
+ "null"
671
+ ],
672
+ "minLength": 1
673
+ },
674
+ "iban": {
675
+ "type": "string",
676
+ "minLength": 1
677
+ },
678
+ "beneficiary": {
679
+ "type": "string",
680
+ "minLength": 1
681
+ },
682
+ "bank": {
683
+ "type": "string",
684
+ "minLength": 1
685
+ }
686
+ },
687
+ "required": [
688
+ "provider",
689
+ "currency",
690
+ "iban",
691
+ "beneficiary",
692
+ "bank"
693
+ ]
694
+ },
695
+ "accountHolder": {
696
+ "type": [
697
+ "string",
698
+ "null"
699
+ ],
700
+ "minLength": 1
701
+ },
702
+ "bankName": {
703
+ "type": [
704
+ "string",
705
+ "null"
706
+ ],
707
+ "minLength": 1
708
+ },
709
+ "iban": {
710
+ "type": [
711
+ "string",
712
+ "null"
713
+ ],
714
+ "minLength": 1
715
+ },
716
+ "bic": {
717
+ "type": [
718
+ "string",
719
+ "null"
720
+ ],
721
+ "minLength": 1
722
+ },
723
+ "paymentReference": {
724
+ "type": [
725
+ "string",
726
+ "null"
727
+ ],
728
+ "minLength": 1
729
+ },
730
+ "instructions": {
731
+ "type": [
732
+ "string",
733
+ "null"
734
+ ],
735
+ "minLength": 1
736
+ }
737
+ },
738
+ "required": [
739
+ "dueDays",
740
+ "account",
741
+ "accountHolder",
742
+ "bankName",
743
+ "iban",
744
+ "bic",
745
+ "paymentReference",
746
+ "instructions"
747
+ ]
748
+ }
749
+ },
750
+ "required": [
751
+ "defaultMethod",
752
+ "methods",
753
+ "structure",
754
+ "schedule",
755
+ "defaultSchedule",
756
+ "bankTransfer"
757
+ ]
758
+ }
759
+ },
760
+ "required": [
761
+ "branding",
762
+ "support",
763
+ "legal",
764
+ "localization",
765
+ "forms",
766
+ "payment"
767
+ ]
768
+ }
769
+ },
770
+ "required": [
771
+ "data"
772
+ ]
773
+ }
774
+ }
775
+ }
776
+ }
777
+ },
778
+ "operationId": "getAdminStorefrontSettings",
779
+ "summary": "GET /v1/admin/storefront/settings",
780
+ "tags": [
781
+ "storefront"
782
+ ],
783
+ "x-voyant-module": "storefront",
784
+ "x-voyant-surface": "admin"
785
+ },
786
+ "patch": {
787
+ "requestBody": {
788
+ "required": true,
789
+ "content": {
790
+ "application/json": {
791
+ "schema": {
792
+ "type": "object",
793
+ "properties": {
794
+ "branding": {
795
+ "type": "object",
796
+ "properties": {
797
+ "logoUrl": {
798
+ "type": [
799
+ "string",
800
+ "null"
801
+ ],
802
+ "format": "uri"
803
+ },
804
+ "faviconUrl": {
805
+ "type": [
806
+ "string",
807
+ "null"
808
+ ],
809
+ "format": "uri"
810
+ },
811
+ "brandMarkUrl": {
812
+ "type": [
813
+ "string",
814
+ "null"
815
+ ],
816
+ "format": "uri"
817
+ },
818
+ "primaryColor": {
819
+ "type": [
820
+ "string",
821
+ "null"
822
+ ],
823
+ "pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
824
+ },
825
+ "accentColor": {
826
+ "type": [
827
+ "string",
828
+ "null"
829
+ ],
830
+ "pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
831
+ },
832
+ "supportedLanguages": {
833
+ "type": "array",
834
+ "items": {
835
+ "type": "string",
836
+ "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
837
+ }
838
+ }
839
+ }
840
+ },
841
+ "support": {
842
+ "type": "object",
843
+ "properties": {
844
+ "email": {
845
+ "type": [
846
+ "string",
847
+ "null"
848
+ ],
849
+ "format": "email"
850
+ },
851
+ "phone": {
852
+ "type": [
853
+ "string",
854
+ "null"
855
+ ],
856
+ "minLength": 1
857
+ },
858
+ "links": {
859
+ "type": "array",
860
+ "items": {
861
+ "type": "object",
862
+ "properties": {
863
+ "label": {
864
+ "type": "string",
865
+ "minLength": 1
866
+ },
867
+ "url": {
868
+ "type": "string",
869
+ "format": "uri"
870
+ }
871
+ },
872
+ "required": [
873
+ "label",
874
+ "url"
875
+ ]
876
+ }
877
+ }
878
+ }
879
+ },
880
+ "legal": {
881
+ "type": "object",
882
+ "properties": {
883
+ "termsUrl": {
884
+ "type": [
885
+ "string",
886
+ "null"
887
+ ],
888
+ "format": "uri"
889
+ },
890
+ "privacyUrl": {
891
+ "type": [
892
+ "string",
893
+ "null"
894
+ ],
895
+ "format": "uri"
896
+ },
897
+ "cancellationUrl": {
898
+ "type": [
899
+ "string",
900
+ "null"
901
+ ],
902
+ "format": "uri"
903
+ },
904
+ "defaultContractTemplateId": {
905
+ "type": [
906
+ "string",
907
+ "null"
908
+ ],
909
+ "minLength": 1
910
+ }
911
+ }
912
+ },
913
+ "localization": {
914
+ "type": "object",
915
+ "properties": {
916
+ "defaultLocale": {
917
+ "type": [
918
+ "string",
919
+ "null"
920
+ ],
921
+ "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
922
+ },
923
+ "currencyDisplay": {
924
+ "type": "string",
925
+ "enum": [
926
+ "code",
927
+ "symbol",
928
+ "name"
929
+ ]
930
+ }
931
+ }
932
+ },
933
+ "forms": {
934
+ "type": "object",
935
+ "properties": {
936
+ "billing": {
937
+ "type": "object",
938
+ "properties": {
939
+ "fields": {
940
+ "type": "array",
941
+ "items": {
942
+ "type": "object",
943
+ "properties": {
944
+ "key": {
945
+ "type": "string",
946
+ "minLength": 1
947
+ },
948
+ "label": {
949
+ "type": "string",
950
+ "minLength": 1
951
+ },
952
+ "type": {
953
+ "type": "string",
954
+ "enum": [
955
+ "text",
956
+ "email",
957
+ "tel",
958
+ "textarea",
959
+ "select",
960
+ "checkbox",
961
+ "date",
962
+ "country"
963
+ ],
964
+ "default": "text"
965
+ },
966
+ "required": {
967
+ "type": "boolean",
968
+ "default": false
969
+ },
970
+ "placeholder": {
971
+ "type": [
972
+ "string",
973
+ "null"
974
+ ],
975
+ "minLength": 1
976
+ },
977
+ "description": {
978
+ "type": [
979
+ "string",
980
+ "null"
981
+ ],
982
+ "minLength": 1
983
+ },
984
+ "autocomplete": {
985
+ "type": [
986
+ "string",
987
+ "null"
988
+ ],
989
+ "minLength": 1
990
+ },
991
+ "options": {
992
+ "type": "array",
993
+ "items": {
994
+ "type": "object",
995
+ "properties": {
996
+ "value": {
997
+ "type": "string",
998
+ "minLength": 1
999
+ },
1000
+ "label": {
1001
+ "type": "string",
1002
+ "minLength": 1
1003
+ }
1004
+ },
1005
+ "required": [
1006
+ "value",
1007
+ "label"
1008
+ ]
1009
+ },
1010
+ "default": []
1011
+ }
1012
+ },
1013
+ "required": [
1014
+ "key",
1015
+ "label"
1016
+ ]
1017
+ },
1018
+ "default": []
1019
+ }
1020
+ }
1021
+ },
1022
+ "travelers": {
1023
+ "type": "object",
1024
+ "properties": {
1025
+ "fields": {
1026
+ "type": "array",
1027
+ "items": {
1028
+ "type": "object",
1029
+ "properties": {
1030
+ "key": {
1031
+ "type": "string",
1032
+ "minLength": 1
1033
+ },
1034
+ "label": {
1035
+ "type": "string",
1036
+ "minLength": 1
1037
+ },
1038
+ "type": {
1039
+ "type": "string",
1040
+ "enum": [
1041
+ "text",
1042
+ "email",
1043
+ "tel",
1044
+ "textarea",
1045
+ "select",
1046
+ "checkbox",
1047
+ "date",
1048
+ "country"
1049
+ ],
1050
+ "default": "text"
1051
+ },
1052
+ "required": {
1053
+ "type": "boolean",
1054
+ "default": false
1055
+ },
1056
+ "placeholder": {
1057
+ "type": [
1058
+ "string",
1059
+ "null"
1060
+ ],
1061
+ "minLength": 1
1062
+ },
1063
+ "description": {
1064
+ "type": [
1065
+ "string",
1066
+ "null"
1067
+ ],
1068
+ "minLength": 1
1069
+ },
1070
+ "autocomplete": {
1071
+ "type": [
1072
+ "string",
1073
+ "null"
1074
+ ],
1075
+ "minLength": 1
1076
+ },
1077
+ "options": {
1078
+ "type": "array",
1079
+ "items": {
1080
+ "type": "object",
1081
+ "properties": {
1082
+ "value": {
1083
+ "type": "string",
1084
+ "minLength": 1
1085
+ },
1086
+ "label": {
1087
+ "type": "string",
1088
+ "minLength": 1
1089
+ }
1090
+ },
1091
+ "required": [
1092
+ "value",
1093
+ "label"
1094
+ ]
1095
+ },
1096
+ "default": []
1097
+ }
1098
+ },
1099
+ "required": [
1100
+ "key",
1101
+ "label"
1102
+ ]
1103
+ },
1104
+ "default": []
1105
+ }
1106
+ }
1107
+ }
1108
+ }
1109
+ },
1110
+ "payment": {
1111
+ "type": "object",
1112
+ "properties": {
1113
+ "defaultMethod": {
1114
+ "type": [
1115
+ "string",
1116
+ "null"
1117
+ ],
1118
+ "enum": [
1119
+ "card",
1120
+ "bank_transfer",
1121
+ "cash",
1122
+ "voucher",
1123
+ "invoice",
1124
+ null
1125
+ ]
1126
+ },
1127
+ "methods": {
1128
+ "type": "array",
1129
+ "items": {
1130
+ "type": "object",
1131
+ "properties": {
1132
+ "code": {
1133
+ "type": "string",
1134
+ "enum": [
1135
+ "card",
1136
+ "bank_transfer",
1137
+ "cash",
1138
+ "voucher",
1139
+ "invoice"
1140
+ ]
1141
+ },
1142
+ "label": {
1143
+ "type": "string",
1144
+ "minLength": 1
1145
+ },
1146
+ "description": {
1147
+ "type": [
1148
+ "string",
1149
+ "null"
1150
+ ],
1151
+ "minLength": 1
1152
+ },
1153
+ "enabled": {
1154
+ "type": "boolean",
1155
+ "default": true
1156
+ }
1157
+ },
1158
+ "required": [
1159
+ "code"
1160
+ ]
1161
+ }
1162
+ },
1163
+ "structure": {
1164
+ "type": "string",
1165
+ "enum": [
1166
+ "full",
1167
+ "split"
1168
+ ]
1169
+ },
1170
+ "schedule": {
1171
+ "type": "array",
1172
+ "items": {
1173
+ "type": "object",
1174
+ "properties": {
1175
+ "percent": {
1176
+ "type": "number",
1177
+ "minimum": 0,
1178
+ "maximum": 100
1179
+ },
1180
+ "dueInDays": {
1181
+ "type": "integer",
1182
+ "minimum": 0
1183
+ },
1184
+ "dueCondition": {
1185
+ "type": "string",
1186
+ "enum": [
1187
+ "after_booking",
1188
+ "before_departure"
1189
+ ]
1190
+ }
1191
+ },
1192
+ "required": [
1193
+ "percent",
1194
+ "dueInDays",
1195
+ "dueCondition"
1196
+ ]
1197
+ }
1198
+ },
1199
+ "defaultSchedule": {
1200
+ "type": [
1201
+ "object",
1202
+ "null"
1203
+ ],
1204
+ "properties": {
1205
+ "depositPercent": {
1206
+ "type": [
1207
+ "number",
1208
+ "null"
1209
+ ],
1210
+ "minimum": 0,
1211
+ "maximum": 100
1212
+ },
1213
+ "balanceDueDaysBeforeDeparture": {
1214
+ "type": [
1215
+ "integer",
1216
+ "null"
1217
+ ],
1218
+ "minimum": 0
1219
+ }
1220
+ }
1221
+ },
1222
+ "bankTransfer": {
1223
+ "type": [
1224
+ "object",
1225
+ "null"
1226
+ ],
1227
+ "properties": {
1228
+ "dueDays": {
1229
+ "type": [
1230
+ "integer",
1231
+ "null"
1232
+ ],
1233
+ "minimum": 0
1234
+ },
1235
+ "account": {
1236
+ "type": [
1237
+ "object",
1238
+ "null"
1239
+ ],
1240
+ "properties": {
1241
+ "provider": {
1242
+ "type": [
1243
+ "string",
1244
+ "null"
1245
+ ],
1246
+ "minLength": 1
1247
+ },
1248
+ "currency": {
1249
+ "type": [
1250
+ "string",
1251
+ "null"
1252
+ ],
1253
+ "minLength": 1
1254
+ },
1255
+ "iban": {
1256
+ "type": "string",
1257
+ "minLength": 1
1258
+ },
1259
+ "beneficiary": {
1260
+ "type": "string",
1261
+ "minLength": 1
1262
+ },
1263
+ "bank": {
1264
+ "type": "string",
1265
+ "minLength": 1
1266
+ }
1267
+ },
1268
+ "required": [
1269
+ "iban",
1270
+ "beneficiary",
1271
+ "bank"
1272
+ ]
1273
+ },
1274
+ "accountHolder": {
1275
+ "type": [
1276
+ "string",
1277
+ "null"
1278
+ ],
1279
+ "minLength": 1
1280
+ },
1281
+ "bankName": {
1282
+ "type": [
1283
+ "string",
1284
+ "null"
1285
+ ],
1286
+ "minLength": 1
1287
+ },
1288
+ "iban": {
1289
+ "type": [
1290
+ "string",
1291
+ "null"
1292
+ ],
1293
+ "minLength": 1
1294
+ },
1295
+ "bic": {
1296
+ "type": [
1297
+ "string",
1298
+ "null"
1299
+ ],
1300
+ "minLength": 1
1301
+ },
1302
+ "paymentReference": {
1303
+ "type": [
1304
+ "string",
1305
+ "null"
1306
+ ],
1307
+ "minLength": 1
1308
+ },
1309
+ "instructions": {
1310
+ "type": [
1311
+ "string",
1312
+ "null"
1313
+ ],
1314
+ "minLength": 1
1315
+ }
1316
+ }
1317
+ }
1318
+ }
1319
+ }
1320
+ }
1321
+ }
1322
+ }
1323
+ }
1324
+ },
1325
+ "responses": {
1326
+ "200": {
1327
+ "description": "The updated storefront settings",
1328
+ "content": {
1329
+ "application/json": {
1330
+ "schema": {
1331
+ "type": "object",
1332
+ "properties": {
1333
+ "data": {
1334
+ "type": "object",
1335
+ "properties": {
1336
+ "branding": {
1337
+ "type": "object",
1338
+ "properties": {
1339
+ "logoUrl": {
1340
+ "type": [
1341
+ "string",
1342
+ "null"
1343
+ ],
1344
+ "format": "uri"
1345
+ },
1346
+ "faviconUrl": {
1347
+ "type": [
1348
+ "string",
1349
+ "null"
1350
+ ],
1351
+ "format": "uri"
1352
+ },
1353
+ "brandMarkUrl": {
1354
+ "type": [
1355
+ "string",
1356
+ "null"
1357
+ ],
1358
+ "format": "uri"
1359
+ },
1360
+ "primaryColor": {
1361
+ "type": [
1362
+ "string",
1363
+ "null"
1364
+ ],
1365
+ "pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
1366
+ },
1367
+ "accentColor": {
1368
+ "type": [
1369
+ "string",
1370
+ "null"
1371
+ ],
1372
+ "pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
1373
+ },
1374
+ "supportedLanguages": {
1375
+ "type": "array",
1376
+ "items": {
1377
+ "type": "string",
1378
+ "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
1379
+ }
1380
+ }
1381
+ },
1382
+ "required": [
1383
+ "logoUrl",
1384
+ "faviconUrl",
1385
+ "brandMarkUrl",
1386
+ "primaryColor",
1387
+ "accentColor",
1388
+ "supportedLanguages"
1389
+ ]
1390
+ },
1391
+ "support": {
1392
+ "type": "object",
1393
+ "properties": {
1394
+ "email": {
1395
+ "type": [
1396
+ "string",
1397
+ "null"
1398
+ ],
1399
+ "format": "email"
1400
+ },
1401
+ "phone": {
1402
+ "type": [
1403
+ "string",
1404
+ "null"
1405
+ ],
1406
+ "minLength": 1
1407
+ },
1408
+ "links": {
1409
+ "type": "array",
1410
+ "items": {
1411
+ "type": "object",
1412
+ "properties": {
1413
+ "label": {
1414
+ "type": "string",
1415
+ "minLength": 1
1416
+ },
1417
+ "url": {
1418
+ "type": "string",
1419
+ "format": "uri"
1420
+ }
1421
+ },
1422
+ "required": [
1423
+ "label",
1424
+ "url"
1425
+ ]
1426
+ }
1427
+ }
1428
+ },
1429
+ "required": [
1430
+ "email",
1431
+ "phone",
1432
+ "links"
1433
+ ]
1434
+ },
1435
+ "legal": {
1436
+ "type": "object",
1437
+ "properties": {
1438
+ "termsUrl": {
1439
+ "type": [
1440
+ "string",
1441
+ "null"
1442
+ ],
1443
+ "format": "uri"
1444
+ },
1445
+ "privacyUrl": {
1446
+ "type": [
1447
+ "string",
1448
+ "null"
1449
+ ],
1450
+ "format": "uri"
1451
+ },
1452
+ "cancellationUrl": {
1453
+ "type": [
1454
+ "string",
1455
+ "null"
1456
+ ],
1457
+ "format": "uri"
1458
+ },
1459
+ "defaultContractTemplateId": {
1460
+ "type": [
1461
+ "string",
1462
+ "null"
1463
+ ],
1464
+ "minLength": 1
1465
+ }
1466
+ },
1467
+ "required": [
1468
+ "termsUrl",
1469
+ "privacyUrl",
1470
+ "cancellationUrl",
1471
+ "defaultContractTemplateId"
1472
+ ]
1473
+ },
1474
+ "localization": {
1475
+ "type": "object",
1476
+ "properties": {
1477
+ "defaultLocale": {
1478
+ "type": [
1479
+ "string",
1480
+ "null"
1481
+ ],
1482
+ "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
1483
+ },
1484
+ "currencyDisplay": {
1485
+ "type": "string",
1486
+ "enum": [
1487
+ "code",
1488
+ "symbol",
1489
+ "name"
1490
+ ]
1491
+ }
1492
+ },
1493
+ "required": [
1494
+ "defaultLocale",
1495
+ "currencyDisplay"
1496
+ ]
1497
+ },
1498
+ "forms": {
1499
+ "type": "object",
1500
+ "properties": {
1501
+ "billing": {
1502
+ "type": "object",
1503
+ "properties": {
1504
+ "fields": {
1505
+ "type": "array",
1506
+ "items": {
1507
+ "type": "object",
1508
+ "properties": {
1509
+ "key": {
1510
+ "type": "string",
1511
+ "minLength": 1
1512
+ },
1513
+ "label": {
1514
+ "type": "string",
1515
+ "minLength": 1
1516
+ },
1517
+ "type": {
1518
+ "type": "string",
1519
+ "enum": [
1520
+ "text",
1521
+ "email",
1522
+ "tel",
1523
+ "textarea",
1524
+ "select",
1525
+ "checkbox",
1526
+ "date",
1527
+ "country"
1528
+ ]
1529
+ },
1530
+ "required": {
1531
+ "type": "boolean"
1532
+ },
1533
+ "placeholder": {
1534
+ "type": [
1535
+ "string",
1536
+ "null"
1537
+ ],
1538
+ "minLength": 1
1539
+ },
1540
+ "description": {
1541
+ "type": [
1542
+ "string",
1543
+ "null"
1544
+ ],
1545
+ "minLength": 1
1546
+ },
1547
+ "autocomplete": {
1548
+ "type": [
1549
+ "string",
1550
+ "null"
1551
+ ],
1552
+ "minLength": 1
1553
+ },
1554
+ "options": {
1555
+ "type": "array",
1556
+ "items": {
1557
+ "type": "object",
1558
+ "properties": {
1559
+ "value": {
1560
+ "type": "string",
1561
+ "minLength": 1
1562
+ },
1563
+ "label": {
1564
+ "type": "string",
1565
+ "minLength": 1
1566
+ }
1567
+ },
1568
+ "required": [
1569
+ "value",
1570
+ "label"
1571
+ ]
1572
+ }
1573
+ }
1574
+ },
1575
+ "required": [
1576
+ "key",
1577
+ "label",
1578
+ "type",
1579
+ "required",
1580
+ "placeholder",
1581
+ "description",
1582
+ "autocomplete",
1583
+ "options"
1584
+ ]
1585
+ }
1586
+ }
1587
+ },
1588
+ "required": [
1589
+ "fields"
1590
+ ]
1591
+ },
1592
+ "travelers": {
1593
+ "type": "object",
1594
+ "properties": {
1595
+ "fields": {
1596
+ "type": "array",
1597
+ "items": {
1598
+ "type": "object",
1599
+ "properties": {
1600
+ "key": {
1601
+ "type": "string",
1602
+ "minLength": 1
1603
+ },
1604
+ "label": {
1605
+ "type": "string",
1606
+ "minLength": 1
1607
+ },
1608
+ "type": {
1609
+ "type": "string",
1610
+ "enum": [
1611
+ "text",
1612
+ "email",
1613
+ "tel",
1614
+ "textarea",
1615
+ "select",
1616
+ "checkbox",
1617
+ "date",
1618
+ "country"
1619
+ ]
1620
+ },
1621
+ "required": {
1622
+ "type": "boolean"
1623
+ },
1624
+ "placeholder": {
1625
+ "type": [
1626
+ "string",
1627
+ "null"
1628
+ ],
1629
+ "minLength": 1
1630
+ },
1631
+ "description": {
1632
+ "type": [
1633
+ "string",
1634
+ "null"
1635
+ ],
1636
+ "minLength": 1
1637
+ },
1638
+ "autocomplete": {
1639
+ "type": [
1640
+ "string",
1641
+ "null"
1642
+ ],
1643
+ "minLength": 1
1644
+ },
1645
+ "options": {
1646
+ "type": "array",
1647
+ "items": {
1648
+ "type": "object",
1649
+ "properties": {
1650
+ "value": {
1651
+ "type": "string",
1652
+ "minLength": 1
1653
+ },
1654
+ "label": {
1655
+ "type": "string",
1656
+ "minLength": 1
1657
+ }
1658
+ },
1659
+ "required": [
1660
+ "value",
1661
+ "label"
1662
+ ]
1663
+ }
1664
+ }
1665
+ },
1666
+ "required": [
1667
+ "key",
1668
+ "label",
1669
+ "type",
1670
+ "required",
1671
+ "placeholder",
1672
+ "description",
1673
+ "autocomplete",
1674
+ "options"
1675
+ ]
1676
+ }
1677
+ }
1678
+ },
1679
+ "required": [
1680
+ "fields"
1681
+ ]
1682
+ }
1683
+ },
1684
+ "required": [
1685
+ "billing",
1686
+ "travelers"
1687
+ ]
1688
+ },
1689
+ "payment": {
1690
+ "type": "object",
1691
+ "properties": {
1692
+ "defaultMethod": {
1693
+ "type": [
1694
+ "string",
1695
+ "null"
1696
+ ],
1697
+ "enum": [
1698
+ "card",
1699
+ "bank_transfer",
1700
+ "cash",
1701
+ "voucher",
1702
+ "invoice",
1703
+ null
1704
+ ]
1705
+ },
1706
+ "methods": {
1707
+ "type": "array",
1708
+ "items": {
1709
+ "type": "object",
1710
+ "properties": {
1711
+ "code": {
1712
+ "type": "string",
1713
+ "enum": [
1714
+ "card",
1715
+ "bank_transfer",
1716
+ "cash",
1717
+ "voucher",
1718
+ "invoice"
1719
+ ]
1720
+ },
1721
+ "label": {
1722
+ "type": "string",
1723
+ "minLength": 1
1724
+ },
1725
+ "description": {
1726
+ "type": [
1727
+ "string",
1728
+ "null"
1729
+ ],
1730
+ "minLength": 1
1731
+ },
1732
+ "enabled": {
1733
+ "type": "boolean"
1734
+ }
1735
+ },
1736
+ "required": [
1737
+ "code",
1738
+ "label",
1739
+ "description",
1740
+ "enabled"
1741
+ ]
1742
+ }
1743
+ },
1744
+ "structure": {
1745
+ "type": "string",
1746
+ "enum": [
1747
+ "full",
1748
+ "split"
1749
+ ]
1750
+ },
1751
+ "schedule": {
1752
+ "type": "array",
1753
+ "items": {
1754
+ "type": "object",
1755
+ "properties": {
1756
+ "percent": {
1757
+ "type": "number",
1758
+ "minimum": 0,
1759
+ "maximum": 100
1760
+ },
1761
+ "dueInDays": {
1762
+ "type": "integer",
1763
+ "minimum": 0
1764
+ },
1765
+ "dueCondition": {
1766
+ "type": "string",
1767
+ "enum": [
1768
+ "after_booking",
1769
+ "before_departure"
1770
+ ]
1771
+ }
1772
+ },
1773
+ "required": [
1774
+ "percent",
1775
+ "dueInDays",
1776
+ "dueCondition"
1777
+ ]
1778
+ }
1779
+ },
1780
+ "defaultSchedule": {
1781
+ "type": [
1782
+ "object",
1783
+ "null"
1784
+ ],
1785
+ "properties": {
1786
+ "depositPercent": {
1787
+ "type": [
1788
+ "number",
1789
+ "null"
1790
+ ],
1791
+ "minimum": 0,
1792
+ "maximum": 100
1793
+ },
1794
+ "balanceDueDaysBeforeDeparture": {
1795
+ "type": [
1796
+ "integer",
1797
+ "null"
1798
+ ],
1799
+ "minimum": 0
1800
+ }
1801
+ },
1802
+ "required": [
1803
+ "depositPercent",
1804
+ "balanceDueDaysBeforeDeparture"
1805
+ ]
1806
+ },
1807
+ "bankTransfer": {
1808
+ "type": [
1809
+ "object",
1810
+ "null"
1811
+ ],
1812
+ "properties": {
1813
+ "dueDays": {
1814
+ "type": [
1815
+ "integer",
1816
+ "null"
1817
+ ],
1818
+ "minimum": 0
1819
+ },
1820
+ "account": {
1821
+ "type": [
1822
+ "object",
1823
+ "null"
1824
+ ],
1825
+ "properties": {
1826
+ "provider": {
1827
+ "type": [
1828
+ "string",
1829
+ "null"
1830
+ ],
1831
+ "minLength": 1
1832
+ },
1833
+ "currency": {
1834
+ "type": [
1835
+ "string",
1836
+ "null"
1837
+ ],
1838
+ "minLength": 1
1839
+ },
1840
+ "iban": {
1841
+ "type": "string",
1842
+ "minLength": 1
1843
+ },
1844
+ "beneficiary": {
1845
+ "type": "string",
1846
+ "minLength": 1
1847
+ },
1848
+ "bank": {
1849
+ "type": "string",
1850
+ "minLength": 1
1851
+ }
1852
+ },
1853
+ "required": [
1854
+ "provider",
1855
+ "currency",
1856
+ "iban",
1857
+ "beneficiary",
1858
+ "bank"
1859
+ ]
1860
+ },
1861
+ "accountHolder": {
1862
+ "type": [
1863
+ "string",
1864
+ "null"
1865
+ ],
1866
+ "minLength": 1
1867
+ },
1868
+ "bankName": {
1869
+ "type": [
1870
+ "string",
1871
+ "null"
1872
+ ],
1873
+ "minLength": 1
1874
+ },
1875
+ "iban": {
1876
+ "type": [
1877
+ "string",
1878
+ "null"
1879
+ ],
1880
+ "minLength": 1
1881
+ },
1882
+ "bic": {
1883
+ "type": [
1884
+ "string",
1885
+ "null"
1886
+ ],
1887
+ "minLength": 1
1888
+ },
1889
+ "paymentReference": {
1890
+ "type": [
1891
+ "string",
1892
+ "null"
1893
+ ],
1894
+ "minLength": 1
1895
+ },
1896
+ "instructions": {
1897
+ "type": [
1898
+ "string",
1899
+ "null"
1900
+ ],
1901
+ "minLength": 1
1902
+ }
1903
+ },
1904
+ "required": [
1905
+ "dueDays",
1906
+ "account",
1907
+ "accountHolder",
1908
+ "bankName",
1909
+ "iban",
1910
+ "bic",
1911
+ "paymentReference",
1912
+ "instructions"
1913
+ ]
1914
+ }
1915
+ },
1916
+ "required": [
1917
+ "defaultMethod",
1918
+ "methods",
1919
+ "structure",
1920
+ "schedule",
1921
+ "defaultSchedule",
1922
+ "bankTransfer"
1923
+ ]
1924
+ }
1925
+ },
1926
+ "required": [
1927
+ "branding",
1928
+ "support",
1929
+ "legal",
1930
+ "localization",
1931
+ "forms",
1932
+ "payment"
1933
+ ]
1934
+ }
1935
+ },
1936
+ "required": [
1937
+ "data"
1938
+ ]
1939
+ }
1940
+ }
1941
+ }
1942
+ },
1943
+ "409": {
1944
+ "description": "Storefront settings updates are not configured for this deployment",
1945
+ "content": {
1946
+ "application/json": {
1947
+ "schema": {
1948
+ "type": "object",
1949
+ "properties": {
1950
+ "error": {
1951
+ "type": "string"
1952
+ }
1953
+ },
1954
+ "required": [
1955
+ "error"
1956
+ ]
1957
+ }
1958
+ }
1959
+ }
1960
+ }
1961
+ },
1962
+ "operationId": "patchAdminStorefrontSettings",
1963
+ "summary": "PATCH /v1/admin/storefront/settings",
1964
+ "tags": [
1965
+ "storefront"
1966
+ ],
1967
+ "x-voyant-module": "storefront",
1968
+ "x-voyant-surface": "admin"
1969
+ }
1970
+ }
1971
+ },
1972
+ "webhooks": {}
1973
+ }