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

onlinepayments/sdk/domain/payout_status_output.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PayoutStatusOutput(DataObject):
+
+    __is_cancellable: Optional[bool] = None
+    __status_category: Optional[str] = None
+    __status_code: Optional[int] = None
+
+    @property
+    def is_cancellable(self) -> Optional[bool]:
+        """
+        | Flag indicating if the payout can be cancelled
+        
+        * true
+        * false
+
+        Type: bool
+        """
+        return self.__is_cancellable
+
+    @is_cancellable.setter
+    def is_cancellable(self, value: Optional[bool]) -> None:
+        self.__is_cancellable = value
+
+    @property
+    def status_category(self) -> Optional[str]:
+        """
+        | Highlevel status of the payment, payout or refund.
+
+        Type: str
+        """
+        return self.__status_category
+
+    @status_category.setter
+    def status_category(self, value: Optional[str]) -> None:
+        self.__status_category = value
+
+    @property
+    def status_code(self) -> Optional[int]:
+        """
+        | Numeric status code of the legacy API. The value can also be found in the BackOffice and in report files.
+
+        Type: int
+        """
+        return self.__status_code
+
+    @status_code.setter
+    def status_code(self, value: Optional[int]) -> None:
+        self.__status_code = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PayoutStatusOutput, self).to_dictionary()
+        if self.is_cancellable is not None:
+            dictionary['isCancellable'] = self.is_cancellable
+        if self.status_category is not None:
+            dictionary['statusCategory'] = self.status_category
+        if self.status_code is not None:
+            dictionary['statusCode'] = self.status_code
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PayoutStatusOutput':
+        super(PayoutStatusOutput, self).from_dictionary(dictionary)
+        if 'isCancellable' in dictionary:
+            self.is_cancellable = dictionary['isCancellable']
+        if 'statusCategory' in dictionary:
+            self.status_category = dictionary['statusCategory']
+        if 'statusCode' in dictionary:
+            self.status_code = dictionary['statusCode']
+        return self

onlinepayments/sdk/domain/pending_authentication.py

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

onlinepayments/sdk/domain/personal_information.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .personal_name import PersonalName
+
+
+class PersonalInformation(DataObject):
+
+    __date_of_birth: Optional[str] = None
+    __gender: Optional[str] = None
+    __name: Optional[PersonalName] = None
+
+    @property
+    def date_of_birth(self) -> Optional[str]:
+        """
+        | The date of birth of the customer of the recipient of the loan. Format YYYYMMDD
+
+        Type: str
+        """
+        return self.__date_of_birth
+
+    @date_of_birth.setter
+    def date_of_birth(self, value: Optional[str]) -> None:
+        self.__date_of_birth = value
+
+    @property
+    def gender(self) -> Optional[str]:
+        """
+        | The gender of the customer. All values are possible as long as it does not exceed the maximum length of 50 characters.
+
+        Type: str
+        """
+        return self.__gender
+
+    @gender.setter
+    def gender(self, value: Optional[str]) -> None:
+        self.__gender = value
+
+    @property
+    def name(self) -> Optional[PersonalName]:
+        """
+        | Object containing the name details of the customer
+
+        Type: :class:`onlinepayments.sdk.domain.personal_name.PersonalName`
+        """
+        return self.__name
+
+    @name.setter
+    def name(self, value: Optional[PersonalName]) -> None:
+        self.__name = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PersonalInformation, self).to_dictionary()
+        if self.date_of_birth is not None:
+            dictionary['dateOfBirth'] = self.date_of_birth
+        if self.gender is not None:
+            dictionary['gender'] = self.gender
+        if self.name is not None:
+            dictionary['name'] = self.name.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PersonalInformation':
+        super(PersonalInformation, self).from_dictionary(dictionary)
+        if 'dateOfBirth' in dictionary:
+            self.date_of_birth = dictionary['dateOfBirth']
+        if 'gender' in dictionary:
+            self.gender = dictionary['gender']
+        if 'name' in dictionary:
+            if not isinstance(dictionary['name'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['name']))
+            value = PersonalName()
+            self.name = value.from_dictionary(dictionary['name'])
+        return self

