wink-sdk-travel-agent 0.0.55__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.
Files changed (144) hide show
  1. wink_sdk_travel_agent/__init__.py +229 -0
  2. wink_sdk_travel_agent/api/__init__.py +6 -0
  3. wink_sdk_travel_agent/api/analytics_api.py +671 -0
  4. wink_sdk_travel_agent/api/travel_agent_api.py +1668 -0
  5. wink_sdk_travel_agent/api_client.py +805 -0
  6. wink_sdk_travel_agent/api_response.py +21 -0
  7. wink_sdk_travel_agent/configuration.py +582 -0
  8. wink_sdk_travel_agent/exceptions.py +217 -0
  9. wink_sdk_travel_agent/models/__init__.py +106 -0
  10. wink_sdk_travel_agent/models/address_agent.py +111 -0
  11. wink_sdk_travel_agent/models/affiliate_account_agent.py +181 -0
  12. wink_sdk_travel_agent/models/affiliate_account_user_agent.py +115 -0
  13. wink_sdk_travel_agent/models/agent_booking_request_agent.py +130 -0
  14. wink_sdk_travel_agent/models/aggregate_descriptor_agent.py +100 -0
  15. wink_sdk_travel_agent/models/ancillary_request_agent.py +111 -0
  16. wink_sdk_travel_agent/models/authenticated_user_agent.py +100 -0
  17. wink_sdk_travel_agent/models/bed_agent.py +91 -0
  18. wink_sdk_travel_agent/models/bedroom_agent.py +106 -0
  19. wink_sdk_travel_agent/models/bedroom_configuration_agent.py +102 -0
  20. wink_sdk_travel_agent/models/beneficiary_agent.py +156 -0
  21. wink_sdk_travel_agent/models/beneficiary_charge_agent.py +97 -0
  22. wink_sdk_travel_agent/models/booking_agent.py +342 -0
  23. wink_sdk_travel_agent/models/booking_analytics_supplier.py +96 -0
  24. wink_sdk_travel_agent/models/booking_ancillary_agent.py +155 -0
  25. wink_sdk_travel_agent/models/booking_confirmations_agent.py +101 -0
  26. wink_sdk_travel_agent/models/booking_contract_agent.py +697 -0
  27. wink_sdk_travel_agent/models/booking_contract_item_agent.py +206 -0
  28. wink_sdk_travel_agent/models/booking_contract_payment_details_agent.py +124 -0
  29. wink_sdk_travel_agent/models/booking_itinerary_agent.py +113 -0
  30. wink_sdk_travel_agent/models/booking_itinerary_room_configuration_agent.py +98 -0
  31. wink_sdk_travel_agent/models/booking_itinerary_room_configuration_child_agent.py +90 -0
  32. wink_sdk_travel_agent/models/booking_overview_request_supplier.py +97 -0
  33. wink_sdk_travel_agent/models/booking_user_agent.py +102 -0
  34. wink_sdk_travel_agent/models/booking_user_request_agent.py +96 -0
  35. wink_sdk_travel_agent/models/booking_user_session_agent.py +112 -0
  36. wink_sdk_travel_agent/models/booking_view_agent.py +101 -0
  37. wink_sdk_travel_agent/models/boolean_response_agent.py +90 -0
  38. wink_sdk_travel_agent/models/cancellation_detail_agent.py +98 -0
  39. wink_sdk_travel_agent/models/cancellation_policy_agent.py +166 -0
  40. wink_sdk_travel_agent/models/cancellation_policy_exception_agent.py +100 -0
  41. wink_sdk_travel_agent/models/cancellation_policy_exceptions_agent.py +97 -0
  42. wink_sdk_travel_agent/models/cancellation_policy_lightweight_agent.py +167 -0
  43. wink_sdk_travel_agent/models/chart_category_axis_supplier.py +88 -0
  44. wink_sdk_travel_agent/models/chart_legend_supplier.py +88 -0
  45. wink_sdk_travel_agent/models/chart_series_supplier.py +90 -0
  46. wink_sdk_travel_agent/models/chart_title_supplier.py +88 -0
  47. wink_sdk_travel_agent/models/child_agent.py +91 -0
  48. wink_sdk_travel_agent/models/commissionable_entry_agent.py +102 -0
  49. wink_sdk_travel_agent/models/company_agent.py +176 -0
  50. wink_sdk_travel_agent/models/company_user_agent.py +114 -0
  51. wink_sdk_travel_agent/models/company_view_agent.py +101 -0
  52. wink_sdk_travel_agent/models/composite_filter_descriptor_agent.py +108 -0
  53. wink_sdk_travel_agent/models/contact_agent.py +104 -0
  54. wink_sdk_travel_agent/models/country_agent.py +100 -0
  55. wink_sdk_travel_agent/models/country_lightweight_agent.py +100 -0
  56. wink_sdk_travel_agent/models/create_agent_booking400_response.py +141 -0
  57. wink_sdk_travel_agent/models/create_agent_booking_request_agent.py +105 -0
  58. wink_sdk_travel_agent/models/custom_monetary_amount.py +91 -0
  59. wink_sdk_travel_agent/models/customization_lightweight_agent.py +232 -0
  60. wink_sdk_travel_agent/models/customization_theme_colors_agent.py +108 -0
  61. wink_sdk_travel_agent/models/daily_rate_agent.py +115 -0
  62. wink_sdk_travel_agent/models/dow_pattern_group_agent.py +102 -0
  63. wink_sdk_travel_agent/models/engine_configuration_booking_report_agent.py +230 -0
  64. wink_sdk_travel_agent/models/engine_configuration_theme_agent.py +108 -0
  65. wink_sdk_travel_agent/models/engine_configuration_theme_colors_agent.py +108 -0
  66. wink_sdk_travel_agent/models/extra_charge_agent.py +103 -0
  67. wink_sdk_travel_agent/models/extra_charges_agent.py +112 -0
  68. wink_sdk_travel_agent/models/fee_agent.py +105 -0
  69. wink_sdk_travel_agent/models/filter_descriptor_agent.py +107 -0
  70. wink_sdk_travel_agent/models/general_manager_agent.py +104 -0
  71. wink_sdk_travel_agent/models/generic_error_message.py +94 -0
  72. wink_sdk_travel_agent/models/geo_json_point_agent.py +94 -0
  73. wink_sdk_travel_agent/models/geo_name_agent.py +136 -0
  74. wink_sdk_travel_agent/models/geo_name_lightweight_agent.py +136 -0
  75. wink_sdk_travel_agent/models/group_descriptor_agent.py +110 -0
  76. wink_sdk_travel_agent/models/grouped_booking_sales_metrics_supplier_details.py +110 -0
  77. wink_sdk_travel_agent/models/guest_room_agent.py +258 -0
  78. wink_sdk_travel_agent/models/guest_room_lightweight_agent.py +259 -0
  79. wink_sdk_travel_agent/models/guest_user_agent.py +108 -0
  80. wink_sdk_travel_agent/models/hotel_on_map_agent.py +270 -0
  81. wink_sdk_travel_agent/models/image_attribution_agent.py +91 -0
  82. wink_sdk_travel_agent/models/line_chart_supplier.py +122 -0
  83. wink_sdk_travel_agent/models/localized_description_agent.py +109 -0
  84. wink_sdk_travel_agent/models/localized_price_agent.py +162 -0
  85. wink_sdk_travel_agent/models/managed_by_entity_agent.py +103 -0
  86. wink_sdk_travel_agent/models/managed_by_entity_rules_agent.py +95 -0
  87. wink_sdk_travel_agent/models/media_author_attribution_agent.py +91 -0
  88. wink_sdk_travel_agent/models/online_presence_agent.py +112 -0
  89. wink_sdk_travel_agent/models/page_booking_agent.py +124 -0
  90. wink_sdk_travel_agent/models/page_booking_view_agent.py +124 -0
  91. wink_sdk_travel_agent/models/pageable_object_agent.py +102 -0
  92. wink_sdk_travel_agent/models/payout_agent.py +158 -0
  93. wink_sdk_travel_agent/models/payout_fee_agent.py +116 -0
  94. wink_sdk_travel_agent/models/pending_refund_agent.py +99 -0
  95. wink_sdk_travel_agent/models/perk_lightweight_agent.py +105 -0
  96. wink_sdk_travel_agent/models/personal_agent.py +139 -0
  97. wink_sdk_travel_agent/models/pet_info_dto_agent.py +90 -0
  98. wink_sdk_travel_agent/models/preferences_agent.py +128 -0
  99. wink_sdk_travel_agent/models/profile_agent.py +110 -0
  100. wink_sdk_travel_agent/models/profile_lightweight_agent.py +111 -0
  101. wink_sdk_travel_agent/models/profile_user_agent.py +100 -0
  102. wink_sdk_travel_agent/models/property_aggregate_lightweight_agent.py +245 -0
  103. wink_sdk_travel_agent/models/property_policy_agent.py +150 -0
  104. wink_sdk_travel_agent/models/quote_agent.py +94 -0
  105. wink_sdk_travel_agent/models/quote_lightweight_agent.py +95 -0
  106. wink_sdk_travel_agent/models/rate_plan_agent.py +172 -0
  107. wink_sdk_travel_agent/models/rate_plan_level_fee_agent.py +112 -0
  108. wink_sdk_travel_agent/models/refund_agent.py +167 -0
  109. wink_sdk_travel_agent/models/reporting_ancillary_agent.py +108 -0
  110. wink_sdk_travel_agent/models/reporting_daily_rate_agent.py +99 -0
  111. wink_sdk_travel_agent/models/reporting_extra_charge_agent.py +98 -0
  112. wink_sdk_travel_agent/models/review_agent.py +133 -0
  113. wink_sdk_travel_agent/models/review_answer_agent.py +102 -0
  114. wink_sdk_travel_agent/models/review_lightweight_agent.py +134 -0
  115. wink_sdk_travel_agent/models/review_user_agent.py +99 -0
  116. wink_sdk_travel_agent/models/room_configuration_agent.py +99 -0
  117. wink_sdk_travel_agent/models/room_configuration_price_rate_plan_agent.py +130 -0
  118. wink_sdk_travel_agent/models/room_stay_agent.py +183 -0
  119. wink_sdk_travel_agent/models/simple_address_agent.py +109 -0
  120. wink_sdk_travel_agent/models/simple_date_time_itinerary_agent.py +108 -0
  121. wink_sdk_travel_agent/models/simple_description_agent.py +111 -0
  122. wink_sdk_travel_agent/models/simple_multimedia_agent.py +156 -0
  123. wink_sdk_travel_agent/models/social_agent.py +100 -0
  124. wink_sdk_travel_agent/models/sort_descriptor_agent.py +100 -0
  125. wink_sdk_travel_agent/models/sort_object.py +96 -0
  126. wink_sdk_travel_agent/models/sort_object_agent.py +92 -0
  127. wink_sdk_travel_agent/models/state_agent.py +117 -0
  128. wink_sdk_travel_agent/models/stay_rate_agent.py +209 -0
  129. wink_sdk_travel_agent/models/sub_country_agent.py +92 -0
  130. wink_sdk_travel_agent/models/sub_country_lightweight_agent.py +92 -0
  131. wink_sdk_travel_agent/models/sub_sub_country_agent.py +92 -0
  132. wink_sdk_travel_agent/models/sub_sub_country_lightweight_agent.py +92 -0
  133. wink_sdk_travel_agent/models/supplier_contract_item_policy_agent.py +170 -0
  134. wink_sdk_travel_agent/models/travel_agent_agent.py +90 -0
  135. wink_sdk_travel_agent/models/travel_inventory_recognition_agent.py +121 -0
  136. wink_sdk_travel_agent/models/upsert_travel_agent_request_agent.py +90 -0
  137. wink_sdk_travel_agent/models/wink_booking_contract_agent.py +697 -0
  138. wink_sdk_travel_agent/py.typed +0 -0
  139. wink_sdk_travel_agent/rest.py +259 -0
  140. wink_sdk_travel_agent-0.0.55.dist-info/METADATA +539 -0
  141. wink_sdk_travel_agent-0.0.55.dist-info/RECORD +144 -0
  142. wink_sdk_travel_agent-0.0.55.dist-info/WHEEL +5 -0
  143. wink_sdk_travel_agent-0.0.55.dist-info/licenses/LICENSE +201 -0
  144. wink_sdk_travel_agent-0.0.55.dist-info/top_level.txt +1 -0
@@ -0,0 +1,100 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Wink API
5
+
6
+ # Introduction Welcome to the Wink API - A programmer-friendly way to manage, sell and book travel inventory on the Wink platform. The API gives you all the tools you need to ready your properties and inventory for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel inventory and promote / sell it in a wide variety of ways. # Integrations We have already integrated with the most well-known channel managers so you don't have to. To see our current integrations, please go to https://extranet.wink.travel and scroll to Connectivity section. Once your properties are set up, you can finish the setup by mapping your property to Wink using your channel manager partner portal. If your properties don't have a channel manager, you can easily manage rates and availability with this API. # Intended Audience Programmers are [most likely] a requirement to start integrating with Wink. Companies and organizations that would most benefit from integrating with us are new and existing travel companies that have relationships with suppliers and that need an advanced system from which to manage their travel inventory and get that same inventory out to as many eyeballs as possible at the lowest price possible. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume endpoints are for developers who want to find existing travel inventory and either book it or use it to advertise through one of their Wink affiliate accounts. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [Inventory](/affiliate/inventory): The Inventory API exposes endpoints for affiliates to manage the inventory they want to sell and how they want to sell it. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [Channel manager](/channel-manager): The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties. ### Taxonomy APIs Taxonomy endpoints are for developers who want to consume and produce travel inventory and need taxonomies of standard and non-standard codes for inventory types, classes, statuses etc. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs Payment endpoints are for developers who want to purchase travel inventory. This can be done via the API as a registered Travel Agent or using our API in conjunction with our PCI compliant payment widget for all other entities. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs We are actively working on supporting the most used languages out there. If you don't see your language here, reach out to us with a request to officially add your language. In the meantime, if you want to roll your own SDK, you can do so by downloading the OpenAPI spec and using one of the many available OpenAPI generators available: [https://openapi-generator.tech/docs/generators](https://openapi-generator.tech/docs/generators). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning We chose to version our endpoints in a way that we hope affects your integration minimally. You request the version of our API you wish to work with via the `Wink-Version` header. When it's time for you to upgrade, you only have to change the version number to get access to our updated endpoints. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
7
+
8
+ The version of the OpenAPI document: 30.29.0
9
+ Contact: bjorn@wink.travel
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+
16
+ from __future__ import annotations
17
+ import pprint
18
+ import re # noqa: F401
19
+ import json
20
+
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictStr
22
+ from typing import Any, ClassVar, Dict, List, Optional
23
+ from typing import Optional, Set
24
+ from typing_extensions import Self
25
+
26
+ class ProfileUserAgent(BaseModel):
27
+ """
28
+ ProfileUserAgent
29
+ """ # noqa: E501
30
+ first_name: Optional[StrictStr] = Field(default=None, description="First name", alias="firstName")
31
+ last_name: Optional[StrictStr] = Field(default=None, description="Last name", alias="lastName")
32
+ email: Optional[StrictStr] = Field(default=None, description="Email")
33
+ phone: Optional[StrictStr] = Field(default=None, description="Telephone")
34
+ profile_picture_url: Optional[StrictStr] = Field(default=None, description="Profile picture URL", alias="profilePictureUrl")
35
+ full_name: Optional[StrictStr] = Field(default=None, description="Full name", alias="fullName")
36
+ __properties: ClassVar[List[str]] = ["firstName", "lastName", "email", "phone", "profilePictureUrl", "fullName"]
37
+
38
+ model_config = ConfigDict(
39
+ populate_by_name=True,
40
+ validate_assignment=True,
41
+ protected_namespaces=(),
42
+ )
43
+
44
+
45
+ def to_str(self) -> str:
46
+ """Returns the string representation of the model using alias"""
47
+ return pprint.pformat(self.model_dump(by_alias=True))
48
+
49
+ def to_json(self) -> str:
50
+ """Returns the JSON representation of the model using alias"""
51
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
52
+ return json.dumps(self.to_dict())
53
+
54
+ @classmethod
55
+ def from_json(cls, json_str: str) -> Optional[Self]:
56
+ """Create an instance of ProfileUserAgent from a JSON string"""
57
+ return cls.from_dict(json.loads(json_str))
58
+
59
+ def to_dict(self) -> Dict[str, Any]:
60
+ """Return the dictionary representation of the model using alias.
61
+
62
+ This has the following differences from calling pydantic's
63
+ `self.model_dump(by_alias=True)`:
64
+
65
+ * `None` is only added to the output dict for nullable fields that
66
+ were set at model initialization. Other fields with value `None`
67
+ are ignored.
68
+ * OpenAPI `readOnly` fields are excluded.
69
+ """
70
+ excluded_fields: Set[str] = set([
71
+ "full_name",
72
+ ])
73
+
74
+ _dict = self.model_dump(
75
+ by_alias=True,
76
+ exclude=excluded_fields,
77
+ exclude_none=True,
78
+ )
79
+ return _dict
80
+
81
+ @classmethod
82
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
83
+ """Create an instance of ProfileUserAgent from a dict"""
84
+ if obj is None:
85
+ return None
86
+
87
+ if not isinstance(obj, dict):
88
+ return cls.model_validate(obj)
89
+
90
+ _obj = cls.model_validate({
91
+ "firstName": obj.get("firstName"),
92
+ "lastName": obj.get("lastName"),
93
+ "email": obj.get("email"),
94
+ "phone": obj.get("phone"),
95
+ "profilePictureUrl": obj.get("profilePictureUrl"),
96
+ "fullName": obj.get("fullName")
97
+ })
98
+ return _obj
99
+
100
+
@@ -0,0 +1,245 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Wink API
5
+
6
+ # Introduction Welcome to the Wink API - A programmer-friendly way to manage, sell and book travel inventory on the Wink platform. The API gives you all the tools you need to ready your properties and inventory for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel inventory and promote / sell it in a wide variety of ways. # Integrations We have already integrated with the most well-known channel managers so you don't have to. To see our current integrations, please go to https://extranet.wink.travel and scroll to Connectivity section. Once your properties are set up, you can finish the setup by mapping your property to Wink using your channel manager partner portal. If your properties don't have a channel manager, you can easily manage rates and availability with this API. # Intended Audience Programmers are [most likely] a requirement to start integrating with Wink. Companies and organizations that would most benefit from integrating with us are new and existing travel companies that have relationships with suppliers and that need an advanced system from which to manage their travel inventory and get that same inventory out to as many eyeballs as possible at the lowest price possible. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume endpoints are for developers who want to find existing travel inventory and either book it or use it to advertise through one of their Wink affiliate accounts. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [Inventory](/affiliate/inventory): The Inventory API exposes endpoints for affiliates to manage the inventory they want to sell and how they want to sell it. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [Channel manager](/channel-manager): The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties. ### Taxonomy APIs Taxonomy endpoints are for developers who want to consume and produce travel inventory and need taxonomies of standard and non-standard codes for inventory types, classes, statuses etc. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs Payment endpoints are for developers who want to purchase travel inventory. This can be done via the API as a registered Travel Agent or using our API in conjunction with our PCI compliant payment widget for all other entities. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs We are actively working on supporting the most used languages out there. If you don't see your language here, reach out to us with a request to officially add your language. In the meantime, if you want to roll your own SDK, you can do so by downloading the OpenAPI spec and using one of the many available OpenAPI generators available: [https://openapi-generator.tech/docs/generators](https://openapi-generator.tech/docs/generators). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning We chose to version our endpoints in a way that we hope affects your integration minimally. You request the version of our API you wish to work with via the `Wink-Version` header. When it's time for you to upgrade, you only have to change the version number to get access to our updated endpoints. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
7
+
8
+ The version of the OpenAPI document: 30.29.0
9
+ Contact: bjorn@wink.travel
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+
16
+ from __future__ import annotations
17
+ import pprint
18
+ import re # noqa: F401
19
+ import json
20
+
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
22
+ from typing import Any, ClassVar, Dict, List, Optional, Union
23
+ from typing_extensions import Annotated
24
+ from uuid import UUID
25
+ from wink_sdk_travel_agent.models.contact_agent import ContactAgent
26
+ from wink_sdk_travel_agent.models.general_manager_agent import GeneralManagerAgent
27
+ from wink_sdk_travel_agent.models.geo_json_point_agent import GeoJsonPointAgent
28
+ from wink_sdk_travel_agent.models.property_policy_agent import PropertyPolicyAgent
29
+ from wink_sdk_travel_agent.models.simple_address_agent import SimpleAddressAgent
30
+ from wink_sdk_travel_agent.models.simple_description_agent import SimpleDescriptionAgent
31
+ from wink_sdk_travel_agent.models.simple_multimedia_agent import SimpleMultimediaAgent
32
+ from wink_sdk_travel_agent.models.social_agent import SocialAgent
33
+ from wink_sdk_travel_agent.models.travel_inventory_recognition_agent import TravelInventoryRecognitionAgent
34
+ from typing import Optional, Set
35
+ from typing_extensions import Self
36
+
37
+ class PropertyAggregateLightweightAgent(BaseModel):
38
+ """
39
+ PropertyAggregateLightweightAgent
40
+ """ # noqa: E501
41
+ hotel_identifier: Optional[UUID] = Field(default=None, description="Unique hotel record identifier.", alias="hotelIdentifier")
42
+ name: Optional[StrictStr] = Field(default=None, description="Hotel trade name")
43
+ local_name: Optional[StrictStr] = Field(default=None, description="Hotel local name if different from the trade name or if it is the local language.", alias="localName")
44
+ chain: Optional[StrictStr] = Field(default=None, description="Name of hotel chain if applicable.")
45
+ brand: Optional[StrictStr] = Field(default=None, description="Name of hotel brand")
46
+ url_name: Optional[StrictStr] = Field(default=None, description="Unique URL-friendly name slug of hotel", alias="urlName")
47
+ unique_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Event shorter name", alias="uniqueId")
48
+ star_rating: Optional[Annotated[int, Field(le=6, strict=True, ge=0)]] = Field(default=None, description="Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.", alias="starRating")
49
+ bookings: Optional[StrictInt] = Field(default=0, description="Number of bookings for this property on the wink.travel platform.")
50
+ aggregate_review_rating: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.0, description="Aggregate score based on all current user reviews.", alias="aggregateReviewRating")
51
+ location: Optional[GeoJsonPointAgent] = Field(default=None, description="Geo-location")
52
+ descriptions: Optional[List[SimpleDescriptionAgent]] = Field(default=None, description="Short and long welcome text")
53
+ aggregate_greendex_rating: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.0, description="Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.", alias="aggregateGreendexRating")
54
+ lifestyle_types: Optional[List[Any]] = Field(default=None, alias="lifestyleTypes")
55
+ total_reviews: Optional[StrictInt] = Field(default=0, description="Count of total reviews left by users at this property.", alias="totalReviews")
56
+ reservations: Optional[ContactAgent] = Field(default=None, description="Contact details for reservations desk")
57
+ socials: Optional[List[SocialAgent]] = Field(default=None, description="Property's social network accounts")
58
+ images: Optional[List[SimpleMultimediaAgent]] = Field(default=None, description="Property images.")
59
+ videos: Optional[List[SimpleMultimediaAgent]] = Field(default=None, description="Property videos.")
60
+ policy: Optional[PropertyPolicyAgent] = Field(default=None, description="Basic property policy record.")
61
+ third_party_reviews: Optional[List[TravelInventoryRecognitionAgent]] = Field(default=None, description="Array of awards and third party reviews given to property by certified / non-certified providers.", alias="thirdPartyReviews")
62
+ attractions: Optional[StrictInt] = Field(default=0, description="Number of attractions property has listed on its profile.")
63
+ activities: Optional[StrictInt] = Field(default=0, description="Number of activites property has listed on its profile.")
64
+ places: Optional[StrictInt] = Field(default=0, description="Number of places property has listed on its profile.")
65
+ restaurants: Optional[StrictInt] = Field(default=0, description="Number of restaurants property has on its profile.")
66
+ meeting_rooms: Optional[StrictInt] = Field(default=0, description="Number of meeting rooms property has on its profile.", alias="meetingRooms")
67
+ spas: Optional[StrictInt] = Field(default=0, description="Number of spas property has on its profile.")
68
+ add_ons: Optional[StrictInt] = Field(default=0, description="Number of add-ons property has on its profile.", alias="addOns")
69
+ general_manager: Optional[GeneralManagerAgent] = Field(default=None, alias="generalManager")
70
+ location_category: Optional[StrictStr] = Field(default=None, description="Supported OTA specification `LOC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="locationCategory")
71
+ segment_category: Optional[StrictStr] = Field(default=None, description="Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="segmentCategory")
72
+ hotel_category: Optional[StrictStr] = Field(default=None, description="Supported OTA specification `PCT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="hotelCategory")
73
+ architectural_style: Optional[StrictStr] = Field(default=None, description="Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="architecturalStyle")
74
+ when_built: Optional[StrictStr] = Field(default=None, description="Year the property was constructed.", alias="whenBuilt")
75
+ currency_code: Optional[StrictStr] = Field(default=None, description="Currency code for property.", alias="currencyCode")
76
+ membership_rate_discount: Optional[Union[StrictFloat, StrictInt]] = Field(default=0, description="A property's price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it's there to compare it against other properties.", alias="membershipRateDiscount")
77
+ price_score: Optional[StrictInt] = Field(default=0, description="A property's price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it's there to compare it against other properties.", alias="priceScore")
78
+ perk_score: Optional[StrictInt] = Field(default=0, description="A property's perk score is based on the type of perks that is offered to the guests across all master rates. There is no max score; it's there to compare it against other properties.", alias="perkScore")
79
+ add_on_score: Optional[StrictInt] = Field(default=0, description="A property's package score is based on general availability and price for all packages and add-ons offered by the property. There is no max score; it's there to compare it against other properties.", alias="addOnScore")
80
+ loyalty_score: Optional[StrictInt] = Field(default=0, description="A property's loyalty score is based on calculating how many available rate plans honor loyalty points. There is no max score; it's there to compare it against other properties.", alias="loyaltyScore")
81
+ popular_score: Optional[StrictInt] = Field(default=0, description="A property's popular score is based on calculating number of bookings across room types. There is no max score; it's there to compare it against other properties.", alias="popularScore")
82
+ experience_score: Optional[StrictInt] = Field(default=0, description="A property's experience score is based on how calculating how many types of experiences are available and at what price ranges. There is no max score; it's there to compare it against other properties.", alias="experienceScore")
83
+ hotel_amenity_codes: Optional[List[StrictStr]] = Field(default=None, description="Supported OTA specification `HAC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="hotelAmenityCodes")
84
+ property_accessibility_codes: Optional[List[StrictStr]] = Field(default=None, description="Supported OTA specification `PHY` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="propertyAccessibilityCodes")
85
+ property_security_codes: Optional[List[StrictStr]] = Field(default=None, description="Supported OTA specification `SEC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="propertySecurityCodes")
86
+ number_of_rooms: Optional[StrictInt] = Field(default=0, description="Number of rooms / keys for this property.", alias="numberOfRooms")
87
+ address: Optional[SimpleAddressAgent] = Field(default=None, description="Property address.")
88
+ active: Optional[StrictBool] = Field(default=None, description="Whether property is active")
89
+ url_parameters: Optional[StrictStr] = Field(default=None, description="Convenience data point that creates url friendly query parameters of property.", alias="urlParameters")
90
+ __properties: ClassVar[List[str]] = ["hotelIdentifier", "name", "localName", "chain", "brand", "urlName", "uniqueId", "starRating", "bookings", "aggregateReviewRating", "location", "descriptions", "aggregateGreendexRating", "lifestyleTypes", "totalReviews", "reservations", "socials", "images", "videos", "policy", "thirdPartyReviews", "attractions", "activities", "places", "restaurants", "meetingRooms", "spas", "addOns", "generalManager", "locationCategory", "segmentCategory", "hotelCategory", "architecturalStyle", "whenBuilt", "currencyCode", "membershipRateDiscount", "priceScore", "perkScore", "addOnScore", "loyaltyScore", "popularScore", "experienceScore", "hotelAmenityCodes", "propertyAccessibilityCodes", "propertySecurityCodes", "numberOfRooms", "address", "active", "urlParameters"]
91
+
92
+ model_config = ConfigDict(
93
+ populate_by_name=True,
94
+ validate_assignment=True,
95
+ protected_namespaces=(),
96
+ )
97
+
98
+
99
+ def to_str(self) -> str:
100
+ """Returns the string representation of the model using alias"""
101
+ return pprint.pformat(self.model_dump(by_alias=True))
102
+
103
+ def to_json(self) -> str:
104
+ """Returns the JSON representation of the model using alias"""
105
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
106
+ return json.dumps(self.to_dict())
107
+
108
+ @classmethod
109
+ def from_json(cls, json_str: str) -> Optional[Self]:
110
+ """Create an instance of PropertyAggregateLightweightAgent from a JSON string"""
111
+ return cls.from_dict(json.loads(json_str))
112
+
113
+ def to_dict(self) -> Dict[str, Any]:
114
+ """Return the dictionary representation of the model using alias.
115
+
116
+ This has the following differences from calling pydantic's
117
+ `self.model_dump(by_alias=True)`:
118
+
119
+ * `None` is only added to the output dict for nullable fields that
120
+ were set at model initialization. Other fields with value `None`
121
+ are ignored.
122
+ """
123
+ excluded_fields: Set[str] = set([
124
+ ])
125
+
126
+ _dict = self.model_dump(
127
+ by_alias=True,
128
+ exclude=excluded_fields,
129
+ exclude_none=True,
130
+ )
131
+ # override the default output from pydantic by calling `to_dict()` of location
132
+ if self.location:
133
+ _dict['location'] = self.location.to_dict()
134
+ # override the default output from pydantic by calling `to_dict()` of each item in descriptions (list)
135
+ _items = []
136
+ if self.descriptions:
137
+ for _item_descriptions in self.descriptions:
138
+ if _item_descriptions:
139
+ _items.append(_item_descriptions.to_dict())
140
+ _dict['descriptions'] = _items
141
+ # override the default output from pydantic by calling `to_dict()` of reservations
142
+ if self.reservations:
143
+ _dict['reservations'] = self.reservations.to_dict()
144
+ # override the default output from pydantic by calling `to_dict()` of each item in socials (list)
145
+ _items = []
146
+ if self.socials:
147
+ for _item_socials in self.socials:
148
+ if _item_socials:
149
+ _items.append(_item_socials.to_dict())
150
+ _dict['socials'] = _items
151
+ # override the default output from pydantic by calling `to_dict()` of each item in images (list)
152
+ _items = []
153
+ if self.images:
154
+ for _item_images in self.images:
155
+ if _item_images:
156
+ _items.append(_item_images.to_dict())
157
+ _dict['images'] = _items
158
+ # override the default output from pydantic by calling `to_dict()` of each item in videos (list)
159
+ _items = []
160
+ if self.videos:
161
+ for _item_videos in self.videos:
162
+ if _item_videos:
163
+ _items.append(_item_videos.to_dict())
164
+ _dict['videos'] = _items
165
+ # override the default output from pydantic by calling `to_dict()` of policy
166
+ if self.policy:
167
+ _dict['policy'] = self.policy.to_dict()
168
+ # override the default output from pydantic by calling `to_dict()` of each item in third_party_reviews (list)
169
+ _items = []
170
+ if self.third_party_reviews:
171
+ for _item_third_party_reviews in self.third_party_reviews:
172
+ if _item_third_party_reviews:
173
+ _items.append(_item_third_party_reviews.to_dict())
174
+ _dict['thirdPartyReviews'] = _items
175
+ # override the default output from pydantic by calling `to_dict()` of general_manager
176
+ if self.general_manager:
177
+ _dict['generalManager'] = self.general_manager.to_dict()
178
+ # override the default output from pydantic by calling `to_dict()` of address
179
+ if self.address:
180
+ _dict['address'] = self.address.to_dict()
181
+ return _dict
182
+
183
+ @classmethod
184
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
185
+ """Create an instance of PropertyAggregateLightweightAgent from a dict"""
186
+ if obj is None:
187
+ return None
188
+
189
+ if not isinstance(obj, dict):
190
+ return cls.model_validate(obj)
191
+
192
+ _obj = cls.model_validate({
193
+ "hotelIdentifier": obj.get("hotelIdentifier"),
194
+ "name": obj.get("name"),
195
+ "localName": obj.get("localName"),
196
+ "chain": obj.get("chain"),
197
+ "brand": obj.get("brand"),
198
+ "urlName": obj.get("urlName"),
199
+ "uniqueId": obj.get("uniqueId"),
200
+ "starRating": obj.get("starRating"),
201
+ "bookings": obj.get("bookings") if obj.get("bookings") is not None else 0,
202
+ "aggregateReviewRating": obj.get("aggregateReviewRating") if obj.get("aggregateReviewRating") is not None else 0.0,
203
+ "location": GeoJsonPointAgent.from_dict(obj["location"]) if obj.get("location") is not None else None,
204
+ "descriptions": [SimpleDescriptionAgent.from_dict(_item) for _item in obj["descriptions"]] if obj.get("descriptions") is not None else None,
205
+ "aggregateGreendexRating": obj.get("aggregateGreendexRating") if obj.get("aggregateGreendexRating") is not None else 0.0,
206
+ "lifestyleTypes": obj.get("lifestyleTypes"),
207
+ "totalReviews": obj.get("totalReviews") if obj.get("totalReviews") is not None else 0,
208
+ "reservations": ContactAgent.from_dict(obj["reservations"]) if obj.get("reservations") is not None else None,
209
+ "socials": [SocialAgent.from_dict(_item) for _item in obj["socials"]] if obj.get("socials") is not None else None,
210
+ "images": [SimpleMultimediaAgent.from_dict(_item) for _item in obj["images"]] if obj.get("images") is not None else None,
211
+ "videos": [SimpleMultimediaAgent.from_dict(_item) for _item in obj["videos"]] if obj.get("videos") is not None else None,
212
+ "policy": PropertyPolicyAgent.from_dict(obj["policy"]) if obj.get("policy") is not None else None,
213
+ "thirdPartyReviews": [TravelInventoryRecognitionAgent.from_dict(_item) for _item in obj["thirdPartyReviews"]] if obj.get("thirdPartyReviews") is not None else None,
214
+ "attractions": obj.get("attractions") if obj.get("attractions") is not None else 0,
215
+ "activities": obj.get("activities") if obj.get("activities") is not None else 0,
216
+ "places": obj.get("places") if obj.get("places") is not None else 0,
217
+ "restaurants": obj.get("restaurants") if obj.get("restaurants") is not None else 0,
218
+ "meetingRooms": obj.get("meetingRooms") if obj.get("meetingRooms") is not None else 0,
219
+ "spas": obj.get("spas") if obj.get("spas") is not None else 0,
220
+ "addOns": obj.get("addOns") if obj.get("addOns") is not None else 0,
221
+ "generalManager": GeneralManagerAgent.from_dict(obj["generalManager"]) if obj.get("generalManager") is not None else None,
222
+ "locationCategory": obj.get("locationCategory"),
223
+ "segmentCategory": obj.get("segmentCategory"),
224
+ "hotelCategory": obj.get("hotelCategory"),
225
+ "architecturalStyle": obj.get("architecturalStyle"),
226
+ "whenBuilt": obj.get("whenBuilt"),
227
+ "currencyCode": obj.get("currencyCode"),
228
+ "membershipRateDiscount": obj.get("membershipRateDiscount") if obj.get("membershipRateDiscount") is not None else 0,
229
+ "priceScore": obj.get("priceScore") if obj.get("priceScore") is not None else 0,
230
+ "perkScore": obj.get("perkScore") if obj.get("perkScore") is not None else 0,
231
+ "addOnScore": obj.get("addOnScore") if obj.get("addOnScore") is not None else 0,
232
+ "loyaltyScore": obj.get("loyaltyScore") if obj.get("loyaltyScore") is not None else 0,
233
+ "popularScore": obj.get("popularScore") if obj.get("popularScore") is not None else 0,
234
+ "experienceScore": obj.get("experienceScore") if obj.get("experienceScore") is not None else 0,
235
+ "hotelAmenityCodes": obj.get("hotelAmenityCodes"),
236
+ "propertyAccessibilityCodes": obj.get("propertyAccessibilityCodes"),
237
+ "propertySecurityCodes": obj.get("propertySecurityCodes"),
238
+ "numberOfRooms": obj.get("numberOfRooms") if obj.get("numberOfRooms") is not None else 0,
239
+ "address": SimpleAddressAgent.from_dict(obj["address"]) if obj.get("address") is not None else None,
240
+ "active": obj.get("active"),
241
+ "urlParameters": obj.get("urlParameters")
242
+ })
243
+ return _obj
244
+
245
+
@@ -0,0 +1,150 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Wink API
5
+
6
+ # Introduction Welcome to the Wink API - A programmer-friendly way to manage, sell and book travel inventory on the Wink platform. The API gives you all the tools you need to ready your properties and inventory for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel inventory and promote / sell it in a wide variety of ways. # Integrations We have already integrated with the most well-known channel managers so you don't have to. To see our current integrations, please go to https://extranet.wink.travel and scroll to Connectivity section. Once your properties are set up, you can finish the setup by mapping your property to Wink using your channel manager partner portal. If your properties don't have a channel manager, you can easily manage rates and availability with this API. # Intended Audience Programmers are [most likely] a requirement to start integrating with Wink. Companies and organizations that would most benefit from integrating with us are new and existing travel companies that have relationships with suppliers and that need an advanced system from which to manage their travel inventory and get that same inventory out to as many eyeballs as possible at the lowest price possible. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume endpoints are for developers who want to find existing travel inventory and either book it or use it to advertise through one of their Wink affiliate accounts. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [Inventory](/affiliate/inventory): The Inventory API exposes endpoints for affiliates to manage the inventory they want to sell and how they want to sell it. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [Channel manager](/channel-manager): The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties. ### Taxonomy APIs Taxonomy endpoints are for developers who want to consume and produce travel inventory and need taxonomies of standard and non-standard codes for inventory types, classes, statuses etc. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs Payment endpoints are for developers who want to purchase travel inventory. This can be done via the API as a registered Travel Agent or using our API in conjunction with our PCI compliant payment widget for all other entities. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs We are actively working on supporting the most used languages out there. If you don't see your language here, reach out to us with a request to officially add your language. In the meantime, if you want to roll your own SDK, you can do so by downloading the OpenAPI spec and using one of the many available OpenAPI generators available: [https://openapi-generator.tech/docs/generators](https://openapi-generator.tech/docs/generators). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning We chose to version our endpoints in a way that we hope affects your integration minimally. You request the version of our API you wish to work with via the `Wink-Version` header. When it's time for you to upgrade, you only have to change the version number to get access to our updated endpoints. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
7
+
8
+ The version of the OpenAPI document: 30.29.0
9
+ Contact: bjorn@wink.travel
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+
16
+ from __future__ import annotations
17
+ import pprint
18
+ import re # noqa: F401
19
+ import json
20
+
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
22
+ from typing import Any, ClassVar, Dict, List, Optional
23
+ from typing_extensions import Annotated
24
+ from wink_sdk_travel_agent.models.custom_monetary_amount import CustomMonetaryAmount
25
+ from typing import Optional, Set
26
+ from typing_extensions import Self
27
+
28
+ class PropertyPolicyAgent(BaseModel):
29
+ """
30
+ Outlines basic policies for the property.
31
+ """ # noqa: E501
32
+ children_allowed: StrictBool = Field(description="Indicates whether property allows children", alias="childrenAllowed")
33
+ children_minimum_age: Optional[StrictInt] = Field(default=None, description="When a property allows children, it can also indicate what the minimum age is for children to be allowed.", alias="childrenMinimumAge")
34
+ internet_availability: StrictStr = Field(description="Indicates the availability of internet on the property.", alias="internetAvailability")
35
+ internet_connection_type: StrictStr = Field(description="Indicates how guests can access the Internet on the property.", alias="internetConnectionType")
36
+ internet_connection_location: StrictStr = Field(description="Indicates where internet is available in and around the property.", alias="internetConnectionLocation")
37
+ parking_availability: StrictStr = Field(description="Indicates whether parking is available at the property.", alias="parkingAvailability")
38
+ parking_access: StrictStr = Field(description="Indicates what type of parking is available at the property.", alias="parkingAccess")
39
+ pets_allowed: StrictBool = Field(description="Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.", alias="petsAllowed")
40
+ pet_max_weight_in_kilos: Optional[StrictInt] = Field(default=None, description="If pets are allowed, property can further limit on weight.", alias="petMaxWeightInKilos")
41
+ pet_charge: Optional[CustomMonetaryAmount] = Field(default=None, description="If pets are allowed, property can tell travelers if there is a charge applicable for the pet.", alias="petCharge")
42
+ check_out_time: Annotated[str, Field(min_length=1, strict=True)] = Field(description="When the guest has to check out.", alias="checkOutTime")
43
+ check_in_time: Annotated[str, Field(min_length=1, strict=True)] = Field(description="When the guest can check in.", alias="checkInTime")
44
+ __properties: ClassVar[List[str]] = ["childrenAllowed", "childrenMinimumAge", "internetAvailability", "internetConnectionType", "internetConnectionLocation", "parkingAvailability", "parkingAccess", "petsAllowed", "petMaxWeightInKilos", "petCharge", "checkOutTime", "checkInTime"]
45
+
46
+ @field_validator('internet_availability')
47
+ def internet_availability_validate_enum(cls, value):
48
+ """Validates the enum"""
49
+ if value not in set(['YES', 'NO', 'YES_PAID']):
50
+ raise ValueError("must be one of enum values ('YES', 'NO', 'YES_PAID')")
51
+ return value
52
+
53
+ @field_validator('internet_connection_type')
54
+ def internet_connection_type_validate_enum(cls, value):
55
+ """Validates the enum"""
56
+ if value not in set(['WIFI', 'CABLE']):
57
+ raise ValueError("must be one of enum values ('WIFI', 'CABLE')")
58
+ return value
59
+
60
+ @field_validator('internet_connection_location')
61
+ def internet_connection_location_validate_enum(cls, value):
62
+ """Validates the enum"""
63
+ if value not in set(['ENTIRE_PROPERTY', 'PUBLIC_AREAS', 'ALL_ROOMS', 'SOME_ROOMS', 'BUSINESS_CENTER']):
64
+ raise ValueError("must be one of enum values ('ENTIRE_PROPERTY', 'PUBLIC_AREAS', 'ALL_ROOMS', 'SOME_ROOMS', 'BUSINESS_CENTER')")
65
+ return value
66
+
67
+ @field_validator('parking_availability')
68
+ def parking_availability_validate_enum(cls, value):
69
+ """Validates the enum"""
70
+ if value not in set(['YES', 'NO', 'YES_PAID']):
71
+ raise ValueError("must be one of enum values ('YES', 'NO', 'YES_PAID')")
72
+ return value
73
+
74
+ @field_validator('parking_access')
75
+ def parking_access_validate_enum(cls, value):
76
+ """Validates the enum"""
77
+ if value not in set(['PRIVATE', 'PUBLIC']):
78
+ raise ValueError("must be one of enum values ('PRIVATE', 'PUBLIC')")
79
+ return value
80
+
81
+ model_config = ConfigDict(
82
+ populate_by_name=True,
83
+ validate_assignment=True,
84
+ protected_namespaces=(),
85
+ )
86
+
87
+
88
+ def to_str(self) -> str:
89
+ """Returns the string representation of the model using alias"""
90
+ return pprint.pformat(self.model_dump(by_alias=True))
91
+
92
+ def to_json(self) -> str:
93
+ """Returns the JSON representation of the model using alias"""
94
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
95
+ return json.dumps(self.to_dict())
96
+
97
+ @classmethod
98
+ def from_json(cls, json_str: str) -> Optional[Self]:
99
+ """Create an instance of PropertyPolicyAgent from a JSON string"""
100
+ return cls.from_dict(json.loads(json_str))
101
+
102
+ def to_dict(self) -> Dict[str, Any]:
103
+ """Return the dictionary representation of the model using alias.
104
+
105
+ This has the following differences from calling pydantic's
106
+ `self.model_dump(by_alias=True)`:
107
+
108
+ * `None` is only added to the output dict for nullable fields that
109
+ were set at model initialization. Other fields with value `None`
110
+ are ignored.
111
+ """
112
+ excluded_fields: Set[str] = set([
113
+ ])
114
+
115
+ _dict = self.model_dump(
116
+ by_alias=True,
117
+ exclude=excluded_fields,
118
+ exclude_none=True,
119
+ )
120
+ # override the default output from pydantic by calling `to_dict()` of pet_charge
121
+ if self.pet_charge:
122
+ _dict['petCharge'] = self.pet_charge.to_dict()
123
+ return _dict
124
+
125
+ @classmethod
126
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
127
+ """Create an instance of PropertyPolicyAgent from a dict"""
128
+ if obj is None:
129
+ return None
130
+
131
+ if not isinstance(obj, dict):
132
+ return cls.model_validate(obj)
133
+
134
+ _obj = cls.model_validate({
135
+ "childrenAllowed": obj.get("childrenAllowed") if obj.get("childrenAllowed") is not None else False,
136
+ "childrenMinimumAge": obj.get("childrenMinimumAge"),
137
+ "internetAvailability": obj.get("internetAvailability"),
138
+ "internetConnectionType": obj.get("internetConnectionType"),
139
+ "internetConnectionLocation": obj.get("internetConnectionLocation"),
140
+ "parkingAvailability": obj.get("parkingAvailability"),
141
+ "parkingAccess": obj.get("parkingAccess"),
142
+ "petsAllowed": obj.get("petsAllowed") if obj.get("petsAllowed") is not None else False,
143
+ "petMaxWeightInKilos": obj.get("petMaxWeightInKilos"),
144
+ "petCharge": CustomMonetaryAmount.from_dict(obj["petCharge"]) if obj.get("petCharge") is not None else None,
145
+ "checkOutTime": obj.get("checkOutTime"),
146
+ "checkInTime": obj.get("checkInTime")
147
+ })
148
+ return _obj
149
+
150
+