maleo-identity 0.0.85__py3-none-any.whl → 0.1.24__py3-none-any.whl

maleo/identity/schemas/organization_registration_code.py

@@ -0,0 +1,314 @@
+from pydantic import BaseModel, Field
+from typing import Annotated, Generic, Literal, TypeVar, overload
+from uuid import UUID
+from maleo.enums.status import (
+    ListOfDataStatuses,
+    FULL_DATA_STATUSES,
+)
+from maleo.schemas.mixins.filter import convert as convert_filter
+from maleo.schemas.mixins.general import Codes
+from maleo.schemas.mixins.identity import (
+    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,
+    StatusUpdateParameter as BaseStatusUpdateParameter,
+    DeleteSingleParameter as BaseDeleteSingleParameter,
+)
+from maleo.types.dict import StrToAnyDict
+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 (
+    CodeOrLength,
+    Code,
+    MaxUses,
+    OrganizationRegistrationCodeIdentifier,
+)
+from ..types.organization_registration_code import IdentifierValueType
+
+
+class StandardCreateData(CodeOrLength):
+    pass
+
+
+class FullCreateData(
+    StandardCreateData,
+    IntOrganizationId[int],
+):
+    pass
+
+
+class CreateParameter(FullCreateData):
+    pass
+
+
+class ReadMultipleParameter(
+    ReadPaginatedMultipleParameter,
+    Codes[OptListOfStrs],
+    IntOrganizationIds[OptListOfInts],
+    UUIDs[OptListOfUUIDs],
+    Ids[OptListOfInts],
+):
+    ids: Annotated[OptListOfInts, Field(None, description="Ids")] = None
+    uuids: Annotated[OptListOfUUIDs, Field(None, description="UUIDs")] = None
+    organization_ids: Annotated[
+        OptListOfInts, Field(None, description="Organization's IDs")
+    ] = None
+    codes: Annotated[OptListOfStrs, Field(None, description="Codes")] = None
+
+    @property
+    def _query_param_fields(self) -> set[str]:
+        return {
+            "ids",
+            "uuids",
+            "statuses",
+            "organization_ids",
+            "codes",
+            "search",
+            "page",
+            "limit",
+            "use_cache",
+        }
+
+    def to_query_params(self) -> StrToAnyDict:
+        params = self.model_dump(
+            mode="json", include=self._query_param_fields, exclude_none=True
+        )
+        params["filters"] = convert_filter(self.date_filters)
+        params["sorts"] = convert_sort(self.sort_columns)
+        params = {k: v for k, v in params.items()}
+        return params
+
+
+class ReadSingleParameter(
+    BaseReadSingleParameter[OrganizationRegistrationCodeIdentifier]
+):
+    @classmethod
+    def from_identifier(
+        cls,
+        identifier: OrganizationRegistrationCodeIdentifier,
+        statuses: ListOfDataStatuses = FULL_DATA_STATUSES,
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter":
+        return cls(identifier=identifier, statuses=statuses, use_cache=use_cache)
+
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID, IdentifierType.ORGANIZATION_ID],
+        identifier_value: int,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.CODE],
+        identifier_value: str,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter":
+        return cls(
+            identifier=OrganizationRegistrationCodeIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            statuses=statuses,
+            use_cache=use_cache,
+        )
+
+    def to_query_params(self) -> StrToAnyDict:
+        return self.model_dump(
+            mode="json", include={"statuses", "use_cache"}, exclude_none=True
+        )
+
+
+class FullUpdateData(MaxUses[int], Code[str]):
+    pass
+
+
+class PartialUpdateData(MaxUses[OptInt], Code[OptStr]):
+    pass
+
+
+UpdateDataT = TypeVar("UpdateDataT", FullUpdateData, PartialUpdateData)
+
+
+class UpdateDataMixin(BaseModel, Generic[UpdateDataT]):
+    data: UpdateDataT = Field(..., description="Update data")
+
+
+class UpdateParameter(
+    UpdateDataMixin[UpdateDataT],
+    IdentifierMixin[OrganizationRegistrationCodeIdentifier],
+    Generic[UpdateDataT],
+):
+    @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[OrganizationRegistrationCodeIdentifier],
+):
+    @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[OrganizationRegistrationCodeIdentifier]
+):
+    @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
+            )
+        )

maleo/identity/schemas/organization_relation.py

@@ -0,0 +1,315 @@
+from pydantic import BaseModel, Field
+from typing import Annotated, Generic, Literal, TypeVar, overload
+from uuid import UUID
+from maleo.enums.organization import (
+    OrganizationRelation,
+    SimpleOrganizationRelationMixin,
+    OptListOfOrganizationRelations,
+    SimpleOrganizationRelationsMixin,
+)
+from maleo.enums.status import (
+    ListOfDataStatuses,
+    FULL_DATA_STATUSES,
+)
+from maleo.schemas.mixins.filter import convert as convert_filter
+from maleo.schemas.mixins.identity import (
+    IdentifierMixin,
+    Ids,
+    UUIDs,
+    IntSourceId,
+    IntSourceIds,
+    IntTargetId,
+    IntTargetIds,
+)
+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,
+    StatusUpdateParameter as BaseStatusUpdateParameter,
+    DeleteSingleParameter as BaseDeleteSingleParameter,
+)
+from maleo.types.boolean import OptBool
+from maleo.types.dict import StrToAnyDict
+from maleo.types.integer import OptListOfInts
+from maleo.types.uuid import OptListOfUUIDs
+from ..enums.organization_relation import IdentifierType
+from ..mixins.organization_relation import (
+    IsBidirectional,
+    Meta,
+    OrganizationRelationIdentifier,
+)
+from ..types.organization_relation import CompositeIdentifierType, IdentifierValueType
+
+
+class CreateParameter(
+    Meta,
+    IsBidirectional[bool],
+    SimpleOrganizationRelationMixin[OrganizationRelation],
+    IntTargetId[int],
+    IntSourceId[int],
+):
+    is_bidirectional: Annotated[bool, Field(False, description="Is Bidirectional")] = (
+        False
+    )
+
+
+class ReadMultipleParameter(
+    ReadPaginatedMultipleParameter,
+    SimpleOrganizationRelationsMixin[OptListOfOrganizationRelations],
+    IntTargetIds[OptListOfInts],
+    IntSourceIds[OptListOfInts],
+    UUIDs[OptListOfUUIDs],
+    Ids[OptListOfInts],
+):
+    ids: Annotated[OptListOfInts, Field(None, description="Ids")] = None
+    uuids: Annotated[OptListOfUUIDs, Field(None, description="UUIDs")] = None
+    source_ids: Annotated[OptListOfInts, Field(None, description="Source's IDs")] = None
+    target_ids: Annotated[OptListOfInts, Field(None, description="Target's IDs")] = None
+    relations: Annotated[
+        OptListOfOrganizationRelations,
+        Field(None, description="Organization Relations"),
+    ] = None
+
+    @property
+    def _query_param_fields(self) -> set[str]:
+        return {
+            "ids",
+            "uuids",
+            "statuses",
+            "source_ids",
+            "target_ids",
+            "relations",
+            "search",
+            "page",
+            "limit",
+            "use_cache",
+        }
+
+    def to_query_params(self) -> StrToAnyDict:
+        params = self.model_dump(
+            mode="json", include=self._query_param_fields, exclude_none=True
+        )
+        params["filters"] = convert_filter(self.date_filters)
+        params["sorts"] = convert_sort(self.sort_columns)
+        params = {k: v for k, v in params.items()}
+        return params
+
+
+class ReadSingleParameter(BaseReadSingleParameter[OrganizationRelationIdentifier]):
+    @classmethod
+    def from_identifier(
+        cls,
+        identifier: OrganizationRelationIdentifier,
+        statuses: ListOfDataStatuses = FULL_DATA_STATUSES,
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter":
+        return cls(identifier=identifier, statuses=statuses, use_cache=use_cache)
+
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID],
+        identifier_value: int,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.COMPOSITE],
+        identifier_value: CompositeIdentifierType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter":
+        return cls(
+            identifier=OrganizationRelationIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            statuses=statuses,
+            use_cache=use_cache,
+        )
+
+    def to_query_params(self) -> StrToAnyDict:
+        return self.model_dump(
+            mode="json", include={"statuses", "use_cache"}, exclude_none=True
+        )
+
+
+class FullUpdateData(Meta, IsBidirectional[bool]):
+    pass
+
+
+class PartialUpdateData(Meta, IsBidirectional[OptBool]):
+    pass
+
+
+UpdateDataT = TypeVar("UpdateDataT", FullUpdateData, PartialUpdateData)
+
+
+class UpdateDataMixin(BaseModel, Generic[UpdateDataT]):
+    data: UpdateDataT = Field(..., description="Update data")
+
+
+class UpdateParameter(
+    UpdateDataMixin[UpdateDataT],
+    IdentifierMixin[OrganizationRelationIdentifier],
+    Generic[UpdateDataT],
+):
+    @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.COMPOSITE],
+        identifier_value: CompositeIdentifierType,
+        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=OrganizationRelationIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            data=data,
+        )
+
+
+class StatusUpdateParameter(
+    BaseStatusUpdateParameter[OrganizationRelationIdentifier],
+):
+    @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.COMPOSITE],
+        identifier_value: CompositeIdentifierType,
+        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=OrganizationRelationIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            type=type,
+        )
+
+
+class DeleteSingleParameter(BaseDeleteSingleParameter[OrganizationRelationIdentifier]):
+    @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: CompositeIdentifierType,
+    ) -> "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=OrganizationRelationIdentifier(
+                type=identifier_type, value=identifier_value
+            )
+        )