onlinepayments/sdk/domain/personal_information_token.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .personal_name_token import PersonalNameToken
+
+
+class PersonalInformationToken(DataObject):
+
+    __name: Optional[PersonalNameToken] = None
+
+    @property
+    def name(self) -> Optional[PersonalNameToken]:
+        """
+        Type: :class:`onlinepayments.sdk.domain.personal_name_token.PersonalNameToken`
+        """
+        return self.__name
+
+    @name.setter
+    def name(self, value: Optional[PersonalNameToken]) -> None:
+        self.__name = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PersonalInformationToken, self).to_dictionary()
+        if self.name is not None:
+            dictionary['name'] = self.name.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PersonalInformationToken':
+        super(PersonalInformationToken, 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 = PersonalNameToken()
+            self.name = value.from_dictionary(dictionary['name'])
+        return self

onlinepayments/sdk/domain/personal_name.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PersonalName(DataObject):
+
+    __first_name: Optional[str] = None
+    __surname: Optional[str] = None
+    __title: Optional[str] = None
+
+    @property
+    def first_name(self) -> Optional[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: Optional[str]) -> None:
+        self.__first_name = value
+
+    @property
+    def surname(self) -> Optional[str]:
+        """
+        | Surname(s) or last name(s) of the customer
+
+        Type: str
+        """
+        return self.__surname
+
+    @surname.setter
+    def surname(self, value: Optional[str]) -> None:
+        self.__surname = value
+
+    @property
+    def title(self) -> Optional[str]:
+        """
+        | Title of customer
+
+        Type: str
+        """
+        return self.__title
+
+    @title.setter
+    def title(self, value: Optional[str]) -> None:
+        self.__title = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PersonalName, 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
+        if self.title is not None:
+            dictionary['title'] = self.title
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PersonalName':
+        super(PersonalName, self).from_dictionary(dictionary)
+        if 'firstName' in dictionary:
+            self.first_name = dictionary['firstName']
+        if 'surname' in dictionary:
+            self.surname = dictionary['surname']
+        if 'title' in dictionary:
+            self.title = dictionary['title']
+        return self

onlinepayments/sdk/domain/personal_name_token.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PersonalNameToken(DataObject):
+
+    __first_name: Optional[str] = None
+    __surname: Optional[str] = None
+
+    @property
+    def first_name(self) -> Optional[str]:
+        """
+        Type: str
+        """
+        return self.__first_name
+
+    @first_name.setter
+    def first_name(self, value: Optional[str]) -> None:
+        self.__first_name = value
+
+    @property
+    def surname(self) -> Optional[str]:
+        """
+        Type: str
+        """
+        return self.__surname
+
+    @surname.setter
+    def surname(self, value: Optional[str]) -> None:
+        self.__surname = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PersonalNameToken, 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: dict) -> 'PersonalNameToken':
+        super(PersonalNameToken, 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/domain/product302_recurring.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class Product302Recurring(DataObject):
+
+    __recurring_payment_sequence_indicator: Optional[str] = None
+
+    @property
+    def recurring_payment_sequence_indicator(self) -> Optional[str]:
+        """
+        * first = This transaction is the first of a series of recurring transactions
+
+        Type: str
+        """
+        return self.__recurring_payment_sequence_indicator
+
+    @recurring_payment_sequence_indicator.setter
+    def recurring_payment_sequence_indicator(self, value: Optional[str]) -> None:
+        self.__recurring_payment_sequence_indicator = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(Product302Recurring, self).to_dictionary()
+        if self.recurring_payment_sequence_indicator is not None:
+            dictionary['recurringPaymentSequenceIndicator'] = self.recurring_payment_sequence_indicator
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'Product302Recurring':
+        super(Product302Recurring, self).from_dictionary(dictionary)
+        if 'recurringPaymentSequenceIndicator' in dictionary:
+            self.recurring_payment_sequence_indicator = dictionary['recurringPaymentSequenceIndicator']
+        return self

onlinepayments/sdk/domain/product320_recurring.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class Product320Recurring(DataObject):
+
+    __recurring_payment_sequence_indicator: Optional[str] = None
+
+    @property
+    def recurring_payment_sequence_indicator(self) -> Optional[str]:
+        """
+        * first = This transaction is the first of a series of recurring transactions
+
+        Type: str
+        """
+        return self.__recurring_payment_sequence_indicator
+
+    @recurring_payment_sequence_indicator.setter
+    def recurring_payment_sequence_indicator(self, value: Optional[str]) -> None:
+        self.__recurring_payment_sequence_indicator = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(Product320Recurring, self).to_dictionary()
+        if self.recurring_payment_sequence_indicator is not None:
+            dictionary['recurringPaymentSequenceIndicator'] = self.recurring_payment_sequence_indicator
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'Product320Recurring':
+        super(Product320Recurring, self).from_dictionary(dictionary)
+        if 'recurringPaymentSequenceIndicator' in dictionary:
+            self.recurring_payment_sequence_indicator = dictionary['recurringPaymentSequenceIndicator']
+        return self

onlinepayments/sdk/domain/product_directory.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .data_object import DataObject
+from .directory_entry import DirectoryEntry
+
+
+class ProductDirectory(DataObject):
+
+    __entries: Optional[List[DirectoryEntry]] = None
+
+    @property
+    def entries(self) -> Optional[List[DirectoryEntry]]:
+        """
+        | List of entries in the directory
+
+        Type: list[:class:`onlinepayments.sdk.domain.directory_entry.DirectoryEntry`]
+        """
+        return self.__entries
+
+    @entries.setter
+    def entries(self, value: Optional[List[DirectoryEntry]]) -> None:
+        self.__entries = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(ProductDirectory, self).to_dictionary()
+        if self.entries is not None:
+            dictionary['entries'] = []
+            for element in self.entries:
+                if element is not None:
+                    dictionary['entries'].append(element.to_dictionary())
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'ProductDirectory':
+        super(ProductDirectory, self).from_dictionary(dictionary)
+        if 'entries' in dictionary:
+            if not isinstance(dictionary['entries'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['entries']))
+            self.entries = []
+            for element in dictionary['entries']:
+                value = DirectoryEntry()
+                self.entries.append(value.from_dictionary(element))
+        return self

onlinepayments/sdk/domain/protection_eligibility.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class ProtectionEligibility(DataObject):
+
+    __eligibility: Optional[str] = None
+    __type: Optional[str] = None
+
+    @property
+    def eligibility(self) -> Optional[str]:
+        """
+        * Eligible - Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment and Item Not Received
+        * PartiallyEligible - Merchant is protected by PayPal's Seller Protection Policy for Item Not Received
+        * Ineligible — Merchant is not protected under the Seller Protection Policy
+
+        Type: str
+        """
+        return self.__eligibility
+
+    @eligibility.setter
+    def eligibility(self, value: Optional[str]) -> None:
+        self.__eligibility = value
+
+    @property
+    def type(self) -> Optional[str]:
+        """
+        * ItemNotReceivedEligible - Merchant is protected by PayPal's Seller Protection Policy for Item Not Received
+        * UnauthorizedPaymentEligible - Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment
+        * Ineligible - Merchant is not protected under the Seller Protection Policy
+
+        Type: str
+        """
+        return self.__type
+
+    @type.setter
+    def type(self, value: Optional[str]) -> None:
+        self.__type = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(ProtectionEligibility, self).to_dictionary()
+        if self.eligibility is not None:
+            dictionary['eligibility'] = self.eligibility
+        if self.type is not None:
+            dictionary['type'] = self.type
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'ProtectionEligibility':
+        super(ProtectionEligibility, self).from_dictionary(dictionary)
+        if 'eligibility' in dictionary:
+            self.eligibility = dictionary['eligibility']
+        if 'type' in dictionary:
+            self.type = dictionary['type']
+        return self

onlinepayments/sdk/domain/range_validator.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class RangeValidator(DataObject):
+
+    __max_value: Optional[int] = None
+    __min_value: Optional[int] = None
+
+    @property
+    def max_value(self) -> Optional[int]:
+        """
+        Type: int
+        """
+        return self.__max_value
+
+    @max_value.setter
+    def max_value(self, value: Optional[int]) -> None:
+        self.__max_value = value
+
+    @property
+    def min_value(self) -> Optional[int]:
+        """
+        Type: int
+        """
+        return self.__min_value
+
+    @min_value.setter
+    def min_value(self, value: Optional[int]) -> None:
+        self.__min_value = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RangeValidator, self).to_dictionary()
+        if self.max_value is not None:
+            dictionary['maxValue'] = self.max_value
+        if self.min_value is not None:
+            dictionary['minValue'] = self.min_value
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RangeValidator':
+        super(RangeValidator, self).from_dictionary(dictionary)
+        if 'maxValue' in dictionary:
+            self.max_value = dictionary['maxValue']
+        if 'minValue' in dictionary:
+            self.min_value = dictionary['minValue']
+        return self