onlinepayments-sdk-python3 4.23.0__zip → 5.1.0__zip

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/airline_data.py

@@ -1,90 +1,85 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from typing import List
+from typing import List, Optional
 
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.airline_flight_leg import AirlineFlightLeg
-from onlinepayments.sdk.domain.airline_passenger import AirlinePassenger
+from .airline_flight_leg import AirlineFlightLeg
+from .airline_passenger import AirlinePassenger
+from .data_object import DataObject
 
 
 class AirlineData(DataObject):
-    """
-    | Object that holds airline specific data
-    """
-
-    __agent_numeric_code = None
-    __code = None
-    __flight_date = None
-    __flight_indicator = None
-    __flight_legs = None
-    __invoice_number = None
-    __is_e_ticket = None
-    __is_restricted_ticket = None
-    __is_third_party = None
-    __issue_date = None
-    __merchant_customer_id = None
-    __name = None
-    __passenger_name = None
-    __passengers = None
-    __place_of_issue = None
-    __pnr = None
-    __point_of_sale = None
-    __pos_city_code = None
-    __ticket_currency = None
-    __ticket_delivery_method = None
-    __ticket_number = None
-    __total_fare = None
-    __total_fee = None
-    __total_taxes = None
-    __travel_agency_name = None
+
+    __agent_numeric_code: Optional[str] = None
+    __code: Optional[str] = None
+    __flight_date: Optional[str] = None
+    __flight_indicator: Optional[str] = None
+    __flight_legs: Optional[List[AirlineFlightLeg]] = None
+    __invoice_number: Optional[str] = None
+    __is_e_ticket: Optional[bool] = None
+    __is_restricted_ticket: Optional[bool] = None
+    __is_third_party: Optional[bool] = None
+    __issue_date: Optional[str] = None
+    __merchant_customer_id: Optional[str] = None
+    __name: Optional[str] = None
+    __passenger_name: Optional[str] = None
+    __passengers: Optional[List[AirlinePassenger]] = None
+    __place_of_issue: Optional[str] = None
+    __pnr: Optional[str] = None
+    __point_of_sale: Optional[str] = None
+    __pos_city_code: Optional[str] = None
+    __ticket_currency: Optional[str] = None
+    __ticket_delivery_method: Optional[str] = None
+    __ticket_number: Optional[str] = None
+    __total_fare: Optional[int] = None
+    __total_fee: Optional[int] = None
+    __total_taxes: Optional[int] = None
+    __travel_agency_name: Optional[str] = None
 
     @property
-    def agent_numeric_code(self) -> str:
+    def agent_numeric_code(self) -> Optional[str]:
         """
-        | Numeric code identifying the agent
-        | This field is used by the following payment products: 840
+        | Numeric code identifying the agent This field is used by the following payment products: 840
 
         Type: str
         """
         return self.__agent_numeric_code
 
     @agent_numeric_code.setter
-    def agent_numeric_code(self, value: str):
+    def agent_numeric_code(self, value: Optional[str]) -> None:
         self.__agent_numeric_code = value
 
     @property
-    def code(self) -> str:
+    def code(self) -> Optional[str]:
         """
-        | Airline numeric code
-        | This field is used by the following payment products: 840
+        | Airline numeric code This field is used by the following payment products: 840
 
         Type: str
         """
         return self.__code
 
     @code.setter
-    def code(self, value: str):
+    def code(self, value: Optional[str]) -> None:
         self.__code = value
 
     @property
-    def flight_date(self) -> str:
+    def flight_date(self) -> Optional[str]:
         """
-        | Deprecated: This field is not used by any payment product
-        | Date of the Flight
-        | Format: YYYYMMDD
+        | Deprecated: This field is not used by any payment product Date of the Flight Format: YYYYMMDD
 
         Type: str
+
+        Deprecated; This field is not used by any payment product Date of the Flight Format: YYYYMMDD
         """
         return self.__flight_date
 
     @flight_date.setter
-    def flight_date(self, value: str):
+    def flight_date(self, value: Optional[str]) -> None:
         self.__flight_date = value
 
     @property
-    def flight_indicator(self) -> str:
+    def flight_indicator(self) -> Optional[str]:
         """
         | Indicator representing the type of flight on the itinerary.
 
@@ -93,11 +88,11 @@ class AirlineData(DataObject):
         return self.__flight_indicator
 
     @flight_indicator.setter
-    def flight_indicator(self, value: str):
+    def flight_indicator(self, value: Optional[str]) -> None:
         self.__flight_indicator = value
 
     @property
-    def flight_legs(self) -> List[AirlineFlightLeg]:
+    def flight_legs(self) -> Optional[List[AirlineFlightLeg]]:
         """
         | Object that holds the data on the individual legs of the flight ticket
 
@@ -106,198 +101,203 @@ class AirlineData(DataObject):
         return self.__flight_legs
 
     @flight_legs.setter
-    def flight_legs(self, value: List[AirlineFlightLeg]):
+    def flight_legs(self, value: Optional[List[AirlineFlightLeg]]) -> None:
         self.__flight_legs = value
 
     @property
-    def invoice_number(self) -> str:
+    def invoice_number(self) -> Optional[str]:
         """
-        | Airline tracing number
-        | This field is used by the following payment products: cards
+        | Airline tracing number This field is used by the following payment products: cards
 
         Type: str
         """
         return self.__invoice_number
 
     @invoice_number.setter
-    def invoice_number(self, value: str):
+    def invoice_number(self, value: Optional[str]) -> None:
         self.__invoice_number = value
 
     @property
-    def is_e_ticket(self) -> bool:
+    def is_e_ticket(self) -> Optional[bool]:
         """
         | Deprecated: This field is not used by any payment product
-        |  * true = The ticket is an E-Ticket
-        |  * false = the ticket is not an E-Ticket'
+        
+        * true = The ticket is an E-Ticket
+        * false = the ticket is not an E-Ticket'
 
         Type: bool
+
+        Deprecated; Deprecated
         """
         return self.__is_e_ticket
 
     @is_e_ticket.setter
-    def is_e_ticket(self, value: bool):
+    def is_e_ticket(self, value: Optional[bool]) -> None:
         self.__is_e_ticket = value
 
     @property
-    def is_restricted_ticket(self) -> bool:
+    def is_restricted_ticket(self) -> Optional[bool]:
         """
         | Indicates if the ticket is refundable or not.
-        |  * true - Restricted, the ticket is non-refundable
-        |  * false - No restrictions, the ticket is (partially) refundable
-        | This field is used by the following payment products: 840
+        
+        * true - Restricted, the ticket is non-refundable
+        * false - No restrictions, the ticket is (partially) refundable This field is used by the following payment products: 840
 
         Type: bool
         """
         return self.__is_restricted_ticket
 
     @is_restricted_ticket.setter
-    def is_restricted_ticket(self, value: bool):
+    def is_restricted_ticket(self, value: Optional[bool]) -> None:
         self.__is_restricted_ticket = value
 
     @property
-    def is_third_party(self) -> bool:
+    def is_third_party(self) -> Optional[bool]:
         """
         | Deprecated: This field is not used by any payment product
-        |  * true - The payer is the ticket holder
-        |  * false - The payer is not the ticket holder
+        
+        * true - The payer is the ticket holder
+        * false - The payer is not the ticket holder
 
         Type: bool
+
+        Deprecated; This field is not used by any payment product  * true - The payer is the ticket holder  * false - The payer is not the ticket holder
         """
         return self.__is_third_party
 
     @is_third_party.setter
-    def is_third_party(self, value: bool):
+    def is_third_party(self, value: Optional[bool]) -> None:
         self.__is_third_party = value
 
     @property
-    def issue_date(self) -> str:
+    def issue_date(self) -> Optional[str]:
         """
-        | This is the date of issue recorded in the airline system In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date.
-        | Format: YYYYMMDD
-        | This field is used by the following payment products: cards, 840
+        | This is the date of issue recorded in the airline system In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date. Format: YYYYMMDD This field is used by the following payment products: cards, 840
 
         Type: str
         """
         return self.__issue_date
 
     @issue_date.setter
-    def issue_date(self, value: str):
+    def issue_date(self, value: Optional[str]) -> None:
         self.__issue_date = value
 
     @property
