maleo-identity 0.0.52__py3-none-any.whl → 0.0.55__py3-none-any.whl

maleo_identity/client/services/user.py

@@ -66,37 +66,37 @@ class MaleoIdentityUserClientService(MaleoClientService):
             logger=self._logger,
             fail_result_class=MaleoIdentityUserClientResultsTransfers.Fail
         )
-        @BaseClientUtils.result_processor(
-            fail_class=MaleoIdentityUserClientResultsTransfers.Fail,
-            data_found_class=MaleoIdentityUserClientResultsTransfers.MultipleData,
-            no_data_class=MaleoIdentityUserClientResultsTransfers.NoData
-        )
-        @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
-            namespace=self.service_manager.configs.cache.redis.namespaces.create(
-                "user",
-                type=BaseEnums.CacheType.CLIENT,
-                base_override=self.key
-            ),
-            key_builder=BaseCacheConfigurations.key_builder,
-            skip_cache_func=lambda x: (
-                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
-                or x is None
-                or (
-                    isinstance(x, dict)
-                    and (
-                        x.get("success") in [False, None]
-                        or (x.get("success") is True and x.get("data") is None)
-                    )
-                )
-            ),
-            cache=Cache.REDIS,
-            serializer=JsonSerializer(),
-            endpoint=self.service_manager.configs.cache.redis.host,
-            port=self.service_manager.configs.cache.redis.port,
-            password=self.service_manager.configs.cache.redis.password,
-            db=self.service_manager.configs.cache.redis.db
-        )
+        # @BaseClientUtils.result_processor(
+        #     fail_class=MaleoIdentityUserClientResultsTransfers.Fail,
+        #     data_found_class=MaleoIdentityUserClientResultsTransfers.MultipleData,
+        #     no_data_class=MaleoIdentityUserClientResultsTransfers.NoData
+        # )
+        # @cached(
+        #     ttl=int(BaseEnums.CacheTTL.TTL_30MN),
+        #     namespace=self.service_manager.configs.cache.redis.namespaces.create(
+        #         "user",
+        #         type=BaseEnums.CacheType.CLIENT,
+        #         base_override=self.key
+        #     ),
+        #     key_builder=BaseCacheConfigurations.key_builder,
+        #     skip_cache_func=lambda x: (
+        #         self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+        #         or x is None
+        #         or (
+        #             isinstance(x, dict)
+        #             and (
+        #                 x.get("success") in [False, None]
+        #                 or (x.get("success") is True and x.get("data") is None)
+        #             )
+        #         )
+        #     ),
+        #     cache=Cache.REDIS,
+        #     serializer=JsonSerializer(),
+        #     endpoint=self.service_manager.configs.cache.redis.host,
+        #     port=self.service_manager.configs.cache.redis.port,
+        #     password=self.service_manager.configs.cache.redis.password,
+        #     db=self.service_manager.configs.cache.redis.db
+        # )
         async def _impl(
             parameters:MaleoIdentityUserClientParametersTransfers.GetMultiple,
             controller_type:MaleoIdentityGeneralEnums.ClientControllerType = MaleoIdentityGeneralEnums.ClientControllerType.HTTP
@@ -131,7 +131,7 @@ class MaleoIdentityUserClientService(MaleoClientService):
                     MaleoIdentityUserClientResultsTransfers
                     .Fail
                     .model_validate(controller_result.content)
-                    .model_dump(mode="json")
+                    # .model_dump(mode="json")
                 )
             else:
                 if controller_result.content["data"] is None:
@@ -139,14 +139,14 @@ class MaleoIdentityUserClientService(MaleoClientService):
                         MaleoIdentityUserClientResultsTransfers
                         .NoData
                         .model_validate(controller_result.content)
-                        .model_dump(mode="json")
+                        # .model_dump(mode="json")
                     )
                 else:
                     return (
                         MaleoIdentityUserClientResultsTransfers
                         .MultipleData
                         .model_validate(controller_result.content)
-                        .model_dump(mode="json")
+                        # .model_dump(mode="json")
                     )
         return await _impl(
             parameters=parameters,
@@ -456,37 +456,37 @@ class MaleoIdentityUserClientService(MaleoClientService):
             logger=self._logger,
             fail_result_class=MaleoIdentityUserOrganizationClientResultsTransfers.Fail
         )
-        @BaseClientUtils.result_processor(
-            fail_class=MaleoIdentityUserOrganizationClientResultsTransfers.Fail,
-            data_found_class=MaleoIdentityUserOrganizationClientResultsTransfers.MultipleData,
-            no_data_class=MaleoIdentityUserOrganizationClientResultsTransfers.NoData
-        )
-        @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
-            namespace=self.service_manager.configs.cache.redis.namespaces.create(
-                "user_organization",
-                type=BaseEnums.CacheType.CLIENT,
-                base_override=self.key
-            ),
-            key_builder=BaseCacheConfigurations.key_builder,
-            skip_cache_func=lambda x: (
-                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
-                or x is None
-                or (
-                    isinstance(x, dict)
-                    and (
-                        x.get("success") in [False, None]
-                        or (x.get("success") is True and x.get("data") is None)
-                    )
-                )
-            ),
-            cache=Cache.REDIS,
-            serializer=JsonSerializer(),
-            endpoint=self.service_manager.configs.cache.redis.host,
-            port=self.service_manager.configs.cache.redis.port,
-            password=self.service_manager.configs.cache.redis.password,
-            db=self.service_manager.configs.cache.redis.db
-        )
+        # @BaseClientUtils.result_processor(
+        #     fail_class=MaleoIdentityUserOrganizationClientResultsTransfers.Fail,
+        #     data_found_class=MaleoIdentityUserOrganizationClientResultsTransfers.MultipleData,
+        #     no_data_class=MaleoIdentityUserOrganizationClientResultsTransfers.NoData
+        # )
+        # @cached(
+        #     ttl=int(BaseEnums.CacheTTL.TTL_30MN),
+        #     namespace=self.service_manager.configs.cache.redis.namespaces.create(
+        #         "user_organization",
+        #         type=BaseEnums.CacheType.CLIENT,
+        #         base_override=self.key
+        #     ),
+        #     key_builder=BaseCacheConfigurations.key_builder,
+        #     skip_cache_func=lambda x: (
+        #         self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+        #         or x is None
+        #         or (
+        #             isinstance(x, dict)
+        #             and (
+        #                 x.get("success") in [False, None]
+        #                 or (x.get("success") is True and x.get("data") is None)
+        #             )
+        #         )
+        #     ),
+        #     cache=Cache.REDIS,
+        #     serializer=JsonSerializer(),
+        #     endpoint=self.service_manager.configs.cache.redis.host,
+        #     port=self.service_manager.configs.cache.redis.port,
+        #     password=self.service_manager.configs.cache.redis.password,
+        #     db=self.service_manager.configs.cache.redis.db
+        # )
         async def _impl(
             parameters:MaleoIdentityUserOrganizationClientParametersTransfers.GetMultipleFromUser,
             controller_type:MaleoIdentityGeneralEnums.ClientControllerType = MaleoIdentityGeneralEnums.ClientControllerType.HTTP
@@ -521,7 +521,7 @@ class MaleoIdentityUserClientService(MaleoClientService):
                     MaleoIdentityUserOrganizationClientResultsTransfers
                     .Fail
                     .model_validate(controller_result.content)
-                    .model_dump(mode="json")
+                    # .model_dump(mode="json")
                 )
             else:
                 if controller_result.content["data"] is None:
@@ -529,14 +529,14 @@ class MaleoIdentityUserClientService(MaleoClientService):
                         MaleoIdentityUserOrganizationClientResultsTransfers
                         .NoData
                         .model_validate(controller_result.content)
-                        .model_dump(mode="json")
+                        # .model_dump(mode="json")
                     )
                 else:
                     return (
                         MaleoIdentityUserOrganizationClientResultsTransfers
                         .MultipleData
                         .model_validate(controller_result.content)
-                        .model_dump(mode="json")
+                        # .model_dump(mode="json")
                     )
         return await _impl(
             parameters=parameters,
@@ -643,37 +643,37 @@ class MaleoIdentityUserClientService(MaleoClientService):
             logger=self._logger,
             fail_result_class=MaleoIdentityUserSystemRoleClientResultsTransfers.Fail
         )
-        @BaseClientUtils.result_processor(
-            fail_class=MaleoIdentityUserSystemRoleClientResultsTransfers.Fail,
-            data_found_class=MaleoIdentityUserSystemRoleClientResultsTransfers.MultipleData,
-            no_data_class=MaleoIdentityUserSystemRoleClientResultsTransfers.NoData
-        )
-        @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
-            namespace=self.service_manager.configs.cache.redis.namespaces.create(
-                "user_system_role",
-                type=BaseEnums.CacheType.CLIENT,
-                base_override=self.key
-            ),
-            key_builder=BaseCacheConfigurations.key_builder,
-            skip_cache_func=lambda x: (
-                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
-                or x is None
-                or (
-                    isinstance(x, dict)
-                    and (
-                        x.get("success") in [False, None]
-                        or (x.get("success") is True and x.get("data") is None)
-                    )
-                )
-            ),
-            cache=Cache.REDIS,
-            serializer=JsonSerializer(),
-            endpoint=self.service_manager.configs.cache.redis.host,
-            port=self.service_manager.configs.cache.redis.port,
-            password=self.service_manager.configs.cache.redis.password,
-            db=self.service_manager.configs.cache.redis.db
-        )
+        # @BaseClientUtils.result_processor(
+        #     fail_class=MaleoIdentityUserSystemRoleClientResultsTransfers.Fail,
+        #     data_found_class=MaleoIdentityUserSystemRoleClientResultsTransfers.MultipleData,
+        #     no_data_class=MaleoIdentityUserSystemRoleClientResultsTransfers.NoData
+        # )
+        # @cached(
+        #     ttl=int(BaseEnums.CacheTTL.TTL_30MN),
+        #     namespace=self.service_manager.configs.cache.redis.namespaces.create(
+        #         "user_system_role",
+        #         type=BaseEnums.CacheType.CLIENT,
+        #         base_override=self.key
+        #     ),
+        #     key_builder=BaseCacheConfigurations.key_builder,
+        #     skip_cache_func=lambda x: (
+        #         self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+        #         or x is None
+        #         or (
+        #             isinstance(x, dict)
+        #             and (
+        #                 x.get("success") in [False, None]
+        #                 or (x.get("success") is True and x.get("data") is None)
+        #             )
+        #         )
+        #     ),
+        #     cache=Cache.REDIS,
+        #     serializer=JsonSerializer(),
+        #     endpoint=self.service_manager.configs.cache.redis.host,
+        #     port=self.service_manager.configs.cache.redis.port,
+        #     password=self.service_manager.configs.cache.redis.password,
+        #     db=self.service_manager.configs.cache.redis.db
+        # )
         async def _impl():
             #* Validate chosen controller type
             if not isinstance(
@@ -705,7 +705,7 @@ class MaleoIdentityUserClientService(MaleoClientService):
                     MaleoIdentityUserSystemRoleClientResultsTransfers
                     .Fail
                     .model_validate(controller_result.content)
-                    .model_dump(mode="json")
+                    # .model_dump(mode="json")
                 )
             else:
                 if controller_result.content["data"] is None:
@@ -713,14 +713,14 @@ class MaleoIdentityUserClientService(MaleoClientService):
                         MaleoIdentityUserSystemRoleClientResultsTransfers
                         .NoData
                         .model_validate(controller_result.content)
-                        .model_dump(mode="json")
+                        # .model_dump(mode="json")
                     )
                 else:
                     return (
                         MaleoIdentityUserSystemRoleClientResultsTransfers
                         .MultipleData
                         .model_validate(controller_result.content)
-                        .model_dump(mode="json")
+                        # .model_dump(mode="json")
                     )
         return await _impl(
             parameters=parameters,
@@ -826,37 +826,37 @@ class MaleoIdentityUserClientService(MaleoClientService):
             logger=self._logger,
             fail_result_class=MaleoIdentityUserOrganizationRoleClientResultsTransfers.Fail
         )
-        @BaseClientUtils.result_processor(
-            fail_class=MaleoIdentityUserOrganizationRoleClientResultsTransfers.Fail,
-            data_found_class=MaleoIdentityUserOrganizationRoleClientResultsTransfers.MultipleData,
-            no_data_class=MaleoIdentityUserOrganizationRoleClientResultsTransfers.NoData
-        )
-        @cached(
-            ttl=int(BaseEnums.CacheTTL.TTL_30MN),
-            namespace=self.service_manager.configs.cache.redis.namespaces.create(
-                "user_organization_role",
-                type=BaseEnums.CacheType.CLIENT,
-                base_override=self.key
-            ),
-            key_builder=BaseCacheConfigurations.key_builder,
-            skip_cache_func=lambda x: (
-                self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
-                or x is None
-                or (
-                    isinstance(x, dict)
-                    and (
-                        x.get("success") in [False, None]
-                        or (x.get("success") is True and x.get("data") is None)
-                    )
-                )
-            ),
-            cache=Cache.REDIS,
-            serializer=JsonSerializer(),
-            endpoint=self.service_manager.configs.cache.redis.host,
-            port=self.service_manager.configs.cache.redis.port,
-            password=self.service_manager.configs.cache.redis.password,
-            db=self.service_manager.configs.cache.redis.db
-        )
+        # @BaseClientUtils.result_processor(
+        #     fail_class=MaleoIdentityUserOrganizationRoleClientResultsTransfers.Fail,
+        #     data_found_class=MaleoIdentityUserOrganizationRoleClientResultsTransfers.MultipleData,
+        #     no_data_class=MaleoIdentityUserOrganizationRoleClientResultsTransfers.NoData
+        # )
+        # @cached(
+        #     ttl=int(BaseEnums.CacheTTL.TTL_30MN),
+        #     namespace=self.service_manager.configs.cache.redis.namespaces.create(
+        #         "user_organization_role",
+        #         type=BaseEnums.CacheType.CLIENT,
+        #         base_override=self.key
+        #     ),
+        #     key_builder=BaseCacheConfigurations.key_builder,
+        #     skip_cache_func=lambda x: (
+        #         self.service_manager.settings.ENVIRONMENT == BaseEnums.EnvironmentType.LOCAL
+        #         or x is None
+        #         or (
+        #             isinstance(x, dict)
+        #             and (
+        #                 x.get("success") in [False, None]
+        #                 or (x.get("success") is True and x.get("data") is None)
+        #             )
+        #         )
+        #     ),
+        #     cache=Cache.REDIS,
+        #     serializer=JsonSerializer(),
+        #     endpoint=self.service_manager.configs.cache.redis.host,
+        #     port=self.service_manager.configs.cache.redis.port,
+        #     password=self.service_manager.configs.cache.redis.password,
+        #     db=self.service_manager.configs.cache.redis.db
+        # )
         async def _impl(
             parameters:MaleoIdentityUserOrganizationRoleClientParametersTransfers.GetMultipleFromUserOrOrganization,
             controller_type:MaleoIdentityGeneralEnums.ClientControllerType = MaleoIdentityGeneralEnums.ClientControllerType.HTTP
@@ -891,7 +891,7 @@ class MaleoIdentityUserClientService(MaleoClientService):
                     MaleoIdentityUserOrganizationRoleClientResultsTransfers
                     .Fail
                     .model_validate(controller_result.content)
-                    .model_dump(mode="json")
+                    # .model_dump(mode="json")
                 )
             else:
                 if controller_result.content["data"] is None:
@@ -899,14 +899,14 @@ class MaleoIdentityUserClientService(MaleoClientService):
                         MaleoIdentityUserOrganizationRoleClientResultsTransfers
                         .NoData
                         .model_validate(controller_result.content)
