miso-client 0.1.0__py3-none-any.whl → 3.7.2__py3-none-any.whl

miso_client/api/types/__init__.py

@@ -0,0 +1,75 @@
+"""
+API type definitions.
+
+Exports all request and response types for the API layer.
+"""
+
+from .auth_types import (
+    DeviceCodeRequest,
+    DeviceCodeResponse,
+    DeviceCodeResponseWrapper,
+    DeviceCodeTokenPollRequest,
+    DeviceCodeTokenPollResponse,
+    DeviceCodeTokenResponse,
+    GetUserResponse,
+    GetUserResponseData,
+    LoginResponse,
+    LoginResponseData,
+    LogoutResponse,
+    RefreshTokenRequest,
+    RefreshTokenResponse,
+    ValidateTokenRequest,
+    ValidateTokenResponse,
+    ValidateTokenResponseData,
+)
+from .logs_types import (
+    AuditLogData,
+    BatchLogError,
+    BatchLogRequest,
+    BatchLogResponse,
+    GeneralLogData,
+    LogRequest,
+    LogResponse,
+)
+from .permissions_types import GetPermissionsResponse as PermissionsGetPermissionsResponse
+from .permissions_types import GetPermissionsResponseData as PermissionsGetPermissionsResponseData
+from .permissions_types import RefreshPermissionsResponse as PermissionsRefreshPermissionsResponse
+from .roles_types import GetRolesResponse as RolesGetRolesResponse
+from .roles_types import GetRolesResponseData as RolesGetRolesResponseData
+from .roles_types import RefreshRolesResponse as RolesRefreshRolesResponse
+
+__all__ = [
+    # Auth types
+    "LoginResponse",
+    "LoginResponseData",
+    "ValidateTokenRequest",
+    "ValidateTokenResponse",
+    "ValidateTokenResponseData",
+    "GetUserResponse",
+    "GetUserResponseData",
+    "LogoutResponse",
+    "RefreshTokenRequest",
+    "RefreshTokenResponse",
+    "DeviceCodeTokenResponse",
+    "DeviceCodeRequest",
+    "DeviceCodeResponse",
+    "DeviceCodeResponseWrapper",
+    "DeviceCodeTokenPollRequest",
+    "DeviceCodeTokenPollResponse",
+    # Roles types
+    "RolesGetRolesResponse",
+    "RolesGetRolesResponseData",
+    "RolesRefreshRolesResponse",
+    # Permissions types
+    "PermissionsGetPermissionsResponse",
+    "PermissionsGetPermissionsResponseData",
+    "PermissionsRefreshPermissionsResponse",
+    # Logs types
+    "GeneralLogData",
+    "AuditLogData",
+    "LogRequest",
+    "BatchLogRequest",
+    "LogResponse",
+    "BatchLogResponse",
+    "BatchLogError",
+]

miso_client/api/types/auth_types.py

@@ -0,0 +1,183 @@
+"""
+Auth API request and response types.
+
+All types follow OpenAPI specification with camelCase field names.
+"""
+
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+from ...models.config import UserInfo
+
+
+class LoginResponse(BaseModel):
+    """Login response with login URL."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: "LoginResponseData" = Field(..., description="Login data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class LoginResponseData(BaseModel):
+    """Login response data."""
+
+    loginUrl: str = Field(..., description="Login URL for OAuth2 flow")
+
+
+class ValidateTokenRequest(BaseModel):
+    """Token validation request."""
+
+    token: str = Field(..., description="JWT token to validate")
+    environment: Optional[str] = Field(default=None, description="Optional environment key")
+    application: Optional[str] = Field(default=None, description="Optional application key")
+
+
+class ValidateTokenResponse(BaseModel):
+    """Token validation response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: "ValidateTokenResponseData" = Field(..., description="Validation data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class ValidateTokenResponseData(BaseModel):
+    """Token validation response data."""
+
+    authenticated: bool = Field(..., description="Whether token is authenticated")
+    user: Optional[UserInfo] = Field(default=None, description="User information if authenticated")
+    expiresAt: Optional[str] = Field(default=None, description="Token expiration timestamp")
+
+
+class GetUserResponse(BaseModel):
+    """Get user response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: "GetUserResponseData" = Field(..., description="User data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class GetUserResponseData(BaseModel):
+    """Get user response data."""
+
+    user: UserInfo = Field(..., description="User information")
+    authenticated: bool = Field(..., description="Whether user is authenticated")
+
+
+class LogoutResponse(BaseModel):
+    """Logout response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    message: str = Field(..., description="Logout message")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class RefreshTokenRequest(BaseModel):
+    """Refresh token request."""
+
+    refreshToken: str = Field(..., description="Refresh token")
+
+
+class DeviceCodeTokenResponse(BaseModel):
+    """Device code token response."""
+
+    accessToken: str = Field(..., description="JWT access token")
+    refreshToken: Optional[str] = Field(default=None, description="Refresh token")
+    expiresIn: int = Field(..., description="Token expiration in seconds")
+
+
+class RefreshTokenResponse(BaseModel):
+    """Refresh token response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: DeviceCodeTokenResponse = Field(..., description="Token data")
+    message: Optional[str] = Field(default=None, description="Optional message")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class DeviceCodeRequest(BaseModel):
+    """Device code initiation request."""
+
+    environment: Optional[str] = Field(default=None, description="Environment key")
+    scope: Optional[str] = Field(default=None, description="OAuth2 scope string")
+
+
+class DeviceCodeResponse(BaseModel):
+    """Device code response."""
+
+    deviceCode: str = Field(..., description="Device code for polling")
+    userCode: str = Field(..., description="User code to enter")
+    verificationUri: str = Field(..., description="Verification URI")
+    verificationUriComplete: Optional[str] = Field(
+        default=None, description="Complete URI with user code"
+    )
+    expiresIn: int = Field(..., description="Device code expiration in seconds")
+    interval: int = Field(..., description="Polling interval in seconds")
+
+
+class DeviceCodeResponseWrapper(BaseModel):
+    """Device code response wrapper."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: DeviceCodeResponse = Field(..., description="Device code data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class DeviceCodeTokenPollRequest(BaseModel):
+    """Device code token poll request."""
+
+    deviceCode: str = Field(..., description="Device code from initiation")
+
+
+class DeviceCodeTokenPollResponse(BaseModel):
+    """Device code token poll response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: Optional[DeviceCodeTokenResponse] = Field(default=None, description="Token data if ready")
+    error: Optional[str] = Field(default=None, description="Error code if pending")
+    errorDescription: Optional[str] = Field(default=None, description="Error description")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class GetRolesResponse(BaseModel):
+    """Get roles response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: "GetRolesResponseData" = Field(..., description="Roles data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class GetRolesResponseData(BaseModel):
+    """Get roles response data."""
+
+    roles: List[str] = Field(..., description="List of user roles")
+
+
+class RefreshRolesResponse(BaseModel):
+    """Refresh roles response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: GetRolesResponseData = Field(..., description="Roles data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class GetPermissionsResponse(BaseModel):
+    """Get permissions response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: "GetPermissionsResponseData" = Field(..., description="Permissions data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class GetPermissionsResponseData(BaseModel):
+    """Get permissions response data."""
+
+    permissions: List[str] = Field(..., description="List of user permissions")
+
+
+class RefreshPermissionsResponse(BaseModel):
+    """Refresh permissions response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: GetPermissionsResponseData = Field(..., description="Permissions data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")

miso_client/api/types/logs_types.py

@@ -0,0 +1,71 @@
+"""
+Logs API request and response types.
+
+All types follow OpenAPI specification with camelCase field names.
+"""
+
+from typing import Any, Dict, List, Literal, Optional, Union
+
+from pydantic import BaseModel, Field
+
+from ...models.config import LogEntry
+
+
+class GeneralLogData(BaseModel):
+    """General log data structure."""
+
+    level: Literal["error", "warn", "info", "debug"] = Field(..., description="Log level")
+    message: str = Field(..., description="Log message")
+    context: Optional[Dict[str, Any]] = Field(default=None, description="Additional context")
+    correlationId: Optional[str] = Field(default=None, description="Correlation ID")
+
+
+class AuditLogData(BaseModel):
+    """Audit log data structure."""
+
+    entityType: str = Field(..., description="Entity type")
+    entityId: str = Field(..., description="Entity ID")
+    action: str = Field(..., description="Action performed")
+    oldValues: Optional[Dict[str, Any]] = Field(default=None, description="Previous values")
+    newValues: Optional[Dict[str, Any]] = Field(default=None, description="New values")
+    correlationId: Optional[str] = Field(default=None, description="Correlation ID")
+
+
+class LogRequest(BaseModel):
+    """Log request with type and data."""
+
+    type: Literal["error", "general", "audit"] = Field(..., description="Log entry type")
+    data: Union[GeneralLogData, AuditLogData] = Field(..., description="Log data")
+
+
+class BatchLogRequest(BaseModel):
+    """Batch log request."""
+
+    logs: List[LogEntry] = Field(..., description="List of log entries")
+
+
+class LogResponse(BaseModel):
+    """Log response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    message: str = Field(..., description="Response message")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class BatchLogError(BaseModel):
+    """Batch log error entry."""
+
+    index: int = Field(..., description="Index of failed log entry")
+    error: str = Field(..., description="Error message")
+    log: Dict[str, Any] = Field(..., description="Failed log entry")
+
+
+class BatchLogResponse(BaseModel):
+    """Batch log response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    message: str = Field(..., description="Response message")
+    processed: int = Field(..., description="Number of logs successfully processed")
+    failed: int = Field(..., description="Number of logs that failed")
+    errors: Optional[List[BatchLogError]] = Field(default=None, description="Error details")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")

miso_client/api/types/permissions_types.py

@@ -0,0 +1,31 @@
+"""
+Permissions API request and response types.
+
+All types follow OpenAPI specification with camelCase field names.
+"""
+
+from typing import List
+
+from pydantic import BaseModel, Field
+
+
+class GetPermissionsResponse(BaseModel):
+    """Get permissions response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: "GetPermissionsResponseData" = Field(..., description="Permissions data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class GetPermissionsResponseData(BaseModel):
+    """Get permissions response data."""
+
+    permissions: List[str] = Field(..., description="List of user permissions")
+
+
+class RefreshPermissionsResponse(BaseModel):
+    """Refresh permissions response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: GetPermissionsResponseData = Field(..., description="Permissions data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")

miso_client/api/types/roles_types.py

@@ -0,0 +1,31 @@
+"""
+Roles API request and response types.
+
+All types follow OpenAPI specification with camelCase field names.
+"""
+
+from typing import List
+
+from pydantic import BaseModel, Field
+
+
+class GetRolesResponse(BaseModel):
+    """Get roles response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: "GetRolesResponseData" = Field(..., description="Roles data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")
+
+
+class GetRolesResponseData(BaseModel):
+    """Get roles response data."""
+
+    roles: List[str] = Field(..., description="List of user roles")
+
+
+class RefreshRolesResponse(BaseModel):
+    """Refresh roles response."""
+
+    success: bool = Field(..., description="Whether request was successful")
+    data: GetRolesResponseData = Field(..., description="Roles data")
+    timestamp: str = Field(..., description="Response timestamp (ISO 8601)")

miso_client/errors.py

@@ -4,41 +4,67 @@ SDK exceptions and error handling.
 This module defines custom exceptions for the MisoClient SDK.
 """
 
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ..models.error_response import ErrorResponse
+
 
 class MisoClientError(Exception):
     """Base exception for MisoClient SDK errors."""
-    
-    def __init__(self, message: str, status_code: int | None = None, error_body: dict | None = None):
+
+    def __init__(
+        self,
+        message: str,
+        status_code: int | None = None,
+        error_body: dict | None = None,
+        error_response: "ErrorResponse | None" = None,
+    ):
         """
         Initialize MisoClient error.
-        
+
         Args:
             message: Error message
             status_code: HTTP status code if applicable
             error_body: Sanitized error response body (secrets masked)
+            error_response: Structured error response object (RFC 7807-style)
         """
         super().__init__(message)
         self.message = message
         self.status_code = status_code
         self.error_body = error_body if error_body is not None else None
+        self.error_response = error_response
+
+        # Enhance message with structured error information if available
+        if error_response and error_response.errors:
+            if len(error_response.errors) == 1:
+                self.message = error_response.errors[0]
+            else:
+                self.message = f"{error_response.title}: {'; '.join(error_response.errors)}"
+            # Override status_code from structured response if available
+            if error_response.statusCode:
+                self.status_code = error_response.statusCode
 
 
 class AuthenticationError(MisoClientError):
     """Raised when authentication fails."""
+
     pass
 
 
 class AuthorizationError(MisoClientError):
     """Raised when authorization check fails."""
+
     pass
 
 
 class ConnectionError(MisoClientError):
     """Raised when connection to controller or Redis fails."""
+
     pass
 
 
 class ConfigurationError(MisoClientError):
     """Raised when configuration is invalid."""
-    pass
 
+    pass

miso_client/models/__init__.py

@@ -1 +1,5 @@
 """Pydantic models for MisoClient configuration and data types."""
+
+from .error_response import ErrorResponse
+
+__all__ = ["ErrorResponse"]