onlinepayments-sdk-python3 4.22.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/three_d_secure_results.py

@@ -1,31 +1,30 @@
 # -*- 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 ThreeDSecureResults(DataObject):
-    """
-    | 3D Secure results object
-    """
-
-    __acs_transaction_id = None
-    __applied_exemption = None
-    __authentication_status = None
-    __cavv = None
-    __challenge_indicator = None
-    __ds_transaction_id = None
-    __eci = None
-    __exemption_engine_flow = None
-    __flow = None
-    __liability = None
-    __scheme_eci = None
-    __version = None
-    __xid = None
+
+    __acs_transaction_id: Optional[str] = None
+    __applied_exemption: Optional[str] = None
+    __authentication_status: Optional[str] = None
+    __cavv: Optional[str] = None
+    __challenge_indicator: Optional[str] = None
+    __ds_transaction_id: Optional[str] = None
+    __eci: Optional[str] = None
+    __exemption_engine_flow: Optional[str] = None
+    __flow: Optional[str] = None
+    __liability: Optional[str] = None
+    __scheme_eci: Optional[str] = None
+    __version: Optional[str] = None
+    __xid: Optional[str] = None
 
     @property
-    def acs_transaction_id(self) -> str:
+    def acs_transaction_id(self) -> Optional[str]:
         """
         | Authenticated Transaction Identifier at the ACS/Issuer.
 
@@ -34,11 +33,11 @@ class ThreeDSecureResults(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 requested and applied in the authorization
 
@@ -47,31 +46,32 @@ class ThreeDSecureResults(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 authentication_status(self) -> str:
+    def authentication_status(self) -> Optional[str]:
         """
         | One-letter authentication status returned by DS. Possible values are:
-        | * Y - Authentication succeeded
-        | * A - Authentication attempted
-        | * I - Information only, liability shifted to the merchant
-        | * N - Authentication failed
-        | * R - Authentication rejected
-        | * U - Authentication unavailable
-        | * C - Authentication required
+        
+        * Y - Authentication succeeded
+        * A - Authentication attempted
+        * I - Information only, liability shifted to the merchant
+        * N - Authentication failed
+        * R - Authentication rejected
+        * U - Authentication unavailable
+        * C - Authentication required
 
         Type: str
         """
         return self.__authentication_status
 
     @authentication_status.setter
-    def authentication_status(self, value: str):
+    def authentication_status(self, value: Optional[str]) -> None:
         self.__authentication_status = value
 
     @property
-    def cavv(self) -> str:
+    def cavv(self) -> Optional[str]:
         """
         | Cardholder Authentication Verification Value. End-2-end reference generated by the Issuer to recognize that the authentication has taken place.
 
@@ -80,11 +80,11 @@ class ThreeDSecureResults(DataObject):
         return self.__cavv
 
     @cavv.setter
-    def cavv(self, value: str):
+    def cavv(self, value: Optional[str]) -> None:
         self.__cavv = value
 
     @property
-    def challenge_indicator(self) -> str:
+    def challenge_indicator(self) -> Optional[str]:
         """
         | Challenge Indicator used for this transaction. This value might differ from the one sent by the merchant if the card is not supporting it (3DS version 2.1 vs 3DS version 2.2).
 
@@ -93,11 +93,11 @@ class ThreeDSecureResults(DataObject):
         return self.__challenge_indicator
 
     @challenge_indicator.setter
-    def challenge_indicator(self, value: str):
+    def challenge_indicator(self, value: Optional[str]) -> None:
         self.__challenge_indicator = value
 
     @property
-    def ds_transaction_id(self) -> str:
+    def ds_transaction_id(self) -> Optional[str]:
         """
         | 3D Secure Directory Server Transaction Identifier used for this transaction.
 
@@ -106,11 +106,11 @@ class ThreeDSecureResults(DataObject):
         return self.__ds_transaction_id
 
     @ds_transaction_id.setter
-    def ds_transaction_id(self, value: str):
+    def ds_transaction_id(self, value: Optional[str]) -> None:
         self.__ds_transaction_id = value
 
     @property
