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

fortisapi/models/terminal_timeouts.py

@@ -0,0 +1,304 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+class TerminalTimeouts(object):
+    """Implementation of the 'TerminalTimeouts' model.
+
+    The following options outlines some configurable timeout values that can be used
+    to customize the experience at the terminal for the cardholder.
+    >These timeouts are specific to Ingenico devices only.
+    >
+    >These timeouts are specific to Ingenico devices only.
+    >
+
+    Attributes:
+        card_entry_timeout (int): How long to wait for input from cardholder.
+            >Message on timeout: Card Entry Timeout >
+        device_terms_prompt_timeout (int): How long the terms will be displayed on
+            the device. >Message on timeout: Timeout waiting for Customer >
+        overall_timeout (int): How long to wait for response from
+            /v2/routertransactions endpoint. >Message on timeout: Overall Request
+            Timeout >
+        pin_entry_timeout (int): How long to wait for pin entry by cardholder.
+            >Message on timeout: Pin Entry Timeout >
+        signature_input_timeout (int): How long to wait for first "touch" to
+            signature. >Message on timeout: Signature Input Timeout >
+        signature_submit_timeout (int): How long to wait for signature to be
+            submitted. >Message on timeout: Signature Storage Timeout >
+        status_display_time (int): How long the approve/decline status message stays
+            on screen. >Message on timeout: N/A - Not actually a "timeout".  This is
+            a time to display the status on the screen. >
+        tip_cashback_timeout (int): How long to wait for input on a tip or cashback
+            screen. >Message on timeout: Tip/Cashback Timeout >
+        transaction_timeout (int): How long to wait for response from the processor.
+            >Message on timeout: Transaction Timeout >
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "card_entry_timeout": "card_entry_timeout",
+        "device_terms_prompt_timeout": "device_terms_prompt_timeout",
+        "overall_timeout": "overall_timeout",
+        "pin_entry_timeout": "pin_entry_timeout",
+        "signature_input_timeout": "signature_input_timeout",
+        "signature_submit_timeout": "signature_submit_timeout",
+        "status_display_time": "status_display_time",
+        "tip_cashback_timeout": "tip_cashback_timeout",
+        "transaction_timeout": "transaction_timeout",
+    }
+
+    _optionals = [
+        "card_entry_timeout",
+        "device_terms_prompt_timeout",
+        "overall_timeout",
+        "pin_entry_timeout",
+        "signature_input_timeout",
+        "signature_submit_timeout",
+        "status_display_time",
+        "tip_cashback_timeout",
+        "transaction_timeout",
+    ]
+
+    _nullables = [
+        "card_entry_timeout",
+        "device_terms_prompt_timeout",
+        "overall_timeout",
+        "pin_entry_timeout",
+        "signature_input_timeout",
+        "signature_submit_timeout",
+        "status_display_time",
+        "tip_cashback_timeout",
+        "transaction_timeout",
+    ]
+
+    def __init__(
+        self,
+        card_entry_timeout=120,
+        device_terms_prompt_timeout=60,
+        overall_timeout=300,
+        pin_entry_timeout=30,
+        signature_input_timeout=10,
+        signature_submit_timeout=30,
+        status_display_time=7,
+        tip_cashback_timeout=30,
+        transaction_timeout=10,
+        additional_properties=None):
+        """Initialize a TerminalTimeouts instance."""
+        # Initialize members of the class
+        self.card_entry_timeout = card_entry_timeout
+        self.device_terms_prompt_timeout = device_terms_prompt_timeout
+        self.overall_timeout = overall_timeout
+        self.pin_entry_timeout = pin_entry_timeout
+        self.signature_input_timeout = signature_input_timeout
+        self.signature_submit_timeout = signature_submit_timeout
+        self.status_display_time = status_display_time
+        self.tip_cashback_timeout = tip_cashback_timeout
+        self.transaction_timeout = transaction_timeout
+
+        # 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
+        card_entry_timeout =\
+            dictionary.get("card_entry_timeout")\
+            if dictionary.get("card_entry_timeout")\
+                else 120
+        device_terms_prompt_timeout =\
+            dictionary.get("device_terms_prompt_timeout")\
+            if dictionary.get("device_terms_prompt_timeout")\
+                else 60
+        overall_timeout =\
+            dictionary.get("overall_timeout")\
+            if dictionary.get("overall_timeout")\
+                else 300
+        pin_entry_timeout =\
+            dictionary.get("pin_entry_timeout")\
+            if dictionary.get("pin_entry_timeout")\
+                else 30
+        signature_input_timeout =\
+            dictionary.get("signature_input_timeout")\
+            if dictionary.get("signature_input_timeout")\
+                else 10
+        signature_submit_timeout =\
+            dictionary.get("signature_submit_timeout")\
+            if dictionary.get("signature_submit_timeout")\
+                else 30
+        status_display_time =\
+            dictionary.get("status_display_time")\
+            if dictionary.get("status_display_time")\
+                else 7
+        tip_cashback_timeout =\
+            dictionary.get("tip_cashback_timeout")\
+            if dictionary.get("tip_cashback_timeout")\
+                else 30
+        transaction_timeout =\
+            dictionary.get("transaction_timeout")\
+            if dictionary.get("transaction_timeout")\
+                else 10
+
+        # 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(card_entry_timeout,
+                   device_terms_prompt_timeout,
+                   overall_timeout,
+                   pin_entry_timeout,
+                   signature_input_timeout,
+                   signature_submit_timeout,
+                   status_display_time,
+                   tip_cashback_timeout,
+                   transaction_timeout,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _card_entry_timeout=(
+            self.card_entry_timeout
+            if hasattr(self, "card_entry_timeout")
+            else None
+        )
+        _device_terms_prompt_timeout=(
+            self.device_terms_prompt_timeout
+            if hasattr(self, "device_terms_prompt_timeout")
+            else None
+        )
+        _overall_timeout=(
+            self.overall_timeout
+            if hasattr(self, "overall_timeout")
+            else None
+        )
+        _pin_entry_timeout=(
+            self.pin_entry_timeout
+            if hasattr(self, "pin_entry_timeout")
+            else None
+        )
+        _signature_input_timeout=(
+            self.signature_input_timeout
+            if hasattr(self, "signature_input_timeout")
+            else None
+        )
+        _signature_submit_timeout=(
+            self.signature_submit_timeout
+            if hasattr(self, "signature_submit_timeout")
+            else None
+        )
+        _status_display_time=(
+            self.status_display_time
+            if hasattr(self, "status_display_time")
+            else None
+        )
+        _tip_cashback_timeout=(
+            self.tip_cashback_timeout
+            if hasattr(self, "tip_cashback_timeout")
+            else None
+        )
+        _transaction_timeout=(
+            self.transaction_timeout
+            if hasattr(self, "transaction_timeout")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"card_entry_timeout={_card_entry_timeout!r}, "
+            f"device_terms_prompt_timeout={_device_terms_prompt_timeout!r}, "
+            f"overall_timeout={_overall_timeout!r}, "
+            f"pin_entry_timeout={_pin_entry_timeout!r}, "
+            f"signature_input_timeout={_signature_input_timeout!r}, "
+            f"signature_submit_timeout={_signature_submit_timeout!r}, "
+            f"status_display_time={_status_display_time!r}, "
+            f"tip_cashback_timeout={_tip_cashback_timeout!r}, "
+            f"transaction_timeout={_transaction_timeout!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _card_entry_timeout=(
+            self.card_entry_timeout
+            if hasattr(self, "card_entry_timeout")
+            else None
+        )
+        _device_terms_prompt_timeout=(
+            self.device_terms_prompt_timeout
+            if hasattr(self, "device_terms_prompt_timeout")
+            else None
+        )
+        _overall_timeout=(
+            self.overall_timeout
+            if hasattr(self, "overall_timeout")
+            else None
+        )
+        _pin_entry_timeout=(
+            self.pin_entry_timeout
+            if hasattr(self, "pin_entry_timeout")
+            else None
+        )
+        _signature_input_timeout=(
+            self.signature_input_timeout
+            if hasattr(self, "signature_input_timeout")
+            else None
+        )
+        _signature_submit_timeout=(
+            self.signature_submit_timeout
+            if hasattr(self, "signature_submit_timeout")
+            else None
+        )
+        _status_display_time=(
+            self.status_display_time
+            if hasattr(self, "status_display_time")
+            else None
+        )
+        _tip_cashback_timeout=(
+            self.tip_cashback_timeout
+            if hasattr(self, "tip_cashback_timeout")
+            else None
+        )
+        _transaction_timeout=(
+            self.transaction_timeout
+            if hasattr(self, "transaction_timeout")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"card_entry_timeout={_card_entry_timeout!s}, "
+            f"device_terms_prompt_timeout={_device_terms_prompt_timeout!s}, "
+            f"overall_timeout={_overall_timeout!s}, "
+            f"pin_entry_timeout={_pin_entry_timeout!s}, "
+            f"signature_input_timeout={_signature_input_timeout!s}, "
+            f"signature_submit_timeout={_signature_submit_timeout!s}, "
+            f"status_display_time={_status_display_time!s}, "
+            f"tip_cashback_timeout={_tip_cashback_timeout!s}, "
+            f"transaction_timeout={_transaction_timeout!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/terminal_timeouts_12.py

@@ -0,0 +1,314 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class TerminalTimeouts12(object):
+    """Implementation of the 'TerminalTimeouts12' model.
+
+    The following options outlines some configurable timeout values that can be used
+    to customize the experience at the terminal for the cardholder.
+    >These timeouts are specific to Ingenico devices only.
+    >
+
+    Attributes:
+        card_entry_timeout (int): How long to wait for input from cardholder.
+            >Message on timeout: Card Entry Timeout >
+        device_terms_prompt_timeout (int): How long the terms will be displayed on
+            the device. >Message on timeout: Timeout waiting for Customer >
+        overall_timeout (int): How long to wait for response from
+            /v2/routertransactions endpoint. >Message on timeout: Overall Request
+            Timeout >
+        pin_entry_timeout (int): How long to wait for pin entry by cardholder.
+            >Message on timeout: Pin Entry Timeout >
+        signature_input_timeout (int): How long to wait for first "touch" to
+            signature. >Message on timeout: Signature Input Timeout >
+        signature_submit_timeout (int): How long to wait for signature to be
+            submitted. >Message on timeout: Signature Storage Timeout >
+        status_display_time (int): How long the approve/decline status message stays
+            on screen. >Message on timeout: N/A - Not actually a "timeout".  This is
+            a time to display the status on the screen. >
+        tip_cashback_timeout (int): How long to wait for input on a tip or cashback
+            screen. >Message on timeout: Tip/Cashback Timeout >
+        transaction_timeout (int): How long to wait for response from the processor.
+            >Message on timeout: Transaction Timeout >
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "card_entry_timeout": "card_entry_timeout",
+        "device_terms_prompt_timeout": "device_terms_prompt_timeout",
+        "overall_timeout": "overall_timeout",
+        "pin_entry_timeout": "pin_entry_timeout",
+        "signature_input_timeout": "signature_input_timeout",
+        "signature_submit_timeout": "signature_submit_timeout",
+        "status_display_time": "status_display_time",
+        "tip_cashback_timeout": "tip_cashback_timeout",
+        "transaction_timeout": "transaction_timeout",
+    }
+
+    _optionals = [
+        "card_entry_timeout",
+        "device_terms_prompt_timeout",
+        "overall_timeout",
+        "pin_entry_timeout",
+        "signature_input_timeout",
+        "signature_submit_timeout",
+        "status_display_time",
+        "tip_cashback_timeout",
+        "transaction_timeout",
+    ]
+
+    _nullables = [
+        "card_entry_timeout",
+        "device_terms_prompt_timeout",
+        "overall_timeout",
+        "pin_entry_timeout",
+        "signature_input_timeout",
+        "signature_submit_timeout",
+        "status_display_time",
+        "tip_cashback_timeout",
+        "transaction_timeout",
+    ]
+
+    def __init__(
+        self,
+        card_entry_timeout=APIHelper.SKIP,
+        device_terms_prompt_timeout=APIHelper.SKIP,
+        overall_timeout=APIHelper.SKIP,
+        pin_entry_timeout=APIHelper.SKIP,
+        signature_input_timeout=APIHelper.SKIP,
+        signature_submit_timeout=APIHelper.SKIP,
+        status_display_time=APIHelper.SKIP,
+        tip_cashback_timeout=APIHelper.SKIP,
+        transaction_timeout=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a TerminalTimeouts12 instance."""
+        # Initialize members of the class
+        if card_entry_timeout is not APIHelper.SKIP:
+            self.card_entry_timeout = card_entry_timeout
+        if device_terms_prompt_timeout is not APIHelper.SKIP:
+            self.device_terms_prompt_timeout = device_terms_prompt_timeout
+        if overall_timeout is not APIHelper.SKIP:
+            self.overall_timeout = overall_timeout
+        if pin_entry_timeout is not APIHelper.SKIP:
+            self.pin_entry_timeout = pin_entry_timeout
+        if signature_input_timeout is not APIHelper.SKIP:
+            self.signature_input_timeout = signature_input_timeout
+        if signature_submit_timeout is not APIHelper.SKIP:
+            self.signature_submit_timeout = signature_submit_timeout
+        if status_display_time is not APIHelper.SKIP:
+            self.status_display_time = status_display_time
+        if tip_cashback_timeout is not APIHelper.SKIP:
+            self.tip_cashback_timeout = tip_cashback_timeout
+        if transaction_timeout is not APIHelper.SKIP:
+            self.transaction_timeout = transaction_timeout
+
+        # 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
+        card_entry_timeout =\
+            dictionary.get("card_entry_timeout")\
+            if "card_entry_timeout" in dictionary.keys()\
+                else APIHelper.SKIP
+        device_terms_prompt_timeout =\
+            dictionary.get("device_terms_prompt_timeout")\
+            if "device_terms_prompt_timeout" in dictionary.keys()\
+                else APIHelper.SKIP
+        overall_timeout =\
+            dictionary.get("overall_timeout")\
+            if "overall_timeout" in dictionary.keys()\
+                else APIHelper.SKIP
+        pin_entry_timeout =\
+            dictionary.get("pin_entry_timeout")\
+            if "pin_entry_timeout" in dictionary.keys()\
+                else APIHelper.SKIP
+        signature_input_timeout =\
+            dictionary.get("signature_input_timeout")\
+            if "signature_input_timeout" in dictionary.keys()\
+                else APIHelper.SKIP
+        signature_submit_timeout =\
+            dictionary.get("signature_submit_timeout")\
+            if "signature_submit_timeout" in dictionary.keys()\
+                else APIHelper.SKIP
+        status_display_time =\
+            dictionary.get("status_display_time")\
+            if "status_display_time" in dictionary.keys()\
+                else APIHelper.SKIP
+        tip_cashback_timeout =\
+            dictionary.get("tip_cashback_timeout")\
+            if "tip_cashback_timeout" in dictionary.keys()\
+                else APIHelper.SKIP
+        transaction_timeout =\
+            dictionary.get("transaction_timeout")\
+            if "transaction_timeout" in dictionary.keys()\
+                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(card_entry_timeout,
+                   device_terms_prompt_timeout,
+                   overall_timeout,
+                   pin_entry_timeout,
+                   signature_input_timeout,
+                   signature_submit_timeout,
+                   status_display_time,
+                   tip_cashback_timeout,
+                   transaction_timeout,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _card_entry_timeout=(
+            self.card_entry_timeout
+            if hasattr(self, "card_entry_timeout")
+            else None
+        )
+        _device_terms_prompt_timeout=(
+            self.device_terms_prompt_timeout
+            if hasattr(self, "device_terms_prompt_timeout")
+            else None
+        )
+        _overall_timeout=(
+            self.overall_timeout
+            if hasattr(self, "overall_timeout")
+            else None
+        )
+        _pin_entry_timeout=(
+            self.pin_entry_timeout
+            if hasattr(self, "pin_entry_timeout")
+            else None
+        )
+        _signature_input_timeout=(
+            self.signature_input_timeout
+            if hasattr(self, "signature_input_timeout")
+            else None
+        )
+        _signature_submit_timeout=(
+            self.signature_submit_timeout
+            if hasattr(self, "signature_submit_timeout")
+            else None
+        )
+        _status_display_time=(
+            self.status_display_time
+            if hasattr(self, "status_display_time")
+            else None
+        )
+        _tip_cashback_timeout=(
+            self.tip_cashback_timeout
+            if hasattr(self, "tip_cashback_timeout")
+            else None
+        )
+        _transaction_timeout=(
+            self.transaction_timeout
+            if hasattr(self, "transaction_timeout")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"card_entry_timeout={_card_entry_timeout!r}, "
+            f"device_terms_prompt_timeout={_device_terms_prompt_timeout!r}, "
+            f"overall_timeout={_overall_timeout!r}, "
+            f"pin_entry_timeout={_pin_entry_timeout!r}, "
+            f"signature_input_timeout={_signature_input_timeout!r}, "
+            f"signature_submit_timeout={_signature_submit_timeout!r}, "
+            f"status_display_time={_status_display_time!r}, "
+            f"tip_cashback_timeout={_tip_cashback_timeout!r}, "
+            f"transaction_timeout={_transaction_timeout!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _card_entry_timeout=(
+            self.card_entry_timeout
+            if hasattr(self, "card_entry_timeout")
+            else None
+        )
+        _device_terms_prompt_timeout=(
+            self.device_terms_prompt_timeout
+            if hasattr(self, "device_terms_prompt_timeout")
+            else None
+        )
+        _overall_timeout=(
+            self.overall_timeout
+            if hasattr(self, "overall_timeout")
+            else None
+        )
+        _pin_entry_timeout=(
+            self.pin_entry_timeout
+            if hasattr(self, "pin_entry_timeout")
+            else None
+        )
+        _signature_input_timeout=(
+            self.signature_input_timeout
+            if hasattr(self, "signature_input_timeout")
+            else None
+        )
+        _signature_submit_timeout=(
+            self.signature_submit_timeout
+            if hasattr(self, "signature_submit_timeout")
+            else None
+        )
+        _status_display_time=(
+            self.status_display_time
+            if hasattr(self, "status_display_time")
+            else None
+        )
+        _tip_cashback_timeout=(
+            self.tip_cashback_timeout
+            if hasattr(self, "tip_cashback_timeout")
+            else None
+        )
+        _transaction_timeout=(
+            self.transaction_timeout
+            if hasattr(self, "transaction_timeout")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"card_entry_timeout={_card_entry_timeout!s}, "
+            f"device_terms_prompt_timeout={_device_terms_prompt_timeout!s}, "
+            f"overall_timeout={_overall_timeout!s}, "
+            f"pin_entry_timeout={_pin_entry_timeout!s}, "
+            f"signature_input_timeout={_signature_input_timeout!s}, "
+            f"signature_submit_timeout={_signature_submit_timeout!s}, "
+            f"status_display_time={_status_display_time!s}, "
+            f"tip_cashback_timeout={_tip_cashback_timeout!s}, "
+            f"transaction_timeout={_transaction_timeout!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )