maleo-identity 0.1.11__py3-none-any.whl → 0.1.27__py3-none-any.whl

maleo/identity/schemas/patient.py

@@ -1,6 +1,6 @@
 from datetime import date
 from pydantic import BaseModel, Field
-from typing import Generic, Literal, TypeVar, overload
+from typing import Annotated, Generic, Literal, TypeVar, overload
 from uuid import UUID
 from maleo.enums.identity import (
     OptBloodType,
@@ -28,6 +28,8 @@ from maleo.schemas.mixins.identity import (
     UUIDs,
     FullNames,
     DateOfBirth,
+    IntUserId,
+    IntUserIds,
     IntOrganizationId,
     IntOrganizationIds,
 )
@@ -44,9 +46,9 @@ from maleo.types.dict import StrToAnyDict
 from maleo.types.integer import OptListOfInts
 from maleo.types.string import OptStr, OptListOfStrs
 from maleo.types.uuid import OptListOfUUIDs
-from ..enums.patient import IdentifierType
+from ..enums.patient import IdentifierType, OptListOfExpandableFields
 from ..mixins.common import IdCard, FullName, PlaceOfBirth
-from ..mixins.patient import PatientIdentity, PatientIdentifier
+from ..mixins.patient import PatientIdentity, PatientIdentifier, Expand
 from ..types.patient import IdentifierValueType
 
 
@@ -69,26 +71,42 @@ class FullCreateData(
     pass
 
 
-class CreateParameter(FullCreateData):
+class CreateParameter(Expand, FullCreateData, IntUserId[int]):
     pass
 
 
 class ReadMultipleParameter(
+    Expand,
     ReadPaginatedMultipleParameter,
     RhesusesMixin[OptListOfRhesuses],
     BloodTypesMixin[OptListOfBloodTypes],
     GendersMixin[OptListOfGenders],
     FullNames[OptListOfStrs],
     IntOrganizationIds[OptListOfInts],
+    IntUserIds[OptListOfInts],
     UUIDs[OptListOfUUIDs],
     Ids[OptListOfInts],
 ):
+    ids: Annotated[OptListOfInts, Field(None, description="Ids")] = None
+    uuids: Annotated[OptListOfUUIDs, Field(None, description="UUIDs")] = None
+    user_ids: Annotated[OptListOfInts, Field(None, description="User's IDs")] = None
+    organization_ids: Annotated[
+        OptListOfInts, Field(None, description="Organization's IDs")
+    ] = None
+    full_names: Annotated[OptListOfStrs, Field(None, description="Full Names")] = None
+    genders: Annotated[OptListOfGenders, Field(None, description="Genders")] = None
+    blood_types: Annotated[
+        OptListOfBloodTypes, Field(None, description="Blood Types")
+    ] = None
+    rhesuses: Annotated[OptListOfRhesuses, Field(None, description="Rhesuses")] = None
+
     @property
     def _query_param_fields(self) -> set[str]:
         return {
             "ids",
             "uuids",
             "statuses",
+            "user_ids",
             "organization_ids",
             "full_names",
             "genders",
@@ -98,6 +116,7 @@ class ReadMultipleParameter(
             "page",
             "limit",
             "use_cache",
+            "expand",
         }
 
     def to_query_params(self) -> StrToAnyDict:
@@ -110,7 +129,19 @@ class ReadMultipleParameter(
         return params
 
 
-class ReadSingleParameter(BaseReadSingleParameter[PatientIdentifier]):
+class ReadSingleParameter(Expand, BaseReadSingleParameter[PatientIdentifier]):
+    @classmethod
+    def from_identifier(
+        cls,
+        identifier: PatientIdentifier,
+        statuses: ListOfDataStatuses = FULL_DATA_STATUSES,
+        use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
+    ) -> "ReadSingleParameter":
+        return cls(
+            identifier=identifier, statuses=statuses, use_cache=use_cache, expand=expand
+        )
+
     @overload
     @classmethod
     def new(
@@ -119,6 +150,7 @@ class ReadSingleParameter(BaseReadSingleParameter[PatientIdentifier]):
         identifier_value: int,
         statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
         use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
     ) -> "ReadSingleParameter": ...
     @overload
     @classmethod
@@ -128,15 +160,17 @@ class ReadSingleParameter(BaseReadSingleParameter[PatientIdentifier]):
         identifier_value: UUID,
         statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
         use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
     ) -> "ReadSingleParameter": ...
     @overload
     @classmethod
     def new(
         cls,
-        identifier_type: Literal[IdentifierType.ID_CARD, IdentifierType.PASSPORT],
-        identifier_value: str,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
         statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
         use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
     ) -> "ReadSingleParameter": ...
     @classmethod
     def new(
@@ -145,6 +179,7 @@ class ReadSingleParameter(BaseReadSingleParameter[PatientIdentifier]):
         identifier_value: IdentifierValueType,
         statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
         use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
     ) -> "ReadSingleParameter":
         return cls(
             identifier=PatientIdentifier(
@@ -153,11 +188,12 @@ class ReadSingleParameter(BaseReadSingleParameter[PatientIdentifier]):
             ),
             statuses=statuses,
             use_cache=use_cache,
+            expand=expand,
         )
 
     def to_query_params(self) -> StrToAnyDict:
         return self.model_dump(
-            mode="json", include={"statuses", "use_cache"}, exclude_none=True
+            mode="json", include={"statuses", "use_cache", "expand"}, exclude_none=True
         )
 
 
@@ -195,6 +231,7 @@ class UpdateDataMixin(BaseModel, Generic[UpdateDataT]):
 
 
 class UpdateParameter(
+    Expand,
     UpdateDataMixin[UpdateDataT],
     IdentifierMixin[PatientIdentifier],
     Generic[UpdateDataT],
@@ -206,6 +243,7 @@ class UpdateParameter(
         identifier_type: Literal[IdentifierType.ID],
         identifier_value: int,
         data: UpdateDataT,
+        expand: OptListOfExpandableFields = None,
     ) -> "UpdateParameter": ...
     @overload
     @classmethod
@@ -214,14 +252,7 @@ class UpdateParameter(
         identifier_type: Literal[IdentifierType.UUID],
         identifier_value: UUID,
         data: UpdateDataT,
-    ) -> "UpdateParameter": ...
-    @overload
-    @classmethod
-    def new(
-        cls,
-        identifier_type: Literal[IdentifierType.ID_CARD, IdentifierType.PASSPORT],
-        identifier_value: str,
-        data: UpdateDataT,
+        expand: OptListOfExpandableFields = None,
     ) -> "UpdateParameter": ...
     @overload
     @classmethod
@@ -230,6 +261,7 @@ class UpdateParameter(
         identifier_type: IdentifierType,
         identifier_value: IdentifierValueType,
         data: UpdateDataT,
+        expand: OptListOfExpandableFields = None,
     ) -> "UpdateParameter": ...
     @classmethod
     def new(
@@ -237,14 +269,17 @@ class UpdateParameter(
         identifier_type: IdentifierType,
         identifier_value: IdentifierValueType,
         data: UpdateDataT,
+        expand: OptListOfExpandableFields = None,
     ) -> "UpdateParameter":
         return cls(
             identifier=PatientIdentifier(type=identifier_type, value=identifier_value),
             data=data,
+            expand=expand,
         )
 
 
 class StatusUpdateParameter(
+    Expand,
     BaseStatusUpdateParameter[PatientIdentifier],
 ):
     @overload
@@ -254,6 +289,7 @@ class StatusUpdateParameter(
         identifier_type: Literal[IdentifierType.ID],
         identifier_value: int,
         type: ResourceOperationStatusUpdateType,
+        expand: OptListOfExpandableFields = None,
     ) -> "StatusUpdateParameter": ...
     @overload
     @classmethod
@@ -262,14 +298,7 @@ class StatusUpdateParameter(
         identifier_type: Literal[IdentifierType.UUID],
         identifier_value: UUID,
         type: ResourceOperationStatusUpdateType,
-    ) -> "StatusUpdateParameter": ...
-    @overload
-    @classmethod
-    def new(
-        cls,
-        identifier_type: Literal[IdentifierType.ID_CARD, IdentifierType.PASSPORT],
-        identifier_value: str,
-        type: ResourceOperationStatusUpdateType,
+        expand: OptListOfExpandableFields = None,
     ) -> "StatusUpdateParameter": ...
     @overload
     @classmethod
@@ -278,6 +307,7 @@ class StatusUpdateParameter(
         identifier_type: IdentifierType,
         identifier_value: IdentifierValueType,
         type: ResourceOperationStatusUpdateType,
+        expand: OptListOfExpandableFields = None,
     ) -> "StatusUpdateParameter": ...
     @classmethod
     def new(
@@ -285,10 +315,12 @@ class StatusUpdateParameter(
         identifier_type: IdentifierType,
         identifier_value: IdentifierValueType,
         type: ResourceOperationStatusUpdateType,
+        expand: OptListOfExpandableFields = None,
     ) -> "StatusUpdateParameter":
         return cls(
             identifier=PatientIdentifier(type=identifier_type, value=identifier_value),
             type=type,
+            expand=expand,
         )
 
 
@@ -305,13 +337,6 @@ class DeleteSingleParameter(BaseDeleteSingleParameter[PatientIdentifier]):
     ) -> "DeleteSingleParameter": ...
     @overload
     @classmethod
-    def new(
-        cls,
-        identifier_type: Literal[IdentifierType.ID_CARD, IdentifierType.PASSPORT],
-        identifier_value: str,
-    ) -> "DeleteSingleParameter": ...
-    @overload
-    @classmethod
     def new(
         cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
     ) -> "DeleteSingleParameter": ...

maleo/identity/schemas/user.py

@@ -60,6 +60,20 @@ class ReadMultipleParameter(
     Ids[OptListOfInts],
     IntOrganizationIds[OptListOfInts],
 ):
+    organization_ids: Annotated[
+        OptListOfInts, Field(None, description="Organization's IDs")
+    ] = None
+    ids: Annotated[OptListOfInts, Field(None, description="Ids")] = None
+    uuids: Annotated[OptListOfUUIDs, Field(None, description="UUIDs")] = None
+    user_types: Annotated[OptListOfUserTypes, Field(None, description="User Types")] = (
+        None
+    )
+    usernames: Annotated[OptListOfStrs, Field(None, description="User's Usernames")] = (
+        None
+    )
+    emails: Annotated[OptListOfStrs, Field(None, description="User's Emails")] = None
+    phones: Annotated[OptListOfStrs, Field(None, description="User's Phones")] = None
+
     @property
     def _query_param_fields(self) -> set[str]:
         return {
@@ -88,6 +102,15 @@ class ReadMultipleParameter(
 
 
 class ReadSingleParameter(BaseReadSingleParameter[UserIdentifier]):
+    @classmethod
+    def from_identifier(
+        cls,
+        identifier: UserIdentifier,
+        statuses: ListOfDataStatuses = FULL_DATA_STATUSES,
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter":
+        return cls(identifier=identifier, statuses=statuses, use_cache=use_cache)
+
     @overload
     @classmethod
     def new(

maleo/identity/schemas/user_medical_role.py

@@ -1,5 +1,5 @@
 from pydantic import BaseModel, Field
-from typing import Generic, Literal, TypeVar, overload
+from typing import Annotated, Generic, Literal, TypeVar, overload
 from uuid import UUID
 from maleo.enums.medical import (
     MedicalRole,
@@ -35,7 +35,7 @@ from maleo.types.integer import OptInt, OptListOfInts
 from maleo.types.uuid import OptListOfUUIDs
 from ..enums.user_medical_role import IdentifierType
 from ..mixins.user_medical_role import UserMedicalRoleIdentifier
-from ..types.user_medical_role import CompositeIdentifier, IdentifierValueType
+from ..types.user_medical_role import CompositeIdentifierType, IdentifierValueType
 
 
 class CreateParameter(
@@ -54,6 +54,16 @@ class ReadMultipleParameter(
     UUIDs[OptListOfUUIDs],
     Ids[OptListOfInts],
 ):
+    ids: Annotated[OptListOfInts, Field(None, description="Ids")] = None
+    uuids: Annotated[OptListOfUUIDs, Field(None, description="UUIDs")] = None
+    user_ids: Annotated[OptListOfInts, Field(None, description="User's IDs")] = None
+    organization_ids: Annotated[
+        OptListOfInts, Field(None, description="Organization's IDs")
+    ] = None
+    medical_roles: Annotated[
+        OptListOfMedicalRoles, Field(None, description="Medical Roles")
+    ] = None
+
     @property
     def _query_param_fields(self) -> set[str]:
         return {
@@ -80,6 +90,15 @@ class ReadMultipleParameter(
 
 
 class ReadSingleParameter(BaseReadSingleParameter[UserMedicalRoleIdentifier]):
+    @classmethod
+    def from_identifier(
+        cls,
+        identifier: UserMedicalRoleIdentifier,
+        statuses: ListOfDataStatuses = FULL_DATA_STATUSES,
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter":
+        return cls(identifier=identifier, statuses=statuses, use_cache=use_cache)
+
     @overload
     @classmethod
     def new(
@@ -103,7 +122,7 @@ class ReadSingleParameter(BaseReadSingleParameter[UserMedicalRoleIdentifier]):
     def new(
         cls,
         identifier_type: Literal[IdentifierType.COMPOSITE],
-        identifier_value: CompositeIdentifier,
+        identifier_value: CompositeIdentifierType,
         statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
         use_cache: bool = True,
     ) -> "ReadSingleParameter": ...
@@ -187,7 +206,7 @@ class UpdateParameter(
     def new(
         cls,
         identifier_type: Literal[IdentifierType.COMPOSITE],
-        identifier_value: CompositeIdentifier,
+        identifier_value: CompositeIdentifierType,
         data: UpdateDataT,
     ) -> "UpdateParameter": ...
     @overload
@@ -237,7 +256,7 @@ class StatusUpdateParameter(
     def new(
         cls,
         identifier_type: Literal[IdentifierType.COMPOSITE],
-        identifier_value: CompositeIdentifier,
+        identifier_value: CompositeIdentifierType,
         type: ResourceOperationStatusUpdateType,
     ) -> "StatusUpdateParameter": ...
     @overload
@@ -279,7 +298,7 @@ class DeleteSingleParameter(BaseDeleteSingleParameter[UserMedicalRoleIdentifier]
     def new(
         cls,
         identifier_type: Literal[IdentifierType.COMPOSITE],
-        identifier_value: CompositeIdentifier,
+        identifier_value: CompositeIdentifierType,
     ) -> "DeleteSingleParameter": ...
     @overload
     @classmethod

maleo/identity/schemas/user_organization_role.py

@@ -1,5 +1,5 @@
 from pydantic import BaseModel, Field
-from typing import Generic, Literal, TypeVar, overload
+from typing import Annotated, Generic, Literal, TypeVar, overload
 from uuid import UUID
 from maleo.enums.organization import (
     OrganizationRole,
@@ -35,7 +35,7 @@ from maleo.types.integer import OptInt, OptListOfInts
 from maleo.types.uuid import OptListOfUUIDs
 from ..enums.user_organization_role import IdentifierType
 from ..mixins.user_organization_role import UserOrganizationRoleIdentifier
-from ..types.user_organization_role import CompositeIdentifier, IdentifierValueType
+from ..types.user_organization_role import CompositeIdentifierType, IdentifierValueType
 
 
 class CreateParameter(
@@ -54,6 +54,16 @@ class ReadMultipleParameter(
     UUIDs[OptListOfUUIDs],
     Ids[OptListOfInts],
 ):
+    ids: Annotated[OptListOfInts, Field(None, description="Ids")] = None
+    uuids: Annotated[OptListOfUUIDs, Field(None, description="UUIDs")] = None
+    user_ids: Annotated[OptListOfInts, Field(None, description="User's IDs")] = None
+    organization_ids: Annotated[
+        OptListOfInts, Field(None, description="Organization's IDs")
+    ] = None
+    organization_roles: Annotated[
+        OptListOfOrganizationRoles, Field(None, description="Organization Roles")
+    ] = None
+
     @property
     def _query_param_fields(self) -> set[str]:
         return {
@@ -80,6 +90,15 @@ class ReadMultipleParameter(
 
 
 class ReadSingleParameter(BaseReadSingleParameter[UserOrganizationRoleIdentifier]):
+    @classmethod
+    def from_identifier(
+        cls,
+        identifier: UserOrganizationRoleIdentifier,
+        statuses: ListOfDataStatuses = FULL_DATA_STATUSES,
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter":
+        return cls(identifier=identifier, statuses=statuses, use_cache=use_cache)
+
     @overload
     @classmethod
     def new(
@@ -103,7 +122,7 @@ class ReadSingleParameter(BaseReadSingleParameter[UserOrganizationRoleIdentifier
     def new(
         cls,
         identifier_type: Literal[IdentifierType.COMPOSITE],
-        identifier_value: CompositeIdentifier,
+        identifier_value: CompositeIdentifierType,
         statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
         use_cache: bool = True,
     ) -> "ReadSingleParameter": ...
@@ -188,7 +207,7 @@ class UpdateParameter(
     def new(
         cls,
         identifier_type: Literal[IdentifierType.COMPOSITE],
-        identifier_value: CompositeIdentifier,
+        identifier_value: CompositeIdentifierType,
         data: UpdateDataT,
     ) -> "UpdateParameter": ...
     @overload
@@ -238,7 +257,7 @@ class StatusUpdateParameter(
     def new(
         cls,
         identifier_type: Literal[IdentifierType.COMPOSITE],
-        identifier_value: CompositeIdentifier,
+        identifier_value: CompositeIdentifierType,
         type: ResourceOperationStatusUpdateType,
     ) -> "StatusUpdateParameter": ...
     @overload
@@ -280,7 +299,7 @@ class DeleteSingleParameter(BaseDeleteSingleParameter[UserOrganizationRoleIdenti
     def new(
         cls,
         identifier_type: Literal[IdentifierType.COMPOSITE],
-        identifier_value: CompositeIdentifier,
+        identifier_value: CompositeIdentifierType,
     ) -> "DeleteSingleParameter": ...
     @overload
     @classmethod