maleo-foundation 0.3.71__py3-none-any.whl → 0.3.74__py3-none-any.whl

maleo_foundation/models/schemas/general.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 from datetime import datetime, timezone
-from pydantic import BaseModel, Field, model_validator
-from typing import Any, Optional, Self
+from pydantic import BaseModel, Field
 from uuid import UUID
 from maleo_foundation.enums import BaseEnums
 from maleo_foundation.types import BaseTypes
@@ -23,131 +22,6 @@ class BaseGeneralSchemas:
             10, ge=1, le=100, description="Page size, must be 1 <= limit <= 100."
         )
 
-    # * ----- ----- ----- Operation ----- ----- ----- *#
-    class OperationArguments(BaseModel):
-        positional: BaseTypes.ListOfAny = Field([], description="Positional arguments")
-        keyword: BaseTypes.StringToAnyDict = Field({}, description="Keyword arguments")
-
-    class OperationContext(BaseModel):
-        origin: BaseEnums.OperationOrigin = Field(..., description="Operation's origin")
-        client_key: BaseTypes.OptionalString = Field(None, description="Client's key")
-        layer: BaseEnums.OperationLayer = Field(..., description="Operation's layer")
-        target: Optional[BaseEnums.OperationTarget] = Field(
-            None, description="Operation's target (optional)"
-        )
-        target_environment: Optional[BaseEnums.EnvironmentType] = Field(
-            None, description="Operation's target's environment (optional)"
-        )
-        target_name: BaseTypes.OptionalString = Field(
-            None, description="Operation's target's name (optional)"
-        )
-        target_resource: BaseTypes.OptionalString = Field(
-            None, description="Operation's target's resource (optional)"
-        )
-
-    class OperationMetadata(BaseModel):
-        type: BaseEnums.OperationType = Field(..., description="Operation's type")
-        create_type: Optional[BaseEnums.CreateType] = Field(
-            None, description="Create type (optional)"
-        )
-        update_type: Optional[BaseEnums.UpdateType] = Field(
-            None, description="Update type (optional)"
-        )
-        status_update_type: Optional[BaseEnums.StatusUpdateType] = Field(
-            None, description="Status update type (optional)"
-        )
-        summary: BaseTypes.OptionalString = Field(
-            None, description="Summary (optional)"
-        )
-
-        @model_validator(mode="after")
-        def validate_operation_types(self) -> Self:
-            # Validate create operation type
-            if self.type is BaseEnums.OperationType.CREATE:
-                if self.create_type is None:
-                    raise ValueError(
-                        "'create_type' must have value if 'type' is 'create'"
-                    )
-                if self.create_type not in BaseEnums.CreateType:
-                    raise ValueError(
-                        f"'create_type' must be one of {[e.value for e in BaseEnums.CreateType]}"
-                    )
-
-            # Validate update operation type
-            if self.type is BaseEnums.OperationType.UPDATE:
-                if self.update_type is None:
-                    raise ValueError(
-                        "'update_type' must have value if 'type' is 'update'"
-                    )
-                if self.update_type not in BaseEnums.UpdateType:
-                    raise ValueError(
-                        f"'update_type' must be one of {[e.value for e in BaseEnums.UpdateType]}"
-                    )
-                if self.update_type is BaseEnums.UpdateType.STATUS:
-                    if self.status_update_type is None:
-                        raise ValueError(
-                            "'status_update_type' must have value if 'update_type' is 'status'"
-                        )
-                    if self.status_update_type not in BaseEnums.StatusUpdateType:
-                        raise ValueError(
-                            f"'status_update_type' must be one of {[e.value for e in BaseEnums.StatusUpdateType]}"
-                        )
-
-            return self
-
-    class OperationServiceContext(BaseModel):
-        key: BaseEnums.Service = Field(..., description="Service's key")
-        environment: BaseEnums.EnvironmentType = Field(
-            ..., description="Service's environment"
-        )
-
-    class OperationTimestamps(BaseModel):
-        started_at: BaseTypes.OptionalDatetime = Field(
-            None, description="Started at timestamp (Optional)"
-        )
-        finished_at: BaseTypes.OptionalDatetime = Field(
-            None, description="Finished at timestamp (Optional)"
-        )
-        duration: float = Field(0, description="Operation duration")
-
-        @model_validator(mode="after")
-        def calculate_duration(self) -> Self:
-            if self.started_at is not None and self.finished_at is not None:
-                self.duration = (self.finished_at - self.started_at).total_seconds()
-
-            return self
-
-    class OperationResult(BaseModel):
-        success: bool = Field(..., description="Success status")
-        code: BaseTypes.OptionalString = Field(None, description="Optional result code")
-        message: BaseTypes.OptionalString = Field(None, description="Optional message")
-        description: BaseTypes.OptionalString = Field(
-            None, description="Optional description"
-        )
-        data: Any = Field(..., description="Data")
-        metadata: BaseTypes.OptionalAny = Field(None, description="Optional metadata")
-        other: BaseTypes.OptionalAny = Field(
-            None, description="Optional other information"
-        )
-
-    class DatabaseOperationContext(BaseModel):
-        database: str = Field(..., description="Database name")
-        environment: BaseEnums.EnvironmentType = Field(
-            ..., description="Database environment"
-        )
-        table: str = Field(..., description="Table name")
-
-    class DatabaseOperationResult(BaseModel):
-        data_id: int = Field(..., ge=1, description="Data's ID")
-        old_data: BaseTypes.OptionalAny = Field(None, description="Old data")
-        new_data: BaseTypes.OptionalAny = Field(None, description="New data")
-
-        @model_validator(mode="after")
-        def validate_data(self) -> Self:
-            if self.old_data is None and self.new_data is None:
-                raise ValueError("Either 'old_data' or 'new_data' must have value")
-            return self
-
     # * ----- ----- ----- Data ----- ----- ----- *#
     class Identifiers(BaseModel):
         id: int = Field(..., ge=1, description="Data's ID, must be >= 1.")

