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

fortisapi/models/owner.py

@@ -0,0 +1,322 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class Owner(object):
+    """Implementation of the 'Owner' model.
+
+    Array of merchant owners.
+
+    Attributes:
+        first_name (str): Owner's first name.
+        last_name (str): Owner's last name.
+        middle_name (str): Owner's middle name.
+        title (str): Owner's title.
+        date_of_birth (str): Owner's date of birth.
+        address_line_1 (str): Owner's street address.
+        address_line_2 (str): Line 2 of owner's address.
+        city (str): Owner's address city.
+        state_province (str): Owner's address state/province.
+        postal_code (str): Owner's address postal code.
+        country_code (str): Owner's address country.
+        ssn (str): Owner's full SSN.
+        ownership_percent (int): Owner's ownership percent.
+        phone_number (str): Owner's phone number.
+        email_address (str): Owner's email address.
+        is_controller (bool): Flag indicating whether this owner is the control
+            owner. Maximum of 1 owner can be marked as control.. >Flag indicating
+            whether this owner is the control owner. Maximum of 1 owner can be marked
+            as control. >
+        is_signer (bool): Flag indicating whether or not the owner is a signer for
+            the business. Maximum of 1 owner can be marked as signer. >Flag
+            indicating whether or not the owner is a signer for the business. Maximum
+            of 1 owner can be marked as signer.  >
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "first_name": "first_name",
+        "last_name": "last_name",
+        "title": "title",
+        "date_of_birth": "date_of_birth",
+        "address_line_1": "address_line_1",
+        "address_line_2": "address_line_2",
+        "city": "city",
+        "state_province": "state_province",
+        "postal_code": "postal_code",
+        "country_code": "country_code",
+        "ssn": "ssn",
+        "ownership_percent": "ownership_percent",
+        "phone_number": "phone_number",
+        "email_address": "email_address",
+        "is_controller": "is_controller",
+        "is_signer": "is_signer",
+        "middle_name": "middle_name",
+    }
+
+    _optionals = [
+        "middle_name",
+    ]
+
+    _nullables = [
+        "middle_name",
+    ]
+
+    def __init__(
+        self,
+        first_name=None,
+        last_name=None,
+        title=None,
+        date_of_birth=None,
+        address_line_1=None,
+        address_line_2=None,
+        city=None,
+        state_province=None,
+        postal_code=None,
+        country_code=None,
+        ssn=None,
+        ownership_percent=None,
+        phone_number=None,
+        email_address=None,
+        is_controller=None,
+        is_signer=None,
+        middle_name=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a Owner instance."""
+        # Initialize members of the class
+        self.first_name = first_name
+        self.last_name = last_name
+        if middle_name is not APIHelper.SKIP:
+            self.middle_name = middle_name
+        self.title = title
+        self.date_of_birth = date_of_birth
+        self.address_line_1 = address_line_1
+        self.address_line_2 = address_line_2
+        self.city = city
+        self.state_province = state_province
+        self.postal_code = postal_code
+        self.country_code = country_code
+        self.ssn = ssn
+        self.ownership_percent = ownership_percent
+        self.phone_number = phone_number
+        self.email_address = email_address
+        self.is_controller = is_controller
+        self.is_signer = is_signer
+
+        # 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
+        first_name =\
+            dictionary.get("first_name")\
+            if dictionary.get("first_name")\
+                else None
+        last_name =\
+            dictionary.get("last_name")\
+            if dictionary.get("last_name")\
+                else None
+        title =\
+            dictionary.get("title")\
+            if dictionary.get("title")\
+                else None
+        date_of_birth =\
+            dictionary.get("date_of_birth")\
+            if dictionary.get("date_of_birth")\
+                else None
+        address_line_1 =\
+            dictionary.get("address_line_1")\
+            if dictionary.get("address_line_1")\
+                else None
+        address_line_2 =\
+            dictionary.get("address_line_2")\
+            if dictionary.get("address_line_2")\
+                else None
+        city =\
+            dictionary.get("city")\
+            if dictionary.get("city")\
+                else None
+        state_province =\
+            dictionary.get("state_province")\
+            if dictionary.get("state_province")\
+                else None
+        postal_code =\
+            dictionary.get("postal_code")\
+            if dictionary.get("postal_code")\
+                else None
+        country_code =\
+            dictionary.get("country_code")\
+            if dictionary.get("country_code")\
+                else None
+        ssn =\
+            dictionary.get("ssn")\
+            if dictionary.get("ssn")\
+                else None
+        ownership_percent =\
+            dictionary.get("ownership_percent")\
+            if dictionary.get("ownership_percent")\
+                else None
+        phone_number =\
+            dictionary.get("phone_number")\
+            if dictionary.get("phone_number")\
+                else None
+        email_address =\
+            dictionary.get("email_address")\
+            if dictionary.get("email_address")\
+                else None
+        is_controller =\
+            dictionary.get("is_controller")\
+            if "is_controller" in dictionary.keys()\
+                else None
+        is_signer =\
+            dictionary.get("is_signer")\
+            if "is_signer" in dictionary.keys()\
+                else None
+        middle_name =\
+            dictionary.get("middle_name")\
+            if "middle_name" 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(first_name,
+                   last_name,
+                   title,
+                   date_of_birth,
+                   address_line_1,
+                   address_line_2,
+                   city,
+                   state_province,
+                   postal_code,
+                   country_code,
+                   ssn,
+                   ownership_percent,
+                   phone_number,
+                   email_address,
+                   is_controller,
+                   is_signer,
+                   middle_name,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _first_name=self.first_name
+        _last_name=self.last_name
+        _middle_name=(
+            self.middle_name
+            if hasattr(self, "middle_name")
+            else None
+        )
+        _title=self.title
+        _date_of_birth=self.date_of_birth
+        _address_line_1=self.address_line_1
+        _address_line_2=self.address_line_2
+        _city=self.city
+        _state_province=self.state_province
+        _postal_code=self.postal_code
+        _country_code=self.country_code
+        _ssn=self.ssn
+        _ownership_percent=self.ownership_percent
+        _phone_number=self.phone_number
+        _email_address=self.email_address
+        _is_controller=self.is_controller
+        _is_signer=self.is_signer
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"first_name={_first_name!r}, "
+            f"last_name={_last_name!r}, "
+            f"middle_name={_middle_name!r}, "
+            f"title={_title!r}, "
+            f"date_of_birth={_date_of_birth!r}, "
+            f"address_line_1={_address_line_1!r}, "
+            f"address_line_2={_address_line_2!r}, "
+            f"city={_city!r}, "
+            f"state_province={_state_province!r}, "
+            f"postal_code={_postal_code!r}, "
+            f"country_code={_country_code!r}, "
+            f"ssn={_ssn!r}, "
+            f"ownership_percent={_ownership_percent!r}, "
+            f"phone_number={_phone_number!r}, "
+            f"email_address={_email_address!r}, "
+            f"is_controller={_is_controller!r}, "
+            f"is_signer={_is_signer!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _first_name=self.first_name
+        _last_name=self.last_name
+        _middle_name=(
+            self.middle_name
+            if hasattr(self, "middle_name")
+            else None
+        )
+        _title=self.title
+        _date_of_birth=self.date_of_birth
+        _address_line_1=self.address_line_1
+        _address_line_2=self.address_line_2
+        _city=self.city
+        _state_province=self.state_province
+        _postal_code=self.postal_code
+        _country_code=self.country_code
+        _ssn=self.ssn
+        _ownership_percent=self.ownership_percent
+        _phone_number=self.phone_number
+        _email_address=self.email_address
+        _is_controller=self.is_controller
+        _is_signer=self.is_signer
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"first_name={_first_name!s}, "
+            f"last_name={_last_name!s}, "
+            f"middle_name={_middle_name!s}, "
+            f"title={_title!s}, "
+            f"date_of_birth={_date_of_birth!s}, "
+            f"address_line_1={_address_line_1!s}, "
+            f"address_line_2={_address_line_2!s}, "
+            f"city={_city!s}, "
+            f"state_province={_state_province!s}, "
+            f"postal_code={_postal_code!s}, "
+            f"country_code={_country_code!s}, "
+            f"ssn={_ssn!s}, "
+            f"ownership_percent={_ownership_percent!s}, "
+            f"phone_number={_phone_number!s}, "
+            f"email_address={_email_address!s}, "
+            f"is_controller={_is_controller!s}, "
+            f"is_signer={_is_signer!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/ownership_type_enum.py

@@ -0,0 +1,71 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class OwnershipTypeEnum(object):
+    """Implementation of the 'OwnershipType' enum.
+
+    The Ownership Type of the merchant's business.
+
+    Attributes:
+        C: The enum member of type str.
+        GOV: The enum member of type str.
+        LLC: The enum member of type str.
+        LLP: The enum member of type str.
+        NP: The enum member of type str.
+        P: The enum member of type str.
+        PO: The enum member of type str.
+        S: The enum member of type str.
+        SP: The enum member of type str.
+        TE: The enum member of type str.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    C = "c"
+
+    GOV = "gov"
+
+    LLC = "llc"
+
+    LLP = "llp"
+
+    NP = "np"
+
+    P = "p"
+
+    PO = "po"
+
+    S = "s"
+
+    SP = "sp"
+
+    TE = "te"
+
+    @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/page.py

@@ -0,0 +1,132 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class Page(object):
+    """Implementation of the 'page' model.
+
+    Use this field to specify paginate your results, by using page size and number.
+    You can use one of the following methods:
+    >/endpoint?page={ "number": 1, "size": 50 }
+    >
+    >/endpoint?page[number]=1&page[size]=50
+    >
+
+    Attributes:
+        number (int): The current page number of the page to be retrieved.
+        size (int): The maximum number of records ta will be returned per page.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "number": "number",
+        "size": "size",
+    }
+
+    _optionals = [
+        "number",
+        "size",
+    ]
+
+    def __init__(
+        self,
+        number=APIHelper.SKIP,
+        size=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a Page instance."""
+        # Initialize members of the class
+        if number is not APIHelper.SKIP:
+            self.number = number
+        if size is not APIHelper.SKIP:
+            self.size = size
+
+        # 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
+        number =\
+            dictionary.get("number")\
+            if dictionary.get("number")\
+                else APIHelper.SKIP
+        size =\
+            dictionary.get("size")\
+            if dictionary.get("size")\
+                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(number,
+                   size,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _number=(
+            self.number
+            if hasattr(self, "number")
+            else None
+        )
+        _size=(
+            self.size
+            if hasattr(self, "size")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"number={_number!r}, "
+            f"size={_size!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _number=(
+            self.number
+            if hasattr(self, "number")
+            else None
+        )
+        _size=(
+            self.size
+            if hasattr(self, "size")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"number={_number!s}, "
+            f"size={_size!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )