onlinepayments-sdk-python3 4.23.0__zip → 5.1.0__zip

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/decrypted_payment_data.py

@@ -1,94 +1,97 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class DecryptedPaymentData(DataObject):
-    """
-    | The payment data if you do the decryption of the encrypted payment data yourself.
-    """
 
-    __cardholder_name = None
-    __cryptogram = None
-    __dpan = None
-    __eci = None
-    __expiry_date = None
+    __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) -> str:
+    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.
+        | 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: str):
+    def cardholder_name(self, value: Optional[str]) -> None:
         self.__cardholder_name = value
 
     @property
-    def cryptogram(self) -> str:
+    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.
+        
+        * 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: str):
+    def cryptogram(self, value: Optional[str]) -> None:
         self.__cryptogram = value
 
     @property
-    def dpan(self) -> str:
+    def dpan(self) -> Optional[str]:
         """
-        | The device specific PAN. 
-        |  * For Apple Pay, maps to the applicationPrimaryAccountNumber property in the encrypted payment.
+        | 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: str):
+    def dpan(self, value: Optional[str]) -> None:
         self.__dpan = value
 
     @property
-    def eci(self) -> int:
+    def eci(self) -> Optional[int]:
         """
-        | Electronic Commerce Indicator. 
-        |  * For Apple Pay, maps to the paymentData.eciIndicator property in the encrypted payment data.
+        | 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: int):
+    def eci(self, value: Optional[int]) -> None:
         self.__eci = value
 
     @property
-    def expiry_date(self) -> str:
+    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
+        | 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: str):
+    def expiry_date(self, value: Optional[str]) -> None:
         self.__expiry_date = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(DecryptedPaymentData, self).to_dictionary()
         if self.cardholder_name is not None:
             dictionary['cardholderName'] = self.cardholder_name
@@ -102,7 +105,7 @@ class DecryptedPaymentData(DataObject):
             dictionary['expiryDate'] = self.expiry_date
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'DecryptedPaymentData':
         super(DecryptedPaymentData, self).from_dictionary(dictionary)
         if 'cardholderName' in dictionary:
             self.cardholder_name = dictionary['cardholderName']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/directory_entry.py

@@ -1,46 +1,46 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class DirectoryEntry(DataObject):
-    __issuer_id = None
-    __issuer_list = None
-    __issuer_name = None
+
+    __issuer_id: Optional[str] = None
+    __issuer_list: Optional[str] = None
+    __issuer_name: Optional[str] = None
 
     @property
-    def issuer_id(self) -> str:
+    def issuer_id(self) -> Optional[str]:
         """
-        | Unique ID of the issuing bank of the customer
+        | Deprecated. Unique ID of the issuing bank of the customer
 
         Type: str
         """
         return self.__issuer_id
 
     @issuer_id.setter
-    def issuer_id(self, value: str):
+    def issuer_id(self, value: Optional[str]) -> None:
         self.__issuer_id = value
 
     @property
-    def issuer_list(self) -> str:
+    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
+        | 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: str):
+    def issuer_list(self, value: Optional[str]) -> None:
         self.__issuer_list = value
 
     @property
-    def issuer_name(self) -> str:
+    def issuer_name(self) -> Optional[str]:
         """
         | Name of the issuing bank as it should be presented to the customer
 
@@ -49,10 +49,10 @@ class DirectoryEntry(DataObject):
         return self.__issuer_name
 
     @issuer_name.setter
-    def issuer_name(self, value: str):
+    def issuer_name(self, value: Optional[str]) -> None:
         self.__issuer_name = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(DirectoryEntry, self).to_dictionary()
         if self.issuer_id is not None:
             dictionary['issuerId'] = self.issuer_id
@@ -62,7 +62,7 @@ class DirectoryEntry(DataObject):
             dictionary['issuerName'] = self.issuer_name
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'DirectoryEntry':
         super(DirectoryEntry, self).from_dictionary(dictionary)
         if 'issuerId' in dictionary:
             self.issuer_id = dictionary['issuerId']

onlinepayments_sdk_python3-5.1.0/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-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/empty_validator.py

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

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/error_response.py

@@ -1,19 +1,20 @@
 # -*- 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 onlinepayments.sdk.domain.api_error import APIError
+from .api_error import APIError
+from .data_object import DataObject
 
 
 class ErrorResponse(DataObject):
-    __error_id = None
-    __errors = None
+
+    __error_id: Optional[str] = None
+    __errors: Optional[List[APIError]] = None
 
     @property
-    def error_id(self) -> str:
+    def error_id(self) -> Optional[str]:
         """
         | Unique reference, for debugging purposes, of this error response
 
@@ -22,11 +23,11 @@ class ErrorResponse(DataObject):
         return self.__error_id
 
     @error_id.setter
-    def error_id(self, value: str):
+    def error_id(self, value: Optional[str]) -> None:
         self.__error_id = value
 
     @property
-    def errors(self) -> List[APIError]:
+    def errors(self) -> Optional[List[APIError]]:
         """
         | List of one or more errors
 
@@ -35,10 +36,10 @@ class ErrorResponse(DataObject):
         return self.__errors
 
     @errors.setter
-    def errors(self, value: List[APIError]):
+    def errors(self, value: Optional[List[APIError]]) -> None:
         self.__errors = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(ErrorResponse, self).to_dictionary()
         if self.error_id is not None:
             dictionary['errorId'] = self.error_id
@@ -49,7 +50,7 @@ class ErrorResponse(DataObject):
                     dictionary['errors'].append(element.to_dictionary())
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'ErrorResponse':
         super(ErrorResponse, self).from_dictionary(dictionary)
         if 'errorId' in dictionary:
             self.error_id = dictionary['errorId']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/external_cardholder_authentication_data.py

@@ -1,28 +1,27 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class ExternalCardholderAuthenticationData(DataObject):
-    """
-    | Object containing 3D secure details.
-    """
-
-    __acs_transaction_id = None
-    __applied_exemption = None
-    __cavv = None
-    __cavv_algorithm = None
-    __directory_server_transaction_id = None
-    __eci = None
-    __flow = None
-    __scheme_risk_score = None
-    __three_d_secure_version = None
-    __xid = None
+
+    __acs_transaction_id: Optional[str] = None
+    __applied_exemption: Optional[str] = None
+    __cavv: Optional[str] = None
+    __cavv_algorithm: Optional[str] = None
+    __directory_server_transaction_id: Optional[str] = None
+    __eci: Optional[int] = None
+    __flow: Optional[str] = None
+    __scheme_risk_score: Optional[int] = None
+    __three_d_secure_version: Optional[str] = None
+    __xid: Optional[str] = None
 
     @property
-    def acs_transaction_id(self) -> str:
+    def acs_transaction_id(self) -> Optional[str]:
         """
         | Identifier of the authenticated transaction at the ACS/Issuer.
 
@@ -31,11 +30,11 @@ class ExternalCardholderAuthenticationData(DataObject):
         return self.__acs_transaction_id
 
     @acs_transaction_id.setter
-    def acs_transaction_id(self, value: str):
+    def acs_transaction_id(self, value: Optional[str]) -> None:
         self.__acs_transaction_id = value
 
     @property
-    def applied_exemption(self) -> str:
+    def applied_exemption(self) -> Optional[str]:
         """
         | Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
 
@@ -44,77 +43,74 @@ class ExternalCardholderAuthenticationData(DataObject):
         return self.__applied_exemption
 
     @applied_exemption.setter
-    def applied_exemption(self, value: str):
+    def applied_exemption(self, value: Optional[str]) -> None:
         self.__applied_exemption = value
 
     @property
-    def cavv(self) -> str:
+    def cavv(self) -> Optional[str]:
         """
-        | The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
-        | Note:
-        |   This is mandatory for ECI 2 and 5.
+        | The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value. Note: This is mandatory for ECI 2 and 5.
 
         Type: str
         """
         return self.__cavv
 
     @cavv.setter
-    def cavv(self, value: str):
+    def cavv(self, value: Optional[str]) -> None:
         self.__cavv = value
 
     @property
-    def cavv_algorithm(self) -> str:
+    def cavv_algorithm(self) -> Optional[str]:
         """
-        | The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
-        | Note:
-        |   Required when
-        |   * The 3D Secure authentication for the transaction is managed by a third-party 3D Secure authentication provider
-        |   * You process the transaction through Atos
+        | The algorithm, from your 3D Secure provider, used to generate the authentication CAVV. Note: Required when
+        
+        * The 3D Secure authentication for the transaction is managed by a third-party 3D Secure authentication provider
+        * You process the transaction through Atos
 
         Type: str
         """
         return self.__cavv_algorithm
 
     @cavv_algorithm.setter
-    def cavv_algorithm(self, value: str):
+    def cavv_algorithm(self, value: Optional[str]) -> None:
         self.__cavv_algorithm = value
 
     @property
-    def directory_server_transaction_id(self) -> str:
+    def directory_server_transaction_id(self) -> Optional[str]:
         """
-        | The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
-        | Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
+        | The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
 
         Type: str
         """
         return self.__directory_server_transaction_id
 
     @directory_server_transaction_id.setter
-    def directory_server_transaction_id(self, value: str):
+    def directory_server_transaction_id(self, value: Optional[str]) -> None:
         self.__directory_server_transaction_id = value
 
     @property
-    def eci(self) -> int:
+    def eci(self) -> Optional[int]:
         """
         | Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION
-        | * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
-        | * 1 = Authentication attempted (MasterCard)
-        | * 2 = Successful authentication (MasterCard)
-        | * 5 = Successful authentication (Visa, Diners Club, Amex)
-        | * 6 = Authentication attempted (Visa, Diners Club, Amex)
-        | * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
-        | * (empty) = Not checked or not enrolled
+        
+        * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
+        * 1 = Authentication attempted (MasterCard)
+        * 2 = Successful authentication (MasterCard)
+        * 5 = Successful authentication (Visa, Diners Club, Amex)
+        * 6 = Authentication attempted (Visa, Diners Club, Amex)
+        * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
+        * (empty) = Not checked or not enrolled
 
         Type: int
         """
         return self.__eci
 
     @eci.setter
-    def eci(self, value: int):
+    def eci(self, value: Optional[int]) -> None:
         self.__eci = value
 
     @property
-    def flow(self) -> str:
+    def flow(self) -> Optional[str]:
         """
         | 3D Secure Flow used during this transaction.
 
@@ -123,11 +119,11 @@ class ExternalCardholderAuthenticationData(DataObject):
         return self.__flow
 
     @flow.setter
-    def flow(self, value: str):
+    def flow(self, value: Optional[str]) -> None:
         self.__flow = value
 
     @property
-    def scheme_risk_score(self) -> int:
+    def scheme_risk_score(self) -> Optional[int]:
         """
         | Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
 
@@ -136,29 +132,30 @@ class ExternalCardholderAuthenticationData(DataObject):
         return self.__scheme_risk_score
 
     @scheme_risk_score.setter
-    def scheme_risk_score(self, value: int):
+    def scheme_risk_score(self, value: Optional[int]) -> None:
         self.__scheme_risk_score = value
 
     @property
-    def three_d_secure_version(self) -> str:
+    def three_d_secure_version(self) -> Optional[str]:
         """
         | The 3-D Secure version used for the authentication. Possible values:
-        | * v1
-        | * v2
-        | * 1.0.2
-        | * 2.1.0
-        | * 2.2.0
+        
+        * v1
+        * v2
+        * 1.0.2
+        * 2.1.0
+        * 2.2.0
 
         Type: str
         """
         return self.__three_d_secure_version
 
     @three_d_secure_version.setter
-    def three_d_secure_version(self, value: str):
+    def three_d_secure_version(self, value: Optional[str]) -> None:
         self.__three_d_secure_version = value
 
     @property
-    def xid(self) -> str:
+    def xid(self) -> Optional[str]:
         """
         | The transaction ID that is used for the 3D Authentication
 
@@ -167,10 +164,10 @@ class ExternalCardholderAuthenticationData(DataObject):
         return self.__xid
 
     @xid.setter
-    def xid(self, value: str):
+    def xid(self, value: Optional[str]) -> None:
         self.__xid = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(ExternalCardholderAuthenticationData, self).to_dictionary()
         if self.acs_transaction_id is not None:
             dictionary['acsTransactionId'] = self.acs_transaction_id
@@ -194,7 +191,7 @@ class ExternalCardholderAuthenticationData(DataObject):
             dictionary['xid'] = self.xid
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'ExternalCardholderAuthenticationData':
         super(ExternalCardholderAuthenticationData, self).from_dictionary(dictionary)
         if 'acsTransactionId' in dictionary:
             self.acs_transaction_id = dictionary['acsTransactionId']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/external_token_linked.py

@@ -1,17 +1,20 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class ExternalTokenLinked(DataObject):
-    __computed_token = None
-    __gts_computed_token = None
-    __generated_token = None
+
+    __computed_token: Optional[str] = None
+    __gts_computed_token: Optional[str] = None
+    __generated_token: Optional[str] = None
 
     @property
-    def computed_token(self) -> str:
+    def computed_token(self) -> Optional[str]:
         """
         | The computed token
 
@@ -20,24 +23,26 @@ class ExternalTokenLinked(DataObject):
         return self.__computed_token
 
     @computed_token.setter
-    def computed_token(self, value: str):
+    def computed_token(self, value: Optional[str]) -> None:
         self.__computed_token = value
 
     @property
-    def gts_computed_token(self) -> str:
+    def gts_computed_token(self) -> Optional[str]:
         """
         | Deprecated: Use the field ComputedToken instead.
 
         Type: str
+
+        Deprecated; Use the field ComputedToken instead.
         """
         return self.__gts_computed_token
 
     @gts_computed_token.setter
-    def gts_computed_token(self, value: str):
+    def gts_computed_token(self, value: Optional[str]) -> None:
         self.__gts_computed_token = value
 
     @property
-    def generated_token(self) -> str:
+    def generated_token(self) -> Optional[str]:
         """
         | The generated token
 
@@ -46,10 +51,10 @@ class ExternalTokenLinked(DataObject):
         return self.__generated_token
 
     @generated_token.setter
-    def generated_token(self, value: str):
+    def generated_token(self, value: Optional[str]) -> None:
         self.__generated_token = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(ExternalTokenLinked, self).to_dictionary()
         if self.computed_token is not None:
             dictionary['ComputedToken'] = self.computed_token
@@ -59,7 +64,7 @@ class ExternalTokenLinked(DataObject):
             dictionary['GeneratedToken'] = self.generated_token
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'ExternalTokenLinked':
         super(ExternalTokenLinked, self).from_dictionary(dictionary)
         if 'ComputedToken' in dictionary:
             self.computed_token = dictionary['ComputedToken']