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

onlinepayments/sdk/domain/create_hosted_tokenization_response.py

@@ -0,0 +1,127 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .data_object import DataObject
+
+
+class CreateHostedTokenizationResponse(DataObject):
+
+    __expired_card_tokens: Optional[List[str]] = None
+    __hosted_tokenization_id: Optional[str] = None
+    __hosted_tokenization_url: Optional[str] = None
+    __invalid_tokens: Optional[List[str]] = None
+    __partial_redirect_url: Optional[str] = None
+
+    @property
+    def expired_card_tokens(self) -> Optional[List[str]]:
+        """
+        | Tokens referencing expired cards are returned in this array. These tokens can be used in the hosted tokenization session but you must ensure that the expiry date fields are displayed in the form in order to be updated. If you are using the option "hideTokenFields", these tokens should not be proposed to the customers.
+
+        Type: list[str]
+        """
+        return self.__expired_card_tokens
+
+    @expired_card_tokens.setter
+    def expired_card_tokens(self, value: Optional[List[str]]) -> None:
+        self.__expired_card_tokens = value
+
+    @property
+    def hosted_tokenization_id(self) -> Optional[str]:
+        """
+        | The ID of the Hosted Tokenization Session
+
+        Type: str
+        """
+        return self.__hosted_tokenization_id
+
+    @hosted_tokenization_id.setter
+    def hosted_tokenization_id(self, value: Optional[str]) -> None:
+        self.__hosted_tokenization_id = value
+
+    @property
+    def hosted_tokenization_url(self) -> Optional[str]:
+        """
+        | The URL you can use in your JavaScript when instantiating the Tokenizer.
+
+        Type: str
+        """
+        return self.__hosted_tokenization_url
+
+    @hosted_tokenization_url.setter
+    def hosted_tokenization_url(self, value: Optional[str]) -> None:
+        self.__hosted_tokenization_url = value
+
+    @property
+    def invalid_tokens(self) -> Optional[List[str]]:
+        """
+        | Tokens that are submitted in the request are validated. Tokens that cannot be used in the current session are returned in this array. These tokens might not be valid anymore. The validity of tokens can be verified using the `Get token <#operation/GetTokenApi>`_ endpoint.
+
+        Type: list[str]
+        """
+        return self.__invalid_tokens
+
+    @invalid_tokens.setter
+    def invalid_tokens(self, value: Optional[List[str]]) -> None:
+        self.__invalid_tokens = value
+
+    @property
+    def partial_redirect_url(self) -> Optional[str]:
+        """
+        | Deprecated. Use hostedTokenizationUrl instead.
+        |
+        | The partial URL as generated by our system. You will need to add the protocol and the relevant subdomain to this URL, before redirecting your customer to this URL. A special 'payment' subdomain will always work so you can always add 'https://payment.' at the beginning of this response value to view your hosted pages.
+
+        Type: str
+
+        Deprecated; Deprecated
+        """
+        return self.__partial_redirect_url
+
+    @partial_redirect_url.setter
+    def partial_redirect_url(self, value: Optional[str]) -> None:
+        self.__partial_redirect_url = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(CreateHostedTokenizationResponse, self).to_dictionary()
+        if self.expired_card_tokens is not None:
+            dictionary['expiredCardTokens'] = []
+            for element in self.expired_card_tokens:
+                if element is not None:
+                    dictionary['expiredCardTokens'].append(element)
+        if self.hosted_tokenization_id is not None:
+            dictionary['hostedTokenizationId'] = self.hosted_tokenization_id
+        if self.hosted_tokenization_url is not None:
+            dictionary['hostedTokenizationUrl'] = self.hosted_tokenization_url
+        if self.invalid_tokens is not None:
+            dictionary['invalidTokens'] = []
+            for element in self.invalid_tokens:
+                if element is not None:
+                    dictionary['invalidTokens'].append(element)
+        if self.partial_redirect_url is not None:
+            dictionary['partialRedirectUrl'] = self.partial_redirect_url
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CreateHostedTokenizationResponse':
+        super(CreateHostedTokenizationResponse, self).from_dictionary(dictionary)
+        if 'expiredCardTokens' in dictionary:
+            if not isinstance(dictionary['expiredCardTokens'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['expiredCardTokens']))
+            self.expired_card_tokens = []
+            for element in dictionary['expiredCardTokens']:
+                self.expired_card_tokens.append(element)
+        if 'hostedTokenizationId' in dictionary:
+            self.hosted_tokenization_id = dictionary['hostedTokenizationId']
+        if 'hostedTokenizationUrl' in dictionary:
+            self.hosted_tokenization_url = dictionary['hostedTokenizationUrl']
+        if 'invalidTokens' in dictionary:
+            if not isinstance(dictionary['invalidTokens'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['invalidTokens']))
+            self.invalid_tokens = []
+            for element in dictionary['invalidTokens']:
+                self.invalid_tokens.append(element)
+        if 'partialRedirectUrl' in dictionary:
+            self.partial_redirect_url = dictionary['partialRedirectUrl']
+        return self

onlinepayments/sdk/domain/create_mandate_request.py

@@ -0,0 +1,187 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .mandate_customer import MandateCustomer
+
+
+class CreateMandateRequest(DataObject):
+
+    __alias: Optional[str] = None
+    __customer: Optional[MandateCustomer] = None
+    __customer_reference: Optional[str] = None
+    __language: Optional[str] = None
+    __recurrence_type: Optional[str] = None
+    __return_url: Optional[str] = None
+    __signature_type: 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[MandateCustomer]:
+        """
+        | Customer object containing customer specific inputs. Required for Create mandate and Create payment calls.
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_customer.MandateCustomer`
+        """
+        return self.__customer
+
+    @customer.setter
+    def customer(self, value: Optional[MandateCustomer]) -> 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 language(self) -> Optional[str]:
+        """
+        | The language code of the customer. ISO 639-1, possible values are:
+        
+        * de
+        * en
+        * es
+        * fr
+        * it
+        * nl
+        * si
+        * sk
+        * sv
+
+        Type: str
+        """
+        return self.__language
+
+    @language.setter
+    def language(self, value: Optional[str]) -> None:
+        self.__language = 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 return_url(self) -> Optional[str]:
+        """
+        | Return URL to use if the mandate signing requires redirection. Required for S2S Create Payment if and only if the signatureType is "SMS" or "AIS".
+
+        Type: str
+        """
+        return self.__return_url
+
+    @return_url.setter
+    def return_url(self, value: Optional[str]) -> None:
+        self.__return_url = value
+
+    @property
+    def signature_type(self) -> Optional[str]:
+        """
+        | Specifies whether the mandate is unsigned, signed by SMS or tick box. Possible values are:
+        
+        * UNSIGNED
+        * SMS
+        * TICK_BOX
+        * AIS
+        
+        | Refer to the support page to determine the applicable signature types.
+
+        Type: str
+        """
+        return self.__signature_type
+
+    @signature_type.setter
+    def signature_type(self, value: Optional[str]) -> None:
+        self.__signature_type = 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(CreateMandateRequest, 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.language is not None:
+            dictionary['language'] = self.language
+        if self.recurrence_type is not None:
+            dictionary['recurrenceType'] = self.recurrence_type
+        if self.return_url is not None:
+            dictionary['returnUrl'] = self.return_url
+        if self.signature_type is not None:
+            dictionary['signatureType'] = self.signature_type
+        if self.unique_mandate_reference is not None:
+            dictionary['uniqueMandateReference'] = self.unique_mandate_reference
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CreateMandateRequest':
+        super(CreateMandateRequest, 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 = MandateCustomer()
+            self.customer = value.from_dictionary(dictionary['customer'])
+        if 'customerReference' in dictionary:
+            self.customer_reference = dictionary['customerReference']
+        if 'language' in dictionary:
+            self.language = dictionary['language']
+        if 'recurrenceType' in dictionary:
+            self.recurrence_type = dictionary['recurrenceType']
+        if 'returnUrl' in dictionary:
+            self.return_url = dictionary['returnUrl']
+        if 'signatureType' in dictionary:
+            self.signature_type = dictionary['signatureType']
+        if 'uniqueMandateReference' in dictionary:
+            self.unique_mandate_reference = dictionary['uniqueMandateReference']
+        return self

onlinepayments/sdk/domain/create_mandate_response.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .mandate_merchant_action import MandateMerchantAction
+from .mandate_response import MandateResponse
+
+
+class CreateMandateResponse(DataObject):
+
+    __mandate: Optional[MandateResponse] = None
+    __merchant_action: Optional[MandateMerchantAction] = None
+
+    @property
+    def mandate(self) -> Optional[MandateResponse]:
+        """
+        | Object containing the created mandate.
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_response.MandateResponse`
+        """
+        return self.__mandate
+
+    @mandate.setter
+    def mandate(self, value: Optional[MandateResponse]) -> None:
+        self.__mandate = value
+
+    @property
+    def merchant_action(self) -> Optional[MandateMerchantAction]:
+        """
+        | Object that contains the action, including the needed data, that you should perform next, showing the redirect to a third party to complete the payment or like showing instructions.
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_merchant_action.MandateMerchantAction`
+        """
+        return self.__merchant_action
+
+    @merchant_action.setter
+    def merchant_action(self, value: Optional[MandateMerchantAction]) -> None:
+        self.__merchant_action = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(CreateMandateResponse, self).to_dictionary()
+        if self.mandate is not None:
+            dictionary['mandate'] = self.mandate.to_dictionary()
+        if self.merchant_action is not None:
+            dictionary['merchantAction'] = self.merchant_action.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CreateMandateResponse':
+        super(CreateMandateResponse, self).from_dictionary(dictionary)
+        if 'mandate' in dictionary:
+            if not isinstance(dictionary['mandate'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['mandate']))
+            value = MandateResponse()
+            self.mandate = value.from_dictionary(dictionary['mandate'])
+        if 'merchantAction' in dictionary:
+            if not isinstance(dictionary['merchantAction'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['merchantAction']))
+            value = MandateMerchantAction()
+            self.merchant_action = value.from_dictionary(dictionary['merchantAction'])
+        return self

onlinepayments/sdk/domain/create_mandate_with_return_url.py

@@ -0,0 +1,187 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .mandate_customer import MandateCustomer
+
+
+class CreateMandateWithReturnUrl(DataObject):
+
+    __alias: Optional[str] = None
+    __customer: Optional[MandateCustomer] = None
+    __customer_reference: Optional[str] = None
+    __language: Optional[str] = None
+    __recurrence_type: Optional[str] = None
+    __return_url: Optional[str] = None
+    __signature_type: 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[MandateCustomer]:
+        """
+        | Customer object containing customer specific inputs. Required for Create mandate and Create payment calls.
+
+        Type: :class:`onlinepayments.sdk.domain.mandate_customer.MandateCustomer`
+        """
+        return self.__customer
+
+    @customer.setter
+    def customer(self, value: Optional[MandateCustomer]) -> 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 language(self) -> Optional[str]:
+        """
+        | The language code of the customer. ISO 639-1, possible values are:
+        
+        * de
+        * en
+        * es
+        * fr
+        * it
+        * nl
+        * si
+        * sk
+        * sv
+
+        Type: str
+        """
+        return self.__language
+
+    @language.setter
+    def language(self, value: Optional[str]) -> None:
+        self.__language = 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 return_url(self) -> Optional[str]:
+        """
+        | Return URL to use if the mandate signing requires redirection. Required for S2S Create Payment if and only if the signatureType is "SMS" or "AIS".
+
+        Type: str
+        """
+        return self.__return_url
+
+    @return_url.setter
+    def return_url(self, value: Optional[str]) -> None:
+        self.__return_url = value
+
+    @property
+    def signature_type(self) -> Optional[str]:
+        """
+        | Specifies whether the mandate is unsigned, signed by SMS or tick box. Possible values are:
+        
+        * UNSIGNED
+        * SMS
+        * TICK_BOX
+        * AIS
+        
+        | Refer to the support page to determine the applicable signature types.
+
+        Type: str
+        """
+        return self.__signature_type
+
+    @signature_type.setter
+    def signature_type(self, value: Optional[str]) -> None:
+        self.__signature_type = 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(CreateMandateWithReturnUrl, 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.language is not None:
+            dictionary['language'] = self.language
+        if self.recurrence_type is not None:
+            dictionary['recurrenceType'] = self.recurrence_type
+        if self.return_url is not None:
+            dictionary['returnUrl'] = self.return_url
+        if self.signature_type is not None:
+            dictionary['signatureType'] = self.signature_type
+        if self.unique_mandate_reference is not None:
+            dictionary['uniqueMandateReference'] = self.unique_mandate_reference
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CreateMandateWithReturnUrl':
+        super(CreateMandateWithReturnUrl, 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 = MandateCustomer()
+            self.customer = value.from_dictionary(dictionary['customer'])
+        if 'customerReference' in dictionary:
+            self.customer_reference = dictionary['customerReference']
+        if 'language' in dictionary:
+            self.language = dictionary['language']
+        if 'recurrenceType' in dictionary:
+            self.recurrence_type = dictionary['recurrenceType']
+        if 'returnUrl' in dictionary:
+            self.return_url = dictionary['returnUrl']
+        if 'signatureType' in dictionary:
+            self.signature_type = dictionary['signatureType']
+        if 'uniqueMandateReference' in dictionary:
+            self.unique_mandate_reference = dictionary['uniqueMandateReference']
+        return self