onlinepayments-sdk-python3 4.23.0__zip → 5.1.0__zip

onlinepayments_sdk_python3-5.1.0/onlinepayments/sdk/domain/subsequent_card_payment_method_specific_input.py

@@ -0,0 +1,153 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class SubsequentCardPaymentMethodSpecificInput(DataObject):
+
+    __authorization_mode: Optional[str] = None
+    __payment_number: Optional[int] = None
+    __scheme_reference_data: Optional[str] = None
+    __subsequent_type: Optional[str] = None
+    __token: Optional[str] = None
+    __transaction_channel: Optional[str] = None
+
+    @property
+    def authorization_mode(self) -> Optional[str]:
+        """
+        | Determines the type of the authorization that will be used. Allowed values:
+        
+        * FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can't be reversed and need to be captured for the full amount within 7 days.
+        * PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount.
+        * SALE - The payment creation results in an authorization that is already captured at the moment of approval.
+        
+        | Only used with some acquirers, ignored for acquirers that do not support this. In case the acquirer does not allow this to be specified the authorizationMode is 'unspecified', which behaves similar to a final authorization.
+
+        Type: str
+        """
+        return self.__authorization_mode
+
+    @authorization_mode.setter
+    def authorization_mode(self, value: Optional[str]) -> None:
+        self.__authorization_mode = value
+
+    @property
+    def payment_number(self) -> Optional[int]:
+        """
+        | This payment's ordinal number in the sequence of payments.  As the payments are numbered from 1 to the totalNumberOfPayments provided at initialization of the sequence in the multiplePaymentInformation container, the allowed values for this field actually depend on whether the initial call to CreatePayment or CreateHostedCheckout led to a payment or not.
+        
+        * if the initial call led to a payment, since it is implicitly numbered 1, then the allowed values for this field range from 2 to the totalNumberOfPayments.
+        * if the initial call did not lead to a payment (e.g. this was a 0 amount operation for authentication), then the allowed values for this field range from 1 to the totalNumberOfPayments.
+
+        Type: int
+        """
+        return self.__payment_number
+
+    @payment_number.setter
+    def payment_number(self, value: Optional[int]) -> None:
+        self.__payment_number = value
+
+    @property
+    def scheme_reference_data(self) -> Optional[str]:
+        """
+        | Deprecated: This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication. In case this value is unknown, a Scheme Reference of an earlier transaction that was part of the same sequence can be used as a fall-back. Still, it is strongly advised to submit this value for any Merchant Initiated Transaction or any recurring transaction (hereby defined as "Subsequent").
+
+        Type: str
+
+        Deprecated; Deprecated
+        """
+        return self.__scheme_reference_data
+
+    @scheme_reference_data.setter
+    def scheme_reference_data(self, value: Optional[str]) -> None:
+        self.__scheme_reference_data = value
+
+    @property
+    def subsequent_type(self) -> Optional[str]:
+        """
+        | Determines the type of the subsequent that will be used. Allowed values:
+        
+        * Recurring - Transactions processed at fixed, regular intervals not to exceed one year between Transactions, representing an agreement between a cardholder and a merchant to purchase goods or services provided over a period of time. Note that a recurring MIT transaction is initiated by the merchant (payee) not the customer (payer) and so is out of scope of PSD2. Recurring transactions that are in scope of PSD2 (and therefore may benefit from the recurring transaction exemption) are those that are customer (payer) initiates, e.g. standing orders set up from a bank account.
+        * Unscheduled - A transaction using a stored credential for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date, where the cardholder has provided consent for the merchant to initiate one or more future transactions which are not initiated by the cardholder. This transaction type is based on an agreement with the cardholder and is not to be confused with cardholder initiated transactions performed with stored credentials (CITs are in scope of PSD2 whereas UCOF transactions are MITs and thus out of scope).
+        * Installment - Installment payments describe a single purchase of goods or services billed to a cardholder in multiple transactions over a period of time agreed by the cardholder and merchant.
+        * NoShow - A No-show is a transaction where the merchant is enabled to charge for services which the cardholder entered into an agreement to purchase but did not meet the terms of the agreement.
+        * DelayedCharge - A delayed charge is typically used in hotel, cruise lines and vehicle rental payment scenarios to perform a supplemental account charge after original services are rendered.
+        * PartialShipment - I-P e-Commerce scenario whereby credentials have been stored to enable subsequent MITs per shipment. For this type of use case, PartialShipment is expected on both the initial CIT and eventual subsequent MITs to complete the order.
+        * Resubmission - This is an event that occurs when the original purchase occurred, but the merchant was not able to get authorization at the time the goods or services were provided. This is only applicable to contactless transit transactions.
+
+        Type: str
+        """
+        return self.__subsequent_type
+
+    @subsequent_type.setter
+    def subsequent_type(self, value: Optional[str]) -> None:
+        self.__subsequent_type = value
+
+    @property
+    def token(self) -> Optional[str]:
+        """
+        | Deprecated: ID of the token to use to create the payment.
+
+        Type: str
+
+        Deprecated; ID of the token to use to create the payment.
+        """
+        return self.__token
+
+    @token.setter
+    def token(self, value: Optional[str]) -> None:
+        self.__token = value
+
+    @property
+    def transaction_channel(self) -> Optional[str]:
+        """
+        | Indicates the channel via which the payment is created. Allowed values:
+        
+        * ECOMMERCE - The transaction is a regular E-Commerce transaction.
+        * MOTO - The transaction is a Mail Order/Telephone Order.
+        
+        | Defaults to ECOMMERCE.
+
+        Type: str
+        """
+        return self.__transaction_channel
+
+    @transaction_channel.setter
+    def transaction_channel(self, value: Optional[str]) -> None:
+        self.__transaction_channel = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(SubsequentCardPaymentMethodSpecificInput, self).to_dictionary()
+        if self.authorization_mode is not None:
+            dictionary['authorizationMode'] = self.authorization_mode
+        if self.payment_number is not None:
+            dictionary['paymentNumber'] = self.payment_number
+        if self.scheme_reference_data is not None:
+            dictionary['schemeReferenceData'] = self.scheme_reference_data
+        if self.subsequent_type is not None:
+            dictionary['subsequentType'] = self.subsequent_type
+        if self.token is not None:
+            dictionary['token'] = self.token
+        if self.transaction_channel is not None:
+            dictionary['transactionChannel'] = self.transaction_channel
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'SubsequentCardPaymentMethodSpecificInput':
+        super(SubsequentCardPaymentMethodSpecificInput, self).from_dictionary(dictionary)
+        if 'authorizationMode' in dictionary:
+            self.authorization_mode = dictionary['authorizationMode']
+        if 'paymentNumber' in dictionary:
+            self.payment_number = dictionary['paymentNumber']
+        if 'schemeReferenceData' in dictionary:
+            self.scheme_reference_data = dictionary['schemeReferenceData']
+        if 'subsequentType' in dictionary:
+            self.subsequent_type = dictionary['subsequentType']
+        if 'token' in dictionary:
+            self.token = dictionary['token']
+        if 'transactionChannel' in dictionary:
+            self.transaction_channel = dictionary['transactionChannel']
+        return self

onlinepayments_sdk_python3-5.1.0/onlinepayments/sdk/domain/subsequent_payment_product5001_specific_input.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class SubsequentPaymentProduct5001SpecificInput(DataObject):
+
+    __subsequent_type: Optional[str] = None
+
+    @property
+    def subsequent_type(self) -> Optional[str]:
+        """
+        | Determines the type of the subsequent that will be used. Allowed values:
+        
+        * recurring - Transactions processed at fixed, regular intervals not to exceed one year between Transactions, representing an agreement between a consumer and a merchant to purchase goods or services provided over a period of time. Note that a recurring MIT transaction is initiated by the merchant (payee) not the customer (payer) and so is out of scope of PSD2. Recurring transactions that are in scope of PSD2 (and therefore may benefit from the recurring transaction exemption) are those that are customer (payer) initiates, e.g. standing orders set up from a bank account.
+        * installment - Installment payments describe a single purchase of goods or services billed to a consumer in multiple transactions over a period of time agreed by the consumer and merchant.
+        * other - other cases
+
+        Type: str
+        """
+        return self.__subsequent_type
+
+    @subsequent_type.setter
+    def subsequent_type(self, value: Optional[str]) -> None:
+        self.__subsequent_type = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(SubsequentPaymentProduct5001SpecificInput, self).to_dictionary()
+        if self.subsequent_type is not None:
+            dictionary['subsequentType'] = self.subsequent_type
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'SubsequentPaymentProduct5001SpecificInput':
+        super(SubsequentPaymentProduct5001SpecificInput, self).from_dictionary(dictionary)
+        if 'subsequentType' in dictionary:
+            self.subsequent_type = dictionary['subsequentType']
+        return self

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

@@ -1,34 +1,36 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.order import Order
-from onlinepayments.sdk.domain.subsequent_card_payment_method_specific_input import SubsequentCardPaymentMethodSpecificInput
-from onlinepayments.sdk.domain.subsequent_payment_product5001_specific_input import SubsequentPaymentProduct5001SpecificInput
+from typing import Optional
+
+from .data_object import DataObject
+from .order import Order
+from .subsequent_card_payment_method_specific_input import SubsequentCardPaymentMethodSpecificInput
+from .subsequent_payment_product5001_specific_input import SubsequentPaymentProduct5001SpecificInput
 
 
 class SubsequentPaymentRequest(DataObject):
-    __order = None
-    __subsequent_payment_product5001_specific_input = None
-    __subsequentcard_payment_method_specific_input = None
+
+    __order: Optional[Order] = None
+    __subsequent_payment_product5001_specific_input: Optional[SubsequentPaymentProduct5001SpecificInput] = None
+    __subsequentcard_payment_method_specific_input: Optional[SubsequentCardPaymentMethodSpecificInput] = None
 
     @property
-    def order(self) -> Order:
+    def order(self) -> Optional[Order]:
         """
-        | Order object containing order related data 
-        |  Please note that this object is required to be able to submit the amount.
+        | Order object containing order related data Please note that this object is required to be able to submit the amount.
 
         Type: :class:`onlinepayments.sdk.domain.order.Order`
         """
         return self.__order
 
     @order.setter
-    def order(self, value: Order):
+    def order(self, value: Optional[Order]) -> None:
         self.__order = value
 
     @property
-    def subsequent_payment_product5001_specific_input(self) -> SubsequentPaymentProduct5001SpecificInput:
+    def subsequent_payment_product5001_specific_input(self) -> Optional[SubsequentPaymentProduct5001SpecificInput]:
         """
         | specific data required for Bizum subsequent payment
 
@@ -37,11 +39,11 @@ class SubsequentPaymentRequest(DataObject):
         return self.__subsequent_payment_product5001_specific_input
 
     @subsequent_payment_product5001_specific_input.setter
-    def subsequent_payment_product5001_specific_input(self, value: SubsequentPaymentProduct5001SpecificInput):
+    def subsequent_payment_product5001_specific_input(self, value: Optional[SubsequentPaymentProduct5001SpecificInput]) -> None:
         self.__subsequent_payment_product5001_specific_input = value
 
     @property
-    def subsequentcard_payment_method_specific_input(self) -> SubsequentCardPaymentMethodSpecificInput:
+    def subsequentcard_payment_method_specific_input(self) -> Optional[SubsequentCardPaymentMethodSpecificInput]:
         """
         | Object containing the specific input details for subsequent card payments
 
@@ -50,10 +52,10 @@ class SubsequentPaymentRequest(DataObject):
         return self.__subsequentcard_payment_method_specific_input
 
     @subsequentcard_payment_method_specific_input.setter
-    def subsequentcard_payment_method_specific_input(self, value: SubsequentCardPaymentMethodSpecificInput):
+    def subsequentcard_payment_method_specific_input(self, value: Optional[SubsequentCardPaymentMethodSpecificInput]) -> None:
         self.__subsequentcard_payment_method_specific_input = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(SubsequentPaymentRequest, self).to_dictionary()
         if self.order is not None:
             dictionary['order'] = self.order.to_dictionary()
