@voyant-travel/openapi 0.3.0 → 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 +3 -3
  2. package/spec/admin/accommodations.json +54 -6
  3. package/spec/admin/action-ledger.json +94 -11
  4. package/spec/admin/booking-requirements.json +326 -40
  5. package/spec/admin/bookings.json +550 -68
  6. package/spec/admin/catalog.json +14 -1
  7. package/spec/admin/distribution.json +974 -121
  8. package/spec/admin/external-refs.json +62 -7
  9. package/spec/admin/extras.json +158 -19
  10. package/spec/admin/finance.json +1230 -153
  11. package/spec/admin/identity.json +90 -21
  12. package/spec/admin/legal.json +550 -68
  13. package/spec/admin/markets.json +302 -37
  14. package/spec/admin/notifications.json +294 -36
  15. package/spec/admin/operations.json +2112 -291
  16. package/spec/admin/operator-settings.json +70 -8
  17. package/spec/admin/pricing.json +566 -70
  18. package/spec/admin/products.json +1286 -160
  19. package/spec/admin/promotions.json +54 -6
  20. package/spec/admin/quotes.json +342 -42
  21. package/spec/admin/relationships.json +686 -85
  22. package/spec/admin/sellability.json +246 -30
  23. package/spec/admin/storefront.json +22 -2
  24. package/spec/admin/suppliers.json +278 -34
  25. package/spec/admin/trips.json +198 -24
  26. package/spec/framework-admin.json +10472 -1392
  27. package/spec/framework-openapi.json +11510 -1695
  28. package/spec/framework-storefront.json +846 -105
  29. package/spec/storefront/booking-requirements.json +14 -1
  30. package/spec/storefront/bookings.json +86 -10
  31. package/spec/storefront/catalog.json +14 -1
  32. package/spec/storefront/customer-portal.json +158 -19
  33. package/spec/storefront/finance.json +102 -12
  34. package/spec/storefront/legal.json +94 -11
  35. package/spec/storefront/markets.json +14 -1
  36. package/spec/storefront/operator-settings.json +22 -2
  37. package/spec/storefront/pricing.json +14 -1
  38. package/spec/storefront/products.json +62 -7
  39. package/spec/storefront/storefront-verification.json +38 -4
  40. package/spec/storefront/storefront.json +102 -12
  41. package/spec/storefront/trips.json +198 -24
@@ -5,6 +5,12 @@
5
5
  "version": "0.0.0",
6
6
  "description": "Generated from the Voyant framework's standard module composition. Do not edit by hand."
7
7
  },
8
+ "servers": [
9
+ {
10
+ "url": "/",
11
+ "description": "This deployment (same origin)"
12
+ }
13
+ ],
8
14
  "components": {
9
15
  "schemas": {
10
16
  "CatalogSearchFilter": {
@@ -305,7 +311,14 @@
305
311
  }
306
312
  }
307
313
  }
308
- }
314
+ },
315
+ "operationId": "getPublicProductsByProductIdOffers",
316
+ "summary": "GET /v1/public/products/{productId}/offers",
317
+ "tags": [
318
+ "storefront"
319
+ ],
320
+ "x-voyant-module": "storefront",
321
+ "x-voyant-surface": "storefront"
309
322
  }
310
323
  },
311
324
  "/v1/public/offers/{slug}": {
@@ -480,7 +493,14 @@
480
493
  }
481
494
  }
482
495
  }
483
- }
496
+ },
497
+ "operationId": "getPublicOffersBySlug",
498
+ "summary": "GET /v1/public/offers/{slug}",
499
+ "tags": [
500
+ "storefront"
501
+ ],
502
+ "x-voyant-module": "storefront",
503
+ "x-voyant-surface": "storefront"
484
504
  }
485
505
  },
486
506
  "/v1/public/offers/{slug}/apply": {
@@ -927,7 +947,14 @@
927
947
  }
928
948
  }
929
949
  }
930
- }
950
+ },
951
+ "operationId": "postPublicOffersBySlugApply",
952
+ "summary": "POST /v1/public/offers/{slug}/apply",
953
+ "tags": [
954
+ "storefront"
955
+ ],
956
+ "x-voyant-module": "storefront",
957
+ "x-voyant-surface": "storefront"
931
958
  }
932
959
  },
933
960
  "/v1/public/offers/redeem": {
@@ -1370,7 +1397,14 @@
1370
1397
  }
1371
1398
  }
1372
1399
  }
1373
- }
1400
+ },
1401
+ "operationId": "postPublicOffersRedeem",
1402
+ "summary": "POST /v1/public/offers/redeem",
1403
+ "tags": [
1404
+ "storefront"
1405
+ ],
1406
+ "x-voyant-module": "storefront",
1407
+ "x-voyant-surface": "storefront"
1374
1408
  }
1375
1409
  },
1376
1410
  "/v1/public/leads": {
@@ -1661,7 +1695,14 @@
1661
1695
  }
1662
1696
  }
1663
1697
  }
1664
- }
1698
+ },
1699
+ "operationId": "postPublicLeads",
1700
+ "summary": "POST /v1/public/leads",
1701
+ "tags": [
1702
+ "storefront"
1703
+ ],
1704
+ "x-voyant-module": "storefront",
1705
+ "x-voyant-surface": "storefront"
1665
1706
  }
1666
1707
  },
1667
1708
  "/v1/public/newsletter/subscribe": {
@@ -1917,7 +1958,14 @@
1917
1958
  }
1918
1959
  }
1919
1960
  }
1920
- }
1961
+ },
1962
+ "operationId": "postPublicNewsletterSubscribe",
1963
+ "summary": "POST /v1/public/newsletter/subscribe",
1964
+ "tags": [
1965
+ "storefront"
1966
+ ],
1967
+ "x-voyant-module": "storefront",
1968
+ "x-voyant-surface": "storefront"
1921
1969
  }
1922
1970
  },
1923
1971
  "/v1/public/settings": {
@@ -2540,7 +2588,14 @@
2540
2588
  }
2541
2589
  }
2542
2590
  }
2543
- }
2591
+ },
2592
+ "operationId": "getPublicSettings",
2593
+ "summary": "GET /v1/public/settings",
2594
+ "tags": [
2595
+ "storefront"
2596
+ ],
2597
+ "x-voyant-module": "storefront",
2598
+ "x-voyant-surface": "storefront"
2544
2599
  }
2545
2600
  },
2546
2601
  "/v1/public/departures/{departureId}": {
@@ -2925,7 +2980,14 @@
2925
2980
  }
2926
2981
  }
2927
2982
  }
2928
- }
2983
+ },
2984
+ "operationId": "getPublicDeparturesByDepartureId",
2985
+ "summary": "GET /v1/public/departures/{departureId}",
2986
+ "tags": [
2987
+ "storefront"
2988
+ ],
2989
+ "x-voyant-module": "storefront",
2990
+ "x-voyant-surface": "storefront"
2929
2991
  }
2930
2992
  },
2931
2993
  "/v1/public/products/{productId}/departures": {
@@ -3365,7 +3427,14 @@
3365
3427
  }
3366
3428
  }
3367
3429
  }
3368
- }
3430
+ },
3431
+ "operationId": "getPublicProductsByProductIdDepartures",
3432
+ "summary": "GET /v1/public/products/{productId}/departures",
3433
+ "tags": [
3434
+ "storefront"
3435
+ ],
3436
+ "x-voyant-module": "storefront",
3437
+ "x-voyant-surface": "storefront"
3369
3438
  }
3370
3439
  },
3371
3440
  "/v1/public/products/{productId}/availability": {
@@ -3643,7 +3712,14 @@
3643
3712
  }
3644
3713
  }
3645
3714
  }
3646
- }
3715
+ },
3716
+ "operationId": "getPublicProductsByProductIdAvailability",
3717
+ "summary": "GET /v1/public/products/{productId}/availability",
3718
+ "tags": [
3719
+ "storefront"
3720
+ ],
3721
+ "x-voyant-module": "storefront",
3722
+ "x-voyant-surface": "storefront"
3647
3723
  }
