ipulse-shared-core-ftredge 3.2.2__tar.gz → 3.2.3__tar.gz

{ipulse_shared_core_ftredge-3.2.2/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-3.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ipulse_shared_core_ftredge
-Version: 3.2.2
+Version: 3.2.3
 Summary: Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.
 Home-page: https://github.com/TheFutureEdge/ipulse_shared_core
 Author: Russlan Ramdowar
@@ -8,7 +8,7 @@ License-File: LICENCE
 Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: pytest~=7.1
-Requires-Dist: ipulse_shared_base_ftredge>=2.2.2
+Requires-Dist: ipulse_shared_base_ftredge>=3.4.2
 Dynamic: author
 Dynamic: home-page
 Dynamic: requires-dist

{ipulse_shared_core_ftredge-3.2.2 → ipulse_shared_core_ftredge-3.2.3}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='3.2.2',
+    version='3.2.3',
     package_dir={'': 'src'},  # Specify the source directory
     packages=find_packages(where='src'),  # Look for packages in 'src'
     install_requires=[
@@ -11,7 +11,7 @@ setup(
         'pydantic[email]~=2.5',
         'python-dateutil~=2.8',
         'pytest~=7.1',
-        'ipulse_shared_base_ftredge>=2.2.2',
+        'ipulse_shared_base_ftredge>=3.4.2',
     ],
     author='Russlan Ramdowar',
     description='Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.',

{ipulse_shared_core_ftredge-3.2.2 → ipulse_shared_core_ftredge-3.2.3}/src/ipulse_shared_core_ftredge/__init__.py

@@ -1,3 +1,4 @@
 # pylint: disable=missing-module-docstring
 from .models import ( UserAuth, UserProfile,
-                     UserStatus, UserProfileUpdate)
+                     UserStatus, UserProfileUpdate,
+                     Organisation)

{ipulse_shared_core_ftredge-3.2.2 → ipulse_shared_core_ftredge-3.2.3}/src/ipulse_shared_core_ftredge/models/__init__.py

@@ -2,6 +2,7 @@ from .user_profile import UserProfile
 from .user_status import UserStatus
 from .user_profile_update import UserProfileUpdate
 from .user_auth import UserAuth
+from .organisation import Organisation
 
 
 

ipulse_shared_core_ftredge-3.2.3/src/ipulse_shared_core_ftredge/models/organisation.py

@@ -0,0 +1,87 @@
+# pylint: disable=missing-module-docstring
+# pylint: disable=missing-function-docstring
+# pylint: disable=missing-class-docstring
+# pylint: disable=broad-exception-caught
+# pylint: disable=line-too-long
+# pylint: disable=unused-variable
+# pylint: disable=broad-exception-caught
+# pylint: disable=no-self-argument  # Added for Pydantic validators
+from datetime import datetime
+from typing import Set, Optional, ClassVar
+from pydantic import BaseModel, field_validator, Field, ConfigDict
+import uuid
+import dateutil.parser
+from ipulse_shared_base_ftredge import (
+    OrganizationRelation,
+    OrganizationIndustry
+)
+
+class Organisation(BaseModel):
+    """
+    Organisation model representing business entities in the system.
+    Supports both retail and non-retail customer types with different validation rules.
+    """
+    model_config = ConfigDict(frozen=True, extra="forbid")
+    
+    # Class constants
+    VERSION: ClassVar[float] = 1.0
+    MODULE: ClassVar[str] = "core"
+    CLASS_REF: ClassVar[str] = "orgn"
+
+    # Required fields
+    puid: str = Field(
+        default_factory=lambda: f"{datetime.utcnow().strftime('%Y%m%d%H%M%S')}_{uuid.uuid4().hex[:8]}_{Organisation.MODULE}{Organisation.CLASS_REF}".lower(),
+        description="Unique identifier for the organisation"
+    )
+    name: str = Field(..., min_length=1, max_length=100)
+    relations: Set[OrganizationRelation] = Field(..., description="Organisation relations/types")
+
+    # Timestamps
+    creat_date: datetime = Field(default_factory=datetime.utcnow)
+    updt_date: datetime = Field(default_factory=datetime.utcnow)
+    
+    # Optional fields
+    creat_by_user: Optional[str] = Field(None, max_length=100)
+    updt_by_user: Optional[str] = Field(None, max_length=100)
+    description: Optional[str] = Field(None, max_length=1000)
+    industries: Optional[Set[OrganizationIndustry]] = None
+    website: Optional[str] = Field(None, max_length=200)
+    org_admin_user_uids: Optional[Set[str]] = None
+
+    @field_validator('relations')
+    @classmethod
+    def validate_relations(cls, v: Set[OrganizationRelation]) -> Set[OrganizationRelation]:
+        return v
+
+    @field_validator('industries')
+    @classmethod
+    def validate_industries(cls, v: Optional[Set[OrganizationIndustry]], info) -> Optional[Set[OrganizationIndustry]]:
+        values = info.data
+        is_retail = values.get('relations') == {OrganizationRelation.RETAIL_CUSTOMER}
+        if is_retail and v is not None:
+            raise ValueError("Industries should not be set for retail customers")
+        elif not is_retail and v is None:
+            raise ValueError("Industries required for non-retail customers")
+        return v
+
+    @field_validator('website', 'description')
+    @classmethod
+    def validate_retail_fields(cls, v: Optional[str], info) -> Optional[str]:
+        values = info.data
+        field = info.field_name
+        is_retail = values.get('relations') == {OrganizationRelation.RETAIL_CUSTOMER}
+        if is_retail and v is not None:
+            raise ValueError(f"{field} should not be set for retail customers")
+        elif not is_retail and not v:
+            raise ValueError(f"{field} required for non-retail customers")
+        return v
+
+    @field_validator('creat_date', 'updt_date', mode='before')
+    @classmethod
+    def parse_datetime(cls, v: any) -> datetime:
+        if isinstance(v, datetime):
+            return v
+        try:
+            return dateutil.parser.isoparse(v)
+        except (TypeError, ValueError) as e:
+            raise ValueError(f"Invalid datetime format: {e}")

ipulse_shared_core_ftredge-3.2.3/src/ipulse_shared_core_ftredge/models/user_auth.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel, Field, EmailStr, ConfigDict
+
+class UserAuth(BaseModel):
+    """Authentication model for user credentials"""
+    model_config = ConfigDict(extra="forbid")
+
+    email: EmailStr = Field(..., description="User's email address")
+    password: str = Field(..., min_length=6, description="User's password")
+    extra_fields: dict = Field(default_factory=dict, description="Additional authentication fields")

ipulse_shared_core_ftredge-3.2.3/src/ipulse_shared_core_ftredge/models/user_profile.py

@@ -0,0 +1,76 @@
+from datetime import datetime, date
+from typing import Set, Optional, ClassVar
+from pydantic import BaseModel, EmailStr, Field, ConfigDict
+
+class UserProfile(BaseModel):
+    """
+    User Profile model representing user information and metadata.
+    Contains both system-managed and user-editable fields.
+    """
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    # Metadata as class variables
+    VERSION: ClassVar[float] = 3.01
+    DOMAIN: ClassVar[str] = "user"
+    OBJ_REF: ClassVar[str] = "usprfl"
+    
+    # System-managed fields (read-only)
+    schema_version: float = Field(
+        default=3.01,
+        description="Version of this Class == version of DB Schema",
+        frozen=True
+    )
+    email: EmailStr = Field(
+        ...,
+        description="Propagated from Firebase Auth",
+        frozen=True
+    )
+    organizations_uids: Set[str] = Field(
+        default_factory=set,
+        description="Depends on Subscription Plan, Regularly Updated",
+        frozen=True
+    )
+    
+    # Timestamps and audit fields (read-only)
+    creat_date: datetime = Field(frozen=True)
+    creat_by_user: str = Field(frozen=True)
+    updt_date: datetime = Field(frozen=True)
+    updt_by_user: str = Field(frozen=True)
+    
+    # System identification (read-only)
+    provider_id: str = Field(frozen=True)
+    aliases: Optional[Set[str]] = Field(
+        default=None,
+        frozen=True
+    )
+    
+    # User-editable fields
+    username: Optional[str] = Field(
+        default=None,
+        max_length=50,
+        pattern="^[a-zA-Z0-9_-]+$"
+    )
+    dob: Optional[date] = Field(
+        default=None,
+        description="Date of Birth"
+    )
+    first_name: Optional[str] = Field(
+        default=None,
+        max_length=100
+    )
+    last_name: Optional[str] = Field(
+        default=None,
+        max_length=100
+    )
+    mobile: Optional[str] = Field(
+        default=None,
+        pattern=r"^\+?[1-9]\d{1,14}$",  # Added 'r' prefix for raw string
+        description="E.164 format phone number"
+    )
+
+    # Revision history (as model metadata)
+    CLASS_ORIGIN_AUTHOR: ClassVar[str] = "Russlan Ramdowar;russlan@ftredge.com"
+    CLASS_ORGIN_DATE: ClassVar[datetime] = datetime(2024, 1, 16, 20, 5)
+    CLASS_REVISION_AUTHOR: ClassVar[str] = "Russlan Ramdowar;russlan@ftredge.com"
+    CLASS_REVISION_DATE: ClassVar[datetime] = datetime(2024, 2, 13, 20, 15)
+    LAST_MODIFICATION: ClassVar[str] = "Updated to Pydantic v2 with improved validation"

ipulse_shared_core_ftredge-3.2.3/src/ipulse_shared_core_ftredge/models/user_profile_update.py

@@ -0,0 +1,45 @@
+from typing import Optional, Set, ClassVar
+from pydantic import BaseModel, Field, EmailStr, ConfigDict
+from datetime import date, datetime
+
+class UserProfileUpdate(BaseModel):
+    """
+    User Profile Update model for partial updates of user information.
+    All fields are optional to support partial updates.
+    """
+    model_config = ConfigDict(extra="forbid")
+
+    # Metadata as class variables
+    VERSION: ClassVar[float] = 2.01
+    CLASS_ORIGIN_AUTHOR: ClassVar[str] = "Russlan Ramdowar;russlan@ftredge.com"
+    CLASS_ORGIN_DATE: ClassVar[datetime] = datetime(2024, 3, 15, 20, 15)
+    CLASS_REVISION_DATE: ClassVar[datetime] = datetime(2024, 3, 15, 20, 15)
+
+    # System fields
+    schema_version: Optional[float] = Field(None, description="Version of this Class == version of DB Schema")
+    email: Optional[EmailStr] = Field(None, description="Propagated from Firebase Auth")
+    organizations_uids: Optional[Set[str]] = Field(None, description="Organization memberships")
+    
+    # Timestamps and audit
+    creat_date: Optional[datetime] = None
+    creat_by_user: Optional[str] = None
+    updt_date: Optional[datetime] = None
+    updt_by_user: Optional[str] = None
+    
+    # System identification
+    aliases: Optional[Set[str]] = None
+    provider_id: Optional[str] = None
+
+    # User-editable fields
+    username: Optional[str] = Field(None, max_length=50, pattern=r"^[a-zA-Z0-9_-]+$")
+    dob: Optional[date] = None
+    first_name: Optional[str] = Field(None, max_length=100)
+    last_name: Optional[str] = Field(None, max_length=100)
+    mobile: Optional[str] = Field(None, pattern=r"^\+?[1-9]\d{1,14}$")
+
+    def model_dump(self, **kwargs):
+        kwargs.setdefault('exclude_none', True)
+        return super().model_dump(**kwargs)
+
+
+

ipulse_shared_core_ftredge-3.2.3/src/ipulse_shared_core_ftredge/models/user_status.py

@@ -0,0 +1,93 @@
+from datetime import datetime
+from dateutil.relativedelta import relativedelta
+from typing import Set, Optional, Dict, List, ClassVar
+from pydantic import BaseModel, Field, ConfigDict
+
+# ORIGINAL AUTHOR ="Russlan Ramdowar;russlan@ftredge.com"
+CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
+
+SCHEMA_VERSION = 2.3
+CLASS_REVISION_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
+CLASS_REVISION_DATE=datetime(2024, 2, 13, 20, 15)
+LAST_MODIFICATION="Changed default IAM_GROUPS"
+
+DOMAIN="user"
+OBJ_REF = "usrsttus"
+
+DEFAULT_IAM_GROUPS={"pulseroot":["full_open_read"]}
+DEFAULT_SUBSCRIPTION_PLAN="subscription_free"
+DEFAULT_SUBSCRIPTION_STATUS="active"
+DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS=10
+DEFAULT_EXTRA_INSIGHT_CREDITS=0
+
+############################################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! ############################################
+class UserStatus(BaseModel):
+    """
+    User Status model for tracking user subscription and access rights.
+    """
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    # Class constants
+    VERSION: ClassVar[float] = 2.3
+    DOMAIN: ClassVar[str] = "user"
+    OBJ_REF: ClassVar[str] = "usrsttus"
+    
+    # Default values as class variables
+    DEFAULT_IAM_GROUPS: ClassVar[Dict[str, List[str]]] = {"pulseroot": ["full_open_read"]}
+    DEFAULT_SUBSCRIPTION_PLAN: ClassVar[str] = "subscription_free"
+    DEFAULT_SUBSCRIPTION_STATUS: ClassVar[str] = "active"
+    DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS: ClassVar[int] = 10
+    DEFAULT_EXTRA_INSIGHT_CREDITS: ClassVar[int] = 0
+
+    # System-managed fields
+    schema_version: float = Field(
+        default=2.3,
+        description="Version of this Class == version of DB Schema"
+    )
+    
+    # IAM and subscription fields
+    iam_groups: Dict[str, List[str]] = Field(
+        default_factory=lambda: UserStatus.DEFAULT_IAM_GROUPS,
+        description="User's Groups, with a default one for all authenticated Pulse users"
+    )
+    sbscrptn_plan: str = Field(
+        default_factory=lambda: UserStatus.DEFAULT_SUBSCRIPTION_PLAN,
+        description="Subscription Plan"
+    )
+    sbscrptn_status: str = Field(
+        default_factory=lambda: UserStatus.DEFAULT_SUBSCRIPTION_STATUS,
+        description="Subscription Status"
+    )
+    
+    # Subscription dates
+    sbscrptn_start_date: datetime = Field(
+        default_factory=datetime.utcnow,
+        description="Subscription Start Date"
+    )
+    sbscrptn_end_date: datetime = Field(
+        default_factory=lambda: datetime.utcnow() + relativedelta(years=1),
+        description="Subscription End Date"
+    )
+    
+    # Credits management
+    sbscrptn_insight_credits: int = Field(
+        default_factory=lambda: UserStatus.DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS,
+        description="Subscription-based insight credits"
+    )
+    sbscrptn_ins_crdts_updtd_since_datetime: datetime = Field(
+        default_factory=datetime.utcnow,
+        description="Last update timestamp for subscription credits"
+    )
+    extra_insight_credits: int = Field(
+        default_factory=lambda: UserStatus.DEFAULT_EXTRA_INSIGHT_CREDITS,
+        description="Additional purchased insight credits (non-expiring)"
+    )
+    
+    # Optional fields
+    payment_refs_uids: Optional[Set[str]] = None
+    
+    # Audit fields
+    creat_date: datetime
+    creat_by_user: str
+    updt_date: datetime
+    updt_by_user: str

{ipulse_shared_core_ftredge-3.2.2 → ipulse_shared_core_ftredge-3.2.3/src/ipulse_shared_core_ftredge.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ipulse_shared_core_ftredge
-Version: 3.2.2
+Version: 3.2.3
 Summary: Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.
 Home-page: https://github.com/TheFutureEdge/ipulse_shared_core
 Author: Russlan Ramdowar
@@ -8,7 +8,7 @@ License-File: LICENCE
 Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: pytest~=7.1
-Requires-Dist: ipulse_shared_base_ftredge>=2.2.2
+Requires-Dist: ipulse_shared_base_ftredge>=3.4.2
 Dynamic: author
 Dynamic: home-page
 Dynamic: requires-dist

{ipulse_shared_core_ftredge-3.2.2 → ipulse_shared_core_ftredge-3.2.3}/src/ipulse_shared_core_ftredge.egg-info/requires.txt

@@ -1,4 +1,4 @@
 pydantic[email]~=2.5
 python-dateutil~=2.8
 pytest~=7.1
-ipulse_shared_base_ftredge>=2.2.2
+ipulse_shared_base_ftredge>=3.4.2

ipulse_shared_core_ftredge-3.2.2/src/ipulse_shared_core_ftredge/models/organisation.py

@@ -1,71 +0,0 @@
-# pylint: disable=missing-module-docstring
-# pylint: disable=missing-function-docstring
-# pylint: disable=missing-class-docstring
-# pylint: disable=broad-exception-caught
-# pylint: disable=line-too-long
-# pylint: disable=unused-variable
-# pylint: disable=broad-exception-caught
-# from pydantic import BaseModel, validator, ValidationError, Field
-# from typing import Set, Optional
-# import uuid
-# from datetime import datetime
-# import dateutil.parser
-
-# CLASS_VERSION= 1.0
-# MODULE= "core"
-# CLASS_REF="orgn"
-
-
-# class Organisation(BaseModel):
-#     puid: str = Field(default_factory=f"{datetime.utcnow().strftime('%Y%m%d%H%M')}{uuid.uuid4().hex[:8]}_{MODULE}{CLASS_REF}".lower())
-#     name: str
-#     creat_date: datetime = Field(default_factory=datetime.utcnow()) 
-#     updt_date: datetime = Field(default_factory=datetime.utcnow())
-#     creat_by_user: Optional[str] = None 
-#     updt_by_user: Optional[str] = None
-#     relations: Optional[Set[str]]=None
-#     description: Optional[str] = None  # Updated to use Optional
-#     industries: Optional[Set[str]] = None  # Updated to use Optional
-#     website: Optional[str] = None  # Updated to use Optional
-#     org_admin_user_uids: Optional[Set[str]] = None  # Updated to use Optional
-#     class Config:
-#             extra = "forbid"
-
-
-    # @validator('relations', pre=True, always=True)
-    # def validate_relations(cls, relations):
-    #     if not set(relations).issubset(enums.organisation_relations):
-    #         raise ValueError("Invalid relation values provided.")
-    #     return relations
-
-   
-    # @validator('industries', pre=True, always=True)
-    # def validate_industries(cls, industries):
-    #     if industries is not None and not set(industries).issubset(enums.organisation_industries):
-    #         raise ValueError("Invalid industry values provided.")
-    #     return industries
-    
-    # @validator('creat_date', 'updt_date', pre=True)
-    # def parse_date(cls, value):
-    #     if value is None:
-    #         return value
-    #     if isinstance(value, datetime):
-    #         return value
-    #     try:
-    #         # Assuming Firestore returns an ISO 8601 string, adjust if necessary
-    #         print("Putting Updt or Creat date in a valid format in a Validator when creating Organisation object")
-    #         return dateutil.parser.isoparse(value)
-    #     except (TypeError, ValueError):
-    #         raise ValidationError(f"Invalid datetime format inside Organisation: {value}")
-
-
-    # ### Description, Industries, and Website are optional for Retail Customer and mandatory for Non Retail Customer
-    # @validator('description', 'industries', 'website', pre=True, always=True)
-    # def validate_optional_fields(cls, value, values):
-    #     if values.get('name') == 'Retail Customer' and values.get('relations') == {"retail_customer"} or  values.get('relations') == ["retail_customer"]:
-    #         if value is not None:
-    #             raise ValueError("For 'Retail Customer' with only 'retail_customer' relations, description, industries, and website should not be provided.")
-    #     else:
-    #         if value is None:
-    #             raise ValueError("For Non Retail Customer, description, industries, and website are mandatory.")
-    #     return value

ipulse_shared_core_ftredge-3.2.2/src/ipulse_shared_core_ftredge/models/user_auth.py

@@ -1,6 +0,0 @@
-from pydantic import BaseModel
-
-class UserAuth(BaseModel):
-    email: str
-    password: str
-    extra_fields: dict = {}

ipulse_shared_core_ftredge-3.2.2/src/ipulse_shared_core_ftredge/models/user_profile.py

@@ -1,41 +0,0 @@
-from pydantic import BaseModel, EmailStr , Field
-from datetime import datetime , date
-
-from typing import Set, Optional
-# import uuid
-# from . import pulse_enums as enums
-
-CLASS_ORIGIN_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
-CLASS_ORGIN_DATE=datetime(2024, 1, 16, 20, 5)
-
-CLASS_VERSION = 3.01
-CLASS_REVISION_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
-CLASS_REVISION_DATE=datetime(2024, 2, 13, 20, 15)
-LAST_MODIFICATION="Fixed typo"
-
-
-DOMAIN="user"
-OBJ_REF = "usprfl"
-
-class UserProfile(BaseModel):
-    schema_version: float = Field(default=CLASS_VERSION, description="Version of this Class == version of DB Schema") #User can Read only
-    # uid: str = Field(frozen=True, description="Combination of user_usrprof_<Firebase Auth UID>") #User can Read only ---> STORED as Firestore Doc ID
-    # puid:str = Field(default_factory=lambda: f"{DOMAIN}{OBJ_REF}{datetime.utcnow().strftime('%Y%m%d%H%M')}{uuid.uuid4().hex[:8]}".lower(),
-    #                   frozen=True, 
-    #                   description="Generated Automatically by default_factory") #User can Read only
-    email: EmailStr =  Field(frozen=True, description="Propagated from Firebase Auth" ) #User can Read only
-    organizations_uids: Set[str] = Field( description="Depends on Subscription Plan, Regularly Updated") #User can Read only  
-    creat_date: datetime #User can Read only
-    creat_by_user: str #User can Read only
-    updt_date: datetime #User can Read only
-    updt_by_user: str #User can Read only
-    aliases: Optional[Set[str]] = None #User can Read only
-    provider_id: str   #User can Read only
-    
-    username: Optional[str] = None #User can Read and Edit
-    dob: Optional[date] = None #User can Read and Edit
-    first_name: Optional[str] = None #User can Read and Edit
-    last_name: Optional[str] = None #User can Read and Edit
-    mobile: Optional[str] = None #User can Read and Edit
-    class Config:
-        extra = "forbid"

ipulse_shared_core_ftredge-3.2.2/src/ipulse_shared_core_ftredge/models/user_profile_update.py

@@ -1,36 +0,0 @@
-from typing import Optional, Set
-from pydantic import BaseModel, Field, EmailStr
-from datetime import date, datetime
-
-
-CLASS_ORIGIN_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
-CLASS_ORGIN_DATE=datetime(2024, 3, 15, 20, 15)
-
-CLASS_VERSION = 2.01
-CLASS_REVISION_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
-CLASS_REVISION_DATE=datetime(2024, 3, 15, 20, 15)
-LAST_MODIFICATION="Created , with all fields Optional"
-
-class UserProfileUpdate(BaseModel):
-    schema_version: Optional[float] = Field(None, description="Version of this Class == version of DB Schema")
-    email: Optional[EmailStr] = Field(None, description="Propagated from Firebase Auth")
-    organizations_uids: Optional[Set[str]] = Field(None, description="Depends on Subscription Plan, Regularly Updated")
-    creat_date: Optional[datetime] = Field(None, description="Creation date")
-    creat_by_user: Optional[str] = Field(None, description="Created by user")
-    updt_date: Optional[datetime] = Field(None, description="Update date")
-    updt_by_user: Optional[str] = Field(None, description="Updated by user")
-    aliases: Optional[Set[str]] = Field(None, description="User aliases")
-    provider_id: Optional[str] = Field(None, description="Provider ID")
-
-    username: Optional[str] = Field(None, description="Username")
-    dob: Optional[date] = Field(None, description="Date of Birth")
-    first_name: Optional[str] = Field(None, description="First Name")
-    last_name: Optional[str] = Field(None, description="Last Name")
-    mobile: Optional[str] = Field(None, description="Mobile Number")
-    
-    # def model_dump(self, **kwargs):
-    #         return super().model_dump(exclude_none=True, **kwargs)
-        
-        
-        
-        

ipulse_shared_core_ftredge-3.2.2/src/ipulse_shared_core_ftredge/models/user_status.py

@@ -1,51 +0,0 @@
-from pydantic import BaseModel, Field
-
-from datetime import datetime
-from dateutil.relativedelta import relativedelta
-from typing import Set, Optional, Dict, List
-
-
-
-
-CLASS_ORIGIN_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
-CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
-
-SCHEMA_VERSION = 2.3
-CLASS_REVISION_AUTHOR="Russlan Ramdowar;russlan@ftredge.com"
-CLASS_REVISION_DATE=datetime(2024, 2, 13, 20, 15)
-LAST_MODIFICATION="Changed default IAM_GROUPS"
-
-DOMAIN="user"
-OBJ_REF = "usrsttus"
-
-DEFAULT_IAM_GROUPS={"pulseroot":["full_open_read"]}
-DEFAULT_SUBSCRIPTION_PLAN="subscription_free"
-DEFAULT_SUBSCRIPTION_STATUS="active"
-DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS=10
-DEFAULT_EXTRA_INSIGHT_CREDITS=0
-
-############################################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! ############################################
-class UserStatus(BaseModel):
-    schema_version: float = Field(default=SCHEMA_VERSION, description="Version of this Class == version of DB Schema") #User can Read only
-    # uid: str = Field(frozen=True, description="Generated by Firebase Auth") #User can Read only
-    # puid:str = Field(default_factory=lambda: f"{DOMAIN}{OBJ_REF}{datetime.utcnow().strftime('%Y%m%d%H%M')}{uuid.uuid4().hex[:8]}".lower(),
-    #                   frozen=True, 
-    #                   description="Generated Automatically by default_factory") #User can Read only
-    
-    iam_groups: Dict[str, List[str]] = Field(default_factory=lambda:DEFAULT_IAM_GROUPS, description="User's Groups, with a default one for all authenticated Pulse users") #User can Read only
-    sbscrptn_plan: str=Field(default_factory=lambda:DEFAULT_SUBSCRIPTION_PLAN, description="Subscription Plan ") #User can Read only
-    sbscrptn_status: str=Field(default_factory=lambda:DEFAULT_SUBSCRIPTION_STATUS, description="Subscription Status") #User can Read only
-    sbscrptn_start_date: datetime=Field(default_factory=lambda:datetime.utcnow(), description="Subscription Start Date") #User can Read only
-    sbscrptn_end_date: datetime=Field(default_factory=lambda:datetime.utcnow()+relativedelta(years=1) , description="Subscription End Date") #User can Read only
-    sbscrptn_insight_credits: int= Field(default_factory=lambda:DEFAULT_SUBSCRIPTION_INSIGHT_CREDITS, description="Depends on Subscription Plan, Set Amount udated at Regular Intervals or at Regular Time") #User can Read only
-    sbscrptn_ins_crdts_updtd_since_datetime: datetime=Field(default_factory=lambda:datetime.utcnow(), description="Subscription Start Date") #User can Read only #User can Read only #User can Read only
-    extra_insight_credits: int= Field(default_factory=lambda:DEFAULT_EXTRA_INSIGHT_CREDITS, description="If user purchased extra Insigth Credits they shouldn't Expire") #User can Read only
-    payment_refs_uids: Optional[Set[str]] = None #User can Read only
-    
-    creat_date: datetime #User can Read only
-    creat_by_user: str #User can Read only / Ideally shouldn't be able to see even
-    updt_date: datetime #User can Read only / Ideally shouldn't be able to see even
-    updt_by_user: str #User can Read only / Ideally shouldn't be able to see even
-    
-    class Config:
-        extra = "forbid"