onlinepayments-sdk-python3 4.21.0__zip → 4.23.0__zip

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/mandate_address_response.py

@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+#
+# This class was auto-generated.
+#
+from onlinepayments.sdk.data_object import DataObject
+
+
+class MandateAddressResponse(DataObject):
+    """
+    | Object containing consumer address details
+    """
+
+    __city = None
+    __country_code = None
+    __house_number = None
+    __street = None
+    __zip = None
+
+    @property
+    def city(self) -> str:
+        """
+        | City
+
+        Type: str
+        """
+        return self.__city
+
+    @city.setter
+    def city(self, value: str):
+        self.__city = value
+
+    @property
+    def country_code(self) -> str:
+        """
+        | ISO 3166-1 alpha-2 country code.
+
+        Type: str
+        """
+        return self.__country_code
+
+    @country_code.setter
+    def country_code(self, value: str):
+        self.__country_code = value
+
+    @property
+    def house_number(self) -> str:
+        """
+        | House number
+
+        Type: str
+        """
+        return self.__house_number
+
+    @house_number.setter
+    def house_number(self, value: str):
+        self.__house_number = value
+
+    @property
+    def street(self) -> str:
+        """
+        | Streetname
+
+        Type: str
+        """
+        return self.__street
+
+    @street.setter
+    def street(self, value: str):
+        self.__street = value
+
+    @property
+    def zip(self) -> str:
+        """
+        | Zip code
+
+        Type: str
+        """
+        return self.__zip
+
+    @zip.setter
+    def zip(self, value: str):
+        self.__zip = value
+
+    def to_dictionary(self):
+        dictionary = super(MandateAddressResponse, self).to_dictionary()
+        if self.city is not None:
+            dictionary['city'] = self.city
+        if self.country_code is not None:
+            dictionary['countryCode'] = self.country_code
+        if self.house_number is not None:
+            dictionary['houseNumber'] = self.house_number
+        if self.street is not None:
+            dictionary['street'] = self.street
+        if self.zip is not None:
+            dictionary['zip'] = self.zip
+        return dictionary
+
+    def from_dictionary(self, dictionary):
+        super(MandateAddressResponse, self).from_dictionary(dictionary)
+        if 'city' in dictionary:
+            self.city = dictionary['city']
+        if 'countryCode' in dictionary:
+            self.country_code = dictionary['countryCode']
+        if 'houseNumber' in dictionary:
+            self.house_number = dictionary['houseNumber']
+        if 'street' in dictionary:
+            self.street = dictionary['street']
+        if 'zip' in dictionary:
+            self.zip = dictionary['zip']
+        return self

{onlinepayments-sdk-python3-4.21.0 → onlinepayments-sdk-python3-4.23.0}/onlinepayments/sdk/domain/mandate_contact_details.py

@@ -7,7 +7,7 @@ from onlinepayments.sdk.data_object import DataObject
 
 class MandateContactDetails(DataObject):
     """
-    | Object containing contact details like email address and phone number
+    | Object containing email address
     """
 
     __email_address = None

{onlinepayments-sdk-python3-4.21.0 → onlinepayments-sdk-python3-4.23.0}/onlinepayments/sdk/domain/mandate_customer.py

@@ -50,7 +50,7 @@ class MandateCustomer(DataObject):
     @property
     def contact_details(self) -> MandateContactDetails:
         """
-        | Object containing contact details like email address and phone number
+        | Object containing email address
 
         Type: :class:`onlinepayments.sdk.domain.mandate_contact_details.MandateContactDetails`
         """
@@ -63,7 +63,7 @@ class MandateCustomer(DataObject):
     @property
     def mandate_address(self) -> MandateAddress:
         """
-        | Object containing billing address details.
+        | Object containing consumer address details.
         | Required for Create mandate and Create payment calls.
         | Required for Create hostedCheckout calls where the IBAN is also provided.
 

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/mandate_customer_response.py

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

{onlinepayments-sdk-python3-4.21.0 → onlinepayments-sdk-python3-4.23.0}/onlinepayments/sdk/domain/mandate_personal_information.py

@@ -32,8 +32,7 @@ class MandatePersonalInformation(DataObject):
     @property
     def title(self) -> str:
         """
