README

Documentation:

  <ul>
    <li><a href=\"https://online.travelcompositor.com/api/documentation/index.xhtml#Introduction\">Introduction</a></li>
    <li><a href=\"https://online.travelcompositor.com/api/documentation/index.xhtml#ApiAccomodation\">Accommodation API</a></li>
    <li><a href=\"https://online.travelcompositor.com/api/documentation/index.xhtml#ApiTransport\">Transport API</a></li>
    <li><a href=\"https://online.travelcompositor.com/api/documentation/index.xhtml#ApiClosedTour\">Closed Tour API</a></li>
    <li><a href=\"https://online.travelcompositor.com/api/documentation/index.xhtml#Webhooks\">Webhooks</a></li>
  </ul>

Installation & Usage

Requirements

PHP 8.4 and later.

Your project is free to choose the http client of your choice Please require packages that will provide http client functionality: https://packagist.org/providers/psr/http-client-implementation https://packagist.org/providers/php-http/async-client-implementation https://packagist.org/providers/psr/http-factory-implementation

As an example:

composer require guzzlehttp/guzzle php-http/guzzle7-adapter http-interop/http-factory-guzzle

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new TravelCompositor\Api\AuthenticationApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client()
);
$authentication = new \TravelCompositor\Model\Authentication(); // \TravelCompositor\Model\Authentication

try {
    $result = $apiInstance->authenticate($authentication);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->authenticate: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://online.travelcompositor.com/resources

Class	Method	HTTP request	Description
AuthenticationApi	authenticate	POST /authentication/authenticate	Return auth token
AuthenticationApi	getAuthToken	GET /authentication/getAuthToken	Return auth token. DEPRECATED: For security reasons, use POST - /authentication/authenticate so the password is not visible in the URL
BookAccommodationApi	book	POST /booking/accommodations/{accommodationId}/book	Book accommodation
BookAccommodationApi	cancel	DELETE /booking/{bookingReference}/accommodations/{accommodationBookingReference}	Cancel accommodation
BookAccommodationApi	confirm	POST /booking/accommodations/{accommodationId}/confirm	Confirm accommodation
BookAccommodationApi	getAccommodationBookedDetail	GET /booking/{bookingReference}/accommodations/{accommodationBookingReference}	Accommodation booking detail
BookAccommodationApi	getCancellationFee	GET /booking/{bookingReference}/accommodations/{accommodationBookingReference}/cancellation-fee	Cancellation fees
BookAccommodationApi	prebook	POST /booking/accommodations/{accommodationId}/prebook	Prebook accommodation
BookAccommodationApi	quote	POST /booking/accommodations/quote	Quote accommodations
BookAccommodationApi	quoteSingleAccommodation	POST /booking/accommodations/{accommodationId}/quote	Quote accommodation
BookAccommodationApi	refresh	PUT /booking/{bookingReference}/accommodations/{accommodationBookingReference}	Refresh accommodation booking
BookClosedTourApi	book1	POST /booking/closedtour/{closedTourId}/book	Book Closed Tour
BookClosedTourApi	cancel2	DELETE /booking/{bookingReference}/closedtour/{closedTourBookingReference}	Cancel closedtour
BookClosedTourApi	confirm1	POST /booking/closedtour/{closedTourId}/confirm	Confirm Closed Tour
BookClosedTourApi	getAccommodationOptions	POST /booking/closedtour/{closedTourId}/accommodation	Get Closed Tour Accommodation Options
BookClosedTourApi	getCancellationFee2	GET /booking/{bookingReference}/closedtour/{closedTourBookingReference}/cancellation-fee	Cancellation fees
BookClosedTourApi	getClosedTourBookedDetail	GET /booking/{bookingReference}/closedtour/{closedTourBookingReference}	Closed Tour booking detail
BookClosedTourApi	getPrePostNights	POST /booking/closedtour/{closedTourId}/prequotedata	Get possible closed Tour additional data
BookClosedTourApi	prebook1	POST /booking/closedtour/{closedTourId}/prebook	Prebook Closed tour
BookClosedTourApi	quote1	POST /booking/closedtour/{closedTourId}/quote	Quote closed Tour
BookClosedTourApi	refresh1	PUT /booking/{bookingReference}/closedtour/{closedTourBookingReference}	Refresh closed tour booking
BookTransportsApi	book2	POST /booking/transports/book	Book transports
BookTransportsApi	cancel3	DELETE /booking/{bookingReference}/transports/{transportBookingReference}	Cancel transport
BookTransportsApi	confirm2	POST /booking/transports/confirm	Confirm transports
BookTransportsApi	getCancellationFee3	GET /booking/{bookingReference}/transports/{transportBookingReference}/cancellation-fee	Cancellation fees
BookTransportsApi	getTransportBookedDetail	GET /booking/{bookingReference}/transports/{transportBookingReference}	Transport booking detail
BookTransportsApi	prebook2	POST /booking/transports/prebook	Prebook transports
BookTransportsApi	quote2	POST /booking/transports/quote	Quote transports
BookTransportsApi	refresh2	PUT /booking/{bookingReference}/transports/{transportBookingReference}	Refresh transport booking
BookingApi	cancel1	PUT /booking/{bookingReference}/{serviceType}/{serviceId}/cancel	Cancel a booking service
BookingApi	getBookings	GET /booking/getBookings/{micrositeId}/{bookingReference}	Return booking by reference
BookingApi	getBookings1	GET /booking/getBookings	Return bookings by operator or microsite
BookingApi	getCancellationFee1	GET /booking/{bookingReference}/{serviceType}/{serviceId}/cancellation-fee	Cancellation fees for booking service
BookingClientRequestApi	clientRequestClose	PUT /booking/{bookingReference}/client-requests/{clientRequestId}/close	Closes an existing client request
BookingClientRequestApi	clientRequestCreate	POST /booking/{bookingReference}/client-requests	Creates a new client request
BookingClientRequestApi	clientRequestOpen	PUT /booking/{bookingReference}/client-requests/{clientRequestId}/open	Opens an existing client request
BookingClientRequestApi	clientRequestReply	POST /booking/{bookingReference}/client-requests/{clientRequestId}/reply	Reply to an existing client request
ContractClosedTourApi	createClosedTour	POST /closedtour/{supplierId}	Creates a new closed tour
ContractClosedTourApi	createClosedTourOption	POST /closedtour/{supplierId}/{closedTourCode}	Creates a new closed tour option
ContractClosedTourApi	getClosedTour	GET /closedtour/{supplierId}/{closedTourCode}	Return closed tour by its code
ContractClosedTourApi	getOptions	GET /closedtour/{supplierId}/{closedTourCode}/{optionCode}	Return closed tour options by code
ContractClosedTourApi	updateClosedTour	PUT /closedtour/{supplierId}	Updates an existing closed tour
ContractClosedTourApi	updateClosedTourOption	PUT /closedtour/{supplierId}/{closedTourCode}	Updates an existing closed tour option
ContractGolfApi	createContract	POST /golf/{supplierId}	Creates a new golf contract
ContractGolfApi	createRate	POST /golf/{supplierId}/{contractCode}/rate	Creates a new rate for an existing golf contract
ContractGolfApi	createSeason	POST /golf/{supplierId}/{contractCode}/season	Creates a new season for an existing golf contract
ContractGolfApi	createTeeTime	POST /golf/{supplierId}/{contractCode}/teetime	Creates a new tee time for an existing golf contract
ContractGolfApi	getContract	GET /golf/{supplierId}/{contractCode}	Return the details of golf contract by its code
ContractGolfApi	getContracts	GET /golf/{supplierId}	Return golf contracts by supplier
ContractGolfApi	updateContract	PUT /golf/{supplierId}	Updates an existing golf contract
ContractGolfApi	updateRate	PUT /golf/{supplierId}/{contractCode}/rate	Updates an existing rate for an existing golf contract
ContractGolfApi	updateSeason	PUT /golf/{supplierId}/{contractCode}/season	Updates an existing season for an existing golf contract
ContractGolfApi	updateTeeTime	PUT /golf/{supplierId}/{contractCode}/teetime	Update an existing tee time for an existing golf contract
ContractHotelApi	createHotel	POST /hotel/{supplierId}	Creates a new hotel contract
ContractHotelApi	createHotelMealPlan	POST /hotel/mealplan/{supplierId}/{providerCode}	Creates a new hotel mealplan
ContractHotelApi	createHotelOffer	POST /hotel/offer/{supplierId}/{providerCode}	Add offer to hotel contract
ContractHotelApi	createHotelRates	POST /hotel/rates/{supplierId}/{providerCode}	Add rates to hotel contract
ContractHotelApi	createHotelRoom	POST /hotel/room/{supplierId}/{providerCode}	Creates a new hotel room
ContractHotelApi	createHotelSupplement	POST /hotel/supplement/{supplierId}/{providerCode}	Add supplement to hotel contract
ContractHotelApi	getHotel	GET /hotel/{supplierId}/{providerCode}	Return hotel by its provider code
ContractHotelApi	getHotels	GET /hotel/{supplierId}	Return hotels by supplier
ContractHotelApi	updateHotel	PUT /hotel/{supplierId}	Updates an existing hotel contract
ContractHotelApi	updateHotelRates	PUT /hotel/rates/{supplierId}/{providerCode}	Modifies hotel contract rates
ContractSupplierApi	createContractSupplier	POST /suppliers	Creates a new supplier
ContractSupplierApi	getContractSupplier	GET /suppliers/{supplierId}	Return supplier by its code
ContractSupplierApi	getSupplierList	GET /suppliers	Return suppliers of operator
ContractSupplierApi	updateContractSupplier	PUT /suppliers/{supplierId}	Modify an existing contract supplier
ContractTicketApi	createTicket	POST /tickets/{supplierId}	Creates a new ticket
ContractTicketApi	createTicketOption	POST /tickets/{supplierId}/{ticketCode}	Creates a new ticket option
ContractTicketApi	getOptions1	GET /tickets/{supplierId}/{ticketCode}/{optionCode}	Return ticket options by code
ContractTicketApi	getTicket	GET /tickets/{supplierId}/{ticketCode}	Return ticket by its code
ContractTicketApi	getTickets	GET /tickets/{supplierId}	Return tickets by supplier
ContractTicketApi	updateTicket	PUT /tickets/{supplierId}	Updates an existing ticket
ContractTicketApi	updateTicketOption	PUT /tickets/{supplierId}/{ticketCode}	Updates an existing ticket option
ContractTransferApi	createTransfer	POST /transfer/{supplierId}	Creates a new transfer
ContractTransferApi	getTicket1	GET /transfer/{supplierId}/{transferId}	Return transfer by its id
ContractTransferApi	getTransfers	GET /transfer/{supplierId}	Return transfers by supplier
ContractTransferApi	getZones	GET /transfer/zones/{supplierId}	Return transfer zones
ContractTransferApi	updateTransfer	PUT /transfer/{supplierId}	Updates an existing transfer
ContractTransportApi	createTransport	POST /transport/{supplierId}	Creates a new transport
ContractTransportApi	createTransportOption	POST /transport/{supplierId}/{transportId}	Creates a new transport option
ContractTransportApi	getOptions2	GET /transport/{supplierId}/{transportId}/{optionCode}	Return transport options by code
ContractTransportApi	getTransportContract	GET /transport/{supplierId}/{transportId}	Return transports by its ID
ContractTransportApi	getTransports	GET /transport/{supplierId}	Return transports by supplier
ContractTransportApi	updateTransport	PUT /transport/{supplierId}	Updates an existing transport
ContractTransportApi	updateTransportOption	PUT /transport/{supplierId}/{transportId}	Updates an existing transport option
IdeasApi	getDayToDay1	GET /travelidea/{micrositeId}/{ideaId}	Return idea details by its ID
IdeasApi	getIdea	GET /travelidea/{micrositeId}/info/{ideaId}	Return idea by its ID
IdeasApi	getIdeas	GET /travelidea/{micrositeId}	Return ideas by microsite
IdeasApi	updateIdea	PUT /travelidea/{micrositeId}/{ideaId}	Updates an existing idea
PackagesApi	getDayToDay	GET /package/{micrositeId}/{holidayPackageId}	Return holiday package details by its ID
PackagesApi	getHolidayPackage	GET /package/{micrositeId}/info/{holidayPackageId}	Return holiday package by its ID
PackagesApi	getHolidayPackageCalendar	GET /package/calendar/{micrositeId}/{holidayPackageId}	Return holiday package calendar by its ID
PackagesApi	getHolidayPackages	GET /package/{micrositeId}	Return holiday packages by microsite
PackagesApi	updateHolidayPackage	PUT /package/{micrositeId}/{holidayPackageId}	Updates an existing holiday package
PromotionCodesApi	createPromotionCode	POST /promotioncode/{micrositeId}	Creates a new promotional code
PromotionCodesApi	getPromotionCode	GET /promotioncode/{micrositeId}	Return promotional codes by microsite
PromotionCodesApi	updatePromotionCode	PUT /promotioncode/{micrositeId}	Modify an existing promotional code
PurchaseAttemptsApi	getPurchaseAttempt	GET /purchase-attempts/{micrositeId}	Return purchase attempt
PurchaseAttemptsApi	getPurchaseAttemptById	GET /purchase-attempts/{micrositeId}/{purchaseAttemptId}	Return purchase attempt by Id
TripQuoteApi	countTripQuotes	GET /tripquote/count
TripQuoteApi	reportTripQuotes	GET /tripquote/report
UsersAndAgenciesApi	addUserLoyaltyRewards	POST /user/rewards/{micrositeId}/{agencyId}/{username}	Add rewards
UsersAndAgenciesApi	createAgency	POST /agency/{micrositeId}	Creates a new agency
UsersAndAgenciesApi	createUser	POST /user/{micrositeId}/{agencyId}	Creates a new user
UsersAndAgenciesApi	getAgencies	GET /agency/{micrositeId}	Return agencies by microsite
UsersAndAgenciesApi	getAgency	GET /agency/{micrositeId}/{agencyId}	Return agency by its ID
UsersAndAgenciesApi	getAgency1	GET /agencymanager/{micrositeId}/{agencyManagerId}	Return agency manager by its ID
UsersAndAgenciesApi	getAgencyCredit	GET /agency/agencyCredit/{micrositeId}/{agencyId}	Return agency credit balance by its ID
UsersAndAgenciesApi	getUser	GET /user/{micrositeId}/{agencyId}/{username}	Return user by its ID
UsersAndAgenciesApi	getUsers	GET /user/{micrositeId}	Return users
UsersAndAgenciesApi	getUsers1	GET /user/{micrositeId}/{agencyId}	Return users by agency
UsersAndAgenciesApi	increaseAgencyCredit	PUT /agency/agencyCredit/{micrositeId}/{agencyId}	Increase the credit of an existing agency by its ID
UsersAndAgenciesApi	updateAgency	PUT /agency/{micrositeId}	Updates an existing agency
UsersAndAgenciesApi	updateUser	PUT /user/{micrositeId}/{agencyId}	Updates an existing user
WebContentApi	deleteCustomDatasheet	DELETE /static/closedtour/customdatasheet/{lang}/{dataSheetId}	Deletes Custom Data Sheet
WebContentApi	getAccommodationDataSheet	GET /accommodations/{accommodationId}/datasheet	Returns a accommodation datasheet
WebContentApi	getAccommodations	GET /accommodations	Returns the active accommodations
WebContentApi	getAccommodationsDataSheet	GET /accommodations/datasheet	Returns a list of accommodations datasheet
WebContentApi	getAirlines	GET /airline/{micrositeId}	Return airlines by microsite
WebContentApi	getClosedTour1	GET /static/closedtour/{lang}/{closedTourId}	Get Closed Tour
WebContentApi	getCountries	GET /destination/countries/{micrositeId}	Return countries
WebContentApi	getCruiseDepartures	GET /cruise/{micrositeId}/{cruiseId}/departures	Return cruise departures
WebContentApi	getCruiseItinerary	GET /cruise/{cruiseId}/itinerary	Return an itinerary by ID
WebContentApi	getCruiseLineCharacteristics	GET /cruise/{micrositeId}/cruiseLine	Return cruise line characteristics
WebContentApi	getCruises	GET /cruise/{micrositeId}	Return all cruises
WebContentApi	getCustomDatasheet	GET /static/closedtour/customdatasheet/{dataSheetId}	Get Custom Datasheet
WebContentApi	getDatasheet	POST /static/closedtour/datasheet	Get Datasheets
WebContentApi	getDatasheet1	GET /static/closedtour/datasheet/{dataSheetId}	Get Datasheet
WebContentApi	getDestination	GET /destination/{micrositeId}/{destinationId}	Return destination by ID
WebContentApi	getDestinations	GET /destination/{micrositeId}	Return destinations
WebContentApi	getExpediaAccommodationDataSheet	GET /accommodations/{accommodationId}/expediaDatasheet	Returns a expedia accommodation datasheet. CAUTION: Requires to have expedia as an active hotel supplier.
WebContentApi	getExpediaReviews	GET /accommodations/{accommodationId}/expedia-reviews	Returns expedia reviews for a given hotel. CAUTION: Requires approval from both Travelcompositor and Expedia.
WebContentApi	getInfoTicketByReference	GET /ticket/datasheet/{micrositeId}/{ticketId}	Return info ticket
WebContentApi	getMealPlans	GET /mealplan/{micrositeId}	Return meal plans by microsite
WebContentApi	getPortById	GET /cruise/port/{cruisePortId}	Return a port by its id
WebContentApi	getPorts	GET /cruise/port	Return all ports
WebContentApi	getPreferredHotels	GET /accommodations/preferred/{micrositeId}	Return preferred accommodations
WebContentApi	getPreferredTickets	GET /ticket/preferred/{micrositeId}	Return preferred tickets
WebContentApi	getProviderConfigurationList	GET /providers/configurations/{micrositeId}	Return providers configuration of microsite
WebContentApi	getShipById	GET /cruise/{micrositeId}/ship/{shipId}	Return cruise ship by ID
WebContentApi	getShips	GET /cruise/{micrositeId}/ship	Return all ships
WebContentApi	getThemes	GET /theme/{micrositeId}	Return microsite themes
WebContentApi	getTransportBaseByCode	GET /transportbases/{code}	Returns a transport base by its code
WebContentApi	getTransportBases	GET /transportbases	Returns the active transport bases
WebContentApi	searchClosedTours	POST /static/closedtour/{lang}	Search Closed Tours
WebContentApi	updateCustomDatasheet	PUT /static/closedtour/customdatasheet/{dataSheetId}	Updates Custom Datasheet

Models

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
- Generator version: 7.13.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.PhpClientCodegen

bookunited / travel-compositor

Maintainers

Details