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

fortisapi/models/filter_by.py

@@ -0,0 +1,171 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class FilterBy(object):
+    """Implementation of the 'filter_by' model.
+
+    Attributes:
+        key (str): Resource key to filter by
+        operator (Operator1Enum): Filter operand.  Please note `=` does not imply a
+            strict equality check.   Only time fields support the `<=` and `>=`
+            operators.
+        value (float | str | bool): Filter value.   For time fields, `value` must be
+            sent in Unix format: `946702799`
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "key": "key",
+        "operator": "operator",
+        "value": "value",
+    }
+
+    def __init__(
+        self,
+        key=None,
+        operator=None,
+        value=None,
+        additional_properties=None):
+        """Initialize a FilterBy instance."""
+        # Initialize members of the class
+        self.key = key
+        self.operator = operator
+        self.value = value
+
+        # 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.
+
+        """
+        from fortisapi.utilities.union_type_lookup import (
+            UnionTypeLookUp,
+        )
+
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        key =\
+            dictionary.get("key")\
+            if dictionary.get("key")\
+                else None
+        operator = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("FilterByOperator"),
+            dictionary.get("operator"),
+            False)\
+            if dictionary.get("operator") is not None\
+            else None
+        value = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("FilterByValue"),
+            dictionary.get("value"),
+            False)\
+            if dictionary.get("value") is not None\
+            else None
+
+        # 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(key,
+                   operator,
+                   value,
+                   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.
+
+        """
+        from fortisapi.utilities.union_type_lookup import (
+            UnionTypeLookUp,
+        )
+
+        if isinstance(dictionary, cls):
+            return APIHelper.is_valid_type(
+                    value=dictionary.key,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        str,
+                )) \
+                and (UnionTypeLookUp.get("FilterByOperator")
+                .validate(dictionary.operator).is_valid) \
+                and (UnionTypeLookUp.get("FilterByValue")
+                .validate(dictionary.value).is_valid)
+
+        if not isinstance(dictionary, dict):
+            return False
+
+        return APIHelper.is_valid_type(
+                value=dictionary.get("key"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    str,
+            )) \
+            and (UnionTypeLookUp.get("FilterByOperator")
+            .validate(dictionary.get("operator")).is_valid) \
+            and (UnionTypeLookUp.get("FilterByValue")
+            .validate(dictionary.get("value")).is_valid)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _key=self.key
+        _operator=self.operator
+        _value=self.value
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"key={_key!r}, "
+            f"operator={_operator!r}, "
+            f"value={_value!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _key=self.key
+        _operator=self.operator
+        _value=self.value
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"key={_key!s}, "
+            f"operator={_operator!s}, "
+            f"value={_value!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/footer.py

@@ -0,0 +1,134 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+from fortisapi.models.field_20 import Field20
+from fortisapi.models.settings import Settings
+
+
+class Footer(object):
+    """Implementation of the 'Footer' model.
+
+    Footer
+
+    Attributes:
+        settings (Settings): The model property of type Settings.
+        fields (List[Field20]): The model property of type List[Field20].
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "settings": "settings",
+        "fields": "fields",
+    }
+
+    _optionals = [
+        "settings",
+        "fields",
+    ]
+
+    def __init__(
+        self,
+        settings=APIHelper.SKIP,
+        fields=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a Footer instance."""
+        # Initialize members of the class
+        if settings is not APIHelper.SKIP:
+            self.settings = settings
+        if fields is not APIHelper.SKIP:
+            self.fields = fields
+
+        # 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
+        settings =\
+            Settings.from_dictionary(
+                dictionary.get("settings"))\
+                if "settings" in dictionary.keys()\
+                else APIHelper.SKIP
+        fields = None
+        if dictionary.get("fields") is not None:
+            fields = [
+                Field20.from_dictionary(x)
+                    for x in dictionary.get("fields")
+            ]
+        else:
+            fields = 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(settings,
+                   fields,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _settings=(
+            self.settings
+            if hasattr(self, "settings")
+            else None
+        )
+        _fields=(
+            self.fields
+            if hasattr(self, "fields")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"settings={_settings!r}, "
+            f"fields={_fields!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _settings=(
+            self.settings
+            if hasattr(self, "settings")
+            else None
+        )
+        _fields=(
+            self.fields
+            if hasattr(self, "fields")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"settings={_settings!s}, "
+            f"fields={_fields!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/forecast.py

@@ -0,0 +1,250 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class Forecast(object):
+    """Implementation of the 'Forecast' model.
+
+    Forecast Information on `expand`
+
+    Attributes:
+        id (str): ID
+        recurring_id (str): Recurring ID
+        recurring_type (float): Recurring Type
+        amount (float): Amount
+        month (str): Month
+        created_ts (int): Created Time Stamp
+        modified_ts (int): Modified Time Stamp
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "id": "id",
+        "recurring_id": "recurring_id",
+        "recurring_type": "recurring_type",
+        "amount": "amount",
+        "month": "month",
+        "created_ts": "created_ts",
+        "modified_ts": "modified_ts",
+    }
+
+    _optionals = [
+        "id",
+        "recurring_id",
+        "recurring_type",
+        "amount",
+        "month",
+        "created_ts",
+        "modified_ts",
+    ]
+
+    _nullables = [
+        "recurring_type",
+        "amount",
+        "month",
+        "created_ts",
+        "modified_ts",
+    ]
+
+    def __init__(
+        self,
+        id=APIHelper.SKIP,
+        recurring_id=APIHelper.SKIP,
+        recurring_type=APIHelper.SKIP,
+        amount=APIHelper.SKIP,
+        month=APIHelper.SKIP,
+        created_ts=APIHelper.SKIP,
+        modified_ts=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a Forecast instance."""
+        # Initialize members of the class
+        if id is not APIHelper.SKIP:
+            self.id = id
+        if recurring_id is not APIHelper.SKIP:
+            self.recurring_id = recurring_id
+        if recurring_type is not APIHelper.SKIP:
+            self.recurring_type = recurring_type
+        if amount is not APIHelper.SKIP:
+            self.amount = amount
+        if month is not APIHelper.SKIP:
+            self.month = month
+        if created_ts is not APIHelper.SKIP:
+            self.created_ts = created_ts
+        if modified_ts is not APIHelper.SKIP:
+            self.modified_ts = modified_ts
+
+        # 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
+        id =\
+            dictionary.get("id")\
+            if dictionary.get("id")\
+                else APIHelper.SKIP
+        recurring_id =\
+            dictionary.get("recurring_id")\
+            if dictionary.get("recurring_id")\
+                else APIHelper.SKIP
+        recurring_type =\
+            dictionary.get("recurring_type")\
+            if "recurring_type" in dictionary.keys()\
+                else APIHelper.SKIP
+        amount =\
+            dictionary.get("amount")\
+            if "amount" in dictionary.keys()\
+                else APIHelper.SKIP
+        month =\
+            dictionary.get("month")\
+            if "month" in dictionary.keys()\
+                else APIHelper.SKIP
+        created_ts =\
+            dictionary.get("created_ts")\
+            if "created_ts" in dictionary.keys()\
+                else APIHelper.SKIP
+        modified_ts =\
+            dictionary.get("modified_ts")\
+            if "modified_ts" 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(id,
+                   recurring_id,
+                   recurring_type,
+                   amount,
+                   month,
+                   created_ts,
+                   modified_ts,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _recurring_id=(
+            self.recurring_id
+            if hasattr(self, "recurring_id")
+            else None
+        )
+        _recurring_type=(
+            self.recurring_type
+            if hasattr(self, "recurring_type")
+            else None
+        )
+        _amount=(
+            self.amount
+            if hasattr(self, "amount")
+            else None
+        )
+        _month=(
+            self.month
+            if hasattr(self, "month")
+            else None
+        )
+        _created_ts=(
+            self.created_ts
+            if hasattr(self, "created_ts")
+            else None
+        )
+        _modified_ts=(
+            self.modified_ts
+            if hasattr(self, "modified_ts")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"id={_id!r}, "
+            f"recurring_id={_recurring_id!r}, "
+            f"recurring_type={_recurring_type!r}, "
+            f"amount={_amount!r}, "
+            f"month={_month!r}, "
+            f"created_ts={_created_ts!r}, "
+            f"modified_ts={_modified_ts!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _recurring_id=(
+            self.recurring_id
+            if hasattr(self, "recurring_id")
+            else None
+        )
+        _recurring_type=(
+            self.recurring_type
+            if hasattr(self, "recurring_type")
+            else None
+        )
+        _amount=(
+            self.amount
+            if hasattr(self, "amount")
+            else None
+        )
+        _month=(
+            self.month
+            if hasattr(self, "month")
+            else None
+        )
+        _created_ts=(
+            self.created_ts
+            if hasattr(self, "created_ts")
+            else None
+        )
+        _modified_ts=(
+            self.modified_ts
+            if hasattr(self, "modified_ts")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"id={_id!s}, "
+            f"recurring_id={_recurring_id!s}, "
+            f"recurring_type={_recurring_type!s}, "
+            f"amount={_amount!s}, "
+            f"month={_month!s}, "
+            f"created_ts={_created_ts!s}, "
+            f"modified_ts={_modified_ts!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/format_1_enum.py

@@ -0,0 +1,47 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class Format1Enum(object):
+    """Implementation of the '_format1' enum.
+
+    Reporting format, valid values: csv, tsv
+
+    Attributes:
+        CSV: The enum member of type str.
+        TSV: The enum member of type str.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    CSV = "csv"
+
+    TSV = "tsv"
+
+    @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/format_enum.py

@@ -0,0 +1,47 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class FormatEnum(object):
+    """Implementation of the 'Format' enum.
+
+    Options include: api-default
+
+    Attributes:
+        APIDEFAULT: The enum member of type str.
+        PARTNER: The enum member of type str.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    APIDEFAULT = "api-default"
+
+    PARTNER = "partner"
+
+    @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