wink-sdk-travel-agent 0.0.25__py3-none-any.whl → 0.0.27__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.
- wink_sdk_travel_agent/__init__.py +17 -28
- wink_sdk_travel_agent/api/travel_agent_api.py +29 -29
- wink_sdk_travel_agent/api_client.py +2 -2
- wink_sdk_travel_agent/configuration.py +4 -4
- wink_sdk_travel_agent/exceptions.py +2 -2
- wink_sdk_travel_agent/models/__init__.py +16 -27
- wink_sdk_travel_agent/models/address_agent.py +7 -6
- wink_sdk_travel_agent/models/affiliate_account_agent.py +179 -0
- wink_sdk_travel_agent/models/affiliate_account_user_agent.py +115 -0
- wink_sdk_travel_agent/models/agent_booking_request_agent.py +13 -28
- wink_sdk_travel_agent/models/aggregate_descriptor_agent.py +3 -3
- wink_sdk_travel_agent/models/authenticated_user_agent.py +7 -6
- wink_sdk_travel_agent/models/bed_agent.py +4 -4
- wink_sdk_travel_agent/models/bedroom_agent.py +4 -3
- wink_sdk_travel_agent/models/bedroom_configuration_agent.py +8 -7
- wink_sdk_travel_agent/models/beneficiary_agent.py +13 -21
- wink_sdk_travel_agent/models/beneficiary_charge_agent.py +2 -2
- wink_sdk_travel_agent/models/booking_agent.py +63 -100
- wink_sdk_travel_agent/models/booking_ancillary_agent.py +16 -15
- wink_sdk_travel_agent/models/booking_confirmations_agent.py +6 -14
- wink_sdk_travel_agent/models/booking_contract_agent.py +112 -112
- wink_sdk_travel_agent/models/booking_contract_item_agent.py +17 -25
- wink_sdk_travel_agent/models/booking_contract_payment_details_agent.py +10 -17
- wink_sdk_travel_agent/models/booking_itinerary_agent.py +3 -3
- wink_sdk_travel_agent/models/booking_itinerary_room_configuration_agent.py +4 -4
- wink_sdk_travel_agent/models/booking_itinerary_room_configuration_child_agent.py +2 -2
- wink_sdk_travel_agent/models/booking_user_agent.py +7 -6
- wink_sdk_travel_agent/models/booking_user_request_agent.py +3 -3
- wink_sdk_travel_agent/models/booking_user_session_agent.py +4 -4
- wink_sdk_travel_agent/models/boolean_response_agent.py +2 -2
- wink_sdk_travel_agent/models/cancellation_detail_agent.py +4 -3
- wink_sdk_travel_agent/models/cancellation_policy_exception_agent.py +8 -7
- wink_sdk_travel_agent/models/cancellation_policy_exceptions_agent.py +5 -4
- wink_sdk_travel_agent/models/cancellation_policy_lightweight_agent.py +166 -0
- wink_sdk_travel_agent/models/child_agent.py +2 -2
- wink_sdk_travel_agent/models/commissionable_entry_agent.py +6 -5
- wink_sdk_travel_agent/models/composite_filter_descriptor_agent.py +3 -3
- wink_sdk_travel_agent/models/contact_agent.py +3 -3
- wink_sdk_travel_agent/models/country_lightweight_agent.py +100 -0
- wink_sdk_travel_agent/models/create_agent_booking400_response.py +3 -3
- wink_sdk_travel_agent/models/create_agent_booking_request_agent.py +7 -6
- wink_sdk_travel_agent/models/custom_monetary_amount.py +5 -4
- wink_sdk_travel_agent/models/customization_lightweight_agent.py +231 -0
- wink_sdk_travel_agent/models/customization_theme_colors_agent.py +108 -0
- wink_sdk_travel_agent/models/extra_charge_agent.py +6 -6
- wink_sdk_travel_agent/models/extra_charges_agent.py +3 -3
- wink_sdk_travel_agent/models/filter_descriptor_agent.py +11 -5
- wink_sdk_travel_agent/models/general_manager_agent.py +4 -4
- wink_sdk_travel_agent/models/generic_error_message.py +2 -2
- wink_sdk_travel_agent/models/geo_json_point_agent.py +3 -3
- wink_sdk_travel_agent/models/geo_name_lightweight_agent.py +136 -0
- wink_sdk_travel_agent/models/group_descriptor_agent.py +3 -3
- wink_sdk_travel_agent/models/guest_room_lightweight_agent.py +22 -22
- wink_sdk_travel_agent/models/guest_user_agent.py +9 -8
- wink_sdk_travel_agent/models/image_attribution_agent.py +5 -4
- wink_sdk_travel_agent/models/localized_description_agent.py +25 -7
- wink_sdk_travel_agent/models/localized_price_agent.py +15 -15
- wink_sdk_travel_agent/models/managed_by_entity_agent.py +8 -7
- wink_sdk_travel_agent/models/managed_by_entity_rules_agent.py +3 -3
- wink_sdk_travel_agent/models/page_booking_agent.py +124 -0
- wink_sdk_travel_agent/models/pageable_object_agent.py +6 -6
- wink_sdk_travel_agent/models/payout_agent.py +10 -9
- wink_sdk_travel_agent/models/payout_fee_agent.py +7 -6
- wink_sdk_travel_agent/models/perk_lightweight_agent.py +7 -6
- wink_sdk_travel_agent/models/personal_agent.py +8 -24
- wink_sdk_travel_agent/models/preferences_agent.py +13 -13
- wink_sdk_travel_agent/models/profile_lightweight_agent.py +111 -0
- wink_sdk_travel_agent/models/profile_user_agent.py +3 -3
- wink_sdk_travel_agent/models/property_aggregate_lightweight_agent.py +242 -0
- wink_sdk_travel_agent/models/property_policy_agent.py +6 -5
- wink_sdk_travel_agent/models/quote_lightweight_agent.py +95 -0
- wink_sdk_travel_agent/models/rate_plan_level_fee_agent.py +6 -5
- wink_sdk_travel_agent/models/refund_agent.py +6 -5
- wink_sdk_travel_agent/models/review_answer_agent.py +4 -3
- wink_sdk_travel_agent/models/review_lightweight_agent.py +133 -0
- wink_sdk_travel_agent/models/review_user_agent.py +3 -3
- wink_sdk_travel_agent/models/room_configuration_agent.py +3 -3
- wink_sdk_travel_agent/models/room_configuration_price_rate_plan_agent.py +23 -12
- wink_sdk_travel_agent/models/room_stay_agent.py +19 -18
- wink_sdk_travel_agent/models/simple_address_agent.py +12 -7
- wink_sdk_travel_agent/models/simple_date_time_itinerary_agent.py +7 -7
- wink_sdk_travel_agent/models/simple_description_agent.py +25 -7
- wink_sdk_travel_agent/models/simple_multimedia_agent.py +5 -5
- wink_sdk_travel_agent/models/social_agent.py +2 -2
- wink_sdk_travel_agent/models/sort_descriptor_agent.py +3 -3
- wink_sdk_travel_agent/models/sort_object_agent.py +2 -2
- wink_sdk_travel_agent/models/state_agent.py +3 -3
- wink_sdk_travel_agent/models/stay_rate_agent.py +16 -16
- wink_sdk_travel_agent/models/sub_country_lightweight_agent.py +92 -0
- wink_sdk_travel_agent/models/sub_sub_country_lightweight_agent.py +92 -0
- wink_sdk_travel_agent/models/supplier_contract_item_policy_agent.py +2 -2
- wink_sdk_travel_agent/models/travel_agent_agent.py +3 -3
- wink_sdk_travel_agent/models/travel_inventory_recognition_agent.py +4 -4
- wink_sdk_travel_agent/models/upsert_travel_agent_request_agent.py +2 -2
- wink_sdk_travel_agent/rest.py +2 -2
- {wink_sdk_travel_agent-0.0.25.dist-info → wink_sdk_travel_agent-0.0.27.dist-info}/METADATA +20 -31
- wink_sdk_travel_agent-0.0.27.dist-info/RECORD +133 -0
- {wink_sdk_travel_agent-0.0.25.dist-info → wink_sdk_travel_agent-0.0.27.dist-info}/WHEEL +1 -1
- wink_sdk_travel_agent-0.0.25.dist-info/RECORD +0 -119
- {wink_sdk_travel_agent-0.0.25.dist-info → wink_sdk_travel_agent-0.0.27.dist-info}/licenses/LICENSE +0 -0
- {wink_sdk_travel_agent-0.0.25.dist-info → wink_sdk_travel_agent-0.0.27.dist-info}/top_level.txt +0 -0
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"""
|
|
4
4
|
Wink API
|
|
5
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](/
|
|
6
|
+
# Introduction Welcome to the Wink API - A programmer-friendly way to manage, sell and book travel inventory on the Wink platform. The API gives you all the tools you need to ready your properties and inventory for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel inventory and promote / sell it in a wide variety of ways. # Integrations We have already integrated with the most well-known channel managers so you don't have to. To see our current integrations, please go to https://extranet.wink.travel and scroll to Connectivity section. Once your properties are set up, you can finish the setup by mapping your property to Wink using your channel manager partner portal. If your properties don't have a channel manager, you can easily manage rates and availability with this API. # Intended Audience Programmers are [most likely] a requirement to start integrating with Wink. Companies and organizations that would most benefit from integrating with us are new and existing travel companies that have relationships with suppliers and that need an advanced system from which to manage their travel inventory and get that same inventory out to as many eyeballs as possible at the lowest price possible. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume endpoints are for developers who want to find existing travel inventory and either book it or use it to advertise through one of their Wink affiliate accounts. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [Inventory](/affiliate/inventory): The Inventory API exposes endpoints for affiliates to manage the inventory they want to sell and how they want to sell it. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [Channel manager](/channel-manager): The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties. ### Taxonomy APIs Taxonomy endpoints are for developers who want to consume and produce travel inventory and need taxonomies of standard and non-standard codes for inventory types, classes, statuses etc. - [Reference](/reactive): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs Payment endpoints are for developers who want to purchase travel inventory. This can be done via the API as a registered Travel Agent or using our API in conjunction with our PCI compliant reactive widget for all other entities. - [TripPay](/reactive): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs We are actively working on supporting the most used languages out there. If you don't see your language here, reach out to us with a request to officially add your language. In the meantime, if you want to roll your own SDK, you can do so by downloading the OpenAPI spec and using one of the many available OpenAPI generators available: [https://openapi-generator.tech/docs/generators](https://openapi-generator.tech/docs/generators). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning We chose to version our endpoints in a way that we hope affects your integration minimally. You request the version of our API you wish to work with via the `Wink-Version` header. When it's time for you to upgrade, you only have to change the version number to get access to our updated endpoints. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 30.
|
|
8
|
+
The version of the OpenAPI document: 30.17.2
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -28,36 +28,36 @@ from wink_sdk_travel_agent.models.booking_contract_item_agent import BookingCont
|
|
|
28
28
|
from wink_sdk_travel_agent.models.booking_contract_payment_details_agent import BookingContractPaymentDetailsAgent
|
|
29
29
|
from wink_sdk_travel_agent.models.custom_monetary_amount import CustomMonetaryAmount
|
|
30
30
|
from wink_sdk_travel_agent.models.payout_agent import PayoutAgent
|
|
31
|
-
from wink_sdk_travel_agent.models.
|
|
31
|
+
from wink_sdk_travel_agent.models.quote_lightweight_agent import QuoteLightweightAgent
|
|
32
32
|
from wink_sdk_travel_agent.models.refund_agent import RefundAgent
|
|
33
33
|
from typing import Optional, Set
|
|
34
34
|
from typing_extensions import Self
|
|
35
35
|
|
|
36
36
|
class BookingContractAgent(BaseModel):
|
|
37
37
|
"""
|
|
38
|
-
|
|
38
|
+
BookingContractAgent
|
|
39
39
|
""" # noqa: E501
|
|
40
40
|
booking_contract_identifier: Optional[StrictStr] = Field(default=None, description="Document UUID", alias="bookingContractIdentifier")
|
|
41
41
|
created_date: Optional[datetime] = Field(default=None, description="Datetime this record was first created", alias="createdDate")
|
|
42
42
|
last_update: Optional[datetime] = Field(default=None, description="Datetime this record was last updated", alias="lastUpdate")
|
|
43
|
-
federated_organization_identifier:
|
|
44
|
-
federated_organization_name:
|
|
45
|
-
user: AuthenticatedUserAgent
|
|
46
|
-
ip_address:
|
|
47
|
-
trace_id:
|
|
48
|
-
source_url:
|
|
49
|
-
identifier:
|
|
50
|
-
supplier_identifier:
|
|
51
|
-
supplier_name:
|
|
52
|
-
display_price_quote:
|
|
53
|
-
supplier_price_quote:
|
|
54
|
-
internal_price_quote:
|
|
55
|
-
capture_price_quote:
|
|
43
|
+
federated_organization_identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The auth realm owner ID", alias="federatedOrganizationIdentifier")
|
|
44
|
+
federated_organization_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The auth realm owner name", alias="federatedOrganizationName")
|
|
45
|
+
user: AuthenticatedUserAgent = Field(description="The authenticated user ID that made the request")
|
|
46
|
+
ip_address: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Caller's IP address", alias="ipAddress")
|
|
47
|
+
trace_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Way to track which booking contracts were made together", alias="traceId")
|
|
48
|
+
source_url: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Where did the booking occur", alias="sourceUrl")
|
|
49
|
+
identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Unique identifier used to track the contract. Create a UUID for this purpose.")
|
|
50
|
+
supplier_identifier: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Supplier identifier", alias="supplierIdentifier")
|
|
51
|
+
supplier_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Supplier name", alias="supplierName")
|
|
52
|
+
display_price_quote: QuoteLightweightAgent = Field(description="The quote used to create totalDisplayPrice.", alias="displayPriceQuote")
|
|
53
|
+
supplier_price_quote: QuoteLightweightAgent = Field(description="The quote used to create totalSupplierPrice.", alias="supplierPriceQuote")
|
|
54
|
+
internal_price_quote: QuoteLightweightAgent = Field(description="The quote used to create totalInternalPrice.", alias="internalPriceQuote")
|
|
55
|
+
capture_price_quote: QuoteLightweightAgent = Field(description="The quote used to create totalCapturePrice.", alias="capturePriceQuote")
|
|
56
56
|
item_list: Annotated[List[BookingContractItemAgent], Field(min_length=1, max_length=2147483647)] = Field(description="Holds one booking line item for a specific supplier.", alias="itemList")
|
|
57
57
|
external_supplier_identifier: Optional[StrictStr] = Field(default=None, description="Contract creator can choose to geoname this record with her own identifier", alias="externalSupplierIdentifier")
|
|
58
58
|
external_supplier_booking_code: Optional[StrictStr] = Field(default=None, description="External booking code generated by the affiliate", alias="externalSupplierBookingCode")
|
|
59
|
-
payment: BookingContractPaymentDetailsAgent
|
|
60
|
-
cancelled:
|
|
59
|
+
payment: BookingContractPaymentDetailsAgent = Field(description="Payment details the merchant provided us at the time of payment.")
|
|
60
|
+
cancelled: StrictBool = Field(description="Optional geoname externalIdentifier to remote inventory.")
|
|
61
61
|
cancelled_on: Optional[datetime] = Field(default=None, description="When the booking was cancelled.", alias="cancelledOn")
|
|
62
62
|
canceller: Optional[StrictStr] = Field(default=None, description="Type of entity that cancelled the booking.")
|
|
63
63
|
cancellation_type: Optional[StrictStr] = Field(default=None, description="Reason type.", alias="cancellationType")
|
|
@@ -66,11 +66,11 @@ class BookingContractAgent(BaseModel):
|
|
|
66
66
|
funds_processed: Optional[StrictBool] = Field(default=None, description="Whether a funds transfer request has been created for this booking.", alias="fundsProcessed")
|
|
67
67
|
refunds: Optional[List[RefundAgent]] = Field(default=None, description="An optional list of refunds that occurred with this booking. If the refund amount(s) is the same as the total price, the booking also gets cancelled.")
|
|
68
68
|
payouts: Optional[List[PayoutAgent]] = Field(default=None, description="An optional list of refunds that occurred with this booking. If the refund amount(s) is the same as the total price, the booking also gets cancelled.")
|
|
69
|
-
source_currency:
|
|
70
|
-
display_currency:
|
|
71
|
-
supplier_currency:
|
|
72
|
-
internal_currency:
|
|
73
|
-
capture_currency:
|
|
69
|
+
source_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The source currency", alias="sourceCurrency")
|
|
70
|
+
display_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The display currency", alias="displayCurrency")
|
|
71
|
+
supplier_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The supplier currency", alias="supplierCurrency")
|
|
72
|
+
internal_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The internal currency", alias="internalCurrency")
|
|
73
|
+
capture_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The capture currency", alias="captureCurrency")
|
|
74
74
|
source_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="The total initial price as quoted in the original TripPay contract.", alias="sourceAmount")
|
|
75
75
|
display_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="The total display price.", alias="displayAmount")
|
|
76
76
|
supplier_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="The total supplier price.", alias="supplierAmount")
|
|
@@ -87,56 +87,56 @@ class BookingContractAgent(BaseModel):
|
|
|
87
87
|
net_internal_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="netInternalAmount")
|
|
88
88
|
net_capture_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The total capture price.", alias="netCaptureAmount")
|
|
89
89
|
metadata: Optional[Dict[str, StrictStr]] = Field(default=None, description="Place to add more data related to the booking contract.")
|
|
90
|
-
net_commissionable_total_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netCommissionableTotalSourceAmount")
|
|
91
|
-
net_commissionable_total_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netCommissionableTotalCaptureAmount")
|
|
92
|
-
net_commissionable_total_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netCommissionableTotalDisplayAmount")
|
|
93
|
-
net_commissionable_total_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netCommissionableTotalSupplierAmount")
|
|
94
|
-
net_commissionable_total_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netCommissionableTotalInternalAmount")
|
|
95
|
-
net_total_fees_and_commissions_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesAndCommissionsSourceAmount")
|
|
96
|
-
net_total_fees_and_commissions_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesAndCommissionsCaptureAmount")
|
|
97
|
-
net_total_fees_and_commissions_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesAndCommissionsDisplayAmount")
|
|
98
|
-
net_total_fees_and_commissions_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesAndCommissionsSupplierAmount")
|
|
99
|
-
net_total_fees_and_commissions_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesAndCommissionsInternalAmount")
|
|
100
|
-
net_total_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesSourceAmount")
|
|
101
|
-
net_total_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesCaptureAmount")
|
|
102
|
-
net_total_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesDisplayAmount")
|
|
103
|
-
net_total_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesSupplierAmount")
|
|
104
|
-
net_total_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalFeesInternalAmount")
|
|
105
|
-
net_total_trip_pay_fee_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalTripPayFeeSourceAmount")
|
|
106
|
-
net_total_trip_pay_fee_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalTripPayFeeCaptureAmount")
|
|
107
|
-
net_total_trip_pay_fee_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalTripPayFeeDisplayAmount")
|
|
108
|
-
net_total_trip_pay_fee_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalTripPayFeeSupplierAmount")
|
|
109
|
-
net_total_trip_pay_fee_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalTripPayFeeInternalAmount")
|
|
110
|
-
net_total_sales_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSalesSourceAmount")
|
|
111
|
-
net_total_sales_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSalesCaptureAmount")
|
|
112
|
-
net_total_sales_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSalesDisplayAmount")
|
|
113
|
-
net_total_sales_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSalesSupplierAmount")
|
|
114
|
-
net_total_sales_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSalesInternalAmount")
|
|
115
|
-
commissionable_total_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="commissionableTotalSourceAmount")
|
|
116
|
-
commissionable_total_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="commissionableTotalCaptureAmount")
|
|
117
|
-
commissionable_total_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="commissionableTotalDisplayAmount")
|
|
118
|
-
commissionable_total_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="commissionableTotalSupplierAmount")
|
|
119
|
-
commissionable_total_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="commissionableTotalInternalAmount")
|
|
120
|
-
total_fees_and_commissions_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesAndCommissionsSourceAmount")
|
|
121
|
-
total_fees_and_commissions_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesAndCommissionsCaptureAmount")
|
|
122
|
-
total_fees_and_commissions_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesAndCommissionsDisplayAmount")
|
|
123
|
-
total_fees_and_commissions_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesAndCommissionsSupplierAmount")
|
|
124
|
-
total_fees_and_commissions_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesAndCommissionsInternalAmount")
|
|
125
|
-
total_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesSourceAmount")
|
|
126
|
-
total_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesCaptureAmount")
|
|
127
|
-
total_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesDisplayAmount")
|
|
128
|
-
total_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesSupplierAmount")
|
|
129
|
-
total_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalFeesInternalAmount")
|
|
130
|
-
total_trip_pay_fee_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalTripPayFeeSourceAmount")
|
|
131
|
-
total_trip_pay_fee_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalTripPayFeeCaptureAmount")
|
|
132
|
-
total_trip_pay_fee_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalTripPayFeeDisplayAmount")
|
|
133
|
-
total_trip_pay_fee_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalTripPayFeeSupplierAmount")
|
|
134
|
-
total_trip_pay_fee_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalTripPayFeeInternalAmount")
|
|
135
|
-
total_sales_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSalesSourceAmount")
|
|
136
|
-
total_sales_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSalesCaptureAmount")
|
|
137
|
-
total_sales_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSalesDisplayAmount")
|
|
138
|
-
total_sales_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSalesSupplierAmount")
|
|
139
|
-
total_sales_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSalesInternalAmount")
|
|
90
|
+
net_commissionable_total_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency the affiliate is owed.", alias="netCommissionableTotalSourceAmount")
|
|
91
|
+
net_commissionable_total_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="netCommissionableTotalCaptureAmount")
|
|
92
|
+
net_commissionable_total_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="netCommissionableTotalDisplayAmount")
|
|
93
|
+
net_commissionable_total_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="netCommissionableTotalSupplierAmount")
|
|
94
|
+
net_commissionable_total_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="netCommissionableTotalInternalAmount")
|
|
95
|
+
net_total_fees_and_commissions_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency that is fees and commission.", alias="netTotalFeesAndCommissionsSourceAmount")
|
|
96
|
+
net_total_fees_and_commissions_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="netTotalFeesAndCommissionsCaptureAmount")
|
|
97
|
+
net_total_fees_and_commissions_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="netTotalFeesAndCommissionsDisplayAmount")
|
|
98
|
+
net_total_fees_and_commissions_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="netTotalFeesAndCommissionsSupplierAmount")
|
|
99
|
+
net_total_fees_and_commissions_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="netTotalFeesAndCommissionsInternalAmount")
|
|
100
|
+
net_total_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency that is fees and commission.", alias="netTotalFeesSourceAmount")
|
|
101
|
+
net_total_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="netTotalFeesCaptureAmount")
|
|
102
|
+
net_total_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="netTotalFeesDisplayAmount")
|
|
103
|
+
net_total_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="netTotalFeesSupplierAmount")
|
|
104
|
+
net_total_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="netTotalFeesInternalAmount")
|
|
105
|
+
net_total_trip_pay_fee_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency that is fees and commission.", alias="netTotalTripPayFeeSourceAmount")
|
|
106
|
+
net_total_trip_pay_fee_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="netTotalTripPayFeeCaptureAmount")
|
|
107
|
+
net_total_trip_pay_fee_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="netTotalTripPayFeeDisplayAmount")
|
|
108
|
+
net_total_trip_pay_fee_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="netTotalTripPayFeeSupplierAmount")
|
|
109
|
+
net_total_trip_pay_fee_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="netTotalTripPayFeeInternalAmount")
|
|
110
|
+
net_total_sales_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency that is fees and commission.", alias="netTotalSalesSourceAmount")
|
|
111
|
+
net_total_sales_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="netTotalSalesCaptureAmount")
|
|
112
|
+
net_total_sales_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="netTotalSalesDisplayAmount")
|
|
113
|
+
net_total_sales_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="netTotalSalesSupplierAmount")
|
|
114
|
+
net_total_sales_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="netTotalSalesInternalAmount")
|
|
115
|
+
commissionable_total_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency the affiliate is owed.", alias="commissionableTotalSourceAmount")
|
|
116
|
+
commissionable_total_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="commissionableTotalCaptureAmount")
|
|
117
|
+
commissionable_total_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="commissionableTotalDisplayAmount")
|
|
118
|
+
commissionable_total_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="commissionableTotalSupplierAmount")
|
|
119
|
+
commissionable_total_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="commissionableTotalInternalAmount")
|
|
120
|
+
total_fees_and_commissions_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency that is fees and commission.", alias="totalFeesAndCommissionsSourceAmount")
|
|
121
|
+
total_fees_and_commissions_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="totalFeesAndCommissionsCaptureAmount")
|
|
122
|
+
total_fees_and_commissions_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="totalFeesAndCommissionsDisplayAmount")
|
|
123
|
+
total_fees_and_commissions_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="totalFeesAndCommissionsSupplierAmount")
|
|
124
|
+
total_fees_and_commissions_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="totalFeesAndCommissionsInternalAmount")
|
|
125
|
+
total_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency that is fees and commission.", alias="totalFeesSourceAmount")
|
|
126
|
+
total_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="totalFeesCaptureAmount")
|
|
127
|
+
total_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="totalFeesDisplayAmount")
|
|
128
|
+
total_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="totalFeesSupplierAmount")
|
|
129
|
+
total_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="totalFeesInternalAmount")
|
|
130
|
+
total_trip_pay_fee_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency that is fees and commission.", alias="totalTripPayFeeSourceAmount")
|
|
131
|
+
total_trip_pay_fee_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="totalTripPayFeeCaptureAmount")
|
|
132
|
+
total_trip_pay_fee_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="totalTripPayFeeDisplayAmount")
|
|
133
|
+
total_trip_pay_fee_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="totalTripPayFeeSupplierAmount")
|
|
134
|
+
total_trip_pay_fee_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="totalTripPayFeeInternalAmount")
|
|
135
|
+
total_sales_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency that is fees and commission.", alias="totalSalesSourceAmount")
|
|
136
|
+
total_sales_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="totalSalesCaptureAmount")
|
|
137
|
+
total_sales_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="totalSalesDisplayAmount")
|
|
138
|
+
total_sales_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="totalSalesSupplierAmount")
|
|
139
|
+
total_sales_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="totalSalesInternalAmount")
|
|
140
140
|
funds_available_date: Optional[date] = Field(default=None, description="Returns the date the funds will be released to the customer.", alias="fundsAvailableDate")
|
|
141
141
|
total_fees_in_percent_with_refund: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="All amounts that are not of type SALE", alias="totalFeesInPercentWithRefund")
|
|
142
142
|
total_fees_in_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="All amounts that are not of type SALE before a refund was applied", alias="totalFeesInPercent")
|
|
@@ -150,31 +150,31 @@ class BookingContractAgent(BaseModel):
|
|
|
150
150
|
original_affiliate_agency_fees_in_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Affiliate agent fee in percent", alias="originalAffiliateAgencyFeesInPercent")
|
|
151
151
|
original_supplier_agency_fees_in_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Supplier agent fee in percent", alias="originalSupplierAgencyFeesInPercent")
|
|
152
152
|
original_commissions_in_percent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="All amounts that are not of type SALE before a refund was applied", alias="originalCommissionsInPercent")
|
|
153
|
-
net_total_customers_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalCustomersSourceAmount")
|
|
154
|
-
net_total_customers_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalCustomersCaptureAmount")
|
|
155
|
-
net_total_customers_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalCustomersDisplayAmount")
|
|
156
|
-
net_total_customers_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalCustomersSupplierAmount")
|
|
157
|
-
net_total_customers_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalCustomersInternalAmount")
|
|
158
|
-
total_affiliate_agency_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalAffiliateAgencyFeesSourceAmount")
|
|
159
|
-
total_affiliate_agency_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalAffiliateAgencyFeesCaptureAmount")
|
|
160
|
-
total_affiliate_agency_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalAffiliateAgencyFeesDisplayAmount")
|
|
161
|
-
total_affiliate_agency_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalAffiliateAgencyFeesSupplierAmount")
|
|
162
|
-
total_affiliate_agency_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalAffiliateAgencyFeesInternalAmount")
|
|
163
|
-
total_supplier_agency_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSupplierAgencyFeesSourceAmount")
|
|
164
|
-
total_supplier_agency_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSupplierAgencyFeesCaptureAmount")
|
|
165
|
-
total_supplier_agency_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSupplierAgencyFeesDisplayAmount")
|
|
166
|
-
total_supplier_agency_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSupplierAgencyFeesSupplierAmount")
|
|
167
|
-
total_supplier_agency_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="totalSupplierAgencyFeesInternalAmount")
|
|
168
|
-
net_total_affiliate_agency_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalAffiliateAgencyFeesSourceAmount")
|
|
169
|
-
net_total_affiliate_agency_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalAffiliateAgencyFeesCaptureAmount")
|
|
170
|
-
net_total_affiliate_agency_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalAffiliateAgencyFeesDisplayAmount")
|
|
171
|
-
net_total_affiliate_agency_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalAffiliateAgencyFeesSupplierAmount")
|
|
172
|
-
net_total_affiliate_agency_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalAffiliateAgencyFeesInternalAmount")
|
|
173
|
-
net_total_supplier_agency_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSupplierAgencyFeesSourceAmount")
|
|
174
|
-
net_total_supplier_agency_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSupplierAgencyFeesCaptureAmount")
|
|
175
|
-
net_total_supplier_agency_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSupplierAgencyFeesDisplayAmount")
|
|
176
|
-
net_total_supplier_agency_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSupplierAgencyFeesSupplierAmount")
|
|
177
|
-
net_total_supplier_agency_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, alias="netTotalSupplierAgencyFeesInternalAmount")
|
|
153
|
+
net_total_customers_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency that is fees and commission.", alias="netTotalCustomersSourceAmount")
|
|
154
|
+
net_total_customers_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency the affiliate is owed.", alias="netTotalCustomersCaptureAmount")
|
|
155
|
+
net_total_customers_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency the affiliate is owed.", alias="netTotalCustomersDisplayAmount")
|
|
156
|
+
net_total_customers_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency the affiliate is owed.", alias="netTotalCustomersSupplierAmount")
|
|
157
|
+
net_total_customers_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency the affiliate is owed.", alias="netTotalCustomersInternalAmount")
|
|
158
|
+
total_affiliate_agency_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency owed affiliate agency.", alias="totalAffiliateAgencyFeesSourceAmount")
|
|
159
|
+
total_affiliate_agency_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency owed affiliate agency.", alias="totalAffiliateAgencyFeesCaptureAmount")
|
|
160
|
+
total_affiliate_agency_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency owed affiliate agency.", alias="totalAffiliateAgencyFeesDisplayAmount")
|
|
161
|
+
total_affiliate_agency_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency owed affiliate agency.", alias="totalAffiliateAgencyFeesSupplierAmount")
|
|
162
|
+
total_affiliate_agency_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency owed affiliate agency.", alias="totalAffiliateAgencyFeesInternalAmount")
|
|
163
|
+
total_supplier_agency_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency owed supplier agency.", alias="totalSupplierAgencyFeesSourceAmount")
|
|
164
|
+
total_supplier_agency_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency owed supplier agency.", alias="totalSupplierAgencyFeesCaptureAmount")
|
|
165
|
+
total_supplier_agency_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency owed supplier agency.", alias="totalSupplierAgencyFeesDisplayAmount")
|
|
166
|
+
total_supplier_agency_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency owed supplier agency.", alias="totalSupplierAgencyFeesSupplierAmount")
|
|
167
|
+
total_supplier_agency_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency owed supplier agency.", alias="totalSupplierAgencyFeesInternalAmount")
|
|
168
|
+
net_total_affiliate_agency_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency owed affiliate agency.", alias="netTotalAffiliateAgencyFeesSourceAmount")
|
|
169
|
+
net_total_affiliate_agency_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency owed affiliate agency.", alias="netTotalAffiliateAgencyFeesCaptureAmount")
|
|
170
|
+
net_total_affiliate_agency_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency owed affiliate agency.", alias="netTotalAffiliateAgencyFeesDisplayAmount")
|
|
171
|
+
net_total_affiliate_agency_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency owed affiliate agency.", alias="netTotalAffiliateAgencyFeesSupplierAmount")
|
|
172
|
+
net_total_affiliate_agency_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency owed affiliate agency.", alias="netTotalAffiliateAgencyFeesInternalAmount")
|
|
173
|
+
net_total_supplier_agency_fees_source_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in source currency owed supplier agency.", alias="netTotalSupplierAgencyFeesSourceAmount")
|
|
174
|
+
net_total_supplier_agency_fees_capture_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in capture currency owed supplier agency.", alias="netTotalSupplierAgencyFeesCaptureAmount")
|
|
175
|
+
net_total_supplier_agency_fees_display_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in display currency owed supplier agency.", alias="netTotalSupplierAgencyFeesDisplayAmount")
|
|
176
|
+
net_total_supplier_agency_fees_supplier_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in supplier currency owed supplier agency.", alias="netTotalSupplierAgencyFeesSupplierAmount")
|
|
177
|
+
net_total_supplier_agency_fees_internal_amount: Optional[CustomMonetaryAmount] = Field(default=None, description="Returns the total amount in internal currency owed supplier agency.", alias="netTotalSupplierAgencyFeesInternalAmount")
|
|
178
178
|
has_refunds: Optional[StrictBool] = Field(default=None, description="Indicates whether any refund in any state is present.", alias="hasRefunds")
|
|
179
179
|
has_successful_refunds: Optional[StrictBool] = Field(default=None, description="Indicates whether a successful refund is present.", alias="hasSuccessfulRefunds")
|
|
180
180
|
has_pending_refunds: Optional[StrictBool] = Field(default=None, description="Indicates whether a pending refund is present.", alias="hasPendingRefunds")
|
|
@@ -182,15 +182,15 @@ class BookingContractAgent(BaseModel):
|
|
|
182
182
|
platform_identifier: Optional[StrictStr] = Field(default=None, description="Returns the account identifier for the beneficiary taking a platform fee", alias="platformIdentifier")
|
|
183
183
|
total_funds_grouped_by_beneficiary: Optional[List[BeneficiaryAgent]] = Field(default=None, description="Returns all the beneficiaries in this contract with their total amounts", alias="totalFundsGroupedByBeneficiary")
|
|
184
184
|
total_tokens_earned: Optional[StrictInt] = Field(default=None, description="Total amount of tokens minted on this contract.", alias="totalTokensEarned")
|
|
185
|
+
cancellable_with_no_charges: Optional[StrictBool] = Field(default=None, description="Whether the cancellation comes at no cost to the traveler.", alias="cancellableWithNoCharges")
|
|
186
|
+
is_cancellable_with_potential_charges: Optional[StrictBool] = Field(default=None, description="Whether a cancellation comes with partial charges. I.e. Only some of the items in contract are not fully refundable.", alias="isCancellableWithPotentialCharges")
|
|
187
|
+
fully_refunded: Optional[StrictBool] = Field(default=None, alias="fullyRefunded")
|
|
185
188
|
self_acquiring: Optional[StrictBool] = Field(default=None, alias="selfAcquiring")
|
|
186
|
-
lodging: Optional[BookingContractItemAgent] = None
|
|
189
|
+
lodging: Optional[BookingContractItemAgent] = Field(default=None, description="Returns the lodging item only.")
|
|
187
190
|
cancellable_by_agent: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by an agent.", alias="cancellableByAgent")
|
|
188
191
|
cancellable_by_supplier: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the supplier.", alias="cancellableBySupplier")
|
|
189
192
|
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled completely by the traveller.", alias="cancellableByTraveler")
|
|
190
|
-
|
|
191
|
-
cancellable_with_no_charges: Optional[StrictBool] = Field(default=None, description="Whether the cancellation comes at no cost to the traveler.", alias="cancellableWithNoCharges")
|
|
192
|
-
is_cancellable_with_potential_charges: Optional[StrictBool] = Field(default=None, description="Whether a cancellation comes with partial charges. I.e. Only some of the items in contract are not fully refundable.", alias="isCancellableWithPotentialCharges")
|
|
193
|
-
__properties: ClassVar[List[str]] = ["bookingContractIdentifier", "createdDate", "lastUpdate", "federatedOrganizationIdentifier", "federatedOrganizationName", "user", "ipAddress", "traceId", "sourceUrl", "identifier", "supplierIdentifier", "supplierName", "displayPriceQuote", "supplierPriceQuote", "internalPriceQuote", "capturePriceQuote", "itemList", "externalSupplierIdentifier", "externalSupplierBookingCode", "payment", "cancelled", "cancelledOn", "canceller", "cancellationType", "cancellerUserIdentifier", "cancelReason", "fundsProcessed", "refunds", "payouts", "sourceCurrency", "displayCurrency", "supplierCurrency", "internalCurrency", "captureCurrency", "sourceAmount", "displayAmount", "supplierAmount", "internalAmount", "captureAmount", "sourceAmountRefundModifier", "displayAmountRefundModifier", "supplierAmountRefundModifier", "internalAmountRefundModifier", "captureAmountRefundModifier", "netSourceAmount", "netDisplayAmount", "netSupplierAmount", "netInternalAmount", "netCaptureAmount", "metadata", "netCommissionableTotalSourceAmount", "netCommissionableTotalCaptureAmount", "netCommissionableTotalDisplayAmount", "netCommissionableTotalSupplierAmount", "netCommissionableTotalInternalAmount", "netTotalFeesAndCommissionsSourceAmount", "netTotalFeesAndCommissionsCaptureAmount", "netTotalFeesAndCommissionsDisplayAmount", "netTotalFeesAndCommissionsSupplierAmount", "netTotalFeesAndCommissionsInternalAmount", "netTotalFeesSourceAmount", "netTotalFeesCaptureAmount", "netTotalFeesDisplayAmount", "netTotalFeesSupplierAmount", "netTotalFeesInternalAmount", "netTotalTripPayFeeSourceAmount", "netTotalTripPayFeeCaptureAmount", "netTotalTripPayFeeDisplayAmount", "netTotalTripPayFeeSupplierAmount", "netTotalTripPayFeeInternalAmount", "netTotalSalesSourceAmount", "netTotalSalesCaptureAmount", "netTotalSalesDisplayAmount", "netTotalSalesSupplierAmount", "netTotalSalesInternalAmount", "commissionableTotalSourceAmount", "commissionableTotalCaptureAmount", "commissionableTotalDisplayAmount", "commissionableTotalSupplierAmount", "commissionableTotalInternalAmount", "totalFeesAndCommissionsSourceAmount", "totalFeesAndCommissionsCaptureAmount", "totalFeesAndCommissionsDisplayAmount", "totalFeesAndCommissionsSupplierAmount", "totalFeesAndCommissionsInternalAmount", "totalFeesSourceAmount", "totalFeesCaptureAmount", "totalFeesDisplayAmount", "totalFeesSupplierAmount", "totalFeesInternalAmount", "totalTripPayFeeSourceAmount", "totalTripPayFeeCaptureAmount", "totalTripPayFeeDisplayAmount", "totalTripPayFeeSupplierAmount", "totalTripPayFeeInternalAmount", "totalSalesSourceAmount", "totalSalesCaptureAmount", "totalSalesDisplayAmount", "totalSalesSupplierAmount", "totalSalesInternalAmount", "fundsAvailableDate", "totalFeesInPercentWithRefund", "totalFeesInPercent", "totalTripPayFeeInPercentWithRefund", "totalTripPayFeeInPercent", "totalCommissionsInPercentWithRefund", "totalCommissionsInPercent", "totalFeesAndCommissionsInPercentWithRefund", "totalFeesAndCommissionsInPercent", "originalFeesInPercent", "originalAffiliateAgencyFeesInPercent", "originalSupplierAgencyFeesInPercent", "originalCommissionsInPercent", "netTotalCustomersSourceAmount", "netTotalCustomersCaptureAmount", "netTotalCustomersDisplayAmount", "netTotalCustomersSupplierAmount", "netTotalCustomersInternalAmount", "totalAffiliateAgencyFeesSourceAmount", "totalAffiliateAgencyFeesCaptureAmount", "totalAffiliateAgencyFeesDisplayAmount", "totalAffiliateAgencyFeesSupplierAmount", "totalAffiliateAgencyFeesInternalAmount", "totalSupplierAgencyFeesSourceAmount", "totalSupplierAgencyFeesCaptureAmount", "totalSupplierAgencyFeesDisplayAmount", "totalSupplierAgencyFeesSupplierAmount", "totalSupplierAgencyFeesInternalAmount", "netTotalAffiliateAgencyFeesSourceAmount", "netTotalAffiliateAgencyFeesCaptureAmount", "netTotalAffiliateAgencyFeesDisplayAmount", "netTotalAffiliateAgencyFeesSupplierAmount", "netTotalAffiliateAgencyFeesInternalAmount", "netTotalSupplierAgencyFeesSourceAmount", "netTotalSupplierAgencyFeesCaptureAmount", "netTotalSupplierAgencyFeesDisplayAmount", "netTotalSupplierAgencyFeesSupplierAmount", "netTotalSupplierAgencyFeesInternalAmount", "hasRefunds", "hasSuccessfulRefunds", "hasPendingRefunds", "hasFailedRefunds", "platformIdentifier", "totalFundsGroupedByBeneficiary", "totalTokensEarned", "selfAcquiring", "lodging", "cancellableByAgent", "cancellableBySupplier", "cancellableByTraveler", "fullyRefunded", "cancellableWithNoCharges", "isCancellableWithPotentialCharges"]
|
|
193
|
+
__properties: ClassVar[List[str]] = ["bookingContractIdentifier", "createdDate", "lastUpdate", "federatedOrganizationIdentifier", "federatedOrganizationName", "user", "ipAddress", "traceId", "sourceUrl", "identifier", "supplierIdentifier", "supplierName", "displayPriceQuote", "supplierPriceQuote", "internalPriceQuote", "capturePriceQuote", "itemList", "externalSupplierIdentifier", "externalSupplierBookingCode", "payment", "cancelled", "cancelledOn", "canceller", "cancellationType", "cancellerUserIdentifier", "cancelReason", "fundsProcessed", "refunds", "payouts", "sourceCurrency", "displayCurrency", "supplierCurrency", "internalCurrency", "captureCurrency", "sourceAmount", "displayAmount", "supplierAmount", "internalAmount", "captureAmount", "sourceAmountRefundModifier", "displayAmountRefundModifier", "supplierAmountRefundModifier", "internalAmountRefundModifier", "captureAmountRefundModifier", "netSourceAmount", "netDisplayAmount", "netSupplierAmount", "netInternalAmount", "netCaptureAmount", "metadata", "netCommissionableTotalSourceAmount", "netCommissionableTotalCaptureAmount", "netCommissionableTotalDisplayAmount", "netCommissionableTotalSupplierAmount", "netCommissionableTotalInternalAmount", "netTotalFeesAndCommissionsSourceAmount", "netTotalFeesAndCommissionsCaptureAmount", "netTotalFeesAndCommissionsDisplayAmount", "netTotalFeesAndCommissionsSupplierAmount", "netTotalFeesAndCommissionsInternalAmount", "netTotalFeesSourceAmount", "netTotalFeesCaptureAmount", "netTotalFeesDisplayAmount", "netTotalFeesSupplierAmount", "netTotalFeesInternalAmount", "netTotalTripPayFeeSourceAmount", "netTotalTripPayFeeCaptureAmount", "netTotalTripPayFeeDisplayAmount", "netTotalTripPayFeeSupplierAmount", "netTotalTripPayFeeInternalAmount", "netTotalSalesSourceAmount", "netTotalSalesCaptureAmount", "netTotalSalesDisplayAmount", "netTotalSalesSupplierAmount", "netTotalSalesInternalAmount", "commissionableTotalSourceAmount", "commissionableTotalCaptureAmount", "commissionableTotalDisplayAmount", "commissionableTotalSupplierAmount", "commissionableTotalInternalAmount", "totalFeesAndCommissionsSourceAmount", "totalFeesAndCommissionsCaptureAmount", "totalFeesAndCommissionsDisplayAmount", "totalFeesAndCommissionsSupplierAmount", "totalFeesAndCommissionsInternalAmount", "totalFeesSourceAmount", "totalFeesCaptureAmount", "totalFeesDisplayAmount", "totalFeesSupplierAmount", "totalFeesInternalAmount", "totalTripPayFeeSourceAmount", "totalTripPayFeeCaptureAmount", "totalTripPayFeeDisplayAmount", "totalTripPayFeeSupplierAmount", "totalTripPayFeeInternalAmount", "totalSalesSourceAmount", "totalSalesCaptureAmount", "totalSalesDisplayAmount", "totalSalesSupplierAmount", "totalSalesInternalAmount", "fundsAvailableDate", "totalFeesInPercentWithRefund", "totalFeesInPercent", "totalTripPayFeeInPercentWithRefund", "totalTripPayFeeInPercent", "totalCommissionsInPercentWithRefund", "totalCommissionsInPercent", "totalFeesAndCommissionsInPercentWithRefund", "totalFeesAndCommissionsInPercent", "originalFeesInPercent", "originalAffiliateAgencyFeesInPercent", "originalSupplierAgencyFeesInPercent", "originalCommissionsInPercent", "netTotalCustomersSourceAmount", "netTotalCustomersCaptureAmount", "netTotalCustomersDisplayAmount", "netTotalCustomersSupplierAmount", "netTotalCustomersInternalAmount", "totalAffiliateAgencyFeesSourceAmount", "totalAffiliateAgencyFeesCaptureAmount", "totalAffiliateAgencyFeesDisplayAmount", "totalAffiliateAgencyFeesSupplierAmount", "totalAffiliateAgencyFeesInternalAmount", "totalSupplierAgencyFeesSourceAmount", "totalSupplierAgencyFeesCaptureAmount", "totalSupplierAgencyFeesDisplayAmount", "totalSupplierAgencyFeesSupplierAmount", "totalSupplierAgencyFeesInternalAmount", "netTotalAffiliateAgencyFeesSourceAmount", "netTotalAffiliateAgencyFeesCaptureAmount", "netTotalAffiliateAgencyFeesDisplayAmount", "netTotalAffiliateAgencyFeesSupplierAmount", "netTotalAffiliateAgencyFeesInternalAmount", "netTotalSupplierAgencyFeesSourceAmount", "netTotalSupplierAgencyFeesCaptureAmount", "netTotalSupplierAgencyFeesDisplayAmount", "netTotalSupplierAgencyFeesSupplierAmount", "netTotalSupplierAgencyFeesInternalAmount", "hasRefunds", "hasSuccessfulRefunds", "hasPendingRefunds", "hasFailedRefunds", "platformIdentifier", "totalFundsGroupedByBeneficiary", "totalTokensEarned", "cancellableWithNoCharges", "isCancellableWithPotentialCharges", "fullyRefunded", "selfAcquiring", "lodging", "cancellableByAgent", "cancellableBySupplier", "cancellableByTraveler"]
|
|
194
194
|
|
|
195
195
|
@field_validator('canceller')
|
|
196
196
|
def canceller_validate_enum(cls, value):
|
|
@@ -549,10 +549,10 @@ class BookingContractAgent(BaseModel):
|
|
|
549
549
|
"identifier": obj.get("identifier"),
|
|
550
550
|
"supplierIdentifier": obj.get("supplierIdentifier"),
|
|
551
551
|
"supplierName": obj.get("supplierName"),
|
|
552
|
-
"displayPriceQuote":
|
|
553
|
-
"supplierPriceQuote":
|
|
554
|
-
"internalPriceQuote":
|
|
555
|
-
"capturePriceQuote":
|
|
552
|
+
"displayPriceQuote": QuoteLightweightAgent.from_dict(obj["displayPriceQuote"]) if obj.get("displayPriceQuote") is not None else None,
|
|
553
|
+
"supplierPriceQuote": QuoteLightweightAgent.from_dict(obj["supplierPriceQuote"]) if obj.get("supplierPriceQuote") is not None else None,
|
|
554
|
+
"internalPriceQuote": QuoteLightweightAgent.from_dict(obj["internalPriceQuote"]) if obj.get("internalPriceQuote") is not None else None,
|
|
555
|
+
"capturePriceQuote": QuoteLightweightAgent.from_dict(obj["capturePriceQuote"]) if obj.get("capturePriceQuote") is not None else None,
|
|
556
556
|
"itemList": [BookingContractItemAgent.from_dict(_item) for _item in obj["itemList"]] if obj.get("itemList") is not None else None,
|
|
557
557
|
"externalSupplierIdentifier": obj.get("externalSupplierIdentifier"),
|
|
558
558
|
"externalSupplierBookingCode": obj.get("externalSupplierBookingCode"),
|
|
@@ -682,14 +682,14 @@ class BookingContractAgent(BaseModel):
|
|
|
682
682
|
"platformIdentifier": obj.get("platformIdentifier"),
|
|
683
683
|
"totalFundsGroupedByBeneficiary": [BeneficiaryAgent.from_dict(_item) for _item in obj["totalFundsGroupedByBeneficiary"]] if obj.get("totalFundsGroupedByBeneficiary") is not None else None,
|
|
684
684
|
"totalTokensEarned": obj.get("totalTokensEarned"),
|
|
685
|
+
"cancellableWithNoCharges": obj.get("cancellableWithNoCharges"),
|
|
686
|
+
"isCancellableWithPotentialCharges": obj.get("isCancellableWithPotentialCharges"),
|
|
687
|
+
"fullyRefunded": obj.get("fullyRefunded"),
|
|
685
688
|
"selfAcquiring": obj.get("selfAcquiring"),
|
|
686
689
|
"lodging": BookingContractItemAgent.from_dict(obj["lodging"]) if obj.get("lodging") is not None else None,
|
|
687
690
|
"cancellableByAgent": obj.get("cancellableByAgent"),
|
|
688
691
|
"cancellableBySupplier": obj.get("cancellableBySupplier"),
|
|
689
|
-
"cancellableByTraveler": obj.get("cancellableByTraveler")
|
|
690
|
-
"fullyRefunded": obj.get("fullyRefunded"),
|
|
691
|
-
"cancellableWithNoCharges": obj.get("cancellableWithNoCharges"),
|
|
692
|
-
"isCancellableWithPotentialCharges": obj.get("isCancellableWithPotentialCharges")
|
|
692
|
+
"cancellableByTraveler": obj.get("cancellableByTraveler")
|
|
693
693
|
})
|
|
694
694
|
return _obj
|
|
695
695
|
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"""
|
|
4
4
|
Wink API
|
|
5
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](/
|
|
6
|
+
# Introduction Welcome to the Wink API - A programmer-friendly way to manage, sell and book travel inventory on the Wink platform. The API gives you all the tools you need to ready your properties and inventory for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel inventory and promote / sell it in a wide variety of ways. # Integrations We have already integrated with the most well-known channel managers so you don't have to. To see our current integrations, please go to https://extranet.wink.travel and scroll to Connectivity section. Once your properties are set up, you can finish the setup by mapping your property to Wink using your channel manager partner portal. If your properties don't have a channel manager, you can easily manage rates and availability with this API. # Intended Audience Programmers are [most likely] a requirement to start integrating with Wink. Companies and organizations that would most benefit from integrating with us are new and existing travel companies that have relationships with suppliers and that need an advanced system from which to manage their travel inventory and get that same inventory out to as many eyeballs as possible at the lowest price possible. - Hotel chains - Hotel brands - Travel tech companies - Destination sites - Integrators - Aggregators - Destination management companies - Travel agencies - OTAs ## APIs Not every integrator needs every API. For that reason, we have separated APIs into context. ### Test API - [Ping](/ping): The Ping API is a quick test endpoint to verify that your credentials work Wink. ### Common APIs - [Notifications](/notifications): The Notifications API is a way for us to stay in touch with your user, property or affiliate account. - [User Settings](/user-settings): The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink. ### Consume APIs Consume endpoints are for developers who want to find existing travel inventory and either book it or use it to advertise through one of their Wink affiliate accounts. - [Configuration](/customization-client): A single endpoint to retrieve whitelabel + customization information for the booking customization. - [Lookup](/lookup): All APIs related to locating inventory by region, locale and property flags. - [Inventory](/inventory): All APIs related to retrieve known travel inventory as it was found using the Lookup API.. - [Booking](/booking): All APIs related to creating bookings on the platform. - [Travel Agent](/travel-agent): The Travel Agent API exposes endpoints to manage agent-facilitated bookings. ### Produce APIs Produce endpoints are for developers who want to create and manage travel inventory. #### Property - [Property registration](/extranet/property/register): As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink. - [Property](/extranet/property): This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties. - [Facilities](/extranet/facilities): This collection of endpoints let you manage facilities; such as room types. - [Experiences](/extranet/experiences): This collection of endpoints let you manage experiences, such as activities. - [Monetize](/extranet/monetize): The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink. - [Distribution](/extranet/distribution): The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. - [Property Booking](/extranet/booking): The Property Booking API exposes endpoints for managing bookings and reviews at the property-level. #### Affiliate - [Affiliate](/affiliate): This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts. - [Browse](/affiliate/browse): The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell. - [Inventory](/affiliate/inventory): The Inventory API exposes endpoints for affiliates to manage the inventory they want to sell and how they want to sell it. - [Sales Channel](/affiliate/sales-channel): The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones. - [WinkLinks](/affiliate/winklinks): The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page. #### Rate provider - [Channel manager](/channel-manager): The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties. ### Taxonomy APIs Taxonomy endpoints are for developers who want to consume and produce travel inventory and need taxonomies of standard and non-standard codes for inventory types, classes, statuses etc. - [Reference](/reactive): All APIs related to retrieving platform-supported taxonomies. ### Insight APIs Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers. - [Analytics](/analytics): All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics. ### Payment APIs Payment endpoints are for developers who want to purchase travel inventory. This can be done via the API as a registered Travel Agent or using our API in conjunction with our PCI compliant reactive widget for all other entities. - [TripPay](/reactive): All APIs related to TripPay account management, booking, mapping and integration features. ## SDKs We are actively working on supporting the most used languages out there. If you don't see your language here, reach out to us with a request to officially add your language. In the meantime, if you want to roll your own SDK, you can do so by downloading the OpenAPI spec and using one of the many available OpenAPI generators available: [https://openapi-generator.tech/docs/generators](https://openapi-generator.tech/docs/generators). - Java SDK [https://github.com/wink-travel/wink-sdk-java](https://github.com/wink-travel/wink-sdk-java) ## Usage These features are made available to you via a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer). This API is language agnostic. ## Versioning We chose to version our endpoints in a way that we hope affects your integration minimally. You request the version of our API you wish to work with via the `Wink-Version` header. When it's time for you to upgrade, you only have to change the version number to get access to our updated endpoints. ## Release history - Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md # Travel Agent API The Travel Agent API exposes endpoints to manage agent-facilitated bookings. This API lets you: 1. Travel Agent: Manage agent entity. 2. Booking: Create / Manage bookings Browse the endpoints in the left navigation bar to get started.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 30.
|
|
8
|
+
The version of the OpenAPI document: 30.17.2
|
|
9
9
|
Contact: bjorn@wink.travel
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -22,7 +22,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, Strict
|
|
|
22
22
|
from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
23
23
|
from typing_extensions import Annotated
|
|
24
24
|
from wink_sdk_travel_agent.models.beneficiary_agent import BeneficiaryAgent
|
|
25
|
-
from wink_sdk_travel_agent.models.daily_rate_agent import DailyRateAgent
|
|
26
25
|
from wink_sdk_travel_agent.models.guest_user_agent import GuestUserAgent
|
|
27
26
|
from wink_sdk_travel_agent.models.simple_date_time_itinerary_agent import SimpleDateTimeItineraryAgent
|
|
28
27
|
from wink_sdk_travel_agent.models.supplier_contract_item_policy_agent import SupplierContractItemPolicyAgent
|
|
@@ -31,12 +30,12 @@ from typing_extensions import Self
|
|
|
31
30
|
|
|
32
31
|
class BookingContractItemAgent(BaseModel):
|
|
33
32
|
"""
|
|
34
|
-
|
|
33
|
+
BookingContractItemAgent
|
|
35
34
|
""" # noqa: E501
|
|
36
|
-
supplier_item_booking_code:
|
|
35
|
+
supplier_item_booking_code: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Booking code identifying the supplier line item.", alias="supplierItemBookingCode")
|
|
37
36
|
user: GuestUserAgent
|
|
38
|
-
name_in_english:
|
|
39
|
-
description_in_english:
|
|
37
|
+
name_in_english: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Name of item in English included in booking.", alias="nameInEnglish")
|
|
38
|
+
description_in_english: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Short description in English of item included in booking.", alias="descriptionInEnglish")
|
|
40
39
|
itinerary: SimpleDateTimeItineraryAgent
|
|
41
40
|
pricing_type: StrictStr = Field(description="How to calculate the total amount.", alias="pricingType")
|
|
42
41
|
type: StrictStr = Field(description="Type of item this is.")
|
|
@@ -45,13 +44,13 @@ class BookingContractItemAgent(BaseModel):
|
|
|
45
44
|
policy: Optional[SupplierContractItemPolicyAgent] = None
|
|
46
45
|
external_identifier: Optional[StrictStr] = Field(default=None, description="Optional externalIdentifier to remote inventory.", alias="externalIdentifier")
|
|
47
46
|
tokens_earned: Optional[StrictInt] = Field(default=None, description="Tokens minted for this item", alias="tokensEarned")
|
|
48
|
-
daily_rate_list: Optional[List[
|
|
47
|
+
daily_rate_list: Optional[List[Any]] = Field(default=None, alias="dailyRateList")
|
|
49
48
|
cancelled: Optional[StrictBool] = Field(default=None, description="Optional geoname externalIdentifier to remote inventory.")
|
|
50
|
-
source_currency:
|
|
51
|
-
display_currency:
|
|
52
|
-
supplier_currency:
|
|
53
|
-
internal_currency:
|
|
54
|
-
capture_currency:
|
|
49
|
+
source_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The source currency", alias="sourceCurrency")
|
|
50
|
+
display_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The display currency", alias="displayCurrency")
|
|
51
|
+
supplier_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The supplier currency", alias="supplierCurrency")
|
|
52
|
+
internal_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The internal currency", alias="internalCurrency")
|
|
53
|
+
capture_currency: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The capture currency", alias="captureCurrency")
|
|
55
54
|
source_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="The total initial price as quoted in the original TripPay contract.", alias="sourceAmount")
|
|
56
55
|
display_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="The total display price.", alias="displayAmount")
|
|
57
56
|
supplier_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="The total supplier price.", alias="supplierAmount")
|
|
@@ -68,11 +67,11 @@ class BookingContractItemAgent(BaseModel):
|
|
|
68
67
|
net_internal_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Internal amount minus internal modifier.", alias="netInternalAmount")
|
|
69
68
|
net_capture_amount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Capture amount minus capture modifier.", alias="netCaptureAmount")
|
|
70
69
|
metadata: Optional[Dict[str, StrictStr]] = Field(default=None, description="Place to add more data related to the booking contract item.")
|
|
71
|
-
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled by the traveller.", alias="cancellableByTraveler")
|
|
72
70
|
cancellable_with_no_charges: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled and whether cancellation charges might still occur.", alias="cancellableWithNoCharges")
|
|
73
71
|
cancellable_with_potential_charges: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled and whether cancellation charges might still occur.", alias="cancellableWithPotentialCharges")
|
|
74
72
|
cancellable_by_supplier_or_agent: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled by the supplier. A supplier cancellation overrides the refundable", alias="cancellableBySupplierOrAgent")
|
|
75
|
-
|
|
73
|
+
cancellable_by_traveler: Optional[StrictBool] = Field(default=None, description="Whether the booking can still be cancelled by the traveller.", alias="cancellableByTraveler")
|
|
74
|
+
__properties: ClassVar[List[str]] = ["supplierItemBookingCode", "user", "nameInEnglish", "descriptionInEnglish", "itinerary", "pricingType", "type", "beneficiaryList", "payable", "policy", "externalIdentifier", "tokensEarned", "dailyRateList", "cancelled", "sourceCurrency", "displayCurrency", "supplierCurrency", "internalCurrency", "captureCurrency", "sourceAmount", "displayAmount", "supplierAmount", "internalAmount", "captureAmount", "sourceAmountRefundModifier", "displayAmountRefundModifier", "supplierAmountRefundModifier", "internalAmountRefundModifier", "captureAmountRefundModifier", "netSourceAmount", "netDisplayAmount", "netSupplierAmount", "netInternalAmount", "netCaptureAmount", "metadata", "cancellableWithNoCharges", "cancellableWithPotentialCharges", "cancellableBySupplierOrAgent", "cancellableByTraveler"]
|
|
76
75
|
|
|
77
76
|
@field_validator('pricing_type')
|
|
78
77
|
def pricing_type_validate_enum(cls, value):
|
|
@@ -150,13 +149,6 @@ class BookingContractItemAgent(BaseModel):
|
|
|
150
149
|
# override the default output from pydantic by calling `to_dict()` of policy
|
|
151
150
|
if self.policy:
|
|
152
151
|
_dict['policy'] = self.policy.to_dict()
|
|
153
|
-
# override the default output from pydantic by calling `to_dict()` of each item in daily_rate_list (list)
|
|
154
|
-
_items = []
|
|
155
|
-
if self.daily_rate_list:
|
|
156
|
-
for _item_daily_rate_list in self.daily_rate_list:
|
|
157
|
-
if _item_daily_rate_list:
|
|
158
|
-
_items.append(_item_daily_rate_list.to_dict())
|
|
159
|
-
_dict['dailyRateList'] = _items
|
|
160
152
|
return _dict
|
|
161
153
|
|
|
162
154
|
@classmethod
|
|
@@ -181,7 +173,7 @@ class BookingContractItemAgent(BaseModel):
|
|
|
181
173
|
"policy": SupplierContractItemPolicyAgent.from_dict(obj["policy"]) if obj.get("policy") is not None else None,
|
|
182
174
|
"externalIdentifier": obj.get("externalIdentifier"),
|
|
183
175
|
"tokensEarned": obj.get("tokensEarned"),
|
|
184
|
-
"dailyRateList":
|
|
176
|
+
"dailyRateList": obj.get("dailyRateList"),
|
|
185
177
|
"cancelled": obj.get("cancelled"),
|
|
186
178
|
"sourceCurrency": obj.get("sourceCurrency"),
|
|
187
179
|
"displayCurrency": obj.get("displayCurrency"),
|
|
@@ -204,10 +196,10 @@ class BookingContractItemAgent(BaseModel):
|
|
|
204
196
|
"netInternalAmount": obj.get("netInternalAmount"),
|
|
205
197
|
"netCaptureAmount": obj.get("netCaptureAmount"),
|
|
206
198
|
"metadata": obj.get("metadata"),
|
|
207
|
-
"cancellableByTraveler": obj.get("cancellableByTraveler"),
|
|
208
199
|
"cancellableWithNoCharges": obj.get("cancellableWithNoCharges"),
|
|
209
200
|
"cancellableWithPotentialCharges": obj.get("cancellableWithPotentialCharges"),
|
|
210
|
-
"cancellableBySupplierOrAgent": obj.get("cancellableBySupplierOrAgent")
|
|
201
|
+
"cancellableBySupplierOrAgent": obj.get("cancellableBySupplierOrAgent"),
|
|
202
|
+
"cancellableByTraveler": obj.get("cancellableByTraveler")
|
|
211
203
|
})
|
|
212
204
|
return _obj
|
|
213
205
|
|