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

onlinepayments/sdk/domain/decrypted_payment_data.py

@@ -0,0 +1,120 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class DecryptedPaymentData(DataObject):
+
+    __cardholder_name: Optional[str] = None
+    __cryptogram: Optional[str] = None
+    __dpan: Optional[str] = None
+    __eci: Optional[int] = None
+    __expiry_date: Optional[str] = None
+
+    @property
+    def cardholder_name(self) -> Optional[str]:
+        """
+        | Card holder's name on the card.
+        
+        * For Apple Pay, maps to the cardholderName property in the encrypted payment data.
+
+        Type: str
+        """
+        return self.__cardholder_name
+
+    @cardholder_name.setter
+    def cardholder_name(self, value: Optional[str]) -> None:
+        self.__cardholder_name = value
+
+    @property
+    def cryptogram(self) -> Optional[str]:
+        """
+        | The 3D secure online payment cryptogram.
+        
+        * For Apple Pay, maps to the paymentData.onlinePaymentCryptogram property in the encrypted payment data.
+        * For Google Pay, maps to the paymentMethodDetails.3dsCryptogram property in the encrypted payment data. Not allowed for Google Pay if the paymentMethod is CARD.
+
+        Type: str
+        """
+        return self.__cryptogram
+
+    @cryptogram.setter
+    def cryptogram(self, value: Optional[str]) -> None:
+        self.__cryptogram = value
+
+    @property
+    def dpan(self) -> Optional[str]:
+        """
+        | The device specific PAN.
+        
+        * For Apple Pay, maps to the applicationPrimaryAccountNumber property in the encrypted payment.
+
+        Type: str
+        """
+        return self.__dpan
+
+    @dpan.setter
+    def dpan(self, value: Optional[str]) -> None:
+        self.__dpan = value
+
+    @property
+    def eci(self) -> Optional[int]:
+        """
+        | Electronic Commerce Indicator.
+        
+        * For Apple Pay, maps to the paymentData.eciIndicator property in the encrypted payment data.
+
+        Type: int
+        """
+        return self.__eci
+
+    @eci.setter
+    def eci(self, value: Optional[int]) -> None:
+        self.__eci = value
+
+    @property
+    def expiry_date(self) -> Optional[str]:
+        """
+        | Expiry date of the card Format: MMYY.
+        
+        * For Apple Pay, maps to the applicationExpirationDate property in the encrypted payment data. This property is formatted as YYMMDD, so this needs to be converted to get a correctly formatted expiry date
+
+        Type: str
+        """
+        return self.__expiry_date
+
+    @expiry_date.setter
+    def expiry_date(self, value: Optional[str]) -> None:
+        self.__expiry_date = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(DecryptedPaymentData, self).to_dictionary()
+        if self.cardholder_name is not None:
+            dictionary['cardholderName'] = self.cardholder_name
+        if self.cryptogram is not None:
+            dictionary['cryptogram'] = self.cryptogram
+        if self.dpan is not None:
+            dictionary['dpan'] = self.dpan
+        if self.eci is not None:
+            dictionary['eci'] = self.eci
+        if self.expiry_date is not None:
+            dictionary['expiryDate'] = self.expiry_date
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'DecryptedPaymentData':
+        super(DecryptedPaymentData, self).from_dictionary(dictionary)
+        if 'cardholderName' in dictionary:
+            self.cardholder_name = dictionary['cardholderName']
+        if 'cryptogram' in dictionary:
+            self.cryptogram = dictionary['cryptogram']
+        if 'dpan' in dictionary:
+            self.dpan = dictionary['dpan']
+        if 'eci' in dictionary:
+            self.eci = dictionary['eci']
+        if 'expiryDate' in dictionary:
+            self.expiry_date = dictionary['expiryDate']
+        return self

onlinepayments/sdk/domain/detokenization_response.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .data_object import DataObject
+from .detokenized_token_response import DetokenizedTokenResponse
+
+
+class DetokenizationResponse(DataObject):
+
+    __tokens: Optional[List[DetokenizedTokenResponse]] = None
+
+    @property
+    def tokens(self) -> Optional[List[DetokenizedTokenResponse]]:
+        """
+        | The response contains an array of detokenized data for the provided token IDs, which includes card details and expiration dates.
+
+        Type: list[:class:`onlinepayments.sdk.domain.detokenized_token_response.DetokenizedTokenResponse`]
+        """
+        return self.__tokens
+
+    @tokens.setter
+    def tokens(self, value: Optional[List[DetokenizedTokenResponse]]) -> None:
+        self.__tokens = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(DetokenizationResponse, self).to_dictionary()
+        if self.tokens is not None:
+            dictionary['tokens'] = []
+            for element in self.tokens:
+                if element is not None:
+                    dictionary['tokens'].append(element.to_dictionary())
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'DetokenizationResponse':
+        super(DetokenizationResponse, self).from_dictionary(dictionary)
+        if 'tokens' in dictionary:
+            if not isinstance(dictionary['tokens'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['tokens']))
+            self.tokens = []
+            for element in dictionary['tokens']:
+                value = DetokenizedTokenResponse()
+                self.tokens.append(value.from_dictionary(element))
+        return self

