wink-sdk-travel-agent 0.0.24__py3-none-any.whl → 0.0.26__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 +17 -28
- wink_sdk_travel_agent/api/travel_agent_api.py +29 -29
- wink_sdk_travel_agent/api_client.py +2 -2
- wink_sdk_travel_agent/configuration.py +4 -4
- wink_sdk_travel_agent/exceptions.py +2 -2
- wink_sdk_travel_agent/models/__init__.py +16 -27
- wink_sdk_travel_agent/models/address_agent.py +7 -6
- wink_sdk_travel_agent/models/affiliate_account_agent.py +179 -0
- wink_sdk_travel_agent/models/affiliate_account_user_agent.py +115 -0
- wink_sdk_travel_agent/models/agent_booking_request_agent.py +13 -28
- wink_sdk_travel_agent/models/aggregate_descriptor_agent.py +3 -3
- wink_sdk_travel_agent/models/ancillary_request_agent.py +1 -1
- wink_sdk_travel_agent/models/authenticated_user_agent.py +7 -6
- wink_sdk_travel_agent/models/bed_agent.py +4 -4
- wink_sdk_travel_agent/models/bedroom_agent.py +4 -3
- wink_sdk_travel_agent/models/bedroom_configuration_agent.py +8 -7
- wink_sdk_travel_agent/models/beneficiary_agent.py +13 -21
- wink_sdk_travel_agent/models/beneficiary_charge_agent.py +2 -2
- wink_sdk_travel_agent/models/booking_agent.py +37 -74
- wink_sdk_travel_agent/models/booking_ancillary_agent.py +16 -15
- wink_sdk_travel_agent/models/booking_confirmations_agent.py +8 -16
- wink_sdk_travel_agent/models/booking_contract_agent.py +104 -104
- wink_sdk_travel_agent/models/booking_contract_item_agent.py +13 -21
- wink_sdk_travel_agent/models/booking_contract_payment_details_agent.py +10 -17
- wink_sdk_travel_agent/models/booking_itinerary_agent.py +3 -3
- wink_sdk_travel_agent/models/booking_itinerary_room_configuration_agent.py +4 -4
- wink_sdk_travel_agent/models/booking_itinerary_room_configuration_child_agent.py +2 -2
- wink_sdk_travel_agent/models/booking_user_agent.py +7 -6
- wink_sdk_travel_agent/models/booking_user_request_agent.py +3 -3
- wink_sdk_travel_agent/models/booking_user_session_agent.py +4 -4
- wink_sdk_travel_agent/models/booking_view_agent.py +2 -2
- wink_sdk_travel_agent/models/boolean_response_agent.py +2 -2
- wink_sdk_travel_agent/models/cancellation_detail_agent.py +4 -3
- wink_sdk_travel_agent/models/cancellation_policy_agent.py +1 -1
- wink_sdk_travel_agent/models/cancellation_policy_exception_agent.py +8 -7
- wink_sdk_travel_agent/models/cancellation_policy_exceptions_agent.py +5 -4
- wink_sdk_travel_agent/models/cancellation_policy_lightweight_agent.py +166 -0
- wink_sdk_travel_agent/models/child_agent.py +2 -2
- wink_sdk_travel_agent/models/commissionable_entry_agent.py +6 -5
- wink_sdk_travel_agent/models/company_agent.py +1 -1
- wink_sdk_travel_agent/models/company_user_agent.py +1 -1
- wink_sdk_travel_agent/models/company_view_agent.py +1 -1
- wink_sdk_travel_agent/models/composite_filter_descriptor_agent.py +3 -3
- wink_sdk_travel_agent/models/contact_agent.py +3 -3
- wink_sdk_travel_agent/models/country_agent.py +1 -1
- wink_sdk_travel_agent/models/country_lightweight_agent.py +100 -0
- wink_sdk_travel_agent/models/create_agent_booking400_response.py +3 -3
- wink_sdk_travel_agent/models/create_agent_booking_request_agent.py +7 -6
- wink_sdk_travel_agent/models/custom_monetary_amount.py +5 -4
- wink_sdk_travel_agent/models/customization_lightweight_agent.py +231 -0
- wink_sdk_travel_agent/models/customization_theme_colors_agent.py +108 -0
- wink_sdk_travel_agent/models/daily_rate_agent.py +1 -1
- wink_sdk_travel_agent/models/engine_configuration_booking_report_agent.py +1 -1
- wink_sdk_travel_agent/models/engine_configuration_theme_colors_agent.py +1 -1
- wink_sdk_travel_agent/models/extra_charge_agent.py +6 -6
- wink_sdk_travel_agent/models/extra_charges_agent.py +3 -3
- wink_sdk_travel_agent/models/fee_agent.py +1 -1
- wink_sdk_travel_agent/models/filter_descriptor_agent.py +11 -5
- wink_sdk_travel_agent/models/general_manager_agent.py +4 -4
- wink_sdk_travel_agent/models/generic_error_message.py +2 -2
- wink_sdk_travel_agent/models/geo_json_point_agent.py +3 -3
- wink_sdk_travel_agent/models/geo_name_agent.py +1 -1
- wink_sdk_travel_agent/models/geo_name_lightweight_agent.py +136 -0
- wink_sdk_travel_agent/models/group_descriptor_agent.py +3 -3
- wink_sdk_travel_agent/models/guest_room_lightweight_agent.py +22 -22
- wink_sdk_travel_agent/models/guest_user_agent.py +9 -8
- wink_sdk_travel_agent/models/hotel_on_map_agent.py +1 -1
- wink_sdk_travel_agent/models/image_attribution_agent.py +5 -4
- wink_sdk_travel_agent/models/localized_description_agent.py +25 -7
- wink_sdk_travel_agent/models/localized_price_agent.py +18 -18
- wink_sdk_travel_agent/models/managed_by_entity_agent.py +8 -7
- wink_sdk_travel_agent/models/managed_by_entity_rules_agent.py +3 -3
- wink_sdk_travel_agent/models/online_presence_agent.py +1 -1
- wink_sdk_travel_agent/models/page_booking_agent.py +124 -0
- wink_sdk_travel_agent/models/page_booking_view_agent.py +1 -1
- wink_sdk_travel_agent/models/pageable_object_agent.py +6 -6
- wink_sdk_travel_agent/models/payout_agent.py +10 -9
- wink_sdk_travel_agent/models/payout_fee_agent.py +7 -6
- wink_sdk_travel_agent/models/pending_refund_agent.py +1 -1
- wink_sdk_travel_agent/models/perk_lightweight_agent.py +7 -6
- wink_sdk_travel_agent/models/personal_agent.py +8 -24
- wink_sdk_travel_agent/models/pet_info_dto_agent.py +1 -1
- wink_sdk_travel_agent/models/preferences_agent.py +13 -13
- wink_sdk_travel_agent/models/profile_agent.py +1 -1
- wink_sdk_travel_agent/models/profile_lightweight_agent.py +111 -0
- wink_sdk_travel_agent/models/profile_user_agent.py +3 -3
- wink_sdk_travel_agent/models/property_aggregate_lightweight_agent.py +242 -0
- wink_sdk_travel_agent/models/property_policy_agent.py +6 -5
- wink_sdk_travel_agent/models/quote_agent.py +1 -1
- wink_sdk_travel_agent/models/quote_lightweight_agent.py +95 -0
- wink_sdk_travel_agent/models/rate_plan_level_fee_agent.py +6 -5
- wink_sdk_travel_agent/models/refund_agent.py +6 -5
- wink_sdk_travel_agent/models/reporting_ancillary_agent.py +1 -1
- wink_sdk_travel_agent/models/reporting_daily_rate_agent.py +1 -1
- wink_sdk_travel_agent/models/reporting_extra_charge_agent.py +1 -1
- wink_sdk_travel_agent/models/review_agent.py +1 -1
- wink_sdk_travel_agent/models/review_answer_agent.py +4 -3
- wink_sdk_travel_agent/models/review_lightweight_agent.py +133 -0
- wink_sdk_travel_agent/models/review_user_agent.py +3 -3
- wink_sdk_travel_agent/models/room_configuration_agent.py +3 -3
- wink_sdk_travel_agent/models/room_configuration_price_rate_plan_agent.py +23 -12
- wink_sdk_travel_agent/models/room_stay_agent.py +23 -22
- wink_sdk_travel_agent/models/simple_address_agent.py +12 -7
- wink_sdk_travel_agent/models/simple_date_time_itinerary_agent.py +6 -6
- wink_sdk_travel_agent/models/simple_description_agent.py +25 -7
- wink_sdk_travel_agent/models/simple_multimedia_agent.py +5 -5
- wink_sdk_travel_agent/models/social_agent.py +2 -2
- wink_sdk_travel_agent/models/sort_descriptor_agent.py +3 -3
- wink_sdk_travel_agent/models/sort_object_agent.py +2 -2
- wink_sdk_travel_agent/models/state_agent.py +3 -3
- wink_sdk_travel_agent/models/stay_rate_agent.py +16 -16
- wink_sdk_travel_agent/models/sub_country_agent.py +1 -1
- wink_sdk_travel_agent/models/sub_country_lightweight_agent.py +92 -0
- wink_sdk_travel_agent/models/sub_sub_country_agent.py +1 -1
- wink_sdk_travel_agent/models/sub_sub_country_lightweight_agent.py +92 -0
- wink_sdk_travel_agent/models/supplier_contract_item_policy_agent.py +2 -2
- wink_sdk_travel_agent/models/travel_agent_agent.py +3 -3
- wink_sdk_travel_agent/models/travel_inventory_recognition_agent.py +4 -4
- wink_sdk_travel_agent/models/upsert_travel_agent_request_agent.py +2 -2
- wink_sdk_travel_agent/rest.py +2 -2
- {wink_sdk_travel_agent-0.0.24.dist-info → wink_sdk_travel_agent-0.0.26.dist-info}/METADATA +20 -31
- wink_sdk_travel_agent-0.0.26.dist-info/RECORD +133 -0
- {wink_sdk_travel_agent-0.0.24.dist-info → wink_sdk_travel_agent-0.0.26.dist-info}/WHEEL +1 -1
- wink_sdk_travel_agent-0.0.24.dist-info/RECORD +0 -119
- {wink_sdk_travel_agent-0.0.24.dist-info → wink_sdk_travel_agent-0.0.26.dist-info}/licenses/LICENSE +0 -0
- {wink_sdk_travel_agent-0.0.24.dist-info → wink_sdk_travel_agent-0.0.26.dist-info}/top_level.txt +0 -0
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"""
|
|
4
4
|
Wink API
|
|
5
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](/
|
|
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](/reactive): 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 reactive widget for all other entities. - [TripPay](/reactive): 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.17.1
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"""
|
|
4
4
|
Wink API
|
|
5
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](/
|
|
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](/reactive): 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 reactive widget for all other entities. - [TripPay](/reactive): 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.17.1
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -21,20 +21,15 @@ 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 wink_sdk_travel_agent.models.address_agent import AddressAgent
|
|
25
24
|
from wink_sdk_travel_agent.models.booking_ancillary_agent import BookingAncillaryAgent
|
|
26
25
|
from wink_sdk_travel_agent.models.booking_contract_agent import BookingContractAgent
|
|
27
26
|
from wink_sdk_travel_agent.models.booking_user_agent import BookingUserAgent
|
|
28
27
|
from wink_sdk_travel_agent.models.booking_user_session_agent import BookingUserSessionAgent
|
|
29
28
|
from wink_sdk_travel_agent.models.commissionable_entry_agent import CommissionableEntryAgent
|
|
30
|
-
from wink_sdk_travel_agent.models.contact_agent import ContactAgent
|
|
31
29
|
from wink_sdk_travel_agent.models.custom_monetary_amount import CustomMonetaryAmount
|
|
32
|
-
from wink_sdk_travel_agent.models.
|
|
33
|
-
from wink_sdk_travel_agent.models.
|
|
34
|
-
from wink_sdk_travel_agent.models.
|
|
35
|
-
from wink_sdk_travel_agent.models.reporting_daily_rate_agent import ReportingDailyRateAgent
|
|
36
|
-
from wink_sdk_travel_agent.models.reporting_extra_charge_agent import ReportingExtraChargeAgent
|
|
37
|
-
from wink_sdk_travel_agent.models.review_agent import ReviewAgent
|
|
30
|
+
from wink_sdk_travel_agent.models.customization_lightweight_agent import CustomizationLightweightAgent
|
|
31
|
+
from wink_sdk_travel_agent.models.property_aggregate_lightweight_agent import PropertyAggregateLightweightAgent
|
|
32
|
+
from wink_sdk_travel_agent.models.review_lightweight_agent import ReviewLightweightAgent
|
|
38
33
|
from wink_sdk_travel_agent.models.room_stay_agent import RoomStayAgent
|
|
39
34
|
from wink_sdk_travel_agent.models.social_agent import SocialAgent
|
|
40
35
|
from typing import Optional, Set
|
|
@@ -42,36 +37,36 @@ from typing_extensions import Self
|
|
|
42
37
|
|
|
43
38
|
class BookingAgent(BaseModel):
|
|
44
39
|
"""
|
|
45
|
-
|
|
40
|
+
BookingAgent
|
|
46
41
|
""" # noqa: E501
|
|
47
|
-
|
|
48
|
-
|
|
42
|
+
id: Optional[StrictStr] = Field(default=None, description="Document UUID")
|
|
43
|
+
created_date: Optional[datetime] = Field(default=None, description="Datetime this record was first created", alias="createdDate")
|
|
44
|
+
last_update: Optional[datetime] = Field(default=None, description="Datetime this record was last updated", alias="lastUpdate")
|
|
45
|
+
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
|
+
creation: StrictStr = Field(description="Communicates whether the booking was created normally or if it failed or was just for testing.")
|
|
49
47
|
group_identifier: StrictStr = Field(description="Unique record identifier for the collection of bookings that were made at the same time.", alias="groupIdentifier")
|
|
50
|
-
|
|
51
|
-
engine_configuration: EngineConfigurationBookingReportAgent = Field(alias="engineConfiguration")
|
|
48
|
+
customization: CustomizationLightweightAgent = Field(description="Which customization configuration record did the entity application used to facilitate in making this booking happen.")
|
|
52
49
|
booking_code: StrictStr = Field(description="Unique user-friendly booking geoname. This code should be used when corresponding with travelers.", alias="bookingCode")
|
|
53
|
-
user: BookingUserAgent
|
|
54
|
-
user_session: BookingUserSessionAgent = Field(alias="userSession")
|
|
50
|
+
user: BookingUserAgent = Field(description="User details for the authenticated person that made the booking.")
|
|
51
|
+
user_session: BookingUserSessionAgent = Field(description="User session state as it was when the user made the booking.", alias="userSession")
|
|
55
52
|
server_url: StrictStr = Field(description="The URL the booking occurred", alias="serverUrl")
|
|
56
|
-
contact_info: ContactAgent = Field(alias="contactInfo")
|
|
57
|
-
address: AddressAgent
|
|
58
53
|
socials: Optional[List[SocialAgent]] = Field(default=None, description="List of all social network account property has for the traveler to get in touch.")
|
|
59
|
-
review: Optional[
|
|
54
|
+
review: Optional[ReviewLightweightAgent] = Field(default=None, description="User review created by the traveler after the booking completed.")
|
|
60
55
|
email_header_logo_url: StrictStr = Field(description="Full url of the image logo optimized for emails", alias="emailHeaderLogoUrl")
|
|
61
56
|
logo_identifier: Optional[StrictStr] = Field(default=None, description="Logo cloudinary identifier for potential reuse", alias="logoIdentifier")
|
|
62
|
-
hotel:
|
|
63
|
-
room_stay: Optional[RoomStayAgent] = Field(default=None, alias="roomStay")
|
|
57
|
+
hotel: PropertyAggregateLightweightAgent = Field(description="Combined property data.")
|
|
58
|
+
room_stay: Optional[RoomStayAgent] = Field(default=None, description="All information about the room that was booked.", alias="roomStay")
|
|
64
59
|
special_requests: Optional[StrictStr] = Field(default=None, description="Free text where the traveler can add a message to the property.", alias="specialRequests")
|
|
65
60
|
comment: Optional[StrictStr] = Field(default=None, description="Internal comment field the platform can add and make available to channel manager partners.")
|
|
66
|
-
early_check_in_charge: Optional[CustomMonetaryAmount] = Field(default=None, alias="earlyCheckInCharge")
|
|
67
|
-
late_check_out_charge: Optional[CustomMonetaryAmount] = Field(default=None, alias="lateCheckOutCharge")
|
|
61
|
+
early_check_in_charge: Optional[CustomMonetaryAmount] = Field(default=None, description="Early check-in charge fixed amount that is due if guest checks out early.", alias="earlyCheckInCharge")
|
|
62
|
+
late_check_out_charge: Optional[CustomMonetaryAmount] = Field(default=None, description="Late check-out charge fixed amount that is due if guest checks out late.", alias="lateCheckOutCharge")
|
|
68
63
|
early_check_in_charge_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Early check-in charge calculated in percent of first room night price.", alias="earlyCheckInChargePercent")
|
|
69
64
|
late_check_out_charge_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Early check-in charge calculated in percent of first room night price.", alias="lateCheckOutChargePercent")
|
|
70
65
|
hotel_image_url: StrictStr = Field(description="Absolute URL of hotel image that can be used as-is", alias="hotelImageUrl")
|
|
71
66
|
room_image_url: StrictStr = Field(description="Absolute URL of room image that can be used as-is", alias="roomImageUrl")
|
|
72
67
|
commission_list: Optional[List[CommissionableEntryAgent]] = Field(default=None, description="List of all travel inventory entries that are due a commission to the affiliate.", alias="commissionList")
|
|
73
68
|
ancillary_list: Optional[List[BookingAncillaryAgent]] = Field(default=None, alias="ancillaryList")
|
|
74
|
-
booking_contract: Optional[BookingContractAgent] = Field(default=None, alias="bookingContract")
|
|
69
|
+
booking_contract: Optional[BookingContractAgent] = Field(default=None, description="Booking contract created by TripPay", alias="bookingContract")
|
|
75
70
|
static_map_image_url: Optional[StrictStr] = Field(default=None, description="Url of map image that can be sent via email", alias="staticMapImageUrl")
|
|
76
71
|
static_map_url: Optional[StrictStr] = Field(default=None, description="Url of map image location on Google Maps", alias="staticMapUrl")
|
|
77
72
|
status: Optional[StrictStr] = Field(default=None, description="Convenience data point to show which status the booking currently has.")
|
|
@@ -88,7 +83,6 @@ class BookingAgent(BaseModel):
|
|
|
88
83
|
cancellable_by_agent: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the agent.", alias="cancellableByAgent")
|
|
89
84
|
cancellable_by_supplier: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the supplier.", alias="cancellableBySupplier")
|
|
90
85
|
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the traveller.", alias="cancellableByTraveler")
|
|
91
|
-
full_address: Optional[StrictStr] = Field(default=None, description="Convenience data point to return the full hotel address.", alias="fullAddress")
|
|
92
86
|
has_breakfast: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to breakfast quickly.", alias="hasBreakfast")
|
|
93
87
|
has_brunch: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to brunch quickly.", alias="hasBrunch")
|
|
94
88
|
has_lunch: Optional[StrictBool] = Field(default=None, description="Convenience data point to get to lunch quickly.", alias="hasLunch")
|
|
@@ -103,17 +97,14 @@ class BookingAgent(BaseModel):
|
|
|
103
97
|
has_activities: Optional[StrictBool] = Field(default=None, description="Convenience data point to check if any activity reservations are included in this booking.", alias="hasActivities")
|
|
104
98
|
has_attractions: Optional[StrictBool] = Field(default=None, description="Convenience data point to check if any attractions reservations are included in this booking.", alias="hasAttractions")
|
|
105
99
|
has_places: Optional[StrictBool] = Field(default=None, description="Convenience data point to check if any place reservations are included in this booking.", alias="hasPlaces")
|
|
106
|
-
reporting_daily_rate_list: Optional[List[
|
|
107
|
-
reporting_ancillary_list: Optional[List[
|
|
108
|
-
reporting_extra_charge_list: Optional[List[
|
|
109
|
-
__properties: ClassVar[List[str]] = ["
|
|
100
|
+
reporting_daily_rate_list: Optional[List[Any]] = Field(default=None, alias="reportingDailyRateList")
|
|
101
|
+
reporting_ancillary_list: Optional[List[Any]] = Field(default=None, alias="reportingAncillaryList")
|
|
102
|
+
reporting_extra_charge_list: Optional[List[Any]] = Field(default=None, alias="reportingExtraChargeList")
|
|
103
|
+
__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", "meetingRooms", "restaurants", "spas", "activities", "attractions", "places", "roomTypeAncillaries", "addOns", "rateSource", "hasAddOns", "cancellableByAgent", "cancellableBySupplier", "cancellableByTraveler", "hasBreakfast", "hasBrunch", "hasLunch", "hasDinner", "hasAllInclusive", "hasAllInclusivePlusAlcohol", "hasRoomTypeAncillaries", "hasFood", "hasRestaurants", "hasMeetingRooms", "hasSpas", "hasActivities", "hasAttractions", "hasPlaces", "reportingDailyRateList", "reportingAncillaryList", "reportingExtraChargeList"]
|
|
110
104
|
|
|
111
105
|
@field_validator('creation')
|
|
112
106
|
def creation_validate_enum(cls, value):
|
|
113
107
|
"""Validates the enum"""
|
|
114
|
-
if value is None:
|
|
115
|
-
return value
|
|
116
|
-
|
|
117
108
|
if value not in set(['NORMAL', 'TEST', 'FAILED']):
|
|
118
109
|
raise ValueError("must be one of enum values ('NORMAL', 'TEST', 'FAILED')")
|
|
119
110
|
return value
|
|
@@ -167,21 +158,15 @@ class BookingAgent(BaseModel):
|
|
|
167
158
|
exclude=excluded_fields,
|
|
168
159
|
exclude_none=True,
|
|
169
160
|
)
|
|
170
|
-
# override the default output from pydantic by calling `to_dict()` of
|
|
171
|
-
if self.
|
|
172
|
-
_dict['
|
|
161
|
+
# override the default output from pydantic by calling `to_dict()` of customization
|
|
162
|
+
if self.customization:
|
|
163
|
+
_dict['customization'] = self.customization.to_dict()
|
|
173
164
|
# override the default output from pydantic by calling `to_dict()` of user
|
|
174
165
|
if self.user:
|
|
175
166
|
_dict['user'] = self.user.to_dict()
|
|
176
167
|
# override the default output from pydantic by calling `to_dict()` of user_session
|
|
177
168
|
if self.user_session:
|
|
178
169
|
_dict['userSession'] = self.user_session.to_dict()
|
|
179
|
-
# override the default output from pydantic by calling `to_dict()` of contact_info
|
|
180
|
-
if self.contact_info:
|
|
181
|
-
_dict['contactInfo'] = self.contact_info.to_dict()
|
|
182
|
-
# override the default output from pydantic by calling `to_dict()` of address
|
|
183
|
-
if self.address:
|
|
184
|
-
_dict['address'] = self.address.to_dict()
|
|
185
170
|
# override the default output from pydantic by calling `to_dict()` of each item in socials (list)
|
|
186
171
|
_items = []
|
|
187
172
|
if self.socials:
|
|
@@ -277,27 +262,6 @@ class BookingAgent(BaseModel):
|
|
|
277
262
|
if _item_add_ons:
|
|
278
263
|
_items.append(_item_add_ons.to_dict())
|
|
279
264
|
_dict['addOns'] = _items
|
|
280
|
-
# override the default output from pydantic by calling `to_dict()` of each item in reporting_daily_rate_list (list)
|
|
281
|
-
_items = []
|
|
282
|
-
if self.reporting_daily_rate_list:
|
|
283
|
-
for _item_reporting_daily_rate_list in self.reporting_daily_rate_list:
|
|
284
|
-
if _item_reporting_daily_rate_list:
|
|
285
|
-
_items.append(_item_reporting_daily_rate_list.to_dict())
|
|
286
|
-
_dict['reportingDailyRateList'] = _items
|
|
287
|
-
# override the default output from pydantic by calling `to_dict()` of each item in reporting_ancillary_list (list)
|
|
288
|
-
_items = []
|
|
289
|
-
if self.reporting_ancillary_list:
|
|
290
|
-
for _item_reporting_ancillary_list in self.reporting_ancillary_list:
|
|
291
|
-
if _item_reporting_ancillary_list:
|
|
292
|
-
_items.append(_item_reporting_ancillary_list.to_dict())
|
|
293
|
-
_dict['reportingAncillaryList'] = _items
|
|
294
|
-
# override the default output from pydantic by calling `to_dict()` of each item in reporting_extra_charge_list (list)
|
|
295
|
-
_items = []
|
|
296
|
-
if self.reporting_extra_charge_list:
|
|
297
|
-
for _item_reporting_extra_charge_list in self.reporting_extra_charge_list:
|
|
298
|
-
if _item_reporting_extra_charge_list:
|
|
299
|
-
_items.append(_item_reporting_extra_charge_list.to_dict())
|
|
300
|
-
_dict['reportingExtraChargeList'] = _items
|
|
301
265
|
return _dict
|
|
302
266
|
|
|
303
267
|
@classmethod
|
|
@@ -310,22 +274,22 @@ class BookingAgent(BaseModel):
|
|
|
310
274
|
return cls.model_validate(obj)
|
|
311
275
|
|
|
312
276
|
_obj = cls.model_validate({
|
|
277
|
+
"id": obj.get("id"),
|
|
278
|
+
"createdDate": obj.get("createdDate"),
|
|
279
|
+
"lastUpdate": obj.get("lastUpdate"),
|
|
280
|
+
"version": obj.get("version"),
|
|
313
281
|
"creation": obj.get("creation") if obj.get("creation") is not None else 'NORMAL',
|
|
314
|
-
"date": obj.get("date"),
|
|
315
282
|
"groupIdentifier": obj.get("groupIdentifier"),
|
|
316
|
-
"
|
|
317
|
-
"engineConfiguration": EngineConfigurationBookingReportAgent.from_dict(obj["engineConfiguration"]) if obj.get("engineConfiguration") is not None else None,
|
|
283
|
+
"customization": CustomizationLightweightAgent.from_dict(obj["customization"]) if obj.get("customization") is not None else None,
|
|
318
284
|
"bookingCode": obj.get("bookingCode"),
|
|
319
285
|
"user": BookingUserAgent.from_dict(obj["user"]) if obj.get("user") is not None else None,
|
|
320
286
|
"userSession": BookingUserSessionAgent.from_dict(obj["userSession"]) if obj.get("userSession") is not None else None,
|
|
321
287
|
"serverUrl": obj.get("serverUrl"),
|
|
322
|
-
"contactInfo": ContactAgent.from_dict(obj["contactInfo"]) if obj.get("contactInfo") is not None else None,
|
|
323
|
-
"address": AddressAgent.from_dict(obj["address"]) if obj.get("address") is not None else None,
|
|
324
288
|
"socials": [SocialAgent.from_dict(_item) for _item in obj["socials"]] if obj.get("socials") is not None else None,
|
|
325
|
-
"review":
|
|
289
|
+
"review": ReviewLightweightAgent.from_dict(obj["review"]) if obj.get("review") is not None else None,
|
|
326
290
|
"emailHeaderLogoUrl": obj.get("emailHeaderLogoUrl"),
|
|
327
291
|
"logoIdentifier": obj.get("logoIdentifier"),
|
|
328
|
-
"hotel":
|
|
292
|
+
"hotel": PropertyAggregateLightweightAgent.from_dict(obj["hotel"]) if obj.get("hotel") is not None else None,
|
|
329
293
|
"roomStay": RoomStayAgent.from_dict(obj["roomStay"]) if obj.get("roomStay") is not None else None,
|
|
330
294
|
"specialRequests": obj.get("specialRequests"),
|
|
331
295
|
"comment": obj.get("comment"),
|
|
@@ -354,7 +318,6 @@ class BookingAgent(BaseModel):
|
|
|
354
318
|
"cancellableByAgent": obj.get("cancellableByAgent"),
|
|
355
319
|
"cancellableBySupplier": obj.get("cancellableBySupplier"),
|
|
356
320
|
"cancellableByTraveler": obj.get("cancellableByTraveler"),
|
|
357
|
-
"fullAddress": obj.get("fullAddress"),
|
|
358
321
|
"hasBreakfast": obj.get("hasBreakfast"),
|
|
359
322
|
"hasBrunch": obj.get("hasBrunch"),
|
|
360
323
|
"hasLunch": obj.get("hasLunch"),
|
|
@@ -369,9 +332,9 @@ class BookingAgent(BaseModel):
|
|
|
369
332
|
"hasActivities": obj.get("hasActivities"),
|
|
370
333
|
"hasAttractions": obj.get("hasAttractions"),
|
|
371
334
|
"hasPlaces": obj.get("hasPlaces"),
|
|
372
|
-
"reportingDailyRateList":
|
|
373
|
-
"reportingAncillaryList":
|
|
374
|
-
"reportingExtraChargeList":
|
|
335
|
+
"reportingDailyRateList": obj.get("reportingDailyRateList"),
|
|
336
|
+
"reportingAncillaryList": obj.get("reportingAncillaryList"),
|
|
337
|
+
"reportingExtraChargeList": obj.get("reportingExtraChargeList")
|
|
375
338
|
})
|
|
376
339
|
return _obj
|
|
377
340
|
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"""
|
|
4
4
|
Wink API
|
|
5
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](/
|
|
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](/reactive): 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 reactive widget for all other entities. - [TripPay](/reactive): 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.17.1
|
|
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, Union
|
|
24
|
+
from typing_extensions import Annotated
|
|
24
25
|
from wink_sdk_travel_agent.models.contact_agent import ContactAgent
|
|
25
26
|
from wink_sdk_travel_agent.models.localized_price_agent import LocalizedPriceAgent
|
|
26
27
|
from wink_sdk_travel_agent.models.simple_address_agent import SimpleAddressAgent
|
|
@@ -29,25 +30,25 @@ from typing_extensions import Self
|
|
|
29
30
|
|
|
30
31
|
class BookingAncillaryAgent(BaseModel):
|
|
31
32
|
"""
|
|
32
|
-
|
|
33
|
+
BookingAncillaryAgent
|
|
33
34
|
""" # noqa: E501
|
|
34
|
-
identifier:
|
|
35
|
-
hotel_identifier:
|
|
36
|
-
type_identifier:
|
|
37
|
-
transactional_travel_inventory_identifier:
|
|
38
|
-
name:
|
|
35
|
+
identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Ancillary identifier")
|
|
36
|
+
hotel_identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Hotel identifier", alias="hotelIdentifier")
|
|
37
|
+
type_identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Travel blocking identifier", alias="typeIdentifier")
|
|
38
|
+
transactional_travel_inventory_identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Travel blocking identifier", alias="transactionalTravelInventoryIdentifier")
|
|
39
|
+
name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Name of blocking")
|
|
39
40
|
pricing_type: StrictStr = Field(description="Pricing type", alias="pricingType")
|
|
40
41
|
type: StrictStr = Field(description="Inventory type")
|
|
41
|
-
price: LocalizedPriceAgent
|
|
42
|
+
price: LocalizedPriceAgent = Field(description="Pricing information for this ancillary.")
|
|
42
43
|
start_date: datetime = Field(description="Date start time when reservation was made for.", alias="startDate")
|
|
43
44
|
end_date: datetime = Field(description="Date end time when reservation was made for.", alias="endDate")
|
|
44
45
|
attendees: StrictInt = Field(description="Number of guests that are part of this reservation.")
|
|
45
|
-
image_identifier:
|
|
46
|
-
image_url:
|
|
47
|
-
localized_name:
|
|
48
|
-
localized_description:
|
|
49
|
-
contact: ContactAgent
|
|
50
|
-
address: SimpleAddressAgent
|
|
46
|
+
image_identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Cloudinary image identifier", alias="imageIdentifier")
|
|
47
|
+
image_url: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Absolute URL to image of blocking", alias="imageUrl")
|
|
48
|
+
localized_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Name of travel blocking 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 blocking in traveler language (if available). Defaults to English.", alias="localizedDescription")
|
|
50
|
+
contact: ContactAgent = Field(description="Travel blocking contact (if applicable)")
|
|
51
|
+
address: SimpleAddressAgent = Field(description="Travel blocking address (if applicable)")
|
|
51
52
|
commissionable: StrictBool
|
|
52
53
|
mandatory: StrictBool
|
|
53
54
|
commission: Union[StrictFloat, StrictInt]
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"""
|
|
4
4
|
Wink API
|
|
5
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](/
|
|
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](/reactive): 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 reactive widget for all other entities. - [TripPay](/reactive): 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.17.1
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -20,7 +20,6 @@ import json
|
|
|
20
20
|
|
|
21
21
|
from pydantic import BaseModel, ConfigDict, Field, StrictInt
|
|
22
22
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
23
|
-
from wink_sdk_travel_agent.models.booking_view_agent import BookingViewAgent
|
|
24
23
|
from wink_sdk_travel_agent.models.custom_monetary_amount import CustomMonetaryAmount
|
|
25
24
|
from typing import Optional, Set
|
|
26
25
|
from typing_extensions import Self
|
|
@@ -29,10 +28,10 @@ class BookingConfirmationsAgent(BaseModel):
|
|
|
29
28
|
"""
|
|
30
29
|
BookingConfirmationsAgent
|
|
31
30
|
""" # noqa: E501
|
|
32
|
-
list: Optional[List[
|
|
33
|
-
points_to_be_earned: Optional[StrictInt] = Field(default=
|
|
34
|
-
user_specified_currency_total: Optional[CustomMonetaryAmount] = Field(default=None, alias="userSpecifiedCurrencyTotal")
|
|
35
|
-
source_total: Optional[CustomMonetaryAmount] = Field(default=None, alias="sourceTotal")
|
|
31
|
+
list: Optional[List[Any]] = None
|
|
32
|
+
points_to_be_earned: Optional[StrictInt] = Field(default=0, description="Total points to be earned by Wink", alias="pointsToBeEarned")
|
|
33
|
+
user_specified_currency_total: Optional[CustomMonetaryAmount] = Field(default=None, description="Total amount of money to be paid by the user in display currency", alias="userSpecifiedCurrencyTotal")
|
|
34
|
+
source_total: Optional[CustomMonetaryAmount] = Field(default=None, description="Total amount of money to be paid by the user in source currency", alias="sourceTotal")
|
|
36
35
|
__properties: ClassVar[List[str]] = ["list", "pointsToBeEarned", "userSpecifiedCurrencyTotal", "sourceTotal"]
|
|
37
36
|
|
|
38
37
|
model_config = ConfigDict(
|
|
@@ -74,13 +73,6 @@ class BookingConfirmationsAgent(BaseModel):
|
|
|
74
73
|
exclude=excluded_fields,
|
|
75
74
|
exclude_none=True,
|
|
76
75
|
)
|
|
77
|
-
# override the default output from pydantic by calling `to_dict()` of each item in list (list)
|
|
78
|
-
_items = []
|
|
79
|
-
if self.list:
|
|
80
|
-
for _item_list in self.list:
|
|
81
|
-
if _item_list:
|
|
82
|
-
_items.append(_item_list.to_dict())
|
|
83
|
-
_dict['list'] = _items
|
|
84
76
|
# override the default output from pydantic by calling `to_dict()` of user_specified_currency_total
|
|
85
77
|
if self.user_specified_currency_total:
|
|
86
78
|
_dict['userSpecifiedCurrencyTotal'] = self.user_specified_currency_total.to_dict()
|
|
@@ -99,8 +91,8 @@ class BookingConfirmationsAgent(BaseModel):
|
|
|
99
91
|
return cls.model_validate(obj)
|
|
100
92
|
|
|
101
93
|
_obj = cls.model_validate({
|
|
102
|
-
"list":
|
|
103
|
-
"pointsToBeEarned": obj.get("pointsToBeEarned"),
|
|
94
|
+
"list": obj.get("list"),
|
|
95
|
+
"pointsToBeEarned": obj.get("pointsToBeEarned") if obj.get("pointsToBeEarned") is not None else 0,
|
|
104
96
|
"userSpecifiedCurrencyTotal": CustomMonetaryAmount.from_dict(obj["userSpecifiedCurrencyTotal"]) if obj.get("userSpecifiedCurrencyTotal") is not None else None,
|
|
105
97
|
"sourceTotal": CustomMonetaryAmount.from_dict(obj["sourceTotal"]) if obj.get("sourceTotal") is not None else None
|
|
106
98
|
})
|