wink-sdk-travel-agent 0.0.41__py3-none-any.whl → 0.0.43__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of wink-sdk-travel-agent might be problematic. Click here for more details.
- wink_sdk_travel_agent/__init__.py +328 -101
- wink_sdk_travel_agent/api/__init__.py +18 -1
- wink_sdk_travel_agent/api/analytics_api.py +671 -0
- wink_sdk_travel_agent/api/travel_agent_api.py +1 -324
- wink_sdk_travel_agent/api_client.py +9 -2
- wink_sdk_travel_agent/configuration.py +3 -3
- wink_sdk_travel_agent/exceptions.py +1 -1
- wink_sdk_travel_agent/models/__init__.py +114 -9
- wink_sdk_travel_agent/models/agent_booking_request_agent.py +4 -4
- wink_sdk_travel_agent/models/aggregate_descriptor_agent.py +1 -1
- wink_sdk_travel_agent/models/authenticated_user_agent.py +3 -2
- wink_sdk_travel_agent/models/bed_agent.py +1 -1
- wink_sdk_travel_agent/models/bedroom_agent.py +1 -1
- wink_sdk_travel_agent/models/bedroom_configuration_agent.py +3 -2
- wink_sdk_travel_agent/models/beneficiary_agent.py +1 -1
- wink_sdk_travel_agent/models/beneficiary_charge_agent.py +1 -1
- wink_sdk_travel_agent/models/booking_agent.py +29 -28
- wink_sdk_travel_agent/models/booking_analytics_supplier.py +96 -0
- wink_sdk_travel_agent/models/booking_ancillary_agent.py +7 -6
- wink_sdk_travel_agent/models/booking_confirmations_agent.py +1 -1
- wink_sdk_travel_agent/models/booking_contract_agent.py +13 -12
- wink_sdk_travel_agent/models/booking_contract_item_agent.py +4 -4
- wink_sdk_travel_agent/models/booking_contract_payment_details_agent.py +1 -1
- wink_sdk_travel_agent/models/booking_itinerary_agent.py +5 -5
- wink_sdk_travel_agent/models/booking_itinerary_room_configuration_agent.py +1 -1
- wink_sdk_travel_agent/models/booking_itinerary_room_configuration_child_agent.py +1 -1
- wink_sdk_travel_agent/models/booking_overview_request_supplier.py +97 -0
- wink_sdk_travel_agent/models/booking_user_agent.py +3 -2
- wink_sdk_travel_agent/models/booking_user_request_agent.py +1 -1
- wink_sdk_travel_agent/models/booking_user_session_agent.py +1 -1
- wink_sdk_travel_agent/models/boolean_response_agent.py +1 -1
- wink_sdk_travel_agent/models/cancellation_detail_agent.py +1 -1
- wink_sdk_travel_agent/models/cancellation_policy_exception_agent.py +3 -3
- wink_sdk_travel_agent/models/cancellation_policy_exceptions_agent.py +1 -1
- wink_sdk_travel_agent/models/cancellation_policy_lightweight_agent.py +4 -3
- wink_sdk_travel_agent/models/chart_category_axis_supplier.py +88 -0
- wink_sdk_travel_agent/models/chart_legend_supplier.py +88 -0
- wink_sdk_travel_agent/models/chart_series_supplier.py +90 -0
- wink_sdk_travel_agent/models/chart_title_supplier.py +88 -0
- wink_sdk_travel_agent/models/child_agent.py +1 -1
- wink_sdk_travel_agent/models/commissionable_entry_agent.py +1 -1
- wink_sdk_travel_agent/models/composite_filter_descriptor_agent.py +1 -1
- wink_sdk_travel_agent/models/contact_agent.py +1 -1
- wink_sdk_travel_agent/models/country_lightweight_agent.py +1 -1
- wink_sdk_travel_agent/models/create_agent_booking400_response.py +1 -1
- wink_sdk_travel_agent/models/create_agent_booking_request_agent.py +1 -1
- wink_sdk_travel_agent/models/custom_monetary_amount.py +1 -1
- wink_sdk_travel_agent/models/customization_lightweight_agent.py +5 -4
- wink_sdk_travel_agent/models/customization_theme_colors_agent.py +1 -1
- wink_sdk_travel_agent/models/extra_charge_agent.py +1 -1
- wink_sdk_travel_agent/models/extra_charges_agent.py +1 -1
- wink_sdk_travel_agent/models/filter_descriptor_agent.py +1 -1
- wink_sdk_travel_agent/models/general_manager_agent.py +1 -1
- wink_sdk_travel_agent/models/generic_error_message.py +4 -6
- wink_sdk_travel_agent/models/geo_json_point_agent.py +1 -1
- wink_sdk_travel_agent/models/geo_name_lightweight_agent.py +1 -1
- wink_sdk_travel_agent/models/group_descriptor_agent.py +1 -1
- wink_sdk_travel_agent/models/grouped_booking_sales_metrics_supplier_details.py +110 -0
- wink_sdk_travel_agent/models/guest_room_lightweight_agent.py +5 -4
- wink_sdk_travel_agent/models/guest_user_agent.py +3 -2
- wink_sdk_travel_agent/models/line_chart_supplier.py +122 -0
- wink_sdk_travel_agent/models/localized_description_agent.py +1 -1
- wink_sdk_travel_agent/models/localized_price_agent.py +4 -4
- wink_sdk_travel_agent/models/media_author_attribution_agent.py +1 -1
- wink_sdk_travel_agent/models/page_booking_agent.py +4 -4
- wink_sdk_travel_agent/models/pageable_object_agent.py +1 -1
- wink_sdk_travel_agent/models/payout_agent.py +4 -3
- wink_sdk_travel_agent/models/payout_fee_agent.py +3 -2
- wink_sdk_travel_agent/models/perk_lightweight_agent.py +1 -1
- wink_sdk_travel_agent/models/personal_agent.py +1 -1
- wink_sdk_travel_agent/models/preferences_agent.py +1 -1
- wink_sdk_travel_agent/models/profile_lightweight_agent.py +4 -4
- wink_sdk_travel_agent/models/profile_user_agent.py +1 -1
- wink_sdk_travel_agent/models/property_aggregate_lightweight_agent.py +6 -3
- wink_sdk_travel_agent/models/property_policy_agent.py +1 -1
- wink_sdk_travel_agent/models/quote_lightweight_agent.py +1 -1
- wink_sdk_travel_agent/models/rate_plan_level_fee_agent.py +1 -1
- wink_sdk_travel_agent/models/refund_agent.py +1 -1
- wink_sdk_travel_agent/models/review_answer_agent.py +3 -3
- wink_sdk_travel_agent/models/review_lightweight_agent.py +5 -4
- wink_sdk_travel_agent/models/review_user_agent.py +3 -2
- wink_sdk_travel_agent/models/room_configuration_agent.py +1 -1
- wink_sdk_travel_agent/models/room_configuration_price_rate_plan_agent.py +3 -2
- wink_sdk_travel_agent/models/room_stay_agent.py +6 -5
- wink_sdk_travel_agent/models/simple_address_agent.py +1 -1
- wink_sdk_travel_agent/models/simple_date_time_itinerary_agent.py +5 -5
- wink_sdk_travel_agent/models/simple_description_agent.py +1 -1
- wink_sdk_travel_agent/models/simple_multimedia_agent.py +3 -2
- wink_sdk_travel_agent/models/social_agent.py +1 -1
- wink_sdk_travel_agent/models/sort_descriptor_agent.py +1 -1
- wink_sdk_travel_agent/models/sort_object_agent.py +1 -1
- wink_sdk_travel_agent/models/state_agent.py +1 -1
- wink_sdk_travel_agent/models/stay_rate_agent.py +5 -5
- wink_sdk_travel_agent/models/sub_country_lightweight_agent.py +1 -1
- wink_sdk_travel_agent/models/sub_sub_country_lightweight_agent.py +1 -1
- wink_sdk_travel_agent/models/supplier_contract_item_policy_agent.py +1 -1
- wink_sdk_travel_agent/models/travel_inventory_recognition_agent.py +3 -2
- wink_sdk_travel_agent/rest.py +1 -1
- {wink_sdk_travel_agent-0.0.41.dist-info → wink_sdk_travel_agent-0.0.43.dist-info}/METADATA +24 -24
- wink_sdk_travel_agent-0.0.43.dist-info/RECORD +143 -0
- wink_sdk_travel_agent-0.0.41.dist-info/RECORD +0 -134
- {wink_sdk_travel_agent-0.0.41.dist-info → wink_sdk_travel_agent-0.0.43.dist-info}/WHEEL +0 -0
- {wink_sdk_travel_agent-0.0.41.dist-info → wink_sdk_travel_agent-0.0.43.dist-info}/licenses/LICENSE +0 -0
- {wink_sdk_travel_agent-0.0.41.dist-info → wink_sdk_travel_agent-0.0.43.dist-info}/top_level.txt +0 -0
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
# Introduction 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. 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. # Integrations 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. # Intended Audience 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. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume 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. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [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. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [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. ### Taxonomy APIs 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. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs 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. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs 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). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning 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. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 30.
|
|
8
|
+
The version of the OpenAPI document: 30.21.0
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -21,6 +21,7 @@ import json
|
|
|
21
21
|
from datetime import datetime
|
|
22
22
|
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
|
|
23
23
|
from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
24
|
+
from uuid import UUID
|
|
24
25
|
from wink_sdk_travel_agent.models.booking_ancillary_agent import BookingAncillaryAgent
|
|
25
26
|
from wink_sdk_travel_agent.models.booking_contract_agent import BookingContractAgent
|
|
26
27
|
from wink_sdk_travel_agent.models.booking_user_agent import BookingUserAgent
|
|
@@ -44,7 +45,7 @@ class BookingAgent(BaseModel):
|
|
|
44
45
|
last_update: Optional[datetime] = Field(default=None, description="Datetime this record was last updated", alias="lastUpdate")
|
|
45
46
|
version: Optional[StrictInt] = Field(default=None, 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.")
|
|
46
47
|
creation: StrictStr = Field(description="Communicates whether the booking was created normally or if it failed or was just for testing.")
|
|
47
|
-
group_identifier:
|
|
48
|
+
group_identifier: UUID = Field(description="Unique record identifier for the collection of bookings that were made at the same time.", alias="groupIdentifier")
|
|
48
49
|
customization: CustomizationLightweightAgent = Field(description="Which customization configuration record did the entity application used to facilitate in making this booking happen.")
|
|
49
50
|
booking_code: StrictStr = Field(description="Unique user-friendly booking geoname. This code should be used when corresponding with travelers.", alias="bookingCode")
|
|
50
51
|
user: BookingUserAgent = Field(description="User details for the authenticated person that made the booking.")
|
|
@@ -69,6 +70,16 @@ class BookingAgent(BaseModel):
|
|
|
69
70
|
booking_contract: Optional[BookingContractAgent] = Field(default=None, description="Booking contract created by TripPay", alias="bookingContract")
|
|
70
71
|
static_map_image_url: Optional[StrictStr] = Field(default=None, description="Url of map image that can be sent via email", alias="staticMapImageUrl")
|
|
71
72
|
static_map_url: Optional[StrictStr] = Field(default=None, description="Url of map image location on Google Maps", alias="staticMapUrl")
|
|
73
|
+
status: Optional[StrictStr] = Field(default=None, description="Convenience data point to show which status the booking currently has.")
|
|
74
|
+
has_breakfast: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to breakfast quickly.", alias="hasBreakfast")
|
|
75
|
+
has_brunch: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to brunch quickly.", alias="hasBrunch")
|
|
76
|
+
has_lunch: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to lunch quickly.", alias="hasLunch")
|
|
77
|
+
has_dinner: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to dinner quickly.", alias="hasDinner")
|
|
78
|
+
has_all_inclusive: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to all-inclusive quickly.", alias="hasAllInclusive")
|
|
79
|
+
has_all_inclusive_plus_alcohol: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to all-inclusive with alcohol quickly.", alias="hasAllInclusivePlusAlcohol")
|
|
80
|
+
rate_source: Optional[StrictStr] = Field(default=None, description="Rate origin. This is usually the property channel manager.", alias="rateSource")
|
|
81
|
+
has_add_ons: Optional[StrictBool] = Field(default=None, description="Convenience data point to check if any add-on offers are in this booking.", alias="hasAddOns")
|
|
82
|
+
cancellable_by_agent: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the agent.", alias="cancellableByAgent")
|
|
72
83
|
meeting_rooms: Optional[List[BookingAncillaryAgent]] = Field(default=None, description="Meeting room reservation records.", alias="meetingRooms")
|
|
73
84
|
restaurants: Optional[List[BookingAncillaryAgent]] = Field(default=None, description="Restaurant reservation records.")
|
|
74
85
|
spas: Optional[List[BookingAncillaryAgent]] = Field(default=None, description="Spa reservation records.")
|
|
@@ -76,19 +87,7 @@ class BookingAgent(BaseModel):
|
|
|
76
87
|
attractions: Optional[List[BookingAncillaryAgent]] = Field(default=None, description="Attraction reservation records.")
|
|
77
88
|
places: Optional[List[BookingAncillaryAgent]] = Field(default=None, description="Place reservation records.")
|
|
78
89
|
room_type_ancillaries: Optional[List[BookingAncillaryAgent]] = Field(default=None, description="Room type ancillary records.", alias="roomTypeAncillaries")
|
|
79
|
-
status: Optional[StrictStr] = Field(default=None, description="Convenience data point to show which status the booking currently has.")
|
|
80
|
-
rate_source: Optional[StrictStr] = Field(default=None, description="Rate origin. This is usually the property channel manager.", alias="rateSource")
|
|
81
|
-
has_add_ons: Optional[StrictBool] = Field(default=None, description="Convenience data point to check if any add-on offers are in this booking.", alias="hasAddOns")
|
|
82
|
-
cancellable_by_agent: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the agent.", alias="cancellableByAgent")
|
|
83
|
-
cancellable_by_supplier: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the supplier.", alias="cancellableBySupplier")
|
|
84
|
-
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the traveller.", alias="cancellableByTraveler")
|
|
85
90
|
add_ons: Optional[List[BookingAncillaryAgent]] = Field(default=None, description="Add-on records.", alias="addOns")
|
|
86
|
-
has_breakfast: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to breakfast quickly.", alias="hasBreakfast")
|
|
87
|
-
has_brunch: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to brunch quickly.", alias="hasBrunch")
|
|
88
|
-
has_lunch: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to lunch quickly.", alias="hasLunch")
|
|
89
|
-
has_dinner: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to dinner quickly.", alias="hasDinner")
|
|
90
|
-
has_all_inclusive: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to all-inclusive quickly.", alias="hasAllInclusive")
|
|
91
|
-
has_all_inclusive_plus_alcohol: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to all-inclusive with alcohol quickly.", alias="hasAllInclusivePlusAlcohol")
|
|
92
91
|
has_room_type_ancillaries: Optional[StrictBool] = Field(default=None, description="Convenience data point to check if any room type ancillaries are in this booking.", alias="hasRoomTypeAncillaries")
|
|
93
92
|
has_food: Optional[StrictBool] = Field(default=None, description="Convenience data point to check if any food is included in this booking.", alias="hasFood")
|
|
94
93
|
has_restaurants: Optional[StrictBool] = Field(default=None, description="Convenience data point to check if any restaurant reservations are included in this booking.", alias="hasRestaurants")
|
|
@@ -100,7 +99,9 @@ class BookingAgent(BaseModel):
|
|
|
100
99
|
reporting_daily_rate_list: Optional[List[Any]] = Field(default=None, alias="reportingDailyRateList")
|
|
101
100
|
reporting_ancillary_list: Optional[List[Any]] = Field(default=None, alias="reportingAncillaryList")
|
|
102
101
|
reporting_extra_charge_list: Optional[List[Any]] = Field(default=None, alias="reportingExtraChargeList")
|
|
103
|
-
|
|
102
|
+
cancellable_by_supplier: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the supplier.", alias="cancellableBySupplier")
|
|
103
|
+
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the traveller.", alias="cancellableByTraveler")
|
|
104
|
+
__properties: ClassVar[List[str]] = ["id", "createdDate", "lastUpdate", "version", "creation", "groupIdentifier", "customization", "bookingCode", "user", "userSession", "serverUrl", "socials", "review", "emailHeaderLogoUrl", "logoIdentifier", "hotel", "roomStay", "specialRequests", "comment", "earlyCheckInCharge", "lateCheckOutCharge", "earlyCheckInChargePercent", "lateCheckOutChargePercent", "hotelImageUrl", "roomImageUrl", "commissionList", "ancillaryList", "bookingContract", "staticMapImageUrl", "staticMapUrl", "status", "hasBreakfast", "hasBrunch", "hasLunch", "hasDinner", "hasAllInclusive", "hasAllInclusivePlusAlcohol", "rateSource", "hasAddOns", "cancellableByAgent", "meetingRooms", "restaurants", "spas", "activities", "attractions", "places", "roomTypeAncillaries", "addOns", "hasRoomTypeAncillaries", "hasFood", "hasRestaurants", "hasMeetingRooms", "hasSpas", "hasActivities", "hasAttractions", "hasPlaces", "reportingDailyRateList", "reportingAncillaryList", "reportingExtraChargeList", "cancellableBySupplier", "cancellableByTraveler"]
|
|
104
105
|
|
|
105
106
|
@field_validator('creation')
|
|
106
107
|
def creation_validate_enum(cls, value):
|
|
@@ -304,6 +305,16 @@ class BookingAgent(BaseModel):
|
|
|
304
305
|
"bookingContract": BookingContractAgent.from_dict(obj["bookingContract"]) if obj.get("bookingContract") is not None else None,
|
|
305
306
|
"staticMapImageUrl": obj.get("staticMapImageUrl"),
|
|
306
307
|
"staticMapUrl": obj.get("staticMapUrl"),
|
|
308
|
+
"status": obj.get("status"),
|
|
309
|
+
"hasBreakfast": obj.get("hasBreakfast"),
|
|
310
|
+
"hasBrunch": obj.get("hasBrunch"),
|
|
311
|
+
"hasLunch": obj.get("hasLunch"),
|
|
312
|
+
"hasDinner": obj.get("hasDinner"),
|
|
313
|
+
"hasAllInclusive": obj.get("hasAllInclusive"),
|
|
314
|
+
"hasAllInclusivePlusAlcohol": obj.get("hasAllInclusivePlusAlcohol"),
|
|
315
|
+
"rateSource": obj.get("rateSource"),
|
|
316
|
+
"hasAddOns": obj.get("hasAddOns"),
|
|
317
|
+
"cancellableByAgent": obj.get("cancellableByAgent"),
|
|
307
318
|
"meetingRooms": [BookingAncillaryAgent.from_dict(_item) for _item in obj["meetingRooms"]] if obj.get("meetingRooms") is not None else None,
|
|
308
319
|
"restaurants": [BookingAncillaryAgent.from_dict(_item) for _item in obj["restaurants"]] if obj.get("restaurants") is not None else None,
|
|
309
320
|
"spas": [BookingAncillaryAgent.from_dict(_item) for _item in obj["spas"]] if obj.get("spas") is not None else None,
|
|
@@ -311,19 +322,7 @@ class BookingAgent(BaseModel):
|
|
|
311
322
|
"attractions": [BookingAncillaryAgent.from_dict(_item) for _item in obj["attractions"]] if obj.get("attractions") is not None else None,
|
|
312
323
|
"places": [BookingAncillaryAgent.from_dict(_item) for _item in obj["places"]] if obj.get("places") is not None else None,
|
|
313
324
|
"roomTypeAncillaries": [BookingAncillaryAgent.from_dict(_item) for _item in obj["roomTypeAncillaries"]] if obj.get("roomTypeAncillaries") is not None else None,
|
|
314
|
-
"status": obj.get("status"),
|
|
315
|
-
"rateSource": obj.get("rateSource"),
|
|
316
|
-
"hasAddOns": obj.get("hasAddOns"),
|
|
317
|
-
"cancellableByAgent": obj.get("cancellableByAgent"),
|
|
318
|
-
"cancellableBySupplier": obj.get("cancellableBySupplier"),
|
|
319
|
-
"cancellableByTraveler": obj.get("cancellableByTraveler"),
|
|
320
325
|
"addOns": [BookingAncillaryAgent.from_dict(_item) for _item in obj["addOns"]] if obj.get("addOns") is not None else None,
|
|
321
|
-
"hasBreakfast": obj.get("hasBreakfast"),
|
|
322
|
-
"hasBrunch": obj.get("hasBrunch"),
|
|
323
|
-
"hasLunch": obj.get("hasLunch"),
|
|
324
|
-
"hasDinner": obj.get("hasDinner"),
|
|
325
|
-
"hasAllInclusive": obj.get("hasAllInclusive"),
|
|
326
|
-
"hasAllInclusivePlusAlcohol": obj.get("hasAllInclusivePlusAlcohol"),
|
|
327
326
|
"hasRoomTypeAncillaries": obj.get("hasRoomTypeAncillaries"),
|
|
328
327
|
"hasFood": obj.get("hasFood"),
|
|
329
328
|
"hasRestaurants": obj.get("hasRestaurants"),
|
|
@@ -334,7 +333,9 @@ class BookingAgent(BaseModel):
|
|
|
334
333
|
"hasPlaces": obj.get("hasPlaces"),
|
|
335
334
|
"reportingDailyRateList": obj.get("reportingDailyRateList"),
|
|
336
335
|
"reportingAncillaryList": obj.get("reportingAncillaryList"),
|
|
337
|
-
"reportingExtraChargeList": obj.get("reportingExtraChargeList")
|
|
336
|
+
"reportingExtraChargeList": obj.get("reportingExtraChargeList"),
|
|
337
|
+
"cancellableBySupplier": obj.get("cancellableBySupplier"),
|
|
338
|
+
"cancellableByTraveler": obj.get("cancellableByTraveler")
|
|
338
339
|
})
|
|
339
340
|
return _obj
|
|
340
341
|
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Wink API
|
|
5
|
+
|
|
6
|
+
# Introduction 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. 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. # Integrations 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. # Intended Audience 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. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume 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. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [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. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [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. ### Taxonomy APIs 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. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs 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. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs 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). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning 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. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 30.21.0
|
|
9
|
+
Contact: bjorn@wink.travel
|
|
10
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
|
+
|
|
12
|
+
Do not edit the class manually.
|
|
13
|
+
""" # noqa: E501
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
from __future__ import annotations
|
|
17
|
+
import pprint
|
|
18
|
+
import re # noqa: F401
|
|
19
|
+
import json
|
|
20
|
+
|
|
21
|
+
from pydantic import BaseModel, ConfigDict, Field
|
|
22
|
+
from typing import Any, ClassVar, Dict, List
|
|
23
|
+
from wink_sdk_travel_agent.models.line_chart_supplier import LineChartSupplier
|
|
24
|
+
from typing import Optional, Set
|
|
25
|
+
from typing_extensions import Self
|
|
26
|
+
|
|
27
|
+
class BookingAnalyticsSupplier(BaseModel):
|
|
28
|
+
"""
|
|
29
|
+
BookingAnalyticsSupplier
|
|
30
|
+
""" # noqa: E501
|
|
31
|
+
charts: List[LineChartSupplier] = Field(description="Interesting property-level chart data overview")
|
|
32
|
+
__properties: ClassVar[List[str]] = ["charts"]
|
|
33
|
+
|
|
34
|
+
model_config = ConfigDict(
|
|
35
|
+
populate_by_name=True,
|
|
36
|
+
validate_assignment=True,
|
|
37
|
+
protected_namespaces=(),
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
def to_str(self) -> str:
|
|
42
|
+
"""Returns the string representation of the model using alias"""
|
|
43
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
44
|
+
|
|
45
|
+
def to_json(self) -> str:
|
|
46
|
+
"""Returns the JSON representation of the model using alias"""
|
|
47
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
48
|
+
return json.dumps(self.to_dict())
|
|
49
|
+
|
|
50
|
+
@classmethod
|
|
51
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
52
|
+
"""Create an instance of BookingAnalyticsSupplier from a JSON string"""
|
|
53
|
+
return cls.from_dict(json.loads(json_str))
|
|
54
|
+
|
|
55
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
56
|
+
"""Return the dictionary representation of the model using alias.
|
|
57
|
+
|
|
58
|
+
This has the following differences from calling pydantic's
|
|
59
|
+
`self.model_dump(by_alias=True)`:
|
|
60
|
+
|
|
61
|
+
* `None` is only added to the output dict for nullable fields that
|
|
62
|
+
were set at model initialization. Other fields with value `None`
|
|
63
|
+
are ignored.
|
|
64
|
+
"""
|
|
65
|
+
excluded_fields: Set[str] = set([
|
|
66
|
+
])
|
|
67
|
+
|
|
68
|
+
_dict = self.model_dump(
|
|
69
|
+
by_alias=True,
|
|
70
|
+
exclude=excluded_fields,
|
|
71
|
+
exclude_none=True,
|
|
72
|
+
)
|
|
73
|
+
# override the default output from pydantic by calling `to_dict()` of each item in charts (list)
|
|
74
|
+
_items = []
|
|
75
|
+
if self.charts:
|
|
76
|
+
for _item_charts in self.charts:
|
|
77
|
+
if _item_charts:
|
|
78
|
+
_items.append(_item_charts.to_dict())
|
|
79
|
+
_dict['charts'] = _items
|
|
80
|
+
return _dict
|
|
81
|
+
|
|
82
|
+
@classmethod
|
|
83
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
84
|
+
"""Create an instance of BookingAnalyticsSupplier from a dict"""
|
|
85
|
+
if obj is None:
|
|
86
|
+
return None
|
|
87
|
+
|
|
88
|
+
if not isinstance(obj, dict):
|
|
89
|
+
return cls.model_validate(obj)
|
|
90
|
+
|
|
91
|
+
_obj = cls.model_validate({
|
|
92
|
+
"charts": [LineChartSupplier.from_dict(_item) for _item in obj["charts"]] if obj.get("charts") is not None else None
|
|
93
|
+
})
|
|
94
|
+
return _obj
|
|
95
|
+
|
|
96
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
# Introduction 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. 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. # Integrations 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. # Intended Audience 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. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume 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. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [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. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [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. ### Taxonomy APIs 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. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs 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. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs 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). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning 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. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 30.
|
|
8
|
+
The version of the OpenAPI document: 30.21.0
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -22,6 +22,7 @@ from datetime import datetime
|
|
|
22
22
|
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
|
|
23
23
|
from typing import Any, ClassVar, Dict, List, Union
|
|
24
24
|
from typing_extensions import Annotated
|
|
25
|
+
from uuid import UUID
|
|
25
26
|
from wink_sdk_travel_agent.models.contact_agent import ContactAgent
|
|
26
27
|
from wink_sdk_travel_agent.models.localized_price_agent import LocalizedPriceAgent
|
|
27
28
|
from wink_sdk_travel_agent.models.simple_address_agent import SimpleAddressAgent
|
|
@@ -32,10 +33,10 @@ class BookingAncillaryAgent(BaseModel):
|
|
|
32
33
|
"""
|
|
33
34
|
BookingAncillaryAgent
|
|
34
35
|
""" # noqa: E501
|
|
35
|
-
identifier:
|
|
36
|
-
hotel_identifier:
|
|
37
|
-
type_identifier:
|
|
38
|
-
transactional_travel_inventory_identifier:
|
|
36
|
+
identifier: UUID = Field(description="Ancillary identifier")
|
|
37
|
+
hotel_identifier: UUID = Field(description="Hotel identifier", alias="hotelIdentifier")
|
|
38
|
+
type_identifier: UUID = Field(description="Travel inventory identifier", alias="typeIdentifier")
|
|
39
|
+
transactional_travel_inventory_identifier: UUID = Field(description="Travel inventory identifier", alias="transactionalTravelInventoryIdentifier")
|
|
39
40
|
name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Name of inventory")
|
|
40
41
|
pricing_type: StrictStr = Field(description="Pricing type", alias="pricingType")
|
|
41
42
|
type: StrictStr = Field(description="Inventory type")
|
|
@@ -46,7 +47,7 @@ class BookingAncillaryAgent(BaseModel):
|
|
|
46
47
|
image_identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Cloudinary image identifier", alias="imageIdentifier")
|
|
47
48
|
image_url: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Absolute URL to image of inventory", alias="imageUrl")
|
|
48
49
|
localized_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Name of travel inventory in traveler language (if available). Defaults to English.", alias="localizedName")
|
|
49
|
-
localized_description: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Description of travel
|
|
50
|
+
localized_description: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Description of travel inventory in traveler language (if available). Defaults to English.", alias="localizedDescription")
|
|
50
51
|
contact: ContactAgent = Field(description="Travel blocking contact (if applicable)")
|
|
51
52
|
address: SimpleAddressAgent = Field(description="Travel blocking address (if applicable)")
|
|
52
53
|
commissionable: StrictBool
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
# Introduction 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. 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. # Integrations 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. # Intended Audience 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. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume 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. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [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. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [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. ### Taxonomy APIs 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. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs 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. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs 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). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning 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. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 30.
|
|
8
|
+
The version of the OpenAPI document: 30.21.0
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
# Introduction 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. 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. # Integrations 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. # Intended Audience 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. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume 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. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [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. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [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. ### Taxonomy APIs 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. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs 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. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs 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). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning 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. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 30.
|
|
8
|
+
The version of the OpenAPI document: 30.21.0
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -22,6 +22,7 @@ from datetime import date, datetime
|
|
|
22
22
|
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
|
|
23
23
|
from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
24
24
|
from typing_extensions import Annotated
|
|
25
|
+
from uuid import UUID
|
|
25
26
|
from wink_sdk_travel_agent.models.authenticated_user_agent import AuthenticatedUserAgent
|
|
26
27
|
from wink_sdk_travel_agent.models.beneficiary_agent import BeneficiaryAgent
|
|
27
28
|
from wink_sdk_travel_agent.models.booking_contract_item_agent import BookingContractItemAgent
|
|
@@ -37,7 +38,7 @@ class BookingContractAgent(BaseModel):
|
|
|
37
38
|
"""
|
|
38
39
|
BookingContractAgent
|
|
39
40
|
""" # noqa: E501
|
|
40
|
-
booking_contract_identifier: Optional[
|
|
41
|
+
booking_contract_identifier: Optional[UUID] = Field(default=None, description="Document UUID", alias="bookingContractIdentifier")
|
|
41
42
|
created_date: Optional[datetime] = Field(default=None, description="Datetime this record was first created", alias="createdDate")
|
|
42
43
|
last_update: Optional[datetime] = Field(default=None, description="Datetime this record was last updated", alias="lastUpdate")
|
|
43
44
|
federated_organization_identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The auth realm owner ID", alias="federatedOrganizationIdentifier")
|
|
@@ -46,8 +47,8 @@ class BookingContractAgent(BaseModel):
|
|
|
46
47
|
ip_address: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Caller's IP address", alias="ipAddress")
|
|
47
48
|
trace_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Way to track which booking contracts were made together", alias="traceId")
|
|
48
49
|
source_url: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Where did the booking occur", alias="sourceUrl")
|
|
49
|
-
identifier:
|
|
50
|
-
supplier_identifier:
|
|
50
|
+
identifier: UUID = Field(description="Unique identifier used to track the contract. Create a UUID for this purpose.")
|
|
51
|
+
supplier_identifier: UUID = Field(description="Supplier identifier", alias="supplierIdentifier")
|
|
51
52
|
supplier_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Supplier name", alias="supplierName")
|
|
52
53
|
display_price_quote: QuoteLightweightAgent = Field(description="The quote used to create totalDisplayPrice.", alias="displayPriceQuote")
|
|
53
54
|
supplier_price_quote: QuoteLightweightAgent = Field(description="The quote used to create totalSupplierPrice.", alias="supplierPriceQuote")
|
|
@@ -182,15 +183,15 @@ class BookingContractAgent(BaseModel):
|
|
|
182
183
|
platform_identifier: Optional[StrictStr] = Field(default=None, description="Returns the account identifier for the beneficiary taking a platform fee", alias="platformIdentifier")
|
|
183
184
|
total_funds_grouped_by_beneficiary: Optional[List[BeneficiaryAgent]] = Field(default=None, description="Returns all the beneficiaries in this contract with their total amounts", alias="totalFundsGroupedByBeneficiary")
|
|
184
185
|
total_tokens_earned: Optional[StrictInt] = Field(default=None, description="Total amount of tokens minted on this contract.", alias="totalTokensEarned")
|
|
186
|
+
fully_refunded: Optional[StrictBool] = Field(default=None, alias="fullyRefunded")
|
|
185
187
|
self_acquiring: Optional[StrictBool] = Field(default=None, alias="selfAcquiring")
|
|
186
188
|
lodging: Optional[BookingContractItemAgent] = Field(default=None, description="Returns the lodging item only.")
|
|
187
189
|
cancellable_by_agent: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by an agent.", alias="cancellableByAgent")
|
|
188
|
-
cancellable_by_supplier: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the supplier.", alias="cancellableBySupplier")
|
|
189
|
-
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the traveller.", alias="cancellableByTraveler")
|
|
190
|
-
fully_refunded: Optional[StrictBool] = Field(default=None, alias="fullyRefunded")
|
|
191
190
|
cancellable_with_no_charges: Optional[StrictBool] = Field(default=None, description="Whether the cancellation comes at no cost to the traveler.", alias="cancellableWithNoCharges")
|
|
192
191
|
is_cancellable_with_potential_charges: Optional[StrictBool] = Field(default=None, description="Whether a cancellation comes with partial charges. I.e. Only some of the items in contract are not fully refundable.", alias="isCancellableWithPotentialCharges")
|
|
193
|
-
|
|
192
|
+
cancellable_by_supplier: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the supplier.", alias="cancellableBySupplier")
|
|
193
|
+
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the traveller.", alias="cancellableByTraveler")
|
|
194
|
+
__properties: ClassVar[List[str]] = ["bookingContractIdentifier", "createdDate", "lastUpdate", "federatedOrganizationIdentifier", "federatedOrganizationName", "user", "ipAddress", "traceId", "sourceUrl", "identifier", "supplierIdentifier", "supplierName", "displayPriceQuote", "supplierPriceQuote", "internalPriceQuote", "capturePriceQuote", "itemList", "externalSupplierIdentifier", "externalSupplierBookingCode", "payment", "cancelled", "cancelledOn", "canceller", "cancellationType", "cancellerUserIdentifier", "cancelReason", "fundsProcessed", "refunds", "payouts", "sourceCurrency", "displayCurrency", "supplierCurrency", "internalCurrency", "captureCurrency", "sourceAmount", "displayAmount", "supplierAmount", "internalAmount", "captureAmount", "sourceAmountRefundModifier", "displayAmountRefundModifier", "supplierAmountRefundModifier", "internalAmountRefundModifier", "captureAmountRefundModifier", "netSourceAmount", "netDisplayAmount", "netSupplierAmount", "netInternalAmount", "netCaptureAmount", "metadata", "netCommissionableTotalSourceAmount", "netCommissionableTotalCaptureAmount", "netCommissionableTotalDisplayAmount", "netCommissionableTotalSupplierAmount", "netCommissionableTotalInternalAmount", "netTotalFeesAndCommissionsSourceAmount", "netTotalFeesAndCommissionsCaptureAmount", "netTotalFeesAndCommissionsDisplayAmount", "netTotalFeesAndCommissionsSupplierAmount", "netTotalFeesAndCommissionsInternalAmount", "netTotalFeesSourceAmount", "netTotalFeesCaptureAmount", "netTotalFeesDisplayAmount", "netTotalFeesSupplierAmount", "netTotalFeesInternalAmount", "netTotalTripPayFeeSourceAmount", "netTotalTripPayFeeCaptureAmount", "netTotalTripPayFeeDisplayAmount", "netTotalTripPayFeeSupplierAmount", "netTotalTripPayFeeInternalAmount", "netTotalSalesSourceAmount", "netTotalSalesCaptureAmount", "netTotalSalesDisplayAmount", "netTotalSalesSupplierAmount", "netTotalSalesInternalAmount", "commissionableTotalSourceAmount", "commissionableTotalCaptureAmount", "commissionableTotalDisplayAmount", "commissionableTotalSupplierAmount", "commissionableTotalInternalAmount", "totalFeesAndCommissionsSourceAmount", "totalFeesAndCommissionsCaptureAmount", "totalFeesAndCommissionsDisplayAmount", "totalFeesAndCommissionsSupplierAmount", "totalFeesAndCommissionsInternalAmount", "totalFeesSourceAmount", "totalFeesCaptureAmount", "totalFeesDisplayAmount", "totalFeesSupplierAmount", "totalFeesInternalAmount", "totalTripPayFeeSourceAmount", "totalTripPayFeeCaptureAmount", "totalTripPayFeeDisplayAmount", "totalTripPayFeeSupplierAmount", "totalTripPayFeeInternalAmount", "totalSalesSourceAmount", "totalSalesCaptureAmount", "totalSalesDisplayAmount", "totalSalesSupplierAmount", "totalSalesInternalAmount", "fundsAvailableDate", "totalFeesInPercentWithRefund", "totalFeesInPercent", "totalTripPayFeeInPercentWithRefund", "totalTripPayFeeInPercent", "totalCommissionsInPercentWithRefund", "totalCommissionsInPercent", "totalFeesAndCommissionsInPercentWithRefund", "totalFeesAndCommissionsInPercent", "originalFeesInPercent", "originalAffiliateAgencyFeesInPercent", "originalSupplierAgencyFeesInPercent", "originalCommissionsInPercent", "netTotalCustomersSourceAmount", "netTotalCustomersCaptureAmount", "netTotalCustomersDisplayAmount", "netTotalCustomersSupplierAmount", "netTotalCustomersInternalAmount", "totalAffiliateAgencyFeesSourceAmount", "totalAffiliateAgencyFeesCaptureAmount", "totalAffiliateAgencyFeesDisplayAmount", "totalAffiliateAgencyFeesSupplierAmount", "totalAffiliateAgencyFeesInternalAmount", "totalSupplierAgencyFeesSourceAmount", "totalSupplierAgencyFeesCaptureAmount", "totalSupplierAgencyFeesDisplayAmount", "totalSupplierAgencyFeesSupplierAmount", "totalSupplierAgencyFeesInternalAmount", "netTotalAffiliateAgencyFeesSourceAmount", "netTotalAffiliateAgencyFeesCaptureAmount", "netTotalAffiliateAgencyFeesDisplayAmount", "netTotalAffiliateAgencyFeesSupplierAmount", "netTotalAffiliateAgencyFeesInternalAmount", "netTotalSupplierAgencyFeesSourceAmount", "netTotalSupplierAgencyFeesCaptureAmount", "netTotalSupplierAgencyFeesDisplayAmount", "netTotalSupplierAgencyFeesSupplierAmount", "netTotalSupplierAgencyFeesInternalAmount", "hasRefunds", "hasSuccessfulRefunds", "hasPendingRefunds", "hasFailedRefunds", "platformIdentifier", "totalFundsGroupedByBeneficiary", "totalTokensEarned", "fullyRefunded", "selfAcquiring", "lodging", "cancellableByAgent", "cancellableWithNoCharges", "isCancellableWithPotentialCharges", "cancellableBySupplier", "cancellableByTraveler"]
|
|
194
195
|
|
|
195
196
|
@field_validator('canceller')
|
|
196
197
|
def canceller_validate_enum(cls, value):
|
|
@@ -682,14 +683,14 @@ class BookingContractAgent(BaseModel):
|
|
|
682
683
|
"platformIdentifier": obj.get("platformIdentifier"),
|
|
683
684
|
"totalFundsGroupedByBeneficiary": [BeneficiaryAgent.from_dict(_item) for _item in obj["totalFundsGroupedByBeneficiary"]] if obj.get("totalFundsGroupedByBeneficiary") is not None else None,
|
|
684
685
|
"totalTokensEarned": obj.get("totalTokensEarned"),
|
|
686
|
+
"fullyRefunded": obj.get("fullyRefunded"),
|
|
685
687
|
"selfAcquiring": obj.get("selfAcquiring"),
|
|
686
688
|
"lodging": BookingContractItemAgent.from_dict(obj["lodging"]) if obj.get("lodging") is not None else None,
|
|
687
689
|
"cancellableByAgent": obj.get("cancellableByAgent"),
|
|
688
|
-
"cancellableBySupplier": obj.get("cancellableBySupplier"),
|
|
689
|
-
"cancellableByTraveler": obj.get("cancellableByTraveler"),
|
|
690
|
-
"fullyRefunded": obj.get("fullyRefunded"),
|
|
691
690
|
"cancellableWithNoCharges": obj.get("cancellableWithNoCharges"),
|
|
692
|
-
"isCancellableWithPotentialCharges": obj.get("isCancellableWithPotentialCharges")
|
|
691
|
+
"isCancellableWithPotentialCharges": obj.get("isCancellableWithPotentialCharges"),
|
|
692
|
+
"cancellableBySupplier": obj.get("cancellableBySupplier"),
|
|
693
|
+
"cancellableByTraveler": obj.get("cancellableByTraveler")
|
|
693
694
|
})
|
|
694
695
|
return _obj
|
|
695
696
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
# Introduction 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. 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. # Integrations 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. # Intended Audience 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. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume 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. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [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. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [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. ### Taxonomy APIs 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. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs 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. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs 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). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning 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. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 30.
|
|
8
|
+
The version of the OpenAPI document: 30.21.0
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -67,11 +67,11 @@ class BookingContractItemAgent(BaseModel):
|
|
|
67
67
|
net_internal_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Internal amount minus internal modifier.", alias="netInternalAmount")
|
|
68
68
|
net_capture_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Capture amount minus capture modifier.", alias="netCaptureAmount")
|
|
69
69
|
metadata: Optional[Dict[str, StrictStr]] = Field(default=None, description="Place to add more data related to the booking contract item.")
|
|
70
|
-
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled by the traveller.", alias="cancellableByTraveler")
|
|
71
70
|
cancellable_with_no_charges: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled and whether cancellation charges might still occur.", alias="cancellableWithNoCharges")
|
|
72
71
|
cancellable_with_potential_charges: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled and whether cancellation charges might still occur.", alias="cancellableWithPotentialCharges")
|
|
72
|
+
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled by the traveller.", alias="cancellableByTraveler")
|
|
73
73
|
cancellable_by_supplier_or_agent: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled by the supplier. A supplier cancellation overrides the refundable", alias="cancellableBySupplierOrAgent")
|
|
74
|
-
__properties: ClassVar[List[str]] = ["supplierItemBookingCode", "user", "nameInEnglish", "descriptionInEnglish", "itinerary", "pricingType", "type", "beneficiaryList", "payable", "policy", "externalIdentifier", "tokensEarned", "dailyRateList", "cancelled", "sourceCurrency", "displayCurrency", "supplierCurrency", "internalCurrency", "captureCurrency", "sourceAmount", "displayAmount", "supplierAmount", "internalAmount", "captureAmount", "sourceAmountRefundModifier", "displayAmountRefundModifier", "supplierAmountRefundModifier", "internalAmountRefundModifier", "captureAmountRefundModifier", "netSourceAmount", "netDisplayAmount", "netSupplierAmount", "netInternalAmount", "netCaptureAmount", "metadata", "
|
|
74
|
+
__properties: ClassVar[List[str]] = ["supplierItemBookingCode", "user", "nameInEnglish", "descriptionInEnglish", "itinerary", "pricingType", "type", "beneficiaryList", "payable", "policy", "externalIdentifier", "tokensEarned", "dailyRateList", "cancelled", "sourceCurrency", "displayCurrency", "supplierCurrency", "internalCurrency", "captureCurrency", "sourceAmount", "displayAmount", "supplierAmount", "internalAmount", "captureAmount", "sourceAmountRefundModifier", "displayAmountRefundModifier", "supplierAmountRefundModifier", "internalAmountRefundModifier", "captureAmountRefundModifier", "netSourceAmount", "netDisplayAmount", "netSupplierAmount", "netInternalAmount", "netCaptureAmount", "metadata", "cancellableWithNoCharges", "cancellableWithPotentialCharges", "cancellableByTraveler", "cancellableBySupplierOrAgent"]
|
|
75
75
|
|
|
76
76
|
@field_validator('pricing_type')
|
|
77
77
|
def pricing_type_validate_enum(cls, value):
|
|
@@ -196,9 +196,9 @@ class BookingContractItemAgent(BaseModel):
|
|
|
196
196
|
"netInternalAmount": obj.get("netInternalAmount"),
|
|
197
197
|
"netCaptureAmount": obj.get("netCaptureAmount"),
|
|
198
198
|
"metadata": obj.get("metadata"),
|
|
199
|
-
"cancellableByTraveler": obj.get("cancellableByTraveler"),
|
|
200
199
|
"cancellableWithNoCharges": obj.get("cancellableWithNoCharges"),
|
|
201
200
|
"cancellableWithPotentialCharges": obj.get("cancellableWithPotentialCharges"),
|
|
201
|
+
"cancellableByTraveler": obj.get("cancellableByTraveler"),
|
|
202
202
|
"cancellableBySupplierOrAgent": obj.get("cancellableBySupplierOrAgent")
|
|
203
203
|
})
|
|
204
204
|
return _obj
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
# Introduction 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. 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. # Integrations 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. # Intended Audience 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. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume 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. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [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. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [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. ### Taxonomy APIs 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. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs 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. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs 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). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning 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. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 30.
|
|
8
|
+
The version of the OpenAPI document: 30.21.0
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
# Introduction 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. 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. # Integrations 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. # Intended Audience 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. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume 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. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [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. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [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. ### Taxonomy APIs 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. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs 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. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs 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). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning 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. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 30.
|
|
8
|
+
The version of the OpenAPI document: 30.21.0
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -35,9 +35,9 @@ class BookingItineraryAgent(BaseModel):
|
|
|
35
35
|
items: Optional[List[BookingItineraryRoomConfigurationAgent]] = None
|
|
36
36
|
hours: Optional[StrictInt] = Field(default=None, 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.")
|
|
37
37
|
children: Optional[StrictInt] = Field(default=None, description="How many total children for this stay")
|
|
38
|
-
guests: Optional[StrictInt] = Field(default=None, description="How many total guests for this stay")
|
|
39
38
|
rooms: Optional[StrictInt] = Field(default=None, description="How many total rooms for this stay")
|
|
40
|
-
|
|
39
|
+
guests: Optional[StrictInt] = Field(default=None, description="How many total guests for this stay")
|
|
40
|
+
__properties: ClassVar[List[str]] = ["startDate", "endDate", "nights", "items", "hours", "children", "rooms", "guests"]
|
|
41
41
|
|
|
42
42
|
model_config = ConfigDict(
|
|
43
43
|
populate_by_name=True,
|
|
@@ -105,8 +105,8 @@ class BookingItineraryAgent(BaseModel):
|
|
|
105
105
|
"items": [BookingItineraryRoomConfigurationAgent.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None,
|
|
106
106
|
"hours": obj.get("hours"),
|
|
107
107
|
"children": obj.get("children"),
|
|
108
|
-
"
|
|
109
|
-
"
|
|
108
|
+
"rooms": obj.get("rooms"),
|
|
109
|
+
"guests": obj.get("guests")
|
|
110
110
|
})
|
|
111
111
|
return _obj
|
|
112
112
|
|