-    def eci(self) -> str:
+    def eci(self) -> Optional[str]:
         """
         | Indicates Authentication validation results returned after AuthenticationValidation
 
@@ -119,11 +119,11 @@ class ThreeDSecureResults(DataObject):
         return self.__eci
 
     @eci.setter
-    def eci(self, value: str):
+    def eci(self, value: Optional[str]) -> None:
         self.__eci = value
 
     @property
-    def exemption_engine_flow(self) -> str:
+    def exemption_engine_flow(self) -> Optional[str]:
         """
         | Detailed description of the Exemption Engine outcomes
 
@@ -132,11 +132,11 @@ class ThreeDSecureResults(DataObject):
         return self.__exemption_engine_flow
 
     @exemption_engine_flow.setter
-    def exemption_engine_flow(self, value: str):
+    def exemption_engine_flow(self, value: Optional[str]) -> None:
         self.__exemption_engine_flow = value
 
     @property
-    def flow(self) -> str:
+    def flow(self) -> Optional[str]:
         """
         | 3D Secure Flow used during this transaction.
 
@@ -145,15 +145,16 @@ class ThreeDSecureResults(DataObject):
         return self.__flow
 
     @flow.setter
-    def flow(self, value: str):
+    def flow(self, value: Optional[str]) -> None:
         self.__flow = value
 
     @property
-    def liability(self) -> str:
+    def liability(self) -> Optional[str]:
         """
         | Determines the Fraud liability. Possible values are:
-        | * issuer - Fraud liability shifts to the issuer
-        | * merchant - Fraud liability with the merchant 
+        
+        * issuer - Fraud liability shifts to the issuer
+        * merchant - Fraud liability with the merchant
         
         | Note: When not filled in Fraud liability is not applicable for the current transaction.
 
@@ -162,11 +163,11 @@ class ThreeDSecureResults(DataObject):
         return self.__liability
 
     @liability.setter
-    def liability(self, value: str):
+    def liability(self, value: Optional[str]) -> None:
         self.__liability = value
 
     @property
-    def scheme_eci(self) -> str:
+    def scheme_eci(self) -> Optional[str]:
         """
         | 3D Secure ECI (Electronic Commerce Indicator) depending on the Scheme. Returned by DS.
 
@@ -175,11 +176,11 @@ class ThreeDSecureResults(DataObject):
         return self.__scheme_eci
 
     @scheme_eci.setter
-    def scheme_eci(self, value: str):
+    def scheme_eci(self, value: Optional[str]) -> None:
         self.__scheme_eci = value
 
     @property
-    def version(self) -> str:
+    def version(self) -> Optional[str]:
         """
         | 3D Secure Protocol version used during this transaction.
 
@@ -188,11 +189,11 @@ class ThreeDSecureResults(DataObject):
         return self.__version
 
     @version.setter
-    def version(self, value: str):
+    def version(self, value: Optional[str]) -> None:
         self.__version = value
 
     @property
-    def xid(self) -> str:
+    def xid(self) -> Optional[str]:
         """
         | Transaction ID for the Authentication
 
@@ -201,10 +202,10 @@ class ThreeDSecureResults(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(ThreeDSecureResults, self).to_dictionary()
         if self.acs_transaction_id is not None:
             dictionary['acsTransactionId'] = self.acs_transaction_id
@@ -234,7 +235,7 @@ class ThreeDSecureResults(DataObject):
             dictionary['xid'] = self.xid
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'ThreeDSecureResults':
         super(ThreeDSecureResults, self).from_dictionary(dictionary)
         if 'acsTransactionId' in dictionary:
             self.acs_transaction_id = dictionary['acsTransactionId']

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/token_card.py

@@ -1,21 +1,20 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.token_card_data import TokenCardData
+from typing import Optional
+
+from .data_object import DataObject
+from .token_card_data import TokenCardData
 
 
 class TokenCard(DataObject):
-    """
-    | Object containing card details
-    """
 
-    __alias = None
-    __data = None
+    __alias: Optional[str] = None
+    __data: Optional[TokenCardData] = None
 
     @property
-    def alias(self) -> str:
+    def alias(self) -> Optional[str]:
         """
         | An alias for the token. This can be used to visually represent the token.
 
@@ -24,21 +23,21 @@ class TokenCard(DataObject):
         return self.__alias
 
     @alias.setter
-    def alias(self, value: str):
+    def alias(self, value: Optional[str]) -> None:
         self.__alias = value
 
     @property
-    def data(self) -> TokenCardData:
+    def data(self) -> Optional[TokenCardData]:
         """
         Type: :class:`onlinepayments.sdk.domain.token_card_data.TokenCardData`
         """
         return self.__data
 
     @data.setter
-    def data(self, value: TokenCardData):
+    def data(self, value: Optional[TokenCardData]) -> None:
         self.__data = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(TokenCard, self).to_dictionary()
         if self.alias is not None:
             dictionary['alias'] = self.alias
@@ -46,7 +45,7 @@ class TokenCard(DataObject):
             dictionary['data'] = self.data.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'TokenCard':
         super(TokenCard, self).from_dictionary(dictionary)
         if 'alias' in dictionary:
             self.alias = dictionary['alias']

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/domain/token_card_data.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .card_without_cvv import CardWithoutCvv
+from .data_object import DataObject
+
+
+class TokenCardData(DataObject):
+
+    __card_without_cvv: Optional[CardWithoutCvv] = None
+    __cobrand_selection_indicator: Optional[str] = None
+
+    @property
+    def card_without_cvv(self) -> Optional[CardWithoutCvv]:
+        """
+        Type: :class:`onlinepayments.sdk.domain.card_without_cvv.CardWithoutCvv`
+        """
+        return self.__card_without_cvv
+
+    @card_without_cvv.setter
+    def card_without_cvv(self, value: Optional[CardWithoutCvv]) -> None:
+        self.__card_without_cvv = value
+
+    @property
+    def cobrand_selection_indicator(self) -> Optional[str]:
+        """
+        | For cobranded cards, this field indicates the brand selection method:
+        
+        * default - The holder implicitly accepted the default brand.
+        * alternative - The holder explicitly selected an alternative brand.
+        * notApplicable - The card is not cobranded.
+
+        Type: str
+        """
+        return self.__cobrand_selection_indicator
+
+    @cobrand_selection_indicator.setter
+    def cobrand_selection_indicator(self, value: Optional[str]) -> None:
+        self.__cobrand_selection_indicator = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(TokenCardData, self).to_dictionary()
+        if self.card_without_cvv is not None:
+            dictionary['cardWithoutCvv'] = self.card_without_cvv.to_dictionary()
+        if self.cobrand_selection_indicator is not None:
+            dictionary['cobrandSelectionIndicator'] = self.cobrand_selection_indicator
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'TokenCardData':
+        super(TokenCardData, self).from_dictionary(dictionary)
+        if 'cardWithoutCvv' in dictionary:
+            if not isinstance(dictionary['cardWithoutCvv'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['cardWithoutCvv']))
+            value = CardWithoutCvv()
+            self.card_without_cvv = value.from_dictionary(dictionary['cardWithoutCvv'])
+        if 'cobrandSelectionIndicator' in dictionary:
+            self.cobrand_selection_indicator = dictionary['cobrandSelectionIndicator']
+        return self

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/token_card_specific_input.py

@@ -1,20 +1,19 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.token_data import TokenData
+from typing import Optional
+
+from .data_object import DataObject
+from .token_data import TokenData
 
 
 class TokenCardSpecificInput(DataObject):
-    """
-    | Object containing the token details for a card
-    """
 
-    __data = None
+    __data: Optional[TokenData] = None
 
     @property
