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

onlinepayments/sdk/domain/mandate_customer.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .bank_account_iban import BankAccountIban
+from .data_object import DataObject
+from .mandate_address import MandateAddress
+from .mandate_contact_details import MandateContactDetails
+from .mandate_personal_information import MandatePersonalInformation
+
+
+class MandateCustomer(DataObject):
+
+    __bank_account_iban: Optional[BankAccountIban] = None
+    __company_name: Optional[str] = None
+    __contact_details: Optional[MandateContactDetails] = None
+    __mandate_address: Optional[MandateAddress] = None
+    __personal_information: Optional[MandatePersonalInformation] = None
+
+    @property
+    def bank_account_iban(self) -> Optional[BankAccountIban]:
+        """
+        | Object containing IBAN information
+
+        Type: :class:`onlinepayments.sdk.domain.bank_account_iban.BankAccountIban`
+        """
+        return self.__bank_account_iban
+
+    @bank_account_iban.setter
+    def bank_account_iban(self, value: Optional[BankAccountIban]) -> None:
+        self.__bank_account_iban = value
+
+    @property
+    def company_name(self) -> Optional[str]:
+        """
+        | Name of company, as a customer
+
+        Type: str
+        """
+        return self.__company_name
+
+    @company_name.setter
+    def company_name(self, value: Optional[str]) -> None:
+        self.__company_name = value
+
+    @property
+    def contact_details(self) -> Optional[MandateContactDetails]:
+        """
+        | Object containing email address
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_contact_details.MandateContactDetails`
+        """
+        return self.__contact_details
+
+    @contact_details.setter
+    def contact_details(self, value: Optional[MandateContactDetails]) -> None:
+        self.__contact_details = value
+
+    @property
+    def mandate_address(self) -> Optional[MandateAddress]:
+        """
+        | Object containing consumer address details. Required for Create mandate and Create payment calls. Required for Create hostedCheckout calls where the IBAN is also provided.
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_address.MandateAddress`
+        """
+        return self.__mandate_address
+
+    @mandate_address.setter
+    def mandate_address(self, value: Optional[MandateAddress]) -> None:
+        self.__mandate_address = value
+
+    @property
+    def personal_information(self) -> Optional[MandatePersonalInformation]:
+        """
+        | Object containing personal information of the customer. Required for Create mandate and Create payment calls.
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_personal_information.MandatePersonalInformation`
+        """
+        return self.__personal_information
+
+    @personal_information.setter
+    def personal_information(self, value: Optional[MandatePersonalInformation]) -> None:
+        self.__personal_information = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MandateCustomer, self).to_dictionary()
+        if self.bank_account_iban is not None:
+            dictionary['bankAccountIban'] = self.bank_account_iban.to_dictionary()
+        if self.company_name is not None:
+            dictionary['companyName'] = self.company_name
+        if self.contact_details is not None:
+            dictionary['contactDetails'] = self.contact_details.to_dictionary()
+        if self.mandate_address is not None:
+            dictionary['mandateAddress'] = self.mandate_address.to_dictionary()
+        if self.personal_information is not None:
+            dictionary['personalInformation'] = self.personal_information.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MandateCustomer':
+        super(MandateCustomer, self).from_dictionary(dictionary)
+        if 'bankAccountIban' in dictionary:
+            if not isinstance(dictionary['bankAccountIban'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['bankAccountIban']))
+            value = BankAccountIban()
+            self.bank_account_iban = value.from_dictionary(dictionary['bankAccountIban'])
+        if 'companyName' in dictionary:
+            self.company_name = dictionary['companyName']
+        if 'contactDetails' in dictionary:
+            if not isinstance(dictionary['contactDetails'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['contactDetails']))
+            value = MandateContactDetails()
+            self.contact_details = value.from_dictionary(dictionary['contactDetails'])
+        if 'mandateAddress' in dictionary:
+            if not isinstance(dictionary['mandateAddress'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['mandateAddress']))
+            value = MandateAddress()
+            self.mandate_address = value.from_dictionary(dictionary['mandateAddress'])
+        if 'personalInformation' in dictionary:
+            if not isinstance(dictionary['personalInformation'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['personalInformation']))
+            value = MandatePersonalInformation()
+            self.personal_information = value.from_dictionary(dictionary['personalInformation'])
+        return self

onlinepayments/sdk/domain/mandate_customer_response.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .bank_account_iban import BankAccountIban
+from .data_object import DataObject
+from .mandate_address_response import MandateAddressResponse
+from .mandate_contact_details import MandateContactDetails
+from .mandate_personal_information_response import MandatePersonalInformationResponse
+
+
+class MandateCustomerResponse(DataObject):
+
+    __bank_account_iban: Optional[BankAccountIban] = None
+    __company_name: Optional[str] = None
+    __contact_details: Optional[MandateContactDetails] = None
+    __mandate_address: Optional[MandateAddressResponse] = None
+    __personal_information: Optional[MandatePersonalInformationResponse] = None
+
+    @property
+    def bank_account_iban(self) -> Optional[BankAccountIban]:
+        """
+        | Object containing IBAN information
+
+        Type: :class:`onlinepayments.sdk.domain.bank_account_iban.BankAccountIban`
+        """
+        return self.__bank_account_iban
+
+    @bank_account_iban.setter
+    def bank_account_iban(self, value: Optional[BankAccountIban]) -> None:
+        self.__bank_account_iban = value
+
+    @property
+    def company_name(self) -> Optional[str]:
+        """
+        | Name of company, as a customer
+
+        Type: str
+        """
+        return self.__company_name
+
+    @company_name.setter
+    def company_name(self, value: Optional[str]) -> None:
+        self.__company_name = value
+
+    @property
+    def contact_details(self) -> Optional[MandateContactDetails]:
+        """
+        | Object containing email address
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_contact_details.MandateContactDetails`
+        """
+        return self.__contact_details
+
+    @contact_details.setter
+    def contact_details(self, value: Optional[MandateContactDetails]) -> None:
+        self.__contact_details = value
+
+    @property
+    def mandate_address(self) -> Optional[MandateAddressResponse]:
+        """
+        | Object containing consumer address details
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_address_response.MandateAddressResponse`
+        """
+        return self.__mandate_address
+
+    @mandate_address.setter
+    def mandate_address(self, value: Optional[MandateAddressResponse]) -> None:
+        self.__mandate_address = value
+
+    @property
+    def personal_information(self) -> Optional[MandatePersonalInformationResponse]:
+        """
+        | Object containing personal information of the customer
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_personal_information_response.MandatePersonalInformationResponse`
+        """
+        return self.__personal_information
+
+    @personal_information.setter
+    def personal_information(self, value: Optional[MandatePersonalInformationResponse]) -> None:
+        self.__personal_information = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MandateCustomerResponse, self).to_dictionary()
+        if self.bank_account_iban is not None:
+            dictionary['bankAccountIban'] = self.bank_account_iban.to_dictionary()
+        if self.company_name is not None:
+            dictionary['companyName'] = self.company_name
+        if self.contact_details is not None:
+            dictionary['contactDetails'] = self.contact_details.to_dictionary()
+        if self.mandate_address is not None:
+            dictionary['mandateAddress'] = self.mandate_address.to_dictionary()
+        if self.personal_information is not None:
+            dictionary['personalInformation'] = self.personal_information.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MandateCustomerResponse':
+        super(MandateCustomerResponse, self).from_dictionary(dictionary)
+        if 'bankAccountIban' in dictionary:
+            if not isinstance(dictionary['bankAccountIban'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['bankAccountIban']))
+            value = BankAccountIban()
+            self.bank_account_iban = value.from_dictionary(dictionary['bankAccountIban'])
+        if 'companyName' in dictionary:
+            self.company_name = dictionary['companyName']
+        if 'contactDetails' in dictionary:
+            if not isinstance(dictionary['contactDetails'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['contactDetails']))
+            value = MandateContactDetails()
+            self.contact_details = value.from_dictionary(dictionary['contactDetails'])
+        if 'mandateAddress' in dictionary:
+            if not isinstance(dictionary['mandateAddress'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['mandateAddress']))
+            value = MandateAddressResponse()
+            self.mandate_address = value.from_dictionary(dictionary['mandateAddress'])
+        if 'personalInformation' in dictionary:
+            if not isinstance(dictionary['personalInformation'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['personalInformation']))
+            value = MandatePersonalInformationResponse()
+            self.personal_information = value.from_dictionary(dictionary['personalInformation'])
+        return self

