fortis-python-sdk 1.0.0__py3-none-any.whl

fortisapi/models/data_12.py

@@ -0,0 +1,369 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class Data12(object):
+    """Implementation of the 'Data12' model.
+
+    Attributes:
+        three_ds_server_trans_id (str): Universally unique transaction identifier
+            assigned by the 3DS Server to identify a single transaction. It has the
+            same value as the corresponding received authentication request. This
+            value has 36 characters in a format defined in IETF RFC 4122.
+        acs_url (str): Fully qualified URL of the ACS in case the authentication
+            response message indicates that further Cardholder interaction is
+            required to complete the authentication.  This field is only present in
+            Browser flow.
+        transaction_status (TransactionStatusEnum): Indicates whether a transaction
+            qualifies as an authenticated transaction. >Y - Authentication / Account
+            verification successful > >N - Not authenticated / Account not verified;
+            Transaction denied > >U - Authentication / Account verification could not
+            be performed; technical or other problem > >C - In order to complete the
+            authentication, a challenge is required > >R - Authentication / Account
+            verification Rejected. Issuer is rejecting authentication/verification
+            and request that authorization not be attempted > >A - Attempts
+            processing performed; Not authenticated / verified, but a proof of
+            attempt authentication / verification is provided > >D - In order to
+            complete the authentication, a challenge is required. Decoupled
+            Authentication confirmed. (Only if the 3DS Server has initiated
+            authentication with EMV 3DS 2.2.0 version or greater) > >I -
+            Informational Only; 3DS Requestor challenge preference acknowledged.
+            (Only if the 3DS Server has initiated authentication with EMV 3DS 2.2.0
+            version or greater) >
+        authentication_value (str): Payment System-specific value provided as part of
+            the ACS registration for each supported DS. Authentication Value may be
+            used to provide proof of authentication.
+        eci (str): Payment System-specific value provided by the ACS to indicate the
+            results of the attempt to authenticate the Cardholder.
+        ds_trans_id (str): Universally unique transaction identifier assigned by the
+            DS to identify a single transaction.
+        acs_trans_id (str): Universally unique transaction identifier assigned by the
+            ACS to identify a single transaction.
+        message_version (str): Protocol version identifier This shall be the Protocol
+            Version Number of the specification utilised by the system creating this
+            message. The Message Version Number is set by the 3DS Server which
+            originates the protocol with the AReq message. The Message Version Number
+            does not change during a 3DS transaction.
+        acs_challenge_mandated (AcsChallengeMandatedEnum): Indication of whether a
+            challenge is required for the transaction to be authorised due to
+            local/regional mandates or other variable. >Y - Challenge is mandated >
+            >N - Challenge is not mandated >
+        purchase_date (str): Date and time of the purchase, converted into UTC. The
+            field is limited to 14 characters, formatted as YYYYMMDDHHMMSS.
+        base_64_encoded_challenge_request (str): Base64-encoded Challenge Request
+            object in case the authentication response message indicates that further
+            Cardholder interaction is required to complete the authentication.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "three_ds_server_trans_id": "three_ds_server_trans_id",
+        "acs_url": "acs_url",
+        "transaction_status": "transaction_status",
+        "authentication_value": "authentication_value",
+        "eci": "eci",
+        "ds_trans_id": "ds_trans_id",
+        "acs_trans_id": "acs_trans_id",
+        "message_version": "message_version",
+        "acs_challenge_mandated": "acs_challenge_mandated",
+        "purchase_date": "purchase_date",
+        "base_64_encoded_challenge_request": "base64_encoded_challenge_request",
+    }
+
+    _optionals = [
+        "three_ds_server_trans_id",
+        "acs_url",
+        "transaction_status",
+        "authentication_value",
+        "eci",
+        "ds_trans_id",
+        "acs_trans_id",
+        "message_version",
+        "acs_challenge_mandated",
+        "purchase_date",
+        "base_64_encoded_challenge_request",
+    ]
+
+    def __init__(
+        self,
+        three_ds_server_trans_id=APIHelper.SKIP,
+        acs_url=APIHelper.SKIP,
+        transaction_status=APIHelper.SKIP,
+        authentication_value=APIHelper.SKIP,
+        eci=APIHelper.SKIP,
+        ds_trans_id=APIHelper.SKIP,
+        acs_trans_id=APIHelper.SKIP,
+        message_version=APIHelper.SKIP,
+        acs_challenge_mandated=APIHelper.SKIP,
+        purchase_date=APIHelper.SKIP,
+        base_64_encoded_challenge_request=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a Data12 instance."""
+        # Initialize members of the class
+        if three_ds_server_trans_id is not APIHelper.SKIP:
+            self.three_ds_server_trans_id = three_ds_server_trans_id
+        if acs_url is not APIHelper.SKIP:
+            self.acs_url = acs_url
+        if transaction_status is not APIHelper.SKIP:
+            self.transaction_status = transaction_status
+        if authentication_value is not APIHelper.SKIP:
+            self.authentication_value = authentication_value
+        if eci is not APIHelper.SKIP:
+            self.eci = eci
+        if ds_trans_id is not APIHelper.SKIP:
+            self.ds_trans_id = ds_trans_id
+        if acs_trans_id is not APIHelper.SKIP:
+            self.acs_trans_id = acs_trans_id
+        if message_version is not APIHelper.SKIP:
+            self.message_version = message_version
+        if acs_challenge_mandated is not APIHelper.SKIP:
+            self.acs_challenge_mandated = acs_challenge_mandated
+        if purchase_date is not APIHelper.SKIP:
+            self.purchase_date = purchase_date
+        if base_64_encoded_challenge_request is not APIHelper.SKIP:
+            self.base_64_encoded_challenge_request =\
+                 base_64_encoded_challenge_request
+
+        # Add additional model properties to the instance
+        if additional_properties is None:
+            additional_properties = {}
+        self.additional_properties = additional_properties
+
+    @classmethod
+    def from_dictionary(cls,
+                        dictionary):
+        """Create an instance of this model from a dictionary
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object
+            as obtained from the deserialization of the server's response. The
+            keys MUST match property names in the API description.
+
+        Returns:
+            object: An instance of this structure class.
+
+        """
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        three_ds_server_trans_id =\
+            dictionary.get("three_ds_server_trans_id")\
+            if dictionary.get("three_ds_server_trans_id")\
+                else APIHelper.SKIP
+        acs_url =\
+            dictionary.get("acs_url")\
+            if dictionary.get("acs_url")\
+                else APIHelper.SKIP
+        transaction_status =\
+            dictionary.get("transaction_status")\
+            if dictionary.get("transaction_status")\
+                else APIHelper.SKIP
+        authentication_value =\
+            dictionary.get("authentication_value")\
+            if dictionary.get("authentication_value")\
+                else APIHelper.SKIP
+        eci =\
+            dictionary.get("eci")\
+            if dictionary.get("eci")\
+                else APIHelper.SKIP
+        ds_trans_id =\
+            dictionary.get("ds_trans_id")\
+            if dictionary.get("ds_trans_id")\
+                else APIHelper.SKIP
+        acs_trans_id =\
+            dictionary.get("acs_trans_id")\
+            if dictionary.get("acs_trans_id")\
+                else APIHelper.SKIP
+        message_version =\
+            dictionary.get("message_version")\
+            if dictionary.get("message_version")\
+                else APIHelper.SKIP
+        acs_challenge_mandated =\
+            dictionary.get("acs_challenge_mandated")\
+            if dictionary.get("acs_challenge_mandated")\
+                else APIHelper.SKIP
+        purchase_date =\
+            dictionary.get("purchase_date")\
+            if dictionary.get("purchase_date")\
+                else APIHelper.SKIP
+        base_64_encoded_challenge_request =\
+            dictionary.get("base64_encoded_challenge_request")\
+            if dictionary.get("base64_encoded_challenge_request")\
+                else APIHelper.SKIP
+
+        # Clean out expected properties from dictionary
+        additional_properties =\
+            {k: v for k, v in dictionary.items() if k not in cls._names.values()}
+
+        # Return an object of this model
+        return cls(three_ds_server_trans_id,
+                   acs_url,
+                   transaction_status,
+                   authentication_value,
+                   eci,
+                   ds_trans_id,
+                   acs_trans_id,
+                   message_version,
+                   acs_challenge_mandated,
+                   purchase_date,
+                   base_64_encoded_challenge_request,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _three_ds_server_trans_id=(
+            self.three_ds_server_trans_id
+            if hasattr(self, "three_ds_server_trans_id")
+            else None
+        )
+        _acs_url=(
+            self.acs_url
+            if hasattr(self, "acs_url")
+            else None
+        )
+        _transaction_status=(
+            self.transaction_status
+            if hasattr(self, "transaction_status")
+            else None
+        )
+        _authentication_value=(
+            self.authentication_value
+            if hasattr(self, "authentication_value")
+            else None
+        )
+        _eci=(
+            self.eci
+            if hasattr(self, "eci")
+            else None
+        )
+        _ds_trans_id=(
+            self.ds_trans_id
+            if hasattr(self, "ds_trans_id")
+            else None
+        )
+        _acs_trans_id=(
+            self.acs_trans_id
+            if hasattr(self, "acs_trans_id")
+            else None
+        )
+        _message_version=(
+            self.message_version
+            if hasattr(self, "message_version")
+            else None
+        )
+        _acs_challenge_mandated=(
+            self.acs_challenge_mandated
+            if hasattr(self, "acs_challenge_mandated")
+            else None
+        )
+        _purchase_date=(
+            self.purchase_date
+            if hasattr(self, "purchase_date")
+            else None
+        )
+        _base_64_encoded_challenge_request=(
+            self.base_64_encoded_challenge_request
+            if hasattr(self, "base_64_encoded_challenge_request")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"three_ds_server_trans_id={_three_ds_server_trans_id!r}, "
+            f"acs_url={_acs_url!r}, "
+            f"transaction_status={_transaction_status!r}, "
+            f"authentication_value={_authentication_value!r}, "
+            f"eci={_eci!r}, "
+            f"ds_trans_id={_ds_trans_id!r}, "
+            f"acs_trans_id={_acs_trans_id!r}, "
+            f"message_version={_message_version!r}, "
+            f"acs_challenge_mandated={_acs_challenge_mandated!r}, "
+            f"purchase_date={_purchase_date!r}, "
+            f"base_64_encoded_challenge_request={_base_64_encoded_challenge_request!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _three_ds_server_trans_id=(
+            self.three_ds_server_trans_id
+            if hasattr(self, "three_ds_server_trans_id")
+            else None
+        )
+        _acs_url=(
+            self.acs_url
+            if hasattr(self, "acs_url")
+            else None
+        )
+        _transaction_status=(
+            self.transaction_status
+            if hasattr(self, "transaction_status")
+            else None
+        )
+        _authentication_value=(
+            self.authentication_value
+            if hasattr(self, "authentication_value")
+            else None
+        )
+        _eci=(
+            self.eci
+            if hasattr(self, "eci")
+            else None
+        )
+        _ds_trans_id=(
+            self.ds_trans_id
+            if hasattr(self, "ds_trans_id")
+            else None
+        )
+        _acs_trans_id=(
+            self.acs_trans_id
+            if hasattr(self, "acs_trans_id")
+            else None
+        )
+        _message_version=(
+            self.message_version
+            if hasattr(self, "message_version")
+            else None
+        )
+        _acs_challenge_mandated=(
+            self.acs_challenge_mandated
+            if hasattr(self, "acs_challenge_mandated")
+            else None
+        )
+        _purchase_date=(
+            self.purchase_date
+            if hasattr(self, "purchase_date")
+            else None
+        )
+        _base_64_encoded_challenge_request=(
+            self.base_64_encoded_challenge_request
+            if hasattr(self, "base_64_encoded_challenge_request")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"three_ds_server_trans_id={_three_ds_server_trans_id!s}, "
+            f"acs_url={_acs_url!s}, "
+            f"transaction_status={_transaction_status!s}, "
+            f"authentication_value={_authentication_value!s}, "
+            f"eci={_eci!s}, "
+            f"ds_trans_id={_ds_trans_id!s}, "
+            f"acs_trans_id={_acs_trans_id!s}, "
+            f"message_version={_message_version!s}, "
+            f"acs_challenge_mandated={_acs_challenge_mandated!s}, "
+            f"purchase_date={_purchase_date!s}, "
+            f"base_64_encoded_challenge_request={_base_64_encoded_challenge_request!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/data_13.py

@@ -0,0 +1,263 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class Data13(object):
+    """Implementation of the 'Data13' model.
+
+    Attributes:
+        three_ds_server_trans_id (str): Universally unique transaction identifier
+            assigned by the 3DS Server to identify a single transaction.
+        transaction_status (str): Indicates whether a transaction qualifies as an
+            authenticated transaction.  "D" and "I" are also applicable if the 3DS
+            Server has initiated authentication with EMV 3DS 2.2.0 version or greater
+            >Y - Authentication / Account verification successful > >N - Not
+            authenticated / Account not verified; Transaction denied > >U -
+            Authentication / Account verification could not be performed; technical
+            or other problem > >C - In order to complete the authentication, a
+            challenge is required > >R - Authentication / Account verification
+            Rejected. Issuer is rejecting authentication/verification and request
+            that authorization not be attempted > >A - Attempts processing performed;
+            Not authenticated / verified, but a proof of attempt authentication /
+            verification is provided > >D - In order to complete the authentication,
+            a challenge is required. Decoupled Authentication confirmed > >I -
+            Informational Only; 3DS Requestor challenge preference acknowledged >
+        ds_trans_id (str): Universally unique transaction identifier assigned by the
+            DS to identify a single transaction.
+        acs_trans_id (str): Universally unique transaction identifier assigned by the
+            ACS to identify a single transaction.
+        message_version (str): Protocol version identifier This shall be the Protocol
+            Version Number of the specification utilised by the system creating this
+            message.  The Message Version Number is set by the 3DS Server which
+            originates the protocol with the AReq message. The Message Version Number
+            does not change during a 3DS transaction.
+        authentication_value (str): Payment System-specific value provided as part of
+            the ACS registration for each supported DS. Authentication Value may be
+            used to provide proof of authentication.
+        eci (str): Payment System-specific value provided by the ACS to indicate the
+            results of the attempt to authenticate the Cardholder.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "three_ds_server_trans_id": "three_ds_server_trans_id",
+        "transaction_status": "transaction_status",
+        "ds_trans_id": "ds_trans_id",
+        "acs_trans_id": "acs_trans_id",
+        "message_version": "message_version",
+        "authentication_value": "authentication_value",
+        "eci": "eci",
+    }
+
+    _optionals = [
+        "three_ds_server_trans_id",
+        "transaction_status",
+        "ds_trans_id",
+        "acs_trans_id",
+        "message_version",
+        "authentication_value",
+        "eci",
+    ]
+
+    def __init__(
+        self,
+        three_ds_server_trans_id=APIHelper.SKIP,
+        transaction_status=APIHelper.SKIP,
+        ds_trans_id=APIHelper.SKIP,
+        acs_trans_id=APIHelper.SKIP,
+        message_version=APIHelper.SKIP,
+        authentication_value=APIHelper.SKIP,
+        eci=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a Data13 instance."""
+        # Initialize members of the class
+        if three_ds_server_trans_id is not APIHelper.SKIP:
+            self.three_ds_server_trans_id = three_ds_server_trans_id
+        if transaction_status is not APIHelper.SKIP:
+            self.transaction_status = transaction_status
+        if ds_trans_id is not APIHelper.SKIP:
+            self.ds_trans_id = ds_trans_id
+        if acs_trans_id is not APIHelper.SKIP:
+            self.acs_trans_id = acs_trans_id
+        if message_version is not APIHelper.SKIP:
+            self.message_version = message_version
+        if authentication_value is not APIHelper.SKIP:
+            self.authentication_value = authentication_value
+        if eci is not APIHelper.SKIP:
+            self.eci = eci
+
+        # Add additional model properties to the instance
+        if additional_properties is None:
+            additional_properties = {}
+        self.additional_properties = additional_properties
+
+    @classmethod
+    def from_dictionary(cls,
+                        dictionary):
+        """Create an instance of this model from a dictionary
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object
+            as obtained from the deserialization of the server's response. The
+            keys MUST match property names in the API description.
+
+        Returns:
+            object: An instance of this structure class.
+
+        """
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        three_ds_server_trans_id =\
+            dictionary.get("three_ds_server_trans_id")\
+            if dictionary.get("three_ds_server_trans_id")\
+                else APIHelper.SKIP
+        transaction_status =\
+            dictionary.get("transaction_status")\
+            if dictionary.get("transaction_status")\
+                else APIHelper.SKIP
+        ds_trans_id =\
+            dictionary.get("ds_trans_id")\
+            if dictionary.get("ds_trans_id")\
+                else APIHelper.SKIP
+        acs_trans_id =\
+            dictionary.get("acs_trans_id")\
+            if dictionary.get("acs_trans_id")\
+                else APIHelper.SKIP
+        message_version =\
+            dictionary.get("message_version")\
+            if dictionary.get("message_version")\
+                else APIHelper.SKIP
+        authentication_value =\
+            dictionary.get("authentication_value")\
+            if dictionary.get("authentication_value")\
+                else APIHelper.SKIP
+        eci =\
+            dictionary.get("eci")\
+            if dictionary.get("eci")\
+                else APIHelper.SKIP
+
+        # Clean out expected properties from dictionary
+        additional_properties =\
+            {k: v for k, v in dictionary.items() if k not in cls._names.values()}
+
+        # Return an object of this model
+        return cls(three_ds_server_trans_id,
+                   transaction_status,
+                   ds_trans_id,
+                   acs_trans_id,
+                   message_version,
+                   authentication_value,
+                   eci,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _three_ds_server_trans_id=(
+            self.three_ds_server_trans_id
+            if hasattr(self, "three_ds_server_trans_id")
+            else None
+        )
+        _transaction_status=(
+            self.transaction_status
+            if hasattr(self, "transaction_status")
+            else None
+        )
+        _ds_trans_id=(
+            self.ds_trans_id
+            if hasattr(self, "ds_trans_id")
+            else None
+        )
+        _acs_trans_id=(
+            self.acs_trans_id
+            if hasattr(self, "acs_trans_id")
+            else None
+        )
+        _message_version=(
+            self.message_version
+            if hasattr(self, "message_version")
+            else None
+        )
+        _authentication_value=(
+            self.authentication_value
+            if hasattr(self, "authentication_value")
+            else None
+        )
+        _eci=(
+            self.eci
+            if hasattr(self, "eci")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"three_ds_server_trans_id={_three_ds_server_trans_id!r}, "
+            f"transaction_status={_transaction_status!r}, "
+            f"ds_trans_id={_ds_trans_id!r}, "
+            f"acs_trans_id={_acs_trans_id!r}, "
+            f"message_version={_message_version!r}, "
+            f"authentication_value={_authentication_value!r}, "
+            f"eci={_eci!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _three_ds_server_trans_id=(
+            self.three_ds_server_trans_id
+            if hasattr(self, "three_ds_server_trans_id")
+            else None
+        )
+        _transaction_status=(
+            self.transaction_status
+            if hasattr(self, "transaction_status")
+            else None
+        )
+        _ds_trans_id=(
+            self.ds_trans_id
+            if hasattr(self, "ds_trans_id")
+            else None
+        )
+        _acs_trans_id=(
+            self.acs_trans_id
+            if hasattr(self, "acs_trans_id")
+            else None
+        )
+        _message_version=(
+            self.message_version
+            if hasattr(self, "message_version")
+            else None
+        )
+        _authentication_value=(
+            self.authentication_value
+            if hasattr(self, "authentication_value")
+            else None
+        )
+        _eci=(
+            self.eci
+            if hasattr(self, "eci")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"three_ds_server_trans_id={_three_ds_server_trans_id!s}, "
+            f"transaction_status={_transaction_status!s}, "
+            f"ds_trans_id={_ds_trans_id!s}, "
+            f"acs_trans_id={_acs_trans_id!s}, "
+            f"message_version={_message_version!s}, "
+            f"authentication_value={_authentication_value!s}, "
+            f"eci={_eci!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )