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,798 @@
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
+ import datetime
17
+ from dateutil.parser import parse
18
+ from enum import Enum
19
+ import decimal
20
+ import json
21
+ import mimetypes
22
+ import os
23
+ import re
24
+ import tempfile
25
+
26
+ from urllib.parse import quote
27
+ from typing import Tuple, Optional, List, Dict, Union
28
+ from pydantic import SecretStr
29
+
30
+ from wink_sdk_travel_agent.configuration import Configuration
31
+ from wink_sdk_travel_agent.api_response import ApiResponse, T as ApiResponseT
32
+ import wink_sdk_travel_agent.models
33
+ from wink_sdk_travel_agent import rest
34
+ from wink_sdk_travel_agent.exceptions import (
35
+ ApiValueError,
36
+ ApiException,
37
+ BadRequestException,
38
+ UnauthorizedException,
39
+ ForbiddenException,
40
+ NotFoundException,
41
+ ServiceException
42
+ )
43
+
44
+ RequestSerialized = Tuple[str, str, Dict[str, str], Optional[str], List[str]]
45
+
46
+ class ApiClient:
47
+ """Generic API client for OpenAPI client library builds.
48
+
49
+ OpenAPI generic API client. This client handles the client-
50
+ server communication, and is invariant across implementations. Specifics of
51
+ the methods and models for each application are generated from the OpenAPI
52
+ templates.
53
+
54
+ :param configuration: .Configuration object for this client
55
+ :param header_name: a header to pass when making calls to the API.
56
+ :param header_value: a header value to pass when making calls to
57
+ the API.
58
+ :param cookie: a cookie to include in the header when making calls
59
+ to the API
60
+ """
61
+
62
+ PRIMITIVE_TYPES = (float, bool, bytes, str, int)
63
+ NATIVE_TYPES_MAPPING = {
64
+ 'int': int,
65
+ 'long': int, # TODO remove as only py3 is supported?
66
+ 'float': float,
67
+ 'str': str,
68
+ 'bool': bool,
69
+ 'date': datetime.date,
70
+ 'datetime': datetime.datetime,
71
+ 'decimal': decimal.Decimal,
72
+ 'object': object,
73
+ }
74
+ _pool = None
75
+
76
+ def __init__(
77
+ self,
78
+ configuration=None,
79
+ header_name=None,
80
+ header_value=None,
81
+ cookie=None
82
+ ) -> None:
83
+ # use default configuration if none is provided
84
+ if configuration is None:
85
+ configuration = Configuration.get_default()
86
+ self.configuration = configuration
87
+
88
+ self.rest_client = rest.RESTClientObject(configuration)
89
+ self.default_headers = {}
90
+ if header_name is not None:
91
+ self.default_headers[header_name] = header_value
92
+ self.cookie = cookie
93
+ # Set default User-Agent.
94
+ self.user_agent = 'wink-sdk-python'
95
+ self.client_side_validation = configuration.client_side_validation
96
+
97
+ def __enter__(self):
98
+ return self
99
+
100
+ def __exit__(self, exc_type, exc_value, traceback):
101
+ pass
102
+
103
+ @property
104
+ def user_agent(self):
105
+ """User agent for this API client"""
106
+ return self.default_headers['User-Agent']
107
+
108
+ @user_agent.setter
109
+ def user_agent(self, value):
110
+ self.default_headers['User-Agent'] = value
111
+
112
+ def set_default_header(self, header_name, header_value):
113
+ self.default_headers[header_name] = header_value
114
+
115
+
116
+ _default = None
117
+
118
+ @classmethod
119
+ def get_default(cls):
120
+ """Return new instance of ApiClient.
121
+
122
+ This method returns newly created, based on default constructor,
123
+ object of ApiClient class or returns a copy of default
124
+ ApiClient.
125
+
126
+ :return: The ApiClient object.
127
+ """
128
+ if cls._default is None:
129
+ cls._default = ApiClient()
130
+ return cls._default
131
+
132
+ @classmethod
133
+ def set_default(cls, default):
134
+ """Set default instance of ApiClient.
135
+
136
+ It stores default ApiClient.
137
+
138
+ :param default: object of ApiClient.
139
+ """
140
+ cls._default = default
141
+
142
+ def param_serialize(
143
+ self,
144
+ method,
145
+ resource_path,
146
+ path_params=None,
147
+ query_params=None,
148
+ header_params=None,
149
+ body=None,
150
+ post_params=None,
151
+ files=None, auth_settings=None,
152
+ collection_formats=None,
153
+ _host=None,
154
+ _request_auth=None
155
+ ) -> RequestSerialized:
156
+
157
+ """Builds the HTTP request params needed by the request.
158
+ :param method: Method to call.
159
+ :param resource_path: Path to method endpoint.
160
+ :param path_params: Path parameters in the url.
161
+ :param query_params: Query parameters in the url.
162
+ :param header_params: Header parameters to be
163
+ placed in the request header.
164
+ :param body: Request body.
165
+ :param post_params dict: Request post form parameters,
166
+ for `application/x-www-form-urlencoded`, `multipart/form-data`.
167
+ :param auth_settings list: Auth Settings names for the request.
168
+ :param files dict: key -> filename, value -> filepath,
169
+ for `multipart/form-data`.
170
+ :param collection_formats: dict of collection formats for path, query,
171
+ header, and post parameters.
172
+ :param _request_auth: set to override the auth_settings for an a single
173
+ request; this effectively ignores the authentication
174
+ in the spec for a single request.
175
+ :return: tuple of form (path, http_method, query_params, header_params,
176
+ body, post_params, files)
177
+ """
178
+
179
+ config = self.configuration
180
+
181
+ # header parameters
182
+ header_params = header_params or {}
183
+ header_params.update(self.default_headers)
184
+ if self.cookie:
185
+ header_params['Cookie'] = self.cookie
186
+ if header_params:
187
+ header_params = self.sanitize_for_serialization(header_params)
188
+ header_params = dict(
189
+ self.parameters_to_tuples(header_params,collection_formats)
190
+ )
191
+
192
+ # path parameters
193
+ if path_params:
194
+ path_params = self.sanitize_for_serialization(path_params)
195
+ path_params = self.parameters_to_tuples(
196
+ path_params,
197
+ collection_formats
198
+ )
199
+ for k, v in path_params:
200
+ # specified safe chars, encode everything
201
+ resource_path = resource_path.replace(
202
+ '{%s}' % k,
203
+ quote(str(v), safe=config.safe_chars_for_path_param)
204
+ )
205
+
206
+ # post parameters
207
+ if post_params or files:
208
+ post_params = post_params if post_params else []
209
+ post_params = self.sanitize_for_serialization(post_params)
210
+ post_params = self.parameters_to_tuples(
211
+ post_params,
212
+ collection_formats
213
+ )
214
+ if files:
215
+ post_params.extend(self.files_parameters(files))
216
+
217
+ # auth setting
218
+ self.update_params_for_auth(
219
+ header_params,
220
+ query_params,
221
+ auth_settings,
222
+ resource_path,
223
+ method,
224
+ body,
225
+ request_auth=_request_auth
226
+ )
227
+
228
+ # body
229
+ if body:
230
+ body = self.sanitize_for_serialization(body)
231
+
232
+ # request url
233
+ if _host is None or self.configuration.ignore_operation_servers:
234
+ url = self.configuration.host + resource_path
235
+ else:
236
+ # use server/host defined in path or operation instead
237
+ url = _host + resource_path
238
+
239
+ # query parameters
240
+ if query_params:
241
+ query_params = self.sanitize_for_serialization(query_params)
242
+ url_query = self.parameters_to_url_query(
243
+ query_params,
244
+ collection_formats
245
+ )
246
+ url += "?" + url_query
247
+
248
+ return method, url, header_params, body, post_params
249
+
250
+
251
+ def call_api(
252
+ self,
253
+ method,
254
+ url,
255
+ header_params=None,
256
+ body=None,
257
+ post_params=None,
258
+ _request_timeout=None
259
+ ) -> rest.RESTResponse:
260
+ """Makes the HTTP request (synchronous)
261
+ :param method: Method to call.
262
+ :param url: Path to method endpoint.
263
+ :param header_params: Header parameters to be
264
+ placed in the request header.
265
+ :param body: Request body.
266
+ :param post_params dict: Request post form parameters,
267
+ for `application/x-www-form-urlencoded`, `multipart/form-data`.
268
+ :param _request_timeout: timeout setting for this request.
269
+ :return: RESTResponse
270
+ """
271
+
272
+ try:
273
+ # perform request and return response
274
+ response_data = self.rest_client.request(
275
+ method, url,
276
+ headers=header_params,
277
+ body=body, post_params=post_params,
278
+ _request_timeout=_request_timeout
279
+ )
280
+
281
+ except ApiException as e:
282
+ raise e
283
+
284
+ return response_data
285
+
286
+ def response_deserialize(
287
+ self,
288
+ response_data: rest.RESTResponse,
289
+ response_types_map: Optional[Dict[str, ApiResponseT]]=None
290
+ ) -> ApiResponse[ApiResponseT]:
291
+ """Deserializes response into an object.
292
+ :param response_data: RESTResponse object to be deserialized.
293
+ :param response_types_map: dict of response types.
294
+ :return: ApiResponse
295
+ """
296
+
297
+ msg = "RESTResponse.read() must be called before passing it to response_deserialize()"
298
+ assert response_data.data is not None, msg
299
+
300
+ response_type = response_types_map.get(str(response_data.status), None)
301
+ if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599:
302
+ # if not found, look for '1XX', '2XX', etc.
303
+ response_type = response_types_map.get(str(response_data.status)[0] + "XX", None)
304
+
305
+ # deserialize response data
306
+ response_text = None
307
+ return_data = None
308
+ try:
309
+ if response_type == "bytearray":
310
+ return_data = response_data.data
311
+ elif response_type == "file":
312
+ return_data = self.__deserialize_file(response_data)
313
+ elif response_type is not None:
314
+ match = None
315
+ content_type = response_data.getheader('content-type')
316
+ if content_type is not None:
317
+ match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type)
318
+ encoding = match.group(1) if match else "utf-8"
319
+ response_text = response_data.data.decode(encoding)
320
+ return_data = self.deserialize(response_text, response_type, content_type)
321
+ finally:
322
+ if not 200 <= response_data.status <= 299:
323
+ raise ApiException.from_response(
324
+ http_resp=response_data,
325
+ body=response_text,
326
+ data=return_data,
327
+ )
328
+
329
+ return ApiResponse(
330
+ status_code = response_data.status,
331
+ data = return_data,
332
+ headers = response_data.getheaders(),
333
+ raw_data = response_data.data
334
+ )
335
+
336
+ def sanitize_for_serialization(self, obj):
337
+ """Builds a JSON POST object.
338
+
339
+ If obj is None, return None.
340
+ If obj is SecretStr, return obj.get_secret_value()
341
+ If obj is str, int, long, float, bool, return directly.
342
+ If obj is datetime.datetime, datetime.date
343
+ convert to string in iso8601 format.
344
+ If obj is decimal.Decimal return string representation.
345
+ If obj is list, sanitize each element in the list.
346
+ If obj is dict, return the dict.
347
+ If obj is OpenAPI model, return the properties dict.
348
+
349
+ :param obj: The data to serialize.
350
+ :return: The serialized form of data.
351
+ """
352
+ if obj is None:
353
+ return None
354
+ elif isinstance(obj, Enum):
355
+ return obj.value
356
+ elif isinstance(obj, SecretStr):
357
+ return obj.get_secret_value()
358
+ elif isinstance(obj, self.PRIMITIVE_TYPES):
359
+ return obj
360
+ elif isinstance(obj, list):
361
+ return [
362
+ self.sanitize_for_serialization(sub_obj) for sub_obj in obj
363
+ ]
364
+ elif isinstance(obj, tuple):
365
+ return tuple(
366
+ self.sanitize_for_serialization(sub_obj) for sub_obj in obj
367
+ )
368
+ elif isinstance(obj, (datetime.datetime, datetime.date)):
369
+ return obj.isoformat()
370
+ elif isinstance(obj, decimal.Decimal):
371
+ return str(obj)
372
+
373
+ elif isinstance(obj, dict):
374
+ obj_dict = obj
375
+ else:
376
+ # Convert model obj to dict except
377
+ # attributes `openapi_types`, `attribute_map`
378
+ # and attributes which value is not None.
379
+ # Convert attribute name to json key in
380
+ # model definition for request.
381
+ if hasattr(obj, 'to_dict') and callable(getattr(obj, 'to_dict')):
382
+ obj_dict = obj.to_dict()
383
+ else:
384
+ obj_dict = obj.__dict__
385
+
386
+ return {
387
+ key: self.sanitize_for_serialization(val)
388
+ for key, val in obj_dict.items()
389
+ }
390
+
391
+ def deserialize(self, response_text: str, response_type: str, content_type: Optional[str]):
392
+ """Deserializes response into an object.
393
+
394
+ :param response: RESTResponse object to be deserialized.
395
+ :param response_type: class literal for
396
+ deserialized object, or string of class name.
397
+ :param content_type: content type of response.
398
+
399
+ :return: deserialized object.
400
+ """
401
+
402
+ # fetch data from response object
403
+ if content_type is None:
404
+ try:
405
+ data = json.loads(response_text)
406
+ except ValueError:
407
+ data = response_text
408
+ elif re.match(r'^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE):
409
+ if response_text == "":
410
+ data = ""
411
+ else:
412
+ data = json.loads(response_text)
413
+ elif re.match(r'^text\/[a-z.+-]+\s*(;|$)', content_type, re.IGNORECASE):
414
+ data = response_text
415
+ else:
416
+ raise ApiException(
417
+ status=0,
418
+ reason="Unsupported content type: {0}".format(content_type)
419
+ )
420
+
421
+ return self.__deserialize(data, response_type)
422
+
423
+ def __deserialize(self, data, klass):
424
+ """Deserializes dict, list, str into an object.
425
+
426
+ :param data: dict, list or str.
427
+ :param klass: class literal, or string of class name.
428
+
429
+ :return: object.
430
+ """
431
+ if data is None:
432
+ return None
433
+
434
+ if isinstance(klass, str):
435
+ if klass.startswith('List['):
436
+ m = re.match(r'List\[(.*)]', klass)
437
+ assert m is not None, "Malformed List type definition"
438
+ sub_kls = m.group(1)
439
+ return [self.__deserialize(sub_data, sub_kls)
440
+ for sub_data in data]
441
+
442
+ if klass.startswith('Dict['):
443
+ m = re.match(r'Dict\[([^,]*), (.*)]', klass)
444
+ assert m is not None, "Malformed Dict type definition"
445
+ sub_kls = m.group(2)
446
+ return {k: self.__deserialize(v, sub_kls)
447
+ for k, v in data.items()}
448
+
449
+ # convert str to class
450
+ if klass in self.NATIVE_TYPES_MAPPING:
451
+ klass = self.NATIVE_TYPES_MAPPING[klass]
452
+ else:
453
+ klass = getattr(wink_sdk_travel_agent.models, klass)
454
+
455
+ if klass in self.PRIMITIVE_TYPES:
456
+ return self.__deserialize_primitive(data, klass)
457
+ elif klass == object:
458
+ return self.__deserialize_object(data)
459
+ elif klass == datetime.date:
460
+ return self.__deserialize_date(data)
461
+ elif klass == datetime.datetime:
462
+ return self.__deserialize_datetime(data)
463
+ elif klass == decimal.Decimal:
464
+ return decimal.Decimal(data)
465
+ elif issubclass(klass, Enum):
466
+ return self.__deserialize_enum(data, klass)
467
+ else:
468
+ return self.__deserialize_model(data, klass)
469
+
470
+ def parameters_to_tuples(self, params, collection_formats):
471
+ """Get parameters as list of tuples, formatting collections.
472
+
473
+ :param params: Parameters as dict or list of two-tuples
474
+ :param dict collection_formats: Parameter collection formats
475
+ :return: Parameters as list of tuples, collections formatted
476
+ """
477
+ new_params: List[Tuple[str, str]] = []
478
+ if collection_formats is None:
479
+ collection_formats = {}
480
+ for k, v in params.items() if isinstance(params, dict) else params:
481
+ if k in collection_formats:
482
+ collection_format = collection_formats[k]
483
+ if collection_format == 'multi':
484
+ new_params.extend((k, value) for value in v)
485
+ else:
486
+ if collection_format == 'ssv':
487
+ delimiter = ' '
488
+ elif collection_format == 'tsv':
489
+ delimiter = '\t'
490
+ elif collection_format == 'pipes':
491
+ delimiter = '|'
492
+ else: # csv is the default
493
+ delimiter = ','
494
+ new_params.append(
495
+ (k, delimiter.join(str(value) for value in v)))
496
+ else:
497
+ new_params.append((k, v))
498
+ return new_params
499
+
500
+ def parameters_to_url_query(self, params, collection_formats):
501
+ """Get parameters as list of tuples, formatting collections.
502
+
503
+ :param params: Parameters as dict or list of two-tuples
504
+ :param dict collection_formats: Parameter collection formats
505
+ :return: URL query string (e.g. a=Hello%20World&b=123)
506
+ """
507
+ new_params: List[Tuple[str, str]] = []
508
+ if collection_formats is None:
509
+ collection_formats = {}
510
+ for k, v in params.items() if isinstance(params, dict) else params:
511
+ if isinstance(v, bool):
512
+ v = str(v).lower()
513
+ if isinstance(v, (int, float)):
514
+ v = str(v)
515
+ if isinstance(v, dict):
516
+ v = json.dumps(v)
517
+
518
+ if k in collection_formats:
519
+ collection_format = collection_formats[k]
520
+ if collection_format == 'multi':
521
+ new_params.extend((k, str(value)) for value in v)
522
+ else:
523
+ if collection_format == 'ssv':
524
+ delimiter = ' '
525
+ elif collection_format == 'tsv':
526
+ delimiter = '\t'
527
+ elif collection_format == 'pipes':
528
+ delimiter = '|'
529
+ else: # csv is the default
530
+ delimiter = ','
531
+ new_params.append(
532
+ (k, delimiter.join(quote(str(value)) for value in v))
533
+ )
534
+ else:
535
+ new_params.append((k, quote(str(v))))
536
+
537
+ return "&".join(["=".join(map(str, item)) for item in new_params])
538
+
539
+ def files_parameters(
540
+ self,
541
+ files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]],
542
+ ):
543
+ """Builds form parameters.
544
+
545
+ :param files: File parameters.
546
+ :return: Form parameters with files.
547
+ """
548
+ params = []
549
+ for k, v in files.items():
550
+ if isinstance(v, str):
551
+ with open(v, 'rb') as f:
552
+ filename = os.path.basename(f.name)
553
+ filedata = f.read()
554
+ elif isinstance(v, bytes):
555
+ filename = k
556
+ filedata = v
557
+ elif isinstance(v, tuple):
558
+ filename, filedata = v
559
+ elif isinstance(v, list):
560
+ for file_param in v:
561
+ params.extend(self.files_parameters({k: file_param}))
562
+ continue
563
+ else:
564
+ raise ValueError("Unsupported file value")
565
+ mimetype = (
566
+ mimetypes.guess_type(filename)[0]
567
+ or 'application/octet-stream'
568
+ )
569
+ params.append(
570
+ tuple([k, tuple([filename, filedata, mimetype])])
571
+ )
572
+ return params
573
+
574
+ def select_header_accept(self, accepts: List[str]) -> Optional[str]:
575
+ """Returns `Accept` based on an array of accepts provided.
576
+
577
+ :param accepts: List of headers.
578
+ :return: Accept (e.g. application/json).
579
+ """
580
+ if not accepts:
581
+ return None
582
+
583
+ for accept in accepts:
584
+ if re.search('json', accept, re.IGNORECASE):
585
+ return accept
586
+
587
+ return accepts[0]
588
+
589
+ def select_header_content_type(self, content_types):
590
+ """Returns `Content-Type` based on an array of content_types provided.
591
+
592
+ :param content_types: List of content-types.
593
+ :return: Content-Type (e.g. application/json).
594
+ """
595
+ if not content_types:
596
+ return None
597
+
598
+ for content_type in content_types:
599
+ if re.search('json', content_type, re.IGNORECASE):
600
+ return content_type
601
+
602
+ return content_types[0]
603
+
604
+ def update_params_for_auth(
605
+ self,
606
+ headers,
607
+ queries,
608
+ auth_settings,
609
+ resource_path,
610
+ method,
611
+ body,
612
+ request_auth=None
613
+ ) -> None:
614
+ """Updates header and query params based on authentication setting.
615
+
616
+ :param headers: Header parameters dict to be updated.
617
+ :param queries: Query parameters tuple list to be updated.
618
+ :param auth_settings: Authentication setting identifiers list.
619
+ :resource_path: A string representation of the HTTP request resource path.
620
+ :method: A string representation of the HTTP request method.
621
+ :body: A object representing the body of the HTTP request.
622
+ The object type is the return value of sanitize_for_serialization().
623
+ :param request_auth: if set, the provided settings will
624
+ override the token in the configuration.
625
+ """
626
+ if not auth_settings:
627
+ return
628
+
629
+ if request_auth:
630
+ self._apply_auth_params(
631
+ headers,
632
+ queries,
633
+ resource_path,
634
+ method,
635
+ body,
636
+ request_auth
637
+ )
638
+ else:
639
+ for auth in auth_settings:
640
+ auth_setting = self.configuration.auth_settings().get(auth)
641
+ if auth_setting:
642
+ self._apply_auth_params(
643
+ headers,
644
+ queries,
645
+ resource_path,
646
+ method,
647
+ body,
648
+ auth_setting
649
+ )
650
+
651
+ def _apply_auth_params(
652
+ self,
653
+ headers,
654
+ queries,
655
+ resource_path,
656
+ method,
657
+ body,
658
+ auth_setting
659
+ ) -> None:
660
+ """Updates the request parameters based on a single auth_setting
661
+
662
+ :param headers: Header parameters dict to be updated.
663
+ :param queries: Query parameters tuple list to be updated.
664
+ :resource_path: A string representation of the HTTP request resource path.
665
+ :method: A string representation of the HTTP request method.
666
+ :body: A object representing the body of the HTTP request.
667
+ The object type is the return value of sanitize_for_serialization().
668
+ :param auth_setting: auth settings for the endpoint
669
+ """
670
+ if auth_setting['in'] == 'cookie':
671
+ headers['Cookie'] = auth_setting['value']
672
+ elif auth_setting['in'] == 'header':
673
+ if auth_setting['type'] != 'http-signature':
674
+ headers[auth_setting['key']] = auth_setting['value']
675
+ elif auth_setting['in'] == 'query':
676
+ queries.append((auth_setting['key'], auth_setting['value']))
677
+ else:
678
+ raise ApiValueError(
679
+ 'Authentication token must be in `query` or `header`'
680
+ )
681
+
682
+ def __deserialize_file(self, response):
683
+ """Deserializes body to file
684
+
685
+ Saves response body into a file in a temporary folder,
686
+ using the filename from the `Content-Disposition` header if provided.
687
+
688
+ handle file downloading
689
+ save response body into a tmp file and return the instance
690
+
691
+ :param response: RESTResponse.
692
+ :return: file path.
693
+ """
694
+ fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path)
695
+ os.close(fd)
696
+ os.remove(path)
697
+
698
+ content_disposition = response.getheader("Content-Disposition")
699
+ if content_disposition:
700
+ m = re.search(
701
+ r'filename=[\'"]?([^\'"\s]+)[\'"]?',
702
+ content_disposition
703
+ )
704
+ assert m is not None, "Unexpected 'content-disposition' header value"
705
+ filename = m.group(1)
706
+ path = os.path.join(os.path.dirname(path), filename)
707
+
708
+ with open(path, "wb") as f:
709
+ f.write(response.data)
710
+
711
+ return path
712
+
713
+ def __deserialize_primitive(self, data, klass):
714
+ """Deserializes string to primitive type.
715
+
716
+ :param data: str.
717
+ :param klass: class literal.
718
+
719
+ :return: int, long, float, str, bool.
720
+ """
721
+ try:
722
+ return klass(data)
723
+ except UnicodeEncodeError:
724
+ return str(data)
725
+ except TypeError:
726
+ return data
727
+
728
+ def __deserialize_object(self, value):
729
+ """Return an original value.
730
+
731
+ :return: object.
732
+ """
733
+ return value
734
+
735
+ def __deserialize_date(self, string):
736
+ """Deserializes string to date.
737
+
738
+ :param string: str.
739
+ :return: date.
740
+ """
741
+ try:
742
+ return parse(string).date()
743
+ except ImportError:
744
+ return string
745
+ except ValueError:
746
+ raise rest.ApiException(
747
+ status=0,
748
+ reason="Failed to parse `{0}` as date object".format(string)
749
+ )
750
+
751
+ def __deserialize_datetime(self, string):
752
+ """Deserializes string to datetime.
753
+
754
+ The string should be in iso8601 datetime format.
755
+
756
+ :param string: str.
757
+ :return: datetime.
758
+ """
759
+ try:
760
+ return parse(string)
761
+ except ImportError:
762
+ return string
763
+ except ValueError:
764
+ raise rest.ApiException(
765
+ status=0,
766
+ reason=(
767
+ "Failed to parse `{0}` as datetime object"
768
+ .format(string)
769
+ )
770
+ )
771
+
772
+ def __deserialize_enum(self, data, klass):
773
+ """Deserializes primitive type to enum.
774
+
775
+ :param data: primitive type.
776
+ :param klass: class literal.
777
+ :return: enum value.
778
+ """
779
+ try:
780
+ return klass(data)
781
+ except ValueError:
782
+ raise rest.ApiException(
783
+ status=0,
784
+ reason=(
785
+ "Failed to parse `{0}` as `{1}`"
786
+ .format(data, klass)
787
+ )
788
+ )
789
+
790
+ def __deserialize_model(self, data, klass):
791
+ """Deserializes list or dict to model.
792
+
793
+ :param data: dict, list.
794
+ :param klass: class literal.
795
+ :return: model object.
796
+ """
797
+
798
+ return klass.from_dict(data)