onlinepayments/sdk/domain/mandate_merchant_action.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .mandate_redirect_data import MandateRedirectData
+
+
+class MandateMerchantAction(DataObject):
+
+    __action_type: Optional[str] = None
+    __redirect_data: Optional[MandateRedirectData] = None
+
+    @property
+    def action_type(self) -> Optional[str]:
+        """
+        | Action merchants needs to take in the online mandate process. Possible values are:
+        
+        * REDIRECT - The customer needs to be redirected using the details found in redirectData
+
+        Type: str
+        """
+        return self.__action_type
+
+    @action_type.setter
+    def action_type(self, value: Optional[str]) -> None:
+        self.__action_type = value
+
+    @property
+    def redirect_data(self) -> Optional[MandateRedirectData]:
+        """
+        | Object containing all data needed to redirect the customer
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_redirect_data.MandateRedirectData`
+        """
+        return self.__redirect_data
+
+    @redirect_data.setter
+    def redirect_data(self, value: Optional[MandateRedirectData]) -> None:
+        self.__redirect_data = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MandateMerchantAction, self).to_dictionary()
+        if self.action_type is not None:
+            dictionary['actionType'] = self.action_type
+        if self.redirect_data is not None:
+            dictionary['redirectData'] = self.redirect_data.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MandateMerchantAction':
+        super(MandateMerchantAction, self).from_dictionary(dictionary)
+        if 'actionType' in dictionary:
+            self.action_type = dictionary['actionType']
+        if 'redirectData' in dictionary:
+            if not isinstance(dictionary['redirectData'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['redirectData']))
+            value = MandateRedirectData()
+            self.redirect_data = value.from_dictionary(dictionary['redirectData'])
+        return self

onlinepayments/sdk/domain/mandate_personal_information.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .mandate_personal_name import MandatePersonalName
+
+
+class MandatePersonalInformation(DataObject):
+
+    __name: Optional[MandatePersonalName] = None
+    __title: Optional[str] = None
+
+    @property
+    def name(self) -> Optional[MandatePersonalName]:
+        """
+        | Object containing the name details of the customer. Required for Create mandate and Create payment calls.
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_personal_name.MandatePersonalName`
+        """
+        return self.__name
+
+    @name.setter
+    def name(self, value: Optional[MandatePersonalName]) -> None:
+        self.__name = value
+
+    @property
+    def title(self) -> Optional[str]:
+        """
+        | Object containing the title of the customer (Mr, Miss or Mrs)
+
+        Type: str
+        """
+        return self.__title
+
+    @title.setter
+    def title(self, value: Optional[str]) -> None:
+        self.__title = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MandatePersonalInformation, self).to_dictionary()
+        if self.name is not None:
+            dictionary['name'] = self.name.to_dictionary()
+        if self.title is not None:
+            dictionary['title'] = self.title
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MandatePersonalInformation':
+        super(MandatePersonalInformation, self).from_dictionary(dictionary)
+        if 'name' in dictionary:
+            if not isinstance(dictionary['name'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['name']))
+            value = MandatePersonalName()
+            self.name = value.from_dictionary(dictionary['name'])
+        if 'title' in dictionary:
+            self.title = dictionary['title']
+        return self

onlinepayments/sdk/domain/mandate_personal_information_response.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .mandate_personal_name_response import MandatePersonalNameResponse
+
+
+class MandatePersonalInformationResponse(DataObject):
+
+    __name: Optional[MandatePersonalNameResponse] = None
+    __title: Optional[str] = None
+
+    @property
+    def name(self) -> Optional[MandatePersonalNameResponse]:
+        """
+        | Object containing the name details of the customer.
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_personal_name_response.MandatePersonalNameResponse`
+        """
+        return self.__name
+
+    @name.setter
+    def name(self, value: Optional[MandatePersonalNameResponse]) -> None:
+        self.__name = value
+
+    @property
+    def title(self) -> Optional[str]:
+        """
+        | Object containing the title of the customer (Mr, Miss or Mrs)
+
+        Type: str
+        """
+        return self.__title
+
+    @title.setter
+    def title(self, value: Optional[str]) -> None:
+        self.__title = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MandatePersonalInformationResponse, self).to_dictionary()
+        if self.name is not None:
+            dictionary['name'] = self.name.to_dictionary()
+        if self.title is not None:
+            dictionary['title'] = self.title
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MandatePersonalInformationResponse':
+        super(MandatePersonalInformationResponse, self).from_dictionary(dictionary)
+        if 'name' in dictionary:
+            if not isinstance(dictionary['name'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['name']))
+            value = MandatePersonalNameResponse()
+            self.name = value.from_dictionary(dictionary['name'])
+        if 'title' in dictionary:
+            self.title = dictionary['title']
+        return self

onlinepayments/sdk/domain/mandate_personal_name.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class MandatePersonalName(DataObject):
+
+    __first_name: Optional[str] = None
+    __surname: Optional[str] = None
+
+    @property
+    def first_name(self) -> Optional[str]:
+        """
+        | 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: Optional[str]) -> None:
+        self.__first_name = value
+
+    @property
+    def surname(self) -> Optional[str]:
+        """
+        | 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: Optional[str]) -> None:
+        self.__surname = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MandatePersonalName, self).to_dictionary()
+        if self.first_name is not None:
+            dictionary['firstName'] = self.first_name
+        if self.surname is not None:
+            dictionary['surname'] = self.surname
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MandatePersonalName':
+        super(MandatePersonalName, self).from_dictionary(dictionary)
+        if 'firstName' in dictionary:
+            self.first_name = dictionary['firstName']
+        if 'surname' in dictionary:
+            self.surname = dictionary['surname']
+        return self

onlinepayments/sdk/domain/mandate_personal_name_response.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class MandatePersonalNameResponse(DataObject):
+
+    __first_name: Optional[str] = None
+    __surname: Optional[str] = None
+
+    @property
+    def first_name(self) -> Optional[str]:
+        """
+        | Given name(s) or first name(s) of the customer.
+
+        Type: str
+        """
+        return self.__first_name
+
+    @first_name.setter
+    def first_name(self, value: Optional[str]) -> None:
+        self.__first_name = value
+
+    @property
+    def surname(self) -> Optional[str]:
+        """
+        | Surname(s) or last name(s) of the customer.
+
+        Type: str
+        """
+        return self.__surname
+
+    @surname.setter
+    def surname(self, value: Optional[str]) -> None:
+        self.__surname = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MandatePersonalNameResponse, self).to_dictionary()
+        if self.first_name is not None:
+            dictionary['firstName'] = self.first_name
+        if self.surname is not None:
+            dictionary['surname'] = self.surname
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MandatePersonalNameResponse':
+        super(MandatePersonalNameResponse, self).from_dictionary(dictionary)
+        if 'firstName' in dictionary:
+            self.first_name = dictionary['firstName']
+        if 'surname' in dictionary:
+            self.surname = dictionary['surname']
+        return self

onlinepayments/sdk/domain/mandate_redirect_data.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class MandateRedirectData(DataObject):
+
+    __returnmac: Optional[str] = None
+    __redirect_url: Optional[str] = None
+
+    @property
+    def returnmac(self) -> Optional[str]:
+        """
+        | A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment.
+
+        Type: str
+        """
+        return self.__returnmac
+
+    @returnmac.setter
+    def returnmac(self, value: Optional[str]) -> None:
+        self.__returnmac = value
+
+    @property
+    def redirect_url(self) -> Optional[str]:
+        """
+        | The URL that the customer should be redirected to. Be sure to redirect using the GET method.
+
+        Type: str
+        """
+        return self.__redirect_url
+
+    @redirect_url.setter
+    def redirect_url(self, value: Optional[str]) -> None:
+        self.__redirect_url = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(MandateRedirectData, self).to_dictionary()
+        if self.returnmac is not None:
+            dictionary['RETURNMAC'] = self.returnmac
+        if self.redirect_url is not None:
+            dictionary['redirectURL'] = self.redirect_url
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'MandateRedirectData':
+        super(MandateRedirectData, self).from_dictionary(dictionary)
+        if 'RETURNMAC' in dictionary:
+            self.returnmac = dictionary['RETURNMAC']
+        if 'redirectURL' in dictionary:
+            self.redirect_url = dictionary['redirectURL']
+        return self