Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
{"openapi":"3.0.1","info":{"title":"Wink API","description":" # Introduction\n Welcome to the Wink API - A programmer-friendly way to manage, sell and book travel inventory on the Wink platform. The API gives you all the tools you need to ready your properties and inventory for sale across 1000s of our native sales channels.\n Integrators, affiliates, travel agents and content creators have the ability search for your travel inventory and promote / sell it in a wide variety of ways.\n\n # Integrations\n We have already integrated with the most well-known channel managers so you don't have to. To see our current integrations, please go to https://extranet.wink.travel and scroll to Connectivity section. Once your properties are set up, you can finish the setup by mapping your property to Wink using your channel manager partner portal. If your properties don't have a channel manager, you can easily manage rates and availability with this API.\n\n # Intended Audience\n Programmers are [most likely] a requirement to start integrating with Wink. Companies and organizations that would most benefit from integrating with us are new and existing travel companies that have relationships with suppliers and that need an advanced system from which to manage their travel inventory and get that same inventory out to as many eyeballs as possible at the lowest price possible.\n - Hotel chains\n - Hotel brands\n - Travel tech companies\n - Destination sites\n - Integrators\n - Aggregators\n - Destination management companies\n - Travel agencies\n - OTAs\n\n ## APIs\n Not every integrator needs every API. For that reason, we have separated APIs into context.\n\n### Test API\n\n - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink.\n\n### Common APIs\n\n- [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account.\n- [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink.\n\n### Consume APIs\nConsume endpoints are for developers who want to find existing travel inventory and either book it or use it to advertise through one of their Wink affiliate accounts.\n\n - [Configuration](/engine-client): A single endpoint to retrieve whitelabel + customization information for the booking engine.\n - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags.\n - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API..\n - [Booking](/booking): All APIs related to creating bookings on the platform.\n - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings.\n\n ### Produce APIs\n Produce endpoints are for developers who want to create and manage travel inventory.\n\n #### Property\n - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink.\n - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties.\n - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types.\n - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities.\n - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink.\n - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink.\n - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level.\n\n #### Affiliate\n - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts.\n - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell.\n - [Inventory](/affiliate/inventory): The Inventory API exposes endpoints for affiliates to manage the inventory they want to sell and how they want to sell it.\n - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones.\n - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page.\n\n #### Rate provider\n - [Channel manager](/channel-manager): The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties.\n\n ### Taxonomy APIs\n Taxonomy endpoints are for developers who want to consume and produce travel inventory and need taxonomies of standard and non-standard codes for inventory types, classes, statuses etc.\n\n - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies.\n\n ### Insight APIs\n Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers.\n\n - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics.\n\n ### Payment APIs\n Payment endpoints are for developers who want to purchase travel inventory. This can be done via the API as a registered Travel Agent or using our API in conjunction with our PCI compliant payment widget for all other entities.\n\n - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features.\n\n ## SDKs\n We are actively working on supporting the most used languages out there. If you don't see your language here, reach out to us with a request to officially add your language. In the meantime, if you want to roll your own SDK, you can do so by downloading the OpenAPI spec and using one of the many available OpenAPI generators available: [https://openapi-generator.tech/docs/generators](https://openapi-generator.tech/docs/generators).\n\n - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java)\n\n ## Usage\n These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic.\n\n ## Versioning\n We chose to version our endpoints in a way that we hope affects your integration minimally. You request the version of our API you wish to work with via the `Wink-Version` header. When it's time for you to upgrade, you only have to change the version number to get access to our updated endpoints.\n\n ## Release history\n - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md\n\n\n\n# Travel Agent API\nThe Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you:\n\n1. Travel Agent: Manage agent entity.\n2. Booking: Create / Manage bookings\n\nBrowse the endpoints in the left navigation bar to get started.\n\n","contact":{"name":"Bjorn Harvold","email":"[email protected]"},"version":"30.5.2","x-logo":{"backgroundColor":"#FFFFFF","altText":"wink","url":"https://res.cloudinary.com/traveliko/image/upload/c_scale,h_129/v1653285543/wink/logo_text_white.svg"}},"servers":[{"url":"https://api.wink.travel","description":"Endpoint"}],"tags":[{"name":"Travel Agent","description":"Travel Agent API is a collection fo endpoints for agents to access the bookings they facilitated."}],"paths":{"/api/booking/agent":{"post":{"tags":["Travel Agent"],"summary":"Create Agent Booking","description":"Create agent booking. Expects the agent to be a registered agent with TripPay and have available funds to cover the booking amount.","operationId":"createAgentBooking","parameters":[{"name":"Wink-Version","in":"header","schema":{"type":"string","enum":["2.0"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentBookingRequest_Agent"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/plain":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"application/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/plain":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingConfirmations_Agent"}}}}},"security":[{"oauth2ClientCredentials":[]}]}},"/api/affiliate/{companyIdentifier}/booking/grid":{"post":{"tags":["Travel Agent"],"summary":"Show Bookings","description":"Show bookings for the company that helped create those booking.","operationId":"showBookingGridAsTravelAgent","parameters":[{"name":"companyIdentifier","in":"path","description":"Show bookings for company identifier","required":true,"schema":{"type":"string"},"example":"company-1"},{"name":"Wink-Version","in":"header","schema":{"type":"string","enum":["2.0"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/State_Agent"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/plain":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"application/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/plain":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBookingView_Agent"}}}}},"security":[{"oauth2ClientCredentials":[]}]}},"/api/affiliate/{companyIdentifier}/booking/{bookingIdentifier}":{"get":{"tags":["Travel Agent"],"summary":"Show Booking","description":"Show a booking record by its identifier.","operationId":"showBookingAsTravelAgent","parameters":[{"name":"companyIdentifier","in":"path","description":"Show booking for company identifier","required":true,"schema":{"type":"string"},"example":"company-1"},{"name":"bookingIdentifier","in":"path","description":"Show booking with booking identifier","required":true,"schema":{"type":"string"},"example":"booking-1"},{"name":"Wink-Version","in":"header","schema":{"type":"string","enum":["2.0"]}},{"name":"Accept","in":"header","schema":{"type":"string","enum":["application/json"]}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/plain":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"application/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/plain":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingView_Agent"}}}}},"security":[{"oauth2ClientCredentials":[]}]},"patch":{"tags":["Travel Agent"],"summary":"Cancel Booking","description":"Cancel a booking by its booking identifier","operationId":"cancelBookingAsTravelAgent","parameters":[{"name":"companyIdentifier","in":"path","description":"Cancel booking owned by company identifier","required":true,"schema":{"type":"string"},"example":"company-1"},{"name":"bookingIdentifier","in":"path","description":"Cancel booking by identifier","required":true,"schema":{"type":"string"},"example":"booking-1"},{"name":"Wink-Version","in":"header","schema":{"type":"string","enum":["2.0"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationDetail_Agent"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/plain":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"application/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/plain":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingView_Agent"}}}}},"security":[{"oauth2ClientCredentials":[]}]}},"/api/affiliate/{companyIdentifier}/booking/{bookingIdentifier}/resend":{"patch":{"tags":["Travel Agent"],"summary":"Resend Booking Confirmation","description":"Resends booking confirmation email to traveler.","operationId":"resendBookingConfirmationEmailAsTravelAgent","parameters":[{"name":"companyIdentifier","in":"path","description":"Resend booking owned by company identifier","required":true,"schema":{"type":"string"},"example":"company-1"},{"name":"bookingIdentifier","in":"path","description":"Resend booking by identifier","required":true,"schema":{"type":"string"},"example":"booking-1"},{"name":"Wink-Version","in":"header","schema":{"type":"string","enum":["2.0"]}}],"requestBody":{"description":"Empty request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyRequestBody_Agent"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/plain":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"application/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/plain":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BooleanResponse_Agent"}}}}},"security":[{"oauth2ClientCredentials":[]}]}},"/api/affiliate/{companyIdentifier}/agent":{"patch":{"tags":["Travel Agent"],"summary":"Update Agent","description":"Update an existing agent","operationId":"updateAgent","parameters":[{"name":"companyIdentifier","in":"path","description":"Update agent by company id","required":true,"schema":{"type":"string"}},{"name":"Wink-Version","in":"header","schema":{"type":"string","enum":["2.0"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertTravelAgentRequest_Agent"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/xml":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}},"text/plain":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericErrorMessage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"application/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/xml":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"text/plain":{"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"object"}},{"$ref":"#/components/schemas/GenericErrorMessage"}]}},"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyView_Agent"}}}}},"security":[{"oauth2ClientCredentials":[]}]}}},"components":{"schemas":{"GenericErrorMessage":{"type":"object","properties":{"timestamp":{"type":"string","xml":{"attribute":true}},"status":{"type":"integer","format":"int32","xml":{"attribute":true}},"error":{"type":"string"},"message":{"type":"string"},"path":{"type":"string"}},"description":"Generic error message","xml":{"name":"ErrorMessage"}},"AgentBookingRequest_Agent":{"required":["endDate","hotelIdentifier","roomConfiguration","roomRateIdentifier","startDate","user"],"type":"object","properties":{"hotelIdentifier":{"type":"string","description":"Unique hotel record identifier.","format":"uuid"},"startDate":{"type":"string","description":"Date when guest arrives on the premises.","format":"date","example":"2021-01-31"},"endDate":{"type":"string","description":"Date when guest departs the premises.","format":"date","example":"2021-02-07"},"roomConfiguration":{"$ref":"#/components/schemas/RoomConfiguration_Agent"},"promotionalCodes":{"type":"array","items":{"type":"string","description":"List of promotional codes the user entered to to activate a promotion.","example":"promo-1"}},"roomRateIdentifier":{"type":"string","description":"The unique master rate that made the guest room / rate plan available for sale.","format":"uuid"},"bedroomConfigurationIdentifier":{"type":"string","description":"Guest can optionally request a specific bedroom layout if the room type is set up with multiple layout choices."},"ancillaries":{"type":"array","items":{"$ref":"#/components/schemas/AncillaryRequest_Agent"}},"specialRequests":{"type":"string","description":"A guest can send a special request to the hotel in free-text here.","example":"Can I please have rose petals on my pillows when I arrive?"},"user":{"$ref":"#/components/schemas/BookingUserRequest_Agent"},"externalSupplierBookingCode":{"type":"string","description":"External booking code generated by the affiliate","example":"external-booking-code-1"},"externalTransactionIdentifier":{"type":"string","description":"External transaction identifier","example":"external-transaction-1"},"externalCustomerIdentifier":{"type":"string","description":"External customer identifier","example":"customer-1"},"externalFees":{"type":"array","items":{"$ref":"#/components/schemas/Fee_Agent"}},"vendorSpecific":{"type":"object","additionalProperties":{"type":"string","description":"External metadata"},"description":"External metadata"},"validUser":{"type":"boolean"}},"description":"List of room configuration booking requests. Each entry is a separately booked room."},"AncillaryRequest_Agent":{"required":["channelInventoryIdentifier","endDate","quantity","startDate","transactionalTravelInventoryIdentifier","type","typeIdentifier"],"type":"object","properties":{"typeIdentifier":{"type":"string","description":"Travel inventory identifier","format":"uuid"},"channelInventoryIdentifier":{"type":"string","description":"Channel inventory identifier","format":"uuid"},"transactionalTravelInventoryIdentifier":{"type":"string","description":"Travel inventory identifier","format":"uuid"},"startDate":{"type":"string","description":"Date start time when reservation was made for.","format":"date-time"},"endDate":{"type":"string","description":"Date end time when reservation was made for.","format":"date-time"},"quantity":{"minimum":1,"type":"integer","description":"Quantity of the ancillary requested.","format":"int32","example":2,"default":1},"identifier":{"type":"string","description":"Ancillary identifier","format":"uuid"},"type":{"type":"string","description":"Inventory type","example":"PLACE","enum":["ROOM_TYPE_ANCILLARY","ADD_ON","MEETING_ROOM","SPA","RESTAURANT","ACTIVITY","ATTRACTION","PLACE"]}},"description":"Extra reservations of spas, meeting rooms etc that should accompany the room type booking."},"BookingUserRequest_Agent":{"required":["email","firstName","lastName"],"type":"object","properties":{"firstName":{"type":"string","description":"First name","example":"John"},"lastName":{"type":"string","description":"Last name","example":"Smith"},"email":{"type":"string","description":"Email","format":"email","example":"[email protected]"},"telephone":{"type":"string","description":"Telephone","example":"0123456789"},"valid":{"type":"boolean"}},"description":"User object contains details of the person that made the booking."},"Child_Agent":{"required":["age","quantity"],"type":"object","properties":{"quantity":{"minimum":1,"type":"integer","description":"Number of children","format":"int32"},"age":{"minimum":0,"type":"integer","description":"Age of children","format":"int32"}},"description":"Child configuration"},"CreateAgentBookingRequest_Agent":{"required":["displayCurrency","displayLanguage","rooms","sourceUrl"],"type":"object","properties":{"rooms":{"type":"array","description":"List of room configuration booking requests. Each entry is a separately booked room.","items":{"$ref":"#/components/schemas/AgentBookingRequest_Agent"}},"displayCurrency":{"type":"string","description":"The desired currency","example":"USD","default":"USD"},"displayLanguage":{"type":"string","description":"The desired language","example":"en","default":"en"},"sourceUrl":{"type":"string","description":"Where did the booking occur","example":"https://www.traveliko.com"},"traceId":{"type":"string","description":"Integrator can choose to include a unique identifier to help identify the collection of bookings","example":"trace-1"}}},"CustomMonetaryAmount":{"required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number"},"currency":{"type":"string"}}},"Fee_Agent":{"required":["description","fee","identifier","type"],"type":"object","properties":{"identifier":{"type":"string","description":"Unique system ID.","example":"ABC1234"},"fee":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"type":{"type":"string","description":"Type of fee","enum":["ACQUIRING","FX","TAX"]},"description":{"type":"string","description":"Withdrawal fee description"}},"description":"External fee array"},"RoomConfiguration_Agent":{"required":["adults"],"type":"object","properties":{"adults":{"minimum":1,"type":"integer","description":"Number of adults","format":"int32","example":2,"default":1},"children":{"type":"array","description":"Children configurations","items":{"$ref":"#/components/schemas/Child_Agent"}}},"description":"Room Configuration"},"Address_Agent":{"required":["address1","city"],"type":"object","properties":{"address1":{"type":"string","description":"Address line 1","example":"234 Near da beach"},"address2":{"type":"string","description":"Address line 2","example":"Pebble #5001"},"state":{"type":"string","description":"State","example":"CA"},"postalCode":{"type":"string","description":"Postal / zip code","example":"90210"},"county":{"type":"string","description":"County","example":"Alameda county"},"city":{"$ref":"#/components/schemas/GeoName_Agent"},"valid":{"type":"boolean","description":"Whether this address is considered valid by the system or not","readOnly":true,"example":true},"fullAddress":{"type":"string","description":"Address 1, Address 2, City, State, Postal / Zip code, Country","readOnly":true,"example":"11 At home, Suite 3C, New York City, NY 10010, United States"}},"description":"Address information"},"AuthenticatedUser_Agent":{"required":["email","firstName","lastName"],"type":"object","properties":{"userIdentifier":{"type":"string","description":"User identifier","format":"uuid"},"firstName":{"type":"string","description":"First name","example":"John"},"lastName":{"type":"string","description":"Last name","example":"Smith"},"email":{"type":"string","description":"Email","format":"email","example":"[email protected]"},"fullName":{"type":"string","description":"Full name","readOnly":true,"example":"John Smith"}},"description":"The authenticated user ID that made the payment request","example":"user-1"},"Bed_Agent":{"required":["bedTypeCode","quantity"],"type":"object","properties":{"bedTypeCode":{"type":"string","description":"Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification `BED` code. See [OTA geoname data](#operation/showAvailableCodesForCategory).","example":"1"},"quantity":{"minimum":1,"type":"integer","description":"Number of beds for this bed type.","format":"int32","example":10}}},"BedroomConfiguration_Agent":{"required":["bedroomList","identifier","name"],"type":"object","properties":{"identifier":{"type":"string","description":"Unique identifier","format":"uuid"},"name":{"type":"string","description":"Name of layout"},"bedroomList":{"type":"array","description":"A room type can have more than one bedroom configuration.","items":{"$ref":"#/components/schemas/Bedroom_Agent"}}},"description":"Desired bedroom layout"},"Bedroom_Agent":{"required":["bedList","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of bedroom","enum":["MASTER","QUEEN","JUNIOR","DORMITORY","BEDROOM_1","BEDROOM_2","BEDROOM_3","BEDROOM_4","BEDROOM_5","BEDROOM_6","BEDROOM_7","BEDROOM_8","BEDROOM_9","BEDROOM_10"]},"bedList":{"type":"array","description":"A bedroom can have more than one bed type.","items":{"$ref":"#/components/schemas/Bed_Agent"}}}},"BeneficiaryCharge_Agent":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of charge","enum":["PERCENTAGE","REMAINDER"]},"percent":{"type":"number","description":"A percentage of the total stay amount for an early checkin or late checkout"}},"description":"A variable charge can be a fixed amount or a percentage."},"Beneficiary_Agent":{"required":["accountEmail","accountIdentifier","accountName","captureAmount","captureAmountRefundModifier","captureCurrency","displayAmount","displayAmountRefundModifier","displayCurrency","internalAmount","internalAmountRefundModifier","internalCurrency","netCaptureAmount","netDisplayAmount","netInternalAmount","netSourceAmount","netSupplierAmount","sourceAmount","sourceAmountRefundModifier","sourceCurrency","supplierAmount","supplierAmountRefundModifier","supplierCurrency","type"],"type":"object","properties":{"accountIdentifier":{"type":"string","description":"accountIdentifier of beneficiary that can map to an account with us","example":"account-1"},"accountName":{"type":"string","description":"accountName of beneficiary that can map to an account with us","example":"Account 1"},"accountEmail":{"type":"string","description":"accountEmail of beneficiary that can map to an account with us","example":"[email protected]"},"accountUrl":{"type":"string","description":"accountUrl of beneficiary that can map to an account with us","example":"https://some.url"},"type":{"type":"string","description":"The type of beneficiary payment.","enum":["COMMISSION","PLATFORM_FEE","TRIP_PAY","SALE"]},"amountDue":{"$ref":"#/components/schemas/BeneficiaryCharge_Agent"},"sourceCurrency":{"type":"string","description":"The source currency","example":"USD"},"displayCurrency":{"type":"string","description":"The display currency","example":"USD"},"supplierCurrency":{"type":"string","description":"The supplier currency","example":"USD"},"internalCurrency":{"type":"string","description":"The internal currency","example":"USD"},"captureCurrency":{"type":"string","description":"The capture currency","example":"USD"},"sourceAmount":{"minimum":0,"type":"number","description":"Amount in source currency","example":50},"displayAmount":{"minimum":0,"type":"number","description":"Amount in display currency","example":50},"supplierAmount":{"minimum":0,"type":"number","description":"Amount in supplier currency","example":50},"internalAmount":{"minimum":0,"type":"number","description":"Amount in internal currency","example":50},"captureAmount":{"minimum":0,"type":"number","description":"Amount in capture currency","example":50},"sourceAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original source amount after a refund occurred","example":5},"displayAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original display amount after a refund occurred","example":5},"supplierAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original supplier amount after a refund occurred","example":5},"internalAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original internal amount after a refund occurred","example":5},"captureAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original capture amount after a refund occurred","example":5},"pendingRefunds":{"type":"array","items":{"$ref":"#/components/schemas/PendingRefund_Agent"}},"netSourceAmount":{"minimum":0,"type":"number","description":"Source amount minus source modifier."},"netDisplayAmount":{"minimum":0,"type":"number","description":"Display amount minus display modifier."},"netSupplierAmount":{"minimum":0,"type":"number","description":"Supplier amount minus supplier modifier."},"netInternalAmount":{"minimum":0,"type":"number","description":"Internal amount minus internal modifier."},"netCaptureAmount":{"minimum":0,"type":"number","description":"Capture amount minus capture modifier."},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Place to add more data related to the beneficiary."},"description":"Place to add more data related to the beneficiary."}},"description":"Beneficiary is a registered account with rights to compensation within a booking."},"BookingAncillary_Agent":{"required":["address","attendees","commission","commissionable","contact","endDate","hotelIdentifier","identifier","imageIdentifier","imageUrl","localizedDescription","localizedName","mandatory","name","price","pricingType","startDate","transactionalTravelInventoryIdentifier","type","typeIdentifier"],"type":"object","properties":{"identifier":{"type":"string","description":"Ancillary identifier","format":"uuid"},"hotelIdentifier":{"type":"string","description":"Hotel identifier","format":"uuid"},"typeIdentifier":{"type":"string","description":"Travel inventory identifier","format":"uuid"},"transactionalTravelInventoryIdentifier":{"type":"string","description":"Travel inventory identifier","format":"uuid"},"name":{"type":"string","description":"Name of inventory","example":"Place 1"},"pricingType":{"type":"string","description":"Pricing type","example":"PER_USE","enum":["PER_STAY","PER_DAY","PER_NIGHT","PER_USE","PER_HOUR","PER_PERSON","PER_PERSON_PER_NIGHT","PER_PERSON_PER_HOUR","PER_ADULT","PER_ADULT_PER_NIGHT","PER_ADULT_PER_HOUR","PER_CHILD","PER_CHILD_PER_NIGHT","PER_CHILD_PER_HOUR"]},"type":{"type":"string","description":"Inventory type","example":"PLACE","enum":["ROOM_TYPE_ANCILLARY","ADD_ON","MEETING_ROOM","SPA","RESTAURANT","ACTIVITY","ATTRACTION","PLACE"]},"price":{"$ref":"#/components/schemas/LocalizedPrice_Agent"},"startDate":{"type":"string","description":"Date start time when reservation was made for.","format":"date-time"},"endDate":{"type":"string","description":"Date end time when reservation was made for.","format":"date-time"},"attendees":{"type":"integer","description":"Number of guests that are part of this reservation.","format":"int32","example":2,"default":1},"imageIdentifier":{"type":"string","description":"Cloudinary image identifier","example":"cloudinary-image-1"},"imageUrl":{"type":"string","description":"Absolute URL to image of inventory","example":"https://path.to.image.com/this-is-me.jpg"},"localizedName":{"type":"string","description":"Name of travel inventory in traveler language (if available). Defaults to English.","example":"Plass 1"},"localizedDescription":{"type":"string","description":"Description of travel inventory in traveler language (if available). Defaults to English.","example":"place-1"},"contact":{"$ref":"#/components/schemas/Contact_Agent"},"address":{"$ref":"#/components/schemas/Address_Agent"},"commissionable":{"type":"boolean"},"mandatory":{"type":"boolean"},"commission":{"type":"number","format":"float"}},"description":"Add-on records."},"BookingConfirmations_Agent":{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/BookingView_Agent"}},"pointsToBeEarned":{"type":"integer","format":"int64"},"userSpecifiedCurrencyTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"sourceTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"}}},"BookingContractItem_Agent":{"required":["beneficiaryList","captureAmount","captureCurrency","descriptionInEnglish","displayAmount","displayCurrency","internalAmount","internalCurrency","itinerary","nameInEnglish","netCaptureAmount","netDisplayAmount","netInternalAmount","netSourceAmount","netSupplierAmount","payable","pricingType","sourceAmount","sourceCurrency","supplierAmount","supplierCurrency","supplierItemBookingCode","type","user"],"type":"object","properties":{"supplierItemBookingCode":{"type":"string","description":"Booking code identifying the supplier line item.","example":"TP-ASDFG1234"},"user":{"$ref":"#/components/schemas/GuestUser_Agent"},"nameInEnglish":{"type":"string","description":"Name of item in English included in booking.","example":"Deluxe King"},"descriptionInEnglish":{"type":"string","description":"Short description in English of item included in booking.","example":"This is the best deluxe king that money can buy."},"itinerary":{"$ref":"#/components/schemas/SimpleDateTimeItinerary_Agent"},"pricingType":{"type":"string","description":"How to calculate the total amount.","enum":["PER_STAY","PER_DAY","PER_NIGHT","PER_USE","PER_HOUR","PER_PERSON","PER_PERSON_PER_NIGHT","PER_PERSON_PER_HOUR","PER_ADULT","PER_ADULT_PER_NIGHT","PER_ADULT_PER_HOUR","PER_CHILD","PER_CHILD_PER_NIGHT","PER_CHILD_PER_HOUR"]},"type":{"type":"string","description":"Type of item this is.","example":"LODGING","enum":["LODGING","RAIL","AIR","CAR","CRUISE","PACKAGE","ADD_ON","RENTAL","EXPERIENCE","ANCILLARY_BOOKING","ANCILLARY_FEE"]},"beneficiaryList":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Beneficiary_Agent"}},"payable":{"type":"string","description":"When to charge for this item.","example":"PREPAY","enum":["IMMEDIATE","ARRIVAL","DEPARTURE","AGENT"]},"policy":{"$ref":"#/components/schemas/SupplierContractItemPolicy_Agent"},"externalIdentifier":{"type":"string","description":"Optional externalIdentifier to remote inventory.","example":"room-type-1"},"tokensEarned":{"type":"integer","description":"Tokens minted for this item","format":"int64","example":12},"dailyRateList":{"type":"array","items":{"$ref":"#/components/schemas/DailyRate_Agent"}},"cancelled":{"type":"boolean","description":"Optional geoname externalIdentifier to remote inventory."},"sourceCurrency":{"type":"string","description":"The source currency","example":"USD"},"displayCurrency":{"type":"string","description":"The display currency","example":"USD"},"supplierCurrency":{"type":"string","description":"The supplier currency","example":"USD"},"internalCurrency":{"type":"string","description":"The internal currency","example":"USD"},"captureCurrency":{"type":"string","description":"The capture currency","example":"USD"},"sourceAmount":{"minimum":0,"type":"number","description":"The total initial price as quoted in the original TripPay contract."},"displayAmount":{"minimum":0,"type":"number","description":"The total display price."},"supplierAmount":{"minimum":0,"type":"number","description":"The total supplier price."},"internalAmount":{"minimum":0,"type":"number","description":"The total internal price."},"captureAmount":{"minimum":0,"type":"number","description":"The total capture price."},"sourceAmountRefundModifier":{"minimum":0,"type":"number","description":"The source amount still due after a partial refund occurs."},"displayAmountRefundModifier":{"minimum":0,"type":"number","description":"The display amount still due after a partial refund occurs."},"supplierAmountRefundModifier":{"minimum":0,"type":"number","description":"The supplier amount still due after a partial refund occurs."},"internalAmountRefundModifier":{"minimum":0,"type":"number","description":"The internal amount still due after a partial refund occurs."},"captureAmountRefundModifier":{"minimum":0,"type":"number","description":"The capture amount still due after a partial refund occurs."},"netSourceAmount":{"minimum":0,"type":"number","description":"Source amount minus source modifier."},"netDisplayAmount":{"minimum":0,"type":"number","description":"Display amount minus display modifier."},"netSupplierAmount":{"minimum":0,"type":"number","description":"Supplier amount minus supplier modifier."},"netInternalAmount":{"minimum":0,"type":"number","description":"Internal amount minus internal modifier."},"netCaptureAmount":{"minimum":0,"type":"number","description":"Capture amount minus capture modifier."},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Place to add more data related to the booking contract item."},"description":"Place to add more data related to the booking contract item."},"cancellableBySupplier":{"type":"boolean","description":"Whether the booking can still be cancelled by the supplier. A supplier cancellation overrides the refundable"},"cancellableByTraveler":{"type":"boolean","description":"Whether the booking can still be cancelled by the traveller."},"cancellableWithNoCharges":{"type":"boolean","description":"Whether the booking can still be cancelled and whether cancellation charges might still occur."},"cancellableWithPotentialCharges":{"type":"boolean","description":"Whether the booking can still be cancelled and whether cancellation charges might still occur."}},"description":"Returns the lodging item only."},"BookingContractPaymentDetails_Agent":{"required":["acquirerIdentifier","chargeIdentifier","customerIdentifier","status","transactionIdentifier","vendor","vendorSpecific"],"type":"object","properties":{"acquirerIdentifier":{"type":"string","description":"Unique acquiring identifier. Blank for agent payment","example":"stripe-world"},"vendor":{"type":"string","description":"Name of acquiring vendor","example":"STRIPE","enum":["STRIPE","AGENT","NMI","WISE"]},"transactionIdentifier":{"type":"string","description":"Unique transaction id from the vendor. Agent adds their transaction identifier.","example":"tx-1"},"customerIdentifier":{"type":"string","description":"Unique customer id from the vendor. Agent adds their own customer identifier.","example":"customer-1"},"chargeIdentifier":{"type":"string","description":"Unique charge id from the vendor..","example":"charge-1"},"status":{"type":"string","description":"Unique transaction id from the vendor upon a successful sale. Agent adds their transaction identifier.","example":"INITIALIZED","enum":["INITIALIZED","PROCESSING","SUCCEEDED","FAILED"]},"agentInvoicedDate":{"type":"string","description":"The date/time the invoice was generated","format":"date-time"},"agentInvoiceIdentifier":{"type":"string","description":"The specific invoice this booking was registered on","example":"invoice-1"},"redirectUrl":{"type":"string","description":"Where to redirect to after payment [in-]complete"},"fees":{"type":"array","items":{"$ref":"#/components/schemas/Fee_Agent"}},"vendorSpecific":{"type":"object","additionalProperties":{"type":"string","description":"Vendor specific values that are returned in a successful response"},"description":"Vendor specific values that are returned in a successful response"}},"description":"Payment details the merchant provided us at the time of payment."},"BookingContract_Agent":{"required":["captureAmount","captureCurrency","capturePriceQuote","displayAmount","displayCurrency","displayPriceQuote","federatedOrganizationIdentifier","federatedOrganizationName","identifier","internalAmount","internalCurrency","internalPriceQuote","ipAddress","itemList","payment","sourceAmount","sourceCurrency","sourceUrl","supplierAmount","supplierCurrency","supplierIdentifier","supplierName","supplierPriceQuote","traceId","user"],"type":"object","properties":{"bookingContractIdentifier":{"type":"string","description":"Document UUID","format":"uuid"},"createdDate":{"type":"string","description":"Datetime this record was first created","format":"date-time"},"lastUpdate":{"type":"string","description":"Datetime this record was last updated","format":"date-time"},"federatedOrganizationIdentifier":{"type":"string","description":"The auth realm owner ID","example":"owner-1"},"federatedOrganizationName":{"type":"string","description":"The auth realm owner name","example":"Wink"},"user":{"$ref":"#/components/schemas/AuthenticatedUser_Agent"},"ipAddress":{"type":"string","description":"Caller's IP address","example":"111.222.333.444"},"traceId":{"type":"string","description":"Way to track which booking contracts were made together","example":"T-123456"},"sourceUrl":{"type":"string","description":"Where did the booking occur","example":"https://www.traveliko.com"},"identifier":{"type":"string","description":"Unique identifier used to track the contract. Create a UUID for this purpose.","format":"uuid"},"supplierIdentifier":{"type":"string","description":"Supplier identifier","format":"uuid"},"supplierName":{"type":"string","description":"Supplier name","example":"Supplier One"},"displayPriceQuote":{"$ref":"#/components/schemas/Quote_Agent"},"supplierPriceQuote":{"$ref":"#/components/schemas/Quote_Agent"},"internalPriceQuote":{"$ref":"#/components/schemas/Quote_Agent"},"capturePriceQuote":{"$ref":"#/components/schemas/Quote_Agent"},"itemList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Holds one booking line item for a specific supplier.","items":{"$ref":"#/components/schemas/BookingContractItem_Agent"}},"externalSupplierIdentifier":{"type":"string","description":"Contract creator can choose to geoname this record with her own identifier","example":"supplier-a"},"externalSupplierBookingCode":{"type":"string","description":"External booking code generated by the affiliate","example":"external-booking-code-1"},"payment":{"$ref":"#/components/schemas/BookingContractPaymentDetails_Agent"},"cancelled":{"type":"boolean","description":"Optional geoname externalIdentifier to remote inventory.","example":false,"default":false},"cancelledOn":{"type":"string","description":"When the booking was cancelled.","format":"date-time"},"canceller":{"type":"string","description":"Type of entity that cancelled the booking.","enum":["SALES_CHANNEL","SUPPLIER","TRAVELER","ACQUIRER","ADMINISTRATOR"]},"cancellationType":{"type":"string","description":"Reason type.","enum":["DUPLICATE","CANCELLATION","NO_SHOW","CC_INVALID","CC_INSUFFICIENT","DISCRETIONARY"]},"cancellerUserIdentifier":{"type":"string","description":"User identifier that cancelled the entity."},"cancelReason":{"type":"string","description":"Reason for cancellation."},"fundsAddedToLedger":{"type":"boolean","description":"Whether the contract has been added to the ledger; ready for payout.","example":false},"fundsProcessed":{"type":"boolean","description":"Whether a funds transfer request has been created for this booking.","example":false},"refunds":{"type":"array","description":"An optional list of refunds that occurred with this booking. If the refund amount(s) is the same as the total price, the booking also gets cancelled.","items":{"$ref":"#/components/schemas/Refund_Agent"}},"payouts":{"type":"array","description":"An optional list of refunds that occurred with this booking. If the refund amount(s) is the same as the total price, the booking also gets cancelled.","items":{"$ref":"#/components/schemas/Payout_Agent"}},"sourceCurrency":{"type":"string","description":"The source currency","example":"USD"},"displayCurrency":{"type":"string","description":"The display currency","example":"USD"},"supplierCurrency":{"type":"string","description":"The supplier currency","example":"USD"},"internalCurrency":{"type":"string","description":"The internal currency","example":"USD"},"captureCurrency":{"type":"string","description":"The capture currency","example":"USD"},"sourceAmount":{"minimum":0,"type":"number","description":"The total initial price as quoted in the original TripPay contract."},"displayAmount":{"minimum":0,"type":"number","description":"The total display price."},"supplierAmount":{"minimum":0,"type":"number","description":"The total supplier price."},"internalAmount":{"minimum":0,"type":"number"},"captureAmount":{"minimum":0,"type":"number","description":"The total capture price."},"sourceAmountRefundModifier":{"type":"number","description":"The source amount still due after a partial refund occurs."},"displayAmountRefundModifier":{"type":"number","description":"The display amount still due after a partial refund occurs."},"supplierAmountRefundModifier":{"type":"number","description":"The supplier amount still due after a partial refund occurs."},"internalAmountRefundModifier":{"type":"number","description":"The internal amount still due after a partial refund occurs."},"captureAmountRefundModifier":{"type":"number","description":"The capture amount still due after a partial refund occurs."},"netSourceAmount":{"type":"number","description":"The total initial price as quoted in the original TripPay contract."},"netDisplayAmount":{"type":"number","description":"The total display price."},"netSupplierAmount":{"type":"number","description":"The total supplier price."},"netInternalAmount":{"type":"number"},"netCaptureAmount":{"type":"number","description":"The total capture price."},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Place to add more data related to the booking contract."},"description":"Place to add more data related to the booking contract."},"netCommissionableTotalSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netCommissionableTotalCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netCommissionableTotalDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netCommissionableTotalSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netCommissionableTotalInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesAndCommissionsSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesAndCommissionsCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesAndCommissionsDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesAndCommissionsSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesAndCommissionsInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalFeesInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalTripPayFeeSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalTripPayFeeCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalTripPayFeeDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalTripPayFeeSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalTripPayFeeInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalSalesSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalSalesCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalSalesDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalSalesSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalSalesInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"commissionableTotalSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"commissionableTotalCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"commissionableTotalDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"commissionableTotalSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"commissionableTotalInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesAndCommissionsSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesAndCommissionsCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesAndCommissionsDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesAndCommissionsSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesAndCommissionsInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalFeesInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalTripPayFeeSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalTripPayFeeCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalTripPayFeeDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalTripPayFeeSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalTripPayFeeInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalSalesSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalSalesCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalSalesDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalSalesSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalSalesInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"fundsAvailableDate":{"type":"string","description":"Returns the date the funds will be released to the customer.","format":"date"},"totalFeesInPercentWithRefund":{"type":"number","description":"All amounts that are not of type SALE","format":"float"},"totalFeesInPercent":{"type":"number","description":"All amounts that are not of type SALE before a refund was applied","format":"float"},"totalTripPayFeeInPercentWithRefund":{"type":"number","description":"All amounts that are not of type SALE","format":"float"},"totalTripPayFeeInPercent":{"type":"number","description":"All amounts that are not of type SALE before a refund was applied","format":"float"},"totalCommissionsInPercentWithRefund":{"type":"number","description":"All amounts that are not of type SALE","format":"float"},"totalCommissionsInPercent":{"type":"number","description":"All amounts that are not of type SALE before a refund was applied","format":"float"},"totalFeesAndCommissionsInPercentWithRefund":{"type":"number","description":"All amounts that are not of type SALE","format":"float"},"totalFeesAndCommissionsInPercent":{"type":"number","description":"All amounts that are not of type SALE before a refund was applied","format":"float"},"originalFeesInPercent":{"type":"number","description":"All amounts that are not of type SALE before a refund was applied"},"originalCommissionsInPercent":{"type":"number","description":"All amounts that are not of type SALE before a refund was applied"},"netTotalCustomersSourceAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalCustomersCaptureAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalCustomersDisplayAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalCustomersSupplierAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"netTotalCustomersInternalAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"hasRefunds":{"type":"boolean","description":"Indicates whether any refund in any state is present."},"hasSuccessfulRefunds":{"type":"boolean","description":"Indicates whether a successful refund is present."},"hasPendingRefunds":{"type":"boolean","description":"Indicates whether a pending refund is present."},"hasFailedRefunds":{"type":"boolean","description":"Indicates whether a failed refund is present."},"platformIdentifier":{"type":"string","description":"Returns the account identifier for the beneficiary taking a platform fee"},"totalFundsGroupedByBeneficiary":{"type":"array","description":"Returns all the beneficiaries in this contract with their total amounts","items":{"$ref":"#/components/schemas/Beneficiary_Agent"}},"totalTokensEarned":{"type":"integer","description":"Total amount of tokens minted on this contract.","format":"int64"},"lodging":{"$ref":"#/components/schemas/BookingContractItem_Agent"},"cancellableBySupplier":{"type":"boolean","description":"Whether the booking can still be cancelled completely by the supplier."},"cancellableByTraveler":{"type":"boolean","description":"Whether the booking can still be cancelled completely by the traveller."},"cancellableWithNoCharges":{"type":"boolean","description":"Whether the cancellation comes at no cost to the traveler."},"isCancellableWithPotentialCharges":{"type":"boolean","description":"Whether a cancellation comes with partial charges. I.e. Only some of the items in contract are not fully refundable.","writeOnly":true}},"description":"Booking contract created by TripPay"},"BookingUser_Agent":{"required":["email","firstName","lastName"],"type":"object","properties":{"userIdentifier":{"type":"string","description":"User identifier","format":"uuid"},"firstName":{"type":"string","description":"First name","example":"John"},"lastName":{"type":"string","description":"Last name","example":"Smith"},"email":{"type":"string","description":"Email","format":"email","example":"[email protected]"},"telephone":{"type":"string","description":"Telephone","example":"+1 212 555 1212"},"fullName":{"type":"string","description":"Full name","readOnly":true,"example":"John Smith"}},"description":"User details for the authenticated person that made the booking."},"BookingView_Agent":{"required":["booking"],"type":"object","properties":{"id":{"type":"string","description":"Document UUID","example":"doc-1"},"createdDate":{"type":"string","description":"Datetime this record was first created","format":"date-time"},"lastUpdate":{"type":"string","description":"Datetime this record was last updated","format":"date-time"},"version":{"type":"integer","description":"Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.","format":"int64","example":12},"booking":{"$ref":"#/components/schemas/Booking_Agent"}}},"Booking_Agent":{"required":["address","bookingCode","contactInfo","date","emailHeaderLogoUrl","engineConfiguration","groupIdentifier","hotel","hotelImageUrl","identifier","roomImageUrl","serverUrl","user","userSession"],"type":"object","properties":{"creation":{"type":"string","description":"Communicates whether the booking was created normally or if it failed or was just for testing.","example":"TEST","default":"NORMAL","enum":["NORMAL","TEST","FAILED"]},"date":{"type":"string","description":"Date and time the booking was made.","format":"date-time"},"groupIdentifier":{"type":"string","description":"Unique record identifier for the collection of bookings that were made at the same time.","format":"uuid"},"identifier":{"type":"string","description":"Unique record identifier","format":"uuid"},"engineConfiguration":{"$ref":"#/components/schemas/EngineConfigurationBookingReport_Agent"},"bookingCode":{"type":"string","description":"Unique user-friendly booking geoname. This code should be used when corresponding with travelers.","example":"ABC1234"},"user":{"$ref":"#/components/schemas/BookingUser_Agent"},"userSession":{"$ref":"#/components/schemas/UserSession_Agent"},"serverUrl":{"type":"string","description":"The URL the booking occurred"},"contactInfo":{"$ref":"#/components/schemas/Contact_Agent"},"address":{"$ref":"#/components/schemas/Address_Agent"},"socials":{"type":"array","description":"List of all social network account property has for the traveler to get in touch.","items":{"$ref":"#/components/schemas/Social_Agent"}},"review":{"$ref":"#/components/schemas/Review_Agent"},"emailHeaderLogoUrl":{"type":"string","description":"Full url of the image logo optimized for emails"},"logoIdentifier":{"type":"string","description":"Logo cloudinary identifier for potential reuse"},"hotel":{"$ref":"#/components/schemas/HotelOnMap_Agent"},"roomStay":{"$ref":"#/components/schemas/RoomStay_Agent"},"specialRequests":{"type":"string","description":"Free text where the traveler can add a message to the property."},"comment":{"type":"string","description":"Internal comment field the payment can add and make available to channel manager partners."},"earlyCheckInCharge":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"lateCheckOutCharge":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"earlyCheckInChargePercent":{"type":"number","description":"Early check-in charge calculated in percent of first room night price.","format":"float","example":0.05},"lateCheckOutChargePercent":{"type":"number","description":"Early check-in charge calculated in percent of first room night price.","format":"float","example":0.05},"hotelImageUrl":{"type":"string","description":"Absolute URL of hotel image that can be used as-is","example":"https://path.to/property-image.jpg"},"roomImageUrl":{"type":"string","description":"Absolute URL of room image that can be used as-is","example":"https://path.to/room-image.jpg"},"commissionList":{"type":"array","description":"List of all travel inventory entries that are due a commission to the affiliate.","items":{"$ref":"#/components/schemas/CommissionableEntry_Agent"}},"ancillaryList":{"type":"array","items":{"$ref":"#/components/schemas/BookingAncillary_Agent"}},"bookingContract":{"$ref":"#/components/schemas/BookingContract_Agent"},"staticMapImageUrl":{"type":"string","description":"Url of map image that can be sent via email","example":"https://path.to/room-image.jpg"},"staticMapUrl":{"type":"string","description":"Url of map image location on Google Maps","example":"https://path.to/room-image.jpg"},"status":{"type":"string","description":"Convenience data point to show which status the booking currently has.","example":"ACTIVE","enum":["CANCELLED_BY_HOTEL","CANCELLED_BY_GUEST","CANCELLED_BY_ADMIN","CANCELLED_BY_SALES_CHANNEL","PAST","FUTURE","CANCELLED_BY_ACQUIRER","ACTIVE","FAILED"]},"fullAddress":{"type":"string","description":"Convenience data point to return the full hotel address.","example":"204 At home lane, Singapore, Singapore 224333"},"restaurants":{"type":"array","description":"Restaurant reservation records.","items":{"$ref":"#/components/schemas/BookingAncillary_Agent"}},"meetingRooms":{"type":"array","description":"Meeting room reservation records.","items":{"$ref":"#/components/schemas/BookingAncillary_Agent"}},"spas":{"type":"array","description":"Spa reservation records.","items":{"$ref":"#/components/schemas/BookingAncillary_Agent"}},"activities":{"type":"array","description":"Activity reservation records.","items":{"$ref":"#/components/schemas/BookingAncillary_Agent"}},"attractions":{"type":"array","description":"Attraction reservation records.","items":{"$ref":"#/components/schemas/BookingAncillary_Agent"}},"places":{"type":"array","description":"Place reservation records.","items":{"$ref":"#/components/schemas/BookingAncillary_Agent"}},"roomTypeAncillaries":{"type":"array","description":"Room type ancillary records.","items":{"$ref":"#/components/schemas/BookingAncillary_Agent"}},"addOns":{"type":"array","description":"Add-on records.","items":{"$ref":"#/components/schemas/BookingAncillary_Agent"}},"rateSource":{"type":"string","description":"Rate origin. This is usually the property channel manager.","example":"SITEMINDER"},"cancellableBySupplier":{"type":"boolean","description":"Whether the booking can still be cancelled completely by the supplier."},"cancellableByTraveler":{"type":"boolean","description":"Whether the booking can still be cancelled completely by the traveller."},"hasAddOns":{"type":"boolean","description":"Convenience data point to check if any add-on offers are in this booking.","example":true},"hasRoomTypeAncillaries":{"type":"boolean","description":"Convenience data point to check if any room type ancillaries are in this booking.","example":true},"hasFood":{"type":"boolean","description":"Convenience data point to check if any food is included in this booking.","example":true},"hasRestaurants":{"type":"boolean","description":"Convenience data point to check if any restaurant reservations are included in this booking.","example":true},"hasMeetingRooms":{"type":"boolean","description":"Convenience data point to check if any meeting room reservations are included in this booking.","example":true},"hasSpas":{"type":"boolean","description":"Convenience data point to check if any spa reservations are included in this booking.","example":true},"hasActivities":{"type":"boolean","description":"Convenience data point to check if any activity reservations are included in this booking.","example":true},"hasAttractions":{"type":"boolean","description":"Convenience data point to check if any attractions reservations are included in this booking.","example":true},"hasPlaces":{"type":"boolean","description":"Convenience data point to check if any place reservations are included in this booking.","example":true},"reportingDailyRateList":{"type":"array","items":{"$ref":"#/components/schemas/ReportingDailyRate_Agent"}},"reportingAncillaryList":{"type":"array","items":{"$ref":"#/components/schemas/ReportingAncillary_Agent"}},"reportingExtraChargeList":{"type":"array","items":{"$ref":"#/components/schemas/ReportingExtraCharge_Agent"}},"hasBreakfast":{"type":"boolean","description":"Convenience data point to get to breakfast quickly.","example":true},"hasBrunch":{"type":"boolean","description":"Convenience data point to get to brunch quickly.","example":true},"hasLunch":{"type":"boolean","description":"Convenience data point to get to lunch quickly.","example":true},"hasDinner":{"type":"boolean","description":"Convenience data point to get to dinner quickly.","example":true},"hasAllInclusive":{"type":"boolean","description":"Convenience data point to get to all-inclusive quickly.","example":true},"hasAllInclusivePlusAlcohol":{"type":"boolean","description":"Convenience data point to get to all-inclusive with alcohol quickly.","example":true}},"description":"Booking data object"},"CancellationPolicyException_Agent":{"required":["cancellationPolicy","cancellationPolicyIdentifier","endDate","startDate"],"type":"object","properties":{"cancellationPolicyIdentifier":{"type":"string","description":"Cancellation policy","format":"uuid"},"cancellationPolicy":{"$ref":"#/components/schemas/CancellationPolicy_Agent"},"startDate":{"type":"string","description":"Start date for when this cancellation policy should start to override the default cancellation policy.","format":"date"},"endDate":{"type":"string","description":"End date for when this cancellation policy should end overriding the default cancellation policy.","format":"date"}}},"CancellationPolicyExceptions_Agent":{"required":["list"],"type":"object","properties":{"list":{"type":"array","description":"List of cancellation policy exceptions","items":{"$ref":"#/components/schemas/CancellationPolicyException_Agent"}}},"description":"Allows a property to dynamically use another cancellation policy for a specific date range"},"CancellationPolicy_Agent":{"required":["hotelIdentifier","identifier","refundable"],"type":"object","properties":{"identifier":{"type":"string","description":"Unique cancellation policy identifier","format":"uuid"},"hotelIdentifier":{"type":"string","description":"Property this cancellation is associated with","format":"uuid"},"refundable":{"type":"boolean","description":"Whether this cancellation policy is refundable or not","example":false,"default":false},"advanceCancellationFreeOfCharge":{"type":"string","description":"When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.","example":"UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL","enum":["UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL","UNTIL_FOURTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL","ONE_DAY_BEFORE_ARRIVAL","TWO_DAYS_BEFORE_ARRIVAL","THREE_DAYS_BEFORE_ARRIVAL","FIVE_DAYS_BEFORE_ARRIVAL","SEVEN_DAYS_BEFORE_ARRIVAL","FOURTEEN_DAYS_BEFORE_ARRIVAL","TWENTYONE_DAYS_BEFORE_ARRIVAL","THIRTY_DAYS_BEFORE_ARRIVAL","FOURTY_TWO_DAYS_BEFORE_ARRIVAL","SIXTY_DAYS_BEFORE_ARRIVAL"]},"refundableCancellationCharge":{"type":"string","description":"If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.","example":"FIFTY_PERCENT","enum":["FIRST_NIGHT","THIRTY_PERCENT","FIFTY_PERCENT","SIXTY_PERCENT","SEVENTY_PERCENT","NINENTY_PERCENT","ONE_HUNDRED_PERCENT"]},"noShowCharge":{"type":"string","description":"In case the 'Refundable cancellation charge' is set, a different no show charge can be applied.","example":"SAME_AS_CANCELLATION_FEE","enum":["SAME_AS_CANCELLATION_FEE","ONE_HUNDRED_PERCENT_OF_TOTAL_CHARGE"]},"nonRefundableCancellationCharge":{"type":"string","description":"When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.","example":"SEVENTY_PERCENT","enum":["FIRST_NIGHT","TEN_PERCENT","THIRTY_PERCENT","FIFTY_PERCENT","SEVENTY_PERCENT"]},"nonRefundableDeadline":{"type":"string","description":"The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.","example":"SEVEN_DAYS_BEFORE_ARRIVAL","enum":["ONE_DAY_BEFORE_ARRIVAL","TWO_DAYS_BEFORE_ARRIVAL","THREE_DAYS_BEFORE_ARRIVAL","FIVE_DAYS_BEFORE_ARRIVAL","SEVEN_DAYS_BEFORE_ARRIVAL","FOURTEEN_DAYS_BEFORE_ARRIVAL","TWENTYONE_DAYS_BEFORE_ARRIVAL","THIRTY_DAYS_BEFORE_ARRIVAL","FOURTY_TWO_DAYS_BEFORE_ARRIVAL","SIXTY_DAYS_BEFORE_ARRIVAL"]},"nonRefundableAfterDeadlineCancellationCharge":{"type":"string","description":"If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.","example":"ONE_HUNDRED_PERCENT","enum":["FIRST_NIGHT","TEN_PERCENT","THIRTY_PERCENT","FIFTY_PERCENT","SEVENTY_PERCENT","ONE_HUNDRED_PERCENT"]},"policyCode":{"type":"string"}},"description":"Based on the itinerary, the cancellation policy could be taken directly from the rate plan or it could be a policy exception also listed on the rate plan"},"CommissionableEntry_Agent":{"required":["commissionPercent","identifier","name","type"],"type":"object","properties":{"name":{"type":"string"},"identifier":{"type":"string"},"type":{"type":"string","enum":["GUEST_ROOM","ADD_ON","MEETING_ROOM","RESTAURANT","SPA","ATTRACTION","PLACE","ACTIVITY"]},"commissionPercent":{"type":"number","format":"float"}},"description":"List of all travel inventory entries that are due a commission to the affiliate."},"Contact_Agent":{"type":"object","properties":{"firstName":{"type":"string","description":"Contact first name","example":"John"},"lastName":{"type":"string","description":"Contact last name","example":"Smith"},"email":{"type":"string","description":"Contact E-mail","example":"[email protected]"},"secondaryEmail":{"type":"string","description":"Contact secondary Email","example":"[email protected]"},"phoneNumber":{"type":"string","description":"Contact phone number","example":"+12125551212"},"fullName":{"type":"string","description":"First and last name","readOnly":true,"example":"John Smith"},"summary":{"type":"string","description":"Summary","readOnly":true,"example":"John Smith ([email protected] / +12125551212)"}},"description":"Array of emergency contact information for the customer"},"Country_Agent":{"type":"object","properties":{"iso":{"type":"string","description":"ISO code","example":"US"},"name":{"type":"string","description":"Country name","example":"United States"},"capital":{"type":"string","description":"Country capital","example":"Washington"},"continent":{"type":"string","description":"Continent code","example":"NA"},"currencyCode":{"type":"string","description":"Currency code","example":"USD"},"currencyName":{"type":"string","description":"Currency name","example":"Dollar"},"geoNameId":{"type":"string","description":"Country GeoNames identifier","example":"6252001"}},"description":"Country"},"DailyRate_Agent":{"required":["capturePrice","date","displayPrice","internalPrice","price","supplierPrice"],"type":"object","properties":{"date":{"type":"string","description":"The date this rate is applicable for.","format":"date","example":"2020-08-24"},"price":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"displayPrice":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"supplierPrice":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"internalPrice":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"capturePrice":{"$ref":"#/components/schemas/CustomMonetaryAmount"}},"description":"In case of LODGING, include daily rates"},"DowPatternGroup_Agent":{"type":"object","properties":{"mon":{"type":"boolean","description":"Set to `true` to enable Monday.","example":true},"tue":{"type":"boolean","description":"Set to `true` to enable Tuesday.","example":true},"wed":{"type":"boolean","description":"Set to `true` to enable Wednesday.","example":true},"thu":{"type":"boolean","description":"Set to `true` to enable Thursday.","example":true},"fri":{"type":"boolean","description":"Set to `true` to enable Friday.","example":true},"sat":{"type":"boolean","description":"Set to `true` to enable Saturday.","example":true},"sun":{"type":"boolean","description":"Set to `true` to enable Sunday.","example":true},"disabled":{"type":"boolean","description":"Convenience property to quickly determine if this existing object has any active days enabled.","example":true}}},"EngineConfigurationBookingReport_Agent":{"required":["identifier","name","ownerIdentifier","ownerName","subType","userIdentifier"],"type":"object","properties":{"identifier":{"type":"string","description":"Unique engine configuration identifier","format":"uuid"},"name":{"type":"string","description":"Engine configuration name","example":"Engine Configuration 1"},"userIdentifier":{"type":"string","description":"Authenticated user identifier","format":"uuid"},"ownerIdentifier":{"type":"string","description":"Engine configuration record creator identifier","format":"uuid"},"ownerName":{"type":"string","description":"Name of company owner.","example":"Travel Tech 1"},"subType":{"type":"string","description":"Sales channel sub-type.","example":"APPLICATION","enum":["DIRECT","APPLICATION","HOTEL","TRAVELIKO","CORPORATE","TRAVEL_AGENT","INFLUENCER","BLOGGER","DESTINATION","CHANNEL_MANAGER","PROPERTY_MANAGEMENT_SYSTEM","CENTRAL_RESERVATION_SYSTEM","GOOGLE_HOTEL_API","MANAGEMENT_COMPANY","CHAIN","BRAND","EVENT_ORGANIZER"]},"defaultCurrency":{"type":"string","description":"Control which currency your users see prices in initially.","example":"USD","default":"USD"},"defaultLanguage":{"type":"string","description":"Control which language your users see text in initially.","example":"en","default":"en"},"defaultLifestyle":{"type":"string","description":"Control which lifestyle contextx your users see initially.","example":"LIFESTYLE_HEALTH_FITNESS","enum":["LIFESTYLE_HEALTH_FITNESS","LIFESTYLE_RELAX","LIFESTYLE_ADULT_ONLY","LIFESTYLE_ADVENTURE","LIFESTYLE_BUSINESS","LIFESTYLE_LGBT","LIFESTYLE_SINGLE_PARENT","LIFESTYLE_SOLO_FEMALE","LIFESTYLE_BEAUTY","LIFESTYLE_FOODIE","LIFESTYLE_FAMILY","LIFESTYLE_ROMANCE","LIFESTYLE_COUPLE","LIFESTYLE_SOLO","LIFESTYLE_BACKPACKER","LIFESTYLE_SHOPPING","LIFESTYLE_SPORTS","LIFESTYLE_MOUNTAIN","LIFESTYLE_BEACH","LIFESTYLE_CITY","LIFESTYLE_COUNTRY","LIFESTYLE_CULTURE","LIFESTYLE_ECO"]},"logos":{"type":"array","description":"Customize booking confirmation emails by adding a custom logo to your configuration.","items":{"$ref":"#/components/schemas/SimpleMultimedia_Agent"}},"hostedBookingEngineUrl":{"type":"string","description":"If you are self-hosting our booking engine, let us know where it is hosted. Note: This url needs to be secured with SSL.","example":"https://my.customtravelsite.com/book","default":"https://ota.wink.travel"},"selfHosted":{"type":"boolean","description":"Flag to indicate you are self-hosting our booking engine and not using our default booking engine url.","example":true,"default":false},"themeColors":{"$ref":"#/components/schemas/EngineConfigurationTheme_Agent"},"numberOfAdvanceDays":{"type":"integer","description":"You can control the initial itinerary date used to retrieve travel inventory prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long and how many days in advance (this field), of today's date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don't use either of these options, the itinerary will default to today's date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave `startDate` and `endDate` empty.","format":"int32","example":10},"numberOfStayDays":{"type":"integer","description":"You can control the initial itinerary date used to retrieve travel inventory prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long (this field) and how many days in advance, of today's date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don't use either of these options, the itinerary will default to today's date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave `startDate` and `endDate` empty.","format":"int32","example":2},"startDate":{"type":"string","description":"Set a fixed itinerary start date. ONLY populate this field if you want to fix the itinerary date. Also, leave `numberOfAdvanceDays` and `numberOfStayDays` empty.","format":"date","example":"2021-12-24"},"endDate":{"type":"string","description":"Set a fixed itinerary end date ONLY populate this field if you want to fix the itinerary date. Also, leave `numberOfAdvanceDays` and `numberOfStayDays` empty.","format":"date","example":"2021-12-31"},"roomConfigurations":{"type":"array","description":"Control how many adults / children will be staying and how many rooms. Defaults to: One room, two adults.","items":{"$ref":"#/components/schemas/RoomConfiguration_Agent"}},"useDays":{"type":"boolean","description":"if true, we use numberOfAdvanceDays / numberOfStayDays properties - false, we use startDate / endDate","example":true},"promotionalCodes":{"type":"array","description":"If you've received special promotional codes from suppliers to give to your audience, you can choose to bake these code directly into the price by entering them here.","example":["promo-1"],"items":{"type":"string","description":"If you've received special promotional codes from suppliers to give to your audience, you can choose to bake these code directly into the price by entering them here.","example":"[\"promo-1\"]"}},"sendBookingNotificationEmailsToProperty":{"type":"boolean","description":"An integrator can choose to disable outgoing emails to properties because they want to do that themselves.","example":true,"default":true},"sendBookingNotificationEmailsToBooker":{"type":"boolean","description":"An integrator can choose to disable outgoing emails to users because they want to do that themselves.","example":true,"default":true},"sendBookingNotificationEmailsToChannelManager":{"type":"boolean","description":"An integrator can choose to disable notifying the property's channel manager. Note: This should ONLY be done for testing.","example":true,"default":true},"wcBookClickAction":{"type":"string","description":"Action to complete once a user clicks on the CTA button on inventory.","example":"IBE_MODAL","enum":["FORWARD_TO_IBE","IBE_MODAL"]},"city":{"$ref":"#/components/schemas/GeoName_Agent"},"showUnavailableCard":{"type":"boolean","description":"Show unavailable inventory card when inventory not currently for sale. Otherwise, it displays a normal card but without the price."},"showRankings":{"type":"boolean","description":"Whether to display rankings (lifestyle, eco score and reviews) on hotel landing page."}},"description":"Which engine configuration record did the entity application used to facilitate in making this booking happen."},"EngineConfigurationTheme_Agent":{"type":"object","properties":{"primary":{"type":"string","description":"Primary color","example":"#dc3545","default":"#dc3545"},"secondary":{"type":"string","description":"Secondary color","example":"#6c757d","default":"#6c757d"},"success":{"type":"string","description":"Success color","example":"#28a745","default":"#28a745"},"danger":{"type":"string","description":"Danger color","example":"#dc3545","default":"#dc3545"},"warning":{"type":"string","description":"Warning color","example":"#ffc107","default":"#ffc107"},"info":{"type":"string","description":"Info color","example":"#17a2b8","default":"#17a2b8"},"light":{"type":"string","description":"Light color","example":"#f8f9fa","default":"#f8f9fa"},"dark":{"type":"string","description":"Dark color","example":"#343a40","default":"#343a40"},"body":{"type":"string","description":"Body color","example":"#212529","default":"#212529"},"muted":{"type":"string","description":"Muted color","example":"#6c757d","default":"#6c757d"},"white":{"type":"string","description":"White color","example":"#ffffff","default":"#ffffff"}},"description":"Choose how you want our web components to look and more closely match with your own site style."},"ExtraCharge_Agent":{"title":"Items","type":"object","properties":{"ratePlanLevelFee":{"$ref":"#/components/schemas/RatePlanLevelFee_Agent"},"unitPrice":{"$ref":"#/components/schemas/LocalizedPrice_Agent"},"price":{"$ref":"#/components/schemas/LocalizedPrice_Agent"}},"description":"List of extra charges that applies to the rate plan."},"ExtraCharges_Agent":{"type":"object","properties":{"items":{"title":"Items","type":"array","description":"List of extra charges that applies to the rate plan.","items":{"$ref":"#/components/schemas/ExtraCharge_Agent"}},"userSpecifiedCurrencyTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"sourceTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"internalTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"}},"description":"Rate plan-level extra charges"},"GeneralManager_Agent":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of GM currently managing the property.","example":"Jane Doe"},"image":{"$ref":"#/components/schemas/SimpleMultimedia_Agent"},"descriptions":{"type":"array","description":"Localized welcome message from GM.","items":{"$ref":"#/components/schemas/LocalizedDescription_Agent"}}},"description":"General manager related data."},"GeoJsonPoint_Agent":{"type":"object","properties":{"x":{"type":"number","format":"double"},"y":{"type":"number","format":"double"},"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"number","format":"double"}}},"description":"Geo-location point where inventory takes place. Defaults to location of property.","example":{"type":"POINT","coordinates":[100.5581533,13.7370197]}},"GeoName_Agent":{"type":"object","properties":{"geoNameId":{"type":"string","description":"GeoName identifier","example":"5128581"},"type":{"type":"string","description":"GeoName type","enum":["CITY","ISLAND","OTHER"]},"name":{"type":"string","description":"Name of city","example":"New York City"},"urlName":{"type":"string","description":"Url name","example":"new-york-city-united-states"},"asciiName":{"type":"string","description":"Ascii name of city","example":"New York City"},"location":{"$ref":"#/components/schemas/GeoJsonPoint_Agent"},"featureCode":{"type":"string"},"countryCode":{"type":"string"},"timezone":{"type":"string","description":"Timezone","example":"America/New_York"},"country":{"$ref":"#/components/schemas/Country_Agent"},"subCountry":{"$ref":"#/components/schemas/SubCountry_Agent"},"subSubCountry":{"$ref":"#/components/schemas/SubSubCountry_Agent"}},"description":"GeoNames have been created at [https://geonames.org](https://geonames.org) and contain geographical destinations we use as geoname data to associate travel inventory with a location."},"GuestRoom_Agent":{"required":["active","address","bathroomCount","bedroomConfigurationList","bookable","commissionable","composite","compositeCount","contact","descriptions","featuredInd","hotelIdentifier","identifier","includedAdultOccupancy","includedChildOccupancy","livingRoomCount","location","maxAdultOccupancy","maxChildOccupancy","maxCribs","maxOccupancy","maxRollaways","minOccupancy","multimedias","name","nonSmoking","pricePoint","proximityCode","quantity","roomArchitectureCode","roomCategory","roomClassificationCode","roomLocationCode","roomViewCode","sharedRoomInd","size"],"type":"object","properties":{"identifier":{"type":"string","description":"Unique record identifier","format":"uuid"},"hotelIdentifier":{"type":"string","description":"Hotel identifier.","format":"uuid"},"featuredInd":{"type":"boolean","description":"Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.","example":false},"lifestyleType":{"type":"string","description":"Indicate the type of lifestyle this inventory should be associated with.","example":"LIFESTYLE_HEALTH_FITNESS","enum":["LIFESTYLE_HEALTH_FITNESS","LIFESTYLE_RELAX","LIFESTYLE_ADULT_ONLY","LIFESTYLE_ADVENTURE","LIFESTYLE_BUSINESS","LIFESTYLE_LGBT","LIFESTYLE_SINGLE_PARENT","LIFESTYLE_SOLO_FEMALE","LIFESTYLE_BEAUTY","LIFESTYLE_FOODIE","LIFESTYLE_FAMILY","LIFESTYLE_ROMANCE","LIFESTYLE_COUPLE","LIFESTYLE_SOLO","LIFESTYLE_BACKPACKER","LIFESTYLE_SHOPPING","LIFESTYLE_SPORTS","LIFESTYLE_MOUNTAIN","LIFESTYLE_BEACH","LIFESTYLE_CITY","LIFESTYLE_COUNTRY","LIFESTYLE_CULTURE","LIFESTYLE_ECO"]},"location":{"$ref":"#/components/schemas/GeoJsonPoint_Agent"},"descriptions":{"type":"array","description":"Localized descriptions describing inventory.","items":{"$ref":"#/components/schemas/SimpleDescription_Agent"}},"multimedias":{"type":"array","description":"List of images / videos of inventory.","items":{"$ref":"#/components/schemas/SimpleMultimedia_Agent"}},"contact":{"$ref":"#/components/schemas/Contact_Agent"},"address":{"$ref":"#/components/schemas/Address_Agent"},"commissionable":{"type":"boolean","description":"Indicate whether sales channels receive commission for selling this inventory.","example":true,"default":true},"name":{"type":"string","description":"Internal name of inventory.","example":"Archery lesson"},"proximityCode":{"type":"string","description":"Supported OTA specification `PRX` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"1"},"sort":{"type":"integer","description":"Use this property to sort an inventory in a list of activities.","format":"int32","example":1},"minAgeAppropriateCode":{"type":"string","description":"Supported OTA specification `AQC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"1"},"bookable":{"type":"boolean","description":"Indicates if this inventory can be added to a booking or if it is read-only marketing material only.","example":true,"default":true},"active":{"type":"boolean","description":"Modify inventory availability with this flag.","example":true,"default":true},"disabilityFeatures":{"type":"array","description":"Supported OTA specification `PHY` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":["1"],"items":{"type":"string"}},"securityFeatures":{"type":"array","description":"Supported OTA specification `SEC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":["1"],"items":{"type":"string"}},"socials":{"type":"array","description":"Social network accounts for inventory (if applicable).","items":{"$ref":"#/components/schemas/Social_Agent"}},"pricePoint":{"type":"string","description":"Level of expensiveness.","example":"THREE","default":"THREE","enum":["HALF","ONE","ONE_HALF","TWO","TWO_HALF","THREE","THREE_HALF","FOUR","FOUR_HALF","FIVE"]},"recognitionList":{"type":"array","description":"Inventory-level recognition.","items":{"$ref":"#/components/schemas/TravelInventoryRecognition_Agent"}},"maxOccupancy":{"minimum":1,"type":"integer","description":"Maximum number of guest allowed in a room type.","format":"int32","example":2,"default":2},"minOccupancy":{"minimum":1,"type":"integer","description":"Minimum number of guests allowed in a room type.","format":"int32","example":1,"default":1},"quantity":{"minimum":1,"type":"integer","description":"Defines the number of rooms of this type","format":"int32","example":40},"nonSmoking":{"type":"boolean","description":"Non-smoking indicator","example":true},"bedroomConfigurationList":{"type":"array","description":"A room type can have more than one bed configuration.","items":{"$ref":"#/components/schemas/BedroomConfiguration_Agent"}},"size":{"minimum":1,"type":"number","description":"Number of square meters that defines the size of this room type.","format":"float","example":55},"maxAdultOccupancy":{"minimum":1,"type":"integer","description":"Maximum number of adults allowed in a room type.","format":"int32","example":1,"default":2},"maxChildOccupancy":{"minimum":0,"type":"integer","description":"Maximum number of children allowed in a room type.","format":"int32","example":0,"default":0},"bathroomCount":{"minimum":0,"type":"integer","description":"Number of bathrooms","format":"int32","example":0,"default":1},"livingRoomCount":{"minimum":0,"type":"integer","description":"Number of living rooms","format":"int32","example":0,"default":1},"maxRollaways":{"minimum":0,"type":"integer","description":"Maximum number of rollaway beds allowed in this room type.","format":"int32","example":0,"default":0},"roomCategory":{"type":"string","description":"Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"1"},"floor":{"type":"string","description":"Floor an which a room is located"},"roomLocationCode":{"type":"string","description":"Indicates the location of the room within the hotel structure. Typical values would be \"Near Exit\",\"Close to elevator\", \"Low Floor\" or \"High Floor\". Supported OTA specification `RLT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"1"},"roomViewCode":{"type":"string","description":"Indicates the view of the room. Typical values would be \"Ocean view\", \"Pool view\" or \"Garden View\". Supported OTA specification `RVT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"1"},"composite":{"type":"boolean","description":"Indicates that the room (suite) is a composite of smaller units.","example":false,"default":false},"compositeCount":{"minimum":0,"type":"integer","description":"Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.","format":"int32","example":2,"default":0},"roomClassificationCode":{"type":"string","description":"Specifies the room classification (e.g., cabin, apartment). Supported OTA specification `GRI` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"1"},"roomArchitectureCode":{"type":"string","description":"Specifies the architectural style of a room. Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"1"},"roomGender":{"type":"string","description":"Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.","example":"Female","default":"Unknown","enum":["Male","Female","MaleAndFemale","Unknown"]},"sharedRoomInd":{"type":"boolean","description":"If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.","example":false,"default":false},"maxCribs":{"minimum":0,"type":"integer","description":"Maximum number of cribs allowed in a room type.","format":"int32","example":1,"default":0},"amenities":{"type":"array","description":"Collection of room amenity items available to the guest. Supported OTA specification `RMA` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":["1","7"],"items":{"type":"string"}},"includedAdultOccupancy":{"minimum":0,"type":"integer","description":"The number of pax the room price was meant for","format":"int32","example":2,"default":2},"includedChildOccupancy":{"minimum":0,"type":"integer","description":"The number of children the room price was meant for","format":"int32","example":0,"default":0}},"description":"Guest room details."},"GuestUser_Agent":{"required":["email","firstName","lastName"],"type":"object","properties":{"userIdentifier":{"type":"string","description":"User identifier","format":"uuid"},"firstName":{"type":"string","description":"First name","example":"John"},"lastName":{"type":"string","description":"Last name","example":"Smith"},"email":{"type":"string","description":"Email","format":"email","example":"[email protected]"},"telephone":{"type":"string","description":"Telephone","example":"+1 212 555 1212"},"profile":{"$ref":"#/components/schemas/Profile_Agent"},"fullName":{"type":"string","description":"Full name","readOnly":true,"example":"John Smith"}}},"HotelOnMap_Agent":{"type":"object","properties":{"identifier":{"type":"string","description":"Unique record identifier. This is NOT the same as the unique hotel record identifier.","example":"document-1"},"hotelIdentifier":{"type":"string","description":"Unique hotel record identifier.","format":"uuid"},"name":{"type":"string","description":"Hotel trade name","example":"The Loveliest Hotel"},"localName":{"type":"string","description":"Hotel local name if different from the trade name or if it is the local language.","example":"Det Beste Hotellet"},"chain":{"type":"string","description":"Name of hotel chain if applicable.","example":"Hotel chain"},"brand":{"type":"string","description":"Name of hotel brand","example":"Hotel brand"},"urlName":{"type":"string","description":"Unique URL-friendly name slug of hotel","example":"the-loveliest-hotel-new-york-united-states"},"starRating":{"maximum":6,"minimum":0,"type":"integer","description":"Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.","format":"int32","example":4},"bookings":{"type":"integer","description":"Number of bookings for this property on the wink.travel payment.","format":"int64","example":6054,"default":0},"aggregateReviewRating":{"type":"number","description":"Aggregate score based on all current user reviews.","format":"float","example":7.8,"default":0.0},"location":{"$ref":"#/components/schemas/GeoJsonPoint_Agent"},"shortDescriptions":{"type":"array","description":"A localized list of short property descriptions","items":{"$ref":"#/components/schemas/LocalizedDescription_Agent"}},"longDescriptions":{"type":"array","description":"A localized list of longer property descriptions","items":{"$ref":"#/components/schemas/LocalizedDescription_Agent"}},"aggregateGreendexRating":{"type":"number","description":"Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.","format":"float","example":7.0,"default":0.0},"lifestyleTypes":{"type":"array","items":{"type":"string","description":"A list of lifestyles the property associates with.","example":"LIFESTYLE_HEALTH_FITNESS","enum":["LIFESTYLE_HEALTH_FITNESS","LIFESTYLE_RELAX","LIFESTYLE_ADULT_ONLY","LIFESTYLE_ADVENTURE","LIFESTYLE_BUSINESS","LIFESTYLE_LGBT","LIFESTYLE_SINGLE_PARENT","LIFESTYLE_SOLO_FEMALE","LIFESTYLE_BEAUTY","LIFESTYLE_FOODIE","LIFESTYLE_FAMILY","LIFESTYLE_ROMANCE","LIFESTYLE_COUPLE","LIFESTYLE_SOLO","LIFESTYLE_BACKPACKER","LIFESTYLE_SHOPPING","LIFESTYLE_SPORTS","LIFESTYLE_MOUNTAIN","LIFESTYLE_BEACH","LIFESTYLE_CITY","LIFESTYLE_COUNTRY","LIFESTYLE_CULTURE","LIFESTYLE_ECO"]}},"totalReviews":{"type":"integer","description":"Count of total reviews left by users at this property.","format":"int32","example":989,"default":0},"available":{"type":"boolean","description":"Flag indicating whether the payment has made this property available for sale.","example":true,"default":false},"hotelAvailable":{"type":"boolean","description":"Flag indicating whether the property has made this property available for sale.","example":true,"default":false},"reservations":{"$ref":"#/components/schemas/Contact_Agent"},"socials":{"type":"array","description":"Property's social network accounts","items":{"$ref":"#/components/schemas/Social_Agent"}},"images":{"type":"array","description":"Property images.","items":{"$ref":"#/components/schemas/SimpleMultimedia_Agent"}},"videos":{"type":"array","description":"Property videos.","items":{"$ref":"#/components/schemas/SimpleMultimedia_Agent"}},"policy":{"$ref":"#/components/schemas/PropertyPolicy_Agent"},"thirdPartyReviews":{"type":"array","description":"Array of awards and third party reviews given to property by certified / non-certified providers.","items":{"$ref":"#/components/schemas/TravelInventoryRecognition_Agent"}},"attractions":{"type":"integer","description":"Number of attractions property has listed on its profile.","format":"int32","example":5,"default":0},"recreations":{"type":"integer","description":"Number of activites property has listed on its profile.","format":"int32","example":3,"default":0},"pois":{"type":"integer","description":"Number of places property has listed on its profile.","format":"int32","example":9,"default":0},"restaurants":{"type":"integer","description":"Number of restaurants property has on its profile.","format":"int32","example":2,"default":0},"meetingRooms":{"type":"integer","description":"Number of meeting rooms property has on its profile.","format":"int32","example":2,"default":0},"spas":{"type":"integer","description":"Number of spas property has on its profile.","format":"int32","example":1,"default":0},"addOns":{"type":"integer","description":"Number of add-ons property has on its profile.","format":"int32","example":5,"default":0},"generalManager":{"$ref":"#/components/schemas/GeneralManager_Agent"},"locationCategory":{"type":"string","description":"Supported OTA specification `LOC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"34"},"segmentCategory":{"type":"string","description":"Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"7"},"hotelCategory":{"type":"string","description":"Supported OTA specification `PCT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"45"},"architecturalStyle":{"type":"string","description":"Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"7"},"whenBuilt":{"type":"string","description":"Year the property was constructed.","example":"1927"},"currencyCode":{"type":"string","description":"Currency code for property.","example":"USD"},"membershipRateDiscount":{"type":"number","description":"A property's price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it's there to compare it against other properties.","format":"float","example":9,"default":0},"priceScore":{"type":"integer","description":"A property's price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it's there to compare it against other properties.","format":"int32","example":9,"default":0},"perkScore":{"type":"integer","description":"A property's perk score is based on the type of perks that is offered to the guests across all master rates. There is no max score; it's there to compare it against other properties.","format":"int32","example":4,"default":0},"packageScore":{"type":"integer","description":"A property's package score is based on general availability and price for all packages and add-ons offered by the property. There is no max score; it's there to compare it against other properties.","format":"int32","example":4,"default":0},"loyaltyScore":{"type":"integer","description":"A property's loyalty score is based on calculating how many available rate plans honor loyalty points. There is no max score; it's there to compare it against other properties.","format":"int32","example":5,"default":0},"popularScore":{"type":"integer","description":"A property's popular score is based on calculating number of bookings across room types. There is no max score; it's there to compare it against other properties.","format":"int32","example":45,"default":0},"experienceScore":{"type":"integer","description":"A property's experience score is based on how calculating how many types of experiences are available and at what price ranges. There is no max score; it's there to compare it against other properties.","format":"int32","example":5,"default":0},"availabilityScore":{"type":"integer","description":"A property's availability score is based on general availability of all room types. If most room types are always unavailable, the attractiveness of this property goes down. We use this as our primary benchmark to decide how and when to feature properties. There is no max score; it's there to compare it against other properties.","format":"int32","example":5,"default":0},"views":{"type":"integer","description":"Total number of user views of this property.","format":"int64","example":10432,"default":0},"hotelAmenityCodes":{"type":"array","description":"Supported OTA specification `HAC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":["1","7"],"items":{"type":"string","description":"Supported OTA specification `HAC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"[\"1\",\"7\"]"}},"propertyAccessibilityCodes":{"type":"array","description":"Supported OTA specification `PHY` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":["1","7"],"items":{"type":"string","description":"Supported OTA specification `PHY` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"[\"1\",\"7\"]"}},"propertySecurityCodes":{"type":"array","description":"Supported OTA specification `SEC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":["1","7"],"items":{"type":"string","description":"Supported OTA specification `SEC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"[\"1\",\"7\"]"}},"numberOfRooms":{"type":"integer","description":"Number of rooms / keys for this property.","format":"int32","example":32,"default":0},"address":{"$ref":"#/components/schemas/Address_Agent"},"active":{"type":"boolean","description":"A property is considered active when both available and hotelAvailable flags are true.","example":true},"urlParameters":{"type":"string","description":"Convenience data point that creates url friendly query parameters of property."}},"description":"Combined property data."},"ImageAttribution_Agent":{"required":["name"],"type":"object","properties":{"url":{"type":"string","description":"URL to contributor","example":"https://maps.google.com/maps/contrib/111628493169070103594"},"name":{"type":"string","description":"Name of contributor","example":"Samuel Adams"}},"description":"Whether image has attribution properties"},"Itinerary_Agent":{"required":["endDate","items","startDate"],"type":"object","properties":{"startDate":{"type":"string","description":"Start date","format":"date"},"endDate":{"type":"string","description":"End date","format":"date"},"items":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Room configurations","items":{"$ref":"#/components/schemas/RoomConfiguration_Agent"}},"nights":{"type":"integer","description":"How many total nights for this stay","format":"int32"},"hours":{"type":"integer","description":"Number of hours between start and end dates. Used for itineraries that require bookings that occur within hours and not days. E.g. Meeting room reservation.","format":"int64","readOnly":true},"children":{"type":"integer","description":"How many total children for this stay","format":"int32"},"rooms":{"type":"integer","description":"How many total rooms for this stay","format":"int32"},"guests":{"type":"integer","description":"How many total guests for this stay","format":"int32"}},"description":"SimpleDateTimeItinerary"},"LocalizedDescription_Agent":{"required":["description","language"],"type":"object","properties":{"description":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Longer text description","example":"This is a longer description in the specified language."},"language":{"maxLength":2,"minLength":2,"type":"string","description":"Indicate which language this description is written in.","example":"en","default":"en"}},"description":"List of localized descriptions for this fee."},"LocalizedPrice_Agent":{"required":["internalBaseTotal","sourceBaseTotal","sourceToInternalCurrencyQuote","sourceToUserCurrencyQuote","userSpecifiedCurrencyBaseTotal"],"type":"object","properties":{"sourceToUserCurrencyQuote":{"$ref":"#/components/schemas/Quote_Agent"},"sourceToInternalCurrencyQuote":{"$ref":"#/components/schemas/Quote_Agent"},"userSpecifiedCurrencyBaseTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"sourceBaseTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"internalBaseTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"userSpecifiedCurrencyPromotionalModifier":{"type":"number","description":"Promotional modifiers in user specified currency","example":-40},"sourcePromotionalModifier":{"type":"number","description":"Promotional modifiers in hotel currency","example":-40},"internalPromotionalModifier":{"type":"number","description":"Promotional modifiers in wink currency","example":-40},"userSpecifiedCurrencyPremiumModifier":{"type":"number","description":"Premium modifiers in user specified currency","example":40},"sourcePremiumModifier":{"type":"number","description":"Premium modifiers in hotel currency","example":40},"internalPremiumModifier":{"type":"number","description":"Premium modifiers in wink currency","example":40},"userSpecifiedCurrencyChannelModifier":{"type":"number","description":"Channel / Membership modifier in user specified currency","example":-10},"sourceChannelModifier":{"type":"number","description":"Channel / Membership modifier in hotel currency","example":-10},"internalChannelModifier":{"type":"number","description":"Channel / Membership modifier in wink currency","example":-10},"quantity":{"type":"integer","description":"How many of this item is included in this price","format":"int64","default":1},"promotionalDiscountPercent":{"type":"number","description":"Promotional discount percent","format":"float"},"channelDiscountPercent":{"type":"number","description":"Channel discount percent","format":"float"},"premiumPercent":{"type":"number","description":"Premium percent","format":"float"},"hasChannelDiscount":{"type":"boolean"},"hasPremium":{"type":"boolean"},"hasPromotion":{"type":"boolean"},"sourceTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"userSpecifiedCurrencyTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"internalTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalDiscountPercent":{"type":"number","format":"float"}},"description":"Pricing information for this ancillary."},"PayoutFee_Agent":{"required":["candidate","description","fee","identifier","type"],"type":"object","properties":{"identifier":{"type":"string","description":"Unique system ID.","format":"uuid"},"fee":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"type":{"type":"string","description":"Type of fee","enum":["FX","SERVICE_CHARGE"]},"candidate":{"type":"string","description":"Who pays for this fee","enum":["PAYOR","PAYEE"]},"description":{"type":"string","description":"Withdrawal fee description"}},"description":"Fees incurred when making the withdrawal."},"Payout_Agent":{"required":["beneficiaryIdentifier","created","entry","externalPayeeIdentifier","identifier","status","type","vendor","vendorIdentifier","vendorName","vendorTokenKey"],"type":"object","properties":{"vendor":{"type":"string","description":"Name of integration vendor","example":"STRIPE","enum":["STRIPE","AGENT","NMI","WISE"]},"vendorIdentifier":{"type":"string","description":"Which acquirer account we return fund from."},"vendorName":{"type":"string","description":"Name of regional acquirer account."},"vendorTokenKey":{"type":"string","description":"Key to help load Stripe for the correct region. Could be helpful for other vendors as well."},"identifier":{"type":"string","description":"Unique system ID.","format":"uuid"},"beneficiaryIdentifier":{"type":"string","description":"Beneficiary ID.","format":"uuid"},"externalPayeeIdentifier":{"type":"string","description":"This would be the cardholder ID for VCCs.","example":"stripe-cardholder-1"},"type":{"type":"string","description":"Type of withdrawal.","example":"BANK_TRANSFER","enum":["BANK_TRANSFER","VCC"]},"entry":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"fees":{"type":"array","description":"Fees incurred when making the withdrawal.","items":{"$ref":"#/components/schemas/PayoutFee_Agent"}},"created":{"type":"string","description":"When the payout record was created.","format":"date-time"},"description":{"type":"string","description":"Textual response from provider","example":"Card created successfully"},"payoutId":{"type":"string","description":"The identifier that was generated when scheduling the payout. This will come from the payout provider such as Stripe.","example":"stripe-card-1"},"referenceCode":{"type":"string","description":"The transaction code that was generated when the funds move out of TripPay's account. This will come from the payout provider such as Stripe. E.g. For VCCs, it will occur when an authorization takes place.","example":"ABC1234"},"referenceCodeDate":{"type":"string","description":"The time the funds were withdrawn","format":"date-time"},"status":{"type":"string","description":"Status of withdrawal.","example":"SCHEDULED","enum":["INITIATED","ACTIVE","INACTIVE","FAILED","CANCELLED","COMPLETE"]}},"description":"Payout keeps track of all outgoing funds for a certain account."},"PendingRefund_Agent":{"required":["captureAmountRefundModifier","displayAmountRefundModifier","internalAmountRefundModifier","refundIdentifier","sourceAmountRefundModifier","supplierAmountRefundModifier"],"type":"object","properties":{"refundIdentifier":{"type":"string","description":"This is the refund identifier located on the root bookingContract.refunds object","example":"refund-1"},"sourceAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original source amount after a refund occurred","example":5},"displayAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original display amount after a refund occurred","example":5},"supplierAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original supplier amount after a refund occurred","example":5},"internalAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original internal amount after a refund occurred","example":5},"captureAmountRefundModifier":{"minimum":0,"type":"number","description":"The delta from the original capture amount after a refund occurred","example":5}},"description":"When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property"},"Personal_Agent":{"type":"object","properties":{"gender":{"type":"string","description":"Identifier the gender of the customer.","enum":["MALE","FEMALE","OTHER"]},"birthDate":{"type":"string","description":"Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.","format":"date"},"maritalStatus":{"type":"string","description":"Marital status of the traveler.","enum":["ANNULLED","COHABITATING","DIVORCED","ENGAGED","MARRIED","SEPARATED","SINGLE","WIDOWED","UNKNOWN"]},"childQuantity":{"type":"integer","description":"The number of children of the customer.","format":"int32"},"citizenship":{"type":"string","description":"Name of the (self-professed) country that is clamided for citizenship."},"address1":{"type":"string","description":"Address line 1"},"address2":{"type":"string","description":"Address line 2"},"city":{"type":"string","description":"City"},"state":{"type":"string","description":"State"},"postalCode":{"type":"string","description":"Postal code"},"country":{"type":"string","description":"Country"},"preferredCurrency":{"type":"string","description":"Type of funds preferred for reviewing monetary values, in ISO 4217 codes","example":"USD"},"language":{"type":"string","description":"The primary language of the customer"},"contactPerson":{"type":"array","items":{"$ref":"#/components/schemas/Contact_Agent"}},"physChallName":{"type":"array","items":{"type":"string","description":"Array of customer's physical challenges"}},"petInfo":{"type":"array","items":{"$ref":"#/components/schemas/PetInfoDto_Agent"}}},"description":"Detailed customer information for this profile"},"PetInfoDto_Agent":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string","description":"Pet name"},"type":{"type":"string","description":"Pet type"}},"description":"Array of customer's pets"},"Preferences_Agent":{"type":"object","properties":{"propertyLocationPref":{"type":"string","description":"Indicates preference for hotel property locations."},"propertyTypePref":{"type":"string","description":"Indicates preference for hotel property types."},"hotelChainPref":{"type":"string","description":"Identifies a preferred company by name."},"propertyAmenityPref":{"type":"array","description":"Indicates preferences for hotel property amenities.","items":{"type":"string"}},"recreationSrvcPref":{"type":"array","description":"Indicates preference for the type of recreation services in a hotel","items":{"type":"string"}},"businessSrvcPref":{"type":"array","description":"Indicates preference for type of business services in a hotel","items":{"type":"string"}},"securityFeaturePref":{"type":"array","description":"Indicates preference of rtype of security features in a hotel","items":{"type":"string"}},"physChalFeaturePref":{"type":"array","description":"Indicates preferences for type of features required to meet the needs of persons with physical challenges, disabilities, etc.","items":{"type":"string","description":"Indicates preferences for type of features required to meet the needs of persons with physical challenges, disabilities, etc."}},"smokingAllowed":{"type":"boolean","description":"Indicates preference for smooking allowed rooms.."},"roomLocationPref":{"type":"string","description":"Indicates preference for hotel room locations."},"bedTypePref":{"type":"string","description":"Indicates preferences for the size and features of hotel bed types."},"foodSrvcPref":{"type":"string","description":"Indicates preferences for type of food listener facilities in a hotel."},"roomAmenityPref":{"type":"array","description":"Indicates preferences for hotel room amenities.","items":{"type":"string"}},"guestType":{"type":"string","description":"Guest type"},"mealPref":{"type":"string","description":"Indicates meal preference."},"cuisinePref":{"type":"string","description":"Indicates cuisine preference."},"interestPref":{"type":"array","description":"Indicates interest preference","items":{"type":"string"}},"beveragePref":{"type":"array","description":"Indicates beverage preference.","items":{"type":"string"}},"foodPref":{"type":"array","description":"Indicates food preference.","items":{"type":"string"}},"allergies":{"type":"array","description":"Indicates allergies","items":{"type":"string"}},"petsPref":{"type":"array","description":"Indicates pet preferences","items":{"type":"string"}}},"description":"Customer preferences"},"ProfileUser_Agent":{"type":"object","properties":{"firstName":{"type":"string","description":"First name","example":"Avid"},"lastName":{"type":"string","description":"Last name","example":"Travelman"},"email":{"type":"string","description":"Email","format":"email","example":"[email protected]"},"phone":{"type":"string","description":"Telephone","example":"0123456789"},"profilePictureUrl":{"type":"string","description":"Profile picture URL"},"fullName":{"type":"string","description":"Full name","readOnly":true,"example":"John Smith"}},"description":"User details"},"Profile_Agent":{"required":["personal","preferences","profileIdentifier","share","user","userIdentifier"],"type":"object","properties":{"profileIdentifier":{"type":"string","description":"Profile identifier","format":"uuid"},"userIdentifier":{"type":"string","description":"User identifier","format":"uuid"},"share":{"type":"boolean","description":"Indicates whether the user wants to share this profile of themselves with hotel(s)"},"user":{"$ref":"#/components/schemas/ProfileUser_Agent"},"personal":{"$ref":"#/components/schemas/Personal_Agent"},"preferences":{"$ref":"#/components/schemas/Preferences_Agent"}},"description":"Optional profile record"},"PropertyPolicy_Agent":{"required":["checkInTime","checkOutTime","childrenAllowed","internetAvailability","internetConnectionLocation","internetConnectionType","parkingAccess","parkingAvailability","petsAllowed"],"type":"object","properties":{"childrenAllowed":{"type":"boolean","description":"Indicates whether property allows children","example":true,"default":false},"childrenMinimumAge":{"type":"integer","description":"When a property allows children, it can also indicate what the minimum age is for children to be allowed.","format":"int32","example":6},"internetAvailability":{"type":"string","description":"Indicates the availability of internet on the property.","example":"YES","enum":["YES","NO","YES_PAID"]},"internetConnectionType":{"type":"string","description":"Indicates how guests can access the Internet on the property.","example":"WIFI","enum":["WIFI","CABLE"]},"internetConnectionLocation":{"type":"string","description":"Indicates where internet is available in and around the property.","example":"ENTIRE_PROPERTY","enum":["ENTIRE_PROPERTY","PUBLIC_AREAS","ALL_ROOMS","SOME_ROOMS","BUSINESS_CENTER"]},"parkingAvailability":{"type":"string","description":"Indicates whether parking is available at the property.","example":"YES","enum":["YES","NO","YES_PAID"]},"parkingAccess":{"type":"string","description":"Indicates what type of parking is available at the property.","example":"PRIVATE","enum":["PRIVATE","PUBLIC"]},"petsAllowed":{"type":"boolean","description":"Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.","example":true,"default":false},"petMaxWeightInKilos":{"type":"integer","description":"If pets are allowed, property can further limit on weight.","format":"int32","example":10},"petCharge":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"checkOutTime":{"type":"string","description":"When the guest has to check out.","example":"10:00"},"checkInTime":{"type":"string","description":"When the guest can check in.","example":"14:00"}},"description":"Outlines basic policies for the property."},"Quote_Agent":{"required":["exchangeRate","source","target","timestamp"],"type":"object","properties":{"source":{"type":"string","description":"Source"},"target":{"type":"string","description":"Target"},"exchangeRate":{"type":"number","description":"Exchange rate"},"timestamp":{"type":"integer","description":"Timestamp","format":"int64"}},"description":"The quote used to create totalCapturePrice."},"RatePlanLevelFee_Agent":{"required":["descriptions","fixedAmount","type"],"type":"object","properties":{"descriptions":{"type":"array","description":"List of localized descriptions for this fee.","items":{"$ref":"#/components/schemas/LocalizedDescription_Agent"}},"fixedAmount":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"type":{"type":"string","description":"Rate plan fee type","example":"PER_DAY","enum":["PER_DAY","PER_STAY","PER_PERSON_PER_DAY","PER_PERSON_PER_STAY"]}},"description":"What the guest is paying extra for"},"RatePlan_Agent":{"required":["allInclusive","allInclusivePlusAlcohol","breakfast","brunch","cancellationPolicyIdentifier","dinner","hotelIdentifier","identifier","lunch","name","prepaid"],"type":"object","properties":{"identifier":{"type":"string","description":"Rate plan identifier","format":"uuid"},"hotelIdentifier":{"type":"string","description":"Hotel Identifier","format":"uuid"},"name":{"type":"string","description":"Provides the name of the rate plan.","example":"BAR 1"},"prepaid":{"type":"boolean","description":"When true, indicates if the rate is a prepaid rate.","example":false,"default":false},"breakfast":{"type":"boolean","description":"When true, indicates breakfast is included.","example":false,"default":false},"brunch":{"type":"boolean","description":"When true, indicates brunch is included.","example":false,"default":false},"lunch":{"type":"boolean","description":"When true, indicates lunch is included.","example":false,"default":false},"dinner":{"type":"boolean","description":"When true, indicates dinner is included.","example":false,"default":false},"allInclusive":{"type":"boolean","description":"Everything included except alcohol","example":false,"default":false},"allInclusivePlusAlcohol":{"type":"boolean","description":"Everything included with alcohol","example":false,"default":false},"sellStartDate":{"type":"string","description":"Set a start date for when to start selling this rate. When sellStartDate and sellEndDate are set, this rate is only available for sale within that date range.","format":"date"},"sellEndDate":{"type":"string","description":"Set an end date for when to finish selling this rate. When sellStartDate and sellEndDate are set, this rate is only available for sale within that date range.","format":"date"},"stayStartDate":{"type":"string","description":"Set a start date for when the guest can visit. When stayStartDate and stayEndDate are set, this rate is only available for stay within that date range.","format":"date"},"stayEndDate":{"type":"string","description":"Set an end date for when the guest can visit. When stayStartDate and stayEndDate are set, this rate is only available for stay within that date range.","format":"date"},"loyaltyPointsAccrue":{"type":"boolean","description":"Property honors loyalty points with this rate plan.","example":false,"default":false},"maxAdvanceBookingOffset":{"type":"integer","description":"Maximum days before the arrival date for which this rate plan may be booked.","format":"int32","example":10},"minAdvanceBookingOffset":{"type":"integer","description":"Minimum days before the arrival date for which this rate plan may be booked.","format":"int32","example":3},"minTotalOccupancy":{"type":"integer","description":"Defines the minimum number of total occupants required for this rate plan.","format":"int32","example":4},"maxTotalOccupancy":{"type":"integer","description":"Defines the maximum number of total occupants required for this rate plan.","format":"int32","example":4},"minLOS":{"type":"integer","description":"Indicates the minimum length of stay required for this rate plan.","format":"int32","example":3},"maxLOS":{"type":"integer","description":"Indicates the maximum length of stay.","format":"int32","example":5},"minAge":{"type":"integer","description":"The minimum age to qualify for this rate plan.","format":"int32","example":26},"maxAge":{"type":"integer","description":"The maximum age to qualify for this rate plan.","format":"int32","example":50},"availableDaysOfWeek":{"$ref":"#/components/schemas/DowPatternGroup_Agent"},"arrivalDaysOfWeek":{"$ref":"#/components/schemas/DowPatternGroup_Agent"},"departureDaysOfWeek":{"$ref":"#/components/schemas/DowPatternGroup_Agent"},"requiredDaysOfWeek":{"$ref":"#/components/schemas/DowPatternGroup_Agent"},"earlyCheckInCharge":{"$ref":"#/components/schemas/VariableCharge_Agent"},"lateCheckOutCharge":{"$ref":"#/components/schemas/VariableCharge_Agent"},"cancellationPolicyIdentifier":{"type":"string","description":"The cancellation policy for this rate plan.","example":"cancellation-policy-1"},"cancellationPolicy":{"$ref":"#/components/schemas/CancellationPolicy_Agent"},"cancellationPolicyExceptions":{"$ref":"#/components/schemas/CancellationPolicyExceptions_Agent"}},"description":"Rate plan used for this stay"},"Refund_Agent":{"required":["cancelOnRefund","created","description","identifier","reasonType","refund","requestResponse","requestStatus","requestType","statusType"],"type":"object","properties":{"identifier":{"type":"string","description":"A unique identifier","example":"refund-1"},"acquirerRefundIdentifier":{"type":"string","description":"The acquirer refund identifier. Will get attached once it comes in on the webhook.","example":"r-123456"},"requestedByIdentifier":{"type":"string","description":"The SSO person / entity that requested the refund.","example":"user-1"},"refund":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"created":{"type":"string","description":"When the amount was refunded","format":"date-time"},"description":{"type":"string","description":"A description of the refund that can be displayed to booker","example":"Customer made a mistake"},"reasonType":{"type":"string","description":"A description of the refund that can be displayed to booker","example":"DUPLICATE","enum":["DUPLICATE","FRAUDULENT","REQUESTED_BY_CUSTOMER","GUEST_COMPLAINT","GUEST_BOOKED_INCORRECT_DATE","GUEST_SICK","OVERBOOKING","EMERGENCY","FLIGHT_CANCELLED","DEATH_IN_FAMILY","OTHER","EXPIRED_UNCAPTURED_CHARGE"]},"cancelOnRefund":{"type":"string","description":"Whether to cancel the booking alongside requesting a refund.","enum":["NONE","CANCEL_ON_SUCCESSFUL_REFUND","CANCEL_REGARDLESS"]},"statusType":{"type":"string","description":"Status of the refund","example":"SUCCEEDED","enum":["PENDING","SUCCEEDED","CANCELED","REQUIRES_ACTION","FAILED"]},"requestType":{"type":"string","description":"The entity making the refund request","example":"BY_ADMIN","enum":["BY_SUPPLIER","BY_ADMIN","BY_STRIPE","BY_SYSTEM","BY_AGENT"]},"requestStatus":{"type":"string","description":"Status of the refund request","example":"APPROVED","enum":["PENDING","APPROVED","REJECTED"]},"requestResponse":{"type":"string","description":"Admin may choose to respond to the refund request made by the hotel","example":"We have rejected your request. Your cancellation policy does not warrant a manual refund."},"receiptUrl":{"type":"string","description":"This is the receipt url that contains a friendly web confirmation page. Comes in on the webhook.","example":"https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xSXcxazVBQ3F2UW9nN1IxKIPqo54GMgbHKn45YQY6LBbCZ62655YzamuWDVeWAaw7uApCrxewxjSsZX4C9Lef5jY9JeYFrOVx3IaI"},"retries":{"type":"integer","description":"In case a TripPay admin has to go in and re-send the refund request to Stripe, we want to not to the same calculations again when a retry is executed so we keep track of retries here.","format":"int32","example":0,"default":0},"allocation":{"type":"string","description":"The type of refund determines how the funds are deducted each beneficiary.","example":"EQUAL_DISTRIBUTION","default":"EQUAL_DISTRIBUTION","enum":["FROM_SALE_ONLY","EQUAL_DISTRIBUTION","CUSTOMERS_ONLY"]}},"description":"Refund objects allow you to refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged."},"ReportingAncillary_Agent":{"type":"object","properties":{"name":{"type":"string","description":"Full name of ancillary in English."},"type":{"type":"string","description":"The type","enum":["LODGING","RAIL","AIR","CAR","CRUISE","PACKAGE","ADD_ON","RENTAL","EXPERIENCE","ANCILLARY_BOOKING","ANCILLARY_FEE"]},"grossAmount":{"type":"number","description":"The gross amount."},"netAmount":{"type":"number","description":"The gross amount minus fees and commissions."},"netAmountWithRefund":{"type":"number","description":"The gross amount minus fees and commissions."},"currency":{"type":"string","description":"The currency for these amounts."}},"description":"Displays ancillary accounting details"},"ReportingDailyRate_Agent":{"type":"object","properties":{"date":{"type":"string","description":"The rate date.","format":"date"},"baseAmount":{"type":"number","description":"The rate given to us by channel manager / CRS / PMS."},"grossAmount":{"type":"number","description":"The derived amount based on promotions, member discounts etc within our platform."},"netAmount":{"type":"number","description":"The gross amount minus fees and commissions."},"netAmountWithRefund":{"type":"number","description":"The net amount minus potential refund. Null if booking contains no refund."},"currency":{"type":"string","description":"The currency for these amounts."}},"description":"Displays rate accounting details"},"ReportingExtraCharge_Agent":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"grossAmount":{"type":"number"},"netAmount":{"type":"number"},"netAmountWithRefund":{"type":"number"},"currency":{"type":"string"}},"description":"Displays extra charge accounting details."},"ReviewAnswer_Agent":{"required":["category","questionIdentifier","sort","value"],"type":"object","properties":{"questionIdentifier":{"type":"string","description":"Question identifier","format":"uuid"},"category":{"type":"string","description":"Question category","enum":["COMFORT","CONDITION","SERVICE","ENVIRONMENT","FACILITIES","LOCATION","LIFESTYLE","VALUE","FOOD","ROOM"]},"sort":{"type":"integer","description":"Sort key","format":"int32"},"value":{"type":"integer","description":"Value","format":"int32"}}},"ReviewUser_Agent":{"type":"object","properties":{"userIdentifier":{"type":"string","description":"User identifier","format":"uuid"},"firstName":{"type":"string","description":"First name","example":"John"},"lastName":{"type":"string","description":"Last name","example":"Smith"},"email":{"type":"string","description":"Email","format":"email","example":"[email protected]"},"telephone":{"type":"string","description":"Telephone","example":"0123456789"},"fullName":{"type":"string","description":"Full name","example":"0123456789"}},"description":"User details of creator of booking."},"Review_Agent":{"type":"object","properties":{"identifier":{"type":"string","description":"Unique review identifier identifying this record.","format":"uuid"},"bookingIdentifier":{"type":"string","description":"Booking identifier identifier booking this review is associated with.","format":"uuid"},"hotelIdentifier":{"type":"string","description":"Hotel identifier this booking is associated with.","format":"uuid"},"user":{"$ref":"#/components/schemas/ReviewUser_Agent"},"reviewDate":{"type":"string","description":"Date of review.","format":"date-time"},"averageScore":{"type":"number","description":"Total points divided by number of questions.","format":"double","example":8.7},"answers":{"type":"array","description":"List of user review answers.","items":{"$ref":"#/components/schemas/ReviewAnswer_Agent"}},"messageFromGuest":{"type":"string","description":"Private message from guest to the hotel. Is not displayed on property profile.","example":"Dear GM, I would like to say thank you so much for taking the time to show my husband and I around the premises and the secret cave behind the property."},"responseFromHotel":{"type":"string","description":"Property can response to traveler review. Response goes on public review profile and can be seen by others.","example":"It was so great to have you at our hotel. Please recommend your friends and come again soon."},"imageIdentifier":{"type":"string","description":"Reviewer can upload her best picture from the property. Cloudinary image identifier.","example":"cloudinary-image-1"},"text":{"type":"string","description":"Free text record created by traveler","example":"Our stay was amazing! Can recommend highly to all. Felt like home."},"approvedText":{"type":"boolean","description":"Hotel allows the review text to be displayed as part of their profile.","example":true},"approvedImage":{"type":"boolean","description":"Hotel allows the user-generated image to be displayed as part of their profile.","example":false},"likes":{"type":"array","description":"List of member identifiers who liked the textual review","format":"uuid","example":"user-1","items":{"type":"string"}},"roomNumber":{"type":"string","description":"Guest's room number during their stay.","example":"501"},"roomRating":{"type":"integer","description":"Guest's room rating","format":"int32","example":7},"responded":{"type":"boolean","description":"Returns true if property has responded to the review given by the guest.","example":false,"default":false}},"description":"User review created by the traveler after the booking completed."},"RoomStay_Agent":{"required":["activeCancellationPolicy","adults","bedroomConfiguration","children","endDate","extraCharges","policy","price","ratePlan","room","roomRateIdentifier","roomRateInternalName","rooms","startDate"],"type":"object","properties":{"policy":{"$ref":"#/components/schemas/PropertyPolicy_Agent"},"room":{"$ref":"#/components/schemas/GuestRoom_Agent"},"rooms":{"type":"integer","description":"Number of rooms. Always 1 since we switched to creating one booking per room.","format":"int32","example":1,"default":1},"bedroomConfiguration":{"$ref":"#/components/schemas/BedroomConfiguration_Agent"},"adults":{"type":"integer","description":"The actual amount of adults as determined by the hotel's policy.","format":"int32","example":2,"default":2},"children":{"type":"integer","description":"The actual amount of children as determined by the hotel's policy.","format":"int32","example":0,"default":0},"startDate":{"type":"string","description":"Stay start date","format":"date","example":"2021-12-24"},"endDate":{"type":"string","description":"Stay end date","format":"date","example":"2021-12-31"},"price":{"$ref":"#/components/schemas/StayRate_Agent"},"roomRateIdentifier":{"type":"string","description":"Master rate identifier","format":"uuid"},"roomRateInternalName":{"type":"string","description":"Master rate internal name","example":"Master Rate 1"},"ratePlan":{"$ref":"#/components/schemas/RatePlan_Agent"},"perkTypes":{"type":"array","description":"List of perks that came with the master rate","example":["PERK_FREE_DRINK_VOUCHER","PERK_EARLY_CHECKIN"],"items":{"type":"string","description":"List of perks that came with the master rate","example":"[\"PERK_FREE_DRINK_VOUCHER\",\"PERK_EARLY_CHECKIN\"]","enum":["PERK_LOYALTY_POINTS","PERK_WINE","PERK_FREE_DRINK_VOUCHER","PERK_FREE_MEAL_TWO_PEOPLE","PERK_FREE_ONE_HOUR_MASSAGE","PERK_TWENTY_PERCENT_FOOD_BEVERAGE_DISCOUNT","PERK_TWENTY_PERCENT_SPA_DISCOUNT_VOUCHER","PERK_GUARANTEED_UPGRADE","PERK_EARLY_CHECKIN","PERK_ROOM_UPGRADE","PERK_LATE_CHECKOUT","PERK_AIRPORT_TRANSFER","PERK_AIRPORT_PICK_UP","PERK_BOTTLE_CHAMPAGNE_ON_ARRIVAL","PERK_BOTTLE_SPARKLING_WINE_ON_ARRIVAL","PERK_BOTTLE_WINE_ON_ARRIVAL"]}},"extraCharges":{"$ref":"#/components/schemas/ExtraCharges_Agent"},"activeCancellationPolicy":{"$ref":"#/components/schemas/CancellationPolicy_Agent"},"cancellable":{"type":"boolean"},"cancellableByHotel":{"type":"boolean"},"cancellableWithPotentialCharge":{"type":"boolean"},"guests":{"type":"integer","format":"int32"},"sourceTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"roomNights":{"type":"integer","description":"Total number of nights the guest stays at the hotel. -1 indicates there is an error.","format":"int64","example":2},"rateSource":{"type":"string"},"userSpecifiedCurrencyTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"internalTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"}},"description":"All information about the room that was booked."},"SimpleDateTimeItinerary_Agent":{"required":["adults","children","endDate","startDate"],"type":"object","properties":{"startDate":{"type":"string","description":"Start date","format":"date-time"},"endDate":{"type":"string","description":"End date","format":"date-time"},"adults":{"minimum":0,"type":"integer","description":"Number of adults","format":"int32"},"children":{"minimum":0,"type":"integer","description":"Number of children","format":"int32"},"nights":{"type":"integer","description":"Total number of room nights","format":"int64","readOnly":true},"hours":{"type":"integer","description":"Number of hours between start and end dates. Used for itineraries that require bookings that occur within hours and not days. E.g. Meeting room reservation.","format":"int64","readOnly":true},"guests":{"type":"integer","description":"Total number of adults and children","format":"int32","readOnly":true}},"description":"SimpleDateTimeItinerary outlines stay dates, number of adults and children"},"SimpleDescription_Agent":{"required":["description","language"],"type":"object","properties":{"name":{"type":"string","description":"Use as title or short text description","example":"An example title"},"description":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Longer text description","example":"This is a longer description in the specified language."},"language":{"maxLength":2,"minLength":2,"type":"string","description":"Indicate which language this description is written in.","example":"en","default":"en"}}},"SimpleMultimedia_Agent":{"required":["height","identifier","multimediaIdentifier","source","type","width"],"type":"object","properties":{"multimediaIdentifier":{"type":"string","description":"Document identifier","format":"uuid"},"identifier":{"type":"string","description":"Use this identifier to communicate with Cloudinary.","example":"cloudinary-image-1"},"type":{"type":"string","description":"Whether Cloudinary media is a VIDEO or IMAGE.","example":"IMAGE","enum":["IMAGE","VIDEO","AUDIO","RAW"]},"source":{"type":"string","description":"Currently ONLY using Cloudinary to store all image / video assets.","example":"CLOUDINARY","default":"CLOUDINARY","enum":["YOUTUBE","CLOUDINARY"]},"sort":{"type":"integer","description":"Sort allows you to control how you want to sort this record in a list of media records.","format":"int32","example":10,"default":999},"angle":{"type":"string","description":"Media angle","example":"-90"},"width":{"type":"integer","description":"Media width in pixels.","format":"int32","example":2560},"height":{"type":"integer","description":"Media height in pixels.","format":"int32","example":1600},"published":{"type":"boolean","description":"Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.","example":true,"default":false},"category":{"type":"string","description":"Supported OTA specification `PIC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)","example":"1"},"descriptions":{"type":"array","description":"Localized media captions to give user some context about where this media was taken.","items":{"$ref":"#/components/schemas/SimpleDescription_Agent"}},"lifestyleType":{"type":"string","description":"Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.","example":"LIFESTYLE_HEALTH_FITNESS","enum":["LIFESTYLE_HEALTH_FITNESS","LIFESTYLE_RELAX","LIFESTYLE_ADULT_ONLY","LIFESTYLE_ADVENTURE","LIFESTYLE_BUSINESS","LIFESTYLE_LGBT","LIFESTYLE_SINGLE_PARENT","LIFESTYLE_SOLO_FEMALE","LIFESTYLE_BEAUTY","LIFESTYLE_FOODIE","LIFESTYLE_FAMILY","LIFESTYLE_ROMANCE","LIFESTYLE_COUPLE","LIFESTYLE_SOLO","LIFESTYLE_BACKPACKER","LIFESTYLE_SHOPPING","LIFESTYLE_SPORTS","LIFESTYLE_MOUNTAIN","LIFESTYLE_BEACH","LIFESTYLE_CITY","LIFESTYLE_COUNTRY","LIFESTYLE_CULTURE","LIFESTYLE_ECO"]},"attribution":{"type":"array","description":"Whether image has attribution properties","items":{"$ref":"#/components/schemas/ImageAttribution_Agent"}},"isLandscape":{"type":"boolean","description":"True if media width is greater or equal to height","example":true}},"description":"Multimedia that contains less information than Multimedia object"},"Social_Agent":{"type":"object","properties":{"type":{"type":"string","description":"Type of social network.","enum":["FACEBOOK","INSTAGRAM","SKYPE","TRIP_ADVISOR","TWITTER","GOOGLE_PLUS","WHATSAPP","LINE","WECHAT","VIBER","SNAPCHAT","WEIBO","RENREN","WEBSITE","QQ","TIKTOK"]},"location":{"type":"string","description":"URL or social network identifier to social network profile"},"enabled":{"type":"boolean","description":"Whether social network is available for use."}},"description":"Social network"},"StayRate_Agent":{"type":"object","properties":{"userSpecifiedCurrencyBaseTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"sourceBaseTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"internalBaseTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"sourceExtraPaxModifier":{"type":"number","description":"Extra person modifier in hotel currency.","example":15},"internalExtraPaxModifier":{"type":"number","description":"Extra person modifier in wink currency","example":15},"userSpecifiedCurrencyExtraPaxModifier":{"type":"number","description":"Extra person modifier in user specified currency","example":15},"sourceExtraChildModifier":{"type":"number","description":"Extra child modifier in hotel currency","example":15},"internalExtraChildModifier":{"type":"number","description":"Extra child modifier in wink currency","example":15},"userSpecifiedCurrencyExtraChildModifier":{"type":"number","description":"Extra child modifier in user specified currcency","example":15},"sourceSingleOccupantModifier":{"type":"number","description":"Single occupant modifier in hotel currency","example":-15},"internalSingleOccupantModifier":{"type":"number","description":"Singe occupant modifier in wink currency","example":-15},"userSpecifiedCurrencySingleOccupantModifier":{"type":"number","description":"Single occupant modifier in user specified currency","example":-15},"sourcePromotionalModifier":{"type":"number","description":"Rate discount modifiers in hotel currency","example":-40},"internalPromotionalModifier":{"type":"number","description":"Rate discount modifiers in wink currency","example":-40},"userSpecifiedCurrencyPromotionalModifier":{"type":"number","description":"Rate discount modifiers in user specified currency","example":-40},"sourcePremiumModifier":{"type":"number","description":"Rate premiums modifiers in hotel currency","example":40},"internalPremiumModifier":{"type":"number","description":"Rate premiums modifiers in wink currency","example":40},"userSpecifiedCurrencyPremiumModifier":{"type":"number","description":"Rate premiums modifiers in user specified currency","example":40},"sourceChannelModifier":{"type":"number","description":"Channel / Membership modifier in hotel currency","example":-10},"internalChannelModifier":{"type":"number","description":"Channel / Membership modifier in wink currency","example":-10},"userSpecifiedCurrencyChannelModifier":{"type":"number","description":"Channel / Membership modifier in user specified currency","example":-10},"quantity":{"type":"integer","description":"Quantity","format":"int32"},"minOccupancy":{"type":"integer","description":"Minimum occupancy","format":"int32"},"maxOccupancy":{"type":"integer","description":"Maximum occupancy","format":"int32"},"rateSource":{"type":"string","description":"Source"},"promotionalDiscountPercent":{"type":"number","description":"Promotional discount percent","format":"float"},"channelDiscountPercent":{"type":"number","description":"Chanel discount percent","format":"float"},"premiumPercent":{"type":"number","description":"Premium percent","format":"float"},"available":{"type":"boolean","description":"Available"},"sourceToUserCurrencyQuote":{"$ref":"#/components/schemas/Quote_Agent"},"sourceToInternalCurrencyQuote":{"$ref":"#/components/schemas/Quote_Agent"},"offerDetails":{"type":"array","description":"Localized text of the discount","items":{"$ref":"#/components/schemas/LocalizedDescription_Agent"}},"promotionalCodes":{"type":"array","description":"Promotional codes","items":{"type":"string"}},"userSpecifiedCurrencyTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"sourceTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"internalTotal":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"userSpecifiedCurrencyAveragePricePerNight":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"internalAveragePricePerNight":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"sourceAveragePricePerNight":{"$ref":"#/components/schemas/CustomMonetaryAmount"},"totalDiscountPercent":{"type":"number","format":"float"}},"description":"Price details"},"SubCountry_Agent":{"type":"object","properties":{"name":{"type":"string","description":"Sub-country name","example":"New York"},"asciiName":{"type":"string","description":"Sub-country ascii name","example":"New York"},"geoNameId":{"type":"string","description":"Sub-country GeoNames identifier","example":"5128638"}},"description":"Country subdivision such as a state or province"},"SubSubCountry_Agent":{"type":"object","properties":{"name":{"type":"string"},"asciiName":{"type":"string"},"geoNameId":{"type":"string"}},"description":"Country sub sub division"},"SupplierContractItemPolicy_Agent":{"required":["refundable"],"type":"object","properties":{"refundable":{"type":"boolean","description":"Whether this booking is refundable or not.","example":true},"advanceCancellationFreeOfCharge":{"type":"string","description":"When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.","example":"UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL","enum":["UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL","UNTIL_FOURTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL","ONE_DAY_BEFORE_ARRIVAL","TWO_DAYS_BEFORE_ARRIVAL","THREE_DAYS_BEFORE_ARRIVAL","FIVE_DAYS_BEFORE_ARRIVAL","SEVEN_DAYS_BEFORE_ARRIVAL","FOURTEEN_DAYS_BEFORE_ARRIVAL","TWENTYONE_DAYS_BEFORE_ARRIVAL","THIRTY_DAYS_BEFORE_ARRIVAL","FOURTY_TWO_DAYS_BEFORE_ARRIVAL","SIXTY_DAYS_BEFORE_ARRIVAL"]},"refundableCancellationCharge":{"type":"string","description":"If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.","example":"FIFTY_PERCENT","enum":["FIRST_NIGHT","THIRTY_PERCENT","FIFTY_PERCENT","SIXTY_PERCENT","SEVENTY_PERCENT","NINENTY_PERCENT","ONE_HUNDRED_PERCENT"]},"noShowCharge":{"type":"string","description":"In case the 'Refundable cancellation charge' is set, a different no show charge can be applied.","example":"SAME_AS_CANCELLATION_FEE","enum":["SAME_AS_CANCELLATION_FEE","ONE_HUNDRED_PERCENT_OF_TOTAL_CHARGE"]},"nonRefundableCancellationCharge":{"type":"string","description":"When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.","example":"SEVENTY_PERCENT","enum":["FIRST_NIGHT","TEN_PERCENT","THIRTY_PERCENT","FIFTY_PERCENT","SEVENTY_PERCENT"]},"nonRefundableDeadline":{"type":"string","description":"The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.","example":"SEVEN_DAYS_BEFORE_ARRIVAL","enum":["ONE_DAY_BEFORE_ARRIVAL","TWO_DAYS_BEFORE_ARRIVAL","THREE_DAYS_BEFORE_ARRIVAL","FIVE_DAYS_BEFORE_ARRIVAL","SEVEN_DAYS_BEFORE_ARRIVAL","FOURTEEN_DAYS_BEFORE_ARRIVAL","TWENTYONE_DAYS_BEFORE_ARRIVAL","THIRTY_DAYS_BEFORE_ARRIVAL","FOURTY_TWO_DAYS_BEFORE_ARRIVAL","SIXTY_DAYS_BEFORE_ARRIVAL"]},"nonRefundableAfterDeadlineCancellationCharge":{"type":"string","description":"If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.","example":"ONE_HUNDRED_PERCENT","enum":["FIRST_NIGHT","TEN_PERCENT","THIRTY_PERCENT","FIFTY_PERCENT","SEVENTY_PERCENT","ONE_HUNDRED_PERCENT"]},"externalIdentifier":{"type":"string","description":"Optional geoname externalIdentifier to remote policy.","example":"policy-1"},"fullyRefundable":{"type":"boolean","readOnly":true},"partiallyRefundable":{"type":"boolean","readOnly":true}},"description":"Outlines the policy for this item."},"TravelInventoryRecognition_Agent":{"required":["category","identifier","maxRating","provider","rating","type"],"type":"object","properties":{"identifier":{"type":"string","description":"Recognition identifier.","format":"uuid"},"category":{"type":"string","description":"Recognition category.","example":"AWARD","enum":["THIRD_PARTY_REVIEW","PUBLICATION","AWARD"]},"type":{"type":"string","description":"Type of rating system the recognition operated on. This allows us to display the score properly.","example":"PERCENT_RATING","enum":["STAR_RATING","NUMERIC_RATING","PERCENT_RATING"]},"provider":{"type":"string","description":"The name of the entity that administers this recognition.","example":"Michelin"},"rating":{"minimum":0.0,"exclusiveMinimum":false,"type":"number","description":"The actual award or rating received by the hotel facility.","format":"float","example":8.5},"maxRating":{"type":"number","description":"Use this to let hotels indicate what the total score for this award is.","format":"float","example":10},"date":{"type":"string","description":"The date the award was received","format":"date","example":"2020-10-24"},"officialAppointmentInd":{"type":"boolean","description":"When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.","example":true},"ratingSymbol":{"type":"string","description":"Provides the symbol used in the rating. Used in conjunction with the Rating.","example":"*"}},"description":"Recognition for the ancillary inventory."},"UserSession_Agent":{"required":["itinerary"],"type":"object","properties":{"itinerary":{"$ref":"#/components/schemas/Itinerary_Agent"},"language":{"type":"string","description":"User's language preference","example":"en"},"currency":{"type":"string","description":"User's currency preference","example":"USD"},"promotionalCodes":{"type":"array","items":{"type":"string","description":"User can pass promotional codes to system to change prices.","example":"promo-1"}},"selectedRoomConfigurationIndex":{"type":"integer","description":"User can pass the current room configuration index to retrieve rates specifically for that room configuration.","format":"int32"},"lifestyle":{"type":"string","description":"The preferred user lifestyle.","enum":["LIFESTYLE_HEALTH_FITNESS","LIFESTYLE_RELAX","LIFESTYLE_ADULT_ONLY","LIFESTYLE_ADVENTURE","LIFESTYLE_BUSINESS","LIFESTYLE_LGBT","LIFESTYLE_SINGLE_PARENT","LIFESTYLE_SOLO_FEMALE","LIFESTYLE_BEAUTY","LIFESTYLE_FOODIE","LIFESTYLE_FAMILY","LIFESTYLE_ROMANCE","LIFESTYLE_COUPLE","LIFESTYLE_SOLO","LIFESTYLE_BACKPACKER","LIFESTYLE_SHOPPING","LIFESTYLE_SPORTS","LIFESTYLE_MOUNTAIN","LIFESTYLE_BEACH","LIFESTYLE_CITY","LIFESTYLE_COUNTRY","LIFESTYLE_CULTURE","LIFESTYLE_ECO"]}},"description":"User session information containing itinerary and other user related data."},"VariableCharge_Agent":{"type":"object"},"AggregateDescriptor_Agent":{"type":"object","properties":{"field":{"type":"string","description":"Field to run aggregate function on","example":"hotel.bookings"},"aggregate":{"type":"string","description":"Aggregate function","example":"count","enum":["count","sum","average","min","max"]}},"description":"Primitive aggregate data points"},"CompositeFilterDescriptor_Agent":{"type":"object","properties":{"logic":{"type":"string","description":"Whether to filter inclusively or exclusively","example":"and","enum":["and","or"]},"filters":{"type":"array","description":"Descriptors used for filtering the result set","items":{"$ref":"#/components/schemas/FilterDescriptor_Agent"}}},"description":"Descriptors used for filtering result set"},"FilterDescriptor_Agent":{"required":["field","operator","value"],"type":"object","properties":{"field":{"type":"string","description":"Field name to filter on","example":"hotel.name"},"operator":{"type":"string","description":"Filter operator to use on field","example":"startsWith","enum":["neq","eq","contains","doesnotcontain","isnull","isnotnull","isempty","isnotempty","startswith","endswith","gte","lte","gt","lt","in","nin"]},"value":{"type":"object","description":"Value to filter dataset against","example":"Happy Res"},"ignoreCase":{"type":"boolean","description":"Make filter comparison case insensitive. Default: Case sensitive ","example":true}},"description":"Descriptors used for filtering the result set"},"GroupDescriptor_Agent":{"type":"object","properties":{"field":{"type":"string","description":"Field to group data set on","example":"createdDate"},"dir":{"type":"string","description":"Group sort direction","example":"asc","enum":["asc","desc"]},"aggregates":{"type":"array","description":"Primitive aggregate data points","items":{"$ref":"#/components/schemas/AggregateDescriptor_Agent"}}},"description":"Descriptors to group result sets by."},"SortDescriptor_Agent":{"type":"object","properties":{"dir":{"type":"string","description":"Descriptors used for sorting result set","example":"asc","enum":["asc","desc"]},"field":{"type":"string","description":"Data set field to sort on","example":"hotel.name"}},"description":"Descriptors used for sorting result set."},"State_Agent":{"type":"object","properties":{"skip":{"minimum":0,"type":"integer","description":"Number of records to be skipped by the pager.","format":"int32","example":0,"default":0},"take":{"maximum":180,"minimum":1,"type":"integer","description":"Number of records to take.","format":"int32","example":10,"default":30},"sort":{"type":"array","description":"Descriptors used for sorting result set.","items":{"$ref":"#/components/schemas/SortDescriptor_Agent"}},"filter":{"$ref":"#/components/schemas/CompositeFilterDescriptor_Agent"},"group":{"type":"array","description":"Descriptors to group result sets by.","items":{"$ref":"#/components/schemas/GroupDescriptor_Agent"}}}},"PageBookingView_Agent":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"$ref":"#/components/schemas/BookingView_Agent"}},"number":{"type":"integer","format":"int32"},"sort":{"type":"array","items":{"$ref":"#/components/schemas/SortObject"}},"first":{"type":"boolean"},"last":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"pageable":{"$ref":"#/components/schemas/PageableObject_Agent"},"empty":{"type":"boolean"}}},"PageableObject_Agent":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"sort":{"type":"array","items":{"$ref":"#/components/schemas/SortObject"}},"paged":{"type":"boolean"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"unpaged":{"type":"boolean"}}},"SortObject":{"type":"object","properties":{"direction":{"type":"string"},"nullHandling":{"type":"string"},"ascending":{"type":"boolean"},"property":{"type":"string"},"ignoreCase":{"type":"boolean"}}},"CancellationDetail_Agent":{"required":["cancellationType","reason"],"type":"object","properties":{"cancellationType":{"type":"string","description":"Cancellation type","example":"CC_INVALID","enum":["DUPLICATE","CANCELLATION","NO_SHOW","CC_INVALID","CC_INSUFFICIENT","DISCRETIONARY"]},"reason":{"type":"string","description":"Reason for cancellation","example":"Death in the family"}}},"EmptyRequestBody_Agent":{"type":"object"},"BooleanResponse_Agent":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether call to endpoint was successful or not."},"message":{"type":"string","description":"A message indicating more textual information. Mostly used to convey an error message."}},"description":"Boolean response"},"UpsertTravelAgentRequest_Agent":{"required":["selfAcquires","selfDisburses"],"type":"object","properties":{"selfAcquires":{"type":"boolean","description":"Whether the agent is in charge of charging the property."},"selfDisburses":{"type":"boolean","description":"Whether the agent is in charge of paying the property."}}},"CompanyUser_Agent":{"required":["email"],"type":"object","properties":{"email":{"type":"string","description":"User email","example":"[email protected]"},"status":{"type":"string","description":"Contact phone number","example":"+12125551212","enum":["PENDING","ACCEPTED","DEACTIVATED"]},"userIdentifier":{"type":"string","description":"User identifier","format":"uuid"},"firstName":{"type":"string","description":"Contact first name","example":"John"},"lastName":{"type":"string","description":"Contact last name","example":"Smith"},"secondaryEmail":{"type":"string","description":"Contact secondary Email","example":"[email protected]"},"phoneNumber":{"type":"string","description":"Contact phone number","example":"+12125551212"},"profilePictureUrl":{"type":"string","description":"Profile picture is available"},"name":{"type":"string"}}},"CompanyView_Agent":{"required":["company"],"type":"object","properties":{"id":{"type":"string","description":"Document UUID","example":"doc-1"},"createdDate":{"type":"string","description":"Datetime this record was first created","format":"date-time"},"lastUpdate":{"type":"string","description":"Datetime this record was last updated","format":"date-time"},"version":{"type":"integer","description":"Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.","format":"int64","example":12},"company":{"$ref":"#/components/schemas/Company_Agent"}}},"Company_Agent":{"required":["address","approved","companyType","enabled","identifier","name","owner","type","url","urlName","userIdentifier","vatID"],"type":"object","properties":{"identifier":{"type":"string","description":"Unique identifier","format":"uuid"},"userIdentifier":{"type":"string","description":"User or Registered client owner identifier that created this record","format":"uuid"},"owner":{"$ref":"#/components/schemas/CompanyUser_Agent"},"name":{"type":"string","description":"Name of company","example":"Company 1"},"urlName":{"type":"string","description":"Url slug of company name","example":"company-1"},"legalName":{"type":"string","description":"Legal name of entity if other than name","example":"Legal Company 1"},"enabled":{"type":"boolean","description":"Whether this company is enabled by payment.","example":true},"approved":{"type":"boolean","description":"Whether this company has been approved by KYC.","example":true,"default":false},"companyType":{"type":"string","description":"Type of company","example":"COMPANY","enum":["COMPANY","INDIVIDUAL"]},"type":{"type":"string","description":"Type of sales channel","example":"APPLICATION","enum":["DIRECT","APPLICATION","HOTEL","TRAVELIKO","CORPORATE","TRAVEL_AGENT","INFLUENCER","BLOGGER","DESTINATION","CHANNEL_MANAGER","PROPERTY_MANAGEMENT_SYSTEM","CENTRAL_RESERVATION_SYSTEM","GOOGLE_HOTEL_API","MANAGEMENT_COMPANY","CHAIN","BRAND","EVENT_ORGANIZER"]},"vatID":{"type":"string","description":"An optional VAT ID","example":"vat-1"},"description":{"type":"string","description":"A personal message from the company."},"url":{"type":"string","description":"Company's main website","example":"https://www.mymainsite.com"},"address":{"$ref":"#/components/schemas/Address_Agent"},"managers":{"maxItems":30,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/CompanyUser_Agent"}},"urls":{"type":"array","description":"List of all active accounts that could be used for selling or seeing a company's reach.","items":{"type":"string","description":"List of all active accounts that could be used for selling or seeing a company's reach."}},"logo":{"$ref":"#/components/schemas/SimpleMultimedia_Agent"},"travelAgent":{"$ref":"#/components/schemas/TravelAgent_Agent"}},"description":"A Company is our definition of a sales channel / affiliate. A property also has a company record."},"TravelAgent_Agent":{"required":["selfAcquires","selfDisburses"],"type":"object","properties":{"selfAcquires":{"type":"boolean","description":"Whether the agent is in charge of charging the property."},"selfDisburses":{"type":"boolean","description":"Whether the agent is in charge of paying the property."}},"description":"Customize account with a custom logo / profile picture."}},"securitySchemes":{"oauth2ClientCredentials":{"type":"oauth2","description":"## Retrieve access token\nMake a POST (`Content-Type: application/x-www-form-urlencoded`) request to the Token URL below. Include one POST key/value entry: `grant_type=client_credentials` and include your clientID / secretKey credentials in a Basic Auth header. E.g. `Authorization: Basic base64_encode($clientId + ':' + $secretKey)`.\n## Add Bearer access token to all API requests\nOnce you have the access token, you can pass that along on all API requests in the authentication header: `'Authorization: Bearer $accessToken`.\nNote: Tokens expire after 3 hours. Please make sure you refresh your token before that time.","name":"Client Credentials","flows":{"clientCredentials":{"authorizationUrl":"https://iam.wink.travel/oauth2/authorize","tokenUrl":"https://iam.wink.travel/oauth2/token","refreshUrl":"https://iam.wink.travel/oauth2/refresh","scopes":{"inventory.read":"Read Wink data","inventory.write":"Create Wink data","inventory.remove":"Remove Wink data"}}}}}}}