-    def data(self) -> TokenData:
+    def data(self) -> Optional[TokenData]:
         """
         | Object containing the token details for a card
 
@@ -23,16 +22,16 @@ class TokenCardSpecificInput(DataObject):
         return self.__data
 
     @data.setter
-    def data(self, value: TokenData):
+    def data(self, value: Optional[TokenData]) -> None:
         self.__data = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(TokenCardSpecificInput, self).to_dictionary()
         if self.data is not None:
             dictionary['data'] = self.data.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'TokenCardSpecificInput':
         super(TokenCardSpecificInput, self).from_dictionary(dictionary)
         if 'data' in dictionary:
             if not isinstance(dictionary['data'], dict):

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/domain/token_data.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .card import Card
+from .data_object import DataObject
+
+
+class TokenData(DataObject):
+
+    __card: Optional[Card] = None
+    __cobrand_selection_indicator: Optional[str] = None
+
+    @property
+    def card(self) -> Optional[Card]:
+        """
+        | Object containing card details
+
+        Type: :class:`onlinepayments.sdk.domain.card.Card`
+        """
+        return self.__card
+
+    @card.setter
+    def card(self, value: Optional[Card]) -> None:
+        self.__card = value
+
+    @property
+    def cobrand_selection_indicator(self) -> Optional[str]:
+        """
+        | For cobranded cards, this field indicates the brand selection method:
+        
+        * default - The holder implicitly accepted the default brand.
+        * alternative - The holder explicitly selected an alternative brand.
+        * notApplicable - The card is not cobranded.
+
+        Type: str
+        """
+        return self.__cobrand_selection_indicator
+
+    @cobrand_selection_indicator.setter
+    def cobrand_selection_indicator(self, value: Optional[str]) -> None:
+        self.__cobrand_selection_indicator = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(TokenData, self).to_dictionary()
+        if self.card is not None:
+            dictionary['card'] = self.card.to_dictionary()
+        if self.cobrand_selection_indicator is not None:
+            dictionary['cobrandSelectionIndicator'] = self.cobrand_selection_indicator
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'TokenData':
+        super(TokenData, self).from_dictionary(dictionary)
+        if 'card' in dictionary:
+            if not isinstance(dictionary['card'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['card']))
+            value = Card()
+            self.card = value.from_dictionary(dictionary['card'])
+        if 'cobrandSelectionIndicator' in dictionary:
+            self.cobrand_selection_indicator = dictionary['cobrandSelectionIndicator']
+        return self

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/token_e_wallet.py

@@ -1,45 +1,45 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.customer_token import CustomerToken
+from typing import Optional
+
+from .customer_token import CustomerToken
+from .data_object import DataObject
 
 
 class TokenEWallet(DataObject):
-    """
-    | Object containing eWallet details
-    """
 
-    __alias = None
-    __customer = None
+    __alias: Optional[str] = None
+    __customer: Optional[CustomerToken] = None
 
     @property
-    def alias(self) -> str:
+    def alias(self) -> Optional[str]:
         """
-        | Deprecated: This field is not used by any payment product
-        | An alias for the token. This can be used to visually represent the token.
+        | Deprecated: This field is not used by any payment product An alias for the token. This can be used to visually represent the token.
 
         Type: str
+
+        Deprecated; This field is not used by any payment product An alias for the token. This can be used to visually represent the token.
         """
         return self.__alias
 
     @alias.setter
-    def alias(self, value: str):
+    def alias(self, value: Optional[str]) -> None:
         self.__alias = value
 
     @property
-    def customer(self) -> CustomerToken:
+    def customer(self) -> Optional[CustomerToken]:
         """
         Type: :class:`onlinepayments.sdk.domain.customer_token.CustomerToken`
         """
         return self.__customer
 
     @customer.setter
-    def customer(self, value: CustomerToken):
+    def customer(self, value: Optional[CustomerToken]) -> None:
         self.__customer = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(TokenEWallet, self).to_dictionary()
         if self.alias is not None:
             dictionary['alias'] = self.alias
@@ -47,7 +47,7 @@ class TokenEWallet(DataObject):
             dictionary['customer'] = self.customer.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'TokenEWallet':
         super(TokenEWallet, self).from_dictionary(dictionary)
         if 'alias' in dictionary:
             self.alias = dictionary['alias']