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

fortisapi/models/identity_verification.py

@@ -0,0 +1,183 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class IdentityVerification(object):
+    """Implementation of the 'IdentityVerification' model.
+
+    Identity Verification
+
+    Attributes:
+        dl_state (str): Required for ACH transactions when Driver's License
+            Verification is enabled on the terminal.  Either dl_number + dl_state OR
+            customer_id will need to be passed in this scenario.
+        dl_number (str): Required for ACH transactions when Driver's License
+            Verification is enabled on the terminal.  Either dl_number + dl_state OR
+            customer_id will need to be passed in this scenario.
+        dob_year (str): Required for certain ACH transactions where Identity
+            Verification has been enabled for the terminal.  Either ssn4 or dob_year
+            will need to be passed in this scenario but NOT BOTH.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "dl_state": "dl_state",
+        "dl_number": "dl_number",
+        "dob_year": "dob_year",
+    }
+
+    _optionals = [
+        "dl_state",
+        "dl_number",
+        "dob_year",
+    ]
+
+    _nullables = [
+        "dl_state",
+        "dl_number",
+        "dob_year",
+    ]
+
+    def __init__(
+        self,
+        dl_state=APIHelper.SKIP,
+        dl_number=APIHelper.SKIP,
+        dob_year=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a IdentityVerification instance."""
+        # Initialize members of the class
+        if dl_state is not APIHelper.SKIP:
+            self.dl_state = dl_state
+        if dl_number is not APIHelper.SKIP:
+            self.dl_number = dl_number
+        if dob_year is not APIHelper.SKIP:
+            self.dob_year = dob_year
+
+        # 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
+        dl_state =\
+            dictionary.get("dl_state")\
+            if "dl_state" in dictionary.keys()\
+                else APIHelper.SKIP
+        dl_number =\
+            dictionary.get("dl_number")\
+            if "dl_number" in dictionary.keys()\
+                else APIHelper.SKIP
+        dob_year =\
+            dictionary.get("dob_year")\
+            if "dob_year" 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(dl_state,
+                   dl_number,
+                   dob_year,
+                   additional_properties)
+
+    @classmethod
+    def validate(cls, dictionary):
+        """Validate dictionary against class required properties
+
+        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:
+            boolean : if dictionary is valid contains required properties.
+
+        """
+        if isinstance(dictionary, cls):
+            return True
+
+        if not isinstance(dictionary, dict):
+            return False
+
+        return True
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _dl_state=(
+            self.dl_state
+            if hasattr(self, "dl_state")
+            else None
+        )
+        _dl_number=(
+            self.dl_number
+            if hasattr(self, "dl_number")
+            else None
+        )
+        _dob_year=(
+            self.dob_year
+            if hasattr(self, "dob_year")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"dl_state={_dl_state!r}, "
+            f"dl_number={_dl_number!r}, "
+            f"dob_year={_dob_year!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _dl_state=(
+            self.dl_state
+            if hasattr(self, "dl_state")
+            else None
+        )
+        _dl_number=(
+            self.dl_number
+            if hasattr(self, "dl_number")
+            else None
+        )
+        _dob_year=(
+            self.dob_year
+            if hasattr(self, "dob_year")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"dl_state={_dl_state!s}, "
+            f"dl_number={_dl_number!s}, "
+            f"dob_year={_dob_year!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/identity_verification_2.py

@@ -0,0 +1,183 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class IdentityVerification2(object):
+    """Implementation of the 'IdentityVerification2' model.
+
+    Identity verification
+
+    Attributes:
+        dl_state (str): Used for certain ACH transactions where Driver's License is
+            required by the terminal being used.
+        dl_number (str): Used for certain ACH transactions where Driver's License is
+            required by the terminal being used.
+        ssn_4 (str): The last four of the account_holder social security number.
+        dob_year (str): Used for certain ACH transactions where Identity Verification
+            is enabled on the terminal being used.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "dl_state": "dl_state",
+        "dl_number": "dl_number",
+        "ssn_4": "ssn4",
+        "dob_year": "dob_year",
+    }
+
+    _optionals = [
+        "dl_state",
+        "dl_number",
+        "ssn_4",
+        "dob_year",
+    ]
+
+    _nullables = [
+        "dl_state",
+        "dl_number",
+        "ssn_4",
+        "dob_year",
+    ]
+
+    def __init__(
+        self,
+        dl_state=APIHelper.SKIP,
+        dl_number=APIHelper.SKIP,
+        ssn_4=APIHelper.SKIP,
+        dob_year=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a IdentityVerification2 instance."""
+        # Initialize members of the class
+        if dl_state is not APIHelper.SKIP:
+            self.dl_state = dl_state
+        if dl_number is not APIHelper.SKIP:
+            self.dl_number = dl_number
+        if ssn_4 is not APIHelper.SKIP:
+            self.ssn_4 = ssn_4
+        if dob_year is not APIHelper.SKIP:
+            self.dob_year = dob_year
+
+        # 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
+        dl_state =\
+            dictionary.get("dl_state")\
+            if "dl_state" in dictionary.keys()\
+                else APIHelper.SKIP
+        dl_number =\
+            dictionary.get("dl_number")\
+            if "dl_number" in dictionary.keys()\
+                else APIHelper.SKIP
+        ssn_4 =\
+            dictionary.get("ssn4")\
+            if "ssn4" in dictionary.keys()\
+                else APIHelper.SKIP
+        dob_year =\
+            dictionary.get("dob_year")\
+            if "dob_year" 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(dl_state,
+                   dl_number,
+                   ssn_4,
+                   dob_year,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _dl_state=(
+            self.dl_state
+            if hasattr(self, "dl_state")
+            else None
+        )
+        _dl_number=(
+            self.dl_number
+            if hasattr(self, "dl_number")
+            else None
+        )
+        _ssn_4=(
+            self.ssn_4
+            if hasattr(self, "ssn_4")
+            else None
+        )
+        _dob_year=(
+            self.dob_year
+            if hasattr(self, "dob_year")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"dl_state={_dl_state!r}, "
+            f"dl_number={_dl_number!r}, "
+            f"ssn_4={_ssn_4!r}, "
+            f"dob_year={_dob_year!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _dl_state=(
+            self.dl_state
+            if hasattr(self, "dl_state")
+            else None
+        )
+        _dl_number=(
+            self.dl_number
+            if hasattr(self, "dl_number")
+            else None
+        )
+        _ssn_4=(
+            self.ssn_4
+            if hasattr(self, "ssn_4")
+            else None
+        )
+        _dob_year=(
+            self.dob_year
+            if hasattr(self, "dob_year")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"dl_state={_dl_state!s}, "
+            f"dl_number={_dl_number!s}, "
+            f"ssn_4={_ssn_4!s}, "
+            f"dob_year={_dob_year!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/identity_verification_27.py

@@ -0,0 +1,165 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class IdentityVerification27(object):
+    """Implementation of the 'IdentityVerification27' model.
+
+    Identity Verification
+
+    Attributes:
+        dl_state (str): Required for ACH transactions when Driver's License
+            Verification is enabled on the terminal.  Either dl_number + dl_state OR
+            customer_id will need to be passed in this scenario.
+        dl_number (str): Required for ACH transactions when Driver's License
+            Verification is enabled on the terminal.  Either dl_number + dl_state OR
+            customer_id will need to be passed in this scenario.
+        ssn_4 (str): For ACH transactions where Identity Verification is enabled for
+            terminal. Only ssn4 or dob_year should be passed. not both.
+        dob_year (str): Required for certain ACH transactions where Identity
+            Verification has been enabled for the terminal.  Either ssn4 or dob_year
+            will need to be passed in this scenario but NOT BOTH.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "dl_state": "dl_state",
+        "dl_number": "dl_number",
+        "ssn_4": "ssn4",
+        "dob_year": "dob_year",
+    }
+
+    _optionals = [
+        "ssn_4",
+        "dob_year",
+    ]
+
+    _nullables = [
+        "ssn_4",
+        "dob_year",
+    ]
+
+    def __init__(
+        self,
+        dl_state=None,
+        dl_number=None,
+        ssn_4=APIHelper.SKIP,
+        dob_year=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a IdentityVerification27 instance."""
+        # Initialize members of the class
+        self.dl_state = dl_state
+        self.dl_number = dl_number
+        if ssn_4 is not APIHelper.SKIP:
+            self.ssn_4 = ssn_4
+        if dob_year is not APIHelper.SKIP:
+            self.dob_year = dob_year
+
+        # 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
+        dl_state =\
+            dictionary.get("dl_state")\
+            if dictionary.get("dl_state")\
+                else None
+        dl_number =\
+            dictionary.get("dl_number")\
+            if dictionary.get("dl_number")\
+                else None
+        ssn_4 =\
+            dictionary.get("ssn4")\
+            if "ssn4" in dictionary.keys()\
+                else APIHelper.SKIP
+        dob_year =\
+            dictionary.get("dob_year")\
+            if "dob_year" 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(dl_state,
+                   dl_number,
+                   ssn_4,
+                   dob_year,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _dl_state=self.dl_state
+        _dl_number=self.dl_number
+        _ssn_4=(
+            self.ssn_4
+            if hasattr(self, "ssn_4")
+            else None
+        )
+        _dob_year=(
+            self.dob_year
+            if hasattr(self, "dob_year")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"dl_state={_dl_state!r}, "
+            f"dl_number={_dl_number!r}, "
+            f"ssn_4={_ssn_4!r}, "
+            f"dob_year={_dob_year!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _dl_state=self.dl_state
+        _dl_number=self.dl_number
+        _ssn_4=(
+            self.ssn_4
+            if hasattr(self, "ssn_4")
+            else None
+        )
+        _dob_year=(
+            self.dob_year
+            if hasattr(self, "dob_year")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"dl_state={_dl_state!s}, "
+            f"dl_number={_dl_number!s}, "
+            f"ssn_4={_ssn_4!s}, "
+            f"dob_year={_dob_year!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/idtype_enum.py

@@ -0,0 +1,47 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class IdtypeEnum(object):
+    """Implementation of the 'Idtype' enum.
+
+    Terminal Manufacturer ID Type
+
+    Attributes:
+        MAC: The enum member of type str.
+        SN: The enum member of type str.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    MAC = "mac"
+
+    SN = "sn"
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default

fortisapi/models/iias_ind_enum.py

@@ -0,0 +1,64 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class IiasIndEnum(object):
+    """Implementation of the 'IiasInd' enum.
+
+    Possible values are '0', '1','2'
+
+    Attributes:
+        ENUM_0: The enum member of type int.
+        ENUM_1: The enum member of type int.
+        ENUM_2: The enum member of type int.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    _all_values = [0, 1, 2]
+    ENUM_0 = 0
+
+    ENUM_1 = 1
+
+    ENUM_2 = 2
+
+    @classmethod
+    def validate(cls, value):
+        """Validate value contains in enum
+
+        Args:
+            value: the value to be validated
+
+        Returns:
+            boolean : if value is valid enum values.
+
+        """
+        return value in cls._all_values
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default

fortisapi/models/industry_type_enum.py

@@ -0,0 +1,59 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class IndustryTypeEnum(object):
+    """Implementation of the 'IndustryType' enum.
+
+    Industry Type
+
+    Attributes:
+        ECOMMERCE: The enum member of type str.
+        RESTAURANT: The enum member of type str.
+        LODGING: The enum member of type str.
+        MOTO: The enum member of type str.
+        RETAIL: The enum member of type str.
+        ENUM_RETAIL SELF SERVE: The enum member of type str.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    ECOMMERCE = "ecommerce"
+
+    RESTAURANT = "restaurant"
+
+    LODGING = "lodging"
+
+    MOTO = "moto"
+
+    RETAIL = "retail"
+
+    ENUM_RETAIL_SELF_SERVE = "retail self serve"
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default