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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. wink_sdk_travel_agent/__init__.py +229 -0
  2. wink_sdk_travel_agent/api/__init__.py +6 -0
  3. wink_sdk_travel_agent/api/analytics_api.py +671 -0
  4. wink_sdk_travel_agent/api/travel_agent_api.py +1668 -0
  5. wink_sdk_travel_agent/api_client.py +805 -0
  6. wink_sdk_travel_agent/api_response.py +21 -0
  7. wink_sdk_travel_agent/configuration.py +582 -0
  8. wink_sdk_travel_agent/exceptions.py +217 -0
  9. wink_sdk_travel_agent/models/__init__.py +106 -0
  10. wink_sdk_travel_agent/models/address_agent.py +111 -0
  11. wink_sdk_travel_agent/models/affiliate_account_agent.py +181 -0
  12. wink_sdk_travel_agent/models/affiliate_account_user_agent.py +115 -0
  13. wink_sdk_travel_agent/models/agent_booking_request_agent.py +130 -0
  14. wink_sdk_travel_agent/models/aggregate_descriptor_agent.py +100 -0
  15. wink_sdk_travel_agent/models/ancillary_request_agent.py +111 -0
  16. wink_sdk_travel_agent/models/authenticated_user_agent.py +100 -0
  17. wink_sdk_travel_agent/models/bed_agent.py +91 -0
  18. wink_sdk_travel_agent/models/bedroom_agent.py +106 -0
  19. wink_sdk_travel_agent/models/bedroom_configuration_agent.py +102 -0
  20. wink_sdk_travel_agent/models/beneficiary_agent.py +156 -0
  21. wink_sdk_travel_agent/models/beneficiary_charge_agent.py +97 -0
  22. wink_sdk_travel_agent/models/booking_agent.py +342 -0
  23. wink_sdk_travel_agent/models/booking_analytics_supplier.py +96 -0
  24. wink_sdk_travel_agent/models/booking_ancillary_agent.py +155 -0
  25. wink_sdk_travel_agent/models/booking_confirmations_agent.py +101 -0
  26. wink_sdk_travel_agent/models/booking_contract_agent.py +697 -0
  27. wink_sdk_travel_agent/models/booking_contract_item_agent.py +206 -0
  28. wink_sdk_travel_agent/models/booking_contract_payment_details_agent.py +124 -0
  29. wink_sdk_travel_agent/models/booking_itinerary_agent.py +113 -0
  30. wink_sdk_travel_agent/models/booking_itinerary_room_configuration_agent.py +98 -0
  31. wink_sdk_travel_agent/models/booking_itinerary_room_configuration_child_agent.py +90 -0
  32. wink_sdk_travel_agent/models/booking_overview_request_supplier.py +97 -0
  33. wink_sdk_travel_agent/models/booking_user_agent.py +102 -0
  34. wink_sdk_travel_agent/models/booking_user_request_agent.py +96 -0
  35. wink_sdk_travel_agent/models/booking_user_session_agent.py +112 -0
  36. wink_sdk_travel_agent/models/booking_view_agent.py +101 -0
  37. wink_sdk_travel_agent/models/boolean_response_agent.py +90 -0
  38. wink_sdk_travel_agent/models/cancellation_detail_agent.py +98 -0
  39. wink_sdk_travel_agent/models/cancellation_policy_agent.py +166 -0
  40. wink_sdk_travel_agent/models/cancellation_policy_exception_agent.py +100 -0
  41. wink_sdk_travel_agent/models/cancellation_policy_exceptions_agent.py +97 -0
  42. wink_sdk_travel_agent/models/cancellation_policy_lightweight_agent.py +167 -0
  43. wink_sdk_travel_agent/models/chart_category_axis_supplier.py +88 -0
  44. wink_sdk_travel_agent/models/chart_legend_supplier.py +88 -0
  45. wink_sdk_travel_agent/models/chart_series_supplier.py +90 -0
  46. wink_sdk_travel_agent/models/chart_title_supplier.py +88 -0
  47. wink_sdk_travel_agent/models/child_agent.py +91 -0
  48. wink_sdk_travel_agent/models/commissionable_entry_agent.py +102 -0
  49. wink_sdk_travel_agent/models/company_agent.py +176 -0
  50. wink_sdk_travel_agent/models/company_user_agent.py +114 -0
  51. wink_sdk_travel_agent/models/company_view_agent.py +101 -0
  52. wink_sdk_travel_agent/models/composite_filter_descriptor_agent.py +108 -0
  53. wink_sdk_travel_agent/models/contact_agent.py +104 -0
  54. wink_sdk_travel_agent/models/country_agent.py +100 -0
  55. wink_sdk_travel_agent/models/country_lightweight_agent.py +100 -0
  56. wink_sdk_travel_agent/models/create_agent_booking400_response.py +141 -0
  57. wink_sdk_travel_agent/models/create_agent_booking_request_agent.py +105 -0
  58. wink_sdk_travel_agent/models/custom_monetary_amount.py +91 -0
  59. wink_sdk_travel_agent/models/customization_lightweight_agent.py +232 -0
  60. wink_sdk_travel_agent/models/customization_theme_colors_agent.py +108 -0
  61. wink_sdk_travel_agent/models/daily_rate_agent.py +115 -0
  62. wink_sdk_travel_agent/models/dow_pattern_group_agent.py +102 -0
  63. wink_sdk_travel_agent/models/engine_configuration_booking_report_agent.py +230 -0
  64. wink_sdk_travel_agent/models/engine_configuration_theme_agent.py +108 -0
  65. wink_sdk_travel_agent/models/engine_configuration_theme_colors_agent.py +108 -0
  66. wink_sdk_travel_agent/models/extra_charge_agent.py +103 -0
  67. wink_sdk_travel_agent/models/extra_charges_agent.py +112 -0
  68. wink_sdk_travel_agent/models/fee_agent.py +105 -0
  69. wink_sdk_travel_agent/models/filter_descriptor_agent.py +107 -0
  70. wink_sdk_travel_agent/models/general_manager_agent.py +104 -0
  71. wink_sdk_travel_agent/models/generic_error_message.py +94 -0
  72. wink_sdk_travel_agent/models/geo_json_point_agent.py +94 -0
  73. wink_sdk_travel_agent/models/geo_name_agent.py +136 -0
  74. wink_sdk_travel_agent/models/geo_name_lightweight_agent.py +136 -0
  75. wink_sdk_travel_agent/models/group_descriptor_agent.py +110 -0
  76. wink_sdk_travel_agent/models/grouped_booking_sales_metrics_supplier_details.py +110 -0
  77. wink_sdk_travel_agent/models/guest_room_agent.py +258 -0
  78. wink_sdk_travel_agent/models/guest_room_lightweight_agent.py +259 -0
  79. wink_sdk_travel_agent/models/guest_user_agent.py +108 -0
  80. wink_sdk_travel_agent/models/hotel_on_map_agent.py +270 -0
  81. wink_sdk_travel_agent/models/image_attribution_agent.py +91 -0
  82. wink_sdk_travel_agent/models/line_chart_supplier.py +122 -0
  83. wink_sdk_travel_agent/models/localized_description_agent.py +109 -0
  84. wink_sdk_travel_agent/models/localized_price_agent.py +162 -0
  85. wink_sdk_travel_agent/models/managed_by_entity_agent.py +103 -0
  86. wink_sdk_travel_agent/models/managed_by_entity_rules_agent.py +95 -0
  87. wink_sdk_travel_agent/models/media_author_attribution_agent.py +91 -0
  88. wink_sdk_travel_agent/models/online_presence_agent.py +112 -0
  89. wink_sdk_travel_agent/models/page_booking_agent.py +124 -0
  90. wink_sdk_travel_agent/models/page_booking_view_agent.py +124 -0
  91. wink_sdk_travel_agent/models/pageable_object_agent.py +102 -0
  92. wink_sdk_travel_agent/models/payout_agent.py +158 -0
  93. wink_sdk_travel_agent/models/payout_fee_agent.py +116 -0
  94. wink_sdk_travel_agent/models/pending_refund_agent.py +99 -0
  95. wink_sdk_travel_agent/models/perk_lightweight_agent.py +105 -0
  96. wink_sdk_travel_agent/models/personal_agent.py +139 -0
  97. wink_sdk_travel_agent/models/pet_info_dto_agent.py +90 -0
  98. wink_sdk_travel_agent/models/preferences_agent.py +128 -0
  99. wink_sdk_travel_agent/models/profile_agent.py +110 -0
  100. wink_sdk_travel_agent/models/profile_lightweight_agent.py +111 -0
  101. wink_sdk_travel_agent/models/profile_user_agent.py +100 -0
  102. wink_sdk_travel_agent/models/property_aggregate_lightweight_agent.py +245 -0
  103. wink_sdk_travel_agent/models/property_policy_agent.py +150 -0
  104. wink_sdk_travel_agent/models/quote_agent.py +94 -0
  105. wink_sdk_travel_agent/models/quote_lightweight_agent.py +95 -0
  106. wink_sdk_travel_agent/models/rate_plan_agent.py +172 -0
  107. wink_sdk_travel_agent/models/rate_plan_level_fee_agent.py +112 -0
  108. wink_sdk_travel_agent/models/refund_agent.py +167 -0
  109. wink_sdk_travel_agent/models/reporting_ancillary_agent.py +108 -0
  110. wink_sdk_travel_agent/models/reporting_daily_rate_agent.py +99 -0
  111. wink_sdk_travel_agent/models/reporting_extra_charge_agent.py +98 -0
  112. wink_sdk_travel_agent/models/review_agent.py +133 -0
  113. wink_sdk_travel_agent/models/review_answer_agent.py +102 -0
  114. wink_sdk_travel_agent/models/review_lightweight_agent.py +134 -0
  115. wink_sdk_travel_agent/models/review_user_agent.py +99 -0
  116. wink_sdk_travel_agent/models/room_configuration_agent.py +99 -0
  117. wink_sdk_travel_agent/models/room_configuration_price_rate_plan_agent.py +130 -0
  118. wink_sdk_travel_agent/models/room_stay_agent.py +183 -0
  119. wink_sdk_travel_agent/models/simple_address_agent.py +109 -0
  120. wink_sdk_travel_agent/models/simple_date_time_itinerary_agent.py +108 -0
  121. wink_sdk_travel_agent/models/simple_description_agent.py +111 -0
  122. wink_sdk_travel_agent/models/simple_multimedia_agent.py +156 -0
  123. wink_sdk_travel_agent/models/social_agent.py +100 -0
  124. wink_sdk_travel_agent/models/sort_descriptor_agent.py +100 -0
  125. wink_sdk_travel_agent/models/sort_object.py +96 -0
  126. wink_sdk_travel_agent/models/sort_object_agent.py +92 -0
  127. wink_sdk_travel_agent/models/state_agent.py +117 -0
  128. wink_sdk_travel_agent/models/stay_rate_agent.py +209 -0
  129. wink_sdk_travel_agent/models/sub_country_agent.py +92 -0
  130. wink_sdk_travel_agent/models/sub_country_lightweight_agent.py +92 -0
  131. wink_sdk_travel_agent/models/sub_sub_country_agent.py +92 -0
  132. wink_sdk_travel_agent/models/sub_sub_country_lightweight_agent.py +92 -0
  133. wink_sdk_travel_agent/models/supplier_contract_item_policy_agent.py +170 -0
  134. wink_sdk_travel_agent/models/travel_agent_agent.py +90 -0
  135. wink_sdk_travel_agent/models/travel_inventory_recognition_agent.py +121 -0
  136. wink_sdk_travel_agent/models/upsert_travel_agent_request_agent.py +90 -0
  137. wink_sdk_travel_agent/models/wink_booking_contract_agent.py +697 -0
  138. wink_sdk_travel_agent/py.typed +0 -0
  139. wink_sdk_travel_agent/rest.py +259 -0
  140. wink_sdk_travel_agent-0.0.55.dist-info/METADATA +539 -0
  141. wink_sdk_travel_agent-0.0.55.dist-info/RECORD +144 -0
  142. wink_sdk_travel_agent-0.0.55.dist-info/WHEEL +5 -0
  143. wink_sdk_travel_agent-0.0.55.dist-info/licenses/LICENSE +201 -0
  144. wink_sdk_travel_agent-0.0.55.dist-info/top_level.txt +1 -0
@@ -0,0 +1,671 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Wink API
5
+
6
+ # Introduction Welcome to the Wink API - A programmer-friendly way to manage, sell and book travel inventory on the Wink platform. The API gives you all the tools you need to ready your properties and inventory for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel inventory and promote / sell it in a wide variety of ways. # Integrations We have already integrated with the most well-known channel managers so you don't have to. To see our current integrations, please go to https://extranet.wink.travel and scroll to Connectivity section. Once your properties are set up, you can finish the setup by mapping your property to Wink using your channel manager partner portal. If your properties don't have a channel manager, you can easily manage rates and availability with this API. # Intended Audience Programmers are [most likely] a requirement to start integrating with Wink. Companies and organizations that would most benefit from integrating with us are new and existing travel companies that have relationships with suppliers and that need an advanced system from which to manage their travel inventory and get that same inventory out to as many eyeballs as possible at the lowest price possible. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume endpoints are for developers who want to find existing travel inventory and either book it or use it to advertise through one of their Wink affiliate accounts. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [Inventory](/affiliate/inventory): The Inventory API exposes endpoints for affiliates to manage the inventory they want to sell and how they want to sell it. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [Channel manager](/channel-manager): The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties. ### Taxonomy APIs Taxonomy endpoints are for developers who want to consume and produce travel inventory and need taxonomies of standard and non-standard codes for inventory types, classes, statuses etc. - [Reference](/reference): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs Payment endpoints are for developers who want to purchase travel inventory. This can be done via the API as a registered Travel Agent or using our API in conjunction with our PCI compliant payment widget for all other entities. - [TripPay](/payment): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs We are actively working on supporting the most used languages out there. If you don't see your language here, reach out to us with a request to officially add your language. In the meantime, if you want to roll your own SDK, you can do so by downloading the OpenAPI spec and using one of the many available OpenAPI generators available: [https://openapi-generator.tech/docs/generators](https://openapi-generator.tech/docs/generators). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning We chose to version our endpoints in a way that we hope affects your integration minimally. You request the version of our API you wish to work with via the `Wink-Version` header. When it's time for you to upgrade, you only have to change the version number to get access to our updated endpoints. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
7
+
8
+ The version of the OpenAPI document: 30.29.0
9
+ Contact: bjorn@wink.travel
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+ import warnings
16
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
17
+ from typing import Any, Dict, List, Optional, Tuple, Union
18
+ from typing_extensions import Annotated
19
+
20
+ from pydantic import Field, StrictStr, field_validator
21
+ from typing import Optional
22
+ from typing_extensions import Annotated
23
+ from wink_sdk_travel_agent.models.booking_analytics_supplier import BookingAnalyticsSupplier
24
+ from wink_sdk_travel_agent.models.booking_overview_request_supplier import BookingOverviewRequestSupplier
25
+ from wink_sdk_travel_agent.models.grouped_booking_sales_metrics_supplier_details import GroupedBookingSalesMetricsSupplierDetails
26
+
27
+ from wink_sdk_travel_agent.api_client import ApiClient, RequestSerialized
28
+ from wink_sdk_travel_agent.api_response import ApiResponse
29
+ from wink_sdk_travel_agent.rest import RESTResponseType
30
+
31
+
32
+ class AnalyticsApi:
33
+ """NOTE: This class is auto generated by OpenAPI Generator
34
+ Ref: https://openapi-generator.tech
35
+
36
+ Do not edit the class manually.
37
+ """
38
+
39
+ def __init__(self, api_client=None) -> None:
40
+ if api_client is None:
41
+ api_client = ApiClient.get_default()
42
+ self.api_client = api_client
43
+
44
+
45
+ @validate_call
46
+ def show_affiliate_booking_analytics(
47
+ self,
48
+ company_identifier: Annotated[StrictStr, Field(description="Show active booking count for company with this identifier")],
49
+ booking_overview_request_supplier: Annotated[BookingOverviewRequestSupplier, Field(description="Overview request body")],
50
+ wink_version: Optional[StrictStr] = None,
51
+ _request_timeout: Union[
52
+ None,
53
+ Annotated[StrictFloat, Field(gt=0)],
54
+ Tuple[
55
+ Annotated[StrictFloat, Field(gt=0)],
56
+ Annotated[StrictFloat, Field(gt=0)]
57
+ ]
58
+ ] = None,
59
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
60
+ _content_type: Optional[StrictStr] = None,
61
+ _headers: Optional[Dict[StrictStr, Any]] = None,
62
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
63
+ ) -> BookingAnalyticsSupplier:
64
+ """Affiliate Booking Analytics
65
+
66
+ Retrieve the number of upcoming bookings that arrive today for the specific company.
67
+
68
+ :param company_identifier: Show active booking count for company with this identifier (required)
69
+ :type company_identifier: str
70
+ :param booking_overview_request_supplier: Overview request body (required)
71
+ :type booking_overview_request_supplier: BookingOverviewRequestSupplier
72
+ :param wink_version:
73
+ :type wink_version: str
74
+ :param _request_timeout: timeout setting for this request. If one
75
+ number provided, it will be total request
76
+ timeout. It can also be a pair (tuple) of
77
+ (connection, read) timeouts.
78
+ :type _request_timeout: int, tuple(int, int), optional
79
+ :param _request_auth: set to override the auth_settings for an a single
80
+ request; this effectively ignores the
81
+ authentication in the spec for a single request.
82
+ :type _request_auth: dict, optional
83
+ :param _content_type: force content-type for the request.
84
+ :type _content_type: str, Optional
85
+ :param _headers: set to override the headers for a single
86
+ request; this effectively ignores the headers
87
+ in the spec for a single request.
88
+ :type _headers: dict, optional
89
+ :param _host_index: set to override the host_index for a single
90
+ request; this effectively ignores the host_index
91
+ in the spec for a single request.
92
+ :type _host_index: int, optional
93
+ :return: Returns the result object.
94
+ """ # noqa: E501
95
+
96
+ _param = self._show_affiliate_booking_analytics_serialize(
97
+ company_identifier=company_identifier,
98
+ booking_overview_request_supplier=booking_overview_request_supplier,
99
+ wink_version=wink_version,
100
+ _request_auth=_request_auth,
101
+ _content_type=_content_type,
102
+ _headers=_headers,
103
+ _host_index=_host_index
104
+ )
105
+
106
+ _response_types_map: Dict[str, Optional[str]] = {
107
+ '403': "GenericErrorMessage",
108
+ '401': "GenericErrorMessage",
109
+ '400': "CreateAgentBooking400Response",
110
+ '500': "object",
111
+ '200': "BookingAnalyticsSupplier",
112
+ }
113
+ response_data = self.api_client.call_api(
114
+ *_param,
115
+ _request_timeout=_request_timeout
116
+ )
117
+ response_data.read()
118
+ return self.api_client.response_deserialize(
119
+ response_data=response_data,
120
+ response_types_map=_response_types_map,
121
+ ).data
122
+
123
+
124
+ @validate_call
125
+ def show_affiliate_booking_analytics_with_http_info(
126
+ self,
127
+ company_identifier: Annotated[StrictStr, Field(description="Show active booking count for company with this identifier")],
128
+ booking_overview_request_supplier: Annotated[BookingOverviewRequestSupplier, Field(description="Overview request body")],
129
+ wink_version: Optional[StrictStr] = None,
130
+ _request_timeout: Union[
131
+ None,
132
+ Annotated[StrictFloat, Field(gt=0)],
133
+ Tuple[
134
+ Annotated[StrictFloat, Field(gt=0)],
135
+ Annotated[StrictFloat, Field(gt=0)]
136
+ ]
137
+ ] = None,
138
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
139
+ _content_type: Optional[StrictStr] = None,
140
+ _headers: Optional[Dict[StrictStr, Any]] = None,
141
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
142
+ ) -> ApiResponse[BookingAnalyticsSupplier]:
143
+ """Affiliate Booking Analytics
144
+
145
+ Retrieve the number of upcoming bookings that arrive today for the specific company.
146
+
147
+ :param company_identifier: Show active booking count for company with this identifier (required)
148
+ :type company_identifier: str
149
+ :param booking_overview_request_supplier: Overview request body (required)
150
+ :type booking_overview_request_supplier: BookingOverviewRequestSupplier
151
+ :param wink_version:
152
+ :type wink_version: str
153
+ :param _request_timeout: timeout setting for this request. If one
154
+ number provided, it will be total request
155
+ timeout. It can also be a pair (tuple) of
156
+ (connection, read) timeouts.
157
+ :type _request_timeout: int, tuple(int, int), optional
158
+ :param _request_auth: set to override the auth_settings for an a single
159
+ request; this effectively ignores the
160
+ authentication in the spec for a single request.
161
+ :type _request_auth: dict, optional
162
+ :param _content_type: force content-type for the request.
163
+ :type _content_type: str, Optional
164
+ :param _headers: set to override the headers for a single
165
+ request; this effectively ignores the headers
166
+ in the spec for a single request.
167
+ :type _headers: dict, optional
168
+ :param _host_index: set to override the host_index for a single
169
+ request; this effectively ignores the host_index
170
+ in the spec for a single request.
171
+ :type _host_index: int, optional
172
+ :return: Returns the result object.
173
+ """ # noqa: E501
174
+
175
+ _param = self._show_affiliate_booking_analytics_serialize(
176
+ company_identifier=company_identifier,
177
+ booking_overview_request_supplier=booking_overview_request_supplier,
178
+ wink_version=wink_version,
179
+ _request_auth=_request_auth,
180
+ _content_type=_content_type,
181
+ _headers=_headers,
182
+ _host_index=_host_index
183
+ )
184
+
185
+ _response_types_map: Dict[str, Optional[str]] = {
186
+ '403': "GenericErrorMessage",
187
+ '401': "GenericErrorMessage",
188
+ '400': "CreateAgentBooking400Response",
189
+ '500': "object",
190
+ '200': "BookingAnalyticsSupplier",
191
+ }
192
+ response_data = self.api_client.call_api(
193
+ *_param,
194
+ _request_timeout=_request_timeout
195
+ )
196
+ response_data.read()
197
+ return self.api_client.response_deserialize(
198
+ response_data=response_data,
199
+ response_types_map=_response_types_map,
200
+ )
201
+
202
+
203
+ @validate_call
204
+ def show_affiliate_booking_analytics_without_preload_content(
205
+ self,
206
+ company_identifier: Annotated[StrictStr, Field(description="Show active booking count for company with this identifier")],
207
+ booking_overview_request_supplier: Annotated[BookingOverviewRequestSupplier, Field(description="Overview request body")],
208
+ wink_version: Optional[StrictStr] = None,
209
+ _request_timeout: Union[
210
+ None,
211
+ Annotated[StrictFloat, Field(gt=0)],
212
+ Tuple[
213
+ Annotated[StrictFloat, Field(gt=0)],
214
+ Annotated[StrictFloat, Field(gt=0)]
215
+ ]
216
+ ] = None,
217
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
218
+ _content_type: Optional[StrictStr] = None,
219
+ _headers: Optional[Dict[StrictStr, Any]] = None,
220
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
221
+ ) -> RESTResponseType:
222
+ """Affiliate Booking Analytics
223
+
224
+ Retrieve the number of upcoming bookings that arrive today for the specific company.
225
+
226
+ :param company_identifier: Show active booking count for company with this identifier (required)
227
+ :type company_identifier: str
228
+ :param booking_overview_request_supplier: Overview request body (required)
229
+ :type booking_overview_request_supplier: BookingOverviewRequestSupplier
230
+ :param wink_version:
231
+ :type wink_version: str
232
+ :param _request_timeout: timeout setting for this request. If one
233
+ number provided, it will be total request
234
+ timeout. It can also be a pair (tuple) of
235
+ (connection, read) timeouts.
236
+ :type _request_timeout: int, tuple(int, int), optional
237
+ :param _request_auth: set to override the auth_settings for an a single
238
+ request; this effectively ignores the
239
+ authentication in the spec for a single request.
240
+ :type _request_auth: dict, optional
241
+ :param _content_type: force content-type for the request.
242
+ :type _content_type: str, Optional
243
+ :param _headers: set to override the headers for a single
244
+ request; this effectively ignores the headers
245
+ in the spec for a single request.
246
+ :type _headers: dict, optional
247
+ :param _host_index: set to override the host_index for a single
248
+ request; this effectively ignores the host_index
249
+ in the spec for a single request.
250
+ :type _host_index: int, optional
251
+ :return: Returns the result object.
252
+ """ # noqa: E501
253
+
254
+ _param = self._show_affiliate_booking_analytics_serialize(
255
+ company_identifier=company_identifier,
256
+ booking_overview_request_supplier=booking_overview_request_supplier,
257
+ wink_version=wink_version,
258
+ _request_auth=_request_auth,
259
+ _content_type=_content_type,
260
+ _headers=_headers,
261
+ _host_index=_host_index
262
+ )
263
+
264
+ _response_types_map: Dict[str, Optional[str]] = {
265
+ '403': "GenericErrorMessage",
266
+ '401': "GenericErrorMessage",
267
+ '400': "CreateAgentBooking400Response",
268
+ '500': "object",
269
+ '200': "BookingAnalyticsSupplier",
270
+ }
271
+ response_data = self.api_client.call_api(
272
+ *_param,
273
+ _request_timeout=_request_timeout
274
+ )
275
+ return response_data.response
276
+
277
+
278
+ def _show_affiliate_booking_analytics_serialize(
279
+ self,
280
+ company_identifier,
281
+ booking_overview_request_supplier,
282
+ wink_version,
283
+ _request_auth,
284
+ _content_type,
285
+ _headers,
286
+ _host_index,
287
+ ) -> RequestSerialized:
288
+
289
+ _host = None
290
+
291
+ _collection_formats: Dict[str, str] = {
292
+ }
293
+
294
+ _path_params: Dict[str, str] = {}
295
+ _query_params: List[Tuple[str, str]] = []
296
+ _header_params: Dict[str, Optional[str]] = _headers or {}
297
+ _form_params: List[Tuple[str, str]] = []
298
+ _files: Dict[
299
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
300
+ ] = {}
301
+ _body_params: Optional[bytes] = None
302
+
303
+ # process the path parameters
304
+ if company_identifier is not None:
305
+ _path_params['companyIdentifier'] = company_identifier
306
+ # process the query parameters
307
+ # process the header parameters
308
+ if wink_version is not None:
309
+ _header_params['Wink-Version'] = wink_version
310
+ # process the form parameters
311
+ # process the body parameter
312
+ if booking_overview_request_supplier is not None:
313
+ _body_params = booking_overview_request_supplier
314
+
315
+
316
+ # set the HTTP header `Accept`
317
+ if 'Accept' not in _header_params:
318
+ _header_params['Accept'] = self.api_client.select_header_accept(
319
+ [
320
+ '*/*',
321
+ 'application/json',
322
+ 'application/xml',
323
+ 'text/xml',
324
+ 'text/plain',
325
+ 'text/html'
326
+ ]
327
+ )
328
+
329
+ # set the HTTP header `Content-Type`
330
+ if _content_type:
331
+ _header_params['Content-Type'] = _content_type
332
+ else:
333
+ _default_content_type = (
334
+ self.api_client.select_header_content_type(
335
+ [
336
+ 'application/json'
337
+ ]
338
+ )
339
+ )
340
+ if _default_content_type is not None:
341
+ _header_params['Content-Type'] = _default_content_type
342
+
343
+ # authentication setting
344
+ _auth_settings: List[str] = [
345
+ 'oauth2ClientCredentials'
346
+ ]
347
+
348
+ return self.api_client.param_serialize(
349
+ method='POST',
350
+ resource_path='/api/affiliate/{companyIdentifier}/booking/analytics',
351
+ path_params=_path_params,
352
+ query_params=_query_params,
353
+ header_params=_header_params,
354
+ body=_body_params,
355
+ post_params=_form_params,
356
+ files=_files,
357
+ auth_settings=_auth_settings,
358
+ collection_formats=_collection_formats,
359
+ _host=_host,
360
+ _request_auth=_request_auth
361
+ )
362
+
363
+
364
+
365
+
366
+ @validate_call
367
+ def show_booking_overview(
368
+ self,
369
+ company_identifier: Annotated[StrictStr, Field(description="Show booking owned by this company")],
370
+ wink_version: Optional[StrictStr] = None,
371
+ accept: Optional[StrictStr] = None,
372
+ _request_timeout: Union[
373
+ None,
374
+ Annotated[StrictFloat, Field(gt=0)],
375
+ Tuple[
376
+ Annotated[StrictFloat, Field(gt=0)],
377
+ Annotated[StrictFloat, Field(gt=0)]
378
+ ]
379
+ ] = None,
380
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
381
+ _content_type: Optional[StrictStr] = None,
382
+ _headers: Optional[Dict[StrictStr, Any]] = None,
383
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
384
+ ) -> GroupedBookingSalesMetricsSupplierDetails:
385
+ """Affiliate Booking Overview
386
+
387
+ Basic booking overview data
388
+
389
+ :param company_identifier: Show booking owned by this company (required)
390
+ :type company_identifier: str
391
+ :param wink_version:
392
+ :type wink_version: str
393
+ :param accept:
394
+ :type accept: str
395
+ :param _request_timeout: timeout setting for this request. If one
396
+ number provided, it will be total request
397
+ timeout. It can also be a pair (tuple) of
398
+ (connection, read) timeouts.
399
+ :type _request_timeout: int, tuple(int, int), optional
400
+ :param _request_auth: set to override the auth_settings for an a single
401
+ request; this effectively ignores the
402
+ authentication in the spec for a single request.
403
+ :type _request_auth: dict, optional
404
+ :param _content_type: force content-type for the request.
405
+ :type _content_type: str, Optional
406
+ :param _headers: set to override the headers for a single
407
+ request; this effectively ignores the headers
408
+ in the spec for a single request.
409
+ :type _headers: dict, optional
410
+ :param _host_index: set to override the host_index for a single
411
+ request; this effectively ignores the host_index
412
+ in the spec for a single request.
413
+ :type _host_index: int, optional
414
+ :return: Returns the result object.
415
+ """ # noqa: E501
416
+
417
+ _param = self._show_booking_overview_serialize(
418
+ company_identifier=company_identifier,
419
+ wink_version=wink_version,
420
+ accept=accept,
421
+ _request_auth=_request_auth,
422
+ _content_type=_content_type,
423
+ _headers=_headers,
424
+ _host_index=_host_index
425
+ )
426
+
427
+ _response_types_map: Dict[str, Optional[str]] = {
428
+ '403': "GenericErrorMessage",
429
+ '401': "GenericErrorMessage",
430
+ '400': "CreateAgentBooking400Response",
431
+ '500': "object",
432
+ '200': "GroupedBookingSalesMetricsSupplierDetails",
433
+ }
434
+ response_data = self.api_client.call_api(
435
+ *_param,
436
+ _request_timeout=_request_timeout
437
+ )
438
+ response_data.read()
439
+ return self.api_client.response_deserialize(
440
+ response_data=response_data,
441
+ response_types_map=_response_types_map,
442
+ ).data
443
+
444
+
445
+ @validate_call
446
+ def show_booking_overview_with_http_info(
447
+ self,
448
+ company_identifier: Annotated[StrictStr, Field(description="Show booking owned by this company")],
449
+ wink_version: Optional[StrictStr] = None,
450
+ accept: Optional[StrictStr] = None,
451
+ _request_timeout: Union[
452
+ None,
453
+ Annotated[StrictFloat, Field(gt=0)],
454
+ Tuple[
455
+ Annotated[StrictFloat, Field(gt=0)],
456
+ Annotated[StrictFloat, Field(gt=0)]
457
+ ]
458
+ ] = None,
459
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
460
+ _content_type: Optional[StrictStr] = None,
461
+ _headers: Optional[Dict[StrictStr, Any]] = None,
462
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
463
+ ) -> ApiResponse[GroupedBookingSalesMetricsSupplierDetails]:
464
+ """Affiliate Booking Overview
465
+
466
+ Basic booking overview data
467
+
468
+ :param company_identifier: Show booking owned by this company (required)
469
+ :type company_identifier: str
470
+ :param wink_version:
471
+ :type wink_version: str
472
+ :param accept:
473
+ :type accept: str
474
+ :param _request_timeout: timeout setting for this request. If one
475
+ number provided, it will be total request
476
+ timeout. It can also be a pair (tuple) of
477
+ (connection, read) timeouts.
478
+ :type _request_timeout: int, tuple(int, int), optional
479
+ :param _request_auth: set to override the auth_settings for an a single
480
+ request; this effectively ignores the
481
+ authentication in the spec for a single request.
482
+ :type _request_auth: dict, optional
483
+ :param _content_type: force content-type for the request.
484
+ :type _content_type: str, Optional
485
+ :param _headers: set to override the headers for a single
486
+ request; this effectively ignores the headers
487
+ in the spec for a single request.
488
+ :type _headers: dict, optional
489
+ :param _host_index: set to override the host_index for a single
490
+ request; this effectively ignores the host_index
491
+ in the spec for a single request.
492
+ :type _host_index: int, optional
493
+ :return: Returns the result object.
494
+ """ # noqa: E501
495
+
496
+ _param = self._show_booking_overview_serialize(
497
+ company_identifier=company_identifier,
498
+ wink_version=wink_version,
499
+ accept=accept,
500
+ _request_auth=_request_auth,
501
+ _content_type=_content_type,
502
+ _headers=_headers,
503
+ _host_index=_host_index
504
+ )
505
+
506
+ _response_types_map: Dict[str, Optional[str]] = {
507
+ '403': "GenericErrorMessage",
508
+ '401': "GenericErrorMessage",
509
+ '400': "CreateAgentBooking400Response",
510
+ '500': "object",
511
+ '200': "GroupedBookingSalesMetricsSupplierDetails",
512
+ }
513
+ response_data = self.api_client.call_api(
514
+ *_param,
515
+ _request_timeout=_request_timeout
516
+ )
517
+ response_data.read()
518
+ return self.api_client.response_deserialize(
519
+ response_data=response_data,
520
+ response_types_map=_response_types_map,
521
+ )
522
+
523
+
524
+ @validate_call
525
+ def show_booking_overview_without_preload_content(
526
+ self,
527
+ company_identifier: Annotated[StrictStr, Field(description="Show booking owned by this company")],
528
+ wink_version: Optional[StrictStr] = None,
529
+ accept: Optional[StrictStr] = None,
530
+ _request_timeout: Union[
531
+ None,
532
+ Annotated[StrictFloat, Field(gt=0)],
533
+ Tuple[
534
+ Annotated[StrictFloat, Field(gt=0)],
535
+ Annotated[StrictFloat, Field(gt=0)]
536
+ ]
537
+ ] = None,
538
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
539
+ _content_type: Optional[StrictStr] = None,
540
+ _headers: Optional[Dict[StrictStr, Any]] = None,
541
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
542
+ ) -> RESTResponseType:
543
+ """Affiliate Booking Overview
544
+
545
+ Basic booking overview data
546
+
547
+ :param company_identifier: Show booking owned by this company (required)
548
+ :type company_identifier: str
549
+ :param wink_version:
550
+ :type wink_version: str
551
+ :param accept:
552
+ :type accept: str
553
+ :param _request_timeout: timeout setting for this request. If one
554
+ number provided, it will be total request
555
+ timeout. It can also be a pair (tuple) of
556
+ (connection, read) timeouts.
557
+ :type _request_timeout: int, tuple(int, int), optional
558
+ :param _request_auth: set to override the auth_settings for an a single
559
+ request; this effectively ignores the
560
+ authentication in the spec for a single request.
561
+ :type _request_auth: dict, optional
562
+ :param _content_type: force content-type for the request.
563
+ :type _content_type: str, Optional
564
+ :param _headers: set to override the headers for a single
565
+ request; this effectively ignores the headers
566
+ in the spec for a single request.
567
+ :type _headers: dict, optional
568
+ :param _host_index: set to override the host_index for a single
569
+ request; this effectively ignores the host_index
570
+ in the spec for a single request.
571
+ :type _host_index: int, optional
572
+ :return: Returns the result object.
573
+ """ # noqa: E501
574
+
575
+ _param = self._show_booking_overview_serialize(
576
+ company_identifier=company_identifier,
577
+ wink_version=wink_version,
578
+ accept=accept,
579
+ _request_auth=_request_auth,
580
+ _content_type=_content_type,
581
+ _headers=_headers,
582
+ _host_index=_host_index
583
+ )
584
+
585
+ _response_types_map: Dict[str, Optional[str]] = {
586
+ '403': "GenericErrorMessage",
587
+ '401': "GenericErrorMessage",
588
+ '400': "CreateAgentBooking400Response",
589
+ '500': "object",
590
+ '200': "GroupedBookingSalesMetricsSupplierDetails",
591
+ }
592
+ response_data = self.api_client.call_api(
593
+ *_param,
594
+ _request_timeout=_request_timeout
595
+ )
596
+ return response_data.response
597
+
598
+
599
+ def _show_booking_overview_serialize(
600
+ self,
601
+ company_identifier,
602
+ wink_version,
603
+ accept,
604
+ _request_auth,
605
+ _content_type,
606
+ _headers,
607
+ _host_index,
608
+ ) -> RequestSerialized:
609
+
610
+ _host = None
611
+
612
+ _collection_formats: Dict[str, str] = {
613
+ }
614
+
615
+ _path_params: Dict[str, str] = {}
616
+ _query_params: List[Tuple[str, str]] = []
617
+ _header_params: Dict[str, Optional[str]] = _headers or {}
618
+ _form_params: List[Tuple[str, str]] = []
619
+ _files: Dict[
620
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
621
+ ] = {}
622
+ _body_params: Optional[bytes] = None
623
+
624
+ # process the path parameters
625
+ if company_identifier is not None:
626
+ _path_params['companyIdentifier'] = company_identifier
627
+ # process the query parameters
628
+ # process the header parameters
629
+ if wink_version is not None:
630
+ _header_params['Wink-Version'] = wink_version
631
+ if accept is not None:
632
+ _header_params['Accept'] = accept
633
+ # process the form parameters
634
+ # process the body parameter
635
+
636
+
637
+ # set the HTTP header `Accept`
638
+ if 'Accept' not in _header_params:
639
+ _header_params['Accept'] = self.api_client.select_header_accept(
640
+ [
641
+ '*/*',
642
+ 'application/json',
643
+ 'application/xml',
644
+ 'text/xml',
645
+ 'text/plain',
646
+ 'text/html'
647
+ ]
648
+ )
649
+
650
+
651
+ # authentication setting
652
+ _auth_settings: List[str] = [
653
+ 'oauth2ClientCredentials'
654
+ ]
655
+
656
+ return self.api_client.param_serialize(
657
+ method='GET',
658
+ resource_path='/api/affiliate/{companyIdentifier}/booking/overview',
659
+ path_params=_path_params,
660
+ query_params=_query_params,
661
+ header_params=_header_params,
662
+ body=_body_params,
663
+ post_params=_form_params,
664
+ files=_files,
665
+ auth_settings=_auth_settings,
666
+ collection_formats=_collection_formats,
667
+ _host=_host,
668
+ _request_auth=_request_auth
669
+ )
670
+
671
+