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,139 @@
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 datetime import date
22
+ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
23
+ from typing import Any, ClassVar, Dict, List, Optional
24
+ from typing import Optional, Set
25
+ from typing_extensions import Self
26
+
27
+ class PersonalAgent(BaseModel):
28
+ """
29
+ PersonalAgent
30
+ """ # noqa: E501
31
+ gender: Optional[StrictStr] = Field(default=None, description="Identifier the gender of the customer.")
32
+ birth_date: Optional[date] = Field(default=None, description="Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", alias="birthDate")
33
+ marital_status: Optional[StrictStr] = Field(default=None, description="Marital status of the traveler.", alias="maritalStatus")
34
+ child_quantity: Optional[StrictInt] = Field(default=None, description="The number of children of the customer.", alias="childQuantity")
35
+ citizenship: Optional[StrictStr] = Field(default=None, description="Name of the (self-professed) country that is clamided for citizenship.")
36
+ address1: Optional[StrictStr] = Field(default=None, description="Address line 1")
37
+ address2: Optional[StrictStr] = Field(default=None, description="Address line 2")
38
+ city: Optional[StrictStr] = Field(default=None, description="City")
39
+ state: Optional[StrictStr] = Field(default=None, description="State")
40
+ postal_code: Optional[StrictStr] = Field(default=None, description="Postal code", alias="postalCode")
41
+ country: Optional[StrictStr] = Field(default=None, description="Country")
42
+ preferred_currency: Optional[StrictStr] = Field(default=None, description="Type of funds preferred for reviewing monetary values, in ISO 4217 codes", alias="preferredCurrency")
43
+ language: Optional[StrictStr] = Field(default=None, description="The primary language of the customer")
44
+ contact_person: Optional[List[Any]] = Field(default=None, alias="contactPerson")
45
+ phys_chall_name: Optional[List[Any]] = Field(default=None, alias="physChallName")
46
+ pet_info: Optional[List[Any]] = Field(default=None, alias="petInfo")
47
+ __properties: ClassVar[List[str]] = ["gender", "birthDate", "maritalStatus", "childQuantity", "citizenship", "address1", "address2", "city", "state", "postalCode", "country", "preferredCurrency", "language", "contactPerson", "physChallName", "petInfo"]
48
+
49
+ @field_validator('gender')
50
+ def gender_validate_enum(cls, value):
51
+ """Validates the enum"""
52
+ if value is None:
53
+ return value
54
+
55
+ if value not in set(['MALE', 'FEMALE', 'OTHER']):
56
+ raise ValueError("must be one of enum values ('MALE', 'FEMALE', 'OTHER')")
57
+ return value
58
+
59
+ @field_validator('marital_status')
60
+ def marital_status_validate_enum(cls, value):
61
+ """Validates the enum"""
62
+ if value is None:
63
+ return value
64
+
65
+ if value not in set(['ANNULLED', 'COHABITATING', 'DIVORCED', 'ENGAGED', 'MARRIED', 'SEPARATED', 'SINGLE', 'WIDOWED', 'UNKNOWN']):
66
+ raise ValueError("must be one of enum values ('ANNULLED', 'COHABITATING', 'DIVORCED', 'ENGAGED', 'MARRIED', 'SEPARATED', 'SINGLE', 'WIDOWED', 'UNKNOWN')")
67
+ return value
68
+
69
+ model_config = ConfigDict(
70
+ populate_by_name=True,
71
+ validate_assignment=True,
72
+ protected_namespaces=(),
73
+ )
74
+
75
+
76
+ def to_str(self) -> str:
77
+ """Returns the string representation of the model using alias"""
78
+ return pprint.pformat(self.model_dump(by_alias=True))
79
+
80
+ def to_json(self) -> str:
81
+ """Returns the JSON representation of the model using alias"""
82
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
83
+ return json.dumps(self.to_dict())
84
+
85
+ @classmethod
86
+ def from_json(cls, json_str: str) -> Optional[Self]:
87
+ """Create an instance of PersonalAgent from a JSON string"""
88
+ return cls.from_dict(json.loads(json_str))
89
+
90
+ def to_dict(self) -> Dict[str, Any]:
91
+ """Return the dictionary representation of the model using alias.
92
+
93
+ This has the following differences from calling pydantic's
94
+ `self.model_dump(by_alias=True)`:
95
+
96
+ * `None` is only added to the output dict for nullable fields that
97
+ were set at model initialization. Other fields with value `None`
98
+ are ignored.
99
+ """
100
+ excluded_fields: Set[str] = set([
101
+ ])
102
+
103
+ _dict = self.model_dump(
104
+ by_alias=True,
105
+ exclude=excluded_fields,
106
+ exclude_none=True,
107
+ )
108
+ return _dict
109
+
110
+ @classmethod
111
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
112
+ """Create an instance of PersonalAgent from a dict"""
113
+ if obj is None:
114
+ return None
115
+
116
+ if not isinstance(obj, dict):
117
+ return cls.model_validate(obj)
118
+
119
+ _obj = cls.model_validate({
120
+ "gender": obj.get("gender"),
121
+ "birthDate": obj.get("birthDate"),
122
+ "maritalStatus": obj.get("maritalStatus"),
123
+ "childQuantity": obj.get("childQuantity"),
124
+ "citizenship": obj.get("citizenship"),
125
+ "address1": obj.get("address1"),
126
+ "address2": obj.get("address2"),
127
+ "city": obj.get("city"),
128
+ "state": obj.get("state"),
129
+ "postalCode": obj.get("postalCode"),
130
+ "country": obj.get("country"),
131
+ "preferredCurrency": obj.get("preferredCurrency"),
132
+ "language": obj.get("language"),
133
+ "contactPerson": obj.get("contactPerson"),
134
+ "physChallName": obj.get("physChallName"),
135
+ "petInfo": obj.get("petInfo")
136
+ })
137
+ return _obj
138
+
139
+
@@ -0,0 +1,90 @@
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, StrictStr
22
+ from typing import Any, ClassVar, Dict, List
23
+ from typing import Optional, Set
24
+ from typing_extensions import Self
25
+
26
+ class PetInfoDtoAgent(BaseModel):
27
+ """
28
+ Array of customer's pets
29
+ """ # noqa: E501
30
+ name: StrictStr = Field(description="Pet name")
31
+ type: StrictStr = Field(description="Pet type")
32
+ __properties: ClassVar[List[str]] = ["name", "type"]
33
+
34
+ model_config = ConfigDict(
35
+ populate_by_name=True,
36
+ validate_assignment=True,
37
+ protected_namespaces=(),
38
+ )
39
+
40
+
41
+ def to_str(self) -> str:
42
+ """Returns the string representation of the model using alias"""
43
+ return pprint.pformat(self.model_dump(by_alias=True))
44
+
45
+ def to_json(self) -> str:
46
+ """Returns the JSON representation of the model using alias"""
47
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
48
+ return json.dumps(self.to_dict())
49
+
50
+ @classmethod
51
+ def from_json(cls, json_str: str) -> Optional[Self]:
52
+ """Create an instance of PetInfoDtoAgent from a JSON string"""
53
+ return cls.from_dict(json.loads(json_str))
54
+
55
+ def to_dict(self) -> Dict[str, Any]:
56
+ """Return the dictionary representation of the model using alias.
57
+
58
+ This has the following differences from calling pydantic's
59
+ `self.model_dump(by_alias=True)`:
60
+
61
+ * `None` is only added to the output dict for nullable fields that
62
+ were set at model initialization. Other fields with value `None`
63
+ are ignored.
64
+ """
65
+ excluded_fields: Set[str] = set([
66
+ ])
67
+
68
+ _dict = self.model_dump(
69
+ by_alias=True,
70
+ exclude=excluded_fields,
71
+ exclude_none=True,
72
+ )
73
+ return _dict
74
+
75
+ @classmethod
76
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
77
+ """Create an instance of PetInfoDtoAgent from a dict"""
78
+ if obj is None:
79
+ return None
80
+
81
+ if not isinstance(obj, dict):
82
+ return cls.model_validate(obj)
83
+
84
+ _obj = cls.model_validate({
85
+ "name": obj.get("name"),
86
+ "type": obj.get("type")
87
+ })
88
+ return _obj
89
+
90
+
@@ -0,0 +1,128 @@
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, 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 PreferencesAgent(BaseModel):
27
+ """
28
+ PreferencesAgent
29
+ """ # noqa: E501
30
+ property_location_pref: Optional[StrictStr] = Field(default=None, description="Indicates preference for hotel property locations.", alias="propertyLocationPref")
31
+ property_type_pref: Optional[StrictStr] = Field(default=None, description="Indicates preference for hotel property types.", alias="propertyTypePref")
32
+ hotel_chain_pref: Optional[StrictStr] = Field(default=None, description="Identifies a preferred company by name.", alias="hotelChainPref")
33
+ property_amenity_pref: Optional[List[StrictStr]] = Field(default=None, alias="propertyAmenityPref")
34
+ recreation_srvc_pref: Optional[List[StrictStr]] = Field(default=None, alias="recreationSrvcPref")
35
+ business_srvc_pref: Optional[List[StrictStr]] = Field(default=None, alias="businessSrvcPref")
36
+ security_feature_pref: Optional[List[StrictStr]] = Field(default=None, alias="securityFeaturePref")
37
+ phys_chal_feature_pref: Optional[List[StrictStr]] = Field(default=None, description="Indicates preferences for type of features required to meet the needs of persons with physical challenges, disabilities, etc.", alias="physChalFeaturePref")
38
+ smoking_allowed: Optional[StrictBool] = Field(default=None, description="Indicates preference for smooking allowed rooms..", alias="smokingAllowed")
39
+ room_location_pref: Optional[StrictStr] = Field(default=None, description="Indicates preference for hotel room locations.", alias="roomLocationPref")
40
+ bed_type_pref: Optional[StrictStr] = Field(default=None, description="Indicates preferences for the size and features of hotel bed types.", alias="bedTypePref")
41
+ food_srvc_pref: Optional[StrictStr] = Field(default=None, description="Indicates preferences for type of food listener facilities in a hotel.", alias="foodSrvcPref")
42
+ room_amenity_pref: Optional[List[StrictStr]] = Field(default=None, alias="roomAmenityPref")
43
+ guest_type: Optional[StrictStr] = Field(default=None, description="Guest type", alias="guestType")
44
+ meal_pref: Optional[StrictStr] = Field(default=None, description="Indicates meal preference.", alias="mealPref")
45
+ cuisine_pref: Optional[StrictStr] = Field(default=None, description="Indicates cuisine preference.", alias="cuisinePref")
46
+ interest_pref: Optional[List[StrictStr]] = Field(default=None, alias="interestPref")
47
+ beverage_pref: Optional[List[StrictStr]] = Field(default=None, alias="beveragePref")
48
+ food_pref: Optional[List[StrictStr]] = Field(default=None, alias="foodPref")
49
+ allergies: Optional[List[StrictStr]] = None
50
+ pets_pref: Optional[List[StrictStr]] = Field(default=None, alias="petsPref")
51
+ __properties: ClassVar[List[str]] = ["propertyLocationPref", "propertyTypePref", "hotelChainPref", "propertyAmenityPref", "recreationSrvcPref", "businessSrvcPref", "securityFeaturePref", "physChalFeaturePref", "smokingAllowed", "roomLocationPref", "bedTypePref", "foodSrvcPref", "roomAmenityPref", "guestType", "mealPref", "cuisinePref", "interestPref", "beveragePref", "foodPref", "allergies", "petsPref"]
52
+
53
+ model_config = ConfigDict(
54
+ populate_by_name=True,
55
+ validate_assignment=True,
56
+ protected_namespaces=(),
57
+ )
58
+
59
+
60
+ def to_str(self) -> str:
61
+ """Returns the string representation of the model using alias"""
62
+ return pprint.pformat(self.model_dump(by_alias=True))
63
+
64
+ def to_json(self) -> str:
65
+ """Returns the JSON representation of the model using alias"""
66
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
67
+ return json.dumps(self.to_dict())
68
+
69
+ @classmethod
70
+ def from_json(cls, json_str: str) -> Optional[Self]:
71
+ """Create an instance of PreferencesAgent from a JSON string"""
72
+ return cls.from_dict(json.loads(json_str))
73
+
74
+ def to_dict(self) -> Dict[str, Any]:
75
+ """Return the dictionary representation of the model using alias.
76
+
77
+ This has the following differences from calling pydantic's
78
+ `self.model_dump(by_alias=True)`:
79
+
80
+ * `None` is only added to the output dict for nullable fields that
81
+ were set at model initialization. Other fields with value `None`
82
+ are ignored.
83
+ """
84
+ excluded_fields: Set[str] = set([
85
+ ])
86
+
87
+ _dict = self.model_dump(
88
+ by_alias=True,
89
+ exclude=excluded_fields,
90
+ exclude_none=True,
91
+ )
92
+ return _dict
93
+
94
+ @classmethod
95
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
96
+ """Create an instance of PreferencesAgent from a dict"""
97
+ if obj is None:
98
+ return None
99
+
100
+ if not isinstance(obj, dict):
101
+ return cls.model_validate(obj)
102
+
103
+ _obj = cls.model_validate({
104
+ "propertyLocationPref": obj.get("propertyLocationPref"),
105
+ "propertyTypePref": obj.get("propertyTypePref"),
106
+ "hotelChainPref": obj.get("hotelChainPref"),
107
+ "propertyAmenityPref": obj.get("propertyAmenityPref"),
108
+ "recreationSrvcPref": obj.get("recreationSrvcPref"),
109
+ "businessSrvcPref": obj.get("businessSrvcPref"),
110
+ "securityFeaturePref": obj.get("securityFeaturePref"),
111
+ "physChalFeaturePref": obj.get("physChalFeaturePref"),
112
+ "smokingAllowed": obj.get("smokingAllowed"),
113
+ "roomLocationPref": obj.get("roomLocationPref"),
114
+ "bedTypePref": obj.get("bedTypePref"),
115
+ "foodSrvcPref": obj.get("foodSrvcPref"),
116
+ "roomAmenityPref": obj.get("roomAmenityPref"),
117
+ "guestType": obj.get("guestType"),
118
+ "mealPref": obj.get("mealPref"),
119
+ "cuisinePref": obj.get("cuisinePref"),
120
+ "interestPref": obj.get("interestPref"),
121
+ "beveragePref": obj.get("beveragePref"),
122
+ "foodPref": obj.get("foodPref"),
123
+ "allergies": obj.get("allergies"),
124
+ "petsPref": obj.get("petsPref")
125
+ })
126
+ return _obj
127
+
128
+
@@ -0,0 +1,110 @@
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, StrictStr
22
+ from typing import Any, ClassVar, Dict, List
23
+ from wink_sdk_travel_agent.models.personal_agent import PersonalAgent
24
+ from wink_sdk_travel_agent.models.preferences_agent import PreferencesAgent
25
+ from wink_sdk_travel_agent.models.profile_user_agent import ProfileUserAgent
26
+ from typing import Optional, Set
27
+ from typing_extensions import Self
28
+
29
+ class ProfileAgent(BaseModel):
30
+ """
31
+ Optional profile record
32
+ """ # noqa: E501
33
+ profile_identifier: StrictStr = Field(description="Profile identifier", alias="profileIdentifier")
34
+ user_identifier: StrictStr = Field(description="User identifier", alias="userIdentifier")
35
+ share: StrictBool = Field(description="Indicates whether the user wants to share this profile of themselves with hotel(s)")
36
+ user: ProfileUserAgent
37
+ personal: PersonalAgent
38
+ preferences: PreferencesAgent
39
+ __properties: ClassVar[List[str]] = ["profileIdentifier", "userIdentifier", "share", "user", "personal", "preferences"]
40
+
41
+ model_config = ConfigDict(
42
+ populate_by_name=True,
43
+ validate_assignment=True,
44
+ protected_namespaces=(),
45
+ )
46
+
47
+
48
+ def to_str(self) -> str:
49
+ """Returns the string representation of the model using alias"""
50
+ return pprint.pformat(self.model_dump(by_alias=True))
51
+
52
+ def to_json(self) -> str:
53
+ """Returns the JSON representation of the model using alias"""
54
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
55
+ return json.dumps(self.to_dict())
56
+
57
+ @classmethod
58
+ def from_json(cls, json_str: str) -> Optional[Self]:
59
+ """Create an instance of ProfileAgent from a JSON string"""
60
+ return cls.from_dict(json.loads(json_str))
61
+
62
+ def to_dict(self) -> Dict[str, Any]:
63
+ """Return the dictionary representation of the model using alias.
64
+
65
+ This has the following differences from calling pydantic's
66
+ `self.model_dump(by_alias=True)`:
67
+
68
+ * `None` is only added to the output dict for nullable fields that
69
+ were set at model initialization. Other fields with value `None`
70
+ are ignored.
71
+ """
72
+ excluded_fields: Set[str] = set([
73
+ ])
74
+
75
+ _dict = self.model_dump(
76
+ by_alias=True,
77
+ exclude=excluded_fields,
78
+ exclude_none=True,
79
+ )
80
+ # override the default output from pydantic by calling `to_dict()` of user
81
+ if self.user:
82
+ _dict['user'] = self.user.to_dict()
83
+ # override the default output from pydantic by calling `to_dict()` of personal
84
+ if self.personal:
85
+ _dict['personal'] = self.personal.to_dict()
86
+ # override the default output from pydantic by calling `to_dict()` of preferences
87
+ if self.preferences:
88
+ _dict['preferences'] = self.preferences.to_dict()
89
+ return _dict
90
+
91
+ @classmethod
92
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
93
+ """Create an instance of ProfileAgent from a dict"""
94
+ if obj is None:
95
+ return None
96
+
97
+ if not isinstance(obj, dict):
98
+ return cls.model_validate(obj)
99
+
100
+ _obj = cls.model_validate({
101
+ "profileIdentifier": obj.get("profileIdentifier"),
102
+ "userIdentifier": obj.get("userIdentifier"),
103
+ "share": obj.get("share"),
104
+ "user": ProfileUserAgent.from_dict(obj["user"]) if obj.get("user") is not None else None,
105
+ "personal": PersonalAgent.from_dict(obj["personal"]) if obj.get("personal") is not None else None,
106
+ "preferences": PreferencesAgent.from_dict(obj["preferences"]) if obj.get("preferences") is not None else None
107
+ })
108
+ return _obj
109
+
110
+
@@ -0,0 +1,111 @@
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
22
+ from typing import Any, ClassVar, Dict, List
23
+ from uuid import UUID
24
+ from wink_sdk_travel_agent.models.personal_agent import PersonalAgent
25
+ from wink_sdk_travel_agent.models.preferences_agent import PreferencesAgent
26
+ from wink_sdk_travel_agent.models.profile_user_agent import ProfileUserAgent
27
+ from typing import Optional, Set
28
+ from typing_extensions import Self
29
+
30
+ class ProfileLightweightAgent(BaseModel):
31
+ """
32
+ ProfileLightweightAgent
33
+ """ # noqa: E501
34
+ profile_identifier: UUID = Field(description="Profile identifier", alias="profileIdentifier")
35
+ user_identifier: UUID = Field(description="User identifier", alias="userIdentifier")
36
+ share: StrictBool = Field(description="Indicates whether the user wants to share this profile of themselves with hotel(s)")
37
+ user: ProfileUserAgent = Field(description="User details")
38
+ personal: PersonalAgent = Field(description="Detailed customer information for this profile")
39
+ preferences: PreferencesAgent = Field(description="Customer preferences")
40
+ __properties: ClassVar[List[str]] = ["profileIdentifier", "userIdentifier", "share", "user", "personal", "preferences"]
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 ProfileLightweightAgent 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
+ """
73
+ excluded_fields: Set[str] = set([
74
+ ])
75
+
76
+ _dict = self.model_dump(
77
+ by_alias=True,
78
+ exclude=excluded_fields,
79
+ exclude_none=True,
80
+ )
81
+ # override the default output from pydantic by calling `to_dict()` of user
82
+ if self.user:
83
+ _dict['user'] = self.user.to_dict()
84
+ # override the default output from pydantic by calling `to_dict()` of personal
85
+ if self.personal:
86
+ _dict['personal'] = self.personal.to_dict()
87
+ # override the default output from pydantic by calling `to_dict()` of preferences
88
+ if self.preferences:
89
+ _dict['preferences'] = self.preferences.to_dict()
90
+ return _dict
91
+
92
+ @classmethod
93
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
94
+ """Create an instance of ProfileLightweightAgent from a dict"""
95
+ if obj is None:
96
+ return None
97
+
98
+ if not isinstance(obj, dict):
99
+ return cls.model_validate(obj)
100
+
101
+ _obj = cls.model_validate({
102
+ "profileIdentifier": obj.get("profileIdentifier"),
103
+ "userIdentifier": obj.get("userIdentifier"),
104
+ "share": obj.get("share"),
105
+ "user": ProfileUserAgent.from_dict(obj["user"]) if obj.get("user") is not None else None,
106
+ "personal": PersonalAgent.from_dict(obj["personal"]) if obj.get("personal") is not None else None,
107
+ "preferences": PreferencesAgent.from_dict(obj["preferences"]) if obj.get("preferences") is not None else None
108
+ })
109
+ return _obj
110
+
111
+