-                        .model_dump(mode="json")
+                        # .model_dump(mode="json")
                     )
                 else:
                     return (
                         MaleoIdentityUserOrganizationRoleClientResultsTransfers
                         .MultipleData
                         .model_validate(controller_result.content)
-                        .model_dump(mode="json")
+                        # .model_dump(mode="json")
                     )
         return await _impl(
             parameters=parameters,

maleo_identity/constants/organization_registration_code.py

@@ -0,0 +1,14 @@
+from typing import Dict
+from uuid import UUID
+from maleo_identity.enums.organization_registration_code import MaleoIdentityOrganizationRegistrationCodeEnums
+
+class MaleoIdentityOrganizationRegistrationCodeConstants:
+    IDENTIFIER_TYPE_VALUE_TYPE_MAP:Dict[
+        MaleoIdentityOrganizationRegistrationCodeEnums.IdentifierType,
+        object
+    ] = {
+        MaleoIdentityOrganizationRegistrationCodeEnums.IdentifierType.ID: int,
+        MaleoIdentityOrganizationRegistrationCodeEnums.IdentifierType.UUID: UUID,
+        MaleoIdentityOrganizationRegistrationCodeEnums.IdentifierType.ORGANIZATION_ID: int,
+        MaleoIdentityOrganizationRegistrationCodeEnums.IdentifierType.CODE: UUID
+    }

maleo_identity/enums/organization.py

@@ -7,4 +7,5 @@ class MaleoIdentityOrganizationEnums:
         KEY = "key"
 
     class ExpandableFields(StrEnum):
-        ORGANIZATION_TYPE = "organization_type"
+        ORGANIZATION_TYPE = "organization_type"
+        REGISTRATION_CODES = "registration_codes"

maleo_identity/enums/organization_registration_code.py

@@ -0,0 +1,8 @@
+from enum import StrEnum
+
+class MaleoIdentityOrganizationRegistrationCodeEnums:
+    class IdentifierType(StrEnum):
+        ID = "id"
+        UUID = "uuid"
+        ORGANIZATION_ID = "organization_id"
+        CODE = "code"

maleo_identity/models/responses/organization_registration_code.py

@@ -0,0 +1,46 @@
+from pydantic import Field
+from maleo_foundation.models.responses import BaseResponses
+from maleo_identity.enums.organization_registration_code import MaleoIdentityOrganizationRegistrationCodeEnums
+from maleo_identity.models.transfers.general.organization_registration_code import OrganizationRegistrationCodeTransfers
+
+class MaleoIdentityOrganizationRegistrationCodeResponses:
+    class InvalidIdentifierType(BaseResponses.BadRequest):
+        code:str = "IDT-ORC-001"
+        message:str = "Invalid identifier type"
+        description:str = "Invalid identifier type is given in the request"
+        other: str = f"Valid identifier types: {[f'{e.name} ({e.value})' for e in MaleoIdentityOrganizationRegistrationCodeEnums.IdentifierType]}"
+
+    class InvalidValueType(BaseResponses.BadRequest):
+        code:str = "IDT-ORC-002"
+        message:str = "Invalid value type"
+        description:str = "Invalid value type is given in the request"
+
+    class GetSingle(BaseResponses.SingleData):
+        code:str = "IDT-ORC-003"
+        message:str = "Organization registration code found"
+        description:str = "Requested organization registration code found in database"
+        data:OrganizationRegistrationCodeTransfers = Field(..., description="Organization registration code")
+
+    class GetMultiple(BaseResponses.PaginatedMultipleData):
+        code:str = "IDT-ORC-004"
+        message:str = "Organization registration codes found"
+        description:str = "Requested organization registration codes found in database"
+        data:list[OrganizationRegistrationCodeTransfers] = Field(..., description="Organization registration codes")
+
+    class CreateFailed(BaseResponses.BadRequest):
+        code:str = "IDT-ORC-005"
+        message:str = "Failed creating new organization registration code"
+
+    class CreateSuccess(BaseResponses.SingleData):
+        code:str = "IDT-ORC-006"
+        message:str = "Successfully created new organization registration code"
+        data:OrganizationRegistrationCodeTransfers = Field(..., description="Organization registration code")
+
+    class UpdateFailed(BaseResponses.BadRequest):
+        code:str = "IDT-ORC-007"
+        message:str = "Failed updating organization registration code's data"
+
+    class UpdateSuccess(BaseResponses.SingleData):
+        code:str = "IDT-ORC-008"
+        message:str = "Successfully updated organization registration code's data"
+        data:OrganizationRegistrationCodeTransfers = Field(..., description="Organization registration code")

maleo_identity/models/schemas/general.py

@@ -11,5 +11,8 @@ class MaleoIdentityGeneralSchemas:
     class OrganizationId(BaseModel):
         organization_id:int = Field(..., ge=1, description="Organization's ID")
 
+    class OptionalOrganizationId(BaseModel):
+        organization_id:BaseTypes.OptionalInteger = Field(None, ge=1, description="Optional Organization's ID")
+
     class OptionalListOfOrganizationIds(BaseModel):
         organization_ids:BaseTypes.OptionalListOfIntegers = Field(None, description="Organization's IDs")

maleo_identity/models/schemas/organization_registration_code.py

@@ -0,0 +1,21 @@
+from pydantic import BaseModel, Field
+from uuid import UUID
+from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+from maleo_foundation.models.schemas.parameter import BaseParameterSchemas
+from maleo_identity.enums.organization_registration_code import MaleoIdentityOrganizationRegistrationCodeEnums
+
+class MaleoIdentityOrganizationRegistrationCodeSchemas:
+    class IdentifierType(BaseParameterSchemas.IdentifierType):
+        identifier:MaleoIdentityOrganizationRegistrationCodeEnums.IdentifierType = Field(..., description="Organization registration code's identifier")
+
+    class Name(BaseGeneralSchemas.Name):
+        name:str = Field(..., max_length=50, description="Organization Role's name")
+
+    class Code(BaseModel):
+        code:UUID = Field(..., description="Registration code")
+
+    class MaxUses(BaseModel):
+        max_uses:int = Field(..., ge=1, description="Max code uses")
+
+    class CurrentUses(BaseModel):
+        current_uses:int = Field(..., ge=0, description="Current code uses")

maleo_identity/models/schemas/user.py

@@ -1,5 +1,6 @@
 from pydantic import BaseModel, Field
 from typing import List, Optional
+from uuid import UUID
 from maleo_foundation.models.schemas.parameter import BaseParameterSchemas
 from maleo_foundation.types import BaseTypes
 from maleo_identity.enums.user import MaleoIdentityUserEnums
@@ -11,9 +12,6 @@ class MaleoIdentityUserSchemas:
     class Expand(BaseParameterSchemas.Expand):
         expand:Optional[List[MaleoIdentityUserEnums.ExpandableFields]] = Field(None, description="Expanded field(s)")
 
-    class OptionalOrganizationId(BaseModel):
-        organization_id:BaseTypes.OptionalInteger = Field(..., ge=1, description="Organization's ID")
-
     class Username(BaseModel):
         username:str = Field(..., max_length=50, description="User's username")
 
@@ -27,10 +25,16 @@ class MaleoIdentityUserSchemas:
         emails:BaseTypes.OptionalListOfStrings = Field(None, description="Specific emails")
 
     class Phone(BaseModel):
-        phone:str = Field(..., min_length=4, max_length=15, pattern=r'^\d{4,15}$', description="User's phone")
+        phone:str = Field(..., min_length=4, max_length=15, description="User's phone")
 
     class OptionalListOfPhones(BaseModel):
         phones:BaseTypes.OptionalListOfStrings = Field(None, description="Specific phones")
 
     class Password(BaseModel):
-        password:str = Field(..., max_length=255, description="User's password")
+        password:str = Field(..., max_length=255, description="User's password")
+
+    class PasswordConfirmation(BaseModel):
+        password_confirmation:str = Field(..., max_length=255, description="User's password confirmation")
+
+    class RegistrationCode(BaseModel):
+        registration_code:UUID = Field(..., description="Registration code")

maleo_identity/models/tables/__init__.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 from .organization import OrganizationsTable
+from .organization_registration_code import OrganizationRegistrationCodesTable
 from .organization_role import OrganizationRolesTable
 from .user import UsersTable
 from .user_profile import UserProfilesTable
@@ -9,6 +10,7 @@ from .user_organization_role import UserOrganizationRolesTable
 
 class MaleoIdentityTables:
     Organization = OrganizationsTable
+    OrganizationRegistrationCode = OrganizationRegistrationCodesTable
     OrganizationRole = OrganizationRolesTable
     User = UsersTable
     UserProfile = UserProfilesTable

maleo_identity/models/tables/organization.py

@@ -29,4 +29,11 @@ class OrganizationsTable(MaleoIdentityMetadataManager.Base):
         lazy="select",
         foreign_keys="[OrganizationsTable.parent_id]",
         order_by="OrganizationsTable.id"
+    )
+    registration_code = relationship(
+        "OrganizationRegistrationCodesTable",
+        back_populates="organization",
+        cascade="all",
+        lazy="select",
+        uselist=False
     )

maleo_identity/models/tables/organization_registration_code.py

@@ -0,0 +1,29 @@
+from sqlalchemy import Column, ForeignKey
+from sqlalchemy.orm import relationship
+from sqlalchemy.types import Integer, UUID
+from uuid import uuid4
+from maleo_identity.db import MaleoIdentityMetadataManager
+
+class OrganizationRegistrationCodesTable(MaleoIdentityMetadataManager.Base):
+    __tablename__ = "organization_registration_codes"
+    #* Foreign Key OrganizationsTable
+    organization_id = Column(
+        Integer,
+        ForeignKey(
+            "organizations.id",
+            ondelete="CASCADE",
+            onupdate="CASCADE"
+        ),
+        unique=True,
+        nullable=False
+    )
+    organization = relationship(
+        "OrganizationsTable",
+        back_populates="registration_code",
+        cascade="all",
+        lazy="select",
+        uselist=False
+    )
+    code = Column(name="code", type_=UUID, default=uuid4, unique=True, nullable=False)
+    max_uses = Column(name="max_uses", type_=Integer, nullable=False, default=1)
+    current_uses = Column(name="current_uses", type_=Integer, nullable=False, default=0)

maleo_identity/models/transfers/general/organization.py

@@ -3,8 +3,10 @@ from typing import List, Optional
 from maleo_foundation.models.schemas.general import BaseGeneralSchemas
 from maleo_metadata.models.expanded_schemas.organization_type import MaleoMetadataOrganizationTypeExpandedSchemas
 from maleo_identity.models.schemas.organization import MaleoIdentityOrganizationSchemas
+from .organization_registration_code import OptionalOrganizationRegistrationCodeTransfers
 
 class OrganizationTransfers(
+    OptionalOrganizationRegistrationCodeTransfers,
     MaleoIdentityOrganizationSchemas.Name,
     MaleoIdentityOrganizationSchemas.Key,
     MaleoIdentityOrganizationSchemas.OptionalParentId,

maleo_identity/models/transfers/general/organization_registration_code.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+from maleo_identity.models.schemas.general import MaleoIdentityGeneralSchemas
+from maleo_identity.models.schemas.organization_registration_code import MaleoIdentityOrganizationRegistrationCodeSchemas
+
+class OrganizationRegistrationCodeTransfers(
+    MaleoIdentityOrganizationRegistrationCodeSchemas.CurrentUses,
+    MaleoIdentityOrganizationRegistrationCodeSchemas.MaxUses,
+    MaleoIdentityOrganizationRegistrationCodeSchemas.Code,
+    MaleoIdentityGeneralSchemas.OrganizationId,
+    BaseGeneralSchemas.Status,
+    BaseGeneralSchemas.Timestamps,
+    BaseGeneralSchemas.Identifiers
+):
+    pass
+
+class OptionalOrganizationRegistrationCodeTransfers(BaseModel):
+    registration_code:Optional[OrganizationRegistrationCodeTransfers] = Field(..., description="Registration codes")

maleo_identity/models/transfers/parameters/client/organization_registration_code.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+from maleo_foundation.models.schemas.parameter import BaseParameterSchemas
+from maleo_foundation.models.transfers.parameters.client import BaseClientParametersTransfers
+from maleo_identity.models.schemas.general import MaleoIdentityGeneralSchemas
+
+class MaleoIdentityOrganizationRegistrationCodeClientParametersTransfers:
+    class GetMultipleFromOrganization(
+        BaseClientParametersTransfers.GetPaginatedMultiple,
+        MaleoIdentityGeneralSchemas.OrganizationId
+    ): pass
+    
+    class GetMultiple(
+        BaseClientParametersTransfers.GetPaginatedMultiple,
+        MaleoIdentityGeneralSchemas.OptionalListOfOrganizationIds
+    ): pass
+
+    class GetMultipleFromOrganizationQuery(
+        BaseClientParametersTransfers.GetPaginatedMultipleQuery
+    ): pass
+
+    class GetMultipleQuery(
+        BaseClientParametersTransfers.GetPaginatedMultipleQuery,
+        MaleoIdentityGeneralSchemas.OptionalListOfOrganizationIds
+    ): pass