onlinepayments-sdk-python3 4.23.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/mandate_personal_name.py

@@ -1,48 +1,44 @@
 # -*- 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 MandatePersonalName(DataObject):
-    """
-    | Object containing the name details of the customer.
-    | Required for Create mandate and Create payment calls.
-    """
 
-    __first_name = None
-    __surname = None
+    __first_name: Optional[str] = None
+    __surname: Optional[str] = None
 
     @property
-    def first_name(self) -> str:
+    def first_name(self) -> Optional[str]:
         """
-        | Given name(s) or first name(s) of the customer.
-        | Required for Create mandate and Create payment calls.
+        | Given name(s) or first name(s) of the customer. Required for Create mandate and Create payment calls.
 
         Type: str
         """
         return self.__first_name
 
     @first_name.setter
-    def first_name(self, value: str):
+    def first_name(self, value: Optional[str]) -> None:
         self.__first_name = value
 
     @property
-    def surname(self) -> str:
+    def surname(self) -> Optional[str]:
         """
-        | Surname(s) or last name(s) of the customer.
-        | Required for Create mandate and Create payment calls.
+        | Surname(s) or last name(s) of the customer. Required for Create mandate and Create payment calls.
 
         Type: str
         """
         return self.__surname
 
     @surname.setter
-    def surname(self, value: str):
+    def surname(self, value: Optional[str]) -> None:
         self.__surname = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(MandatePersonalName, self).to_dictionary()
         if self.first_name is not None:
             dictionary['firstName'] = self.first_name
@@ -50,7 +46,7 @@ class MandatePersonalName(DataObject):
             dictionary['surname'] = self.surname
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'MandatePersonalName':
         super(MandatePersonalName, self).from_dictionary(dictionary)
         if 'firstName' in dictionary:
             self.first_name = dictionary['firstName']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/mandate_personal_name_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 typing import Optional
+
+from .data_object import DataObject
 
 
 class MandatePersonalNameResponse(DataObject):
-    """
-    | Object containing the name details of the customer.
-    """
 
-    __first_name = None
-    __surname = None
+    __first_name: Optional[str] = None
+    __surname: Optional[str] = None
 
     @property
-    def first_name(self) -> str:
+    def first_name(self) -> Optional[str]:
         """
         | Given name(s) or first name(s) of the customer.
 
@@ -23,11 +22,11 @@ class MandatePersonalNameResponse(DataObject):
         return self.__first_name
 
     @first_name.setter
-    def first_name(self, value: str):
+    def first_name(self, value: Optional[str]) -> None:
         self.__first_name = value
 
     @property
-    def surname(self) -> str:
+    def surname(self) -> Optional[str]:
         """
         | Surname(s) or last name(s) of the customer.
 
@@ -36,10 +35,10 @@ class MandatePersonalNameResponse(DataObject):
         return self.__surname
 
     @surname.setter
-    def surname(self, value: str):
+    def surname(self, value: Optional[str]) -> None:
         self.__surname = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(MandatePersonalNameResponse, self).to_dictionary()
         if self.first_name is not None:
             dictionary['firstName'] = self.first_name
@@ -47,7 +46,7 @@ class MandatePersonalNameResponse(DataObject):
             dictionary['surname'] = self.surname
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'MandatePersonalNameResponse':
         super(MandatePersonalNameResponse, self).from_dictionary(dictionary)
         if 'firstName' in dictionary:
             self.first_name = dictionary['firstName']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/mandate_redirect_data.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 typing import Optional
+
+from .data_object import DataObject
 
 
 class MandateRedirectData(DataObject):
-    """
-    | Object containing all data needed to redirect the customer
-    """
 
-    __returnmac = None
-    __redirect_url = None
+    __returnmac: Optional[str] = None
+    __redirect_url: Optional[str] = None
 
     @property
-    def returnmac(self) -> str:
+    def returnmac(self) -> Optional[str]:
         """
         | A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment.
 
@@ -23,11 +22,11 @@ class MandateRedirectData(DataObject):
         return self.__returnmac
 
     @returnmac.setter
-    def returnmac(self, value: str):
+    def returnmac(self, value: Optional[str]) -> None:
         self.__returnmac = value
 
     @property
-    def redirect_url(self) -> str:
+    def redirect_url(self) -> Optional[str]:
         """
         | The URL that the customer should be redirected to. Be sure to redirect using the GET method.
 
@@ -36,10 +35,10 @@ class MandateRedirectData(DataObject):
         return self.__redirect_url
 
     @redirect_url.setter
-    def redirect_url(self, value: str):
+    def redirect_url(self, value: Optional[str]) -> None:
         self.__redirect_url = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(MandateRedirectData, self).to_dictionary()
         if self.returnmac is not None:
             dictionary['RETURNMAC'] = self.returnmac
@@ -47,7 +46,7 @@ class MandateRedirectData(DataObject):
             dictionary['redirectURL'] = self.redirect_url
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'MandateRedirectData':
         super(MandateRedirectData, self).from_dictionary(dictionary)
         if 'RETURNMAC' in dictionary:
             self.returnmac = dictionary['RETURNMAC']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/mandate_response.py

@@ -1,26 +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.mandate_customer_response import MandateCustomerResponse
+from typing import Optional
+
+from .data_object import DataObject
+from .mandate_customer_response import MandateCustomerResponse
 
 
 class MandateResponse(DataObject):
-    """
-    | Object containing the created mandate.
-    """
-
-    __alias = None
-    __customer = None
-    __customer_reference = None
-    __mandate_pdf = None
-    __recurrence_type = None
-    __status = None
-    __unique_mandate_reference = None
+
+    __alias: Optional[str] = None
+    __customer: Optional[MandateCustomerResponse] = None
+    __customer_reference: Optional[str] = None
+    __mandate_pdf: Optional[str] = None
+    __recurrence_type: Optional[str] = None
+    __status: Optional[str] = None
+    __unique_mandate_reference: Optional[str] = None
 
     @property
-    def alias(self) -> str:
+    def alias(self) -> Optional[str]:
         """
         | An alias for the mandate. This can be used to visually represent the mandate. Do not include any unmasked sensitive data in the alias. If this field is not provided the masked IBAN of the customer is used.
 
@@ -29,11 +28,11 @@ class MandateResponse(DataObject):
         return self.__alias
 
     @alias.setter
-    def alias(self, value: str):
+    def alias(self, value: Optional[str]) -> None:
         self.__alias = value
 
     @property
-    def customer(self) -> MandateCustomerResponse:
+    def customer(self) -> Optional[MandateCustomerResponse]:
         """
         | Customer object containing customer specific outputs.
 
@@ -42,11 +41,11 @@ class MandateResponse(DataObject):
         return self.__customer
 
     @customer.setter
-    def customer(self, value: MandateCustomerResponse):
+    def customer(self, value: Optional[MandateCustomerResponse]) -> None:
         self.__customer = value
 
     @property
-    def customer_reference(self) -> str:
+    def customer_reference(self) -> Optional[str]:
         """
         | The unique identifier of a customer
 
@@ -55,11 +54,11 @@ class MandateResponse(DataObject):
         return self.__customer_reference
 
     @customer_reference.setter
-    def customer_reference(self, value: str):
+    def customer_reference(self, value: Optional[str]) -> None:
         self.__customer_reference = value
 
     @property
-    def mandate_pdf(self) -> str:
+    def mandate_pdf(self) -> Optional[str]:
         """
         | The mandate PDF in base64 encoded string
 
@@ -68,37 +67,38 @@ class MandateResponse(DataObject):
         return self.__mandate_pdf
 
     @mandate_pdf.setter
-    def mandate_pdf(self, value: str):
+    def mandate_pdf(self, value: Optional[str]) -> None:
         self.__mandate_pdf = value
 
     @property
-    def recurrence_type(self) -> str:
+    def recurrence_type(self) -> Optional[str]:
         """
         | Specifies whether the mandate is for one-off or recurring payments. Possible values are:
-        | * UNIQUE
-        | * RECURRING
+        
+        * UNIQUE
+        * RECURRING
 
         Type: str
         """
         return self.__recurrence_type
 
     @recurrence_type.setter
-    def recurrence_type(self, value: str):
+    def recurrence_type(self, value: Optional[str]) -> None:
         self.__recurrence_type = value
 
     @property
-    def status(self) -> str:
+    def status(self) -> Optional[str]:
         """
         Type: str
         """
         return self.__status
 
     @status.setter
-    def status(self, value: str):
+    def status(self, value: Optional[str]) -> None:
         self.__status = value
 
     @property
-    def unique_mandate_reference(self) -> str:
+    def unique_mandate_reference(self) -> Optional[str]:
         """
         | The unique identifier of the mandate
 
@@ -107,10 +107,10 @@ class MandateResponse(DataObject):
         return self.__unique_mandate_reference
 
     @unique_mandate_reference.setter
-    def unique_mandate_reference(self, value: str):
+    def unique_mandate_reference(self, value: Optional[str]) -> None:
         self.__unique_mandate_reference = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(MandateResponse, self).to_dictionary()
         if self.alias is not None:
             dictionary['alias'] = self.alias
@@ -128,7 +128,7 @@ class MandateResponse(DataObject):
             dictionary['uniqueMandateReference'] = self.unique_mandate_reference
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'MandateResponse':
         super(MandateResponse, self).from_dictionary(dictionary)
         if 'alias' in dictionary:
             self.alias = dictionary['alias']

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/domain/merchant_action.py

@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .mobile_three_d_secure_challenge_parameters import MobileThreeDSecureChallengeParameters
+from .redirect_data import RedirectData
+from .show_form_data import ShowFormData
+
+
+class MerchantAction(DataObject):
+
+    __action_type: Optional[str] = None
+    __mobile_three_d_secure_challenge_parameters: Optional[MobileThreeDSecureChallengeParameters] = None
+    __redirect_data: Optional[RedirectData] = None
+    __show_form_data: Optional[ShowFormData] = None
+
+    @property
+    def action_type(self) -> Optional[str]:
+        """
+        | Action merchants needs to take in the online payment process. Possible values are:
+        
+        * REDIRECT - The customer needs to be redirected using the details found in redirectData
+        * SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request.
+        * SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData
+        * SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData
+        * MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object.
+        * CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
+
+        Type: str
+        """
+        return self.__action_type
+
+    @action_type.setter
+    def action_type(self, value: Optional[str]) -> None:
+        self.__action_type = value
+
+    @property
+    def mobile_three_d_secure_challenge_parameters(self) -> Optional[MobileThreeDSecureChallengeParameters]:
+        """
+        | Mobile 3D Secure Challenge Parameters
+
+        Type: :class:`onlinepayments.sdk.domain.mobile_three_d_secure_challenge_parameters.MobileThreeDSecureChallengeParameters`
+        """
+        return self.__mobile_three_d_secure_challenge_parameters
+
+    @mobile_three_d_secure_challenge_parameters.setter
+    def mobile_three_d_secure_challenge_parameters(self, value: Optional[MobileThreeDSecureChallengeParameters]) -> None:
+        self.__mobile_three_d_secure_challenge_parameters = value
+
+    @property
+    def redirect_data(self) -> Optional[RedirectData]:
+        """
+        | Object containing all data needed to redirect the customer
+
+        Type: :class:`onlinepayments.sdk.domain.redirect_data.RedirectData`
+        """
+        return self.__redirect_data
+
+    @redirect_data.setter
+    def redirect_data(self, value: Optional[RedirectData]) -> None:
+        self.__redirect_data = value
+
+    @property
+    def show_form_data(self) -> Optional[ShowFormData]:
+        """
+        | Object returned for the SHOW_FORM actionType.
+
+        Type: :class:`onlinepayments.sdk.domain.show_form_data.ShowFormData`
+        """
+        return self.__show_form_data
+
+    @show_form_data.setter
+    def show_form_data(self, value: Optional[ShowFormData]) -> None:
+        self.__show_form_data = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MerchantAction, self).to_dictionary()
+        if self.action_type is not None:
+            dictionary['actionType'] = self.action_type
+        if self.mobile_three_d_secure_challenge_parameters is not None:
+            dictionary['mobileThreeDSecureChallengeParameters'] = self.mobile_three_d_secure_challenge_parameters.to_dictionary()
+        if self.redirect_data is not None:
+            dictionary['redirectData'] = self.redirect_data.to_dictionary()
+        if self.show_form_data is not None:
+            dictionary['showFormData'] = self.show_form_data.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MerchantAction':
+        super(MerchantAction, self).from_dictionary(dictionary)
+        if 'actionType' in dictionary:
+            self.action_type = dictionary['actionType']
+        if 'mobileThreeDSecureChallengeParameters' in dictionary:
+            if not isinstance(dictionary['mobileThreeDSecureChallengeParameters'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['mobileThreeDSecureChallengeParameters']))
+            value = MobileThreeDSecureChallengeParameters()
+            self.mobile_three_d_secure_challenge_parameters = value.from_dictionary(dictionary['mobileThreeDSecureChallengeParameters'])
+        if 'redirectData' in dictionary:
+            if not isinstance(dictionary['redirectData'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['redirectData']))
+            value = RedirectData()
+            self.redirect_data = value.from_dictionary(dictionary['redirectData'])
+        if 'showFormData' in dictionary:
+            if not isinstance(dictionary['showFormData'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['showFormData']))
+            value = ShowFormData()
+            self.show_form_data = value.from_dictionary(dictionary['showFormData'])
+        return self

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/mobile_payment_data.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 typing import Optional
+
+from .data_object import DataObject
 
 
 class MobilePaymentData(DataObject):
-    """
-    | Object containing payment details
-    """
 
-    __dpan = None
-    __expiry_date = None
+    __dpan: Optional[str] = None
+    __expiry_date: Optional[str] = None
 
     @property
-    def dpan(self) -> str:
+    def dpan(self) -> Optional[str]:
         """
         | The obfuscated DPAN. Only the last four digits are visible.
 
@@ -23,11 +22,11 @@ class MobilePaymentData(DataObject):
         return self.__dpan
 
     @dpan.setter
-    def dpan(self, value: str):
+    def dpan(self, value: Optional[str]) -> None:
         self.__dpan = value
 
     @property