3648
3724
  },
3649
3725
  "/v1/public/products/{productId}/departures/{departureId}/itinerary": {
@@ -3783,7 +3859,14 @@
3783
3859
  }
3784
3860
  }
3785
3861
  }
3786
- }
3862
+ },
3863
+ "operationId": "getPublicProductsByProductIdDeparturesByDepartureIdItinerary",
3864
+ "summary": "GET /v1/public/products/{productId}/departures/{departureId}/itinerary",
3865
+ "tags": [
3866
+ "storefront"
3867
+ ],
3868
+ "x-voyant-module": "storefront",
3869
+ "x-voyant-surface": "storefront"
3787
3870
  }
3788
3871
  },
3789
3872
  "/v1/public/products/{productId}/extensions": {
@@ -4059,7 +4142,14 @@
4059
4142
  }
4060
4143
  }
4061
4144
  }
4062
- }
4145
+ },
4146
+ "operationId": "getPublicProductsByProductIdExtensions",
4147
+ "summary": "GET /v1/public/products/{productId}/extensions",
4148
+ "tags": [
4149
+ "storefront"
4150
+ ],
4151
+ "x-voyant-module": "storefront",
4152
+ "x-voyant-surface": "storefront"
4063
4153
  }
4064
4154
  }
4065
4155
  },
@@ -5,6 +5,12 @@
5
5
  "version": "0.0.0",
6
6
  "description": "Generated from the Voyant framework's standard module composition. Do not edit by hand."
7
7
  },
8
+ "servers": [
9
+ {
10
+ "url": "/",
11
+ "description": "This deployment (same origin)"
12
+ }
13
+ ],
8
14
  "components": {
9
15
  "schemas": {
10
16
  "CatalogSearchFilter": {
@@ -187,7 +193,14 @@
187
193
  }
188
194
  }
189
195
  }
190
- }
196
+ },
197
+ "operationId": "getPublicTripsHealth",
198
+ "summary": "GET /v1/public/trips/health",
199
+ "tags": [
200
+ "trips"
201
+ ],
202
+ "x-voyant-module": "trips",
203
+ "x-voyant-surface": "storefront"
191
204
  }
192
205
  },
193
206
  "/v1/public/trips": {
@@ -794,7 +807,14 @@
794
807
  }
795
808
  }
796
809
  }
797
- }
810
+ },
811
+ "operationId": "getPublicTrips",
812
+ "summary": "GET /v1/public/trips",
813
+ "tags": [
814
+ "trips"
815
+ ],
816
+ "x-voyant-module": "trips",
817
+ "x-voyant-surface": "storefront"
798
818
  },
799
819
  "post": {
800
820
  "requestBody": {
@@ -1308,7 +1328,14 @@
1308
1328
  }
1309
1329
  }
1310
1330
  }
1311
- }
1331
+ },
1332
+ "operationId": "postPublicTrips",
1333
+ "summary": "POST /v1/public/trips",
1334
+ "tags": [
1335
+ "trips"
1336
+ ],
1337
+ "x-voyant-module": "trips",
1338
+ "x-voyant-surface": "storefront"
1312
1339
  }
1313
1340
  },
1314
1341
  "/v1/public/trips/{envelopeId}": {
@@ -1762,7 +1789,14 @@
1762
1789
  }
1763
1790
  }
1764
1791
  }
1765
- }
1792
+ },
1793
+ "operationId": "getPublicTripsByEnvelopeId",
1794
+ "summary": "GET /v1/public/trips/{envelopeId}",
1795
+ "tags": [
1796
+ "trips"
1797
+ ],
1798
+ "x-voyant-module": "trips",
1799
+ "x-voyant-surface": "storefront"
1766
1800
  },
1767
1801
  "patch": {
1768
1802
  "parameters": [
@@ -2084,7 +2118,14 @@
2084
2118
  }
2085
2119
  }
2086
2120
  }
2087
- }
2121
+ },
2122
+ "operationId": "patchPublicTripsByEnvelopeId",
2123
+ "summary": "PATCH /v1/public/trips/{envelopeId}",
2124
+ "tags": [
2125
+ "trips"
2126
+ ],
2127
+ "x-voyant-module": "trips",
2128
+ "x-voyant-surface": "storefront"
2088
2129
  }
2089
2130
  },
2090
2131
  "/v1/public/trips/{envelopeId}/reshop": {
@@ -2450,7 +2491,14 @@
2450
2491
  }
2451
2492
  }
2452
2493
  }
2453
- }
2494
+ },
2495
+ "operationId": "postPublicTripsByEnvelopeIdReshop",
2496
+ "summary": "POST /v1/public/trips/{envelopeId}/reshop",
2497
+ "tags": [
2498
+ "trips"
2499
+ ],
2500
+ "x-voyant-module": "trips",
2501
+ "x-voyant-surface": "storefront"
2454
2502
  }
2455
2503
  },
2456
2504
  "/v1/public/trips/{envelopeId}/snapshots": {
@@ -2588,7 +2636,14 @@
2588
2636
  }
2589
2637
  }
2590
2638
  }
2591
- }
2639
+ },
2640
+ "operationId": "getPublicTripsByEnvelopeIdSnapshots",
2641
+ "summary": "GET /v1/public/trips/{envelopeId}/snapshots",
2642
+ "tags": [
2643
+ "trips"
2644
+ ],
2645
+ "x-voyant-module": "trips",
2646
+ "x-voyant-surface": "storefront"
2592
2647
  },
2593
2648
  "post": {
2594
2649
  "parameters": [
@@ -2797,7 +2852,14 @@
2797
2852
  }
2798
2853
  }
2799
2854
  }
2800
- }
2855
+ },
2856
+ "operationId": "postPublicTripsByEnvelopeIdSnapshots",
2857
+ "summary": "POST /v1/public/trips/{envelopeId}/snapshots",
2858
+ "tags": [
2859
+ "trips"
2860
+ ],
2861
+ "x-voyant-module": "trips",
2862
+ "x-voyant-surface": "storefront"
2801
2863
  }
2802
2864
  },
2803
2865
  "/v1/public/trips/snapshots/{snapshotId}": {
@@ -2951,7 +3013,14 @@
2951
3013
  }
2952
3014
  }
2953
3015
  }
2954
- }
3016
+ },
3017
+ "operationId": "getPublicTripsSnapshotsBySnapshotId",
3018
+ "summary": "GET /v1/public/trips/snapshots/{snapshotId}",
3019
+ "tags": [
3020
+ "trips"
3021
+ ],
3022
+ "x-voyant-module": "trips",
3023
+ "x-voyant-surface": "storefront"
2955
3024
  }
2956
3025
  },
2957
3026
  "/v1/public/trips/{envelopeId}/components": {
@@ -3372,7 +3441,14 @@
3372
3441
  }
3373
3442
  }
3374
3443
  }
3375
- }
3444
+ },
3445
+ "operationId": "postPublicTripsByEnvelopeIdComponents",
3446
+ "summary": "POST /v1/public/trips/{envelopeId}/components",
3447
+ "tags": [
3448
+ "trips"
3449
+ ],
3450
+ "x-voyant-module": "trips",
3451
+ "x-voyant-surface": "storefront"
3376
3452
  }
3377
3453
  },
3378
3454
  "/v1/public/trips/{envelopeId}/components/reorder": {
@@ -3734,7 +3810,14 @@
3734
3810
  }
3735
3811
  }
3736
3812
  }
3737
- }
3813
+ },
3814
+ "operationId": "postPublicTripsByEnvelopeIdComponentsReorder",
3815
+ "summary": "POST /v1/public/trips/{envelopeId}/components/reorder",
3816
+ "tags": [
3817
+ "trips"
3818
+ ],
3819
+ "x-voyant-module": "trips",
3820
+ "x-voyant-surface": "storefront"
3738
3821
  }
3739
3822
  },
3740
3823
  "/v1/public/trips/components/{componentId}": {
@@ -4150,7 +4233,14 @@
4150
4233
  }
4151
4234
  }
4152
4235
  }
4153
- }
4236
+ },
4237
+ "operationId": "patchPublicTripsComponentsByComponentId",
4238
+ "summary": "PATCH /v1/public/trips/components/{componentId}",
4239
+ "tags": [
4240
+ "trips"
4241
+ ],
4242
+ "x-voyant-module": "trips",
4243
+ "x-voyant-surface": "storefront"
4154
4244
  },
4155
4245
  "delete": {
4156
4246
  "parameters": [
@@ -4484,7 +4574,14 @@
4484
4574
  }
4485
4575
  }
4486
4576
  }
4487
- }
4577
+ },
4578
+ "operationId": "deletePublicTripsComponentsByComponentId",
4579
+ "summary": "DELETE /v1/public/trips/components/{componentId}",
4580
+ "tags": [
4581
+ "trips"
4582
+ ],
4583
+ "x-voyant-module": "trips",
4584
+ "x-voyant-surface": "storefront"
4488
4585
  }
4489
4586
  },
4490
4587
  "/v1/public/trips/components/{componentId}/refs": {
@@ -4869,7 +4966,14 @@
4869
4966
  }
4870
4967
  }
4871
4968
  }
4872
- }
4969
+ },
4970
+ "operationId": "postPublicTripsComponentsByComponentIdRefs",
4971
+ "summary": "POST /v1/public/trips/components/{componentId}/refs",
4972
+ "tags": [
4973
+ "trips"
4974
+ ],
4975
+ "x-voyant-module": "trips",
4976
+ "x-voyant-surface": "storefront"
4873
4977
  }
4874
4978
  },
4875
4979
  "/v1/public/trips/{envelopeId}/requirements": {
@@ -5113,7 +5217,14 @@
5113
5217
  }
5114
5218
  }
5115
5219
  }
5116
- }
5220
+ },
5221
+ "operationId": "postPublicTripsByEnvelopeIdRequirements",
5222
+ "summary": "POST /v1/public/trips/{envelopeId}/requirements",
5223
+ "tags": [
5224
+ "trips"
5225
+ ],
5226
+ "x-voyant-module": "trips",
5227
+ "x-voyant-surface": "storefront"
5117
5228
  },
5118
5229
  "get": {
5119
5230
  "parameters": [
@@ -5309,7 +5420,14 @@
5309
5420
  }
5310
5421
  }
5311
5422
  }
5312
- }
5423
+ },
5424
+ "operationId": "getPublicTripsByEnvelopeIdRequirements",
5425
+ "summary": "GET /v1/public/trips/{envelopeId}/requirements",
5426
+ "tags": [
5427
+ "trips"
5428
+ ],
5429
+ "x-voyant-module": "trips",
5430
+ "x-voyant-surface": "storefront"
5313
5431
  }
5314
5432
  },
5315
5433
  "/v1/public/trips/requirements/{requirementId}/candidates": {
@@ -5677,7 +5795,14 @@
5677
5795
  }
5678
5796
  }
5679
5797
  }
5680
- }
5798
+ },
5799
+ "operationId": "postPublicTripsRequirementsByRequirementIdCandidates",
5800
+ "summary": "POST /v1/public/trips/requirements/{requirementId}/candidates",
5801
+ "tags": [
5802
+ "trips"
5803
+ ],
5804
+ "x-voyant-module": "trips",
5805
+ "x-voyant-surface": "storefront"
5681
5806
  }
5682
5807
  },
5683
5808
  "/v1/public/trips/requirements/{requirementId}/select": {
@@ -6216,7 +6341,14 @@
6216
6341
  }
6217
6342
  }
6218
6343
  }
6219
- }
6344
+ },
6345
+ "operationId": "postPublicTripsRequirementsByRequirementIdSelect",
6346
+ "summary": "POST /v1/public/trips/requirements/{requirementId}/select",
6347
+ "tags": [
6348
+ "trips"
6349
+ ],
6350
+ "x-voyant-module": "trips",
6351
+ "x-voyant-surface": "storefront"
6220
6352
  }
6221
6353
  },
6222
6354
  "/v1/public/trips/requirements/{requirementId}/reshop": {
@@ -6584,7 +6716,14 @@
6584
6716
  }
6585
6717
  }
6586
6718
  }
6587
- }
6719
+ },
6720
+ "operationId": "postPublicTripsRequirementsByRequirementIdReshop",
6721
+ "summary": "POST /v1/public/trips/requirements/{requirementId}/reshop",
6722
+ "tags": [
6723
+ "trips"
6724
+ ],
6725
+ "x-voyant-module": "trips",
6726
+ "x-voyant-surface": "storefront"
6588
6727
  }
6589
6728
  },
6590
6729
  "/v1/public/trips/{envelopeId}/price": {
@@ -7147,7 +7286,14 @@
7147
7286
  }
7148
7287
  }
7149
7288
  }
7150
- }
7289
+ },
7290
+ "operationId": "postPublicTripsByEnvelopeIdPrice",
7291
+ "summary": "POST /v1/public/trips/{envelopeId}/price",
7292
+ "tags": [
7293
+ "trips"
7294
+ ],
7295
+ "x-voyant-module": "trips",
7296
+ "x-voyant-surface": "storefront"
7151
7297
  }
7152
7298
  },
7153
7299
  "/v1/public/trips/{envelopeId}/reserve": {
@@ -7708,7 +7854,14 @@
7708
7854
  }
7709
7855
  }
7710
7856
  }
7711
- }
7857
+ },
7858
+ "operationId": "postPublicTripsByEnvelopeIdReserve",
7859
+ "summary": "POST /v1/public/trips/{envelopeId}/reserve",
7860
+ "tags": [
7861
+ "trips"
7862
+ ],
7863
+ "x-voyant-module": "trips",
7864
+ "x-voyant-surface": "storefront"
7712
7865
  }
7713
7866
  },
7714
7867
  "/v1/public/trips/{envelopeId}/checkout": {
@@ -8252,7 +8405,14 @@
8252
8405
  }
8253
8406
  }
8254
8407
  }
8255
- }
8408
+ },
8409
+ "operationId": "postPublicTripsByEnvelopeIdCheckout",
8410
+ "summary": "POST /v1/public/trips/{envelopeId}/checkout",
8411
+ "tags": [
8412
+ "trips"
8413
+ ],
8414
+ "x-voyant-module": "trips",
8415
+ "x-voyant-surface": "storefront"
8256
8416
  }
8257
8417
  },
8258
8418
  "/v1/public/trips/{envelopeId}/cancellation-preview": {
@@ -8798,7 +8958,14 @@
8798
8958
  }
8799
8959
  }
8800
8960
  }
8801
- }
8961
+ },
8962
+ "operationId": "postPublicTripsByEnvelopeIdCancellationPreview",
8963
+ "summary": "POST /v1/public/trips/{envelopeId}/cancellation-preview",
8964
+ "tags": [
8965
+ "trips"
8966
+ ],
8967
+ "x-voyant-module": "trips",
8968
+ "x-voyant-surface": "storefront"
8802
8969
  }
8803
8970
  },
8804
8971
  "/v1/public/trips/{envelopeId}/cancel-components": {
@@ -9349,7 +9516,14 @@
9349
9516
  }
9350
9517
  }
9351
9518
  }
9352
- }
9519
+ },
9520
+ "operationId": "postPublicTripsByEnvelopeIdCancelComponents",
9521
+ "summary": "POST /v1/public/trips/{envelopeId}/cancel-components",
9522
+ "tags": [
9523
+ "trips"
9524
+ ],
9525
+ "x-voyant-module": "trips",
9526
+ "x-voyant-surface": "storefront"
9353
9527
  }
9354
9528
  }
9355
9529
  },