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,108 @@
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_extensions import Annotated
24
+ from uuid import UUID
25
+ from wink_sdk_travel_agent.models.profile_lightweight_agent import ProfileLightweightAgent
26
+ from typing import Optional, Set
27
+ from typing_extensions import Self
28
+
29
+ class GuestUserAgent(BaseModel):
30
+ """
31
+ GuestUserAgent
32
+ """ # noqa: E501
33
+ user_identifier: Optional[UUID] = Field(default=None, description="User identifier", alias="userIdentifier")
34
+ first_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="First name", alias="firstName")
35
+ last_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Last name", alias="lastName")
36
+ email: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Email")
37
+ telephone: Optional[StrictStr] = Field(default=None, description="Telephone")
38
+ profile: Optional[ProfileLightweightAgent] = Field(default=None, description="Optional profile record")
39
+ full_name: Optional[StrictStr] = Field(default=None, description="Full name", alias="fullName")
40
+ __properties: ClassVar[List[str]] = ["userIdentifier", "firstName", "lastName", "email", "telephone", "profile", "fullName"]
41
+
42
+ model_config = ConfigDict(
43
+ populate_by_name=True,
44
+ validate_assignment=True,
45
+ protected_namespaces=(),
46
+ )
47
+
48
+
49
+ def to_str(self) -> str:
50
+ """Returns the string representation of the model using alias"""
51
+ return pprint.pformat(self.model_dump(by_alias=True))
52
+
53
+ def to_json(self) -> str:
54
+ """Returns the JSON representation of the model using alias"""
55
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
56
+ return json.dumps(self.to_dict())
57
+
58
+ @classmethod
59
+ def from_json(cls, json_str: str) -> Optional[Self]:
60
+ """Create an instance of GuestUserAgent from a JSON string"""
61
+ return cls.from_dict(json.loads(json_str))
62
+
63
+ def to_dict(self) -> Dict[str, Any]:
64
+ """Return the dictionary representation of the model using alias.
65
+
66
+ This has the following differences from calling pydantic's
67
+ `self.model_dump(by_alias=True)`:
68
+
69
+ * `None` is only added to the output dict for nullable fields that
70
+ were set at model initialization. Other fields with value `None`
71
+ are ignored.
72
+ * OpenAPI `readOnly` fields are excluded.
73
+ """
74
+ excluded_fields: Set[str] = set([
75
+ "full_name",
76
+ ])
77
+
78
+ _dict = self.model_dump(
79
+ by_alias=True,
80
+ exclude=excluded_fields,
81
+ exclude_none=True,
82
+ )
83
+ # override the default output from pydantic by calling `to_dict()` of profile
84
+ if self.profile:
85
+ _dict['profile'] = self.profile.to_dict()
86
+ return _dict
87
+
88
+ @classmethod
89
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
90
+ """Create an instance of GuestUserAgent from a dict"""
91
+ if obj is None:
92
+ return None
93
+
94
+ if not isinstance(obj, dict):
95
+ return cls.model_validate(obj)
96
+
97
+ _obj = cls.model_validate({
98
+ "userIdentifier": obj.get("userIdentifier"),
99
+ "firstName": obj.get("firstName"),
100
+ "lastName": obj.get("lastName"),
101
+ "email": obj.get("email"),
102
+ "telephone": obj.get("telephone"),
103
+ "profile": ProfileLightweightAgent.from_dict(obj["profile"]) if obj.get("profile") is not None else None,
104
+ "fullName": obj.get("fullName")
105
+ })
106
+ return _obj
107
+
108
+
@@ -0,0 +1,270 @@
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](/engine-client): A single endpoint to retrieve whitelabel + customization information for the booking engine. - [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
+
8
+ The version of the OpenAPI document: 30.16.4
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, field_validator
22
+ from typing import Any, ClassVar, Dict, List, Optional, Union
23
+ from typing_extensions import Annotated
24
+ from wink_sdk_travel_agent.models.address_agent import AddressAgent
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.localized_description_agent import LocalizedDescriptionAgent
29
+ from wink_sdk_travel_agent.models.property_policy_agent import PropertyPolicyAgent
30
+ from wink_sdk_travel_agent.models.simple_multimedia_agent import SimpleMultimediaAgent
31
+ from wink_sdk_travel_agent.models.social_agent import SocialAgent
32
+ from wink_sdk_travel_agent.models.travel_inventory_recognition_agent import TravelInventoryRecognitionAgent
33
+ from typing import Optional, Set
34
+ from typing_extensions import Self
35
+
36
+ class HotelOnMapAgent(BaseModel):
37
+ """
38
+ Combined property data.
39
+ """ # noqa: E501
40
+ identifier: Optional[StrictStr] = Field(default=None, description="Unique record identifier. This is NOT the same as the unique hotel record identifier.")
41
+ hotel_identifier: Optional[StrictStr] = 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
+ 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")
48
+ bookings: Optional[StrictInt] = Field(default=0, description="Number of bookings for this property on the wink.travel platform.")
49
+ aggregate_review_rating: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.0, description="Aggregate score based on all current user reviews.", alias="aggregateReviewRating")
50
+ location: Optional[GeoJsonPointAgent] = None
51
+ short_descriptions: Optional[List[LocalizedDescriptionAgent]] = Field(default=None, description="A localized list of short property descriptions", alias="shortDescriptions")
52
+ long_descriptions: Optional[List[LocalizedDescriptionAgent]] = Field(default=None, description="A localized list of longer property descriptions", alias="longDescriptions")
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[StrictStr]] = 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
+ available: Optional[StrictBool] = Field(default=False, description="Flag indicating whether the reactive has made this property available for sale.")
57
+ hotel_available: Optional[StrictBool] = Field(default=False, description="Flag indicating whether the property has made this property available for sale.", alias="hotelAvailable")
58
+ reservations: Optional[ContactAgent] = None
59
+ socials: Optional[List[SocialAgent]] = Field(default=None, description="Property's social network accounts")
60
+ images: Optional[List[SimpleMultimediaAgent]] = Field(default=None, description="Property images.")
61
+ videos: Optional[List[SimpleMultimediaAgent]] = Field(default=None, description="Property videos.")
62
+ policy: Optional[PropertyPolicyAgent] = None
63
+ 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")
64
+ attractions: Optional[StrictInt] = Field(default=0, description="Number of attractions property has listed on its profile.")
65
+ recreations: Optional[StrictInt] = Field(default=0, description="Number of activites property has listed on its profile.")
66
+ pois: Optional[StrictInt] = Field(default=0, description="Number of places property has listed on its profile.")
67
+ restaurants: Optional[StrictInt] = Field(default=0, description="Number of restaurants property has on its profile.")
68
+ meeting_rooms: Optional[StrictInt] = Field(default=0, description="Number of meeting rooms property has on its profile.", alias="meetingRooms")
69
+ spas: Optional[StrictInt] = Field(default=0, description="Number of spas property has on its profile.")
70
+ add_ons: Optional[StrictInt] = Field(default=0, description="Number of add-ons property has on its profile.", alias="addOns")
71
+ general_manager: Optional[GeneralManagerAgent] = Field(default=None, alias="generalManager")
72
+ location_category: Optional[StrictStr] = Field(default=None, description="Supported OTA specification `LOC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="locationCategory")
73
+ segment_category: Optional[StrictStr] = Field(default=None, description="Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="segmentCategory")
74
+ hotel_category: Optional[StrictStr] = Field(default=None, description="Supported OTA specification `PCT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="hotelCategory")
75
+ architectural_style: Optional[StrictStr] = Field(default=None, description="Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="architecturalStyle")
76
+ when_built: Optional[StrictStr] = Field(default=None, description="Year the property was constructed.", alias="whenBuilt")
77
+ currency_code: Optional[StrictStr] = Field(default=None, description="Currency code for property.", alias="currencyCode")
78
+ 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")
79
+ 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")
80
+ 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")
81
+ package_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="packageScore")
82
+ 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")
83
+ 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")
84
+ 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")
85
+ availability_score: Optional[StrictInt] = Field(default=0, description="A property's availability score is based on general availability of all room types. If most room types are always unavailable, the attractiveness of this property goes down. We use this as our primary benchmark to decide how and when to feature properties. There is no max score; it's there to compare it against other properties.", alias="availabilityScore")
86
+ hotel_amenity_codes: Optional[List[StrictStr]] = Field(default=None, description="Supported OTA specification `HAC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="hotelAmenityCodes")
87
+ property_accessibility_codes: Optional[List[StrictStr]] = Field(default=None, description="Supported OTA specification `PHY` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="propertyAccessibilityCodes")
88
+ property_security_codes: Optional[List[StrictStr]] = Field(default=None, description="Supported OTA specification `SEC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", alias="propertySecurityCodes")
89
+ number_of_rooms: Optional[StrictInt] = Field(default=0, description="Number of rooms / keys for this property.", alias="numberOfRooms")
90
+ address: Optional[AddressAgent] = None
91
+ active: Optional[StrictBool] = Field(default=None, description="A property is considered active when both available and hotelAvailable flags are true.")
92
+ url_parameters: Optional[StrictStr] = Field(default=None, description="Convenience data point that creates url friendly query parameters of property.", alias="urlParameters")
93
+ __properties: ClassVar[List[str]] = ["identifier", "hotelIdentifier", "name", "localName", "chain", "brand", "urlName", "starRating", "bookings", "aggregateReviewRating", "location", "shortDescriptions", "longDescriptions", "aggregateGreendexRating", "lifestyleTypes", "totalReviews", "available", "hotelAvailable", "reservations", "socials", "images", "videos", "policy", "thirdPartyReviews", "attractions", "recreations", "pois", "restaurants", "meetingRooms", "spas", "addOns", "generalManager", "locationCategory", "segmentCategory", "hotelCategory", "architecturalStyle", "whenBuilt", "currencyCode", "membershipRateDiscount", "priceScore", "perkScore", "packageScore", "loyaltyScore", "popularScore", "experienceScore", "availabilityScore", "hotelAmenityCodes", "propertyAccessibilityCodes", "propertySecurityCodes", "numberOfRooms", "address", "active", "urlParameters"]
94
+
95
+ @field_validator('lifestyle_types')
96
+ def lifestyle_types_validate_enum(cls, value):
97
+ """Validates the enum"""
98
+ if value is None:
99
+ return value
100
+
101
+ for i in value:
102
+ if i not in set(['LIFESTYLE_HEALTH_FITNESS', 'LIFESTYLE_RELAX', 'LIFESTYLE_ADULT_ONLY', 'LIFESTYLE_ADVENTURE', 'LIFESTYLE_BUSINESS', 'LIFESTYLE_LGBT', 'LIFESTYLE_SINGLE_PARENT', 'LIFESTYLE_SOLO_FEMALE', 'LIFESTYLE_BEAUTY', 'LIFESTYLE_FOODIE', 'LIFESTYLE_FAMILY', 'LIFESTYLE_ROMANCE', 'LIFESTYLE_COUPLE', 'LIFESTYLE_SOLO', 'LIFESTYLE_BACKPACKER', 'LIFESTYLE_SHOPPING', 'LIFESTYLE_SPORTS', 'LIFESTYLE_MOUNTAIN', 'LIFESTYLE_BEACH', 'LIFESTYLE_CITY', 'LIFESTYLE_COUNTRY', 'LIFESTYLE_CULTURE', 'LIFESTYLE_ECO']):
103
+ raise ValueError("each list item must be one of ('LIFESTYLE_HEALTH_FITNESS', 'LIFESTYLE_RELAX', 'LIFESTYLE_ADULT_ONLY', 'LIFESTYLE_ADVENTURE', 'LIFESTYLE_BUSINESS', 'LIFESTYLE_LGBT', 'LIFESTYLE_SINGLE_PARENT', 'LIFESTYLE_SOLO_FEMALE', 'LIFESTYLE_BEAUTY', 'LIFESTYLE_FOODIE', 'LIFESTYLE_FAMILY', 'LIFESTYLE_ROMANCE', 'LIFESTYLE_COUPLE', 'LIFESTYLE_SOLO', 'LIFESTYLE_BACKPACKER', 'LIFESTYLE_SHOPPING', 'LIFESTYLE_SPORTS', 'LIFESTYLE_MOUNTAIN', 'LIFESTYLE_BEACH', 'LIFESTYLE_CITY', 'LIFESTYLE_COUNTRY', 'LIFESTYLE_CULTURE', 'LIFESTYLE_ECO')")
104
+ return value
105
+
106
+ model_config = ConfigDict(
107
+ populate_by_name=True,
108
+ validate_assignment=True,
109
+ protected_namespaces=(),
110
+ )
111
+
112
+
113
+ def to_str(self) -> str:
114
+ """Returns the string representation of the model using alias"""
115
+ return pprint.pformat(self.model_dump(by_alias=True))
116
+
117
+ def to_json(self) -> str:
118
+ """Returns the JSON representation of the model using alias"""
119
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
120
+ return json.dumps(self.to_dict())
121
+
122
+ @classmethod
123
+ def from_json(cls, json_str: str) -> Optional[Self]:
124
+ """Create an instance of HotelOnMapAgent from a JSON string"""
125
+ return cls.from_dict(json.loads(json_str))
126
+
127
+ def to_dict(self) -> Dict[str, Any]:
128
+ """Return the dictionary representation of the model using alias.
129
+
130
+ This has the following differences from calling pydantic's
131
+ `self.model_dump(by_alias=True)`:
132
+
133
+ * `None` is only added to the output dict for nullable fields that
134
+ were set at model initialization. Other fields with value `None`
135
+ are ignored.
136
+ """
137
+ excluded_fields: Set[str] = set([
138
+ ])
139
+
140
+ _dict = self.model_dump(
141
+ by_alias=True,
142
+ exclude=excluded_fields,
143
+ exclude_none=True,
144
+ )
145
+ # override the default output from pydantic by calling `to_dict()` of location
146
+ if self.location:
147
+ _dict['location'] = self.location.to_dict()
148
+ # override the default output from pydantic by calling `to_dict()` of each item in short_descriptions (list)
149
+ _items = []
150
+ if self.short_descriptions:
151
+ for _item_short_descriptions in self.short_descriptions:
152
+ if _item_short_descriptions:
153
+ _items.append(_item_short_descriptions.to_dict())
154
+ _dict['shortDescriptions'] = _items
155
+ # override the default output from pydantic by calling `to_dict()` of each item in long_descriptions (list)
156
+ _items = []
157
+ if self.long_descriptions:
158
+ for _item_long_descriptions in self.long_descriptions:
159
+ if _item_long_descriptions:
160
+ _items.append(_item_long_descriptions.to_dict())
161
+ _dict['longDescriptions'] = _items
162
+ # override the default output from pydantic by calling `to_dict()` of reservations
163
+ if self.reservations:
164
+ _dict['reservations'] = self.reservations.to_dict()
165
+ # override the default output from pydantic by calling `to_dict()` of each item in socials (list)
166
+ _items = []
167
+ if self.socials:
168
+ for _item_socials in self.socials:
169
+ if _item_socials:
170
+ _items.append(_item_socials.to_dict())
171
+ _dict['socials'] = _items
172
+ # override the default output from pydantic by calling `to_dict()` of each item in images (list)
173
+ _items = []
174
+ if self.images:
175
+ for _item_images in self.images:
176
+ if _item_images:
177
+ _items.append(_item_images.to_dict())
178
+ _dict['images'] = _items
179
+ # override the default output from pydantic by calling `to_dict()` of each item in videos (list)
180
+ _items = []
181
+ if self.videos:
182
+ for _item_videos in self.videos:
183
+ if _item_videos:
184
+ _items.append(_item_videos.to_dict())
185
+ _dict['videos'] = _items
186
+ # override the default output from pydantic by calling `to_dict()` of policy
187
+ if self.policy:
188
+ _dict['policy'] = self.policy.to_dict()
189
+ # override the default output from pydantic by calling `to_dict()` of each item in third_party_reviews (list)
190
+ _items = []
191
+ if self.third_party_reviews:
192
+ for _item_third_party_reviews in self.third_party_reviews:
193
+ if _item_third_party_reviews:
194
+ _items.append(_item_third_party_reviews.to_dict())
195
+ _dict['thirdPartyReviews'] = _items
196
+ # override the default output from pydantic by calling `to_dict()` of general_manager
197
+ if self.general_manager:
198
+ _dict['generalManager'] = self.general_manager.to_dict()
199
+ # override the default output from pydantic by calling `to_dict()` of address
200
+ if self.address:
201
+ _dict['address'] = self.address.to_dict()
202
+ return _dict
203
+
204
+ @classmethod
205
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
206
+ """Create an instance of HotelOnMapAgent from a dict"""
207
+ if obj is None:
208
+ return None
209
+
210
+ if not isinstance(obj, dict):
211
+ return cls.model_validate(obj)
212
+
213
+ _obj = cls.model_validate({
214
+ "identifier": obj.get("identifier"),
215
+ "hotelIdentifier": obj.get("hotelIdentifier"),
216
+ "name": obj.get("name"),
217
+ "localName": obj.get("localName"),
218
+ "chain": obj.get("chain"),
219
+ "brand": obj.get("brand"),
220
+ "urlName": obj.get("urlName"),
221
+ "starRating": obj.get("starRating"),
222
+ "bookings": obj.get("bookings") if obj.get("bookings") is not None else 0,
223
+ "aggregateReviewRating": obj.get("aggregateReviewRating") if obj.get("aggregateReviewRating") is not None else 0.0,
224
+ "location": GeoJsonPointAgent.from_dict(obj["location"]) if obj.get("location") is not None else None,
225
+ "shortDescriptions": [LocalizedDescriptionAgent.from_dict(_item) for _item in obj["shortDescriptions"]] if obj.get("shortDescriptions") is not None else None,
226
+ "longDescriptions": [LocalizedDescriptionAgent.from_dict(_item) for _item in obj["longDescriptions"]] if obj.get("longDescriptions") is not None else None,
227
+ "aggregateGreendexRating": obj.get("aggregateGreendexRating") if obj.get("aggregateGreendexRating") is not None else 0.0,
228
+ "lifestyleTypes": obj.get("lifestyleTypes"),
229
+ "totalReviews": obj.get("totalReviews") if obj.get("totalReviews") is not None else 0,
230
+ "available": obj.get("available") if obj.get("available") is not None else False,
231
+ "hotelAvailable": obj.get("hotelAvailable") if obj.get("hotelAvailable") is not None else False,
232
+ "reservations": ContactAgent.from_dict(obj["reservations"]) if obj.get("reservations") is not None else None,
233
+ "socials": [SocialAgent.from_dict(_item) for _item in obj["socials"]] if obj.get("socials") is not None else None,
234
+ "images": [SimpleMultimediaAgent.from_dict(_item) for _item in obj["images"]] if obj.get("images") is not None else None,
235
+ "videos": [SimpleMultimediaAgent.from_dict(_item) for _item in obj["videos"]] if obj.get("videos") is not None else None,
236
+ "policy": PropertyPolicyAgent.from_dict(obj["policy"]) if obj.get("policy") is not None else None,
237
+ "thirdPartyReviews": [TravelInventoryRecognitionAgent.from_dict(_item) for _item in obj["thirdPartyReviews"]] if obj.get("thirdPartyReviews") is not None else None,
238
+ "attractions": obj.get("attractions") if obj.get("attractions") is not None else 0,
239
+ "recreations": obj.get("recreations") if obj.get("recreations") is not None else 0,
240
+ "pois": obj.get("pois") if obj.get("pois") is not None else 0,
241
+ "restaurants": obj.get("restaurants") if obj.get("restaurants") is not None else 0,
242
+ "meetingRooms": obj.get("meetingRooms") if obj.get("meetingRooms") is not None else 0,
243
+ "spas": obj.get("spas") if obj.get("spas") is not None else 0,
244
+ "addOns": obj.get("addOns") if obj.get("addOns") is not None else 0,
245
+ "generalManager": GeneralManagerAgent.from_dict(obj["generalManager"]) if obj.get("generalManager") is not None else None,
246
+ "locationCategory": obj.get("locationCategory"),
247
+ "segmentCategory": obj.get("segmentCategory"),
248
+ "hotelCategory": obj.get("hotelCategory"),
249
+ "architecturalStyle": obj.get("architecturalStyle"),
250
+ "whenBuilt": obj.get("whenBuilt"),
251
+ "currencyCode": obj.get("currencyCode"),
252
+ "membershipRateDiscount": obj.get("membershipRateDiscount") if obj.get("membershipRateDiscount") is not None else 0,
253
+ "priceScore": obj.get("priceScore") if obj.get("priceScore") is not None else 0,
254
+ "perkScore": obj.get("perkScore") if obj.get("perkScore") is not None else 0,
255
+ "packageScore": obj.get("packageScore") if obj.get("packageScore") is not None else 0,
256
+ "loyaltyScore": obj.get("loyaltyScore") if obj.get("loyaltyScore") is not None else 0,
257
+ "popularScore": obj.get("popularScore") if obj.get("popularScore") is not None else 0,
258
+ "experienceScore": obj.get("experienceScore") if obj.get("experienceScore") is not None else 0,
259
+ "availabilityScore": obj.get("availabilityScore") if obj.get("availabilityScore") is not None else 0,
260
+ "hotelAmenityCodes": obj.get("hotelAmenityCodes"),
261
+ "propertyAccessibilityCodes": obj.get("propertyAccessibilityCodes"),
262
+ "propertySecurityCodes": obj.get("propertySecurityCodes"),
263
+ "numberOfRooms": obj.get("numberOfRooms") if obj.get("numberOfRooms") is not None else 0,
264
+ "address": AddressAgent.from_dict(obj["address"]) if obj.get("address") is not None else None,
265
+ "active": obj.get("active"),
266
+ "urlParameters": obj.get("urlParameters")
267
+ })
268
+ return _obj
269
+
270
+
@@ -0,0 +1,91 @@
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](/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
+
8
+ The version of the OpenAPI document: 30.17.14
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_extensions import Annotated
24
+ from typing import Optional, Set
25
+ from typing_extensions import Self
26
+
27
+ class ImageAttributionAgent(BaseModel):
28
+ """
29
+ ImageAttributionAgent
30
+ """ # noqa: E501
31
+ url: Optional[StrictStr] = Field(default=None, description="URL to contributor")
32
+ name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Name of contributor")
33
+ __properties: ClassVar[List[str]] = ["url", "name"]
34
+
35
+ model_config = ConfigDict(
36
+ populate_by_name=True,
37
+ validate_assignment=True,
38
+ protected_namespaces=(),
39
+ )
40
+
41
+
42
+ def to_str(self) -> str:
43
+ """Returns the string representation of the model using alias"""
44
+ return pprint.pformat(self.model_dump(by_alias=True))
45
+
46
+ def to_json(self) -> str:
47
+ """Returns the JSON representation of the model using alias"""
48
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
49
+ return json.dumps(self.to_dict())
50
+
51
+ @classmethod
52
+ def from_json(cls, json_str: str) -> Optional[Self]:
53
+ """Create an instance of ImageAttributionAgent from a JSON string"""
54
+ return cls.from_dict(json.loads(json_str))
55
+
56
+ def to_dict(self) -> Dict[str, Any]:
57
+ """Return the dictionary representation of the model using alias.
58
+
59
+ This has the following differences from calling pydantic's
60
+ `self.model_dump(by_alias=True)`:
61
+
62
+ * `None` is only added to the output dict for nullable fields that
63
+ were set at model initialization. Other fields with value `None`
64
+ are ignored.
65
+ """
66
+ excluded_fields: Set[str] = set([
67
+ ])
68
+
69
+ _dict = self.model_dump(
70
+ by_alias=True,
71
+ exclude=excluded_fields,
72
+ exclude_none=True,
73
+ )
74
+ return _dict
75
+
76
+ @classmethod
77
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
78
+ """Create an instance of ImageAttributionAgent from a dict"""
79
+ if obj is None:
80
+ return None
81
+
82
+ if not isinstance(obj, dict):
83
+ return cls.model_validate(obj)
84
+
85
+ _obj = cls.model_validate({
86
+ "url": obj.get("url"),
87
+ "name": obj.get("name")
88
+ })
89
+ return _obj
90
+
91
+