onlinepayments-sdk-python3 7.4.1__py3-none-any.whl

onlinepayments/sdk/domain/mandate_response.py

@@ -0,0 +1,150 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .mandate_customer_response import MandateCustomerResponse
+
+
+class MandateResponse(DataObject):
+
+    __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) -> 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.
+
+        Type: str
+        """
+        return self.__alias
+
+    @alias.setter
+    def alias(self, value: Optional[str]) -> None:
+        self.__alias = value
+
+    @property
+    def customer(self) -> Optional[MandateCustomerResponse]:
+        """
+        | Customer object containing customer specific outputs.
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_customer_response.MandateCustomerResponse`
+        """
+        return self.__customer
+
+    @customer.setter
+    def customer(self, value: Optional[MandateCustomerResponse]) -> None:
+        self.__customer = value
+
+    @property
+    def customer_reference(self) -> Optional[str]:
+        """
+        | The unique identifier of a customer
+
+        Type: str
+        """
+        return self.__customer_reference
+
+    @customer_reference.setter
+    def customer_reference(self, value: Optional[str]) -> None:
+        self.__customer_reference = value
+
+    @property
+    def mandate_pdf(self) -> Optional[str]:
+        """
+        | The mandate PDF in base64 encoded string
+
+        Type: str
+        """
+        return self.__mandate_pdf
+
+    @mandate_pdf.setter
+    def mandate_pdf(self, value: Optional[str]) -> None:
+        self.__mandate_pdf = value
+
+    @property
+    def recurrence_type(self) -> Optional[str]:
+        """
+        | Specifies whether the mandate is for one-off or recurring payments. Possible values are:
+        
+        * UNIQUE
+        * RECURRING
+
+        Type: str
+        """
+        return self.__recurrence_type
+
+    @recurrence_type.setter
+    def recurrence_type(self, value: Optional[str]) -> None:
+        self.__recurrence_type = value
+
+    @property
+    def status(self) -> Optional[str]:
+        """
+        Type: str
+        """
+        return self.__status
+
+    @status.setter
+    def status(self, value: Optional[str]) -> None:
+        self.__status = value
+
+    @property
+    def unique_mandate_reference(self) -> Optional[str]:
+        """
+        | The unique identifier of the mandate
+
+        Type: str
+        """
+        return self.__unique_mandate_reference
+
+    @unique_mandate_reference.setter
+    def unique_mandate_reference(self, value: Optional[str]) -> None:
+        self.__unique_mandate_reference = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MandateResponse, self).to_dictionary()
+        if self.alias is not None:
+            dictionary['alias'] = self.alias
+        if self.customer is not None:
+            dictionary['customer'] = self.customer.to_dictionary()
+        if self.customer_reference is not None:
+            dictionary['customerReference'] = self.customer_reference
+        if self.mandate_pdf is not None:
+            dictionary['mandatePdf'] = self.mandate_pdf
+        if self.recurrence_type is not None:
+            dictionary['recurrenceType'] = self.recurrence_type
+        if self.status is not None:
+            dictionary['status'] = self.status
+        if self.unique_mandate_reference is not None:
+            dictionary['uniqueMandateReference'] = self.unique_mandate_reference
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MandateResponse':
+        super(MandateResponse, self).from_dictionary(dictionary)
+        if 'alias' in dictionary:
+            self.alias = dictionary['alias']
+        if 'customer' in dictionary:
+            if not isinstance(dictionary['customer'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['customer']))
+            value = MandateCustomerResponse()
+            self.customer = value.from_dictionary(dictionary['customer'])
+        if 'customerReference' in dictionary:
+            self.customer_reference = dictionary['customerReference']
+        if 'mandatePdf' in dictionary:
+            self.mandate_pdf = dictionary['mandatePdf']
+        if 'recurrenceType' in dictionary:
+            self.recurrence_type = dictionary['recurrenceType']
+        if 'status' in dictionary:
+            self.status = dictionary['status']
+        if 'uniqueMandateReference' in dictionary:
+            self.unique_mandate_reference = dictionary['uniqueMandateReference']
+        return self

onlinepayments/sdk/domain/market_place.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class MarketPlace(DataObject):
+
+    __retailer_country: Optional[str] = None
+    __retailer_name: Optional[str] = None
+
+    @property
+    def retailer_country(self) -> Optional[str]:
+        """
+        | ISO 3166-1 alpha-2 country code of the retailer.
+
+        Type: str
+        """
+        return self.__retailer_country
+
+    @retailer_country.setter
+    def retailer_country(self, value: Optional[str]) -> None:
+        self.__retailer_country = value
+
+    @property
+    def retailer_name(self) -> Optional[str]:
+        """
+        | This field is required if the transaction is performed by a merchant using the marketplace. This field must contain the name of the end merchant.
+
+        Type: str
+        """
+        return self.__retailer_name
+
+    @retailer_name.setter
+    def retailer_name(self, value: Optional[str]) -> None:
+        self.__retailer_name = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MarketPlace, self).to_dictionary()
+        if self.retailer_country is not None:
+            dictionary['retailerCountry'] = self.retailer_country
+        if self.retailer_name is not None:
+            dictionary['retailerName'] = self.retailer_name
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MarketPlace':
+        super(MarketPlace, self).from_dictionary(dictionary)
+        if 'retailerCountry' in dictionary:
+            self.retailer_country = dictionary['retailerCountry']
+        if 'retailerName' in dictionary:
+            self.retailer_name = dictionary['retailerName']
+        return self

onlinepayments/sdk/domain/merchant_action.py

@@ -0,0 +1,132 @@
+# -*- 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
+from .show_instructions_data import ShowInstructionsData
+
+
+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
+    __show_instructions_data: Optional[ShowInstructionsData] = 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
+
+    @property
+    def show_instructions_data(self) -> Optional[ShowInstructionsData]:
+        """
+        | Object returned for the SHOW_INSTRUCTIONS actionType.
+
+        Type: :class:`onlinepayments.sdk.domain.show_instructions_data.ShowInstructionsData`
+        """
+        return self.__show_instructions_data
+
+    @show_instructions_data.setter
+    def show_instructions_data(self, value: Optional[ShowInstructionsData]) -> None:
+        self.__show_instructions_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()
+        if self.show_instructions_data is not None:
+            dictionary['showInstructionsData'] = self.show_instructions_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'])
+        if 'showInstructionsData' in dictionary:
+            if not isinstance(dictionary['showInstructionsData'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['showInstructionsData']))
+            value = ShowInstructionsData()
+            self.show_instructions_data = value.from_dictionary(dictionary['showInstructionsData'])
+        return self

onlinepayments/sdk/domain/mobile_payment_data.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class MobilePaymentData(DataObject):
+
+    __dpan: Optional[str] = None
+    __expiry_date: Optional[str] = None
+
+    @property
+    def dpan(self) -> Optional[str]:
+        """
+        | The obfuscated DPAN. Only the last four digits are visible.
+
+        Type: str
+        """
+        return self.__dpan
+
+    @dpan.setter
+    def dpan(self, value: Optional[str]) -> None:
+        self.__dpan = value
+
+    @property
+    def expiry_date(self) -> Optional[str]:
+        """
+        | Expiry date of the tokenized card. Format: MMYY
+
+        Type: str
+        """
+        return self.__expiry_date
+
+    @expiry_date.setter
+    def expiry_date(self, value: Optional[str]) -> None:
+        self.__expiry_date = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MobilePaymentData, self).to_dictionary()
+        if self.dpan is not None:
+            dictionary['dpan'] = self.dpan
+        if self.expiry_date is not None:
+            dictionary['expiryDate'] = self.expiry_date
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MobilePaymentData':
+        super(MobilePaymentData, self).from_dictionary(dictionary)
+        if 'dpan' in dictionary:
+            self.dpan = dictionary['dpan']
+        if 'expiryDate' in dictionary:
+            self.expiry_date = dictionary['expiryDate']
+        return self

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.
+
+        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