-    def merchant_customer_id(self) -> str:
+    def merchant_customer_id(self) -> Optional[str]:
         """
-        | Your ID of the customer in the context of the airline data
-        | This field is used by the following payment products: 840
+        | Your ID of the customer in the context of the airline data This field is used by the following payment products: 840
 
         Type: str
         """
         return self.__merchant_customer_id
 
     @merchant_customer_id.setter
-    def merchant_customer_id(self, value: str):
+    def merchant_customer_id(self, value: Optional[str]) -> None:
         self.__merchant_customer_id = value
 
     @property
-    def name(self) -> str:
+    def name(self) -> Optional[str]:
         """
-        | Deprecated: This field is not used by any payment product
-        | Name of the airline
+        | Deprecated: This field is not used by any payment product Name of the airline
 
         Type: str
+
+        Deprecated; This field is not used by any payment product Name of the airline
         """
         return self.__name
 
     @name.setter
-    def name(self, value: str):
+    def name(self, value: Optional[str]) -> None:
         self.__name = value
 
     @property
-    def passenger_name(self) -> str:
+    def passenger_name(self) -> Optional[str]:
         """
-        | Deprecated: Use passengers instead
-        | Name of passenger
+        | Deprecated: Use passengers instead Name of passenger
 
         Type: str
+
+        Deprecated; Use passengers instead Name of passenger
         """
         return self.__passenger_name
 
     @passenger_name.setter
-    def passenger_name(self, value: str):
+    def passenger_name(self, value: Optional[str]) -> None:
         self.__passenger_name = value
 
     @property
-    def passengers(self) -> List[AirlinePassenger]:
+    def passengers(self) -> Optional[List[AirlinePassenger]]:
         """
-        | Object that holds the data on the individual passengers
-        | This field is used by the following payment products: cards, 840
+        | Object that holds the data on the individual passengers This field is used by the following payment products: cards, 840
 
         Type: list[:class:`onlinepayments.sdk.domain.airline_passenger.AirlinePassenger`]
         """
         return self.__passengers
 
     @passengers.setter
-    def passengers(self, value: List[AirlinePassenger]):
+    def passengers(self, value: Optional[List[AirlinePassenger]]) -> None:
         self.__passengers = value
 
     @property
-    def place_of_issue(self) -> str:
+    def place_of_issue(self) -> Optional[str]:
         """
-        | Deprecated: This field is not used by any payment product
-        | Place of issue
-        | For sales in the US the last two characters (pos 14-15) must be the US state code.
+        | Deprecated: This field is not used by any payment product Place of issue For sales in the US the last two characters (pos 14-15) must be the US state code.
 
         Type: str
+
+        Deprecated; This field is not used by any payment product Place of issue For sales in the US the last two characters (pos 14-15) must be the US state code.
         """
         return self.__place_of_issue
 
     @place_of_issue.setter
-    def place_of_issue(self, value: str):
+    def place_of_issue(self, value: Optional[str]) -> None:
         self.__place_of_issue = value
 
     @property
-    def pnr(self) -> str:
+    def pnr(self) -> Optional[str]:
         """
         | ***Deprecated***. Use passengers instead.
 
         Type: str
+
+        Deprecated; Use passengers instead.
         """
         return self.__pnr
 
     @pnr.setter
-    def pnr(self, value: str):
+    def pnr(self, value: Optional[str]) -> None:
         self.__pnr = value
 
     @property
-    def point_of_sale(self) -> str:
+    def point_of_sale(self) -> Optional[str]:
         """
-        | IATA point of sale name
-        | This field is used by the following payment products: 840
+        | IATA point of sale name This field is used by the following payment products: 840
 
         Type: str
         """
         return self.__point_of_sale
 
     @point_of_sale.setter
-    def point_of_sale(self, value: str):
+    def point_of_sale(self, value: Optional[str]) -> None:
         self.__point_of_sale = value
 
     @property
-    def pos_city_code(self) -> str:
+    def pos_city_code(self) -> Optional[str]:
         """
-        | Deprecated: This field is not used by any payment product
-        | City code of the point of sale
+        | Deprecated: This field is not used by any payment product City code of the point of sale
 
         Type: str
+
+        Deprecated; This field is not used by any payment product City code of the point of sale
         """
         return self.__pos_city_code
 
     @pos_city_code.setter
