hfortix-fortios 0.5.0__py3-none-any.whl → 0.5.2__py3-none-any.whl

hfortix_fortios/__init__.py

@@ -64,7 +64,7 @@ from .client import FortiOS
 #     TrafficShaper,
 # )
 
-__version__ = "0.4.3"
+__version__ = "0.5.1"
 __all__ = [
     # Main client
     "FortiOS",

hfortix_fortios/__init__.pyi

@@ -0,0 +1,83 @@
+"""Type stubs for hfortix_fortios package."""
+
+from __future__ import annotations
+
+from hfortix_core import (
+    APIError as APIError,
+    AuthenticationError as AuthenticationError,
+    AuthorizationError as AuthorizationError,
+    BadRequestError as BadRequestError,
+    CircuitBreakerOpenError as CircuitBreakerOpenError,
+    ConfigurationError as ConfigurationError,
+    DebugSession as DebugSession,
+    DuplicateEntryError as DuplicateEntryError,
+    EntryInUseError as EntryInUseError,
+    FortinetError as FortinetError,
+    InvalidValueError as InvalidValueError,
+    MethodNotAllowedError as MethodNotAllowedError,
+    NonRetryableError as NonRetryableError,
+    OperationNotSupportedError as OperationNotSupportedError,
+    PermissionDeniedError as PermissionDeniedError,
+    RateLimitError as RateLimitError,
+    ReadOnlyModeError as ReadOnlyModeError,
+    ResourceNotFoundError as ResourceNotFoundError,
+    RetryableError as RetryableError,
+    ServerError as ServerError,
+    ServiceUnavailableError as ServiceUnavailableError,
+    TimeoutError as TimeoutError,
+    VDOMError as VDOMError,
+    debug_timer as debug_timer,
+    format_connection_stats as format_connection_stats,
+    format_request_info as format_request_info,
+    print_debug_info as print_debug_info,
+)
+from hfortix_fortios.client import FortiOS as FortiOS
+
+__version__: str
+
+__all__ = [
+    "FortiOS",
+    "configure_logging",
+    "DebugSession",
+    "debug_timer",
+    "format_connection_stats",
+    "format_request_info",
+    "print_debug_info",
+    "FortinetError",
+    "APIError",
+    "AuthenticationError",
+    "AuthorizationError",
+    "RetryableError",
+    "NonRetryableError",
+    "ConfigurationError",
+    "VDOMError",
+    "OperationNotSupportedError",
+    "ReadOnlyModeError",
+    "ResourceNotFoundError",
+    "PermissionDeniedError",
+    "MethodNotAllowedError",
+    "BadRequestError",
+    "DuplicateEntryError",
+    "EntryInUseError",
+    "InvalidValueError",
+    "RateLimitError",
+    "CircuitBreakerOpenError",
+    "ServerError",
+    "ServiceUnavailableError",
+    "TimeoutError",
+]
+
+def configure_logging(
+    level: str = "INFO",
+    format: str | None = None,
+    datefmt: str | None = None,
+) -> None:
+    """
+    Configure logging for hfortix_fortios package.
+    
+    Args:
+        level: Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+        format: Log message format string
+        datefmt: Date format string
+    """
+    ...

hfortix_fortios/api/__init__.pyi

@@ -0,0 +1,45 @@
+"""Type stubs for hfortix_fortios.api module."""
+
+from __future__ import annotations
+
+from hfortix_core.http.interface import IHTTPClient
+
+from .utils import Utils
+from .v2.cmdb import CMDB
+from .v2.log import Log
+from .v2.monitor import Monitor
+from .v2.service import Service
+
+__all__ = ["API"]
+
+class API:
+    """
+    FortiOS REST API v2 Interface.
+    
+    Provides type-safe access to all FortiOS API endpoints.
+    """
+    
+    cmdb: CMDB
+    """Configuration Management Database - CRUD operations on configuration objects."""
+    
+    monitor: Monitor
+    """Real-time monitoring and status data (read-only)."""
+    
+    log: Log
+    """Historical log retrieval (read-only)."""
+    
+    service: Service
+    """System services and operations."""
+    
+    utils: Utils
+    """Utility functions for testing and diagnostics."""
+    
+    def __init__(self, client: IHTTPClient, vdom: str | None = None) -> None:
+        """
+        Initialize API interface.
+        
+        Args:
+            client: HTTP client instance for API communication
+            vdom: Virtual domain name (optional)
+        """
+        ...

hfortix_fortios/api/v2/cmdb/__init__.pyi

@@ -7,6 +7,43 @@ from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from hfortix_core.http.interface import IHTTPClient
+    from . import alertemail
+    from . import antivirus
+    from . import application
+    from . import authentication
+    from . import automation
+    from . import casb
+    from . import certificate
+    from . import diameter_filter
+    from . import dlp
+    from . import dnsfilter
+    from . import emailfilter
+    from . import endpoint_control
+    from . import ethernet_oam
+    from . import extension_controller
+    from . import file_filter
+    from . import firewall
+    from . import ftp_proxy
+    from . import icap
+    from . import ips
+    from . import log
+    from . import monitoring
+    from . import report
+    from . import router
+    from . import rule
+    from . import sctp_filter
+    from . import switch_controller
+    from . import system
+    from . import user
+    from . import videofilter
+    from . import virtual_patch
+    from . import voip
+    from . import vpn
+    from . import waf
+    from . import web_proxy
+    from . import webfilter
+    from . import wireless_controller
+    from . import ztna
 
 
 class CMDB:

hfortix_fortios/api/v2/cmdb/alertemail/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for ALERTEMAIL category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .setting import Setting
+
+
+class Alertemail:
+    """Type stub for Alertemail."""
+
+    setting: Setting
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/antivirus/__init__.pyi

@@ -0,0 +1,23 @@
+"""Type stubs for ANTIVIRUS category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .exempt_list import ExemptList
+    from .profile import Profile
+    from .quarantine import Quarantine
+    from .settings import Settings
+
+
+class Antivirus:
+    """Type stub for Antivirus."""
+
+    exempt_list: ExemptList
+    profile: Profile
+    quarantine: Quarantine
+    settings: Settings
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/application/__init__.pyi

@@ -0,0 +1,25 @@
+"""Type stubs for APPLICATION category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .custom import Custom
+    from .group import Group
+    from .list import List
+    from .name import Name
+    from .rule_settings import RuleSettings
+
+
+class Application:
+    """Type stub for Application."""
+
+    custom: Custom
+    group: Group
+    list: List
+    name: Name
+    rule_settings: RuleSettings
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/authentication/__init__.pyi

@@ -0,0 +1,21 @@
+"""Type stubs for AUTHENTICATION category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .rule import Rule
+    from .scheme import Scheme
+    from .setting import Setting
+
+
+class Authentication:
+    """Type stub for Authentication."""
+
+    rule: Rule
+    scheme: Scheme
+    setting: Setting
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/automation/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for AUTOMATION category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .setting import Setting
+
+
+class Automation:
+    """Type stub for Automation."""
+
+    setting: Setting
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/casb/__init__.pyi

@@ -0,0 +1,23 @@
+"""Type stubs for CASB category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .attribute_match import AttributeMatch
+    from .profile import Profile
+    from .saas_application import SaasApplication
+    from .user_activity import UserActivity
+
+
+class Casb:
+    """Type stub for Casb."""
+
+    attribute_match: AttributeMatch
+    profile: Profile
+    saas_application: SaasApplication
+    user_activity: UserActivity
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/certificate/__init__.pyi

@@ -0,0 +1,25 @@
+"""Type stubs for CERTIFICATE category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .ca import Ca
+    from .crl import Crl
+    from .hsm_local import HsmLocal
+    from .local import Local
+    from .remote import Remote
+
+
+class Certificate:
+    """Type stub for Certificate."""
+
+    ca: Ca
+    crl: Crl
+    hsm_local: HsmLocal
+    local: Local
+    remote: Remote
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/diameter_filter/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for DIAMETER_FILTER category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .profile import Profile
+
+
+class DiameterFilter:
+    """Type stub for DiameterFilter."""
+
+    profile: Profile
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/dlp/__init__.pyi

@@ -0,0 +1,31 @@
+"""Type stubs for DLP category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .data_type import DataType
+    from .dictionary import Dictionary
+    from .exact_data_match import ExactDataMatch
+    from .filepattern import Filepattern
+    from .label import Label
+    from .profile import Profile
+    from .sensor import Sensor
+    from .settings import Settings
+
+
+class Dlp:
+    """Type stub for Dlp."""
+
+    data_type: DataType
+    dictionary: Dictionary
+    exact_data_match: ExactDataMatch
+    filepattern: Filepattern
+    label: Label
+    profile: Profile
+    sensor: Sensor
+    settings: Settings
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/dnsfilter/__init__.pyi

@@ -0,0 +1,19 @@
+"""Type stubs for DNSFILTER category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .domain_filter import DomainFilter
+    from .profile import Profile
+
+
+class Dnsfilter:
+    """Type stub for Dnsfilter."""
+
+    domain_filter: DomainFilter
+    profile: Profile
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/emailfilter/__init__.pyi

@@ -0,0 +1,31 @@
+"""Type stubs for EMAILFILTER category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .block_allow_list import BlockAllowList
+    from .bword import Bword
+    from .dnsbl import Dnsbl
+    from .fortishield import Fortishield
+    from .iptrust import Iptrust
+    from .mheader import Mheader
+    from .options import Options
+    from .profile import Profile
+
+
+class Emailfilter:
+    """Type stub for Emailfilter."""
+
+    block_allow_list: BlockAllowList
+    bword: Bword
+    dnsbl: Dnsbl
+    fortishield: Fortishield
+    iptrust: Iptrust
+    mheader: Mheader
+    options: Options
+    profile: Profile
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/endpoint_control/__init__.pyi

@@ -0,0 +1,21 @@
+"""Type stubs for ENDPOINT_CONTROL category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .fctems import Fctems
+    from .fctems_override import FctemsOverride
+    from .settings import Settings
+
+
+class EndpointControl:
+    """Type stub for EndpointControl."""
+
+    fctems: Fctems
+    fctems_override: FctemsOverride
+    settings: Settings
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/ethernet_oam/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for ETHERNET_OAM category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .cfm import Cfm
+
+
+class EthernetOam:
+    """Type stub for EthernetOam."""
+
+    cfm: Cfm
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/extension_controller/__init__.pyi

@@ -0,0 +1,27 @@
+"""Type stubs for EXTENSION_CONTROLLER category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .dataplan import Dataplan
+    from .extender import Extender
+    from .extender_profile import ExtenderProfile
+    from .extender_vap import ExtenderVap
+    from .fortigate import Fortigate
+    from .fortigate_profile import FortigateProfile
+
+
+class ExtensionController:
+    """Type stub for ExtensionController."""
+
+    dataplan: Dataplan
+    extender: Extender
+    extender_profile: ExtenderProfile
+    extender_vap: ExtenderVap
+    fortigate: Fortigate
+    fortigate_profile: FortigateProfile
+
+    def __init__(self, client: IHTTPClient) -> None: ...

hfortix_fortios/api/v2/cmdb/file_filter/__init__.pyi

@@ -0,0 +1,17 @@
+"""Type stubs for FILE_FILTER category."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from hfortix_core.http.interface import IHTTPClient
+    from .profile import Profile
+
+
+class FileFilter:
+    """Type stub for FileFilter."""
+
+    profile: Profile
+
+    def __init__(self, client: IHTTPClient) -> None: ...