Source code for worldline.connect.sdk.v1.domain.airline_data

# -*- coding: utf-8 -*-
#
# This class was auto-generated from the API references found at
# https://apireference.connect.worldline-solutions.com/
#
from worldline.connect.sdk.domain.data_object import DataObject
from worldline.connect.sdk.v1.domain.airline_flight_leg import AirlineFlightLeg
from worldline.connect.sdk.v1.domain.airline_passenger import AirlinePassenger


[docs]class AirlineData(DataObject): __agent_numeric_code = None __code = None __flight_date = None __flight_legs = None __invoice_number = None __is_e_ticket = None __is_registered_customer = None __is_restricted_ticket = None __is_third_party = None __issue_date = None __merchant_customer_id = None __name = None __number_in_party = None __passenger_name = None __passengers = None __place_of_issue = None __pnr = None __point_of_sale = None __pos_city_code = None __ticket_delivery_method = None __ticket_number = None __total_fare = None __total_fee = None __total_taxes = None __travel_agency_name = None @property def agent_numeric_code(self): """ | Numeric code identifying the agent Type: str """ return self.__agent_numeric_code @agent_numeric_code.setter def agent_numeric_code(self, value): self.__agent_numeric_code = value @property def code(self): """ | Airline numeric code Type: str """ return self.__code @code.setter def code(self, value): self.__code = value @property def flight_date(self): """ | Date of the Flight | Format: YYYYMMDD Type: str """ return self.__flight_date @flight_date.setter def flight_date(self, value): self.__flight_date = value @property def flight_legs(self): """ | Object that holds the data on the individual legs of the ticket Type: list[:class:`worldline.connect.sdk.v1.domain.airline_flight_leg.AirlineFlightLeg`] """ return self.__flight_legs @flight_legs.setter def flight_legs(self, value): self.__flight_legs = value @property def invoice_number(self): """ | Airline tracing number Type: str """ return self.__invoice_number @invoice_number.setter def invoice_number(self, value): self.__invoice_number = value @property def is_e_ticket(self): """ * true = The ticket is an E-Ticket * false = the ticket is not an E-Ticket Type: bool """ return self.__is_e_ticket @is_e_ticket.setter def is_e_ticket(self, value): self.__is_e_ticket = value @property def is_registered_customer(self): """ * true = a registered known customer * false = unknown customer Type: bool Deprecated; Use Order.customer.accountType instead """ return self.__is_registered_customer @is_registered_customer.setter def is_registered_customer(self, value): self.__is_registered_customer = value @property def is_restricted_ticket(self): """ * true - Restricted, the ticket is non-refundable * false - No restrictions, the ticket is (partially) refundable Type: bool """ return self.__is_restricted_ticket @is_restricted_ticket.setter def is_restricted_ticket(self, value): self.__is_restricted_ticket = value @property def is_third_party(self): """ * true - The payer is the ticket holder * false - The payer is not the ticket holder Type: bool """ return self.__is_third_party @is_third_party.setter def is_third_party(self, value): self.__is_third_party = value @property def issue_date(self): """ | This is the date of issue recorded in the airline systemIn a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date. | Format: YYYYMMDD Type: str """ return self.__issue_date @issue_date.setter def issue_date(self, value): self.__issue_date = value @property def merchant_customer_id(self): """ | Your ID of the customer in the context of the airline data Type: str """ return self.__merchant_customer_id @merchant_customer_id.setter def merchant_customer_id(self, value): self.__merchant_customer_id = value @property def name(self): """ | Name of the airline Type: str """ return self.__name @name.setter def name(self, value): self.__name = value @property def number_in_party(self): """ | Total number of passengers in the party. If the the property numberInParty is not present, then the number of passengers will be used on the WL Online Payment Acceptance Platform. Type: int """ return self.__number_in_party @number_in_party.setter def number_in_party(self, value): self.__number_in_party = value @property def passenger_name(self): """ | Name of passenger Type: str """ return self.__passenger_name @passenger_name.setter def passenger_name(self, value): self.__passenger_name = value @property def passengers(self): """ | Object that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform) Type: list[:class:`worldline.connect.sdk.v1.domain.airline_passenger.AirlinePassenger`] """ return self.__passengers @passengers.setter def passengers(self, value): self.__passengers = value @property def place_of_issue(self): """ | Place of issue | For sales in the US the last two characters (pos 14-15) must be the US state code. Type: str """ return self.__place_of_issue @place_of_issue.setter def place_of_issue(self, value): self.__place_of_issue = value @property def pnr(self): """ | Passenger name record Type: str """ return self.__pnr @pnr.setter def pnr(self, value): self.__pnr = value @property def point_of_sale(self): """ | IATA point of sale name Type: str """ return self.__point_of_sale @point_of_sale.setter def point_of_sale(self, value): self.__point_of_sale = value @property def pos_city_code(self): """ | city code of the point of sale Type: str """ return self.__pos_city_code @pos_city_code.setter def pos_city_code(self, value): self.__pos_city_code = value @property def ticket_delivery_method(self): """ | Possible values: * e-ticket * city-ticket-office * airport-ticket-office * ticket-by-mail * ticket-on-departure Type: str """ return self.__ticket_delivery_method @ticket_delivery_method.setter def ticket_delivery_method(self, value): self.__ticket_delivery_method = value @property def ticket_number(self): """ | The ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it contains: * Airline code: 3-digit airline code number * Form code: A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it contains * Serial number: A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial number shall not exceed ten * TICKETNUMBER can be replaced with PNR if the ticket number is unavailable Type: str """ return self.__ticket_number @ticket_number.setter def ticket_number(self, value): self.__ticket_number = value @property def total_fare(self): """ | Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets Type: int """ return self.__total_fare @total_fare.setter def total_fare(self, value): self.__total_fare = value @property def total_fee(self): """ | Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets Type: int """ return self.__total_fee @total_fee.setter def total_fee(self, value): self.__total_fee = value @property def total_taxes(self): """ | Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets Type: int """ return self.__total_taxes @total_taxes.setter def total_taxes(self, value): self.__total_taxes = value @property def travel_agency_name(self): """ | Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform. Type: str """ return self.__travel_agency_name @travel_agency_name.setter def travel_agency_name(self, value): self.__travel_agency_name = value
[docs] def to_dictionary(self): dictionary = super(AirlineData, self).to_dictionary() if self.agent_numeric_code is not None: dictionary['agentNumericCode'] = self.agent_numeric_code if self.code is not None: dictionary['code'] = self.code if self.flight_date is not None: dictionary['flightDate'] = self.flight_date if self.flight_legs is not None: dictionary['flightLegs'] = [] for element in self.flight_legs: if element is not None: dictionary['flightLegs'].append(element.to_dictionary()) if self.invoice_number is not None: dictionary['invoiceNumber'] = self.invoice_number if self.is_e_ticket is not None: dictionary['isETicket'] = self.is_e_ticket if self.is_registered_customer is not None: dictionary['isRegisteredCustomer'] = self.is_registered_customer if self.is_restricted_ticket is not None: dictionary['isRestrictedTicket'] = self.is_restricted_ticket if self.is_third_party is not None: dictionary['isThirdParty'] = self.is_third_party if self.issue_date is not None: dictionary['issueDate'] = self.issue_date if self.merchant_customer_id is not None: dictionary['merchantCustomerId'] = self.merchant_customer_id if self.name is not None: dictionary['name'] = self.name if self.number_in_party is not None: dictionary['numberInParty'] = self.number_in_party if self.passenger_name is not None: dictionary['passengerName'] = self.passenger_name if self.passengers is not None: dictionary['passengers'] = [] for element in self.passengers: if element is not None: dictionary['passengers'].append(element.to_dictionary()) if self.place_of_issue is not None: dictionary['placeOfIssue'] = self.place_of_issue if self.pnr is not None: dictionary['pnr'] = self.pnr if self.point_of_sale is not None: dictionary['pointOfSale'] = self.point_of_sale if self.pos_city_code is not None: dictionary['posCityCode'] = self.pos_city_code if self.ticket_delivery_method is not None: dictionary['ticketDeliveryMethod'] = self.ticket_delivery_method if self.ticket_number is not None: dictionary['ticketNumber'] = self.ticket_number if self.total_fare is not None: dictionary['totalFare'] = self.total_fare if self.total_fee is not None: dictionary['totalFee'] = self.total_fee if self.total_taxes is not None: dictionary['totalTaxes'] = self.total_taxes if self.travel_agency_name is not None: dictionary['travelAgencyName'] = self.travel_agency_name return dictionary
[docs] def from_dictionary(self, dictionary): super(AirlineData, self).from_dictionary(dictionary) if 'agentNumericCode' in dictionary: self.agent_numeric_code = dictionary['agentNumericCode'] if 'code' in dictionary: self.code = dictionary['code'] if 'flightDate' in dictionary: self.flight_date = dictionary['flightDate'] if 'flightLegs' in dictionary: if not isinstance(dictionary['flightLegs'], list): raise TypeError('value \'{}\' is not a list'.format(dictionary['flightLegs'])) self.flight_legs = [] for element in dictionary['flightLegs']: value = AirlineFlightLeg() self.flight_legs.append(value.from_dictionary(element)) if 'invoiceNumber' in dictionary: self.invoice_number = dictionary['invoiceNumber'] if 'isETicket' in dictionary: self.is_e_ticket = dictionary['isETicket'] if 'isRegisteredCustomer' in dictionary: self.is_registered_customer = dictionary['isRegisteredCustomer'] if 'isRestrictedTicket' in dictionary: self.is_restricted_ticket = dictionary['isRestrictedTicket'] if 'isThirdParty' in dictionary: self.is_third_party = dictionary['isThirdParty'] if 'issueDate' in dictionary: self.issue_date = dictionary['issueDate'] if 'merchantCustomerId' in dictionary: self.merchant_customer_id = dictionary['merchantCustomerId'] if 'name' in dictionary: self.name = dictionary['name'] if 'numberInParty' in dictionary: self.number_in_party = dictionary['numberInParty'] if 'passengerName' in dictionary: self.passenger_name = dictionary['passengerName'] if 'passengers' in dictionary: if not isinstance(dictionary['passengers'], list): raise TypeError('value \'{}\' is not a list'.format(dictionary['passengers'])) self.passengers = [] for element in dictionary['passengers']: value = AirlinePassenger() self.passengers.append(value.from_dictionary(element)) if 'placeOfIssue' in dictionary: self.place_of_issue = dictionary['placeOfIssue'] if 'pnr' in dictionary: self.pnr = dictionary['pnr'] if 'pointOfSale' in dictionary: self.point_of_sale = dictionary['pointOfSale'] if 'posCityCode' in dictionary: self.pos_city_code = dictionary['posCityCode'] if 'ticketDeliveryMethod' in dictionary: self.ticket_delivery_method = dictionary['ticketDeliveryMethod'] if 'ticketNumber' in dictionary: self.ticket_number = dictionary['ticketNumber'] if 'totalFare' in dictionary: self.total_fare = dictionary['totalFare'] if 'totalFee' in dictionary: self.total_fee = dictionary['totalFee'] if 'totalTaxes' in dictionary: self.total_taxes = dictionary['totalTaxes'] if 'travelAgencyName' in dictionary: self.travel_agency_name = dictionary['travelAgencyName'] return self