@@ -63,7 +65,7 @@ class SubsequentPaymentRequest(DataObject):
             dictionary['subsequentcardPaymentMethodSpecificInput'] = self.subsequentcard_payment_method_specific_input.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'SubsequentPaymentRequest':
         super(SubsequentPaymentRequest, self).from_dictionary(dictionary)
         if 'order' in dictionary:
             if not isinstance(dictionary['order'], dict):

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

@@ -1,20 +1,19 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.payment_response import PaymentResponse
+from typing import Optional
+
+from .data_object import DataObject
+from .payment_response import PaymentResponse
 
 
 class SubsequentPaymentResponse(DataObject):
-    """
-    | Object that contains details on the created payment in case one has been created.
-    """
 
-    __payment = None
+    __payment: Optional[PaymentResponse] = None
 
     @property
-    def payment(self) -> PaymentResponse:
+    def payment(self) -> Optional[PaymentResponse]:
         """
         | Object that holds the payment related properties
 
@@ -23,16 +22,16 @@ class SubsequentPaymentResponse(DataObject):
         return self.__payment
 
     @payment.setter
-    def payment(self, value: PaymentResponse):
+    def payment(self, value: Optional[PaymentResponse]) -> None:
         self.__payment = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(SubsequentPaymentResponse, self).to_dictionary()
         if self.payment is not None:
             dictionary['payment'] = self.payment.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'SubsequentPaymentResponse':
         super(SubsequentPaymentResponse, self).from_dictionary(dictionary)
         if 'payment' in dictionary:
             if not isinstance(dictionary['payment'], dict):

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

@@ -1,22 +1,25 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.amount_of_money import AmountOfMoney
-from onlinepayments.sdk.domain.surcharge_rate import SurchargeRate
+from typing import Optional
+
+from .amount_of_money import AmountOfMoney
+from .data_object import DataObject
+from .surcharge_rate import SurchargeRate
 
 
 class Surcharge(DataObject):
-    __net_amount = None
-    __payment_product_id = None
-    __result = None
-    __surcharge_amount = None
-    __surcharge_rate = None
-    __total_amount = None
+
+    __net_amount: Optional[AmountOfMoney] = None
+    __payment_product_id: Optional[int] = None
+    __result: Optional[str] = None
+    __surcharge_amount: Optional[AmountOfMoney] = None
+    __surcharge_rate: Optional[SurchargeRate] = None
+    __total_amount: Optional[AmountOfMoney] = None
 
     @property
-    def net_amount(self) -> AmountOfMoney:
+    def net_amount(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -25,11 +28,11 @@ class Surcharge(DataObject):
         return self.__net_amount
 
     @net_amount.setter
-    def net_amount(self, value: AmountOfMoney):
+    def net_amount(self, value: Optional[AmountOfMoney]) -> None:
         self.__net_amount = value
 
     @property
-    def payment_product_id(self) -> int:
+    def payment_product_id(self) -> Optional[int]:
         """
         | Payment product identifier - Please see Products documentation for a full overview of possible values.
 
@@ -38,11 +41,11 @@ class Surcharge(DataObject):
         return self.__payment_product_id
 
     @payment_product_id.setter
-    def payment_product_id(self, value: int):
+    def payment_product_id(self, value: Optional[int]) -> None:
         self.__payment_product_id = value
 
     @property
