wink-sdk-travel-agent 0.0.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of wink-sdk-travel-agent might be problematic. Click here for more details.

Files changed (110) hide show
  1. wink_sdk_travel_agent/__init__.py +129 -0
  2. wink_sdk_travel_agent/api/__init__.py +5 -0
  3. wink_sdk_travel_agent/api/travel_agent_api.py +1985 -0
  4. wink_sdk_travel_agent/api_client.py +798 -0
  5. wink_sdk_travel_agent/api_response.py +21 -0
  6. wink_sdk_travel_agent/configuration.py +459 -0
  7. wink_sdk_travel_agent/exceptions.py +200 -0
  8. wink_sdk_travel_agent/models/__init__.py +112 -0
  9. wink_sdk_travel_agent/models/address_agent.py +110 -0
  10. wink_sdk_travel_agent/models/agent_booking_request_agent.py +145 -0
  11. wink_sdk_travel_agent/models/aggregate_descriptor_agent.py +100 -0
  12. wink_sdk_travel_agent/models/ancillary_request_agent.py +111 -0
  13. wink_sdk_travel_agent/models/authenticated_user_agent.py +98 -0
  14. wink_sdk_travel_agent/models/bed_agent.py +91 -0
  15. wink_sdk_travel_agent/models/bedroom_agent.py +105 -0
  16. wink_sdk_travel_agent/models/bedroom_configuration_agent.py +100 -0
  17. wink_sdk_travel_agent/models/beneficiary_agent.py +162 -0
  18. wink_sdk_travel_agent/models/beneficiary_charge_agent.py +97 -0
  19. wink_sdk_travel_agent/models/booking_agent.py +378 -0
  20. wink_sdk_travel_agent/models/booking_ancillary_agent.py +153 -0
  21. wink_sdk_travel_agent/models/booking_confirmations_agent.py +109 -0
  22. wink_sdk_travel_agent/models/booking_contract_agent.py +592 -0
  23. wink_sdk_travel_agent/models/booking_contract_item_agent.py +214 -0
  24. wink_sdk_travel_agent/models/booking_contract_payment_details_agent.py +131 -0
  25. wink_sdk_travel_agent/models/booking_itinerary_agent.py +113 -0
  26. wink_sdk_travel_agent/models/booking_itinerary_room_configuration_agent.py +98 -0
  27. wink_sdk_travel_agent/models/booking_itinerary_room_configuration_child_agent.py +90 -0
  28. wink_sdk_travel_agent/models/booking_user_agent.py +100 -0
  29. wink_sdk_travel_agent/models/booking_user_request_agent.py +96 -0
  30. wink_sdk_travel_agent/models/booking_user_session_agent.py +112 -0
  31. wink_sdk_travel_agent/models/booking_view_agent.py +101 -0
  32. wink_sdk_travel_agent/models/boolean_response_agent.py +90 -0
  33. wink_sdk_travel_agent/models/cancellation_detail_agent.py +97 -0
  34. wink_sdk_travel_agent/models/cancellation_policy_agent.py +166 -0
  35. wink_sdk_travel_agent/models/cancellation_policy_exception_agent.py +99 -0
  36. wink_sdk_travel_agent/models/cancellation_policy_exceptions_agent.py +96 -0
  37. wink_sdk_travel_agent/models/child_agent.py +91 -0
  38. wink_sdk_travel_agent/models/commissionable_entry_agent.py +101 -0
  39. wink_sdk_travel_agent/models/company_agent.py +160 -0
  40. wink_sdk_travel_agent/models/company_user_agent.py +114 -0
  41. wink_sdk_travel_agent/models/company_view_agent.py +101 -0
  42. wink_sdk_travel_agent/models/composite_filter_descriptor_agent.py +108 -0
  43. wink_sdk_travel_agent/models/contact_agent.py +104 -0
  44. wink_sdk_travel_agent/models/country_agent.py +100 -0
  45. wink_sdk_travel_agent/models/create_agent_booking400_response.py +141 -0
  46. wink_sdk_travel_agent/models/create_agent_booking_request_agent.py +104 -0
  47. wink_sdk_travel_agent/models/custom_monetary_amount.py +90 -0
  48. wink_sdk_travel_agent/models/daily_rate_agent.py +115 -0
  49. wink_sdk_travel_agent/models/dow_pattern_group_agent.py +102 -0
  50. wink_sdk_travel_agent/models/engine_configuration_booking_report_agent.py +192 -0
  51. wink_sdk_travel_agent/models/engine_configuration_theme_agent.py +108 -0
  52. wink_sdk_travel_agent/models/extra_charge_agent.py +103 -0
  53. wink_sdk_travel_agent/models/extra_charges_agent.py +112 -0
  54. wink_sdk_travel_agent/models/fee_agent.py +105 -0
  55. wink_sdk_travel_agent/models/filter_descriptor_agent.py +101 -0
  56. wink_sdk_travel_agent/models/general_manager_agent.py +104 -0
  57. wink_sdk_travel_agent/models/generic_error_message.py +96 -0
  58. wink_sdk_travel_agent/models/geo_json_point_agent.py +94 -0
  59. wink_sdk_travel_agent/models/geo_name_agent.py +136 -0
  60. wink_sdk_travel_agent/models/group_descriptor_agent.py +110 -0
  61. wink_sdk_travel_agent/models/guest_room_agent.py +258 -0
  62. wink_sdk_travel_agent/models/guest_user_agent.py +106 -0
  63. wink_sdk_travel_agent/models/hotel_on_map_agent.py +272 -0
  64. wink_sdk_travel_agent/models/image_attribution_agent.py +90 -0
  65. wink_sdk_travel_agent/models/localized_description_agent.py +91 -0
  66. wink_sdk_travel_agent/models/localized_price_agent.py +162 -0
  67. wink_sdk_travel_agent/models/page_booking_view_agent.py +128 -0
  68. wink_sdk_travel_agent/models/pageable_object_agent.py +106 -0
  69. wink_sdk_travel_agent/models/payout_agent.py +152 -0
  70. wink_sdk_travel_agent/models/payout_fee_agent.py +114 -0
  71. wink_sdk_travel_agent/models/pending_refund_agent.py +99 -0
  72. wink_sdk_travel_agent/models/personal_agent.py +155 -0
  73. wink_sdk_travel_agent/models/pet_info_dto_agent.py +90 -0
  74. wink_sdk_travel_agent/models/preferences_agent.py +128 -0
  75. wink_sdk_travel_agent/models/profile_agent.py +110 -0
  76. wink_sdk_travel_agent/models/profile_user_agent.py +100 -0
  77. wink_sdk_travel_agent/models/property_policy_agent.py +149 -0
  78. wink_sdk_travel_agent/models/quote_agent.py +94 -0
  79. wink_sdk_travel_agent/models/rate_plan_agent.py +172 -0
  80. wink_sdk_travel_agent/models/rate_plan_level_fee_agent.py +111 -0
  81. wink_sdk_travel_agent/models/refund_agent.py +166 -0
  82. wink_sdk_travel_agent/models/reporting_ancillary_agent.py +108 -0
  83. wink_sdk_travel_agent/models/reporting_daily_rate_agent.py +99 -0
  84. wink_sdk_travel_agent/models/reporting_extra_charge_agent.py +98 -0
  85. wink_sdk_travel_agent/models/review_agent.py +133 -0
  86. wink_sdk_travel_agent/models/review_answer_agent.py +101 -0
  87. wink_sdk_travel_agent/models/review_user_agent.py +98 -0
  88. wink_sdk_travel_agent/models/room_configuration_agent.py +99 -0
  89. wink_sdk_travel_agent/models/room_stay_agent.py +184 -0
  90. wink_sdk_travel_agent/models/simple_date_time_itinerary_agent.py +108 -0
  91. wink_sdk_travel_agent/models/simple_description_agent.py +93 -0
  92. wink_sdk_travel_agent/models/simple_multimedia_agent.py +154 -0
  93. wink_sdk_travel_agent/models/social_agent.py +102 -0
  94. wink_sdk_travel_agent/models/sort_descriptor_agent.py +100 -0
  95. wink_sdk_travel_agent/models/sort_object.py +96 -0
  96. wink_sdk_travel_agent/models/state_agent.py +117 -0
  97. wink_sdk_travel_agent/models/stay_rate_agent.py +209 -0
  98. wink_sdk_travel_agent/models/sub_country_agent.py +92 -0
  99. wink_sdk_travel_agent/models/sub_sub_country_agent.py +92 -0
  100. wink_sdk_travel_agent/models/supplier_contract_item_policy_agent.py +170 -0
  101. wink_sdk_travel_agent/models/travel_agent_agent.py +90 -0
  102. wink_sdk_travel_agent/models/travel_inventory_recognition_agent.py +120 -0
  103. wink_sdk_travel_agent/models/upsert_travel_agent_request_agent.py +90 -0
  104. wink_sdk_travel_agent/py.typed +0 -0
  105. wink_sdk_travel_agent/rest.py +258 -0
  106. wink_sdk_travel_agent-0.0.3.dist-info/LICENSE +201 -0
  107. wink_sdk_travel_agent-0.0.3.dist-info/METADATA +17 -0
  108. wink_sdk_travel_agent-0.0.3.dist-info/RECORD +110 -0
  109. wink_sdk_travel_agent-0.0.3.dist-info/WHEEL +5 -0
  110. wink_sdk_travel_agent-0.0.3.dist-info/top_level.txt +1 -0
@@ -0,0 +1,162 @@
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 blocking on the Wink platform. The API gives you all the tools you need to ready your properties and blocking for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel blocking 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 blocking and get that same blocking 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 blocking 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 blocking by region, locale and property flags. - [Inventory](/blocking): All APIs related to retrieve known travel blocking 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 blocking. #### 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 blocking 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 blocking to sell. - [Inventory](/affiliate/blocking): The Inventory API exposes endpoints for affiliates to manage the blocking 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 blocking and need taxonomies of standard and non-standard codes for blocking 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 blocking. 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.7.10
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
22
+ from typing import Any, ClassVar, Dict, List, Optional, Union
23
+ from wink_sdk_travel_agent.models.custom_monetary_amount import CustomMonetaryAmount
24
+ from wink_sdk_travel_agent.models.quote_agent import QuoteAgent
25
+ from typing import Optional, Set
26
+ from typing_extensions import Self
27
+
28
+ class LocalizedPriceAgent(BaseModel):
29
+ """
30
+ Pricing information for this ancillary.
31
+ """ # noqa: E501
32
+ source_to_user_currency_quote: QuoteAgent = Field(alias="sourceToUserCurrencyQuote")
33
+ source_to_internal_currency_quote: QuoteAgent = Field(alias="sourceToInternalCurrencyQuote")
34
+ user_specified_currency_base_total: CustomMonetaryAmount = Field(alias="userSpecifiedCurrencyBaseTotal")
35
+ source_base_total: CustomMonetaryAmount = Field(alias="sourceBaseTotal")
36
+ internal_base_total: CustomMonetaryAmount = Field(alias="internalBaseTotal")
37
+ user_specified_currency_promotional_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Promotional modifiers in user specified currency", alias="userSpecifiedCurrencyPromotionalModifier")
38
+ source_promotional_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Promotional modifiers in hotel currency", alias="sourcePromotionalModifier")
39
+ internal_promotional_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Promotional modifiers in wink currency", alias="internalPromotionalModifier")
40
+ user_specified_currency_premium_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Premium modifiers in user specified currency", alias="userSpecifiedCurrencyPremiumModifier")
41
+ source_premium_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Premium modifiers in hotel currency", alias="sourcePremiumModifier")
42
+ internal_premium_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Premium modifiers in wink currency", alias="internalPremiumModifier")
43
+ user_specified_currency_channel_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Channel / Membership modifier in user specified currency", alias="userSpecifiedCurrencyChannelModifier")
44
+ source_channel_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Channel / Membership modifier in hotel currency", alias="sourceChannelModifier")
45
+ internal_channel_modifier: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Channel / Membership modifier in wink currency", alias="internalChannelModifier")
46
+ quantity: Optional[StrictInt] = Field(default=1, description="How many of this item is included in this price")
47
+ promotional_discount_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Promotional discount percent", alias="promotionalDiscountPercent")
48
+ channel_discount_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Channel discount percent", alias="channelDiscountPercent")
49
+ premium_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Premium percent", alias="premiumPercent")
50
+ has_channel_discount: Optional[StrictBool] = Field(default=None, alias="hasChannelDiscount")
51
+ total_discount_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="totalDiscountPercent")
52
+ user_specified_currency_total: Optional[CustomMonetaryAmount] = Field(default=None, alias="userSpecifiedCurrencyTotal")
53
+ internal_total: Optional[CustomMonetaryAmount] = Field(default=None, alias="internalTotal")
54
+ source_total: Optional[CustomMonetaryAmount] = Field(default=None, alias="sourceTotal")
55
+ has_premium: Optional[StrictBool] = Field(default=None, alias="hasPremium")
56
+ has_promotion: Optional[StrictBool] = Field(default=None, alias="hasPromotion")
57
+ __properties: ClassVar[List[str]] = ["sourceToUserCurrencyQuote", "sourceToInternalCurrencyQuote", "userSpecifiedCurrencyBaseTotal", "sourceBaseTotal", "internalBaseTotal", "userSpecifiedCurrencyPromotionalModifier", "sourcePromotionalModifier", "internalPromotionalModifier", "userSpecifiedCurrencyPremiumModifier", "sourcePremiumModifier", "internalPremiumModifier", "userSpecifiedCurrencyChannelModifier", "sourceChannelModifier", "internalChannelModifier", "quantity", "promotionalDiscountPercent", "channelDiscountPercent", "premiumPercent", "hasChannelDiscount", "totalDiscountPercent", "userSpecifiedCurrencyTotal", "internalTotal", "sourceTotal", "hasPremium", "hasPromotion"]
58
+
59
+ model_config = ConfigDict(
60
+ populate_by_name=True,
61
+ validate_assignment=True,
62
+ protected_namespaces=(),
63
+ )
64
+
65
+
66
+ def to_str(self) -> str:
67
+ """Returns the string representation of the model using alias"""
68
+ return pprint.pformat(self.model_dump(by_alias=True))
69
+
70
+ def to_json(self) -> str:
71
+ """Returns the JSON representation of the model using alias"""
72
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
73
+ return json.dumps(self.to_dict())
74
+
75
+ @classmethod
76
+ def from_json(cls, json_str: str) -> Optional[Self]:
77
+ """Create an instance of LocalizedPriceAgent from a JSON string"""
78
+ return cls.from_dict(json.loads(json_str))
79
+
80
+ def to_dict(self) -> Dict[str, Any]:
81
+ """Return the dictionary representation of the model using alias.
82
+
83
+ This has the following differences from calling pydantic's
84
+ `self.model_dump(by_alias=True)`:
85
+
86
+ * `None` is only added to the output dict for nullable fields that
87
+ were set at model initialization. Other fields with value `None`
88
+ are ignored.
89
+ """
90
+ excluded_fields: Set[str] = set([
91
+ ])
92
+
93
+ _dict = self.model_dump(
94
+ by_alias=True,
95
+ exclude=excluded_fields,
96
+ exclude_none=True,
97
+ )
98
+ # override the default output from pydantic by calling `to_dict()` of source_to_user_currency_quote
99
+ if self.source_to_user_currency_quote:
100
+ _dict['sourceToUserCurrencyQuote'] = self.source_to_user_currency_quote.to_dict()
101
+ # override the default output from pydantic by calling `to_dict()` of source_to_internal_currency_quote
102
+ if self.source_to_internal_currency_quote:
103
+ _dict['sourceToInternalCurrencyQuote'] = self.source_to_internal_currency_quote.to_dict()
104
+ # override the default output from pydantic by calling `to_dict()` of user_specified_currency_base_total
105
+ if self.user_specified_currency_base_total:
106
+ _dict['userSpecifiedCurrencyBaseTotal'] = self.user_specified_currency_base_total.to_dict()
107
+ # override the default output from pydantic by calling `to_dict()` of source_base_total
108
+ if self.source_base_total:
109
+ _dict['sourceBaseTotal'] = self.source_base_total.to_dict()
110
+ # override the default output from pydantic by calling `to_dict()` of internal_base_total
111
+ if self.internal_base_total:
112
+ _dict['internalBaseTotal'] = self.internal_base_total.to_dict()
113
+ # override the default output from pydantic by calling `to_dict()` of user_specified_currency_total
114
+ if self.user_specified_currency_total:
115
+ _dict['userSpecifiedCurrencyTotal'] = self.user_specified_currency_total.to_dict()
116
+ # override the default output from pydantic by calling `to_dict()` of internal_total
117
+ if self.internal_total:
118
+ _dict['internalTotal'] = self.internal_total.to_dict()
119
+ # override the default output from pydantic by calling `to_dict()` of source_total
120
+ if self.source_total:
121
+ _dict['sourceTotal'] = self.source_total.to_dict()
122
+ return _dict
123
+
124
+ @classmethod
125
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
126
+ """Create an instance of LocalizedPriceAgent from a dict"""
127
+ if obj is None:
128
+ return None
129
+
130
+ if not isinstance(obj, dict):
131
+ return cls.model_validate(obj)
132
+
133
+ _obj = cls.model_validate({
134
+ "sourceToUserCurrencyQuote": QuoteAgent.from_dict(obj["sourceToUserCurrencyQuote"]) if obj.get("sourceToUserCurrencyQuote") is not None else None,
135
+ "sourceToInternalCurrencyQuote": QuoteAgent.from_dict(obj["sourceToInternalCurrencyQuote"]) if obj.get("sourceToInternalCurrencyQuote") is not None else None,
136
+ "userSpecifiedCurrencyBaseTotal": CustomMonetaryAmount.from_dict(obj["userSpecifiedCurrencyBaseTotal"]) if obj.get("userSpecifiedCurrencyBaseTotal") is not None else None,
137
+ "sourceBaseTotal": CustomMonetaryAmount.from_dict(obj["sourceBaseTotal"]) if obj.get("sourceBaseTotal") is not None else None,
138
+ "internalBaseTotal": CustomMonetaryAmount.from_dict(obj["internalBaseTotal"]) if obj.get("internalBaseTotal") is not None else None,
139
+ "userSpecifiedCurrencyPromotionalModifier": obj.get("userSpecifiedCurrencyPromotionalModifier"),
140
+ "sourcePromotionalModifier": obj.get("sourcePromotionalModifier"),
141
+ "internalPromotionalModifier": obj.get("internalPromotionalModifier"),
142
+ "userSpecifiedCurrencyPremiumModifier": obj.get("userSpecifiedCurrencyPremiumModifier"),
143
+ "sourcePremiumModifier": obj.get("sourcePremiumModifier"),
144
+ "internalPremiumModifier": obj.get("internalPremiumModifier"),
145
+ "userSpecifiedCurrencyChannelModifier": obj.get("userSpecifiedCurrencyChannelModifier"),
146
+ "sourceChannelModifier": obj.get("sourceChannelModifier"),
147
+ "internalChannelModifier": obj.get("internalChannelModifier"),
148
+ "quantity": obj.get("quantity") if obj.get("quantity") is not None else 1,
149
+ "promotionalDiscountPercent": obj.get("promotionalDiscountPercent"),
150
+ "channelDiscountPercent": obj.get("channelDiscountPercent"),
151
+ "premiumPercent": obj.get("premiumPercent"),
152
+ "hasChannelDiscount": obj.get("hasChannelDiscount"),
153
+ "totalDiscountPercent": obj.get("totalDiscountPercent"),
154
+ "userSpecifiedCurrencyTotal": CustomMonetaryAmount.from_dict(obj["userSpecifiedCurrencyTotal"]) if obj.get("userSpecifiedCurrencyTotal") is not None else None,
155
+ "internalTotal": CustomMonetaryAmount.from_dict(obj["internalTotal"]) if obj.get("internalTotal") is not None else None,
156
+ "sourceTotal": CustomMonetaryAmount.from_dict(obj["sourceTotal"]) if obj.get("sourceTotal") is not None else None,
157
+ "hasPremium": obj.get("hasPremium"),
158
+ "hasPromotion": obj.get("hasPromotion")
159
+ })
160
+ return _obj
161
+
162
+
@@ -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 blocking on the Wink platform. The API gives you all the tools you need to ready your properties and blocking for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel blocking 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 blocking and get that same blocking 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 blocking 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 blocking by region, locale and property flags. - [Inventory](/blocking): All APIs related to retrieve known travel blocking 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 blocking. #### 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 blocking 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 blocking to sell. - [Inventory](/affiliate/blocking): The Inventory API exposes endpoints for affiliates to manage the blocking 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 blocking and need taxonomies of standard and non-standard codes for blocking 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 blocking. 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.7.10
9
+ Contact: bjorn@wink.travel
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+
16
+ from __future__ import annotations
17
+ import pprint
18
+ import re # noqa: F401
19
+ import json
20
+
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
22
+ from typing import Any, ClassVar, Dict, List, Optional
23
+ from wink_sdk_travel_agent.models.booking_view_agent import BookingViewAgent
24
+ from wink_sdk_travel_agent.models.pageable_object_agent import PageableObjectAgent
25
+ from wink_sdk_travel_agent.models.sort_object import SortObject
26
+ from typing import Optional, Set
27
+ from typing_extensions import Self
28
+
29
+ class PageBookingViewAgent(BaseModel):
30
+ """
31
+ PageBookingViewAgent
32
+ """ # noqa: E501
33
+ total_elements: Optional[StrictInt] = Field(default=None, alias="totalElements")
34
+ total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages")
35
+ size: Optional[StrictInt] = None
36
+ content: Optional[List[BookingViewAgent]] = None
37
+ number: Optional[StrictInt] = None
38
+ sort: Optional[List[SortObject]] = None
39
+ first: Optional[StrictBool] = None
40
+ last: Optional[StrictBool] = None
41
+ number_of_elements: Optional[StrictInt] = Field(default=None, alias="numberOfElements")
42
+ pageable: Optional[PageableObjectAgent] = None
43
+ empty: Optional[StrictBool] = None
44
+ __properties: ClassVar[List[str]] = ["totalElements", "totalPages", "size", "content", "number", "sort", "first", "last", "numberOfElements", "pageable", "empty"]
45
+
46
+ model_config = ConfigDict(
47
+ populate_by_name=True,
48
+ validate_assignment=True,
49
+ protected_namespaces=(),
50
+ )
51
+
52
+
53
+ def to_str(self) -> str:
54
+ """Returns the string representation of the model using alias"""
55
+ return pprint.pformat(self.model_dump(by_alias=True))
56
+
57
+ def to_json(self) -> str:
58
+ """Returns the JSON representation of the model using alias"""
59
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
60
+ return json.dumps(self.to_dict())
61
+
62
+ @classmethod
63
+ def from_json(cls, json_str: str) -> Optional[Self]:
64
+ """Create an instance of PageBookingViewAgent from a JSON string"""
65
+ return cls.from_dict(json.loads(json_str))
66
+
67
+ def to_dict(self) -> Dict[str, Any]:
68
+ """Return the dictionary representation of the model using alias.
69
+
70
+ This has the following differences from calling pydantic's
71
+ `self.model_dump(by_alias=True)`:
72
+
73
+ * `None` is only added to the output dict for nullable fields that
74
+ were set at model initialization. Other fields with value `None`
75
+ are ignored.
76
+ """
77
+ excluded_fields: Set[str] = set([
78
+ ])
79
+
80
+ _dict = self.model_dump(
81
+ by_alias=True,
82
+ exclude=excluded_fields,
83
+ exclude_none=True,
84
+ )
85
+ # override the default output from pydantic by calling `to_dict()` of each item in content (list)
86
+ _items = []
87
+ if self.content:
88
+ for _item_content in self.content:
89
+ if _item_content:
90
+ _items.append(_item_content.to_dict())
91
+ _dict['content'] = _items
92
+ # override the default output from pydantic by calling `to_dict()` of each item in sort (list)
93
+ _items = []
94
+ if self.sort:
95
+ for _item_sort in self.sort:
96
+ if _item_sort:
97
+ _items.append(_item_sort.to_dict())
98
+ _dict['sort'] = _items
99
+ # override the default output from pydantic by calling `to_dict()` of pageable
100
+ if self.pageable:
101
+ _dict['pageable'] = self.pageable.to_dict()
102
+ return _dict
103
+
104
+ @classmethod
105
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
106
+ """Create an instance of PageBookingViewAgent from a dict"""
107
+ if obj is None:
108
+ return None
109
+
110
+ if not isinstance(obj, dict):
111
+ return cls.model_validate(obj)
112
+
113
+ _obj = cls.model_validate({
114
+ "totalElements": obj.get("totalElements"),
115
+ "totalPages": obj.get("totalPages"),
116
+ "size": obj.get("size"),
117
+ "content": [BookingViewAgent.from_dict(_item) for _item in obj["content"]] if obj.get("content") is not None else None,
118
+ "number": obj.get("number"),
119
+ "sort": [SortObject.from_dict(_item) for _item in obj["sort"]] if obj.get("sort") is not None else None,
120
+ "first": obj.get("first"),
121
+ "last": obj.get("last"),
122
+ "numberOfElements": obj.get("numberOfElements"),
123
+ "pageable": PageableObjectAgent.from_dict(obj["pageable"]) if obj.get("pageable") is not None else None,
124
+ "empty": obj.get("empty")
125
+ })
126
+ return _obj
127
+
128
+
@@ -0,0 +1,106 @@
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 blocking on the Wink platform. The API gives you all the tools you need to ready your properties and blocking for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel blocking 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 blocking and get that same blocking 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 blocking 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 blocking by region, locale and property flags. - [Inventory](/blocking): All APIs related to retrieve known travel blocking 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 blocking. #### 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 blocking 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 blocking to sell. - [Inventory](/affiliate/blocking): The Inventory API exposes endpoints for affiliates to manage the blocking 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 blocking and need taxonomies of standard and non-standard codes for blocking 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 blocking. 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.7.10
9
+ Contact: bjorn@wink.travel
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+
16
+ from __future__ import annotations
17
+ import pprint
18
+ import re # noqa: F401
19
+ import json
20
+
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
22
+ from typing import Any, ClassVar, Dict, List, Optional
23
+ from wink_sdk_travel_agent.models.sort_object import SortObject
24
+ from typing import Optional, Set
25
+ from typing_extensions import Self
26
+
27
+ class PageableObjectAgent(BaseModel):
28
+ """
29
+ PageableObjectAgent
30
+ """ # noqa: E501
31
+ offset: Optional[StrictInt] = None
32
+ sort: Optional[List[SortObject]] = None
33
+ page_number: Optional[StrictInt] = Field(default=None, alias="pageNumber")
34
+ page_size: Optional[StrictInt] = Field(default=None, alias="pageSize")
35
+ paged: Optional[StrictBool] = None
36
+ unpaged: Optional[StrictBool] = None
37
+ __properties: ClassVar[List[str]] = ["offset", "sort", "pageNumber", "pageSize", "paged", "unpaged"]
38
+
39
+ model_config = ConfigDict(
40
+ populate_by_name=True,
41
+ validate_assignment=True,
42
+ protected_namespaces=(),
43
+ )
44
+
45
+
46
+ def to_str(self) -> str:
47
+ """Returns the string representation of the model using alias"""
48
+ return pprint.pformat(self.model_dump(by_alias=True))
49
+
50
+ def to_json(self) -> str:
51
+ """Returns the JSON representation of the model using alias"""
52
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
53
+ return json.dumps(self.to_dict())
54
+
55
+ @classmethod
56
+ def from_json(cls, json_str: str) -> Optional[Self]:
57
+ """Create an instance of PageableObjectAgent from a JSON string"""
58
+ return cls.from_dict(json.loads(json_str))
59
+
60
+ def to_dict(self) -> Dict[str, Any]:
61
+ """Return the dictionary representation of the model using alias.
62
+
63
+ This has the following differences from calling pydantic's
64
+ `self.model_dump(by_alias=True)`:
65
+
66
+ * `None` is only added to the output dict for nullable fields that
67
+ were set at model initialization. Other fields with value `None`
68
+ are ignored.
69
+ """
70
+ excluded_fields: Set[str] = set([
71
+ ])
72
+
73
+ _dict = self.model_dump(
74
+ by_alias=True,
75
+ exclude=excluded_fields,
76
+ exclude_none=True,
77
+ )
78
+ # override the default output from pydantic by calling `to_dict()` of each item in sort (list)
79
+ _items = []
80
+ if self.sort:
81
+ for _item_sort in self.sort:
82
+ if _item_sort:
83
+ _items.append(_item_sort.to_dict())
84
+ _dict['sort'] = _items
85
+ return _dict
86
+
87
+ @classmethod
88
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
89
+ """Create an instance of PageableObjectAgent from a dict"""
90
+ if obj is None:
91
+ return None
92
+
93
+ if not isinstance(obj, dict):
94
+ return cls.model_validate(obj)
95
+
96
+ _obj = cls.model_validate({
97
+ "offset": obj.get("offset"),
98
+ "sort": [SortObject.from_dict(_item) for _item in obj["sort"]] if obj.get("sort") is not None else None,
99
+ "pageNumber": obj.get("pageNumber"),
100
+ "pageSize": obj.get("pageSize"),
101
+ "paged": obj.get("paged"),
102
+ "unpaged": obj.get("unpaged")
103
+ })
104
+ return _obj
105
+
106
+
@@ -0,0 +1,152 @@
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 blocking on the Wink platform. The API gives you all the tools you need to ready your properties and blocking for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel blocking 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 blocking and get that same blocking 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 blocking 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 blocking by region, locale and property flags. - [Inventory](/blocking): All APIs related to retrieve known travel blocking 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 blocking. #### 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 blocking 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 blocking to sell. - [Inventory](/affiliate/blocking): The Inventory API exposes endpoints for affiliates to manage the blocking 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 blocking and need taxonomies of standard and non-standard codes for blocking 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 blocking. 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.7.10
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 datetime
22
+ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
23
+ from typing import Any, ClassVar, Dict, List, Optional
24
+ from wink_sdk_travel_agent.models.custom_monetary_amount import CustomMonetaryAmount
25
+ from wink_sdk_travel_agent.models.payout_fee_agent import PayoutFeeAgent
26
+ from typing import Optional, Set
27
+ from typing_extensions import Self
28
+
29
+ class PayoutAgent(BaseModel):
30
+ """
31
+ Payout keeps track of all outgoing funds for a certain account.
32
+ """ # noqa: E501
33
+ vendor: StrictStr = Field(description="Name of integration vendor")
34
+ vendor_identifier: StrictStr = Field(description="Which acquirer account we return fund from.", alias="vendorIdentifier")
35
+ vendor_name: StrictStr = Field(description="Name of regional acquirer account.", alias="vendorName")
36
+ vendor_token_key: StrictStr = Field(description="Key to help load Stripe for the correct region. Could be helpful for other vendors as well.", alias="vendorTokenKey")
37
+ identifier: StrictStr = Field(description="Unique system ID.")
38
+ beneficiary_identifier: StrictStr = Field(description="Beneficiary ID.", alias="beneficiaryIdentifier")
39
+ external_payee_identifier: StrictStr = Field(description="This would be the cardholder ID for VCCs.", alias="externalPayeeIdentifier")
40
+ type: StrictStr = Field(description="Type of withdrawal.")
41
+ entry: CustomMonetaryAmount
42
+ fees: Optional[List[PayoutFeeAgent]] = Field(default=None, description="Fees incurred when making the withdrawal.")
43
+ created: datetime = Field(description="When the payout record was created.")
44
+ description: Optional[StrictStr] = Field(default=None, description="Textual response from provider")
45
+ payout_id: Optional[StrictStr] = Field(default=None, description="The identifier that was generated when scheduling the payout. This will come from the payout provider such as Stripe.", alias="payoutId")
46
+ reference_code: Optional[StrictStr] = Field(default=None, description="The transaction code that was generated when the funds move out of TripPay's account. This will come from the payout provider such as Stripe. E.g. For VCCs, it will occur when an authorization takes place.", alias="referenceCode")
47
+ reference_code_date: Optional[datetime] = Field(default=None, description="The time the funds were withdrawn", alias="referenceCodeDate")
48
+ status: StrictStr = Field(description="Status of withdrawal.")
49
+ __properties: ClassVar[List[str]] = ["vendor", "vendorIdentifier", "vendorName", "vendorTokenKey", "identifier", "beneficiaryIdentifier", "externalPayeeIdentifier", "type", "entry", "fees", "created", "description", "payoutId", "referenceCode", "referenceCodeDate", "status"]
50
+
51
+ @field_validator('vendor')
52
+ def vendor_validate_enum(cls, value):
53
+ """Validates the enum"""
54
+ if value not in set(['STRIPE', 'AGENT', 'NMI', 'WISE']):
55
+ raise ValueError("must be one of enum values ('STRIPE', 'AGENT', 'NMI', 'WISE')")
56
+ return value
57
+
58
+ @field_validator('type')
59
+ def type_validate_enum(cls, value):
60
+ """Validates the enum"""
61
+ if value not in set(['BANK_TRANSFER', 'VCC']):
62
+ raise ValueError("must be one of enum values ('BANK_TRANSFER', 'VCC')")
63
+ return value
64
+
65
+ @field_validator('status')
66
+ def status_validate_enum(cls, value):
67
+ """Validates the enum"""
68
+ if value not in set(['INITIATED', 'ACTIVE', 'INACTIVE', 'FAILED', 'CANCELLED', 'COMPLETE']):
69
+ raise ValueError("must be one of enum values ('INITIATED', 'ACTIVE', 'INACTIVE', 'FAILED', 'CANCELLED', 'COMPLETE')")
70
+ return value
71
+
72
+ model_config = ConfigDict(
73
+ populate_by_name=True,
74
+ validate_assignment=True,
75
+ protected_namespaces=(),
76
+ )
77
+
78
+
79
+ def to_str(self) -> str:
80
+ """Returns the string representation of the model using alias"""
81
+ return pprint.pformat(self.model_dump(by_alias=True))
82
+
83
+ def to_json(self) -> str:
84
+ """Returns the JSON representation of the model using alias"""
85
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
86
+ return json.dumps(self.to_dict())
87
+
88
+ @classmethod
89
+ def from_json(cls, json_str: str) -> Optional[Self]:
90
+ """Create an instance of PayoutAgent from a JSON string"""
91
+ return cls.from_dict(json.loads(json_str))
92
+
93
+ def to_dict(self) -> Dict[str, Any]:
94
+ """Return the dictionary representation of the model using alias.
95
+
96
+ This has the following differences from calling pydantic's
97
+ `self.model_dump(by_alias=True)`:
98
+
99
+ * `None` is only added to the output dict for nullable fields that
100
+ were set at model initialization. Other fields with value `None`
101
+ are ignored.
102
+ """
103
+ excluded_fields: Set[str] = set([
104
+ ])
105
+
106
+ _dict = self.model_dump(
107
+ by_alias=True,
108
+ exclude=excluded_fields,
109
+ exclude_none=True,
110
+ )
111
+ # override the default output from pydantic by calling `to_dict()` of entry
112
+ if self.entry:
113
+ _dict['entry'] = self.entry.to_dict()
114
+ # override the default output from pydantic by calling `to_dict()` of each item in fees (list)
115
+ _items = []
116
+ if self.fees:
117
+ for _item_fees in self.fees:
118
+ if _item_fees:
119
+ _items.append(_item_fees.to_dict())
120
+ _dict['fees'] = _items
121
+ return _dict
122
+
123
+ @classmethod
124
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
125
+ """Create an instance of PayoutAgent from a dict"""
126
+ if obj is None:
127
+ return None
128
+
129
+ if not isinstance(obj, dict):
130
+ return cls.model_validate(obj)
131
+
132
+ _obj = cls.model_validate({
133
+ "vendor": obj.get("vendor"),
134
+ "vendorIdentifier": obj.get("vendorIdentifier"),
135
+ "vendorName": obj.get("vendorName"),
136
+ "vendorTokenKey": obj.get("vendorTokenKey"),
137
+ "identifier": obj.get("identifier"),
138
+ "beneficiaryIdentifier": obj.get("beneficiaryIdentifier"),
139
+ "externalPayeeIdentifier": obj.get("externalPayeeIdentifier"),
140
+ "type": obj.get("type"),
141
+ "entry": CustomMonetaryAmount.from_dict(obj["entry"]) if obj.get("entry") is not None else None,
142
+ "fees": [PayoutFeeAgent.from_dict(_item) for _item in obj["fees"]] if obj.get("fees") is not None else None,
143
+ "created": obj.get("created"),
144
+ "description": obj.get("description"),
145
+ "payoutId": obj.get("payoutId"),
146
+ "referenceCode": obj.get("referenceCode"),
147
+ "referenceCodeDate": obj.get("referenceCodeDate"),
148
+ "status": obj.get("status")
149
+ })
150
+ return _obj
151
+
152
+