-        | Object containing the title of the customer (Mr, Miss or Mrs).
-        | Required for Create mandate and Create payment calls.
+        | Object containing the title of the customer (Mr, Miss or Mrs)
 
         Type: str
         """

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/mandate_personal_information_response.py

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

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/mandate_personal_name_response.py

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

{onlinepayments-sdk-python3-4.21.0 → onlinepayments-sdk-python3-4.23.0}/onlinepayments/sdk/domain/mandate_response.py

@@ -3,7 +3,7 @@
 # This class was auto-generated.
 #
 from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.mandate_customer import MandateCustomer
+from onlinepayments.sdk.domain.mandate_customer_response import MandateCustomerResponse
 
 
 class MandateResponse(DataObject):
@@ -14,6 +14,7 @@ class MandateResponse(DataObject):
     __alias = None
     __customer = None
     __customer_reference = None
+    __mandate_pdf = None
     __recurrence_type = None
     __status = None
     __unique_mandate_reference = None
@@ -32,17 +33,16 @@ class MandateResponse(DataObject):
         self.__alias = value
 
     @property
-    def customer(self) -> MandateCustomer:
+    def customer(self) -> MandateCustomerResponse:
         """
-        | Customer object containing customer specific inputs.
-        | Required for Create mandate and Create payment calls.
+        | Customer object containing customer specific outputs.
 
-        Type: :class:`onlinepayments.sdk.domain.mandate_customer.MandateCustomer`
+        Type: :class:`onlinepayments.sdk.domain.mandate_customer_response.MandateCustomerResponse`
         """
         return self.__customer
 
     @customer.setter
-    def customer(self, value: MandateCustomer):
+    def customer(self, value: MandateCustomerResponse):
         self.__customer = value
 
     @property
@@ -58,6 +58,19 @@ class MandateResponse(DataObject):
     def customer_reference(self, value: str):
         self.__customer_reference = value
 
+    @property
+    def mandate_pdf(self) -> str:
+        """
+        | The mandate PDF in base64 encoded string
+
+        Type: str
+        """
+        return self.__mandate_pdf
+
+    @mandate_pdf.setter
+    def mandate_pdf(self, value: str):
+        self.__mandate_pdf = value
+
     @property
     def recurrence_type(self) -> str:
         """
@@ -105,6 +118,8 @@ class MandateResponse(DataObject):
             dictionary['customer'] = self.customer.to_dictionary()
         if self.customer_reference is not None:
             dictionary['customerReference'] = self.customer_reference
+        if self.mandate_pdf is not None:
+            dictionary['mandatePdf'] = self.mandate_pdf
         if self.recurrence_type is not None:
             dictionary['recurrenceType'] = self.recurrence_type
         if self.status is not None:
@@ -120,10 +135,12 @@ class MandateResponse(DataObject):
         if 'customer' in dictionary:
             if not isinstance(dictionary['customer'], dict):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['customer']))
-            value = MandateCustomer()
+            value = MandateCustomerResponse()
             self.customer = value.from_dictionary(dictionary['customer'])
         if 'customerReference' in dictionary:
             self.customer_reference = dictionary['customerReference']
