wink-sdk-travel-agent 0.0.25__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/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 +6 -14
- 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/boolean_response_agent.py +2 -2
- wink_sdk_travel_agent/models/cancellation_detail_agent.py +4 -3
- 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/composite_filter_descriptor_agent.py +3 -3
- wink_sdk_travel_agent/models/contact_agent.py +3 -3
- 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/extra_charge_agent.py +6 -6
- wink_sdk_travel_agent/models/extra_charges_agent.py +3 -3
- 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_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/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 +11 -11
- 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/page_booking_agent.py +124 -0
- 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/perk_lightweight_agent.py +7 -6
- wink_sdk_travel_agent/models/personal_agent.py +8 -24
- wink_sdk_travel_agent/models/preferences_agent.py +13 -13
- 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_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/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 +7 -7
- 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_lightweight_agent.py +92 -0
- 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.25.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.25.dist-info → wink_sdk_travel_agent-0.0.26.dist-info}/WHEEL +1 -1
- wink_sdk_travel_agent-0.0.25.dist-info/RECORD +0 -119
- {wink_sdk_travel_agent-0.0.25.dist-info → wink_sdk_travel_agent-0.0.26.dist-info}/licenses/LICENSE +0 -0
- {wink_sdk_travel_agent-0.0.25.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
|
|
|
@@ -34,52 +34,52 @@ from typing_extensions import Self
|
|
|
34
34
|
|
|
35
35
|
class GuestRoomLightweightAgent(BaseModel):
|
|
36
36
|
"""
|
|
37
|
-
|
|
37
|
+
GuestRoomLightweightAgent
|
|
38
38
|
""" # noqa: E501
|
|
39
|
-
identifier:
|
|
40
|
-
hotel_identifier:
|
|
39
|
+
identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Unique record identifier")
|
|
40
|
+
hotel_identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Hotel identifier.", alias="hotelIdentifier")
|
|
41
41
|
featured_ind: StrictBool = Field(description="Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.", alias="featuredInd")
|
|
42
42
|
lifestyle_type: Optional[StrictStr] = Field(default=None, description="Indicate the type of lifestyle this blocking should be associated with.", alias="lifestyleType")
|
|
43
|
-
location: GeoJsonPointAgent
|
|
44
|
-
descriptions: List[SimpleDescriptionAgent]
|
|
45
|
-
multimedias: List[SimpleMultimediaAgent]
|
|
46
|
-
contact: ContactAgent
|
|
47
|
-
address: SimpleAddressAgent
|
|
43
|
+
location: GeoJsonPointAgent = Field(description="Geo-location point where blocking takes place. Defaults to location of property.")
|
|
44
|
+
descriptions: Annotated[List[SimpleDescriptionAgent], Field(min_length=1)]
|
|
45
|
+
multimedias: Annotated[List[SimpleMultimediaAgent], Field(min_length=1)]
|
|
46
|
+
contact: ContactAgent = Field(description="Associate a contact person for this blocking (if applicable).")
|
|
47
|
+
address: SimpleAddressAgent = Field(description="Defaults to property address.")
|
|
48
48
|
commissionable: StrictBool = Field(description="Indicate whether sales channels receive commission for selling this blocking.")
|
|
49
|
-
name:
|
|
49
|
+
name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Internal name of blocking.")
|
|
50
50
|
proximity_code: StrictStr = Field(description="Supported OTA specification `PRX` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="proximityCode")
|
|
51
51
|
sort: Optional[StrictInt] = Field(default=None, description="Use this property to sort an blocking in a list of activities.")
|
|
52
52
|
min_age_appropriate_code: Optional[StrictStr] = Field(default=None, description="Supported OTA specification `AQC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="minAgeAppropriateCode")
|
|
53
53
|
bookable: StrictBool = Field(description="Indicates if this blocking can be added to a booking or if it is read-only marketing material only.")
|
|
54
54
|
active: StrictBool = Field(description="Modify blocking availability with this flag.")
|
|
55
|
-
disability_features: Optional[List[StrictStr]] = Field(default=None,
|
|
56
|
-
security_features: Optional[List[StrictStr]] = Field(default=None,
|
|
57
|
-
socials: Optional[List[SocialAgent]] =
|
|
55
|
+
disability_features: Optional[List[StrictStr]] = Field(default=None, alias="disabilityFeatures")
|
|
56
|
+
security_features: Optional[List[StrictStr]] = Field(default=None, alias="securityFeatures")
|
|
57
|
+
socials: Optional[List[SocialAgent]] = None
|
|
58
58
|
price_point: StrictStr = Field(description="Level of expensiveness.", alias="pricePoint")
|
|
59
|
-
recognition_list: Optional[List[TravelInventoryRecognitionAgent]] = Field(default=None,
|
|
59
|
+
recognition_list: Optional[List[TravelInventoryRecognitionAgent]] = Field(default=None, alias="recognitionList")
|
|
60
60
|
max_occupancy: Annotated[int, Field(strict=True, ge=1)] = Field(description="Maximum number of guest allowed in a room type.", alias="maxOccupancy")
|
|
61
61
|
min_occupancy: Annotated[int, Field(strict=True, ge=1)] = Field(description="Minimum number of guests allowed in a room type.", alias="minOccupancy")
|
|
62
62
|
quantity: Annotated[int, Field(strict=True, ge=1)] = Field(description="Defines the number of rooms of this type")
|
|
63
63
|
non_smoking: StrictBool = Field(description="Non-smoking indicator", alias="nonSmoking")
|
|
64
|
-
bedroom_configuration_list: List[BedroomConfigurationAgent]
|
|
64
|
+
bedroom_configuration_list: Annotated[List[BedroomConfigurationAgent], Field(min_length=1)] = Field(alias="bedroomConfigurationList")
|
|
65
65
|
size: Union[Annotated[float, Field(strict=True, ge=1)], Annotated[int, Field(strict=True, ge=1)]] = Field(description="Number of square meters that defines the size of this room type.")
|
|
66
66
|
max_adult_occupancy: Annotated[int, Field(strict=True, ge=1)] = Field(description="Maximum number of adults allowed in a room type.", alias="maxAdultOccupancy")
|
|
67
67
|
max_child_occupancy: Annotated[int, Field(strict=True, ge=0)] = Field(description="Maximum number of children allowed in a room type.", alias="maxChildOccupancy")
|
|
68
68
|
bathroom_count: Annotated[int, Field(strict=True, ge=0)] = Field(description="Number of bathrooms", alias="bathroomCount")
|
|
69
69
|
living_room_count: Annotated[int, Field(strict=True, ge=0)] = Field(description="Number of living rooms", alias="livingRoomCount")
|
|
70
70
|
max_rollaways: Annotated[int, Field(strict=True, ge=0)] = Field(description="Maximum number of rollaway beds allowed in this room type.", alias="maxRollaways")
|
|
71
|
-
room_category:
|
|
71
|
+
room_category: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="roomCategory")
|
|
72
72
|
floor: Optional[StrictStr] = Field(default=None, description="Floor an which a room is located")
|
|
73
|
-
room_location_code:
|
|
74
|
-
room_view_code:
|
|
73
|
+
room_location_code: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Indicates the location of the room within the hotel structure. Typical values would be \"Near Exit\",\"Close to elevator\", \"Low Floor\" or \"High Floor\". Supported OTA specification `RLT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="roomLocationCode")
|
|
74
|
+
room_view_code: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Indicates the view of the room. Typical values would be \"Ocean view\", \"Pool view\" or \"Garden View\". Supported OTA specification `RVT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="roomViewCode")
|
|
75
75
|
composite: StrictBool = Field(description="Indicates that the room (suite) is a composite of smaller units.")
|
|
76
76
|
composite_count: Annotated[int, Field(strict=True, ge=0)] = Field(description="Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.", alias="compositeCount")
|
|
77
|
-
room_classification_code:
|
|
78
|
-
room_architecture_code:
|
|
77
|
+
room_classification_code: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Specifies the room classification (e.g., cabin, apartment). Supported OTA specification `GRI` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="roomClassificationCode")
|
|
78
|
+
room_architecture_code: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Specifies the architectural style of a room. Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="roomArchitectureCode")
|
|
79
79
|
room_gender: Optional[StrictStr] = Field(default='Unknown', description="Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.", alias="roomGender")
|
|
80
80
|
shared_room_ind: StrictBool = Field(description="If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.", alias="sharedRoomInd")
|
|
81
81
|
max_cribs: Annotated[int, Field(strict=True, ge=0)] = Field(description="Maximum number of cribs allowed in a room type.", alias="maxCribs")
|
|
82
|
-
amenities: Optional[List[StrictStr]] =
|
|
82
|
+
amenities: Optional[List[StrictStr]] = None
|
|
83
83
|
included_adult_occupancy: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of pax the room price was meant for", alias="includedAdultOccupancy")
|
|
84
84
|
included_child_occupancy: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of children the room price was meant for", alias="includedChildOccupancy")
|
|
85
85
|
__properties: ClassVar[List[str]] = ["identifier", "hotelIdentifier", "featuredInd", "lifestyleType", "location", "descriptions", "multimedias", "contact", "address", "commissionable", "name", "proximityCode", "sort", "minAgeAppropriateCode", "bookable", "active", "disabilityFeatures", "securityFeatures", "socials", "pricePoint", "recognitionList", "maxOccupancy", "minOccupancy", "quantity", "nonSmoking", "bedroomConfigurationList", "size", "maxAdultOccupancy", "maxChildOccupancy", "bathroomCount", "livingRoomCount", "maxRollaways", "roomCategory", "floor", "roomLocationCode", "roomViewCode", "composite", "compositeCount", "roomClassificationCode", "roomArchitectureCode", "roomGender", "sharedRoomInd", "maxCribs", "amenities", "includedAdultOccupancy", "includedChildOccupancy"]
|
|
@@ -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,8 @@ import json
|
|
|
20
20
|
|
|
21
21
|
from pydantic import BaseModel, ConfigDict, Field, StrictStr
|
|
22
22
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
23
|
-
from
|
|
23
|
+
from typing_extensions import Annotated
|
|
24
|
+
from wink_sdk_travel_agent.models.profile_lightweight_agent import ProfileLightweightAgent
|
|
24
25
|
from typing import Optional, Set
|
|
25
26
|
from typing_extensions import Self
|
|
26
27
|
|
|
@@ -29,11 +30,11 @@ class GuestUserAgent(BaseModel):
|
|
|
29
30
|
GuestUserAgent
|
|
30
31
|
""" # noqa: E501
|
|
31
32
|
user_identifier: Optional[StrictStr] = Field(default=None, description="User identifier", alias="userIdentifier")
|
|
32
|
-
first_name:
|
|
33
|
-
last_name:
|
|
34
|
-
email:
|
|
33
|
+
first_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="First name", alias="firstName")
|
|
34
|
+
last_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Last name", alias="lastName")
|
|
35
|
+
email: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Email")
|
|
35
36
|
telephone: Optional[StrictStr] = Field(default=None, description="Telephone")
|
|
36
|
-
profile: Optional[
|
|
37
|
+
profile: Optional[ProfileLightweightAgent] = Field(default=None, description="Optional profile record")
|
|
37
38
|
full_name: Optional[StrictStr] = Field(default=None, description="Full name", alias="fullName")
|
|
38
39
|
__properties: ClassVar[List[str]] = ["userIdentifier", "firstName", "lastName", "email", "telephone", "profile", "fullName"]
|
|
39
40
|
|
|
@@ -98,7 +99,7 @@ class GuestUserAgent(BaseModel):
|
|
|
98
99
|
"lastName": obj.get("lastName"),
|
|
99
100
|
"email": obj.get("email"),
|
|
100
101
|
"telephone": obj.get("telephone"),
|
|
101
|
-
"profile":
|
|
102
|
+
"profile": ProfileLightweightAgent.from_dict(obj["profile"]) if obj.get("profile") is not None else None,
|
|
102
103
|
"fullName": obj.get("fullName")
|
|
103
104
|
})
|
|
104
105
|
return _obj
|
|
@@ -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,15 +20,16 @@ import json
|
|
|
20
20
|
|
|
21
21
|
from pydantic import BaseModel, ConfigDict, Field, StrictStr
|
|
22
22
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
23
|
+
from typing_extensions import Annotated
|
|
23
24
|
from typing import Optional, Set
|
|
24
25
|
from typing_extensions import Self
|
|
25
26
|
|
|
26
27
|
class ImageAttributionAgent(BaseModel):
|
|
27
28
|
"""
|
|
28
|
-
|
|
29
|
+
ImageAttributionAgent
|
|
29
30
|
""" # noqa: E501
|
|
30
31
|
url: Optional[StrictStr] = Field(default=None, description="URL to contributor")
|
|
31
|
-
name:
|
|
32
|
+
name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Name of contributor")
|
|
32
33
|
__properties: ClassVar[List[str]] = ["url", "name"]
|
|
33
34
|
|
|
34
35
|
model_config = ConfigDict(
|
|
@@ -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
|
|
|
@@ -18,19 +18,32 @@ import pprint
|
|
|
18
18
|
import re # noqa: F401
|
|
19
19
|
import json
|
|
20
20
|
|
|
21
|
-
from pydantic import BaseModel, ConfigDict, Field
|
|
22
|
-
from typing import Any, ClassVar, Dict, List
|
|
21
|
+
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
|
|
22
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
23
23
|
from typing_extensions import Annotated
|
|
24
24
|
from typing import Optional, Set
|
|
25
25
|
from typing_extensions import Self
|
|
26
26
|
|
|
27
27
|
class LocalizedDescriptionAgent(BaseModel):
|
|
28
28
|
"""
|
|
29
|
-
|
|
29
|
+
LocalizedDescriptionAgent
|
|
30
30
|
""" # noqa: E501
|
|
31
31
|
description: Annotated[str, Field(min_length=1, strict=True, max_length=2147483647)] = Field(description="Longer text description")
|
|
32
32
|
language: Annotated[str, Field(min_length=2, strict=True, max_length=2)] = Field(description="Indicate which language this description is written in.")
|
|
33
|
-
|
|
33
|
+
creator: Optional[StrictStr] = Field(default='USER', description="Whether it was user or system generated.")
|
|
34
|
+
md5_content_hash: Optional[StrictStr] = Field(default=None, description="The md5 hash of the name, description and language.", alias="md5ContentHash")
|
|
35
|
+
hash_mismatch: Optional[StrictBool] = Field(default=None, alias="hashMismatch")
|
|
36
|
+
__properties: ClassVar[List[str]] = ["description", "language", "creator", "md5ContentHash", "hashMismatch"]
|
|
37
|
+
|
|
38
|
+
@field_validator('creator')
|
|
39
|
+
def creator_validate_enum(cls, value):
|
|
40
|
+
"""Validates the enum"""
|
|
41
|
+
if value is None:
|
|
42
|
+
return value
|
|
43
|
+
|
|
44
|
+
if value not in set(['SYSTEM', 'USER']):
|
|
45
|
+
raise ValueError("must be one of enum values ('SYSTEM', 'USER')")
|
|
46
|
+
return value
|
|
34
47
|
|
|
35
48
|
model_config = ConfigDict(
|
|
36
49
|
populate_by_name=True,
|
|
@@ -62,8 +75,10 @@ class LocalizedDescriptionAgent(BaseModel):
|
|
|
62
75
|
* `None` is only added to the output dict for nullable fields that
|
|
63
76
|
were set at model initialization. Other fields with value `None`
|
|
64
77
|
are ignored.
|
|
78
|
+
* OpenAPI `readOnly` fields are excluded.
|
|
65
79
|
"""
|
|
66
80
|
excluded_fields: Set[str] = set([
|
|
81
|
+
"hash_mismatch",
|
|
67
82
|
])
|
|
68
83
|
|
|
69
84
|
_dict = self.model_dump(
|
|
@@ -84,7 +99,10 @@ class LocalizedDescriptionAgent(BaseModel):
|
|
|
84
99
|
|
|
85
100
|
_obj = cls.model_validate({
|
|
86
101
|
"description": obj.get("description"),
|
|
87
|
-
"language": obj.get("language") if obj.get("language") is not None else 'en'
|
|
102
|
+
"language": obj.get("language") if obj.get("language") is not None else 'en',
|
|
103
|
+
"creator": obj.get("creator") if obj.get("creator") is not None else 'USER',
|
|
104
|
+
"md5ContentHash": obj.get("md5ContentHash"),
|
|
105
|
+
"hashMismatch": obj.get("hashMismatch")
|
|
88
106
|
})
|
|
89
107
|
return _obj
|
|
90
108
|
|
|
@@ -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,19 +21,19 @@ import json
|
|
|
21
21
|
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt
|
|
22
22
|
from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
23
23
|
from wink_sdk_travel_agent.models.custom_monetary_amount import CustomMonetaryAmount
|
|
24
|
-
from wink_sdk_travel_agent.models.
|
|
24
|
+
from wink_sdk_travel_agent.models.quote_lightweight_agent import QuoteLightweightAgent
|
|
25
25
|
from typing import Optional, Set
|
|
26
26
|
from typing_extensions import Self
|
|
27
27
|
|
|
28
28
|
class LocalizedPriceAgent(BaseModel):
|
|
29
29
|
"""
|
|
30
|
-
|
|
30
|
+
LocalizedPriceAgent
|
|
31
31
|
""" # noqa: E501
|
|
32
|
-
source_to_user_currency_quote:
|
|
33
|
-
source_to_internal_currency_quote:
|
|
34
|
-
user_specified_currency_base_total: CustomMonetaryAmount = Field(alias="userSpecifiedCurrencyBaseTotal")
|
|
35
|
-
source_base_total: CustomMonetaryAmount = Field(alias="sourceBaseTotal")
|
|
36
|
-
internal_base_total: CustomMonetaryAmount = Field(alias="internalBaseTotal")
|
|
32
|
+
source_to_user_currency_quote: QuoteLightweightAgent = Field(description="Hotel to user currency exchange rate.", alias="sourceToUserCurrencyQuote")
|
|
33
|
+
source_to_internal_currency_quote: QuoteLightweightAgent = Field(description="Hotel to wink currency exchange rate.", alias="sourceToInternalCurrencyQuote")
|
|
34
|
+
user_specified_currency_base_total: CustomMonetaryAmount = Field(description="Base total in user specified currency.", alias="userSpecifiedCurrencyBaseTotal")
|
|
35
|
+
source_base_total: CustomMonetaryAmount = Field(description="Base total in hotel currency.", alias="sourceBaseTotal")
|
|
36
|
+
internal_base_total: CustomMonetaryAmount = Field(description="Base total in wink currency.", alias="internalBaseTotal")
|
|
37
37
|
user_specified_currency_promotional_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Promotional modifiers in user specified currency", alias="userSpecifiedCurrencyPromotionalModifier")
|
|
38
38
|
source_promotional_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Promotional modifiers in hotel currency", alias="sourcePromotionalModifier")
|
|
39
39
|
internal_promotional_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Promotional modifiers in wink currency", alias="internalPromotionalModifier")
|
|
@@ -131,8 +131,8 @@ class LocalizedPriceAgent(BaseModel):
|
|
|
131
131
|
return cls.model_validate(obj)
|
|
132
132
|
|
|
133
133
|
_obj = cls.model_validate({
|
|
134
|
-
"sourceToUserCurrencyQuote":
|
|
135
|
-
"sourceToInternalCurrencyQuote":
|
|
134
|
+
"sourceToUserCurrencyQuote": QuoteLightweightAgent.from_dict(obj["sourceToUserCurrencyQuote"]) if obj.get("sourceToUserCurrencyQuote") is not None else None,
|
|
135
|
+
"sourceToInternalCurrencyQuote": QuoteLightweightAgent.from_dict(obj["sourceToInternalCurrencyQuote"]) if obj.get("sourceToInternalCurrencyQuote") is not None else None,
|
|
136
136
|
"userSpecifiedCurrencyBaseTotal": CustomMonetaryAmount.from_dict(obj["userSpecifiedCurrencyBaseTotal"]) if obj.get("userSpecifiedCurrencyBaseTotal") is not None else None,
|
|
137
137
|
"sourceBaseTotal": CustomMonetaryAmount.from_dict(obj["sourceBaseTotal"]) if obj.get("sourceBaseTotal") is not None else None,
|
|
138
138
|
"internalBaseTotal": CustomMonetaryAmount.from_dict(obj["internalBaseTotal"]) if obj.get("internalBaseTotal") is not None else None,
|
|
@@ -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
|
|
|
@@ -18,20 +18,21 @@ import pprint
|
|
|
18
18
|
import re # noqa: F401
|
|
19
19
|
import json
|
|
20
20
|
|
|
21
|
-
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt
|
|
21
|
+
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt
|
|
22
22
|
from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
23
|
+
from typing_extensions import Annotated
|
|
23
24
|
from wink_sdk_travel_agent.models.managed_by_entity_rules_agent import ManagedByEntityRulesAgent
|
|
24
25
|
from typing import Optional, Set
|
|
25
26
|
from typing_extensions import Self
|
|
26
27
|
|
|
27
28
|
class ManagedByEntityAgent(BaseModel):
|
|
28
29
|
"""
|
|
29
|
-
|
|
30
|
+
ManagedByEntityAgent
|
|
30
31
|
""" # noqa: E501
|
|
31
|
-
identifier:
|
|
32
|
-
name:
|
|
32
|
+
identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Entity identifier")
|
|
33
|
+
name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Name of entity")
|
|
33
34
|
commission_in_percent: Union[StrictFloat, StrictInt] = Field(description="Agency commission", alias="commissionInPercent")
|
|
34
|
-
rules: Optional[ManagedByEntityRulesAgent] = None
|
|
35
|
+
rules: Optional[ManagedByEntityRulesAgent] = Field(default=None, description="Optional rules for expiration date etc when agency is no longer managing this entity.")
|
|
35
36
|
valid: Optional[StrictBool] = Field(default=None, description="Whether managing entity is eligible a commission.")
|
|
36
37
|
__properties: ClassVar[List[str]] = ["identifier", "name", "commissionInPercent", "rules", "valid"]
|
|
37
38
|
|
|
@@ -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
|
|
|
@@ -26,7 +26,7 @@ from typing_extensions import Self
|
|
|
26
26
|
|
|
27
27
|
class ManagedByEntityRulesAgent(BaseModel):
|
|
28
28
|
"""
|
|
29
|
-
|
|
29
|
+
ManagedByEntityRulesAgent
|
|
30
30
|
""" # noqa: E501
|
|
31
31
|
expires: Optional[date] = Field(default=None, description="Optional expiration date when agency is no longer managing this entity.")
|
|
32
32
|
num_bookings: Optional[StrictInt] = Field(default=None, description="Optional total number of bookings [left] the agency is entitled to commission. This number will decrement every time a booking is made with this agency involved.", alias="numBookings")
|