"""
Pydantic Models for CMDB - wireless_controller/hotspot20/anqp_ip_address_type

Runtime validation models for wireless_controller/hotspot20/anqp_ip_address_type configuration.
Generated from FortiOS schema version unknown.

Example Usage:
    >>> from hfortix_fortios.models.cmdb.wireless_controller.hotspot20.anqp_ip_address_type import 
    >>>
    >>> # Create with validation
    >>> obj = (
    ...     name=1,
    ...     name="example",
    ... )
    >>>
    >>> # Validation happens automatically
    >>> # ValidationError raised if constraints violated
"""

from __future__ import annotations

from pydantic import BaseModel, Field, field_validator
from typing import Any, Literal, Optional
from enum import Enum

# ============================================================================
# Enum Definitions (for fields with 4+ allowed values)
# ============================================================================

class AnqpIpAddressTypeIpv4_address_typeEnum(str, Enum):
    """Allowed values for ipv4_address_type field."""
    NOT_AVAILABLE = "not-available"    PUBLIC = "public"    PORT_RESTRICTED = "port-restricted"    SINGLE_NATED_PRIVATE = "single-NATed-private"    DOUBLE_NATED_PRIVATE = "double-NATed-private"    PORT_RESTRICTED_AND_SINGLE_NATED = "port-restricted-and-single-NATed"    PORT_RESTRICTED_AND_DOUBLE_NATED = "port-restricted-and-double-NATed"    NOT_KNOWN = "not-known"

# ============================================================================
# Main Model
# ============================================================================

class AnqpIpAddressTypeModel(BaseModel):
    """
    Pydantic model for wireless_controller/hotspot20/anqp_ip_address_type configuration.
    
    Configure IP address type availability.
    
    Validation Rules:        - name: max_length=35 pattern=        - ipv6_address_type: pattern=        - ipv4_address_type: pattern=    """
    
    class Config:
        """Pydantic model configuration."""
        extra = "allow"  # Allow additional fields from API
        str_strip_whitespace = True
        validate_assignment = True  # Validate on attribute assignment
        use_enum_values = True  # Use enum values instead of names
    
    # ========================================================================
    # Model Fields
    # ========================================================================
    
    name: str | None = Field(max_length=35, default="", description="IP type name.")    
    ipv6_address_type: Literal["not-available", "available", "not-known"] | None = Field(default="not-available", description="IPv6 address type.")    
    ipv4_address_type: Ipv4AddressTypeEnum | None = Field(default="not-available", description="IPv4 address type.")    
    # ========================================================================
    # Custom Validators
    # ========================================================================
    
    # ========================================================================
    # Helper Methods
    # ========================================================================
    
    def to_fortios_dict(self) -> dict[str, Any]:
        """
        Convert model to FortiOS API payload format.
        
        Returns:
            Dict suitable for POST/PUT operations
        """
        # Export with exclude_none to avoid sending null values
        return self.model_dump(exclude_none=True, by_alias=True)
    
    @classmethod
    def from_fortios_response(cls, data: dict[str, Any]) -> "":
        """
        Create model instance from FortiOS API response.
        
        Args:
            data: Response data from API
            
        Returns:
            Validated model instance
        """
        return cls(**data)

# ============================================================================
# Type Aliases for Convenience
# ============================================================================

Dict = dict[str, Any]  # For backward compatibility

# ============================================================================
# Module Exports
# ============================================================================

__all__ = [
    "AnqpIpAddressTypeModel",]


# ============================================================================
# Generated by hfortix generator v0.6.0
# Schema: 1.7.0
# Generated: 2026-01-09T09:47:42.724725Z
# ============================================================================