-    def result(self) -> str:
+    def result(self) -> Optional[str]:
         """
         | Token describing result. OK - A Surcharge Amount was successfully calculated, NO_SURCHARGE - A configured surcharge rate could not be found for the payment product
 
@@ -51,11 +54,11 @@ class Surcharge(DataObject):
         return self.__result
 
     @result.setter
-    def result(self, value: str):
+    def result(self, value: Optional[str]) -> None:
         self.__result = value
 
     @property
-    def surcharge_amount(self) -> AmountOfMoney:
+    def surcharge_amount(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -64,11 +67,11 @@ class Surcharge(DataObject):
         return self.__surcharge_amount
 
     @surcharge_amount.setter
-    def surcharge_amount(self, value: AmountOfMoney):
+    def surcharge_amount(self, value: Optional[AmountOfMoney]) -> None:
         self.__surcharge_amount = value
 
     @property
-    def surcharge_rate(self) -> SurchargeRate:
+    def surcharge_rate(self) -> Optional[SurchargeRate]:
         """
         | A summary of surcharge details used in the calculation of the surcharge amount. null if result = NO_SURCHARGE
 
@@ -77,11 +80,11 @@ class Surcharge(DataObject):
         return self.__surcharge_rate
 
     @surcharge_rate.setter
-    def surcharge_rate(self, value: SurchargeRate):
+    def surcharge_rate(self, value: Optional[SurchargeRate]) -> None:
         self.__surcharge_rate = value
 
     @property
-    def total_amount(self) -> AmountOfMoney:
+    def total_amount(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -90,10 +93,10 @@ class Surcharge(DataObject):
         return self.__total_amount
 
     @total_amount.setter
-    def total_amount(self, value: AmountOfMoney):
+    def total_amount(self, value: Optional[AmountOfMoney]) -> None:
         self.__total_amount = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(Surcharge, self).to_dictionary()
         if self.net_amount is not None:
             dictionary['netAmount'] = self.net_amount.to_dictionary()
@@ -109,7 +112,7 @@ class Surcharge(DataObject):
             dictionary['totalAmount'] = self.total_amount.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'Surcharge':
         super(Surcharge, self).from_dictionary(dictionary)
         if 'netAmount' in dictionary:
             if not isinstance(dictionary['netAmount'], dict):

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

@@ -1,34 +1,32 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class SurchargeCalculationCard(DataObject):
-    """
-    | An object containing card number and payment product id, which is used to determine surcharge product type
-    """
 
-    __card_number = None
-    __payment_product_id = None
+    __card_number: Optional[str] = None
+    __payment_product_id: Optional[int] = None
 
     @property
-    def card_number(self) -> str:
+    def card_number(self) -> Optional[str]:
         """
-        | The complete credit/debit card number (also know as the PAN)
-        | The card number is always obfuscated in any of our responses
+        | The complete credit/debit card number (also know as the PAN) The card number is always obfuscated in any of our responses
 
         Type: str
         """
         return self.__card_number
 
     @card_number.setter
-    def card_number(self, value: str):
+    def card_number(self, value: Optional[str]) -> None:
         self.__card_number = value
 
     @property
-    def payment_product_id(self) -> int:
+    def payment_product_id(self) -> Optional[int]:
         """
         | Payment product identifier - Please see Products documentation for a full overview of possible values.
 
@@ -37,10 +35,10 @@ class SurchargeCalculationCard(DataObject):
         return self.__payment_product_id
 
     @payment_product_id.setter
-    def payment_product_id(self, value: int):
+    def payment_product_id(self, value: Optional[int]) -> None:
         self.__payment_product_id = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(SurchargeCalculationCard, self).to_dictionary()
         if self.card_number is not None:
             dictionary['cardNumber'] = self.card_number
@@ -48,7 +46,7 @@ class SurchargeCalculationCard(DataObject):
             dictionary['paymentProductId'] = self.payment_product_id
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'SurchargeCalculationCard':
         super(SurchargeCalculationCard, self).from_dictionary(dictionary)
         if 'cardNumber' in dictionary:
             self.card_number = dictionary['cardNumber']

onlinepayments_sdk_python3-5.1.0/onlinepayments/sdk/domain/surcharge_for_payment_link.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class SurchargeForPaymentLink(DataObject):
+
+    __surcharge_mode: Optional[str] = None
+
+    @property
+    def surcharge_mode(self) -> Optional[str]:
+        """
+        | The surcharge mode which defines how a merchant will apply surcharging.
+        
+        * pass-through - Merchant to define and apply surcharge amount for a transaction for processing. This mode is not supported on Create Hosted Checkout Session.
+        * on-behalf-of - Merchant to instruct the payment platform to calculate and apply a surcharge amount to a transaction, based on the merchant’s surcharge configuration, net amount, and payment product type.
+
+        Type: str
+        """
+        return self.__surcharge_mode
+
+    @surcharge_mode.setter
+    def surcharge_mode(self, value: Optional[str]) -> None:
+        self.__surcharge_mode = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(SurchargeForPaymentLink, self).to_dictionary()
+        if self.surcharge_mode is not None:
+            dictionary['surchargeMode'] = self.surcharge_mode
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'SurchargeForPaymentLink':
+        super(SurchargeForPaymentLink, self).from_dictionary(dictionary)
+        if 'surchargeMode' in dictionary:
+            self.surcharge_mode = dictionary['surchargeMode']
+        return self

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

@@ -1,22 +1,21 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class SurchargeRate(DataObject):
-    """
-    | A summary of surcharge details used in the calculation of the surcharge amount. null if result = NO_SURCHARGE
-    """
 
-    __ad_valorem_rate = None
-    __specific_rate = None
-    __surcharge_product_type_id = None
-    __surcharge_product_type_version = None
+    __ad_valorem_rate: Optional[float] = None
+    __specific_rate: Optional[int] = None
+    __surcharge_product_type_id: Optional[str] = None
+    __surcharge_product_type_version: Optional[str] = None
 
     @property
-    def ad_valorem_rate(self) -> float:
+    def ad_valorem_rate(self) -> Optional[float]:
         """
         | A percentage rate defined on a merchant's configuration used in the calculation of a surcharge amount.
 
@@ -25,11 +24,11 @@ class SurchargeRate(DataObject):
         return self.__ad_valorem_rate
 
     @ad_valorem_rate.setter
-    def ad_valorem_rate(self, value: float):
+    def ad_valorem_rate(self, value: Optional[float]) -> None:
         self.__ad_valorem_rate = value
 
     @property
-    def specific_rate(self) -> int:
+    def specific_rate(self) -> Optional[int]:
         """
         | A specific, fixed rate in cents defined on a merchant's configuration that is used in the calculation of a surcharge amount.
 
@@ -38,11 +37,11 @@ class SurchargeRate(DataObject):
         return self.__specific_rate
 
     @specific_rate.setter
-    def specific_rate(self, value: int):
+    def specific_rate(self, value: Optional[int]) -> None:
         self.__specific_rate = value
 
     @property
-    def surcharge_product_type_id(self) -> str:
+    def surcharge_product_type_id(self) -> Optional[str]:
         """
         | The name of the applicable surcharge rates for the relevant payment product
 
@@ -51,11 +50,11 @@ class SurchargeRate(DataObject):
         return self.__surcharge_product_type_id
 
     @surcharge_product_type_id.setter
-    def surcharge_product_type_id(self, value: str):
+    def surcharge_product_type_id(self, value: Optional[str]) -> None:
         self.__surcharge_product_type_id = value
 
     @property
-    def surcharge_product_type_version(self) -> str:
+    def surcharge_product_type_version(self) -> Optional[str]:
         """
         | A specific version identifier of the surcharge rates as applied for this request
 
@@ -64,10 +63,10 @@ class SurchargeRate(DataObject):
         return self.__surcharge_product_type_version
 
     @surcharge_product_type_version.setter
-    def surcharge_product_type_version(self, value: str):
+    def surcharge_product_type_version(self, value: Optional[str]) -> None:
         self.__surcharge_product_type_version = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(SurchargeRate, self).to_dictionary()
         if self.ad_valorem_rate is not None:
             dictionary['adValoremRate'] = self.ad_valorem_rate
@@ -79,7 +78,7 @@ class SurchargeRate(DataObject):
             dictionary['surchargeProductTypeVersion'] = self.surcharge_product_type_version
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'SurchargeRate':
         super(SurchargeRate, self).from_dictionary(dictionary)
         if 'adValoremRate' in dictionary:
             self.ad_valorem_rate = dictionary['adValoremRate']