maleo-identity 0.1.9__py3-none-any.whl → 0.1.10__py3-none-any.whl

maleo/identity/mixins/user_profile.py

@@ -1,6 +1,10 @@
 from pydantic import BaseModel, Field
-from typing import Annotated, Generic
+from typing import Annotated, Generic, Literal, TypeGuard
+from uuid import UUID
+from maleo.schemas.mixins.identity import Identifier
 from maleo.types.string import OptStrT
+from ..enums.user_profile import IdentifierType
+from ..types.user_profile import IdentifierValueType
 
 
 class LeadingTitle(BaseModel, Generic[OptStrT]):
@@ -39,3 +43,75 @@ class AvatarName(BaseModel, Generic[OptStrT]):
 
 class AvatarUrl(BaseModel, Generic[OptStrT]):
     avatar_url: Annotated[OptStrT, Field(..., description="User's Avatar URL")]
+
+
+class UserProfileIdentifier(Identifier[IdentifierType, IdentifierValueType]):
+    pass
+
+
+class IdUserProfileIdentifier(Identifier[Literal[IdentifierType.ID], int]):
+    type: Annotated[
+        Literal[IdentifierType.ID],
+        Field(IdentifierType.ID, description="Identifier's type"),
+    ] = IdentifierType.ID
+    value: Annotated[int, Field(..., description="Identifier's value", ge=1)]
+
+
+class UserIdUserProfileIdentifier(Identifier[Literal[IdentifierType.USER_ID], int]):
+    type: Annotated[
+        Literal[IdentifierType.USER_ID],
+        Field(IdentifierType.USER_ID, description="Identifier's type"),
+    ] = IdentifierType.USER_ID
+    value: Annotated[int, Field(..., description="Identifier's value", ge=1)]
+
+
+class UUIDUserProfileIdentifier(Identifier[Literal[IdentifierType.UUID], UUID]):
+    type: Annotated[
+        Literal[IdentifierType.UUID],
+        Field(IdentifierType.UUID, description="Identifier's type"),
+    ] = IdentifierType.UUID
+
+
+class IdCardUserProfileIdentifier(Identifier[Literal[IdentifierType.ID_CARD], str]):
+    type: Annotated[
+        Literal[IdentifierType.ID_CARD],
+        Field(IdentifierType.ID_CARD, description="Identifier's type"),
+    ] = IdentifierType.ID_CARD
+    value: Annotated[str, Field(..., description="Identifier's value", max_length=16)]
+
+
+AnyUserProfileIdentifier = (
+    UserProfileIdentifier
+    | IdUserProfileIdentifier
+    | UserIdUserProfileIdentifier
+    | UUIDUserProfileIdentifier
+    | IdCardUserProfileIdentifier
+)
+
+
+def is_id_identifier(
+    identifier: AnyUserProfileIdentifier,
+) -> TypeGuard[IdUserProfileIdentifier]:
+    return identifier.type is IdentifierType.ID and isinstance(identifier.value, int)
+
+
+def is_user_id_identifier(
+    identifier: AnyUserProfileIdentifier,
+) -> TypeGuard[UserIdUserProfileIdentifier]:
+    return identifier.type is IdentifierType.USER_ID and isinstance(
+        identifier.value, int
+    )
+
+
+def is_uuid_identifier(
+    identifier: AnyUserProfileIdentifier,
+) -> TypeGuard[UUIDUserProfileIdentifier]:
+    return identifier.type is IdentifierType.UUID and isinstance(identifier.value, UUID)
+
+
+def is_id_card_identifier(
+    identifier: AnyUserProfileIdentifier,
+) -> TypeGuard[IdCardUserProfileIdentifier]:
+    return identifier.type is IdentifierType.ID_CARD and isinstance(
+        identifier.value, str
+    )

maleo/identity/mixins/user_system_role.py

@@ -0,0 +1,63 @@
+from pydantic import Field
+from typing import Annotated, Literal, TypeGuard
+from uuid import UUID
+from maleo.schemas.mixins.identity import Identifier
+from ..enums.user_system_role import IdentifierType
+from ..types.user_system_role import CompositeIdentifier, IdentifierValueType
+
+
+class UserSystemRoleIdentifier(Identifier[IdentifierType, IdentifierValueType]):
+    pass
+
+
+class IdUserSystemRoleIdentifier(Identifier[Literal[IdentifierType.ID], int]):
+    type: Annotated[
+        Literal[IdentifierType.ID],
+        Field(IdentifierType.ID, description="Identifier's type"),
+    ] = IdentifierType.ID
+    value: Annotated[int, Field(..., description="Identifier's value", ge=1)]
+
+
+class UUIDUserSystemRoleIdentifier(Identifier[Literal[IdentifierType.UUID], UUID]):
+    type: Annotated[
+        Literal[IdentifierType.UUID],
+        Field(IdentifierType.UUID, description="Identifier's type"),
+    ] = IdentifierType.UUID
+
+
+class CompositeUserSystemRoleIdentifier(
+    Identifier[Literal[IdentifierType.COMPOSITE], CompositeIdentifier]
+):
+    type: Annotated[
+        Literal[IdentifierType.COMPOSITE],
+        Field(IdentifierType.COMPOSITE, description="Identifier's type"),
+    ] = IdentifierType.COMPOSITE
+    value: Annotated[CompositeIdentifier, Field(..., description="Identifier's value")]
+
+
+AnyUserSystemRoleIdentifier = (
+    UserSystemRoleIdentifier
+    | IdUserSystemRoleIdentifier
+    | UUIDUserSystemRoleIdentifier
+    | CompositeUserSystemRoleIdentifier
+)
+
+
+def is_id_identifier(
+    identifier: AnyUserSystemRoleIdentifier,
+) -> TypeGuard[IdUserSystemRoleIdentifier]:
+    return identifier.type is IdentifierType.ID and isinstance(identifier.value, int)
+
+
+def is_uuid_identifier(
+    identifier: AnyUserSystemRoleIdentifier,
+) -> TypeGuard[UUIDUserSystemRoleIdentifier]:
+    return identifier.type is IdentifierType.UUID and isinstance(identifier.value, UUID)
+
+
+def is_composite_identifier(
+    identifier: AnyUserSystemRoleIdentifier,
+) -> TypeGuard[CompositeUserSystemRoleIdentifier]:
+    return identifier.type is IdentifierType.COMPOSITE and isinstance(
+        identifier.value, tuple
+    )

maleo/identity/schemas/api_key.py

@@ -1,4 +1,4 @@
-from typing import Literal, Tuple, overload
+from typing import Literal, overload
 from uuid import UUID
 from maleo.enums.status import (
     ListOfDataStatuses,
@@ -23,7 +23,8 @@ from maleo.types.dict import StrToAnyDict
 from maleo.types.integer import OptInt, OptListOfInts
 from maleo.types.uuid import OptListOfUUIDs
 from ..enums.api_key import IdentifierType
-from ..types.api_key import IdentifierValueType
+from ..mixins.api_key import APIKeyIdentifier
+from ..types.api_key import CompositeIdentifier, IdentifierValueType
 
 
 class CreateParameter(
@@ -64,7 +65,7 @@ class ReadMultipleParameter(
         return params
 
 
-class ReadSingleParameter(BaseReadSingleParameter[IdentifierType, IdentifierValueType]):
+class ReadSingleParameter(BaseReadSingleParameter[APIKeyIdentifier]):
     @overload
     @classmethod
     def new(
@@ -88,7 +89,7 @@ class ReadSingleParameter(BaseReadSingleParameter[IdentifierType, IdentifierValu
     def new(
         cls,
         identifier_type: Literal[IdentifierType.COMPOSITE],
-        identifier_value: Tuple[int, OptInt],
+        identifier_value: CompositeIdentifier,
         statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
         use_cache: bool = True,
     ) -> "ReadSingleParameter": ...
@@ -110,8 +111,7 @@ class ReadSingleParameter(BaseReadSingleParameter[IdentifierType, IdentifierValu
         use_cache: bool = True,
     ) -> "ReadSingleParameter":
         return cls(
-            identifier_type=identifier_type,
-            identifier_value=identifier_value,
+            identifier=APIKeyIdentifier(type=identifier_type, value=identifier_value),
             statuses=statuses,
             use_cache=use_cache,
         )
@@ -122,7 +122,33 @@ class ReadSingleParameter(BaseReadSingleParameter[IdentifierType, IdentifierValu
         )
 
 
-class DeleteSingleParameter(
-    BaseDeleteSingleParameter[IdentifierType, IdentifierValueType]
-):
-    pass
+class DeleteSingleParameter(BaseDeleteSingleParameter[APIKeyIdentifier]):
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: Literal[IdentifierType.ID], identifier_value: int
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: Literal[IdentifierType.UUID], identifier_value: UUID
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.COMPOSITE],
+        identifier_value: CompositeIdentifier,
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter": ...
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter":
+        return cls(
+            identifier=APIKeyIdentifier(type=identifier_type, value=identifier_value)
+        )

maleo/identity/schemas/common.py

@@ -36,7 +36,7 @@ from ..mixins.api_key import APIKey
 from ..mixins.organization_registration_code import Code, CurrentUses
 from ..mixins.organization_relation import IsBidirectional, Meta
 from ..mixins.organization import Key as OrganizationKey, Name as OrganizationName
-from ..mixins.patient import PatientIdentifier
+from ..mixins.patient import PatientIdentity
 from ..mixins.user_profile import (
     LeadingTitle,
     FirstName,
@@ -67,7 +67,7 @@ class PatientSchema(
     DateOfBirth[date],
     PlaceOfBirth[OptStr],
     FullName[str],
-    PatientIdentifier,
+    PatientIdentity,
     SimpleDataStatusMixin[DataStatusEnum],
     LifecycleTimestamp,
     DataIdentifier,

maleo/identity/schemas/organization.py

@@ -15,13 +15,14 @@ from maleo.enums.status import (
 )
 from maleo.schemas.mixins.filter import convert as convert_filter
 from maleo.schemas.mixins.identity import (
-    IdentifierTypeValue,
+    IdentifierMixin,
     Ids,
     UUIDs,
     Keys,
     Names,
 )
 from maleo.schemas.mixins.sort import convert as convert_sort
+from maleo.schemas.operation.enums import ResourceOperationStatusUpdateType
 from maleo.schemas.parameter import (
     ReadSingleParameter as BaseReadSingleParameter,
     ReadPaginatedMultipleParameter,
@@ -33,7 +34,7 @@ from maleo.types.integer import OptInt, OptListOfInts
 from maleo.types.string import OptStr, OptListOfStrs
 from maleo.types.uuid import OptListOfUUIDs
 from ..enums.organization import IdentifierType
-from ..mixins.organization import Key, Name
+from ..mixins.organization import Key, Name, OrganizationIdentifier
 from ..types.organization import IdentifierValueType
 
 
@@ -81,7 +82,7 @@ class ReadMultipleParameter(
         return params
 
 
-class ReadSingleParameter(BaseReadSingleParameter[IdentifierType, IdentifierValueType]):
+class ReadSingleParameter(BaseReadSingleParameter[OrganizationIdentifier]):
     @overload
     @classmethod
     def new(
@@ -118,8 +119,9 @@ class ReadSingleParameter(BaseReadSingleParameter[IdentifierType, IdentifierValu
         use_cache: bool = True,
     ) -> "ReadSingleParameter":
         return cls(
-            identifier_type=identifier_type,
-            identifier_value=identifier_value,
+            identifier=OrganizationIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
             statuses=statuses,
             use_cache=use_cache,
         )
@@ -149,22 +151,135 @@ class UpdateDataMixin(BaseModel, Generic[UpdateDataT]):
 
 class UpdateParameter(
     UpdateDataMixin[UpdateDataT],
-    IdentifierTypeValue[
-        IdentifierType,
-        IdentifierValueType,
-    ],
+    IdentifierMixin[OrganizationIdentifier],
     Generic[UpdateDataT],
 ):
-    pass
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID],
+        identifier_value: int,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.KEY],
+        identifier_value: str,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        data: UpdateDataT,
+    ) -> "UpdateParameter":
+        return cls(
+            identifier=OrganizationIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            data=data,
+        )
 
 
 class StatusUpdateParameter(
-    BaseStatusUpdateParameter[IdentifierType, IdentifierValueType],
+    BaseStatusUpdateParameter[OrganizationIdentifier],
 ):
-    pass
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID],
+        identifier_value: int,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.KEY],
+        identifier_value: str,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter":
+        return cls(
+            identifier=OrganizationIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            type=type,
+        )
 
 
-class DeleteSingleParameter(
-    BaseDeleteSingleParameter[IdentifierType, IdentifierValueType]
-):
-    pass
+class DeleteSingleParameter(BaseDeleteSingleParameter[OrganizationIdentifier]):
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: Literal[IdentifierType.ID], identifier_value: int
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: Literal[IdentifierType.UUID], identifier_value: UUID
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.KEY],
+        identifier_value: str,
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter": ...
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter":
+        return cls(
+            identifier=OrganizationIdentifier(
+                type=identifier_type, value=identifier_value
+            )
+        )

maleo/identity/schemas/organization_registration_code.py

@@ -8,13 +8,14 @@ from maleo.enums.status import (
 from maleo.schemas.mixins.filter import convert as convert_filter
 from maleo.schemas.mixins.general import Codes
 from maleo.schemas.mixins.identity import (
-    IdentifierTypeValue,
+    IdentifierMixin,
     Ids,
     IntOrganizationId,
     IntOrganizationIds,
     UUIDs,
 )
 from maleo.schemas.mixins.sort import convert as convert_sort
+from maleo.schemas.operation.enums import ResourceOperationStatusUpdateType
 from maleo.schemas.parameter import (
     ReadSingleParameter as BaseReadSingleParameter,
     ReadPaginatedMultipleParameter,
@@ -26,7 +27,11 @@ from maleo.types.integer import OptInt, OptListOfInts
 from maleo.types.string import OptStr, OptListOfStrs
 from maleo.types.uuid import OptListOfUUIDs
 from ..enums.organization_registration_code import IdentifierType
-from ..mixins.organization_registration_code import Code, MaxUses
+from ..mixins.organization_registration_code import (
+    Code,
+    MaxUses,
+    OrganizationRegistrationCodeIdentifier,
+)
 from ..types.organization_registration_code import IdentifierValueType
 
 
@@ -76,7 +81,9 @@ class ReadMultipleParameter(
         return params
 
 
-class ReadSingleParameter(BaseReadSingleParameter[IdentifierType, IdentifierValueType]):
+class ReadSingleParameter(
+    BaseReadSingleParameter[OrganizationRegistrationCodeIdentifier]
+):
     @overload
     @classmethod
     def new(
@@ -122,8 +129,9 @@ class ReadSingleParameter(BaseReadSingleParameter[IdentifierType, IdentifierValu
         use_cache: bool = True,
     ) -> "ReadSingleParameter":
         return cls(
-            identifier_type=identifier_type,
-            identifier_value=identifier_value,
+            identifier=OrganizationRegistrationCodeIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
             statuses=statuses,
             use_cache=use_cache,
         )
@@ -151,22 +159,139 @@ class UpdateDataMixin(BaseModel, Generic[UpdateDataT]):
 
 class UpdateParameter(
     UpdateDataMixin[UpdateDataT],
-    IdentifierTypeValue[
-        IdentifierType,
-        IdentifierValueType,
-    ],
+    IdentifierMixin[OrganizationRegistrationCodeIdentifier],
     Generic[UpdateDataT],
 ):
-    pass
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID, IdentifierType.ORGANIZATION_ID],
+        identifier_value: int,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.CODE],
+        identifier_value: str,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        data: UpdateDataT,
+    ) -> "UpdateParameter":
+        return cls(
+            identifier=OrganizationRegistrationCodeIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            data=data,
+        )
 
 
 class StatusUpdateParameter(
-    BaseStatusUpdateParameter[IdentifierType, IdentifierValueType],
+    BaseStatusUpdateParameter[OrganizationRegistrationCodeIdentifier],
 ):
-    pass
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID, IdentifierType.ORGANIZATION_ID],
+        identifier_value: int,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.CODE],
+        identifier_value: str,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter":
+        return cls(
+            identifier=OrganizationRegistrationCodeIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            type=type,
+        )
 
 
 class DeleteSingleParameter(
-    BaseDeleteSingleParameter[IdentifierType, IdentifierValueType]
+    BaseDeleteSingleParameter[OrganizationRegistrationCodeIdentifier]
 ):
-    pass
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID, IdentifierType.ORGANIZATION_ID],
+        identifier_value: int,
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: Literal[IdentifierType.UUID], identifier_value: UUID
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.CODE],
+        identifier_value: str,
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter": ...
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter":
+        return cls(
+            identifier=OrganizationRegistrationCodeIdentifier(
+                type=identifier_type, value=identifier_value
+            )
+        )