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

fortisapi/http/auth/developer_id.py

@@ -0,0 +1,100 @@
+
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+import os
+
+from apimatic_core.authentication.header_auth import HeaderAuth
+
+
+class DeveloperId(HeaderAuth):
+    """
+    An authentication handler that applies `CustomHeaderAuthentication` to
+    outgoing requests. It constructs the required credential values and integrates
+    with the core authentication framework.
+    """
+
+    @property
+    def error_message(self):
+        """Return reason about the authentication failure."""
+        return "DeveloperId: developer_id is undefined."
+
+    def __init__(self, auth_model):
+        """
+        Initialize the authentication handler with credential data.
+
+        Args:
+            auth_model: The credentials object used to generate the authorization
+             header.
+
+        """
+        auth_params = {}
+        if auth_model is not None \
+                and auth_model.developer_id is not None:
+            auth_params["developer-id"] = auth_model.developer_id
+        super().__init__(auth_params=auth_params)
+
+
+class DeveloperIdCredentials:
+    """
+    A model for authentication credentials. Provides simple validation,
+    cloning support, and optional construction from environment variables.
+    Suitable as a pattern for other auth models.
+    """
+
+    @property
+    def developer_id(self):
+        """
+        Developer ID.
+        """
+        return self._developer_id
+
+    def __init__(self, developer_id):
+        """
+        Initialize the credentials.
+
+        Args:
+            developer_id: The developer_id property value to set.
+
+        Raises:
+            ValueError: If any required value is missing.
+
+        """
+        if developer_id is None:
+            raise ValueError("developer_id cannot be None")
+        self._developer_id = developer_id
+
+    def clone_with(self, developer_id=None):
+        """
+        Return a new instance with optional value overrides.
+
+        Args:
+            developer_id: The developer_id property value to set.
+
+        """
+        return DeveloperIdCredentials(developer_id or self.developer_id)
+
+    @classmethod
+    def from_environment(cls):
+        """
+        Create credentials from environment variables, if available.
+
+        Returns:
+            A credentials instance or ``None`` if values are missing.
+
+        """
+        developer_id = os.getenv(
+            "DEVELOPER_ID_DEVELOPER_ID",
+            None,
+        )
+
+        if (developer_id is None):
+            return None
+
+        return cls(
+            developer_id=developer_id,
+        )

fortisapi/http/auth/user_api_key.py

@@ -0,0 +1,100 @@
+
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+import os
+
+from apimatic_core.authentication.header_auth import HeaderAuth
+
+
+class UserApiKey(HeaderAuth):
+    """
+    An authentication handler that applies `CustomHeaderAuthentication` to
+    outgoing requests. It constructs the required credential values and integrates
+    with the core authentication framework.
+    """
+
+    @property
+    def error_message(self):
+        """Return reason about the authentication failure."""
+        return "UserApiKey: user_api_key is undefined."
+
+    def __init__(self, auth_model):
+        """
+        Initialize the authentication handler with credential data.
+
+        Args:
+            auth_model: The credentials object used to generate the authorization
+             header.
+
+        """
+        auth_params = {}
+        if auth_model is not None \
+                and auth_model.user_api_key is not None:
+            auth_params["user-api-key"] = auth_model.user_api_key
+        super().__init__(auth_params=auth_params)
+
+
+class UserApiKeyCredentials:
+    """
+    A model for authentication credentials. Provides simple validation,
+    cloning support, and optional construction from environment variables.
+    Suitable as a pattern for other auth models.
+    """
+
+    @property
+    def user_api_key(self):
+        """
+        User API Key.
+        """
+        return self._user_api_key
+
+    def __init__(self, user_api_key):
+        """
+        Initialize the credentials.
+
+        Args:
+            user_api_key: The user_api_key property value to set.
+
+        Raises:
+            ValueError: If any required value is missing.
+
+        """
+        if user_api_key is None:
+            raise ValueError("user_api_key cannot be None")
+        self._user_api_key = user_api_key
+
+    def clone_with(self, user_api_key=None):
+        """
+        Return a new instance with optional value overrides.
+
+        Args:
+            user_api_key: The user_api_key property value to set.
+
+        """
+        return UserApiKeyCredentials(user_api_key or self.user_api_key)
+
+    @classmethod
+    def from_environment(cls):
+        """
+        Create credentials from environment variables, if available.
+
+        Returns:
+            A credentials instance or ``None`` if values are missing.
+
+        """
+        user_api_key = os.getenv(
+            "USER_API_KEY_USER_API_KEY",
+            None,
+        )
+
+        if (user_api_key is None):
+            return None
+
+        return cls(
+            user_api_key=user_api_key,
+        )

fortisapi/http/auth/user_id.py

@@ -0,0 +1,100 @@
+
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+import os
+
+from apimatic_core.authentication.header_auth import HeaderAuth
+
+
+class UserId(HeaderAuth):
+    """
+    An authentication handler that applies `CustomHeaderAuthentication` to
+    outgoing requests. It constructs the required credential values and integrates
+    with the core authentication framework.
+    """
+
+    @property
+    def error_message(self):
+        """Return reason about the authentication failure."""
+        return "UserId: user_id is undefined."
+
+    def __init__(self, auth_model):
+        """
+        Initialize the authentication handler with credential data.
+
+        Args:
+            auth_model: The credentials object used to generate the authorization
+             header.
+
+        """
+        auth_params = {}
+        if auth_model is not None \
+                and auth_model.user_id is not None:
+            auth_params["user-id"] = auth_model.user_id
+        super().__init__(auth_params=auth_params)
+
+
+class UserIdCredentials:
+    """
+    A model for authentication credentials. Provides simple validation,
+    cloning support, and optional construction from environment variables.
+    Suitable as a pattern for other auth models.
+    """
+
+    @property
+    def user_id(self):
+        """
+        User ID.
+        """
+        return self._user_id
+
+    def __init__(self, user_id):
+        """
+        Initialize the credentials.
+
+        Args:
+            user_id: The user_id property value to set.
+
+        Raises:
+            ValueError: If any required value is missing.
+
+        """
+        if user_id is None:
+            raise ValueError("user_id cannot be None")
+        self._user_id = user_id
+
+    def clone_with(self, user_id=None):
+        """
+        Return a new instance with optional value overrides.
+
+        Args:
+            user_id: The user_id property value to set.
+
+        """
+        return UserIdCredentials(user_id or self.user_id)
+
+    @classmethod
+    def from_environment(cls):
+        """
+        Create credentials from environment variables, if available.
+
+        Returns:
+            A credentials instance or ``None`` if values are missing.
+
+        """
+        user_id = os.getenv(
+            "USER_ID_USER_ID",
+            None,
+        )
+
+        if (user_id is None):
+            return None
+
+        return cls(
+            user_id=user_id,
+        )

fortisapi/http/http_call_back.py

@@ -0,0 +1,20 @@
+
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core.http.http_callback import HttpCallBack as CoreHttpCallback
+
+
+class HttpCallBack(CoreHttpCallback):
+    """
+    An interface for the callback to be called before and after the
+    HTTP call for an endpoint is made.
+
+    This class should not be instantiated but should be used as a base class
+    for HttpCallBack classes.
+
+    """

fortisapi/http/http_client_provider.py

@@ -0,0 +1,23 @@
+"""
+ fortisapi
+
+ This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+from abc import ABC
+
+from apimatic_core_interfaces.client.http_client_provider import (
+    HttpClientProvider as CoreHttpClientProvider,
+)
+
+
+class HttpClientProvider(CoreHttpClientProvider, ABC):
+    """
+     Defines a contract for providing HTTP client configuration.
+
+     Classes implementing this interface are expected to supply a configured
+     HTTP session and timeout value that will be used by the SDK's internal
+     HTTP layer when making network requests.
+
+     This allows developers to inject their own custom HTTP clients while
+     maintaining compatibility with the SDK's request/response handling.
+    """

fortisapi/http/http_method_enum.py

@@ -0,0 +1,25 @@
+
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core_interfaces.types.http_method_enum import (
+    HttpMethodEnum as CoreHttpMethodEnum,
+)
+
+
+class HttpMethodEnum(CoreHttpMethodEnum):
+    """
+    Enumeration of an HTTP Method
+
+    Attributes:
+        GET: A GET Request
+        POST: A POST Request
+        PUT: A PUT Request
+        PATCH: A PATCH Request
+        DELETE: A DELETE Request
+
+    """

fortisapi/http/http_request.py

@@ -0,0 +1,55 @@
+
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core.http.request.http_request import HttpRequest as CoreHttpRequest
+
+
+class HttpRequest(CoreHttpRequest):
+    """
+    Represent an HTTP request to be sent to the server.
+
+    Encapsulates request details such as the HTTP method, target URL, headers,
+     query parameters, body parameters, and any files included with the request.
+
+    Attributes:
+        http_method: The HTTP method to use for the request.
+        query_url (str): The URL to which the request will be sent.
+        headers (dict[str, str] | None): Headers to include with the request.
+        query_parameters (dict[str, str] | None): Query parameters appended
+            to the request URL.
+        parameters (dict[str, str] | None): Form or body parameters sent
+            with the request.
+        files (dict | None): Files to be sent with the request.
+
+    """
+
+    def __init__(self,
+                 http_method,
+                 query_url,
+                 headers=None,
+                 query_parameters=None,
+                 parameters=None,
+                 files=None):
+        """
+        Initialize an HttpRequest instance.
+
+        Args:
+            http_method: The HTTP method to use for the request.
+            query_url: The URL to which the request will be sent.
+            headers: Headers to include with the request.
+            query_parameters: Query parameters appended to the request URL.
+            parameters: Form or body parameters sent with the request.
+            files: Files to be sent with the request.
+
+        """
+        super().__init__(http_method,
+                         query_url,
+                         headers,
+                         query_parameters,
+                         parameters,
+                         files)

fortisapi/http/http_response.py

@@ -0,0 +1,45 @@
+
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core.http.response.http_response import HttpResponse as CoreHttpResponse
+
+
+class HttpResponse(CoreHttpResponse):
+    """
+    Represent an HTTP response returned by the server.
+
+    Stores response metadata such as status code, reason phrase, headers, and
+     the raw response body, along with the originating request.
+
+    Attributes:
+        status_code (int): The HTTP status code returned by the server.
+        reason_phrase (str): The reason phrase associated with the status code.
+        headers (dict[str, str]): Response headers as key-value pairs.
+        text (str): The raw response body as a string.
+        request: The request object that resulted in this response.
+
+    """
+
+    def __init__(self,
+                 status_code,
+                 reason_phrase,
+                 headers,
+                 text,
+                 request):
+        """
+        Initialize an HttpResponse instance.
+
+        Args:
+            status_code: The HTTP status code returned by the server.
+            reason_phrase: The reason phrase associated with the status code.
+            headers: Response headers as key-value pairs.
+            text: The raw response body as a string.
+            request: The request object that resulted in this response.
+
+        """
+        super().__init__(status_code, reason_phrase, headers, text, request)

fortisapi/http/proxy_settings.py

@@ -0,0 +1,50 @@
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+import os
+from typing import Optional
+
+from apimatic_core.http.configurations.proxy_settings import (
+    ProxySettings as CoreProxySettings,
+)
+
+
+class ProxySettings(CoreProxySettings):
+    """A simple data model for configuring HTTP(S) proxy settings."""
+
+    @classmethod
+    def from_environment(cls) -> Optional["ProxySettings"]:
+        """
+        Create an instance of this class using environment-based configuration.
+
+        This method attempts to construct and return an instance using relevant
+        environment variables, if available. If the required configuration is
+        not present, it may return `None` to indicate that no valid instance
+        could be created.
+
+        Returns:
+            Optional[cls]: A configured instance of this class, or `None` if
+            configuration data is missing or invalid.
+
+        """
+        address = os.getenv("PROXY_ADDRESS", None)
+        if not address:
+            return None
+
+        port = os.getenv("PROXY_PORT", None)
+        if port is not None:
+            try:
+                port = int(port)
+            except (TypeError, ValueError):
+                port = None
+
+        return cls(
+            address=address,
+            port=port,
+            username=os.getenv("PROXY_USERNAME", None),
+            password=os.getenv("PROXY_PASSWORD", None),
+        )