maleo-foundation 0.2.96__py3-none-any.whl → 0.2.98__py3-none-any.whl

maleo_foundation/managers/service.py

@@ -44,96 +44,96 @@ from maleo_foundation.utils.logging import (
 from maleo_foundation.utils.merger import deep_merge
 
 class Settings(BaseSettings):
-    ENVIRONMENT:BaseEnums.EnvironmentType = Field(..., description="Environment")
-    SERVICE_KEY:str = Field(..., description="Service's key")
-    GOOGLE_CREDENTIALS_PATH:str = Field("credentials/maleo-google-service-account.json", description="Internal credential's file path")
-    STATIC_CONFIGURATIONS_PATH:str = Field("configs/static.yaml", description="Maleo's static configurations path")
-    RUNTIME_CONFIGURATIONS_PATH:str = Field("configs/runtime.yaml", description="Service's runtime configurations path")
+    ENVIRONMENT: BaseEnums.EnvironmentType = Field(..., description="Environment")
+    SERVICE_KEY: str = Field(..., description="Service's key")
+    GOOGLE_CREDENTIALS_PATH: str = Field("credentials/maleo-google-service-account.json", description="Internal credential's file path")
+    STATIC_CONFIGURATIONS_PATH: str = Field("configs/static.yaml", description="Maleo's static configurations path")
+    RUNTIME_CONFIGURATIONS_PATH: str = Field("configs/runtime.yaml", description="Service's runtime configurations path")
 
 class MaleoCredentials(BaseModel):
-    id:int = Field(..., description="ID")
-    uuid:UUID = Field(..., description="UUID")
-    username:str = Field(..., description="Username")
-    email:str = Field(..., description="Email")
-    password:str = Field(..., description="Password")
+    id: int = Field(..., description="ID")
+    uuid: UUID = Field(..., description="UUID")
+    username: str = Field(..., description="Username")
+    email: str = Field(..., description="Email")
+    password: str = Field(..., description="Password")
 
 class MiddlewareRuntimeConfigurations(BaseModel):
-    base:BaseMiddlewareConfigurations = Field(..., description="Base middleware's configurations")
+    base: BaseMiddlewareConfigurations = Field(..., description="Base middleware's configurations")
 
     class Config:
         arbitrary_types_allowed=True
 
 class ServiceConfigurations(BaseModel):
-    key:str = Field(..., description="Service's key")
-    name:str = Field(..., description="Service's name")
-    host:str = Field(..., description="Service's host")
-    port:int = Field(..., description="Service's port")
+    key: str = Field(..., description="Service's key")
+    name: str = Field(..., description="Service's name")
+    host: str = Field(..., description="Service's host")
+    port: int = Field(..., description="Service's port")
 
 class RuntimeConfigurations(BaseModel):
-    service:ServiceConfigurations = Field(..., description="Service's configurations")
-    middleware:MiddlewareRuntimeConfigurations = Field(..., description="Middleware's runtime configurations")
-    database:str = Field(..., description="Database's name")
+    service: ServiceConfigurations = Field(..., description="Service's configurations")
+    middleware: MiddlewareRuntimeConfigurations = Field(..., description="Middleware's runtime configurations")
+    database: str = Field(..., description="Database's name")
 
     class Config:
         arbitrary_types_allowed=True
 
 class MiddlewareStaticConfigurations(BaseModel):
-    general:GeneralMiddlewareConfigurations = Field(..., description="Middleware's general configurations")
-    cors:CORSMiddlewareConfigurations = Field(..., description="CORS middleware's configurations")
+    general: GeneralMiddlewareConfigurations = Field(..., description="Middleware's general configurations")
+    cors: CORSMiddlewareConfigurations = Field(..., description="CORS middleware's configurations")
 
     class Config:
         arbitrary_types_allowed=True
 
 class MaleoClientConfiguration(BaseModel):
-    key:str = Field(..., description="Client's key")
-    name:str = Field(..., description="Client's name")
-    url:str = Field(..., description="Client's URL")
+    key: str = Field(..., description="Client's key")
+    name: str = Field(..., description="Client's name")
+    url: str = Field(..., description="Client's URL")
 
 class MaleoClientConfigurations(BaseModel):
-    telemetry:MaleoClientConfiguration = Field(..., description="MaleoTelemetry client's configuration")
-    metadata:MaleoClientConfiguration = Field(..., description="MaleoMetadata client's configuration")
-    identity:MaleoClientConfiguration = Field(..., description="MaleoIdentity client's configuration")
-    access:MaleoClientConfiguration = Field(..., description="MaleoAccess client's configuration")
-    workshop:MaleoClientConfiguration = Field(..., description="MaleoWorkshop client's configuration")
-    medix:MaleoClientConfiguration = Field(..., description="MaleoMedix client's configuration")
-    fhir:MaleoClientConfiguration = Field(..., description="MaleoFHIR client's configuration")
-    dicom:MaleoClientConfiguration = Field(..., description="MaleoDICOM client's configuration")
-    scribe:MaleoClientConfiguration = Field(..., description="MaleoScribe client's configuration")
-    cds:MaleoClientConfiguration = Field(..., description="MaleoCDS client's configuration")
-    imaging:MaleoClientConfiguration = Field(..., description="MaleoImaging client's configuration")
-    mcu:MaleoClientConfiguration = Field(..., description="MaleoMCU client's configuration")
+    telemetry: MaleoClientConfiguration = Field(..., description="MaleoTelemetry client's configuration")
+    metadata: MaleoClientConfiguration = Field(..., description="MaleoMetadata client's configuration")
+    identity: MaleoClientConfiguration = Field(..., description="MaleoIdentity client's configuration")
+    access: MaleoClientConfiguration = Field(..., description="MaleoAccess client's configuration")
+    workshop: MaleoClientConfiguration = Field(..., description="MaleoWorkshop client's configuration")
+    medix: MaleoClientConfiguration = Field(..., description="MaleoMedix client's configuration")
+    fhir: MaleoClientConfiguration = Field(..., description="MaleoFHIR client's configuration")
+    dicom: MaleoClientConfiguration = Field(..., description="MaleoDICOM client's configuration")
+    scribe: MaleoClientConfiguration = Field(..., description="MaleoScribe client's configuration")
+    cds: MaleoClientConfiguration = Field(..., description="MaleoCDS client's configuration")
+    imaging: MaleoClientConfiguration = Field(..., description="MaleoImaging client's configuration")
+    mcu: MaleoClientConfiguration = Field(..., description="MaleoMCU client's configuration")
 
     class Config:
         arbitrary_types_allowed=True
 
 class ClientConfigurations(BaseModel):
-    maleo:MaleoClientConfigurations = Field(..., description="Maleo client's configurations")
+    maleo: MaleoClientConfigurations = Field(..., description="Maleo client's configurations")
 
     class Config:
         arbitrary_types_allowed=True
 
 class StaticConfigurations(BaseModel):
-    middleware:MiddlewareStaticConfigurations = Field(..., description="Middleware's static configurations")
-    client:ClientConfigurations = Field(..., description="Client's configurations")
+    middleware: MiddlewareStaticConfigurations = Field(..., description="Middleware's static configurations")
+    client: ClientConfigurations = Field(..., description="Client's configurations")
 
     class Config:
         arbitrary_types_allowed=True
 
 class Configurations(BaseModel):
-    service:ServiceConfigurations = Field(..., description="Service's configurations")
-    middleware:MiddlewareConfigurations = Field(..., description="Middleware's configurations")
-    cache:CacheConfigurations = Field(..., description="Cache's configurations")
-    database:DatabaseConfigurations = Field(..., description="Database's configurations")
-    client:ClientConfigurations = Field(..., description="Client's configurations")
+    service: ServiceConfigurations = Field(..., description="Service's configurations")
+    middleware: MiddlewareConfigurations = Field(..., description="Middleware's configurations")
+    cache: CacheConfigurations = Field(..., description="Cache's configurations")
+    database: DatabaseConfigurations = Field(..., description="Database's configurations")
+    client: ClientConfigurations = Field(..., description="Client's configurations")
 
     class Config:
         arbitrary_types_allowed=True
 
 class Loggers(BaseModel):
-    application:ServiceLogger = Field(..., description="Application logger")
-    repository:ServiceLogger = Field(..., description="Repository logger")
-    database:ServiceLogger = Field(..., description="Database logger")
-    middleware:MiddlewareLoggers = Field(..., description="Middleware logger")
+    application: ServiceLogger = Field(..., description="Application logger")
+    repository: ServiceLogger = Field(..., description="Repository logger")
+    database: ServiceLogger = Field(..., description="Database logger")
+    middleware: MiddlewareLoggers = Field(..., description="Middleware logger")
 
     class Config:
         arbitrary_types_allowed=True
@@ -141,9 +141,9 @@ class Loggers(BaseModel):
 class ServiceManager:
     def __init__(
         self,
-        db_metadata:MetaData,
-        log_config:SimpleConfig,
-        settings:Optional[Settings] = None
+        db_metadata: MetaData,
+        log_config: SimpleConfig,
+        settings: Optional[Settings] = None
     ):
         self._db_metadata = db_metadata #* Declare DB Metadata
         self._log_config = log_config #* Declare log config
@@ -394,8 +394,8 @@ class ServiceManager:
 
     def create_app(
         self,
-        router:APIRouter,
-        lifespan:Optional[Lifespan[AppType]]=None
+        router: APIRouter,
+        lifespan: Optional[Lifespan[AppType]]=None
     ) -> FastAPI:
         self._loggers.application.info("Creating FastAPI application")
         root_path = "" if self._settings.ENVIRONMENT == "local" else f"/{self._configs.service.key.removeprefix("maleo-")}"

maleo_foundation/middlewares/authentication.py

@@ -15,16 +15,19 @@ from maleo_foundation.utils.logging import MiddlewareLogger
 class Backend(AuthenticationBackend):
     def __init__(
         self,
-        keys:BaseGeneralSchemas.RSAKeys,
-        logger:MiddlewareLogger,
-        maleo_foundation:MaleoFoundationClientManager
+        keys: BaseGeneralSchemas.RSAKeys,
+        logger: MiddlewareLogger,
+        maleo_foundation: MaleoFoundationClientManager
     ):
         super().__init__()
         self._keys = keys
         self._logger = logger
         self._maleo_foundation = maleo_foundation
 
-    async def authenticate(self, conn:HTTPConnection) -> Tuple[Credentials, User]:
+    async def authenticate(
+        self,
+        conn: HTTPConnection
+    ) -> Tuple[Credentials, User]:
         if "Authorization" in conn.headers:
             auth = conn.headers["Authorization"]
             parts = auth.split()
@@ -95,10 +98,10 @@ class Backend(AuthenticationBackend):
         return Credentials(), User(authenticated=False)
 
 def add_authentication_middleware(
-    app:FastAPI,
-    keys:BaseGeneralSchemas.RSAKeys,
-    logger:MiddlewareLogger,
-    maleo_foundation:MaleoFoundationClientManager
+    app: FastAPI,
+    keys: BaseGeneralSchemas.RSAKeys,
+    logger: MiddlewareLogger,
+    maleo_foundation: MaleoFoundationClientManager
 ) -> None:
     """
     Adds Authentication middleware to the FastAPI application.

maleo_foundation/middlewares/base.py

@@ -30,10 +30,10 @@ class RateLimiter:
 
     def __init__(
         self,
-        limit:int,
-        window:timedelta,
-        ip_timeout:timedelta,
-        cleanup_interval:timedelta
+        limit: int,
+        window: timedelta,
+        ip_timeout: timedelta,
+        cleanup_interval: timedelta
     ):
         self.limit = limit
         self.window = window
@@ -46,7 +46,7 @@ class RateLimiter:
 
     def is_rate_limited(
         self,
-        request_context:RequestContextTransfers
+        request_context: RequestContextTransfers
     ) -> bool:
         """Check if client IP is rate limited and record the request."""
         with self._lock:
@@ -70,7 +70,7 @@ class RateLimiter:
 
     def cleanup_old_data(
         self,
-        logger:MiddlewareLogger
+        logger: MiddlewareLogger
     ) -> None:
         """Clean up old request data to prevent memory growth."""
         now = datetime.now()
@@ -107,19 +107,19 @@ class ResponseBuilder:
 
     def __init__(
         self,
-        keys:BaseGeneralSchemas.RSAKeys,
-        maleo_foundation:MaleoFoundationClientManager
+        keys: BaseGeneralSchemas.RSAKeys,
+        maleo_foundation: MaleoFoundationClientManager
     ):
         self.keys = keys
         self.maleo_foundation = maleo_foundation
 
     def add_response_headers(
         self,
-        authentication:Authentication,
-        response:Response,
-        request_context:RequestContextTransfers,
-        responded_at:datetime,
-        process_time:float
+        authentication: Authentication,
+        response: Response,
+        request_context: RequestContextTransfers,
+        responded_at: datetime,
+        process_time: float
     ) -> Response:
         """Add custom headers to response."""
         # Basic headers
@@ -138,10 +138,10 @@ class ResponseBuilder:
 
     def _add_signature_header(
         self,
-        response:Response,
-        request_context:RequestContextTransfers,
-        responded_at:datetime,
-        process_time:float
+        response: Response,
+        request_context: RequestContextTransfers,
+        responded_at: datetime,
+        process_time: float
     ) -> None:
         """Generate and add signature header."""
         message = (
@@ -185,9 +185,9 @@ class ResponseBuilder:
 
     def _should_regenerate_auth(
         self,
-        request_context:RequestContextTransfers,
-        authentication:Authentication,
-        response:Response
+        request_context: RequestContextTransfers,
+        authentication: Authentication,
+        response: Response
     ) -> bool:
         """Check if authorization should be regenerated."""
         return (
@@ -205,10 +205,10 @@ class RequestLogger:
 
     def log_request_response(
         self,
-        authentication:Authentication,
-        response:Response,
-        request_context:RequestContextTransfers,
-        log_level:str = "info"
+        authentication: Authentication,
+        response: Response,
+        request_context: RequestContextTransfers,
+        log_level: str = "info"
     ) -> None:
         """Log request and response details."""
         authentication_info = self._get_authentication_info(authentication)
@@ -223,9 +223,9 @@ class RequestLogger:
     
     def log_exception(
         self,
-        authentication:Authentication,
-        error:Exception,
-        request_context:RequestContextTransfers
+        authentication: Authentication,
+        error: Exception,
+        request_context: RequestContextTransfers
     ) -> None:
         """Log exception details."""
         authentication_info = self._get_authentication_info(authentication)
@@ -260,18 +260,18 @@ class BaseMiddleware(BaseHTTPMiddleware):
 
     def __init__(
         self,
-        app:FastAPI,
-        keys:BaseGeneralSchemas.RSAKeys,
-        logger:MiddlewareLogger,
-        maleo_foundation:MaleoFoundationClientManager,
-        allow_origins:Sequence[str] = (),
-        allow_methods:Sequence[str] = ("GET",),
-        allow_headers:Sequence[str] = (),
-        allow_credentials:bool = False,
-        limit:int = 10,
-        window:int = 1,
-        cleanup_interval:int = 60,
-        ip_timeout:int = 300
+        app: FastAPI,
+        keys: BaseGeneralSchemas.RSAKeys,
+        logger: MiddlewareLogger,
+        maleo_foundation: MaleoFoundationClientManager,
+        allow_origins: Sequence[str] = (),
+        allow_methods: Sequence[str] = ("GET",),
+        allow_headers: Sequence[str] = (),
+        allow_credentials: bool = False,
+        limit: int = 10,
+        window: int = 1,
+        cleanup_interval: int = 60,
+        ip_timeout: int = 300
     ):
         super().__init__(app)
 
@@ -293,7 +293,11 @@ class BaseMiddleware(BaseHTTPMiddleware):
             'allow_credentials': allow_credentials,
         }
 
-    async def dispatch(self, request:Request, call_next:RequestResponseEndpoint) -> Response:
+    async def dispatch(
+        self,
+        request: Request,
+        call_next: RequestResponseEndpoint
+    ) -> Response:
         """Main middleware dispatch method."""
         # Setup
         self.rate_limiter.cleanup_old_data(self.request_logger.logger)
@@ -333,9 +337,9 @@ class BaseMiddleware(BaseHTTPMiddleware):
 
     def _create_rate_limit_response(
         self,
-        authentication:Authentication,
-        request_context:RequestContextTransfers,
-        start_time:float
+        authentication: Authentication,
+        request_context: RequestContextTransfers,
+        start_time: float
     ) -> Response:
         """Create rate limit exceeded response."""
         response = JSONResponse(
@@ -349,11 +353,11 @@ class BaseMiddleware(BaseHTTPMiddleware):
 
     def _build_final_response(
         self,
-        authentication:Authentication,
-        response:Response,
-        request_context:RequestContextTransfers,
-        start_time:float,
-        log_level:str = "info"
+        authentication: Authentication,
+        response: Response,
+        request_context: RequestContextTransfers,
+        start_time: float,
+        log_level: str = "info"
     ) -> Response:
         """Build final response with headers and logging."""
         responded_at = datetime.now(tz=timezone.utc)
@@ -373,10 +377,10 @@ class BaseMiddleware(BaseHTTPMiddleware):
 
     def _handle_exception(
         self,
-        authentication:Authentication,
-        error:Exception,
-        request_context:RequestContextTransfers,
-        start_time:float
+        authentication: Authentication,
+        error: Exception,
+        request_context: RequestContextTransfers,
+        start_time: float
     ) -> Response:
         """Handle exceptions and create error response."""
         responded_at = datetime.now(tz=timezone.utc)
@@ -397,18 +401,18 @@ class BaseMiddleware(BaseHTTPMiddleware):
 
 
 def add_base_middleware(
-    app:FastAPI,
-    keys:BaseGeneralSchemas.RSAKeys,
-    logger:MiddlewareLogger,
-    maleo_foundation:MaleoFoundationClientManager,
-    allow_origins:Sequence[str] = (),
-    allow_methods:Sequence[str] = ("GET",),
-    allow_headers:Sequence[str] = (),
-    allow_credentials:bool = False,
-    limit:int = 10,
-    window:int = 1,
-    cleanup_interval:int = 60,
-    ip_timeout:int = 300
+    app: FastAPI,
+    keys: BaseGeneralSchemas.RSAKeys,
+    logger: MiddlewareLogger,
+    maleo_foundation: MaleoFoundationClientManager,
+    allow_origins: Sequence[str] = (),
+    allow_methods: Sequence[str] = ("GET",),
+    allow_headers: Sequence[str] = (),
+    allow_credentials: bool = False,
+    limit: int = 10,
+    window: int = 1,
+    cleanup_interval: int = 60,
+    ip_timeout: int = 300
 ) -> None:
     """
     Add Base middleware to the FastAPI application.

maleo_foundation/middlewares/cors.py

@@ -3,12 +3,12 @@ from fastapi.middleware.cors import CORSMiddleware
 from typing import Sequence
 
 def add_cors_middleware(
-    app:FastAPI,
-    allow_origins:Sequence[str] = (),
-    allow_methods:Sequence[str] = ("GET",),
-    allow_headers:Sequence[str] = (),
-    allow_credentials:bool = False,
-    expose_headers:Sequence[str] = ()
+    app: FastAPI,
+    allow_origins: Sequence[str] = (),
+    allow_methods: Sequence[str] = ("GET",),
+    allow_headers: Sequence[str] = (),
+    allow_credentials: bool = False,
+    expose_headers: Sequence[str] = ()
 ) -> None:
     """
     Adds CORS (Cross-Origin Resource Sharing) middleware to the FastAPI application.

maleo_foundation/models/responses.py

@@ -7,62 +7,62 @@ from maleo_foundation.types import BaseTypes
 
 class BaseResponses:
     class Fail(BaseResultSchemas.Fail):
-        other:BaseTypes.OptionalAny = Field("Please try again later or contact administrator.", description="Response's other information")
+        other: BaseTypes.OptionalAny = Field("Please try again later or contact administrator.", description="Response's other information")
 
     class BadRequest(Fail):
-        code:str = "MAL-BDR-001"
-        message:str = "Bad Request"
-        description:str = "Bad/Unexpected parameters given in the request"
+        code: str = "MAL-BDR-001"
+        message: str = "Bad Request"
+        description: str = "Bad/Unexpected parameters given in the request"
 
     class InvalidExpand(BadRequest):
-        code:str = "MAL-INE-001"
-        message:str = "Invalid expand"
-        description:str = "Invalid expand field(s) configuration are given. Check 'other' for more information."
+        code: str = "MAL-INE-001"
+        message: str = "Invalid expand"
+        description: str = "Invalid expand field(s) configuration are given. Check 'other' for more information."
 
     class InvalidParameter(BadRequest):
-        code:str = "MAL-IPR-001"
-        message:str = "Invalid parameters"
-        description:str = "Invalid parameters and/or parameters combinations is given. Check 'other' for more information."
+        code: str = "MAL-IPR-001"
+        message: str = "Invalid parameters"
+        description: str = "Invalid parameters and/or parameters combinations is given. Check 'other' for more information."
 
     class InvalidSystemRole(BadRequest):
-        code:str = "MAL-ISR-001"
-        message:str = "Invalid system role"
-        description:str = "Invalid system role is detected in authorization token. Check 'other' for more information."
+        code: str = "MAL-ISR-001"
+        message: str = "Invalid system role"
+        description: str = "Invalid system role is detected in authorization token. Check 'other' for more information."
 
     class Unauthorized(Fail):
-        code:str = "MAL-ATH-001"
-        message:str = "Unauthorized Request"
-        description:str = "You are unauthorized to request this resource"
+        code: str = "MAL-ATH-001"
+        message: str = "Unauthorized Request"
+        description: str = "You are unauthorized to request this resource"
 
     class Forbidden(Fail):
-        code:str = "MAL-ATH-002"
-        message:str = "Forbidden Request"
-        description:str = "You are forbidden from requesting this resource"
+        code: str = "MAL-ATH-002"
+        message: str = "Forbidden Request"
+        description: str = "You are forbidden from requesting this resource"
 
     class MethodNotAllowed(Fail):
-        code:str = "MAL-MTA-002"
-        message:str = "Method Not Allowed"
-        description:str = "Method not allowed for requesting this resource"
+        code: str = "MAL-MTA-002"
+        message: str = "Method Not Allowed"
+        description: str = "Method not allowed for requesting this resource"
 
     class ValidationError(Fail):
-        code:str = "MAL-VLD-001"
-        message:str = "Validation Error"
-        description:str = "Request validation failed due to missing or invalid fields. Check other for more info."
+        code: str = "MAL-VLD-001"
+        message: str = "Validation Error"
+        description: str = "Request validation failed due to missing or invalid fields. Check other for more info."
 
     class RateLimitExceeded(Fail):
-        code:str = "MAL-RTL-001"
-        message:str = "Rate Limit Exceeded"
-        description:str = "This resource is requested too many times. Please try again later."
+        code: str = "MAL-RTL-001"
+        message: str = "Rate Limit Exceeded"
+        description: str = "This resource is requested too many times. Please try again later."
 
     class ServerError(Fail):
-        code:str = "MAL-EXC-001"
-        message:str = "Unexpected Server Error"
-        description:str = "An unexpected error occurred while processing your request."
+        code: str = "MAL-EXC-001"
+        message: str = "Unexpected Server Error"
+        description: str = "An unexpected error occurred while processing your request."
 
     class NotImplemented(Fail):
-        code:str = "MAL-NIM-001"
-        message:str = "Not Implemented"
-        description:str = "This request is not yet implemented by the system."
+        code: str = "MAL-NIM-001"
+        message: str = "Not Implemented"
+        description: str = "This request is not yet implemented by the system."
 
     class NotFound(BaseResultSchemas.NotFound): pass
 
@@ -73,9 +73,9 @@ class BaseResponses:
     class UnpaginatedMultipleData(BaseResultSchemas.UnpaginatedMultipleData): pass
 
     class PaginatedMultipleData(BaseResultSchemas.PaginatedMultipleData):
-        page:int = Field(1, ge=1, description="Page number, must be >= 1.", exclude=True)
-        limit:int = Field(10, ge=1, le=100, description="Page size, must be 1 <= limit <= 100.", exclude=True)
-        total_data:int = Field(..., ge=0, description="Total data count", exclude=True)
+        page: int = Field(1, ge=1, description="Page number, must be >= 1.", exclude=True)
+        limit: int = Field(10, ge=1, le=100, description="Page size, must be 1 <= limit <= 100.", exclude=True)
+        total_data: int = Field(..., ge=0, description="Total data count", exclude=True)
 
         @model_validator(mode="before")
         @classmethod

maleo_foundation/models/schemas/encryption.py

@@ -3,16 +3,16 @@ from maleo_foundation.types import BaseTypes
 
 class MaleoFoundationEncryptionSchemas:
     class Key(BaseModel):
-        key:str = Field(..., description="Key")
+        key: str = Field(..., description="Key")
 
     class Password(BaseModel):
-        password:BaseTypes.OptionalString = Field(None, min_length=32, max_length=1024, description="password")
+        password: BaseTypes.OptionalString = Field(None, min_length=32, max_length=1024, description="password")
 
     class InitializationVector(BaseModel):
-        initialization_vector:str = Field(..., description="Initialization vector")
+        initialization_vector: str = Field(..., description="Initialization vector")
 
     class Plaintext(BaseModel):
-        plaintext:str = Field(..., description="Plaintext")
+        plaintext: str = Field(..., description="Plaintext")
 
     class Ciphertext(BaseModel):
-        ciphertext:str = Field(..., description="Ciphertext")
+        ciphertext: str = Field(..., description="Ciphertext")