+        if 'mandatePdf' in dictionary:
+            self.mandate_pdf = dictionary['mandatePdf']
         if 'recurrenceType' in dictionary:
             self.recurrence_type = dictionary['recurrenceType']
         if 'status' in dictionary:

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/multiple_payment_information.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+#
+# This class was auto-generated.
+#
+from onlinepayments.sdk.data_object import DataObject
+
+
+class MultiplePaymentInformation(DataObject):
+    """
+    | Container announcing forecoming subsequent payments. Holds modalities of these subsequent payments.
+    """
+
+    __payment_pattern = None
+    __total_number_of_payments = None
+
+    @property
+    def payment_pattern(self) -> str:
+        """
+        | Typology of multiple payment. Allowed values:
+        |   * PartialShipment
+
+        Type: str
+        """
+        return self.__payment_pattern
+
+    @payment_pattern.setter
+    def payment_pattern(self, value: str):
+        self.__payment_pattern = value
+
+    @property
+    def total_number_of_payments(self) -> int:
+        """
+        | Total number of payments. If a payment is implied by this call, it implicitly has ordinal number 1.
+
+        Type: int
+        """
+        return self.__total_number_of_payments
+
+    @total_number_of_payments.setter
+    def total_number_of_payments(self, value: int):
+        self.__total_number_of_payments = value
+
+    def to_dictionary(self):
+        dictionary = super(MultiplePaymentInformation, self).to_dictionary()
+        if self.payment_pattern is not None:
+            dictionary['paymentPattern'] = self.payment_pattern
+        if self.total_number_of_payments is not None:
+            dictionary['totalNumberOfPayments'] = self.total_number_of_payments
+        return dictionary
+
+    def from_dictionary(self, dictionary):
+        super(MultiplePaymentInformation, self).from_dictionary(dictionary)
+        if 'paymentPattern' in dictionary:
+            self.payment_pattern = dictionary['paymentPattern']
+        if 'totalNumberOfPayments' in dictionary:
+            self.total_number_of_payments = dictionary['totalNumberOfPayments']
+        return self

{onlinepayments-sdk-python3-4.21.0 → onlinepayments-sdk-python3-4.23.0}/onlinepayments/sdk/domain/payment_link_order_input.py

@@ -10,6 +10,14 @@ from onlinepayments.sdk.domain.surcharge_for_payment_link import SurchargeForPay
 class PaymentLinkOrderInput(DataObject):
     """
     | 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` |
     """
 
     __amount = None

onlinepayments-sdk-python3-4.21.0/onlinepayments/sdk/domain/create_payment_link_request.py → onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/payment_link_specific_input.py

@@ -3,17 +3,15 @@
 # This class was auto-generated.
 #
 from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.payment_link_order_input import PaymentLinkOrderInput
 
 
-class CreatePaymentLinkRequest(DataObject):
+class PaymentLinkSpecificInput(DataObject):
     """
-    | An object containing the Create PaymentLink request.
+    | An object containing details specific to payment link creation
     """
 
     __description = None
     __expiration_date = None
-    __payment_link_order = None
     __recipient_name = None
 
     @property
@@ -32,7 +30,7 @@ class CreatePaymentLinkRequest(DataObject):
     @property
     def expiration_date(self) -> str:
         """
-        | The date after which the payment link will not be usable to complete the payment. The date sent cannot be more than 30 days in the future or a past date. It must also contain the UTC offset.
+        | 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.
 
         Type: str
         """
@@ -42,19 +40,6 @@ class CreatePaymentLinkRequest(DataObject):
     def expiration_date(self, value: str):
         self.__expiration_date = value
 
-    @property
-    def payment_link_order(self) -> PaymentLinkOrderInput:
-        """
-        | An object containing the details of the related payment input.
-
-        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):
-        self.__payment_link_order = value
-
     @property
     def recipient_name(self) -> str:
         """
@@ -69,28 +54,21 @@ class CreatePaymentLinkRequest(DataObject):
         self.__recipient_name = value
 
     def to_dictionary(self):
-        dictionary = super(CreatePaymentLinkRequest, self).to_dictionary()
+        dictionary = super(PaymentLinkSpecificInput, self).to_dictionary()
         if self.description is not None:
             dictionary['description'] = self.description
         if self.expiration_date is not None:
             dictionary['expirationDate'] = self.expiration_date