maleo_foundation/models/transfers/general/authentication.py

@@ -0,0 +1,35 @@
+from pydantic import BaseModel, Field
+from typing import Optional, Sequence
+from maleo_foundation.enums import BaseEnums
+from .token import (
+    MaleoFoundationTokenGeneralTransfers,
+)
+
+
+class Token(BaseModel):
+    type: BaseEnums.TokenType = Field(..., description="Token's type")
+    payload: MaleoFoundationTokenGeneralTransfers.DecodePayload = Field(
+        ..., description="Token's payload"
+    )
+
+
+class Credentials(BaseModel):
+    token: Optional[Token] = Field(None, description="Token")
+    scopes: Optional[Sequence[str]] = Field(None, description="Scopes")
+
+
+class User(BaseModel):
+    is_authenticated: bool = Field(False, description="Authenticated")
+    display_name: str = Field("", description="Username")
+    identity: str = Field("", description="Email")
+
+
+class Authentication(BaseModel):
+    credentials: Credentials = Field(
+        default_factory=Credentials,  # type: ignore
+        description="Credential",
+    )
+    user: User = Field(
+        default_factory=User,  # type: ignore
+        description="User",
+    )

maleo_foundation/{authorization.py → models/transfers/general/authorization.py}

@@ -1,8 +1,5 @@
-from fastapi.security import HTTPBearer
 from pydantic import BaseModel, Field
 
-TOKEN_SCHEME = HTTPBearer()
-
 
 class Authorization(BaseModel):
     scheme: str = Field(..., description="Authorization's scheme")

maleo_foundation/models/transfers/general/configurations/__init__.py

@@ -5,6 +5,7 @@ from maleo_foundation.utils.logging import (
     DatabaseLogger,
     MiddlewareLogger,
     RepositoryLogger,
+    RouterLogger,
     ServiceLogger,
 )
 from .cache import CacheConfigurations
@@ -38,4 +39,5 @@ class Loggers(BaseModel):
     database: DatabaseLogger = Field(..., description="Database logger")
     middleware: MiddlewareLogger = Field(..., description="Middleware logger")
     repository: RepositoryLogger = Field(..., description="Repository logger")
+    router: RouterLogger = Field(..., description="Router logger")
     service: ServiceLogger = Field(..., description="Service logger")

maleo_foundation/models/transfers/general/configurations/client/maleo.py

@@ -7,7 +7,7 @@ class MaleoClientConfigurations(BaseModel):
     environment: BaseEnums.EnvironmentType = Field(
         ..., description="Client's environment"
     )
-    key: str = Field(..., description="Client's key")
+    key: BaseEnums.Service = Field(..., description="Client's key")
     name: str = Field(..., description="Client's name")
     url: str = Field(..., description="Client's URL")
 

maleo_foundation/models/transfers/general/configurations/middleware.py

@@ -2,16 +2,21 @@ from pydantic import BaseModel, Field
 from typing import List
 
 _ALLOW_METHODS: List[str] = ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"]
+
 _ALLOW_HEADERS: List[str] = [
     "Authorization",
     "Content-Type",
+    "X-Operation-Id",
     "X-Request-Id",
     "X-Requested-At",
     "X-Signature",
 ]
+
+
 _EXPOSE_HEADERS: List[str] = [
     "X-New-Authorization",
     "X-Process-Time",
+    "X-Operation-Id",
     "X-Request-Id",
     "X-Requested-At",
     "X-Responded-At",
@@ -19,16 +24,13 @@ _EXPOSE_HEADERS: List[str] = [
 ]
 
 
-class GeneralMiddlewareConfigurations(BaseModel):
+class CORSMiddlewareConfigurations(BaseModel):
     allow_origins: List[str] = Field(
         default_factory=list, description="Allowed origins"
     )
     allow_methods: List[str] = Field(_ALLOW_METHODS, description="Allowed methods")
     allow_headers: list[str] = Field(_ALLOW_HEADERS, description="Allowed headers")
     allow_credentials: bool = Field(True, description="Allowed credentials")
-
-
-class CORSMiddlewareConfigurations(BaseModel):
     expose_headers: List[str] = Field(_EXPOSE_HEADERS, description="Exposed headers")
 
 
@@ -42,9 +44,6 @@ class BaseMiddlewareConfigurations(BaseModel):
 
 
 class MiddlewareConfigurations(BaseModel):
-    general: GeneralMiddlewareConfigurations = Field(
-        ..., description="Middleware's general configurations"
-    )
     cors: CORSMiddlewareConfigurations = Field(
         ..., description="CORS middleware's configurations"
     )

maleo_foundation/models/transfers/general/configurations/pubsub/subscription.py

@@ -0,0 +1,16 @@
+from pydantic import BaseModel, ConfigDict, Field
+from maleo_foundation.controller_types import ControllerTypes
+
+
+class SubscriptionConfigurations(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    id: str = Field(..., description="Subscription's ID")
+    max_messages: int = Field(10, description="Subscription's Max messages")
+    ack_deadline: int = Field(10, description="Subscription's ACK deadline")
+
+
+class ExtendedSubscriptionConfigurations(SubscriptionConfigurations):
+    controller: ControllerTypes.OptionalMessageController = Field(
+        None, description="Optional message controller"
+    )

maleo_foundation/models/transfers/general/configurations/service.py

@@ -1,8 +1,9 @@
 from pydantic import BaseModel, Field
+from maleo_foundation.enums import BaseEnums
 
 
 class ServiceConfigurations(BaseModel):
-    key: str = Field(..., description="Service's key")
+    key: BaseEnums.Service = 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")

maleo_foundation/models/transfers/general/operation.py

@@ -1,51 +1,213 @@
-from pydantic import BaseModel, Field
-from typing import Optional
+import json
+from pydantic import BaseModel, Field, model_validator
+from typing import Any, Optional, Self
+from uuid import UUID, uuid4
 from .request import RequestContext
-from maleo_foundation.authentication import Authentication
-from maleo_foundation.authorization import Authorization
-from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+from .response import ResponseContext
+from .service import ServiceContext
+from maleo_foundation.enums import BaseEnums
+from maleo_foundation.models.transfers.general.authentication import Authentication
+from maleo_foundation.models.transfers.general.authorization import Authorization
+from maleo_foundation.types import BaseTypes
+
+
+class OperationId(BaseModel):
+    operation_id: UUID = Field(uuid4(), description="Operation's ID")
+
+
+class OperationArguments(BaseModel):
+    positional: BaseTypes.ListOfAny = Field([], description="Positional arguments")
+    keyword: BaseTypes.StringToAnyDict = Field({}, description="Keyword arguments")
+
+
+class OperationOrigin(BaseModel):
+    type: BaseEnums.OperationOrigin = Field(
+        ..., description="Operation's origin's type"
+    )
+    properties: BaseTypes.OptionalStringToStringDict = Field(
+        None, description="Operation's origin's properties"
+    )
+
+
+class OperationLayer(BaseModel):
+    type: BaseEnums.OperationLayer = Field(..., description="Operation's layer's type")
+    properties: BaseTypes.OptionalStringToStringDict = Field(
+        None, description="Operation's layer's properties"
+    )
+
+
+class OperationTarget(BaseModel):
+    type: BaseEnums.OperationTarget = Field(
+        ..., description="Operation's target's type"
+    )
+    properties: BaseTypes.OptionalStringToStringDict = Field(
+        None, description="Operation's target's properties"
+    )
+
+
+class OperationContext(BaseModel):
+    origin: OperationOrigin = Field(..., description="Operation's origin")
+    layer: OperationLayer = Field(..., description="Operation's layer")
+    target: Optional[OperationTarget] = Field(
+        None, description="Operation's target (optional)"
+    )
+
+
+class OperationMetadata(BaseModel):
+    type: BaseEnums.OperationType = Field(..., description="Operation's type")
+    create_type: Optional[BaseEnums.CreateType] = Field(
+        None, description="Create type (optional)"
+    )
+    update_type: Optional[BaseEnums.UpdateType] = Field(
+        None, description="Update type (optional)"
+    )
+    status_update_type: Optional[BaseEnums.StatusUpdateType] = Field(
+        None, description="Status update type (optional)"
+    )
+
+    # @model_validator(mode="after")
+    # def validate_operation_types(self) -> Self:
+    #     # Validate create operation type
+    #     if self.type is BaseEnums.OperationType.CREATE:
+    #         if self.create_type is None:
+    #             raise ValueError(
+    #                 "'create_type' must have value if 'type' is 'create'"
+    #             )
+    #         if self.create_type not in BaseEnums.CreateType:
+    #             raise ValueError(
+    #                 f"'create_type' must be one of {[e.value for e in BaseEnums.CreateType]}"
+    #             )
+
+    #     # Validate update operation type
+    #     if self.type is BaseEnums.OperationType.UPDATE:
+    #         if self.update_type is None:
+    #             raise ValueError(
+    #                 "'update_type' must have value if 'type' is 'update'"
+    #             )
+    #         if self.update_type not in BaseEnums.UpdateType:
+    #             raise ValueError(
+    #                 f"'update_type' must be one of {[e.value for e in BaseEnums.UpdateType]}"
+    #             )
+    #         if self.update_type is BaseEnums.UpdateType.STATUS:
+    #             if self.status_update_type is None:
+    #                 raise ValueError(
+    #                     "'status_update_type' must have value if 'update_type' is 'status'"
+    #                 )
+    #             if self.status_update_type not in BaseEnums.StatusUpdateType:
+    #                 raise ValueError(
+    #                     f"'status_update_type' must be one of {[e.value for e in BaseEnums.StatusUpdateType]}"
+    #                 )
+
+    #     return self
+
+
+class OperationException(BaseModel):
+    type: BaseEnums.ExceptionType = Field(
+        BaseEnums.ExceptionType.INTERNAL, description="Exception type"
+    )
+    raw: str = Field(..., description="Raw exception")
+    traceback: BaseTypes.ListOfStrings = Field(..., description="Traceback")
+
+
+class OperationTimestamps(BaseModel):
+    started_at: BaseTypes.OptionalDatetime = Field(
+        None, description="Started at timestamp (Optional)"
+    )
+    finished_at: BaseTypes.OptionalDatetime = Field(
+        None, description="Finished at timestamp (Optional)"
+    )
+    duration: float = Field(0, description="Operation duration")
+
+    @model_validator(mode="after")
+    def calculate_duration(self) -> Self:
+        if self.started_at is not None and self.finished_at is not None:
+            self.duration = (self.finished_at - self.started_at).total_seconds()
+
+        return self
+
+
+class OperationResult(BaseModel):
+    success: bool = Field(..., description="Success status")
+    code: BaseTypes.OptionalString = Field(None, description="Optional result code")
+    message: BaseTypes.OptionalString = Field(None, description="Optional message")
+    description: BaseTypes.OptionalString = Field(
+        None, description="Optional description"
+    )
+    data: Any = Field(..., description="Data")
+    metadata: BaseTypes.OptionalAny = Field(None, description="Optional metadata")
+    other: BaseTypes.OptionalAny = Field(None, description="Optional other information")
 
 
 class Operation(BaseModel):
+    operation_id: UUID = Field(..., description="Operation's ID")
+    summary: str = Field(..., description="Operation's summary")
     request_context: RequestContext = Field(..., description="Request context")
     authentication: Authentication = Field(..., description="Authentication")
     authorization: Optional[Authorization] = Field(None, description="Authorization")
-    service: BaseGeneralSchemas.OperationServiceContext = Field(
-        ..., description="Service's context"
+    service: ServiceContext = Field(..., description="Service's context")
+    timestamps: OperationTimestamps = Field(..., description="Operation's timestamps")
+    context: OperationContext = Field(..., description="Operation's context")
+    metadata: OperationMetadata = Field(..., description="Operation's metadata")
+    exception: Optional[OperationException] = Field(
+        None, description="Operation's exception"
     )
-    timestamps: BaseGeneralSchemas.OperationTimestamps = Field(
-        ..., description="Operation's timestamps"
+    arguments: Optional[OperationArguments] = Field(
+        None, description="Operation's arguments"
     )
-    context: BaseGeneralSchemas.OperationContext = Field(
-        ..., description="Operation's context"
+    result: Optional[OperationResult] = Field(None, description="Operation's result")
+    response_context: Optional[ResponseContext] = Field(
+        None, description="Response's context"
     )
-    metadata: BaseGeneralSchemas.OperationMetadata = Field(
-        ..., description="Operation's metadata"
-    )
-    arguments: BaseGeneralSchemas.OperationArguments = Field(
-        ..., description="Operation's arguments"
-    )
-    result: BaseGeneralSchemas.OperationResult = Field(
-        ..., description="Database operation's result"
+
+    def to_log_string(self, multiline: bool = True, indent: int = 2) -> str:
+        if not self.authentication.user.is_authenticated:
+            authentication = "Unauthenticated"
+        else:
+            authentication = (
+                "Authenticated | "
+                f"Username: {self.authentication.user.display_name} | "
+                f"Email: {self.authentication.user.identity}"
+            )
+        summary = f"Operation {self.operation_id} - {authentication} - {self.summary}"
+        payload = self.model_dump(mode="json")
+        if multiline:
+            details = f"\n{json.dumps(payload, indent=indent)}"
+        else:
+            details = f" - Details: {json.dumps(payload)}"
+        return f"{summary}{details}"
+
+
+class DatabaseOperationContext(BaseModel):
+    database: str = Field(..., description="Database name")
+    environment: BaseEnums.EnvironmentType = Field(
+        ..., description="Database environment"
     )
+    table: str = Field(..., description="Table name")
+
+
+class DatabaseOperationResult(BaseModel):
+    data_id: int = Field(..., ge=1, description="Data's ID")
+    old_data: BaseTypes.OptionalAny = Field(None, description="Old data")
+    new_data: BaseTypes.OptionalAny = Field(None, description="New data")
+
+    @model_validator(mode="after")
+    def validate_data(self) -> Self:
+        if self.old_data is None and self.new_data is None:
+            raise ValueError("Either 'old_data' or 'new_data' must have value")
+        return self
 
 
 class DatabaseOperation(BaseModel):
+    operation_id: UUID = Field(uuid4(), description="Operation's ID")
     request_context: RequestContext = Field(..., description="Request context")
     authentication: Authentication = Field(..., description="Authentication")
     authorization: Optional[Authorization] = Field(None, description="Authorization")
-    service: BaseGeneralSchemas.OperationServiceContext = Field(
-        ..., description="Service's context"
-    )
-    timestamps: BaseGeneralSchemas.OperationTimestamps = Field(
-        ..., description="Operation's timestamps"
-    )
-    context: BaseGeneralSchemas.DatabaseOperationContext = Field(
+    service: ServiceContext = Field(..., description="Service's context")
+    timestamps: OperationTimestamps = Field(..., description="Operation's timestamps")
+    context: DatabaseOperationContext = Field(
         ..., description="Database operation's context"
     )
-    metadata: BaseGeneralSchemas.OperationMetadata = Field(
-        ..., description="Operation's metadata"
-    )
-    result: BaseGeneralSchemas.DatabaseOperationResult = Field(
+    metadata: OperationMetadata = Field(..., description="Operation's metadata")
+    result: DatabaseOperationResult = Field(
         ..., description="Database operation's result"
     )

maleo_foundation/models/transfers/general/request.py

@@ -1,39 +1,33 @@
 from __future__ import annotations
-from datetime import datetime, timezone
+from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field
+from typing import List, Optional, Tuple
 from uuid import UUID
 from maleo_foundation.types import BaseTypes
+from .user_agent import UserAgent
 
 
 class RequestContext(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
-    request_id: UUID = Field(
-        ..., description="Unique identifier for tracing the request"
-    )
-    requested_at: datetime = Field(
-        datetime.now(tz=timezone.utc), description="Request timestamp"
-    )
+    request_id: UUID = Field(..., description="Request's ID")
+    requested_at: datetime = Field(..., description="Request timestamp")
     method: str = Field(..., description="Request's method")
     url: str = Field(..., description="Request's URL")
-    path_params: BaseTypes.OptionalStringToAnyDict = Field(
-        None, description="Request's path parameters"
-    )
-    query_params: BaseTypes.OptionalString = Field(
-        None, description="Request's query parameters"
-    )
     ip_address: str = Field("unknown", description="Client's IP address")
     is_internal: BaseTypes.OptionalBoolean = Field(
         None, description="True if IP is internal"
     )
-    user_agent: BaseTypes.OptionalString = Field(None, description="User-Agent string")
-    ua_browser: BaseTypes.OptionalString = Field(
-        None, description="Browser info from sec-ch-ua"
+    headers: Optional[List[Tuple[str, str]]] = Field(
+        None, description="Request's headers"
+    )
+    path_params: BaseTypes.OptionalStringToStringDict = Field(
+        None, description="Request's path parameters"
     )
-    ua_mobile: BaseTypes.OptionalString = Field(None, description="Is mobile device?")
-    platform: BaseTypes.OptionalString = Field(
-        None, description="Client platform or OS"
+    query_params: BaseTypes.OptionalString = Field(
+        None, description="Request's query parameters"
     )
+    user_agent: UserAgent = Field(..., description="User agent")
     referer: BaseTypes.OptionalString = Field(None, description="Referrer URL")
     origin: BaseTypes.OptionalString = Field(None, description="Origin of the request")
     host: BaseTypes.OptionalString = Field(None, description="Host header from request")

maleo_foundation/models/transfers/general/response.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field
+from typing import List, Optional, Tuple
+
+
+class ResponseContext(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    responded_at: datetime = Field(..., description="Respond timestamp")
+    process_time: float = Field(..., description="Process time")
+    headers: Optional[List[Tuple[str, str]]] = Field(
+        None, description="Response's headers"
+    )

maleo_foundation/models/transfers/general/service.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel, Field
+from maleo_foundation.enums import BaseEnums
+
+
+class ServiceContext(BaseModel):
+    key: BaseEnums.Service = Field(..., description="Service's key")
+    environment: BaseEnums.EnvironmentType = Field(
+        ..., description="Service's environment"
+    )

maleo_foundation/models/transfers/general/settings.py

@@ -7,7 +7,7 @@ from maleo_foundation.types import BaseTypes
 
 class Settings(BaseSettings):
     ENVIRONMENT: BaseEnums.EnvironmentType = Field(..., description="Environment")
-    SERVICE_KEY: str = Field(..., description="Service's key")
+    SERVICE_KEY: BaseEnums.Service = Field(..., description="Service's key")
     ROOT_PATH: str = Field("", description="Application's root path")
     GOOGLE_CREDENTIALS_PATH: str = Field(
         "/credentials/maleo-google-service-account.json",

maleo_foundation/models/transfers/general/user_agent.py

@@ -0,0 +1,34 @@
+from pydantic import BaseModel, Field
+from typing import Optional, Tuple
+
+
+class Browser(BaseModel):
+    family: str
+    version: Tuple[int, ...]
+    version_string: str
+
+
+class OperatingSystem(BaseModel):
+    family: str
+    version: Tuple[int, ...]
+    version_string: str
+
+
+class Device(BaseModel):
+    family: str
+    brand: Optional[str] = None
+    model: Optional[str] = None
+
+
+class UserAgent(BaseModel):
+    ua_string: str = Field(..., description="Raw User-Agent header")
+    browser: Browser = Field(..., description="Browser User-Agent")
+    os: OperatingSystem = Field(..., description="OS User-Agent")
+    device: Device = Field(..., description="Platform User-Agent")
+
+    is_mobile: bool
+    is_tablet: bool
+    is_pc: bool
+    is_bot: bool
+    is_touch_capable: bool
+    is_email_client: bool