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

fortisapi/models/header.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 Header(object):
+    """Implementation of the 'Header' model.
+
+    Header
+
+    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 Header 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/helppage.py

@@ -0,0 +1,270 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class Helppage(object):
+    """Implementation of the 'Helppage' model.
+
+    Attributes:
+        user_type_code (UserTypeCodeEnum): User Type
+        body (str): Body
+        title (str): Title
+        id (str): Help Page ID
+        created_ts (int): Created Time Stamp
+        modified_ts (int): Modified Time Stamp
+        created_user_id (str): User ID Created the register
+        modified_user_id (str): Last User ID that updated the register
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "user_type_code": "user_type_code",
+        "body": "body",
+        "title": "title",
+        "id": "id",
+        "created_ts": "created_ts",
+        "modified_ts": "modified_ts",
+        "created_user_id": "created_user_id",
+        "modified_user_id": "modified_user_id",
+    }
+
+    _optionals = [
+        "user_type_code",
+        "body",
+        "title",
+        "id",
+        "created_ts",
+        "modified_ts",
+        "created_user_id",
+        "modified_user_id",
+    ]
+
+    _nullables = [
+        "created_ts",
+        "modified_ts",
+        "created_user_id",
+        "modified_user_id",
+    ]
+
+    def __init__(
+        self,
+        user_type_code=APIHelper.SKIP,
+        body=APIHelper.SKIP,
+        title=APIHelper.SKIP,
+        id=APIHelper.SKIP,
+        created_ts=APIHelper.SKIP,
+        modified_ts=APIHelper.SKIP,
+        created_user_id=APIHelper.SKIP,
+        modified_user_id=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a Helppage instance."""
+        # Initialize members of the class
+        if user_type_code is not APIHelper.SKIP:
+            self.user_type_code = user_type_code
+        if body is not APIHelper.SKIP:
+            self.body = body
+        if title is not APIHelper.SKIP:
+            self.title = title
+        if id is not APIHelper.SKIP:
+            self.id = id
+        if created_ts is not APIHelper.SKIP:
+            self.created_ts = created_ts
+        if modified_ts is not APIHelper.SKIP:
+            self.modified_ts = modified_ts
+        if created_user_id is not APIHelper.SKIP:
+            self.created_user_id = created_user_id
+        if modified_user_id is not APIHelper.SKIP:
+            self.modified_user_id = modified_user_id
+
+        # 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
+        user_type_code =\
+            dictionary.get("user_type_code")\
+            if dictionary.get("user_type_code")\
+                else APIHelper.SKIP
+        body =\
+            dictionary.get("body")\
+            if dictionary.get("body")\
+                else APIHelper.SKIP
+        title =\
+            dictionary.get("title")\
+            if dictionary.get("title")\
+                else APIHelper.SKIP
+        id =\
+            dictionary.get("id")\
+            if dictionary.get("id")\
+                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
+        created_user_id =\
+            dictionary.get("created_user_id")\
+            if "created_user_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        modified_user_id =\
+            dictionary.get("modified_user_id")\
+            if "modified_user_id" 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(user_type_code,
+                   body,
+                   title,
+                   id,
+                   created_ts,
+                   modified_ts,
+                   created_user_id,
+                   modified_user_id,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _user_type_code=(
+            self.user_type_code
+            if hasattr(self, "user_type_code")
+            else None
+        )
+        _body=(
+            self.body
+            if hasattr(self, "body")
+            else None
+        )
+        _title=(
+            self.title
+            if hasattr(self, "title")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            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
+        )
+        _created_user_id=(
+            self.created_user_id
+            if hasattr(self, "created_user_id")
+            else None
+        )
+        _modified_user_id=(
+            self.modified_user_id
+            if hasattr(self, "modified_user_id")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"user_type_code={_user_type_code!r}, "
+            f"body={_body!r}, "
+            f"title={_title!r}, "
+            f"id={_id!r}, "
+            f"created_ts={_created_ts!r}, "
+            f"modified_ts={_modified_ts!r}, "
+            f"created_user_id={_created_user_id!r}, "
+            f"modified_user_id={_modified_user_id!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _user_type_code=(
+            self.user_type_code
+            if hasattr(self, "user_type_code")
+            else None
+        )
+        _body=(
+            self.body
+            if hasattr(self, "body")
+            else None
+        )
+        _title=(
+            self.title
+            if hasattr(self, "title")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            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
+        )
+        _created_user_id=(
+            self.created_user_id
+            if hasattr(self, "created_user_id")
+            else None
+        )
+        _modified_user_id=(
+            self.modified_user_id
+            if hasattr(self, "modified_user_id")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"user_type_code={_user_type_code!s}, "
+            f"body={_body!s}, "
+            f"title={_title!s}, "
+            f"id={_id!s}, "
+            f"created_ts={_created_ts!s}, "
+            f"modified_ts={_modified_ts!s}, "
+            f"created_user_id={_created_user_id!s}, "
+            f"modified_user_id={_modified_user_id!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/home_phone.py

@@ -0,0 +1,130 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class HomePhone(object):
+    """Implementation of the 'HomePhone' model.
+
+    The home phone provided by the Cardholder. Refer to ITU-E.164 for additional
+    information on format and length.
+    This field is required if available, unless market or regional mandate restricts
+    sending this information.
+
+    Attributes:
+        cc (str): Country Code of the phone
+        subscriber (str): Subscriber section of the number
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "cc": "cc",
+        "subscriber": "subscriber",
+    }
+
+    _optionals = [
+        "cc",
+        "subscriber",
+    ]
+
+    def __init__(
+        self,
+        cc=APIHelper.SKIP,
+        subscriber=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a HomePhone instance."""
+        # Initialize members of the class
+        if cc is not APIHelper.SKIP:
+            self.cc = cc
+        if subscriber is not APIHelper.SKIP:
+            self.subscriber = subscriber
+
+        # 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
+        cc =\
+            dictionary.get("cc")\
+            if dictionary.get("cc")\
+                else APIHelper.SKIP
+        subscriber =\
+            dictionary.get("subscriber")\
+            if dictionary.get("subscriber")\
+                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(cc,
+                   subscriber,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _cc=(
+            self.cc
+            if hasattr(self, "cc")
+            else None
+        )
+        _subscriber=(
+            self.subscriber
+            if hasattr(self, "subscriber")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"cc={_cc!r}, "
+            f"subscriber={_subscriber!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _cc=(
+            self.cc
+            if hasattr(self, "cc")
+            else None
+        )
+        _subscriber=(
+            self.subscriber
+            if hasattr(self, "subscriber")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"cc={_cc!s}, "
+            f"subscriber={_subscriber!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )