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

onlinepayments/sdk/domain/payment_product302_specific_data.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct302SpecificData(DataObject):
+
+    __networks: Optional[List[str]] = None
+
+    @property
+    def networks(self) -> Optional[List[str]]:
+        """
+        | The networks that can be used in the current payment context. The strings that represent the networks in the array are identical to the strings that Apple uses in their documentation. For instance "Visa".
+
+        Type: list[str]
+        """
+        return self.__networks
+
+    @networks.setter
+    def networks(self, value: Optional[List[str]]) -> None:
+        self.__networks = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct302SpecificData, self).to_dictionary()
+        if self.networks is not None:
+            dictionary['networks'] = []
+            for element in self.networks:
+                if element is not None:
+                    dictionary['networks'].append(element)
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct302SpecificData':
+        super(PaymentProduct302SpecificData, self).from_dictionary(dictionary)
+        if 'networks' in dictionary:
+            if not isinstance(dictionary['networks'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['networks']))
+            self.networks = []
+            for element in dictionary['networks']:
+                self.networks.append(element)
+        return self

onlinepayments/sdk/domain/payment_product3203_specific_output.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .address_personal import AddressPersonal
+from .data_object import DataObject
+
+
+class PaymentProduct3203SpecificOutput(DataObject):
+
+    __billing_address: Optional[AddressPersonal] = None
+    __shipping_address: Optional[AddressPersonal] = None
+
+    @property
+    def billing_address(self) -> Optional[AddressPersonal]:
+        """
+        | Object containing address information
+
+        Type: :class:`onlinepayments.sdk.domain.address_personal.AddressPersonal`
+        """
+        return self.__billing_address
+
+    @billing_address.setter
+    def billing_address(self, value: Optional[AddressPersonal]) -> None:
+        self.__billing_address = value
+
+    @property
+    def shipping_address(self) -> Optional[AddressPersonal]:
+        """
+        | Object containing address information
+
+        Type: :class:`onlinepayments.sdk.domain.address_personal.AddressPersonal`
+        """
+        return self.__shipping_address
+
+    @shipping_address.setter
+    def shipping_address(self, value: Optional[AddressPersonal]) -> None:
+        self.__shipping_address = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct3203SpecificOutput, self).to_dictionary()
+        if self.billing_address is not None:
+            dictionary['billingAddress'] = self.billing_address.to_dictionary()
+        if self.shipping_address is not None:
+            dictionary['shippingAddress'] = self.shipping_address.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct3203SpecificOutput':
+        super(PaymentProduct3203SpecificOutput, self).from_dictionary(dictionary)
+        if 'billingAddress' in dictionary:
+            if not isinstance(dictionary['billingAddress'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['billingAddress']))
+            value = AddressPersonal()
+            self.billing_address = value.from_dictionary(dictionary['billingAddress'])
+        if 'shippingAddress' in dictionary:
+            if not isinstance(dictionary['shippingAddress'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['shippingAddress']))
+            value = AddressPersonal()
+            self.shipping_address = value.from_dictionary(dictionary['shippingAddress'])
+        return self

onlinepayments/sdk/domain/payment_product3204_specific_output.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct3204SpecificOutput(DataObject):
+
+    __banking_app_label: Optional[str] = None
+
+    @property
+    def banking_app_label(self) -> Optional[str]:
+        """
+        | The name given by the bank (the publisher of the mobile application) to identify the mobile account where the User will confirm the payment
+
+        Type: str
+        """
+        return self.__banking_app_label
+
+    @banking_app_label.setter
+    def banking_app_label(self, value: Optional[str]) -> None:
+        self.__banking_app_label = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct3204SpecificOutput, self).to_dictionary()
+        if self.banking_app_label is not None:
+            dictionary['bankingAppLabel'] = self.banking_app_label
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct3204SpecificOutput':
+        super(PaymentProduct3204SpecificOutput, self).from_dictionary(dictionary)
+        if 'bankingAppLabel' in dictionary:
+            self.banking_app_label = dictionary['bankingAppLabel']
+        return self

onlinepayments/sdk/domain/payment_product3208_specific_input.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct3208SpecificInput(DataObject):
+
+    __merchant_finance_code: Optional[str] = None
+
+    @property
+    def merchant_finance_code(self) -> Optional[str]:
+        """
+        | This field indicates the finance code provided by the merchant after the buyer has selected the proper financing option.
+
+        Type: str
+        """
+        return self.__merchant_finance_code
+
+    @merchant_finance_code.setter
+    def merchant_finance_code(self, value: Optional[str]) -> None:
+        self.__merchant_finance_code = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct3208SpecificInput, self).to_dictionary()
+        if self.merchant_finance_code is not None:
+            dictionary['merchantFinanceCode'] = self.merchant_finance_code
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct3208SpecificInput':
+        super(PaymentProduct3208SpecificInput, self).from_dictionary(dictionary)
+        if 'merchantFinanceCode' in dictionary:
+            self.merchant_finance_code = dictionary['merchantFinanceCode']
+        return self

onlinepayments/sdk/domain/payment_product3208_specific_output.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct3208SpecificOutput(DataObject):
+
+    __buyer_compliant_bank_message: Optional[str] = None
+
+    @property
+    def buyer_compliant_bank_message(self) -> Optional[str]:
+        """
+        | This field indicates the text that must be returned and shown to the buyer to be compliant with the law regulating this payment product.
+
+        Type: str
+        """
+        return self.__buyer_compliant_bank_message
+
+    @buyer_compliant_bank_message.setter
+    def buyer_compliant_bank_message(self, value: Optional[str]) -> None:
+        self.__buyer_compliant_bank_message = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct3208SpecificOutput, self).to_dictionary()
+        if self.buyer_compliant_bank_message is not None:
+            dictionary['buyerCompliantBankMessage'] = self.buyer_compliant_bank_message
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct3208SpecificOutput':
+        super(PaymentProduct3208SpecificOutput, self).from_dictionary(dictionary)
+        if 'buyerCompliantBankMessage' in dictionary:
+            self.buyer_compliant_bank_message = dictionary['buyerCompliantBankMessage']
+        return self

onlinepayments/sdk/domain/payment_product3209_specific_input.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct3209SpecificInput(DataObject):
+
+    __merchant_finance_code: Optional[str] = None
+
+    @property
+    def merchant_finance_code(self) -> Optional[str]:
+        """
+        | This field indicates the finance code provided by the merchant after the buyer has selected the proper financing option.
+
+        Type: str
+        """
+        return self.__merchant_finance_code
+
+    @merchant_finance_code.setter
+    def merchant_finance_code(self, value: Optional[str]) -> None:
+        self.__merchant_finance_code = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct3209SpecificInput, self).to_dictionary()
+        if self.merchant_finance_code is not None:
+            dictionary['merchantFinanceCode'] = self.merchant_finance_code
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct3209SpecificInput':
+        super(PaymentProduct3209SpecificInput, self).from_dictionary(dictionary)
+        if 'merchantFinanceCode' in dictionary:
+            self.merchant_finance_code = dictionary['merchantFinanceCode']
+        return self

onlinepayments/sdk/domain/payment_product3209_specific_output.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct3209SpecificOutput(DataObject):
+
+    __buyer_compliant_bank_message: Optional[str] = None
+
+    @property
+    def buyer_compliant_bank_message(self) -> Optional[str]:
+        """
+        | This field indicates the text that must be returned and shown to the buyer to be compliant with the law regulating this payment product.
+
+        Type: str
+        """
+        return self.__buyer_compliant_bank_message
+
+    @buyer_compliant_bank_message.setter
+    def buyer_compliant_bank_message(self, value: Optional[str]) -> None:
+        self.__buyer_compliant_bank_message = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct3209SpecificOutput, self).to_dictionary()
+        if self.buyer_compliant_bank_message is not None:
+            dictionary['buyerCompliantBankMessage'] = self.buyer_compliant_bank_message
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct3209SpecificOutput':
+        super(PaymentProduct3209SpecificOutput, self).from_dictionary(dictionary)
+        if 'buyerCompliantBankMessage' in dictionary:
+            self.buyer_compliant_bank_message = dictionary['buyerCompliantBankMessage']
+        return self

onlinepayments/sdk/domain/payment_product320_specific_data.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct320SpecificData(DataObject):
+
+    __gateway: Optional[str] = None
+    __networks: Optional[List[str]] = None
+
+    @property
+    def gateway(self) -> Optional[str]:
+        """
+        | The gateway identifier. You should use this when creating a `tokenization specification <https://developers.google.com/pay/api/android/reference/request-objects#Gateway>`_ .
+
+        Type: str
+        """
+        return self.__gateway
+
+    @gateway.setter
+    def gateway(self, value: Optional[str]) -> None:
+        self.__gateway = value
+
+    @property
+    def networks(self) -> Optional[List[str]]:
+        """
+        | The networks that can be used in the current payment context. The strings that represent the networks in the array are identical to the strings that GooglePay uses in their documentation. For instance "Visa".
+
+        Type: list[str]
+        """
+        return self.__networks
+
+    @networks.setter
+    def networks(self, value: Optional[List[str]]) -> None:
+        self.__networks = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct320SpecificData, self).to_dictionary()
+        if self.gateway is not None:
+            dictionary['gateway'] = self.gateway
+        if self.networks is not None:
+            dictionary['networks'] = []
+            for element in self.networks:
+                if element is not None:
+                    dictionary['networks'].append(element)
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct320SpecificData':
+        super(PaymentProduct320SpecificData, self).from_dictionary(dictionary)
+        if 'gateway' in dictionary:
+            self.gateway = dictionary['gateway']
+        if 'networks' in dictionary:
+            if not isinstance(dictionary['networks'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['networks']))
+            self.networks = []
+            for element in dictionary['networks']:
+                self.networks.append(element)
+        return self

onlinepayments/sdk/domain/payment_product350.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct350(DataObject):
+
+    __app_switch_link: Optional[str] = None
+    __payment_request_token: Optional[str] = None
+
+    @property
+    def app_switch_link(self) -> Optional[str]:
+        """
+        | Contains an application switch URL for opening the Swish application on a mobile device (intended to be used by a device with the Swish app installed)
+
+        Type: str
+        """
+        return self.__app_switch_link
+
+    @app_switch_link.setter
+    def app_switch_link(self, value: Optional[str]) -> None:
+        self.__app_switch_link = value
+
+    @property
+    def payment_request_token(self) -> Optional[str]:
+        """
+        | Contains the token that identifies the payment on the Swish side. This can be used to generate a QR code (either manually or by calling the public QR Code API of Swish) to be scanned by the Swish app.
+
+        Type: str
+        """
+        return self.__payment_request_token
+
+    @payment_request_token.setter
+    def payment_request_token(self, value: Optional[str]) -> None:
+        self.__payment_request_token = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct350, self).to_dictionary()
+        if self.app_switch_link is not None:
+            dictionary['appSwitchLink'] = self.app_switch_link
+        if self.payment_request_token is not None:
+            dictionary['paymentRequestToken'] = self.payment_request_token
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct350':
+        super(PaymentProduct350, self).from_dictionary(dictionary)
+        if 'appSwitchLink' in dictionary:
+            self.app_switch_link = dictionary['appSwitchLink']
+        if 'paymentRequestToken' in dictionary:
+            self.payment_request_token = dictionary['paymentRequestToken']
+        return self

onlinepayments/sdk/domain/payment_product5001.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct5001(DataObject):
+    """
+    Deprecated; Deprecated by pendingAuthentication. Contains the third party data for payment product 5001 (Bizum)
+    """
+
+    __message: Optional[str] = None
+    __polling_url: Optional[str] = None
+
+    @property
+    def message(self) -> Optional[str]:
+        """
+        | A text string intended to be displayed to the consumer
+
+        Type: str
+        """
+        return self.__message
+
+    @message.setter
+    def message(self, value: Optional[str]) -> None:
+        self.__message = value
+
+    @property
+    def polling_url(self) -> Optional[str]:
+        """
+        | A URL that must be polled using JavaScript; it responds with either true or false to say if transaction is still pending or not. As long as the response status is 'true', the message should be shown and polling should continue. Once the status changes to 'false', you should verify the payment outcome and redirect the customer to your status page accordingly. Remember, a pending status 'false' indicates that the Bizum process has concluded, but it does not necessarily confirm a successful payment. And if you end the polling after a few minutes without receiving the status 'false', it means that the transaction can't be ended as accepted or refused yet. NB - If you try to call the polling endpoint with invalid data, you will receive an http 204.
+
+        Type: str
+        """
+        return self.__polling_url
+
+    @polling_url.setter
+    def polling_url(self, value: Optional[str]) -> None:
+        self.__polling_url = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct5001, self).to_dictionary()
+        if self.message is not None:
+            dictionary['message'] = self.message
+        if self.polling_url is not None:
+            dictionary['pollingUrl'] = self.polling_url
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct5001':
+        super(PaymentProduct5001, self).from_dictionary(dictionary)
+        if 'message' in dictionary:
+            self.message = dictionary['message']
+        if 'pollingUrl' in dictionary:
+            self.polling_url = dictionary['pollingUrl']
+        return self

onlinepayments/sdk/domain/payment_product5001_specific_output.py

@@ -0,0 +1,112 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct5001SpecificOutput(DataObject):
+
+    __account_number: Optional[str] = None
+    __authorisation_code: Optional[str] = None
+    __liability: Optional[str] = None
+    __mobile_phone_number: Optional[str] = None
+    __operation_code: Optional[str] = None
+
+    @property
+    def account_number(self) -> Optional[str]:
+        """
+        | The account number is associated with the funding.
+
+        Type: str
+        """
+        return self.__account_number
+
+    @account_number.setter
+    def account_number(self, value: Optional[str]) -> None:
+        self.__account_number = value
+
+    @property
+    def authorisation_code(self) -> Optional[str]:
+        """
+        | The reference returned by redsys to identify the transaction
+
+        Type: str
+        """
+        return self.__authorisation_code
+
+    @authorisation_code.setter
+    def authorisation_code(self, value: Optional[str]) -> None:
+        self.__authorisation_code = value
+
+    @property
+    def liability(self) -> Optional[str]:
+        """
+        | Determines the Fraud liability. Possible values are:
+        
+        * issuer - Fraud liability shifts to the issuer (eq. exemption accepted)
+        * merchant - Fraud liability with the merchant Note: When not filled in, Fraud liability is not applicable for the current transaction.
+
+        Type: str
+        """
+        return self.__liability
+
+    @liability.setter
+    def liability(self, value: Optional[str]) -> None:
+        self.__liability = value
+
+    @property
+    def mobile_phone_number(self) -> Optional[str]:
+        """
+        | The mobile phone number used for this transaction
+
+        Type: str
+        """
+        return self.__mobile_phone_number
+
+    @mobile_phone_number.setter
+    def mobile_phone_number(self, value: Optional[str]) -> None:
+        self.__mobile_phone_number = value
+
+    @property
+    def operation_code(self) -> Optional[str]:
+        """
+        | The reference returned by redsys to identify the operation
+
+        Type: str
+        """
+        return self.__operation_code
+
+    @operation_code.setter
+    def operation_code(self, value: Optional[str]) -> None:
+        self.__operation_code = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct5001SpecificOutput, self).to_dictionary()
+        if self.account_number is not None:
+            dictionary['accountNumber'] = self.account_number
+        if self.authorisation_code is not None:
+            dictionary['authorisationCode'] = self.authorisation_code
+        if self.liability is not None:
+            dictionary['liability'] = self.liability
+        if self.mobile_phone_number is not None:
+            dictionary['mobilePhoneNumber'] = self.mobile_phone_number
+        if self.operation_code is not None:
+            dictionary['operationCode'] = self.operation_code
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct5001SpecificOutput':
+        super(PaymentProduct5001SpecificOutput, self).from_dictionary(dictionary)
+        if 'accountNumber' in dictionary:
+            self.account_number = dictionary['accountNumber']
+        if 'authorisationCode' in dictionary:
+            self.authorisation_code = dictionary['authorisationCode']
+        if 'liability' in dictionary:
+            self.liability = dictionary['liability']
+        if 'mobilePhoneNumber' in dictionary:
+            self.mobile_phone_number = dictionary['mobilePhoneNumber']
+        if 'operationCode' in dictionary:
+            self.operation_code = dictionary['operationCode']
+        return self

onlinepayments/sdk/domain/payment_product5100_specific_input.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct5100SpecificInput(DataObject):
+
+    __brand: Optional[str] = None
+
+    @property
+    def brand(self) -> Optional[str]:
+        """
+        | Indicate whether to use a specific Cpay brand. Brands are configurable at the payment method level. See BackOffice Cpay configuration for allowed values.
+
+        Type: str
+        """
+        return self.__brand
+
+    @brand.setter
+    def brand(self, value: Optional[str]) -> None:
+        self.__brand = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct5100SpecificInput, self).to_dictionary()
+        if self.brand is not None:
+            dictionary['brand'] = self.brand
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct5100SpecificInput':
+        super(PaymentProduct5100SpecificInput, self).from_dictionary(dictionary)
+        if 'brand' in dictionary:
+            self.brand = dictionary['brand']
+        return self

onlinepayments/sdk/domain/payment_product5402_specific_output.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProduct5402SpecificOutput(DataObject):
+
+    __brand: Optional[str] = None
+
+    @property
+    def brand(self) -> Optional[str]:
+        """
+        | The specific meal voucher brand used for the transaction
+
+        Type: str
+        """
+        return self.__brand
+
+    @brand.setter
+    def brand(self, value: Optional[str]) -> None:
+        self.__brand = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProduct5402SpecificOutput, self).to_dictionary()
+        if self.brand is not None:
+            dictionary['brand'] = self.brand
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProduct5402SpecificOutput':
+        super(PaymentProduct5402SpecificOutput, self).from_dictionary(dictionary)
+        if 'brand' in dictionary:
+            self.brand = dictionary['brand']
+        return self