-        if self.payment_link_order is not None:
-            dictionary['paymentLinkOrder'] = self.payment_link_order.to_dictionary()
         if self.recipient_name is not None:
             dictionary['recipientName'] = self.recipient_name
         return dictionary
 
     def from_dictionary(self, dictionary):
-        super(CreatePaymentLinkRequest, self).from_dictionary(dictionary)
+        super(PaymentLinkSpecificInput, self).from_dictionary(dictionary)
         if 'description' in dictionary:
             self.description = dictionary['description']
         if 'expirationDate' in dictionary:
             self.expiration_date = dictionary['expirationDate']
-        if 'paymentLinkOrder' in dictionary:
-            if not isinstance(dictionary['paymentLinkOrder'], dict):
-                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['paymentLinkOrder']))
-            value = PaymentLinkOrderInput()
-            self.payment_link_order = value.from_dictionary(dictionary['paymentLinkOrder'])
         if 'recipientName' in dictionary:
             self.recipient_name = dictionary['recipientName']
         return self

{onlinepayments-sdk-python3-4.21.0 → onlinepayments-sdk-python3-4.23.0}/onlinepayments/sdk/domain/payment_output.py

@@ -6,6 +6,7 @@ from onlinepayments.sdk.data_object import DataObject
 from onlinepayments.sdk.domain.amount_of_money import AmountOfMoney
 from onlinepayments.sdk.domain.card_payment_method_specific_output import CardPaymentMethodSpecificOutput
 from onlinepayments.sdk.domain.customer_output import CustomerOutput
+from onlinepayments.sdk.domain.discount import Discount
 from onlinepayments.sdk.domain.mobile_payment_method_specific_output import MobilePaymentMethodSpecificOutput
 from onlinepayments.sdk.domain.payment_references import PaymentReferences
 from onlinepayments.sdk.domain.redirect_payment_method_specific_output import RedirectPaymentMethodSpecificOutput
@@ -23,6 +24,7 @@ class PaymentOutput(DataObject):
     __amount_paid = None
     __card_payment_method_specific_output = None
     __customer = None
+    __discount = None
     __merchant_parameters = None
     __mobile_payment_method_specific_output = None
     __payment_method = None
@@ -96,6 +98,19 @@ class PaymentOutput(DataObject):
     def customer(self, value: CustomerOutput):
         self.__customer = value
 
+    @property
+    def discount(self) -> Discount:
+        """
+        | Object to apply a discount to the total basket by adding a discount line.
+
+        Type: :class:`onlinepayments.sdk.domain.discount.Discount`
+        """
+        return self.__discount
+
+    @discount.setter
+    def discount(self, value: Discount):
+        self.__discount = value
+
     @property
     def merchant_parameters(self) -> str:
         """
@@ -199,6 +214,8 @@ class PaymentOutput(DataObject):
             dictionary['cardPaymentMethodSpecificOutput'] = self.card_payment_method_specific_output.to_dictionary()
         if self.customer is not None:
             dictionary['customer'] = self.customer.to_dictionary()
+        if self.discount is not None:
+            dictionary['discount'] = self.discount.to_dictionary()
         if self.merchant_parameters is not None:
             dictionary['merchantParameters'] = self.merchant_parameters
         if self.mobile_payment_method_specific_output is not None:
@@ -239,6 +256,11 @@ class PaymentOutput(DataObject):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['customer']))
             value = CustomerOutput()
             self.customer = value.from_dictionary(dictionary['customer'])
+        if 'discount' in dictionary:
+            if not isinstance(dictionary['discount'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['discount']))
+            value = Discount()
+            self.discount = value.from_dictionary(dictionary['discount'])
         if 'merchantParameters' in dictionary:
             self.merchant_parameters = dictionary['merchantParameters']
         if 'mobilePaymentMethodSpecificOutput' in dictionary: