@voyant-travel/openapi 0.2.5 → 0.3.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 +1395 -0
  3. package/spec/admin/action-ledger.json +6202 -0
  4. package/spec/admin/booking-requirements.json +5689 -0
  5. package/spec/admin/bookings.json +18794 -0
  6. package/spec/admin/catalog.json +690 -0
  7. package/spec/admin/distribution.json +19581 -0
  8. package/spec/admin/external-refs.json +1382 -0
  9. package/spec/admin/extras.json +4648 -0
  10. package/spec/admin/finance.json +35506 -0
  11. package/spec/admin/identity.json +4072 -0
  12. package/spec/admin/legal.json +14339 -0
  13. package/spec/admin/markets.json +5286 -0
  14. package/spec/admin/notifications.json +8409 -0
  15. package/spec/admin/operations.json +39806 -0
  16. package/spec/admin/operator-settings.json +1389 -0
  17. package/spec/admin/pricing.json +10640 -0
  18. package/spec/admin/products.json +22131 -0
  19. package/spec/admin/promotions.json +2730 -0
  20. package/spec/admin/quotes.json +7033 -0
  21. package/spec/admin/relationships.json +13911 -0
  22. package/spec/admin/sellability.json +4840 -0
  23. package/spec/admin/storefront.json +1953 -0
  24. package/spec/admin/suppliers.json +5850 -0
  25. package/spec/admin/trips.json +9357 -0
  26. package/spec/framework-admin.json +2552 -276
  27. package/spec/framework-openapi.json +2785 -708
  28. package/spec/framework-storefront.json +252 -451
  29. package/spec/storefront/booking-requirements.json +367 -0
  30. package/spec/storefront/bookings.json +6137 -0
  31. package/spec/storefront/catalog.json +690 -0
  32. package/spec/storefront/customer-portal.json +6038 -0
  33. package/spec/storefront/finance.json +4824 -0
  34. package/spec/storefront/legal.json +2082 -0
  35. package/spec/storefront/markets.json +256 -0
  36. package/spec/storefront/operator-settings.json +309 -0
  37. package/spec/storefront/pricing.json +585 -0
  38. package/spec/storefront/products.json +2910 -0
  39. package/spec/storefront/storefront-verification.json +909 -0
  40. package/spec/storefront/storefront.json +4067 -0
  41. package/spec/storefront/trips.json +9357 -0
@@ -10959,18 +10959,36 @@
10959
10959
  "id": {
10960
10960
  "type": "string"
10961
10961
  },
10962
+ "source": {
10963
+ "type": "string",
10964
+ "enum": [
10965
+ "payment",
10966
+ "voucher_redemption"
10967
+ ],
10968
+ "default": "payment"
10969
+ },
10962
10970
  "invoiceId": {
10963
- "type": "string"
10971
+ "type": [
10972
+ "string",
10973
+ "null"
10974
+ ]
10964
10975
  },
10965
10976
  "invoiceNumber": {
10966
- "type": "string"
10977
+ "type": [
10978
+ "string",
10979
+ "null"
10980
+ ]
10967
10981
  },
10968
10982
  "invoiceType": {
10969
- "type": "string",
10983
+ "type": [
10984
+ "string",
10985
+ "null"
10986
+ ],
10970
10987
  "enum": [
10971
10988
  "invoice",
10972
10989
  "proforma",
10973
- "credit_note"
10990
+ "credit_note",
10991
+ null
10974
10992
  ]
10975
10993
  },
10976
10994
  "status": {
@@ -15357,11 +15375,19 @@
15357
15375
  "required": true,
15358
15376
  "name": "id",
15359
15377
  "in": "path"
15378
+ },
15379
+ {
15380
+ "schema": {
15381
+ "type": "string"
15382
+ },
15383
+ "required": false,
15384
+ "name": "token",
15385
+ "in": "query"
15360
15386
  }
15361
15387
  ],
15362
15388
  "responses": {
15363
15389
  "200": {
15364
- "description": "A public-safe contract by id (metadata stripped)",
15390
+ "description": "A token-authorized public-safe contract",
15365
15391
  "content": {
15366
15392
  "application/json": {
15367
15393
  "schema": {
@@ -15370,9 +15396,6 @@
15370
15396
  "data": {
15371
15397
  "type": "object",
15372
15398
  "properties": {
15373
- "id": {
15374
- "type": "string"
15375
- },
15376
15399
  "contractNumber": {
15377
15400
  "type": [
15378
15401
  "string",
@@ -15401,159 +15424,9 @@
15401
15424
  "void"
15402
15425
  ]
15403
15426
  },
15404
- "stageHistory": {
15405
- "type": "array",
15406
- "items": {
15407
- "type": "object",
15408
- "properties": {
15409
- "stage": {
15410
- "type": "string",
15411
- "enum": [
15412
- "draft",
15413
- "issued",
15414
- "sent",
15415
- "signed",
15416
- "executed",
15417
- "expired",
15418
- "void"
15419
- ]
15420
- },
15421
- "previousStage": {
15422
- "type": [
15423
- "string",
15424
- "null"
15425
- ],
15426
- "enum": [
15427
- "draft",
15428
- "issued",
15429
- "sent",
15430
- "signed",
15431
- "executed",
15432
- "expired",
15433
- "void",
15434
- null
15435
- ]
15436
- },
15437
- "transition": {
15438
- "type": "string",
15439
- "enum": [
15440
- "created",
15441
- "issued",
15442
- "sent",
15443
- "signed",
15444
- "executed",
15445
- "voided"
15446
- ]
15447
- },
15448
- "enteredAt": {
15449
- "type": "string"
15450
- },
15451
- "actorId": {
15452
- "type": [
15453
- "string",
15454
- "null"
15455
- ]
15456
- }
15457
- },
15458
- "required": [
15459
- "stage",
15460
- "previousStage",
15461
- "transition",
15462
- "enteredAt"
15463
- ]
15464
- }
15465
- },
15466
15427
  "title": {
15467
15428
  "type": "string"
15468
15429
  },
15469
- "templateVersionId": {
15470
- "type": [
15471
- "string",
15472
- "null"
15473
- ]
15474
- },
15475
- "seriesId": {
15476
- "type": [
15477
- "string",
15478
- "null"
15479
- ]
15480
- },
15481
- "personId": {
15482
- "type": [
15483
- "string",
15484
- "null"
15485
- ]
15486
- },
15487
- "organizationId": {
15488
- "type": [
15489
- "string",
15490
- "null"
15491
- ]
15492
- },
15493
- "supplierId": {
15494
- "type": [
15495
- "string",
15496
- "null"
15497
- ]
15498
- },
15499
- "channelId": {
15500
- "type": [
15501
- "string",
15502
- "null"
15503
- ]
15504
- },
15505
- "bookingId": {
15506
- "type": [
15507
- "string",
15508
- "null"
15509
- ]
15510
- },
15511
- "targetKind": {
15512
- "type": [
15513
- "string",
15514
- "null"
15515
- ],
15516
- "enum": [
15517
- "booking",
15518
- "quote_version",
15519
- "program",
15520
- "product",
15521
- "inventory_item",
15522
- "supplier_channel_relationship",
15523
- "provider_source_ref",
15524
- null
15525
- ]
15526
- },
15527
- "targetId": {
15528
- "type": [
15529
- "string",
15530
- "null"
15531
- ]
15532
- },
15533
- "targetProvider": {
15534
- "type": [
15535
- "string",
15536
- "null"
15537
- ]
15538
- },
15539
- "targetSourceRef": {
15540
- "type": [
15541
- "string",
15542
- "null"
15543
- ]
15544
- },
15545
- "legacyTransactionOfferId": {
15546
- "type": [
15547
- "string",
15548
- "null"
15549
- ]
15550
- },
15551
- "legacyTransactionOrderId": {
15552
- "type": [
15553
- "string",
15554
- "null"
15555
- ]
15556
- },
15557
15430
  "issuedAt": {
15558
15431
  "type": [
15559
15432
  "string",
@@ -15600,35 +15473,13 @@
15600
15473
  "string",
15601
15474
  "null"
15602
15475
  ]
15603
- },
15604
- "variables": {},
15605
- "createdAt": {
15606
- "type": "string"
15607
- },
15608
- "updatedAt": {
15609
- "type": "string"
15610
15476
  }
15611
15477
  },
15612
15478
  "required": [
15613
- "id",
15614
15479
  "contractNumber",
15615
15480
  "scope",
15616
15481
  "status",
15617
- "stageHistory",
15618
15482
  "title",
15619
- "templateVersionId",
15620
- "seriesId",
15621
- "personId",
15622
- "organizationId",
15623
- "supplierId",
15624
- "channelId",
15625
- "bookingId",
15626
- "targetKind",
15627
- "targetId",
15628
- "targetProvider",
15629
- "targetSourceRef",
15630
- "legacyTransactionOfferId",
15631
- "legacyTransactionOrderId",
15632
15483
  "issuedAt",
15633
15484
  "sentAt",
15634
15485
  "executedAt",
@@ -15636,9 +15487,7 @@
15636
15487
  "voidedAt",
15637
15488
  "language",
15638
15489
  "renderedBodyFormat",
15639
- "renderedBody",
15640
- "createdAt",
15641
- "updatedAt"
15490
+ "renderedBody"
15642
15491
  ]
15643
15492
  }
15644
15493
  },
@@ -15666,6 +15515,24 @@
15666
15515
  }
15667
15516
  }
15668
15517
  }
15518
+ },
15519
+ "410": {
15520
+ "description": "Contract access grant is no longer available",
15521
+ "content": {
15522
+ "application/json": {
15523
+ "schema": {
15524
+ "type": "object",
15525
+ "properties": {
15526
+ "error": {
15527
+ "type": "string"
15528
+ }
15529
+ },
15530
+ "required": [
15531
+ "error"
15532
+ ]
15533
+ }
15534
+ }
15535
+ }
15669
15536
  }
15670
15537
  }
15671
15538
  }
@@ -15680,6 +15547,14 @@
15680
15547
  "required": true,
15681
15548
  "name": "id",
15682
15549
  "in": "path"
15550
+ },
15551
+ {
15552
+ "schema": {
15553
+ "type": "string"
15554
+ },
15555
+ "required": false,
15556
+ "name": "token",
15557
+ "in": "query"
15683
15558
  }
15684
15559
  ],
15685
15560
  "requestBody": {
@@ -15687,183 +15562,42 @@
15687
15562
  "content": {
15688
15563
  "application/json": {
15689
15564
  "schema": {
15690
- "type": "object",
15691
- "properties": {
15692
- "signerName": {
15693
- "type": "string",
15694
- "minLength": 1,
15695
- "maxLength": 255
15696
- },
15697
- "signerEmail": {
15698
- "type": [
15699
- "string",
15700
- "null"
15701
- ],
15702
- "format": "email"
15703
- },
15704
- "signerRole": {
15705
- "type": [
15706
- "string",
15707
- "null"
15708
- ],
15709
- "maxLength": 255
15710
- },
15711
- "personId": {
15712
- "type": [
15713
- "string",
15714
- "null"
15715
- ]
15716
- },
15717
- "targetKind": {
15718
- "type": [
15719
- "string",
15720
- "null"
15721
- ],
15722
- "enum": [
15723
- "booking",
15724
- "quote_version",
15725
- "program",
15726
- "product",
15727
- "inventory_item",
15728
- "supplier_channel_relationship",
15729
- "provider_source_ref",
15730
- null
15731
- ]
15732
- },
15733
- "targetId": {
15734
- "anyOf": [
15735
- {
15736
- "type": "string",
15737
- "enum": [
15738
- ""
15739
- ]
15740
- },
15741
- {
15742
- "type": "string"
15743
- },
15744
- {
15745
- "type": "null"
15746
- }
15747
- ]
15748
- },
15749
- "targetProvider": {
15750
- "anyOf": [
15751
- {
15752
- "type": "string",
15753
- "enum": [
15754
- ""
15755
- ]
15756
- },
15757
- {
15758
- "type": "string",
15759
- "minLength": 1,
15760
- "maxLength": 100
15761
- },
15762
- {
15763
- "type": "null"
15764
- }
15765
- ]
15766
- },
15767
- "targetSourceRef": {
15768
- "anyOf": [
15769
- {
15770
- "type": "string",
15771
- "enum": [
15772
- ""
15773
- ]
15774
- },
15775
- {
15776
- "type": "string",
15777
- "minLength": 1,
15778
- "maxLength": 500
15779
- },
15780
- {
15781
- "type": "null"
15782
- }
15783
- ]
15784
- },
15785
- "legacyTransactionOfferId": {
15786
- "anyOf": [
15787
- {
15788
- "type": "string",
15789
- "enum": [
15790
- ""
15791
- ]
15792
- },
15793
- {
15794
- "type": "string"
15795
- },
15796
- {
15797
- "type": "null"
15798
- }
15799
- ]
15800
- },
15801
- "legacyTransactionOrderId": {
15802
- "anyOf": [
15803
- {
15804
- "type": "string",
15805
- "enum": [
15806
- ""
15807
- ]
15808
- },
15809
- {
15810
- "type": "string"
15811
- },
15812
- {
15813
- "type": "null"
15814
- }
15815
- ]
15816
- },
15817
- "method": {
15818
- "type": "string",
15819
- "enum": [
15820
- "manual",
15821
- "electronic",
15822
- "docusign",
15823
- "other"
15824
- ],
15825
- "default": "manual"
15565
+ "type": "object",
15566
+ "properties": {
15567
+ "signerName": {
15568
+ "type": "string",
15569
+ "minLength": 1,
15570
+ "maxLength": 255
15826
15571
  },
15827
- "provider": {
15572
+ "signerEmail": {
15828
15573
  "type": [
15829
15574
  "string",
15830
15575
  "null"
15831
15576
  ],
15832
- "maxLength": 255
15577
+ "format": "email"
15833
15578
  },
15834
- "externalReference": {
15579
+ "signerRole": {
15835
15580
  "type": [
15836
15581
  "string",
15837
15582
  "null"
15838
15583
  ],
15839
15584
  "maxLength": 255
15840
15585
  },
15841
- "signatureData": {
15842
- "type": [
15843
- "string",
15844
- "null"
15845
- ]
15846
- },
15847
- "ipAddress": {
15848
- "type": [
15849
- "string",
15850
- "null"
15586
+ "method": {
15587
+ "type": "string",
15588
+ "enum": [
15589
+ "manual",
15590
+ "electronic",
15591
+ "docusign",
15592
+ "other"
15851
15593
  ],
15852
- "maxLength": 64
15594
+ "default": "manual"
15853
15595
  },
15854
- "userAgent": {
15596
+ "signatureData": {
15855
15597
  "type": [
15856
15598
  "string",
15857
15599
  "null"
15858
- ],
15859
- "maxLength": 500
15860
- },
15861
- "metadata": {
15862
- "type": [
15863
- "object",
15864
- "null"
15865
- ],
15866
- "additionalProperties": {}
15600
+ ]
15867
15601
  }
15868
15602
  },
15869
15603
  "required": [
@@ -15887,12 +15621,6 @@
15887
15621
  "signature": {
15888
15622
  "type": "object",
15889
15623
  "properties": {
15890
- "id": {
15891
- "type": "string"
15892
- },
15893
- "contractId": {
15894
- "type": "string"
15895
- },
15896
15624
  "signerName": {
15897
15625
  "type": "string"
15898
15626
  },
@@ -15908,58 +15636,6 @@
15908
15636
  "null"
15909
15637
  ]
15910
15638
  },
15911
- "personId": {
15912
- "type": [
15913
- "string",
15914
- "null"
15915
- ]
15916
- },
15917
- "targetKind": {
15918
- "type": [
15919
- "string",
15920
- "null"
15921
- ],
15922
- "enum": [
15923
- "booking",
15924
- "quote_version",
15925
- "program",
15926
- "product",
15927
- "inventory_item",
15928
- "supplier_channel_relationship",
15929
- "provider_source_ref",
15930
- null
15931
- ]
15932
- },
15933
- "targetId": {
15934
- "type": [
15935
- "string",
15936
- "null"
15937
- ]
15938
- },
15939
- "targetProvider": {
15940
- "type": [
15941
- "string",
15942
- "null"
15943
- ]
15944
- },
15945
- "targetSourceRef": {
15946
- "type": [
15947
- "string",
15948
- "null"
15949
- ]
15950
- },
15951
- "legacyTransactionOfferId": {
15952
- "type": [
15953
- "string",
15954
- "null"
15955
- ]
15956
- },
15957
- "legacyTransactionOrderId": {
15958
- "type": [
15959
- "string",
15960
- "null"
15961
- ]
15962
- },
15963
15639
  "method": {
15964
15640
  "type": "string",
15965
15641
  "enum": [
@@ -15969,65 +15645,16 @@
15969
15645
  "other"
15970
15646
  ]
15971
15647
  },
15972
- "provider": {
15973
- "type": [
15974
- "string",
15975
- "null"
15976
- ]
15977
- },
15978
- "externalReference": {
15979
- "type": [
15980
- "string",
15981
- "null"
15982
- ]
15983
- },
15984
- "signatureData": {
15985
- "type": [
15986
- "string",
15987
- "null"
15988
- ]
15989
- },
15990
- "ipAddress": {
15991
- "type": [
15992
- "string",
15993
- "null"
15994
- ]
15995
- },
15996
- "userAgent": {
15997
- "type": [
15998
- "string",
15999
- "null"
16000
- ]
16001
- },
16002
15648
  "signedAt": {
16003
15649
  "type": "string"
16004
- },
16005
- "metadata": {},
16006
- "createdAt": {
16007
- "type": "string"
16008
15650
  }
16009
15651
  },
16010
15652
  "required": [
16011
- "id",
16012
- "contractId",
16013
15653
  "signerName",
16014
15654
  "signerEmail",
16015
15655
  "signerRole",
16016
- "personId",
16017
- "targetKind",
16018
- "targetId",
16019
- "targetProvider",
16020
- "targetSourceRef",
16021
- "legacyTransactionOfferId",
16022
- "legacyTransactionOrderId",
16023
15656
  "method",
16024
- "provider",
16025
- "externalReference",
16026
- "signatureData",
16027
- "ipAddress",
16028
- "userAgent",
16029
- "signedAt",
16030
- "createdAt"
15657
+ "signedAt"
16031
15658
  ]
16032
15659
  }
16033
15660
  },
@@ -16096,6 +15723,24 @@
16096
15723
  }
16097
15724
  }
16098
15725
  }
15726
+ },
15727
+ "410": {
15728
+ "description": "Contract access grant is no longer available",
15729
+ "content": {
15730
+ "application/json": {
15731
+ "schema": {
15732
+ "type": "object",
15733
+ "properties": {
15734
+ "error": {
15735
+ "type": "string"
15736
+ }
15737
+ },
15738
+ "required": [
15739
+ "error"
15740
+ ]
15741
+ }
15742
+ }
15743
+ }
16099
15744
  }
16100
15745
  }
16101
15746
  }
@@ -36888,6 +36533,162 @@
36888
36533
  }
36889
36534
  }
36890
36535
  }
36536
+ },
36537
+ "/v1/public/operator-profile": {
36538
+ "get": {
36539
+ "responses": {
36540
+ "200": {
36541
+ "description": "The public operator profile (null when unset)",
36542
+ "content": {
36543
+ "application/json": {
36544
+ "schema": {
36545
+ "type": "object",
36546
+ "properties": {
36547
+ "data": {
36548
+ "type": [
36549
+ "object",
36550
+ "null"
36551
+ ],
36552
+ "properties": {
36553
+ "name": {
36554
+ "type": "string"
36555
+ },
36556
+ "legalName": {
36557
+ "type": "string"
36558
+ },
36559
+ "address": {
36560
+ "type": "string"
36561
+ },
36562
+ "phone": {
36563
+ "type": "string"
36564
+ },
36565
+ "email": {
36566
+ "type": "string"
36567
+ },
36568
+ "website": {
36569
+ "type": "string"
36570
+ },
36571
+ "license": {
36572
+ "type": "string"
36573
+ },
36574
+ "licenseAuthority": {
36575
+ "type": "string"
36576
+ },
36577
+ "customerPaymentPolicy": {},
36578
+ "bookingCheckoutUrlTemplate": {
36579
+ "type": [
36580
+ "string",
36581
+ "null"
36582
+ ]
36583
+ },
36584
+ "invoicePayUrlTemplate": {
36585
+ "type": [
36586
+ "string",
36587
+ "null"
36588
+ ]
36589
+ }
36590
+ },
36591
+ "required": [
36592
+ "name",
36593
+ "legalName",
36594
+ "address",
36595
+ "phone",
36596
+ "email",
36597
+ "website",
36598
+ "license",
36599
+ "licenseAuthority",
36600
+ "bookingCheckoutUrlTemplate",
36601
+ "invoicePayUrlTemplate"
36602
+ ]
36603
+ }
36604
+ },
36605
+ "required": [
36606
+ "data"
36607
+ ]
36608
+ }
36609
+ }
36610
+ }
36611
+ }
36612
+ }
36613
+ }
36614
+ },
36615
+ "/v1/public/settings/operator": {
36616
+ "get": {
36617
+ "responses": {
36618
+ "200": {
36619
+ "description": "The public operator settings (null when unset)",
36620
+ "content": {
36621
+ "application/json": {
36622
+ "schema": {
36623
+ "type": "object",
36624
+ "properties": {
36625
+ "data": {
36626
+ "type": [
36627
+ "object",
36628
+ "null"
36629
+ ],
36630
+ "properties": {
36631
+ "name": {
36632
+ "type": "string"
36633
+ },
36634
+ "legalName": {
36635
+ "type": "string"
36636
+ },
36637
+ "address": {
36638
+ "type": "string"
36639
+ },
36640
+ "phone": {
36641
+ "type": "string"
36642
+ },
36643
+ "email": {
36644
+ "type": "string"
36645
+ },
36646
+ "website": {
36647
+ "type": "string"
36648
+ },
36649
+ "license": {
36650
+ "type": "string"
36651
+ },
36652
+ "licenseAuthority": {
36653
+ "type": "string"
36654
+ },
36655
+ "customerPaymentPolicy": {},
36656
+ "bookingCheckoutUrlTemplate": {
36657
+ "type": [
36658
+ "string",
36659
+ "null"
36660
+ ]
36661
+ },
36662
+ "invoicePayUrlTemplate": {
36663
+ "type": [
36664
+ "string",
36665
+ "null"
36666
+ ]
36667
+ }
36668
+ },
36669
+ "required": [
36670
+ "name",
36671
+ "legalName",
36672
+ "address",
36673
+ "phone",
36674
+ "email",
36675
+ "website",
36676
+ "license",
36677
+ "licenseAuthority",
36678
+ "bookingCheckoutUrlTemplate",
36679
+ "invoicePayUrlTemplate"
36680
+ ]
36681
+ }
36682
+ },
36683
+ "required": [
36684
+ "data"
36685
+ ]
36686
+ }
36687
+ }
36688
+ }
36689
+ }
36690
+ }
36691
+ }
36891
36692
  }
36892
36693
  },
36893
36694
  "webhooks": {}