-    def expiry_date(self) -> str:
+    def expiry_date(self) -> Optional[str]:
         """
         | Expiry date of the tokenized card. Format: MMYY
 
@@ -36,10 +35,10 @@ class MobilePaymentData(DataObject):
         return self.__expiry_date
 
     @expiry_date.setter
-    def expiry_date(self, value: str):
+    def expiry_date(self, value: Optional[str]) -> None:
         self.__expiry_date = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(MobilePaymentData, self).to_dictionary()
         if self.dpan is not None:
             dictionary['dpan'] = self.dpan
@@ -47,7 +46,7 @@ class MobilePaymentData(DataObject):
             dictionary['expiryDate'] = self.expiry_date
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'MobilePaymentData':
         super(MobilePaymentData, self).from_dictionary(dictionary)
         if 'dpan' in dictionary:
             self.dpan = dictionary['dpan']

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/domain/mobile_payment_method_hosted_checkout_specific_input.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .mobile_payment_product302_specific_input import MobilePaymentProduct302SpecificInput
+from .mobile_payment_product320_specific_input import MobilePaymentProduct320SpecificInput
+
+
+class MobilePaymentMethodHostedCheckoutSpecificInput(DataObject):
+
+    __authorization_mode: Optional[str] = None
+    __payment_product302_specific_input: Optional[MobilePaymentProduct302SpecificInput] = None
+    __payment_product320_specific_input: Optional[MobilePaymentProduct320SpecificInput] = None
+    __payment_product_id: Optional[int] = 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_product302_specific_input(self) -> Optional[MobilePaymentProduct302SpecificInput]:
+        """
+        | Object containing information specific to Apple Pay. Required for payments with product 302.
+
+        Type: :class:`onlinepayments.sdk.domain.mobile_payment_product302_specific_input.MobilePaymentProduct302SpecificInput`
+        """
+        return self.__payment_product302_specific_input
+
+    @payment_product302_specific_input.setter
+    def payment_product302_specific_input(self, value: Optional[MobilePaymentProduct302SpecificInput]) -> None:
+        self.__payment_product302_specific_input = value
+
+    @property
+    def payment_product320_specific_input(self) -> Optional[MobilePaymentProduct320SpecificInput]:
+        """
+        | Object containing information specific to Google Pay. Required for payments with product 320.
+
+        Type: :class:`onlinepayments.sdk.domain.mobile_payment_product320_specific_input.MobilePaymentProduct320SpecificInput`
+        """
+        return self.__payment_product320_specific_input
+
+    @payment_product320_specific_input.setter
+    def payment_product320_specific_input(self, value: Optional[MobilePaymentProduct320SpecificInput]) -> None:
+        self.__payment_product320_specific_input = value
+
+    @property
+    def payment_product_id(self) -> Optional[int]:
+        """
+        | Payment product identifier - Please see Products documentation for a full overview of possible values.
+
+        Type: int
+        """
+        return self.__payment_product_id
+
+    @payment_product_id.setter
+    def payment_product_id(self, value: Optional[int]) -> None:
+        self.__payment_product_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MobilePaymentMethodHostedCheckoutSpecificInput, self).to_dictionary()
+        if self.authorization_mode is not None:
+            dictionary['authorizationMode'] = self.authorization_mode
+        if self.payment_product302_specific_input is not None:
+            dictionary['paymentProduct302SpecificInput'] = self.payment_product302_specific_input.to_dictionary()
+        if self.payment_product320_specific_input is not None:
+            dictionary['paymentProduct320SpecificInput'] = self.payment_product320_specific_input.to_dictionary()
+        if self.payment_product_id is not None:
+            dictionary['paymentProductId'] = self.payment_product_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MobilePaymentMethodHostedCheckoutSpecificInput':
+        super(MobilePaymentMethodHostedCheckoutSpecificInput, self).from_dictionary(dictionary)
+        if 'authorizationMode' in dictionary:
+            self.authorization_mode = dictionary['authorizationMode']
+        if 'paymentProduct302SpecificInput' in dictionary:
+            if not isinstance(dictionary['paymentProduct302SpecificInput'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['paymentProduct302SpecificInput']))
+            value = MobilePaymentProduct302SpecificInput()
+            self.payment_product302_specific_input = value.from_dictionary(dictionary['paymentProduct302SpecificInput'])
+        if 'paymentProduct320SpecificInput' in dictionary:
+            if not isinstance(dictionary['paymentProduct320SpecificInput'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['paymentProduct320SpecificInput']))
+            value = MobilePaymentProduct320SpecificInput()
+            self.payment_product320_specific_input = value.from_dictionary(dictionary['paymentProduct320SpecificInput'])
+        if 'paymentProductId' in dictionary:
+            self.payment_product_id = dictionary['paymentProductId']
+        return self