onlinepayments/sdk/domain/detokenized_token_response.py

@@ -0,0 +1,145 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class DetokenizedTokenResponse(DataObject):
+
+    __card_brand: Optional[str] = None
+    __card_expiry_date: Optional[str] = None
+    __card_holder_name: Optional[str] = None
+    __encrypted_card_number: Optional[str] = None
+    __payment_id: Optional[str] = None
+    __scheme_reference_data: Optional[str] = None
+    __token: Optional[str] = None
+
+    @property
+    def card_brand(self) -> Optional[str]:
+        """
+        | The brand of the card (e.g., VISA, MasterCard).
+
+        Type: str
+        """
+        return self.__card_brand
+
+    @card_brand.setter
+    def card_brand(self, value: Optional[str]) -> None:
+        self.__card_brand = value
+
+    @property
+    def card_expiry_date(self) -> Optional[str]:
+        """
+        | The expiration date of the card in MMYY format, where MM represents the two-digit month and YY represents the two-digit year. For example, a value of 0529 indicates that the card expires in May 2029.
+
+        Type: str
+        """
+        return self.__card_expiry_date
+
+    @card_expiry_date.setter
+    def card_expiry_date(self, value: Optional[str]) -> None:
+        self.__card_expiry_date = value
+
+    @property
+    def card_holder_name(self) -> Optional[str]:
+        """
+        | The full name of the cardholder as it appears on the card.
+
+        Type: str
+        """
+        return self.__card_holder_name
+
+    @card_holder_name.setter
+    def card_holder_name(self, value: Optional[str]) -> None:
+        self.__card_holder_name = value
+
+    @property
+    def encrypted_card_number(self) -> Optional[str]:
+        """
+        | The card number, encrypted and Base64 encoded for secure transport.
+
+        Type: str
+        """
+        return self.__encrypted_card_number
+
+    @encrypted_card_number.setter
+    def encrypted_card_number(self, value: Optional[str]) -> None:
+        self.__encrypted_card_number = value
+
+    @property
+    def payment_id(self) -> Optional[str]:
+        """
+        | The unique identifier for the payment associated with the token is necessary for tracking.
+
+        Type: str
+        """
+        return self.__payment_id
+
+    @payment_id.setter
+    def payment_id(self, value: Optional[str]) -> None:
+        self.__payment_id = value
+
+    @property
+    def scheme_reference_data(self) -> Optional[str]:
+        """
+        | Reference data associated with the payment scheme for the credentials on file.
+
+        Type: str
+        """
+        return self.__scheme_reference_data
+
+    @scheme_reference_data.setter
+    def scheme_reference_data(self, value: Optional[str]) -> None:
+        self.__scheme_reference_data = value
+
+    @property
+    def token(self) -> Optional[str]:
+        """
+        | The unique identifier for the token is required for processing.
+
+        Type: str
+        """
+        return self.__token
+
+    @token.setter
+    def token(self, value: Optional[str]) -> None:
+        self.__token = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(DetokenizedTokenResponse, self).to_dictionary()
+        if self.card_brand is not None:
+            dictionary['cardBrand'] = self.card_brand
+        if self.card_expiry_date is not None:
+            dictionary['cardExpiryDate'] = self.card_expiry_date
+        if self.card_holder_name is not None:
+            dictionary['cardHolderName'] = self.card_holder_name
+        if self.encrypted_card_number is not None:
+            dictionary['encryptedCardNumber'] = self.encrypted_card_number
+        if self.payment_id is not None:
+            dictionary['paymentId'] = self.payment_id
+        if self.scheme_reference_data is not None:
+            dictionary['schemeReferenceData'] = self.scheme_reference_data
+        if self.token is not None:
+            dictionary['token'] = self.token
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'DetokenizedTokenResponse':
+        super(DetokenizedTokenResponse, self).from_dictionary(dictionary)
+        if 'cardBrand' in dictionary:
+            self.card_brand = dictionary['cardBrand']
+        if 'cardExpiryDate' in dictionary:
+            self.card_expiry_date = dictionary['cardExpiryDate']
+        if 'cardHolderName' in dictionary:
+            self.card_holder_name = dictionary['cardHolderName']
+        if 'encryptedCardNumber' in dictionary:
+            self.encrypted_card_number = dictionary['encryptedCardNumber']
+        if 'paymentId' in dictionary:
+            self.payment_id = dictionary['paymentId']
+        if 'schemeReferenceData' in dictionary:
+            self.scheme_reference_data = dictionary['schemeReferenceData']
+        if 'token' in dictionary:
+            self.token = dictionary['token']
+        return self

onlinepayments/sdk/domain/directory_entry.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class DirectoryEntry(DataObject):
+
+    __issuer_id: Optional[str] = None
+    __issuer_list: Optional[str] = None
+    __issuer_name: Optional[str] = None
+
+    @property
+    def issuer_id(self) -> Optional[str]:
+        """
+        | Deprecated. Unique ID of the issuing bank of the customer
+
+        Type: str
+        """
+        return self.__issuer_id
+
+    @issuer_id.setter
+    def issuer_id(self, value: Optional[str]) -> None:
+        self.__issuer_id = value
+
+    @property
+    def issuer_list(self) -> Optional[str]:
+        """
+        | To be used to sort the issuers. short - These issuers should be presented at the top of the list long - These issuers should be presented after the issuers marked as short Note this is only filled if supported by the payment product. Currently only iDeal (809) support this. Sorting within the groups should be done alphabetically
+
+        Type: str
+        """
+        return self.__issuer_list
+
+    @issuer_list.setter
+    def issuer_list(self, value: Optional[str]) -> None:
+        self.__issuer_list = value
+
+    @property
+    def issuer_name(self) -> Optional[str]:
+        """
+        | Name of the issuing bank as it should be presented to the customer
+
+        Type: str
+        """
+        return self.__issuer_name
+
+    @issuer_name.setter
+    def issuer_name(self, value: Optional[str]) -> None:
+        self.__issuer_name = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(DirectoryEntry, self).to_dictionary()
+        if self.issuer_id is not None:
+            dictionary['issuerId'] = self.issuer_id
+        if self.issuer_list is not None:
+            dictionary['issuerList'] = self.issuer_list
+        if self.issuer_name is not None:
+            dictionary['issuerName'] = self.issuer_name
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'DirectoryEntry':
+        super(DirectoryEntry, self).from_dictionary(dictionary)
+        if 'issuerId' in dictionary:
+            self.issuer_id = dictionary['issuerId']
+        if 'issuerList' in dictionary:
+            self.issuer_list = dictionary['issuerList']
+        if 'issuerName' in dictionary:
+            self.issuer_name = dictionary['issuerName']
+        return self

onlinepayments/sdk/domain/discount.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class Discount(DataObject):
+
+    __amount: Optional[int] = None
+
+    @property
+    def amount(self) -> Optional[int]:
+        """
+        | Amount in the smallest currency unit, i.e.:
+        
+        * EUR is a 2-decimals currency, the value 1234 will result in EUR 12.34
+        * KWD is a 3-decimals currency, the value 1234 will result in KWD 1.234
+        * JPY is a zero-decimal currency, the value 1234 will result in JPY 1234
+
+        Type: int
+        """
+        return self.__amount
+
+    @amount.setter
+    def amount(self, value: Optional[int]) -> None:
+        self.__amount = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(Discount, self).to_dictionary()
+        if self.amount is not None:
+            dictionary['amount'] = self.amount
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'Discount':
+        super(Discount, self).from_dictionary(dictionary)
+        if 'amount' in dictionary:
+            self.amount = dictionary['amount']
+        return self

onlinepayments/sdk/domain/empty_validator.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from .data_object import DataObject
+
+
+class EmptyValidator(DataObject):
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(EmptyValidator, self).to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'EmptyValidator':
+        super(EmptyValidator, self).from_dictionary(dictionary)
+        return self

onlinepayments/sdk/domain/error_response.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .api_error import APIError
+from .data_object import DataObject
+
+
+class ErrorResponse(DataObject):
+
+    __error_id: Optional[str] = None
+    __errors: Optional[List[APIError]] = None
+
+    @property
+    def error_id(self) -> Optional[str]:
+        """
+        | Unique reference, for debugging purposes, of this error response
+
+        Type: str
+        """
+        return self.__error_id
+
+    @error_id.setter
+    def error_id(self, value: Optional[str]) -> None:
+        self.__error_id = value
+
+    @property
+    def errors(self) -> Optional[List[APIError]]:
+        """
+        | List of one or more errors
+
+        Type: list[:class:`onlinepayments.sdk.domain.api_error.APIError`]
+        """
+        return self.__errors
+
+    @errors.setter
+    def errors(self, value: Optional[List[APIError]]) -> None:
+        self.__errors = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(ErrorResponse, self).to_dictionary()
+        if self.error_id is not None:
+            dictionary['errorId'] = self.error_id
+        if self.errors is not None:
+            dictionary['errors'] = []
+            for element in self.errors:
+                if element is not None:
+                    dictionary['errors'].append(element.to_dictionary())
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'ErrorResponse':
+        super(ErrorResponse, self).from_dictionary(dictionary)
+        if 'errorId' in dictionary:
+            self.error_id = dictionary['errorId']
+        if 'errors' in dictionary:
+            if not isinstance(dictionary['errors'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['errors']))
+            self.errors = []
+            for element in dictionary['errors']:
+                value = APIError()
+                self.errors.append(value.from_dictionary(element))
+        return self