-    def pos_city_code(self, value: str):
+    def pos_city_code(self, value: Optional[str]) -> None:
         self.__pos_city_code = value
 
     @property
-    def ticket_currency(self) -> str:
+    def ticket_currency(self) -> Optional[str]:
         """
         | Three-letter ISO currency code representing the currency in which ticket purchase amount is expressed.
 
@@ -306,98 +306,95 @@ class AirlineData(DataObject):
         return self.__ticket_currency
 
     @ticket_currency.setter
-    def ticket_currency(self, value: str):
+    def ticket_currency(self, value: Optional[str]) -> None:
         self.__ticket_currency = value
 
     @property
-    def ticket_delivery_method(self) -> str:
+    def ticket_delivery_method(self) -> Optional[str]:
         """
-        | Deprecated: This field is not used by any payment product
-        | Delivery method of the ticket
+        | Deprecated: This field is not used by any payment product Delivery method of the ticket
 
         Type: str
+
+        Deprecated; This field is not used by any payment product Delivery method of the ticket
         """
         return self.__ticket_delivery_method
 
     @ticket_delivery_method.setter
-    def ticket_delivery_method(self, value: str):
+    def ticket_delivery_method(self, value: Optional[str]) -> None:
         self.__ticket_delivery_method = value
 
     @property
-    def ticket_number(self) -> str:
+    def ticket_number(self) -> Optional[str]:
         """
         | The ticket or document number 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
-        | This field is used by the following payment products: cards, 840
+        
+        * 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 This field is used by the following payment products: cards, 840
 
         Type: str
         """
         return self.__ticket_number
 
     @ticket_number.setter
-    def ticket_number(self, value: str):
+    def ticket_number(self, value: Optional[str]) -> None:
         self.__ticket_number = value
 
     @property
-    def total_fare(self) -> int:
+    def total_fare(self) -> Optional[int]:
         """
-        | 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
-        | This field is used by the following payment products: 840
+        | 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 This field is used by the following payment products: 840
 
         Type: int
         """
         return self.__total_fare
 
     @total_fare.setter
-    def total_fare(self, value: int):
+    def total_fare(self, value: Optional[int]) -> None:
         self.__total_fare = value
 
     @property
-    def total_fee(self) -> int:
+    def total_fee(self) -> Optional[int]:
         """
-        | Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
-        | This field is used by the following payment products: 840
+        | Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets This field is used by the following payment products: 840
 
         Type: int
         """
         return self.__total_fee
 
     @total_fee.setter
-    def total_fee(self, value: int):
+    def total_fee(self, value: Optional[int]) -> None:
         self.__total_fee = value
 
     @property
-    def total_taxes(self) -> int:
+    def total_taxes(self) -> Optional[int]:
         """
-        | Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
-        | This field is used by the following payment products: 840
+        | Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets This field is used by the following payment products: 840
 
         Type: int
         """
         return self.__total_taxes
 
     @total_taxes.setter
-    def total_taxes(self, value: int):
+    def total_taxes(self, value: Optional[int]) -> None:
         self.__total_taxes = value
 
     @property
-    def travel_agency_name(self) -> str:
+    def travel_agency_name(self) -> Optional[str]:
         """
-        | Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank
-        | This field is used by the following payment products: 840
+        | Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank This field is used by the following payment products: 840
 
         Type: str
         """
         return self.__travel_agency_name
 
     @travel_agency_name.setter
-    def travel_agency_name(self, value: str):
+    def travel_agency_name(self, value: Optional[str]) -> None:
         self.__travel_agency_name = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(AirlineData, self).to_dictionary()
         if self.agent_numeric_code is not None:
             dictionary['agentNumericCode'] = self.agent_numeric_code
@@ -457,7 +454,7 @@ class AirlineData(DataObject):
             dictionary['travelAgencyName'] = self.travel_agency_name
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'AirlineData':
         super(AirlineData, self).from_dictionary(dictionary)
         if 'agentNumericCode' in dictionary:
             self.agent_numeric_code = dictionary['agentNumericCode']