onlinepayments-sdk-python3 4.23.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/create_mandate_with_return_url.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 CreateMandateWithReturnUrl(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 CreateMandateWithReturnUrl(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 CreateMandateWithReturnUrl(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,27 +107,28 @@ class CreateMandateWithReturnUrl(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 tick box, unsigned or signed by SMS. Possible values are:
-        | * UNSIGNED
-        | * SMS
-        | * TICK_BOX - This option is only available for Equens Worldline
+        
+        * 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
 
@@ -136,10 +137,10 @@ class CreateMandateWithReturnUrl(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(CreateMandateWithReturnUrl, self).to_dictionary()
         if self.alias is not None:
             dictionary['alias'] = self.alias
@@ -159,7 +160,7 @@ class CreateMandateWithReturnUrl(DataObject):
             dictionary['uniqueMandateReference'] = self.unique_mandate_reference
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CreateMandateWithReturnUrl':
         super(CreateMandateWithReturnUrl, self).from_dictionary(dictionary)
         if 'alias' in dictionary:
             self.alias = dictionary['alias']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/create_payment_link_request.py

@@ -1,39 +1,41 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.card_payment_method_specific_input_base import CardPaymentMethodSpecificInputBase
-from onlinepayments.sdk.domain.fraud_fields import FraudFields
-from onlinepayments.sdk.domain.hosted_checkout_specific_input import HostedCheckoutSpecificInput
-from onlinepayments.sdk.domain.mobile_payment_method_hosted_checkout_specific_input import MobilePaymentMethodHostedCheckoutSpecificInput
-from onlinepayments.sdk.domain.order import Order
-from onlinepayments.sdk.domain.payment_link_order_input import PaymentLinkOrderInput
-from onlinepayments.sdk.domain.payment_link_specific_input import PaymentLinkSpecificInput
-from onlinepayments.sdk.domain.redirect_payment_method_specific_input import RedirectPaymentMethodSpecificInput
-from onlinepayments.sdk.domain.sepa_direct_debit_payment_method_specific_input_base import SepaDirectDebitPaymentMethodSpecificInputBase
+from datetime import datetime
+from typing import Optional
+
+from .card_payment_method_specific_input_base import CardPaymentMethodSpecificInputBase
+from .data_object import DataObject
+from .feedbacks import Feedbacks
+from .fraud_fields import FraudFields
+from .hosted_checkout_specific_input import HostedCheckoutSpecificInput
+from .mobile_payment_method_hosted_checkout_specific_input import MobilePaymentMethodHostedCheckoutSpecificInput
+from .order import Order
+from .payment_link_order_input import PaymentLinkOrderInput
+from .payment_link_specific_input import PaymentLinkSpecificInput
+from .redirect_payment_method_specific_input import RedirectPaymentMethodSpecificInput
+from .sepa_direct_debit_payment_method_specific_input_base import SepaDirectDebitPaymentMethodSpecificInputBase
 
 
 class CreatePaymentLinkRequest(DataObject):
-    """
-    | An object containing the Create PaymentLink request.
-    """
-
-    __card_payment_method_specific_input = None
-    __description = None
-    __expiration_date = None
-    __fraud_fields = None
-    __hosted_checkout_specific_input = None
-    __mobile_payment_method_specific_input = None
-    __order = None
-    __payment_link_order = None
-    __payment_link_specific_input = None
-    __recipient_name = None
-    __redirect_payment_method_specific_input = None
-    __sepa_direct_debit_payment_method_specific_input = None
+
+    __card_payment_method_specific_input: Optional[CardPaymentMethodSpecificInputBase] = None
+    __description: Optional[str] = None
+    __expiration_date: Optional[datetime] = None
+    __feedbacks: Optional[Feedbacks] = None
+    __fraud_fields: Optional[FraudFields] = None
+    __hosted_checkout_specific_input: Optional[HostedCheckoutSpecificInput] = None
+    __mobile_payment_method_specific_input: Optional[MobilePaymentMethodHostedCheckoutSpecificInput] = None
+    __order: Optional[Order] = None
+    __payment_link_order: Optional[PaymentLinkOrderInput] = None
+    __payment_link_specific_input: Optional[PaymentLinkSpecificInput] = None
+    __recipient_name: Optional[str] = None
+    __redirect_payment_method_specific_input: Optional[RedirectPaymentMethodSpecificInput] = None
+    __sepa_direct_debit_payment_method_specific_input: Optional[SepaDirectDebitPaymentMethodSpecificInputBase] = None
 
     @property
-    def card_payment_method_specific_input(self) -> CardPaymentMethodSpecificInputBase:
+    def card_payment_method_specific_input(self) -> Optional[CardPaymentMethodSpecificInputBase]:
         """
         | Object containing the specific input details for card payments
 
@@ -42,41 +44,58 @@ class CreatePaymentLinkRequest(DataObject):
         return self.__card_payment_method_specific_input
 
     @card_payment_method_specific_input.setter
-    def card_payment_method_specific_input(self, value: CardPaymentMethodSpecificInputBase):
+    def card_payment_method_specific_input(self, value: Optional[CardPaymentMethodSpecificInputBase]) -> None:
         self.__card_payment_method_specific_input = value
 
     @property
-    def description(self) -> str:
+    def description(self) -> Optional[str]:
         """
         | A note related to the created payment link.
-        
-        | Deprecated: Use `paymentLinkSpecificInput/description` instead.
+        |
+        | Deprecated: Use ``paymentLinkSpecificInput/description`` instead.
 
         Type: str
+
+        Deprecated; A note related to the created payment link.  Use paymentLinkSpecificInput/description instead.
         """
         return self.__description
 
     @description.setter
-    def description(self, value: str):
+    def description(self, value: Optional[str]) -> None:
         self.__description = value
 
     @property
-    def expiration_date(self) -> str:
+    def expiration_date(self) -> Optional[datetime]:
         """
         | The date after which the payment link will not be usable to complete the payment. The date sent cannot be more than 6 months in the future or a past date. It must also contain the UTC offset.
-        
-        | Deprecated: Use `paymentLinkSpecificInput/expirationDate` instead.
+        |
+        | Deprecated: Use ``paymentLinkSpecificInput/expirationDate`` instead.
 
-        Type: str
+        Type: datetime
+
+        Deprecated; The date after which the payment link will not be usable to complete the payment. The date sent cannot be more than 6 months in the future or a past date. It must also contain the UTC offset.  Use paymentLinkSpecificInput/expirationDate instead.
         """
         return self.__expiration_date
 
     @expiration_date.setter
-    def expiration_date(self, value: str):
+    def expiration_date(self, value: Optional[datetime]) -> None:
         self.__expiration_date = value
 
     @property
-    def fraud_fields(self) -> FraudFields:
+    def feedbacks(self) -> Optional[Feedbacks]:
+        """
+        | This section will contain feedback Urls to provide feedback on the payment.
+
+        Type: :class:`onlinepayments.sdk.domain.feedbacks.Feedbacks`
+        """
+        return self.__feedbacks
+
+    @feedbacks.setter
+    def feedbacks(self, value: Optional[Feedbacks]) -> None:
+        self.__feedbacks = value
+
+    @property
+    def fraud_fields(self) -> Optional[FraudFields]:
         """
         | Object containing additional data that will be used to assess the risk of fraud
 
@@ -85,11 +104,11 @@ class CreatePaymentLinkRequest(DataObject):
         return self.__fraud_fields
 
     @fraud_fields.setter
-    def fraud_fields(self, value: FraudFields):
+    def fraud_fields(self, value: Optional[FraudFields]) -> None:
         self.__fraud_fields = value
 
     @property
-    def hosted_checkout_specific_input(self) -> HostedCheckoutSpecificInput:
+    def hosted_checkout_specific_input(self) -> Optional[HostedCheckoutSpecificInput]:
         """
         | Object containing hosted checkout specific data
 
@@ -98,11 +117,11 @@ class CreatePaymentLinkRequest(DataObject):
         return self.__hosted_checkout_specific_input
 
     @hosted_checkout_specific_input.setter
-    def hosted_checkout_specific_input(self, value: HostedCheckoutSpecificInput):
+    def hosted_checkout_specific_input(self, value: Optional[HostedCheckoutSpecificInput]) -> None:
         self.__hosted_checkout_specific_input = value
 
     @property
-    def mobile_payment_method_specific_input(self) -> MobilePaymentMethodHostedCheckoutSpecificInput:
+    def mobile_payment_method_specific_input(self) -> Optional[MobilePaymentMethodHostedCheckoutSpecificInput]:
         """
         | Object containing the specific input details for mobile payments
 
@@ -111,46 +130,39 @@ class CreatePaymentLinkRequest(DataObject):
         return self.__mobile_payment_method_specific_input
 
     @mobile_payment_method_specific_input.setter
-    def mobile_payment_method_specific_input(self, value: MobilePaymentMethodHostedCheckoutSpecificInput):
+    def mobile_payment_method_specific_input(self, value: Optional[MobilePaymentMethodHostedCheckoutSpecificInput]) -> None:
         self.__mobile_payment_method_specific_input = value
 
     @property
-    def order(self) -> Order:
+    def order(self) -> Optional[Order]:
         """
-        | Order object containing order related data 
-        |  Please note that this object is required to be able to submit the amount.
+        | Order object containing order related data Please note that this object is required to be able to submit the amount.
 
         Type: :class:`onlinepayments.sdk.domain.order.Order`
         """
         return self.__order
 
     @order.setter
-    def order(self, value: Order):
+    def order(self, value: Optional[Order]) -> None:
         self.__order = value
 
     @property
-    def payment_link_order(self) -> PaymentLinkOrderInput:
+    def payment_link_order(self) -> Optional[PaymentLinkOrderInput]:
         """
         | An object containing the details of the related payment input.
-        
-        | Deprecated: All properties in `paymentLinkOrder` are deprecated.  
-        | Use corresponding values as noted below:  
-        | | Property | Replacement |
-        | | - | - |
-        | | merchantReference | `order/references/merchantReference` |  
-        | | amount | `order/amountOfMoney` |  
-        | | surchargeSpecificInput | `order/surchargeSpecificInput` |
+        |
+        | Deprecated: All properties in ``paymentLinkOrder`` are deprecated. Use corresponding values as noted below: | Property | Replacement | | - | - | | merchantReference | ``references/merchantReference`` | | amount | ``order/amountOfMoney`` | | surchargeSpecificInput | ``order/surchargeSpecificInput`` |
 
         Type: :class:`onlinepayments.sdk.domain.payment_link_order_input.PaymentLinkOrderInput`
         """
         return self.__payment_link_order
 
     @payment_link_order.setter
-    def payment_link_order(self, value: PaymentLinkOrderInput):
+    def payment_link_order(self, value: Optional[PaymentLinkOrderInput]) -> None:
         self.__payment_link_order = value
 
     @property
-    def payment_link_specific_input(self) -> PaymentLinkSpecificInput:
+    def payment_link_specific_input(self) -> Optional[PaymentLinkSpecificInput]:
         """
         | An object containing details specific to payment link creation
 
@@ -159,26 +171,28 @@ class CreatePaymentLinkRequest(DataObject):
         return self.__payment_link_specific_input
 
     @payment_link_specific_input.setter
-    def payment_link_specific_input(self, value: PaymentLinkSpecificInput):
+    def payment_link_specific_input(self, value: Optional[PaymentLinkSpecificInput]) -> None:
         self.__payment_link_specific_input = value
 
     @property
-    def recipient_name(self) -> str:
+    def recipient_name(self) -> Optional[str]:
         """
         | The payment link recipient name.
-        
-        | Deprecated: Use `paymentLinkSpecificInput/recipientName` instead.
+        |
+        | Deprecated: Use ``paymentLinkSpecificInput/recipientName`` instead.
 
         Type: str
+
+        Deprecated; The payment link recipient name.  Use paymentLinkSpecificInput/recipientName instead.
         """
         return self.__recipient_name
 
     @recipient_name.setter
-    def recipient_name(self, value: str):
+    def recipient_name(self, value: Optional[str]) -> None:
         self.__recipient_name = value
 
     @property
-    def redirect_payment_method_specific_input(self) -> RedirectPaymentMethodSpecificInput:
+    def redirect_payment_method_specific_input(self) -> Optional[RedirectPaymentMethodSpecificInput]:
         """
         | Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal
 
@@ -187,11 +201,11 @@ class CreatePaymentLinkRequest(DataObject):
         return self.__redirect_payment_method_specific_input
 
     @redirect_payment_method_specific_input.setter
-    def redirect_payment_method_specific_input(self, value: RedirectPaymentMethodSpecificInput):
+    def redirect_payment_method_specific_input(self, value: Optional[RedirectPaymentMethodSpecificInput]) -> None:
         self.__redirect_payment_method_specific_input = value
 
     @property
-    def sepa_direct_debit_payment_method_specific_input(self) -> SepaDirectDebitPaymentMethodSpecificInputBase:
+    def sepa_direct_debit_payment_method_specific_input(self) -> Optional[SepaDirectDebitPaymentMethodSpecificInputBase]:
         """
         | Object containing the specific input details for SEPA direct debit payments
 
@@ -200,17 +214,19 @@ class CreatePaymentLinkRequest(DataObject):
         return self.__sepa_direct_debit_payment_method_specific_input
 
     @sepa_direct_debit_payment_method_specific_input.setter
-    def sepa_direct_debit_payment_method_specific_input(self, value: SepaDirectDebitPaymentMethodSpecificInputBase):
+    def sepa_direct_debit_payment_method_specific_input(self, value: Optional[SepaDirectDebitPaymentMethodSpecificInputBase]) -> None:
         self.__sepa_direct_debit_payment_method_specific_input = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(CreatePaymentLinkRequest, self).to_dictionary()
         if self.card_payment_method_specific_input is not None:
             dictionary['cardPaymentMethodSpecificInput'] = self.card_payment_method_specific_input.to_dictionary()
         if self.description is not None:
             dictionary['description'] = self.description
         if self.expiration_date is not None:
-            dictionary['expirationDate'] = self.expiration_date
+            dictionary['expirationDate'] = DataObject.format_datetime(self.expiration_date)
+        if self.feedbacks is not None:
+            dictionary['feedbacks'] = self.feedbacks.to_dictionary()
         if self.fraud_fields is not None:
             dictionary['fraudFields'] = self.fraud_fields.to_dictionary()
         if self.hosted_checkout_specific_input is not None:
@@ -231,7 +247,7 @@ class CreatePaymentLinkRequest(DataObject):
             dictionary['sepaDirectDebitPaymentMethodSpecificInput'] = self.sepa_direct_debit_payment_method_specific_input.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CreatePaymentLinkRequest':
         super(CreatePaymentLinkRequest, self).from_dictionary(dictionary)
         if 'cardPaymentMethodSpecificInput' in dictionary:
             if not isinstance(dictionary['cardPaymentMethodSpecificInput'], dict):
@@ -241,7 +257,12 @@ class CreatePaymentLinkRequest(DataObject):
         if 'description' in dictionary:
             self.description = dictionary['description']
         if 'expirationDate' in dictionary:
-            self.expiration_date = dictionary['expirationDate']
+            self.expiration_date = DataObject.parse_datetime(dictionary['expirationDate'])
+        if 'feedbacks' in dictionary:
+            if not isinstance(dictionary['feedbacks'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['feedbacks']))
+            value = Feedbacks()
+            self.feedbacks = value.from_dictionary(dictionary['feedbacks'])
         if 'fraudFields' in dictionary:
             if not isinstance(dictionary['fraudFields'], dict):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['fraudFields']))