onlinepayments-sdk-python3 4.22.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/create_hosted_checkout_response.py

@@ -1,22 +1,23 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from typing import List
+from typing import List, Optional
 
-from onlinepayments.sdk.data_object import DataObject
+from .data_object import DataObject
 
 
 class CreateHostedCheckoutResponse(DataObject):
-    __returnmac = None
-    __hosted_checkout_id = None
-    __invalid_tokens = None
-    __merchant_reference = None
-    __partial_redirect_url = None
-    __redirect_url = None
+
+    __returnmac: Optional[str] = None
+    __hosted_checkout_id: Optional[str] = None
+    __invalid_tokens: Optional[List[str]] = None
+    __merchant_reference: Optional[str] = None
+    __partial_redirect_url: Optional[str] = None
+    __redirect_url: Optional[str] = None
 
     @property
-    def returnmac(self) -> str:
+    def returnmac(self) -> Optional[str]:
         """
         | When the customer is returned to your site we will append this property and value to the query-string. You should store this data, so you can identify the returning customer.
 
@@ -25,11 +26,11 @@ class CreateHostedCheckoutResponse(DataObject):
         return self.__returnmac
 
     @returnmac.setter
-    def returnmac(self, value: str):
+    def returnmac(self, value: Optional[str]) -> None:
         self.__returnmac = value
 
     @property
-    def hosted_checkout_id(self) -> str:
+    def hosted_checkout_id(self) -> Optional[str]:
         """
         | The ID of the Hosted Checkout Session in which the payment was made.
 
@@ -38,38 +39,35 @@ class CreateHostedCheckoutResponse(DataObject):
         return self.__hosted_checkout_id
 
     @hosted_checkout_id.setter
-    def hosted_checkout_id(self, value: str):
+    def hosted_checkout_id(self, value: Optional[str]) -> None:
         self.__hosted_checkout_id = value
 
     @property
-    def invalid_tokens(self) -> List[str]:
+    def invalid_tokens(self) -> Optional[List[str]]:
         """
-        | Tokens that are submitted in the request are validated. In case any of the tokens can't be used anymore they are returned in this array. You should most likely remove those tokens from your system.
-
         Type: list[str]
         """
         return self.__invalid_tokens
 
     @invalid_tokens.setter
-    def invalid_tokens(self, value: List[str]):
+    def invalid_tokens(self, value: Optional[List[str]]) -> None:
         self.__invalid_tokens = value
 
     @property
-    def merchant_reference(self) -> str:
+    def merchant_reference(self) -> Optional[str]:
         """
-        | Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
-        | It is highly recommended to provide a single MerchantReference per unique order on your side
+        | Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. It is highly recommended to provide a single MerchantReference per unique order on your side
 
         Type: str
         """
         return self.__merchant_reference
 
     @merchant_reference.setter
-    def merchant_reference(self, value: str):
+    def merchant_reference(self, value: Optional[str]) -> None:
         self.__merchant_reference = value
 
     @property
-    def partial_redirect_url(self) -> str:
+    def partial_redirect_url(self) -> Optional[str]:
         """
         | 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.
 
@@ -78,11 +76,11 @@ class CreateHostedCheckoutResponse(DataObject):
         return self.__partial_redirect_url
 
     @partial_redirect_url.setter
-    def partial_redirect_url(self, value: str):
+    def partial_redirect_url(self, value: Optional[str]) -> None:
         self.__partial_redirect_url = value
 
     @property
-    def redirect_url(self) -> str:
+    def redirect_url(self) -> Optional[str]:
         """
         | The full hosted checkout URL as generated by our system. Use this URL to redirect your customer to the hosted checkout page.
 
@@ -91,10 +89,10 @@ class CreateHostedCheckoutResponse(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(CreateHostedCheckoutResponse, self).to_dictionary()
         if self.returnmac is not None:
             dictionary['RETURNMAC'] = self.returnmac
@@ -113,7 +111,7 @@ class CreateHostedCheckoutResponse(DataObject):
             dictionary['redirectUrl'] = self.redirect_url
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CreateHostedCheckoutResponse':
         super(CreateHostedCheckoutResponse, self).from_dictionary(dictionary)
         if 'RETURNMAC' in dictionary:
             self.returnmac = dictionary['RETURNMAC']

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/create_hosted_tokenization_request.py

@@ -1,73 +1,62 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.credit_card_specific_input_hosted_tokenization import CreditCardSpecificInputHostedTokenization
-from onlinepayments.sdk.domain.page_customization import PageCustomization
-from onlinepayments.sdk.domain.payment_product_filters_hosted_tokenization import PaymentProductFiltersHostedTokenization
+from typing import Optional
+
+from .credit_card_specific_input_hosted_tokenization import CreditCardSpecificInputHostedTokenization
+from .data_object import DataObject
+from .payment_product_filters_hosted_tokenization import PaymentProductFiltersHostedTokenization
 
 
 class CreateHostedTokenizationRequest(DataObject):
-    __ask_consumer_consent = None
-    __credit_card_specific_input = None
-    __locale = None
-    __page_customization = None
-    __payment_product_filters = None
-    __tokens = None
-    __variant = None
+
+    __ask_consumer_consent: Optional[bool] = None
+    __credit_card_specific_input: Optional[CreditCardSpecificInputHostedTokenization] = None
+    __locale: Optional[str] = None
+    __payment_product_filters: Optional[PaymentProductFiltersHostedTokenization] = None
+    __tokens: Optional[str] = None
+    __variant: Optional[str] = None
 
     @property
-    def ask_consumer_consent(self) -> bool:
+    def ask_consumer_consent(self) -> Optional[bool]:
         """
-        | Indicate if the tokenization form should contain a checkbox asking the user to give consent for storing their information for future payments.
-        | If this parameter is false or missing, you should ask the user yourself and provide their answer when submitting the Tokenizer in your JavaScript code. To pass this choice set the submitTokenization function's parameter storePermanently to false, if you choose not to store the token for subsequent payments, or to true otherwise.
+        | Indicate if the tokenization form should contain a checkbox asking the user to give consent for storing their information for future payments. If this parameter is false or missing, you should ask the user yourself and provide their answer when submitting the Tokenizer in your JavaScript code. To pass this choice set the submitTokenization function's parameter storePermanently to false, if you choose not to store the token for subsequent payments, or to true otherwise.
 
         Type: bool
         """
         return self.__ask_consumer_consent
 
     @ask_consumer_consent.setter
-    def ask_consumer_consent(self, value: bool):
+    def ask_consumer_consent(self, value: Optional[bool]) -> None:
         self.__ask_consumer_consent = value
 
     @property
-    def credit_card_specific_input(self) -> CreditCardSpecificInputHostedTokenization:
+    def credit_card_specific_input(self) -> Optional[CreditCardSpecificInputHostedTokenization]:
         """
         Type: :class:`onlinepayments.sdk.domain.credit_card_specific_input_hosted_tokenization.CreditCardSpecificInputHostedTokenization`
         """
         return self.__credit_card_specific_input
 
     @credit_card_specific_input.setter
-    def credit_card_specific_input(self, value: CreditCardSpecificInputHostedTokenization):
+    def credit_card_specific_input(self, value: Optional[CreditCardSpecificInputHostedTokenization]) -> None:
         self.__credit_card_specific_input = value
 
     @property
-    def locale(self) -> str:
+    def locale(self) -> Optional[str]:
         """
-        | Locale used in the GUI towards the consumer. 
+        | Locale used in the GUI towards the consumer.
 
         Type: str
         """
         return self.__locale
 
     @locale.setter
-    def locale(self, value: str):
+    def locale(self, value: Optional[str]) -> None:
         self.__locale = value
 
     @property
-    def page_customization(self) -> PageCustomization:
-        """
-        Type: :class:`onlinepayments.sdk.domain.page_customization.PageCustomization`
-        """
-        return self.__page_customization
-
-    @page_customization.setter
-    def page_customization(self, value: PageCustomization):
-        self.__page_customization = value
-
-    @property
-    def payment_product_filters(self) -> PaymentProductFiltersHostedTokenization:
+    def payment_product_filters(self) -> Optional[PaymentProductFiltersHostedTokenization]:
         """
         | Contains the payment product ids that will be used for manipulating the payment products available for the payment to the customer.
 
@@ -76,11 +65,11 @@ class CreateHostedTokenizationRequest(DataObject):
         return self.__payment_product_filters
 
     @payment_product_filters.setter
-    def payment_product_filters(self, value: PaymentProductFiltersHostedTokenization):
+    def payment_product_filters(self, value: Optional[PaymentProductFiltersHostedTokenization]) -> None:
         self.__payment_product_filters = value
 
     @property
-    def tokens(self) -> str:
+    def tokens(self) -> Optional[str]:
         """
         | String containing comma separated tokens (no spaces) associated with the customer of this hosted session. Valid tokens will be used to present the customer the option to re-use previously used payment details. This means the customer for instance does not have to re-enter their card details again, which a big plus when the customer is using their mobile phone to complete the operation.
 
@@ -89,11 +78,11 @@ class CreateHostedTokenizationRequest(DataObject):
         return self.__tokens
 
     @tokens.setter
-    def tokens(self, value: str):
+    def tokens(self, value: Optional[str]) -> None:
         self.__tokens = value
 
     @property
-    def variant(self) -> str:
+    def variant(self) -> Optional[str]:
         """
         | It is possible to upload multiple templates of your payment pages using the Merchant Portal. You can force the use of a custom template by specifying it in the variant field. This allows you to test out the effect of certain changes to your payment pages in a controlled manner. Please note that you need to specify the filename of the template or customization.
 
@@ -102,10 +91,10 @@ class CreateHostedTokenizationRequest(DataObject):
         return self.__variant
 
     @variant.setter
-    def variant(self, value: str):
+    def variant(self, value: Optional[str]) -> None:
         self.__variant = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(CreateHostedTokenizationRequest, self).to_dictionary()
         if self.ask_consumer_consent is not None:
             dictionary['askConsumerConsent'] = self.ask_consumer_consent
@@ -113,8 +102,6 @@ class CreateHostedTokenizationRequest(DataObject):
             dictionary['creditCardSpecificInput'] = self.credit_card_specific_input.to_dictionary()
         if self.locale is not None:
             dictionary['locale'] = self.locale
-        if self.page_customization is not None:
-            dictionary['pageCustomization'] = self.page_customization.to_dictionary()
         if self.payment_product_filters is not None:
             dictionary['paymentProductFilters'] = self.payment_product_filters.to_dictionary()
         if self.tokens is not None:
@@ -123,7 +110,7 @@ class CreateHostedTokenizationRequest(DataObject):
             dictionary['variant'] = self.variant
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CreateHostedTokenizationRequest':
         super(CreateHostedTokenizationRequest, self).from_dictionary(dictionary)
         if 'askConsumerConsent' in dictionary:
             self.ask_consumer_consent = dictionary['askConsumerConsent']
@@ -134,11 +121,6 @@ class CreateHostedTokenizationRequest(DataObject):
             self.credit_card_specific_input = value.from_dictionary(dictionary['creditCardSpecificInput'])
         if 'locale' in dictionary:
             self.locale = dictionary['locale']
-        if 'pageCustomization' in dictionary:
-            if not isinstance(dictionary['pageCustomization'], dict):
-                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['pageCustomization']))
-            value = PageCustomization()
-            self.page_customization = value.from_dictionary(dictionary['pageCustomization'])
         if 'paymentProductFilters' in dictionary:
             if not isinstance(dictionary['paymentProductFilters'], dict):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['paymentProductFilters']))

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/create_hosted_tokenization_response.py

@@ -1,36 +1,35 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from typing import List
+from typing import List, Optional
 
-from onlinepayments.sdk.data_object import DataObject
+from .data_object import DataObject
 
 
 class CreateHostedTokenizationResponse(DataObject):
-    __expired_card_tokens = None
-    __hosted_tokenization_id = None
-    __hosted_tokenization_url = None
-    __invalid_tokens = None
-    __partial_redirect_url = None
+
+    __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) -> List[str]:
+    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.
+        | 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: List[str]):
+    def expired_card_tokens(self, value: Optional[List[str]]) -> None:
         self.__expired_card_tokens = value
 
     @property
-    def hosted_tokenization_id(self) -> str:
+    def hosted_tokenization_id(self) -> Optional[str]:
         """
         | The ID of the Hosted Tokenization Session
 
@@ -39,11 +38,11 @@ class CreateHostedTokenizationResponse(DataObject):
         return self.__hosted_tokenization_id
 
     @hosted_tokenization_id.setter
-    def hosted_tokenization_id(self, value: str):
+    def hosted_tokenization_id(self, value: Optional[str]) -> None:
         self.__hosted_tokenization_id = value
 
     @property
-    def hosted_tokenization_url(self) -> str:
+    def hosted_tokenization_url(self) -> Optional[str]:
         """
         | The URL you can use in your JavaScript when instantiating the Tokenizer.
 
@@ -52,39 +51,40 @@ class CreateHostedTokenizationResponse(DataObject):
         return self.__hosted_tokenization_url
 
     @hosted_tokenization_url.setter
-    def hosted_tokenization_url(self, value: str):
+    def hosted_tokenization_url(self, value: Optional[str]) -> None:
         self.__hosted_tokenization_url = value
 
     @property
-    def invalid_tokens(self) -> List[str]:
+    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.
+        | 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: List[str]):
+    def invalid_tokens(self, value: Optional[List[str]]) -> None:
         self.__invalid_tokens = value
 
     @property
-    def partial_redirect_url(self) -> str:
+    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: str):
+    def partial_redirect_url(self, value: Optional[str]) -> None:
         self.__partial_redirect_url = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(CreateHostedTokenizationResponse, self).to_dictionary()
         if self.expired_card_tokens is not None:
             dictionary['expiredCardTokens'] = []
@@ -104,7 +104,7 @@ class CreateHostedTokenizationResponse(DataObject):
             dictionary['partialRedirectUrl'] = self.partial_redirect_url
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CreateHostedTokenizationResponse':
         super(CreateHostedTokenizationResponse, self).from_dictionary(dictionary)
         if 'expiredCardTokens' in dictionary:
             if not isinstance(dictionary['expiredCardTokens'], list):

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/create_mandate_request.py

@@ -1,27 +1,26 @@
 # -*- 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 import MandateCustomer
+from typing import Optional
+
+from .data_object import DataObject
+from .mandate_customer import MandateCustomer
 
 
 class CreateMandateRequest(DataObject):
-    """
-    | Object containing information to create a SEPA Direct Debit mandate.
-    """
-
-    __alias = None
-    __customer = None
-    __customer_reference = None
-    __language = None
-    __recurrence_type = None
-    __return_url = None
-    __signature_type = None
-    __unique_mandate_reference = None
+
+    __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) -> 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.
 
@@ -30,25 +29,24 @@ class CreateMandateRequest(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) -> MandateCustomer:
+    def customer(self) -> Optional[MandateCustomer]:
         """
-        | Customer object containing customer specific inputs.
-        | Required for Create mandate and Create payment calls.
+        | 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: MandateCustomer):
+    def customer(self, value: Optional[MandateCustomer]) -> None:
         self.__customer = value
 
     @property
-    def customer_reference(self) -> str:
+    def customer_reference(self) -> Optional[str]:
         """
         | The unique identifier of a customer
 
@@ -57,48 +55,50 @@ class CreateMandateRequest(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 language(self) -> str:
+    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
+        
+        * de
+        * en
+        * es
+        * fr
+        * it
+        * nl
+        * si
+        * sk
+        * sv
 
         Type: str
         """
         return self.__language
 
     @language.setter
-    def language(self, value: str):
+    def language(self, value: Optional[str]) -> None:
         self.__language = 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 return_url(self) -> str:
+    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".
 
@@ -107,26 +107,28 @@ class CreateMandateRequest(DataObject):
         return self.__return_url
 
     @return_url.setter
-    def return_url(self, value: str):
+    def return_url(self, value: Optional[str]) -> None:
         self.__return_url = value
 
     @property
-    def signature_type(self) -> str:
+    def signature_type(self) -> Optional[str]:
         """
-        | Specifies whether the mandate is unsigned or signed by SMS. Possible values are:
-        | * UNSIGNED
-        | * SMS
+        | Specifies whether the mandate is tick box, unsigned or signed by SMS. Possible values are:
+        
+        * UNSIGNED
+        * SMS
+        * TICK_BOX - This option is only available for Equens Worldline
 
         Type: str
         """
         return self.__signature_type
 
     @signature_type.setter
-    def signature_type(self, value: str):
+    def signature_type(self, value: Optional[str]) -> None:
         self.__signature_type = value
 
     @property
-    def unique_mandate_reference(self) -> str:
+    def unique_mandate_reference(self) -> Optional[str]:
         """
         | The unique identifier of the mandate
 
@@ -135,10 +137,10 @@ class CreateMandateRequest(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(CreateMandateRequest, self).to_dictionary()
         if self.alias is not None:
             dictionary['alias'] = self.alias
@@ -158,7 +160,7 @@ class CreateMandateRequest(DataObject):
             dictionary['uniqueMandateReference'] = self.unique_mandate_reference
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CreateMandateRequest':
         super(CreateMandateRequest, self).from_dictionary(dictionary)
         if 'alias' in dictionary:
             self.alias = dictionary['alias']