@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,1451 @@
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/settings/operator-profile": {
158
+ "get": {
159
+ "responses": {
160
+ "200": {
161
+ "description": "The operator profile",
162
+ "content": {
163
+ "application/json": {
164
+ "schema": {
165
+ "type": "object",
166
+ "properties": {
167
+ "data": {
168
+ "type": [
169
+ "object",
170
+ "null"
171
+ ],
172
+ "properties": {
173
+ "id": {
174
+ "type": "string"
175
+ },
176
+ "name": {
177
+ "type": [
178
+ "string",
179
+ "null"
180
+ ]
181
+ },
182
+ "legalName": {
183
+ "type": [
184
+ "string",
185
+ "null"
186
+ ]
187
+ },
188
+ "vatId": {
189
+ "type": [
190
+ "string",
191
+ "null"
192
+ ]
193
+ },
194
+ "registrationNumber": {
195
+ "type": [
196
+ "string",
197
+ "null"
198
+ ]
199
+ },
200
+ "address": {
201
+ "type": [
202
+ "string",
203
+ "null"
204
+ ]
205
+ },
206
+ "phone": {
207
+ "type": [
208
+ "string",
209
+ "null"
210
+ ]
211
+ },
212
+ "email": {
213
+ "type": [
214
+ "string",
215
+ "null"
216
+ ]
217
+ },
218
+ "website": {
219
+ "type": [
220
+ "string",
221
+ "null"
222
+ ]
223
+ },
224
+ "license": {
225
+ "type": [
226
+ "string",
227
+ "null"
228
+ ]
229
+ },
230
+ "licenseAuthority": {
231
+ "type": [
232
+ "string",
233
+ "null"
234
+ ]
235
+ },
236
+ "signatoryName": {
237
+ "type": [
238
+ "string",
239
+ "null"
240
+ ]
241
+ },
242
+ "signatoryRole": {
243
+ "type": [
244
+ "string",
245
+ "null"
246
+ ]
247
+ },
248
+ "createdAt": {
249
+ "type": "string"
250
+ },
251
+ "updatedAt": {
252
+ "type": "string"
253
+ }
254
+ },
255
+ "required": [
256
+ "id",
257
+ "name",
258
+ "legalName",
259
+ "vatId",
260
+ "registrationNumber",
261
+ "address",
262
+ "phone",
263
+ "email",
264
+ "website",
265
+ "license",
266
+ "licenseAuthority",
267
+ "signatoryName",
268
+ "signatoryRole",
269
+ "createdAt",
270
+ "updatedAt"
271
+ ]
272
+ }
273
+ },
274
+ "required": [
275
+ "data"
276
+ ]
277
+ }
278
+ }
279
+ }
280
+ }
281
+ },
282
+ "operationId": "getAdminSettingsOperatorProfile",
283
+ "summary": "GET /v1/admin/settings/operator-profile",
284
+ "tags": [
285
+ "operator-settings"
286
+ ],
287
+ "x-voyant-module": "operator-settings",
288
+ "x-voyant-surface": "admin"
289
+ },
290
+ "patch": {
291
+ "requestBody": {
292
+ "required": true,
293
+ "content": {
294
+ "application/json": {
295
+ "schema": {
296
+ "type": "object",
297
+ "properties": {
298
+ "name": {
299
+ "type": [
300
+ "string",
301
+ "null"
302
+ ]
303
+ },
304
+ "legalName": {
305
+ "type": [
306
+ "string",
307
+ "null"
308
+ ]
309
+ },
310
+ "vatId": {
311
+ "type": [
312
+ "string",
313
+ "null"
314
+ ]
315
+ },
316
+ "registrationNumber": {
317
+ "type": [
318
+ "string",
319
+ "null"
320
+ ]
321
+ },
322
+ "address": {
323
+ "type": [
324
+ "string",
325
+ "null"
326
+ ]
327
+ },
328
+ "phone": {
329
+ "type": [
330
+ "string",
331
+ "null"
332
+ ]
333
+ },
334
+ "email": {
335
+ "anyOf": [
336
+ {
337
+ "type": [
338
+ "string",
339
+ "null"
340
+ ],
341
+ "format": "email"
342
+ },
343
+ {
344
+ "type": "string",
345
+ "enum": [
346
+ ""
347
+ ]
348
+ },
349
+ {
350
+ "type": "null"
351
+ }
352
+ ]
353
+ },
354
+ "website": {
355
+ "anyOf": [
356
+ {
357
+ "type": [
358
+ "string",
359
+ "null"
360
+ ],
361
+ "format": "uri"
362
+ },
363
+ {
364
+ "type": "string",
365
+ "enum": [
366
+ ""
367
+ ]
368
+ },
369
+ {
370
+ "type": "null"
371
+ }
372
+ ]
373
+ },
374
+ "license": {
375
+ "type": [
376
+ "string",
377
+ "null"
378
+ ]
379
+ },
380
+ "licenseAuthority": {
381
+ "type": [
382
+ "string",
383
+ "null"
384
+ ]
385
+ },
386
+ "signatoryName": {
387
+ "type": [
388
+ "string",
389
+ "null"
390
+ ]
391
+ },
392
+ "signatoryRole": {
393
+ "type": [
394
+ "string",
395
+ "null"
396
+ ]
397
+ }
398
+ }
399
+ }
400
+ }
401
+ }
402
+ },
403
+ "responses": {
404
+ "200": {
405
+ "description": "The updated operator profile",
406
+ "content": {
407
+ "application/json": {
408
+ "schema": {
409
+ "type": "object",
410
+ "properties": {
411
+ "data": {
412
+ "type": [
413
+ "object",
414
+ "null"
415
+ ],
416
+ "properties": {
417
+ "id": {
418
+ "type": "string"
419
+ },
420
+ "name": {
421
+ "type": [
422
+ "string",
423
+ "null"
424
+ ]
425
+ },
426
+ "legalName": {
427
+ "type": [
428
+ "string",
429
+ "null"
430
+ ]
431
+ },
432
+ "vatId": {
433
+ "type": [
434
+ "string",
435
+ "null"
436
+ ]
437
+ },
438
+ "registrationNumber": {
439
+ "type": [
440
+ "string",
441
+ "null"
442
+ ]
443
+ },
444
+ "address": {
445
+ "type": [
446
+ "string",
447
+ "null"
448
+ ]
449
+ },
450
+ "phone": {
451
+ "type": [
452
+ "string",
453
+ "null"
454
+ ]
455
+ },
456
+ "email": {
457
+ "type": [
458
+ "string",
459
+ "null"
460
+ ]
461
+ },
462
+ "website": {
463
+ "type": [
464
+ "string",
465
+ "null"
466
+ ]
467
+ },
468
+ "license": {
469
+ "type": [
470
+ "string",
471
+ "null"
472
+ ]
473
+ },
474
+ "licenseAuthority": {
475
+ "type": [
476
+ "string",
477
+ "null"
478
+ ]
479
+ },
480
+ "signatoryName": {
481
+ "type": [
482
+ "string",
483
+ "null"
484
+ ]
485
+ },
486
+ "signatoryRole": {
487
+ "type": [
488
+ "string",
489
+ "null"
490
+ ]
491
+ },
492
+ "createdAt": {
493
+ "type": "string"
494
+ },
495
+ "updatedAt": {
496
+ "type": "string"
497
+ }
498
+ },
499
+ "required": [
500
+ "id",
501
+ "name",
502
+ "legalName",
503
+ "vatId",
504
+ "registrationNumber",
505
+ "address",
506
+ "phone",
507
+ "email",
508
+ "website",
509
+ "license",
510
+ "licenseAuthority",
511
+ "signatoryName",
512
+ "signatoryRole",
513
+ "createdAt",
514
+ "updatedAt"
515
+ ]
516
+ }
517
+ },
518
+ "required": [
519
+ "data"
520
+ ]
521
+ }
522
+ }
523
+ }
524
+ }
525
+ },
526
+ "operationId": "patchAdminSettingsOperatorProfile",
527
+ "summary": "PATCH /v1/admin/settings/operator-profile",
528
+ "tags": [
529
+ "operator-settings"
530
+ ],
531
+ "x-voyant-module": "operator-settings",
532
+ "x-voyant-surface": "admin"
533
+ }
534
+ },
535
+ "/v1/admin/settings/operator-payment-instructions": {
536
+ "get": {
537
+ "responses": {
538
+ "200": {
539
+ "description": "The operator payment instructions",
540
+ "content": {
541
+ "application/json": {
542
+ "schema": {
543
+ "type": "object",
544
+ "properties": {
545
+ "data": {
546
+ "type": [
547
+ "object",
548
+ "null"
549
+ ],
550
+ "properties": {
551
+ "id": {
552
+ "type": "string"
553
+ },
554
+ "bankTransferBeneficiary": {
555
+ "type": [
556
+ "string",
557
+ "null"
558
+ ]
559
+ },
560
+ "iban": {
561
+ "type": [
562
+ "string",
563
+ "null"
564
+ ]
565
+ },
566
+ "bank": {
567
+ "type": [
568
+ "string",
569
+ "null"
570
+ ]
571
+ },
572
+ "notes": {
573
+ "type": [
574
+ "string",
575
+ "null"
576
+ ]
577
+ },
578
+ "createdAt": {
579
+ "type": "string"
580
+ },
581
+ "updatedAt": {
582
+ "type": "string"
583
+ }
584
+ },
585
+ "required": [
586
+ "id",
587
+ "bankTransferBeneficiary",
588
+ "iban",
589
+ "bank",
590
+ "notes",
591
+ "createdAt",
592
+ "updatedAt"
593
+ ]
594
+ }
595
+ },
596
+ "required": [
597
+ "data"
598
+ ]
599
+ }
600
+ }
601
+ }
602
+ }
603
+ },
604
+ "operationId": "getAdminSettingsOperatorPaymentInstructions",
605
+ "summary": "GET /v1/admin/settings/operator-payment-instructions",
606
+ "tags": [
607
+ "operator-settings"
608
+ ],
609
+ "x-voyant-module": "operator-settings",
610
+ "x-voyant-surface": "admin"
611
+ },
612
+ "patch": {
613
+ "requestBody": {
614
+ "required": true,
615
+ "content": {
616
+ "application/json": {
617
+ "schema": {
618
+ "type": "object",
619
+ "properties": {
620
+ "bankTransferBeneficiary": {
621
+ "type": [
622
+ "string",
623
+ "null"
624
+ ]
625
+ },
626
+ "iban": {
627
+ "type": [
628
+ "string",
629
+ "null"
630
+ ]
631
+ },
632
+ "bank": {
633
+ "type": [
634
+ "string",
635
+ "null"
636
+ ]
637
+ },
638
+ "notes": {
639
+ "type": [
640
+ "string",
641
+ "null"
642
+ ]
643
+ }
644
+ }
645
+ }
646
+ }
647
+ }
648
+ },
649
+ "responses": {
650
+ "200": {
651
+ "description": "The updated operator payment instructions",
652
+ "content": {
653
+ "application/json": {
654
+ "schema": {
655
+ "type": "object",
656
+ "properties": {
657
+ "data": {
658
+ "type": [
659
+ "object",
660
+ "null"
661
+ ],
662
+ "properties": {
663
+ "id": {
664
+ "type": "string"
665
+ },
666
+ "bankTransferBeneficiary": {
667
+ "type": [
668
+ "string",
669
+ "null"
670
+ ]
671
+ },
672
+ "iban": {
673
+ "type": [
674
+ "string",
675
+ "null"
676
+ ]
677
+ },
678
+ "bank": {
679
+ "type": [
680
+ "string",
681
+ "null"
682
+ ]
683
+ },
684
+ "notes": {
685
+ "type": [
686
+ "string",
687
+ "null"
688
+ ]
689
+ },
690
+ "createdAt": {
691
+ "type": "string"
692
+ },
693
+ "updatedAt": {
694
+ "type": "string"
695
+ }
696
+ },
697
+ "required": [
698
+ "id",
699
+ "bankTransferBeneficiary",
700
+ "iban",
701
+ "bank",
702
+ "notes",
703
+ "createdAt",
704
+ "updatedAt"
705
+ ]
706
+ }
707
+ },
708
+ "required": [
709
+ "data"
710
+ ]
711
+ }
712
+ }
713
+ }
714
+ }
715
+ },
716
+ "operationId": "patchAdminSettingsOperatorPaymentInstructions",
717
+ "summary": "PATCH /v1/admin/settings/operator-payment-instructions",
718
+ "tags": [
719
+ "operator-settings"
720
+ ],
721
+ "x-voyant-module": "operator-settings",
722
+ "x-voyant-surface": "admin"
723
+ }
724
+ },
725
+ "/v1/admin/settings/operator-payment-defaults": {
726
+ "get": {
727
+ "responses": {
728
+ "200": {
729
+ "description": "The operator payment defaults",
730
+ "content": {
731
+ "application/json": {
732
+ "schema": {
733
+ "type": "object",
734
+ "properties": {
735
+ "data": {
736
+ "type": [
737
+ "object",
738
+ "null"
739
+ ],
740
+ "properties": {
741
+ "id": {
742
+ "type": "string"
743
+ },
744
+ "customerPaymentPolicy": {},
745
+ "bookingCheckoutUrlTemplate": {
746
+ "type": [
747
+ "string",
748
+ "null"
749
+ ]
750
+ },
751
+ "invoicePayUrlTemplate": {
752
+ "type": [
753
+ "string",
754
+ "null"
755
+ ]
756
+ },
757
+ "createdAt": {
758
+ "type": "string"
759
+ },
760
+ "updatedAt": {
761
+ "type": "string"
762
+ }
763
+ },
764
+ "required": [
765
+ "id",
766
+ "bookingCheckoutUrlTemplate",
767
+ "invoicePayUrlTemplate",
768
+ "createdAt",
769
+ "updatedAt"
770
+ ]
771
+ }
772
+ },
773
+ "required": [
774
+ "data"
775
+ ]
776
+ }
777
+ }
778
+ }
779
+ }
780
+ },
781
+ "operationId": "getAdminSettingsOperatorPaymentDefaults",
782
+ "summary": "GET /v1/admin/settings/operator-payment-defaults",
783
+ "tags": [
784
+ "operator-settings"
785
+ ],
786
+ "x-voyant-module": "operator-settings",
787
+ "x-voyant-surface": "admin"
788
+ },
789
+ "patch": {
790
+ "requestBody": {
791
+ "required": true,
792
+ "content": {
793
+ "application/json": {
794
+ "schema": {
795
+ "type": "object",
796
+ "properties": {
797
+ "customerPaymentPolicy": {
798
+ "type": [
799
+ "object",
800
+ "null"
801
+ ],
802
+ "properties": {
803
+ "deposit": {
804
+ "type": "object",
805
+ "properties": {
806
+ "kind": {
807
+ "type": "string",
808
+ "enum": [
809
+ "none",
810
+ "percent",
811
+ "fixed_cents"
812
+ ]
813
+ },
814
+ "percent": {
815
+ "type": "number",
816
+ "minimum": 0,
817
+ "maximum": 100
818
+ },
819
+ "amountCents": {
820
+ "type": "integer",
821
+ "minimum": 0
822
+ }
823
+ },
824
+ "required": [
825
+ "kind"
826
+ ]
827
+ },
828
+ "minDaysBeforeDepartureForDeposit": {
829
+ "type": "integer",
830
+ "minimum": 0
831
+ },
832
+ "balanceDueDaysBeforeDeparture": {
833
+ "type": "integer",
834
+ "minimum": 0
835
+ },
836
+ "balanceDueMinDaysFromNow": {
837
+ "type": "integer",
838
+ "minimum": 0
839
+ }
840
+ },
841
+ "required": [
842
+ "deposit",
843
+ "minDaysBeforeDepartureForDeposit",
844
+ "balanceDueDaysBeforeDeparture",
845
+ "balanceDueMinDaysFromNow"
846
+ ]
847
+ },
848
+ "bookingCheckoutUrlTemplate": {
849
+ "type": [
850
+ "string",
851
+ "null"
852
+ ]
853
+ },
854
+ "invoicePayUrlTemplate": {
855
+ "type": [
856
+ "string",
857
+ "null"
858
+ ]
859
+ }
860
+ }
861
+ }
862
+ }
863
+ }
864
+ },
865
+ "responses": {
866
+ "200": {
867
+ "description": "The updated operator payment defaults",
868
+ "content": {
869
+ "application/json": {
870
+ "schema": {
871
+ "type": "object",
872
+ "properties": {
873
+ "data": {
874
+ "type": [
875
+ "object",
876
+ "null"
877
+ ],
878
+ "properties": {
879
+ "id": {
880
+ "type": "string"
881
+ },
882
+ "customerPaymentPolicy": {},
883
+ "bookingCheckoutUrlTemplate": {
884
+ "type": [
885
+ "string",
886
+ "null"
887
+ ]
888
+ },
889
+ "invoicePayUrlTemplate": {
890
+ "type": [
891
+ "string",
892
+ "null"
893
+ ]
894
+ },
895
+ "createdAt": {
896
+ "type": "string"
897
+ },
898
+ "updatedAt": {
899
+ "type": "string"
900
+ }
901
+ },
902
+ "required": [
903
+ "id",
904
+ "bookingCheckoutUrlTemplate",
905
+ "invoicePayUrlTemplate",
906
+ "createdAt",
907
+ "updatedAt"
908
+ ]
909
+ }
910
+ },
911
+ "required": [
912
+ "data"
913
+ ]
914
+ }
915
+ }
916
+ }
917
+ }
918
+ },
919
+ "operationId": "patchAdminSettingsOperatorPaymentDefaults",
920
+ "summary": "PATCH /v1/admin/settings/operator-payment-defaults",
921
+ "tags": [
922
+ "operator-settings"
923
+ ],
924
+ "x-voyant-module": "operator-settings",
925
+ "x-voyant-surface": "admin"
926
+ }
927
+ },
928
+ "/v1/admin/settings/operator": {
929
+ "get": {
930
+ "responses": {
931
+ "200": {
932
+ "description": "The combined operator settings",
933
+ "content": {
934
+ "application/json": {
935
+ "schema": {
936
+ "type": "object",
937
+ "properties": {
938
+ "data": {
939
+ "type": [
940
+ "object",
941
+ "null"
942
+ ],
943
+ "properties": {
944
+ "id": {
945
+ "type": "string"
946
+ },
947
+ "name": {
948
+ "type": [
949
+ "string",
950
+ "null"
951
+ ]
952
+ },
953
+ "legalName": {
954
+ "type": [
955
+ "string",
956
+ "null"
957
+ ]
958
+ },
959
+ "vatId": {
960
+ "type": [
961
+ "string",
962
+ "null"
963
+ ]
964
+ },
965
+ "registrationNumber": {
966
+ "type": [
967
+ "string",
968
+ "null"
969
+ ]
970
+ },
971
+ "address": {
972
+ "type": [
973
+ "string",
974
+ "null"
975
+ ]
976
+ },
977
+ "phone": {
978
+ "type": [
979
+ "string",
980
+ "null"
981
+ ]
982
+ },
983
+ "email": {
984
+ "type": [
985
+ "string",
986
+ "null"
987
+ ]
988
+ },
989
+ "website": {
990
+ "type": [
991
+ "string",
992
+ "null"
993
+ ]
994
+ },
995
+ "license": {
996
+ "type": [
997
+ "string",
998
+ "null"
999
+ ]
1000
+ },
1001
+ "licenseAuthority": {
1002
+ "type": [
1003
+ "string",
1004
+ "null"
1005
+ ]
1006
+ },
1007
+ "signatoryName": {
1008
+ "type": [
1009
+ "string",
1010
+ "null"
1011
+ ]
1012
+ },
1013
+ "signatoryRole": {
1014
+ "type": [
1015
+ "string",
1016
+ "null"
1017
+ ]
1018
+ },
1019
+ "createdAt": {
1020
+ "type": "string"
1021
+ },
1022
+ "updatedAt": {
1023
+ "type": "string"
1024
+ },
1025
+ "bankTransferBeneficiary": {
1026
+ "type": [
1027
+ "string",
1028
+ "null"
1029
+ ]
1030
+ },
1031
+ "iban": {
1032
+ "type": [
1033
+ "string",
1034
+ "null"
1035
+ ]
1036
+ },
1037
+ "bank": {
1038
+ "type": [
1039
+ "string",
1040
+ "null"
1041
+ ]
1042
+ },
1043
+ "notes": {
1044
+ "type": [
1045
+ "string",
1046
+ "null"
1047
+ ]
1048
+ },
1049
+ "customerPaymentPolicy": {},
1050
+ "bookingCheckoutUrlTemplate": {
1051
+ "type": [
1052
+ "string",
1053
+ "null"
1054
+ ]
1055
+ },
1056
+ "invoicePayUrlTemplate": {
1057
+ "type": [
1058
+ "string",
1059
+ "null"
1060
+ ]
1061
+ }
1062
+ },
1063
+ "required": [
1064
+ "bankTransferBeneficiary",
1065
+ "iban",
1066
+ "bank",
1067
+ "notes",
1068
+ "bookingCheckoutUrlTemplate",
1069
+ "invoicePayUrlTemplate"
1070
+ ]
1071
+ }
1072
+ },
1073
+ "required": [
1074
+ "data"
1075
+ ]
1076
+ }
1077
+ }
1078
+ }
1079
+ }
1080
+ },
1081
+ "operationId": "getAdminSettingsOperator",
1082
+ "summary": "GET /v1/admin/settings/operator",
1083
+ "tags": [
1084
+ "operator-settings"
1085
+ ],
1086
+ "x-voyant-module": "operator-settings",
1087
+ "x-voyant-surface": "admin"
1088
+ },
1089
+ "patch": {
1090
+ "requestBody": {
1091
+ "required": true,
1092
+ "content": {
1093
+ "application/json": {
1094
+ "schema": {
1095
+ "type": "object",
1096
+ "properties": {
1097
+ "name": {
1098
+ "type": [
1099
+ "string",
1100
+ "null"
1101
+ ]
1102
+ },
1103
+ "legalName": {
1104
+ "type": [
1105
+ "string",
1106
+ "null"
1107
+ ]
1108
+ },
1109
+ "vatId": {
1110
+ "type": [
1111
+ "string",
1112
+ "null"
1113
+ ]
1114
+ },
1115
+ "registrationNumber": {
1116
+ "type": [
1117
+ "string",
1118
+ "null"
1119
+ ]
1120
+ },
1121
+ "address": {
1122
+ "type": [
1123
+ "string",
1124
+ "null"
1125
+ ]
1126
+ },
1127
+ "phone": {
1128
+ "type": [
1129
+ "string",
1130
+ "null"
1131
+ ]
1132
+ },
1133
+ "email": {
1134
+ "anyOf": [
1135
+ {
1136
+ "type": [
1137
+ "string",
1138
+ "null"
1139
+ ],
1140
+ "format": "email"
1141
+ },
1142
+ {
1143
+ "type": "string",
1144
+ "enum": [
1145
+ ""
1146
+ ]
1147
+ },
1148
+ {
1149
+ "type": "null"
1150
+ }
1151
+ ]
1152
+ },
1153
+ "website": {
1154
+ "anyOf": [
1155
+ {
1156
+ "type": [
1157
+ "string",
1158
+ "null"
1159
+ ],
1160
+ "format": "uri"
1161
+ },
1162
+ {
1163
+ "type": "string",
1164
+ "enum": [
1165
+ ""
1166
+ ]
1167
+ },
1168
+ {
1169
+ "type": "null"
1170
+ }
1171
+ ]
1172
+ },
1173
+ "license": {
1174
+ "type": [
1175
+ "string",
1176
+ "null"
1177
+ ]
1178
+ },
1179
+ "licenseAuthority": {
1180
+ "type": [
1181
+ "string",
1182
+ "null"
1183
+ ]
1184
+ },
1185
+ "signatoryName": {
1186
+ "type": [
1187
+ "string",
1188
+ "null"
1189
+ ]
1190
+ },
1191
+ "signatoryRole": {
1192
+ "type": [
1193
+ "string",
1194
+ "null"
1195
+ ]
1196
+ },
1197
+ "bankTransferBeneficiary": {
1198
+ "type": [
1199
+ "string",
1200
+ "null"
1201
+ ]
1202
+ },
1203
+ "iban": {
1204
+ "type": [
1205
+ "string",
1206
+ "null"
1207
+ ]
1208
+ },
1209
+ "bank": {
1210
+ "type": [
1211
+ "string",
1212
+ "null"
1213
+ ]
1214
+ },
1215
+ "notes": {
1216
+ "type": [
1217
+ "string",
1218
+ "null"
1219
+ ]
1220
+ },
1221
+ "customerPaymentPolicy": {
1222
+ "type": [
1223
+ "object",
1224
+ "null"
1225
+ ],
1226
+ "properties": {
1227
+ "deposit": {
1228
+ "type": "object",
1229
+ "properties": {
1230
+ "kind": {
1231
+ "type": "string",
1232
+ "enum": [
1233
+ "none",
1234
+ "percent",
1235
+ "fixed_cents"
1236
+ ]
1237
+ },
1238
+ "percent": {
1239
+ "type": "number",
1240
+ "minimum": 0,
1241
+ "maximum": 100
1242
+ },
1243
+ "amountCents": {
1244
+ "type": "integer",
1245
+ "minimum": 0
1246
+ }
1247
+ },
1248
+ "required": [
1249
+ "kind"
1250
+ ]
1251
+ },
1252
+ "minDaysBeforeDepartureForDeposit": {
1253
+ "type": "integer",
1254
+ "minimum": 0
1255
+ },
1256
+ "balanceDueDaysBeforeDeparture": {
1257
+ "type": "integer",
1258
+ "minimum": 0
1259
+ },
1260
+ "balanceDueMinDaysFromNow": {
1261
+ "type": "integer",
1262
+ "minimum": 0
1263
+ }
1264
+ },
1265
+ "required": [
1266
+ "deposit",
1267
+ "minDaysBeforeDepartureForDeposit",
1268
+ "balanceDueDaysBeforeDeparture",
1269
+ "balanceDueMinDaysFromNow"
1270
+ ]
1271
+ },
1272
+ "bookingCheckoutUrlTemplate": {
1273
+ "type": [
1274
+ "string",
1275
+ "null"
1276
+ ]
1277
+ },
1278
+ "invoicePayUrlTemplate": {
1279
+ "type": [
1280
+ "string",
1281
+ "null"
1282
+ ]
1283
+ }
1284
+ }
1285
+ }
1286
+ }
1287
+ }
1288
+ },
1289
+ "responses": {
1290
+ "200": {
1291
+ "description": "The updated combined operator settings",
1292
+ "content": {
1293
+ "application/json": {
1294
+ "schema": {
1295
+ "type": "object",
1296
+ "properties": {
1297
+ "data": {
1298
+ "type": [
1299
+ "object",
1300
+ "null"
1301
+ ],
1302
+ "properties": {
1303
+ "id": {
1304
+ "type": "string"
1305
+ },
1306
+ "name": {
1307
+ "type": [
1308
+ "string",
1309
+ "null"
1310
+ ]
1311
+ },
1312
+ "legalName": {
1313
+ "type": [
1314
+ "string",
1315
+ "null"
1316
+ ]
1317
+ },
1318
+ "vatId": {
1319
+ "type": [
1320
+ "string",
1321
+ "null"
1322
+ ]
1323
+ },
1324
+ "registrationNumber": {
1325
+ "type": [
1326
+ "string",
1327
+ "null"
1328
+ ]
1329
+ },
1330
+ "address": {
1331
+ "type": [
1332
+ "string",
1333
+ "null"
1334
+ ]
1335
+ },
1336
+ "phone": {
1337
+ "type": [
1338
+ "string",
1339
+ "null"
1340
+ ]
1341
+ },
1342
+ "email": {
1343
+ "type": [
1344
+ "string",
1345
+ "null"
1346
+ ]
1347
+ },
1348
+ "website": {
1349
+ "type": [
1350
+ "string",
1351
+ "null"
1352
+ ]
1353
+ },
1354
+ "license": {
1355
+ "type": [
1356
+ "string",
1357
+ "null"
1358
+ ]
1359
+ },
1360
+ "licenseAuthority": {
1361
+ "type": [
1362
+ "string",
1363
+ "null"
1364
+ ]
1365
+ },
1366
+ "signatoryName": {
1367
+ "type": [
1368
+ "string",
1369
+ "null"
1370
+ ]
1371
+ },
1372
+ "signatoryRole": {
1373
+ "type": [
1374
+ "string",
1375
+ "null"
1376
+ ]
1377
+ },
1378
+ "createdAt": {
1379
+ "type": "string"
1380
+ },
1381
+ "updatedAt": {
1382
+ "type": "string"
1383
+ },
1384
+ "bankTransferBeneficiary": {
1385
+ "type": [
1386
+ "string",
1387
+ "null"
1388
+ ]
1389
+ },
1390
+ "iban": {
1391
+ "type": [
1392
+ "string",
1393
+ "null"
1394
+ ]
1395
+ },
1396
+ "bank": {
1397
+ "type": [
1398
+ "string",
1399
+ "null"
1400
+ ]
1401
+ },
1402
+ "notes": {
1403
+ "type": [
1404
+ "string",
1405
+ "null"
1406
+ ]
1407
+ },
1408
+ "customerPaymentPolicy": {},
1409
+ "bookingCheckoutUrlTemplate": {
1410
+ "type": [
1411
+ "string",
1412
+ "null"
1413
+ ]
1414
+ },
1415
+ "invoicePayUrlTemplate": {
1416
+ "type": [
1417
+ "string",
1418
+ "null"
1419
+ ]
1420
+ }
1421
+ },
1422
+ "required": [
1423
+ "bankTransferBeneficiary",
1424
+ "iban",
1425
+ "bank",
1426
+ "notes",
1427
+ "bookingCheckoutUrlTemplate",
1428
+ "invoicePayUrlTemplate"
1429
+ ]
1430
+ }
1431
+ },
1432
+ "required": [
1433
+ "data"
1434
+ ]
1435
+ }
1436
+ }
1437
+ }
1438
+ }
1439
+ },
1440
+ "operationId": "patchAdminSettingsOperator",
1441
+ "summary": "PATCH /v1/admin/settings/operator",
1442
+ "tags": [
1443
+ "operator-settings"
1444
+ ],
1445
+ "x-voyant-module": "operator-settings",
1446
+ "x-voyant-surface": "admin"
1447
+ }
1448
+ }
1449
+ },
1450
+ "webhooks": {}
1451
+ }