amsdal_crm 0.1.0__py3-none-any.whl

amsdal_crm/models/__init__.py

@@ -0,0 +1,46 @@
+"""CRM Models."""
+
+# Import File first for Attachment's forward reference
+from amsdal.models.core.file import File  # noqa: F401
+
+from amsdal_crm.models.account import Account
+from amsdal_crm.models.activity import Activity
+from amsdal_crm.models.activity import ActivityRelatedTo
+from amsdal_crm.models.activity import ActivityType
+from amsdal_crm.models.activity import Call
+from amsdal_crm.models.activity import EmailActivity
+from amsdal_crm.models.activity import Event
+from amsdal_crm.models.activity import Note
+from amsdal_crm.models.activity import Task
+from amsdal_crm.models.attachment import Attachment
+from amsdal_crm.models.contact import Contact
+from amsdal_crm.models.custom_field_definition import CustomFieldDefinition
+from amsdal_crm.models.deal import Deal
+from amsdal_crm.models.pipeline import Pipeline
+from amsdal_crm.models.stage import Stage
+from amsdal_crm.models.workflow_rule import WorkflowRule
+
+__all__ = [
+    'Account',
+    'Activity',
+    'ActivityRelatedTo',
+    'ActivityType',
+    'Attachment',
+    'Call',
+    'Contact',
+    'CustomFieldDefinition',
+    'Deal',
+    'EmailActivity',
+    'Event',
+    'Note',
+    'Pipeline',
+    'Stage',
+    'Task',
+    'WorkflowRule',
+]
+
+# Rebuild models to resolve forward references
+Contact.model_rebuild()
+Deal.model_rebuild()
+Stage.model_rebuild()
+Attachment.model_rebuild()

amsdal_crm/models/account.py

@@ -0,0 +1,127 @@
+"""Account Model."""
+
+from typing import Any
+from typing import ClassVar
+
+from amsdal.contrib.auth.models.user import User
+from amsdal.models.mixins import TimestampMixin
+from amsdal_models.classes.data_models.constraints import UniqueConstraint
+from amsdal_models.classes.data_models.indexes import IndexInfo
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+
+class Account(TimestampMixin, Model):
+    """Account (Company/Organization) model.
+
+    Represents a company or organization in the CRM system.
+    Owned by individual users with permission controls.
+    """
+
+    __module_type__: ClassVar[ModuleType] = ModuleType.CONTRIB
+    __constraints__: ClassVar[list[UniqueConstraint]] = [
+        UniqueConstraint(name='unq_account_name_owner', fields=['name', 'owner_email'])
+    ]
+    __indexes__: ClassVar[list[IndexInfo]] = [
+        IndexInfo(name='idx_account_owner_email', field='owner_email'),
+        IndexInfo(name='idx_account_created_at', field='created_at'),
+    ]
+
+    # Core fields
+    name: str = Field(title='Account Name')
+    website: str | None = Field(default=None, title='Website')
+    phone: str | None = Field(default=None, title='Phone')
+    industry: str | None = Field(default=None, title='Industry')
+
+    # Address fields
+    billing_street: str | None = Field(default=None, title='Billing Street')
+    billing_city: str | None = Field(default=None, title='Billing City')
+    billing_state: str | None = Field(default=None, title='Billing State')
+    billing_postal_code: str | None = Field(default=None, title='Billing Postal Code')
+    billing_country: str | None = Field(default=None, title='Billing Country')
+
+    # Ownership
+    owner_email: str = Field(title='Owner Email')
+
+    # Custom fields (JSON)
+    custom_fields: dict[str, Any] | None = Field(default=None, title='Custom Fields')
+
+    @property
+    def display_name(self) -> str:
+        """Return display name for the account."""
+        return self.name
+
+    def has_object_permission(self, user: 'User', action: str) -> bool:
+        """Check if user has permission to perform action on this account.
+
+        Args:
+            user: The user attempting the action
+            action: The action being attempted (read, create, update, delete)
+
+        Returns:
+            True if user has permission, False otherwise
+        """
+        # Owner has all permissions
+        if self.owner_email == user.email:
+            return True
+
+        # Check admin permissions
+        if user.permissions:
+            for permission in user.permissions:
+                if permission.model == '*' and permission.action in ('*', action):
+                    return True
+                if permission.model == 'Account' and permission.action in ('*', action):
+                    return True
+
+        return False
+
+    def pre_create(self) -> None:
+        """Hook called before creating account."""
+        if self.custom_fields:
+            from amsdal_crm.services.custom_field_service import CustomFieldService
+
+            self.custom_fields = CustomFieldService.validate_custom_fields('Account', self.custom_fields)
+        super().pre_create()
+
+    async def apre_create(self) -> None:
+        """Async hook called before creating account."""
+        if self.custom_fields:
+            from amsdal_crm.services.custom_field_service import CustomFieldService
+
+            self.custom_fields = CustomFieldService.validate_custom_fields('Account', self.custom_fields)
+        await super().apre_create()
+
+    def pre_update(self) -> None:
+        """Hook called before updating account."""
+        # Validate custom fields first
+        if self.custom_fields:
+            from amsdal_crm.services.custom_field_service import CustomFieldService
+
+            self.custom_fields = CustomFieldService.validate_custom_fields('Account', self.custom_fields)
+
+        # Call parent to handle timestamps
+        super().pre_update()
+
+    async def apre_update(self) -> None:
+        """Async hook called before updating account."""
+        # Validate custom fields first
+        if self.custom_fields:
+            from amsdal_crm.services.custom_field_service import CustomFieldService
+
+            self.custom_fields = CustomFieldService.validate_custom_fields('Account', self.custom_fields)
+
+        # Call parent to handle timestamps
+        await super().apre_update()
+
+    def post_update(self) -> None:
+        """Hook called after updating account."""
+        from amsdal_crm.services.workflow_service import WorkflowService
+
+        WorkflowService.execute_rules('Account', 'update', self)
+
+    async def apost_update(self) -> None:
+        """Async hook called after updating account."""
+        from amsdal_crm.services.workflow_service import WorkflowService
+
+        WorkflowService.execute_rules('Account', 'update', self)

amsdal_crm/models/activity.py

@@ -0,0 +1,140 @@
+"""Activity Models."""
+
+from datetime import datetime
+from enum import Enum
+from typing import ClassVar
+from typing import Literal
+
+from amsdal.contrib.auth.models.user import User
+from amsdal.models.mixins import TimestampMixin
+from amsdal_models.classes.data_models.indexes import IndexInfo
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+
+class ActivityType(str, Enum):
+    """Activity type enumeration."""
+
+    TASK = 'task'
+    EVENT = 'event'
+    EMAIL = 'email'
+    NOTE = 'note'
+    CALL = 'call'
+
+
+class ActivityRelatedTo(str, Enum):
+    """What type of record this activity is related to."""
+
+    CONTACT = 'Contact'
+    ACCOUNT = 'Account'
+    DEAL = 'Deal'
+
+
+class Activity(TimestampMixin, Model):
+    """Base activity model with polymorphic related_to field.
+
+    Activities can be linked to Contacts, Accounts, or Deals using
+    a generic foreign key pattern (related_to_type + related_to_id).
+    """
+
+    __module_type__: ClassVar[ModuleType] = ModuleType.CONTRIB
+    __indexes__: ClassVar[list[IndexInfo]] = [
+        IndexInfo(name='idx_activity_related_to', field='related_to_id'),
+        IndexInfo(name='idx_activity_owner', field='owner_email'),
+        IndexInfo(name='idx_activity_created_at', field='created_at'),
+        IndexInfo(name='idx_activity_due_date', field='due_date'),
+    ]
+
+    # Discriminator
+    activity_type: ActivityType = Field(title='Activity Type')
+
+    # Core fields
+    subject: str = Field(title='Subject')
+    description: str | None = Field(default=None, title='Description')
+
+    # Polymorphic relationship (generic FK pattern)
+    related_to_type: ActivityRelatedTo = Field(title='Related To Type')
+    related_to_id: str = Field(title='Related To ID')
+
+    # Owner
+    owner_email: str = Field(title='Owner Email')
+
+    # Timing
+    due_date: datetime | None = Field(default=None, title='Due Date')
+    completed_at: datetime | None = Field(default=None, title='Completed At')
+
+    # Status
+    is_completed: bool = Field(default=False, title='Is Completed')
+
+    @property
+    def display_name(self) -> str:
+        """Return display name for the activity."""
+        return f'{self.activity_type.value}: {self.subject}'
+
+    def has_object_permission(self, user: 'User', action: str) -> bool:
+        """Check if user has permission to perform action on this activity.
+
+        Args:
+            user: The user attempting the action
+            action: The action being attempted (read, create, update, delete)
+
+        Returns:
+            True if user has permission, False otherwise
+        """
+        # Owner has all permissions
+        if self.owner_email == user.email:
+            return True
+
+        # Check admin permissions
+        if user.permissions:
+            for permission in user.permissions:
+                if permission.model == '*' and permission.action in ('*', action):
+                    return True
+                if permission.model == 'Activity' and permission.action in ('*', action):
+                    return True
+
+        return False
+
+
+class Task(Activity):
+    """Task activity with priority and status."""
+
+    activity_type: Literal[ActivityType.TASK] = Field(ActivityType.TASK, title='Activity Type')
+    priority: Literal['low', 'medium', 'high'] = Field('medium', title='Priority')
+    status: Literal['not_started', 'in_progress', 'waiting', 'completed'] = Field('not_started', title='Status')
+
+
+class Event(Activity):
+    """Event/meeting activity with start/end times."""
+
+    activity_type: Literal[ActivityType.EVENT] = Field(ActivityType.EVENT, title='Activity Type')
+    start_time: datetime = Field(title='Start Time')
+    end_time: datetime = Field(title='End Time')
+    location: str | None = Field(None, title='Location')
+
+
+class EmailActivity(Activity):
+    """Email activity with sender/recipients."""
+
+    activity_type: Literal[ActivityType.EMAIL] = Field(ActivityType.EMAIL, title='Activity Type')
+    from_address: str = Field(title='From Address')
+    to_addresses: list[str] = Field(title='To Addresses')
+    cc_addresses: list[str] | None = Field(None, title='CC Addresses')
+    body: str = Field(title='Email Body')
+    is_outbound: bool = Field(True, title='Is Outbound')
+
+
+class Note(Activity):
+    """Simple note activity."""
+
+    activity_type: Literal[ActivityType.NOTE] = Field(ActivityType.NOTE, title='Activity Type')
+
+
+class Call(Activity):
+    """Phone call activity."""
+
+    activity_type: Literal[ActivityType.CALL] = Field(ActivityType.CALL, title='Activity Type')
+    phone_number: str = Field(title='Phone Number')
+    duration_seconds: int | None = Field(None, title='Duration (seconds)')
+    call_outcome: str | None = Field(None, title='Call Outcome')

amsdal_crm/models/attachment.py

@@ -0,0 +1,43 @@
+"""Attachment Model."""
+
+import datetime as _dt
+from typing import ClassVar
+from typing import Literal
+
+from amsdal.models.core.file import File
+from amsdal_models.classes.data_models.indexes import IndexInfo
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+
+class Attachment(Model):
+    """Explicit attachment model for tracking file relationships.
+
+    Uses polymorphic relationship to link files to Contacts, Accounts,
+    Deals, or Activities.
+    """
+
+    __module_type__: ClassVar[ModuleType] = ModuleType.CONTRIB
+    __indexes__: ClassVar[list[IndexInfo]] = [
+        IndexInfo(name='idx_attachment_related_to', field='related_to_id'),
+        IndexInfo(name='idx_attachment_uploaded_at', field='uploaded_at'),
+    ]
+
+    file: File = Field(title='File')
+
+    # Polymorphic relationship
+    related_to_type: Literal['Contact', 'Account', 'Deal', 'Activity'] = Field(title='Related To Type')
+    related_to_id: str = Field(title='Related To ID')
+
+    # Metadata
+    uploaded_by: str = Field(title='Uploaded By (User Email)')
+    uploaded_at: _dt.datetime = Field(default_factory=lambda: _dt.datetime.now(_dt.UTC), title='Uploaded At')
+    description: str | None = Field(default=None, title='Description')
+
+    @property
+    def display_name(self) -> str:
+        """Return display name for the attachment."""
+        if hasattr(self.file, 'filename'):
+            return self.file.filename
+        return f'Attachment {self._object_id}'

amsdal_crm/models/contact.py

@@ -0,0 +1,132 @@
+"""Contact Model."""
+
+from typing import Any
+from typing import ClassVar
+from typing import Optional
+
+from amsdal.contrib.auth.models.user import User
+from amsdal.models.mixins import TimestampMixin
+from amsdal_models.classes.data_models.constraints import UniqueConstraint
+from amsdal_models.classes.data_models.indexes import IndexInfo
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+
+class Contact(TimestampMixin, Model):
+    """Contact (Person) model.
+
+    Represents a person in the CRM system, optionally linked to an Account.
+    Owned by individual users with permission controls.
+    """
+
+    __module_type__: ClassVar[ModuleType] = ModuleType.CONTRIB
+    __constraints__: ClassVar[list[UniqueConstraint]] = [UniqueConstraint(name='unq_contact_email', fields=['email'])]
+    __indexes__: ClassVar[list[IndexInfo]] = [
+        IndexInfo(name='idx_contact_owner_email', field='owner_email'),
+        IndexInfo(name='idx_contact_created_at', field='created_at'),
+    ]
+
+    # Core fields
+    first_name: str = Field(title='First Name')
+    last_name: str = Field(title='Last Name')
+    email: str = Field(title='Email')
+    phone: str | None = Field(default=None, title='Phone Number')
+    mobile: str | None = Field(default=None, title='Mobile Number')
+    title: str | None = Field(default=None, title='Job Title')
+
+    # Relationships
+    account: Optional['Account'] = Field(default=None, title='Account')
+    owner_email: str = Field(title='Owner Email')
+
+    # Custom fields (JSON)
+    custom_fields: dict[str, Any] | None = Field(default=None, title='Custom Fields')
+
+    @property
+    def display_name(self) -> str:
+        """Return display name for the contact."""
+        return f'{self.first_name} {self.last_name}'
+
+    @property
+    def full_name(self) -> str:
+        """Return full name of the contact."""
+        return f'{self.first_name} {self.last_name}'
+
+    def has_object_permission(self, user: 'User', action: str) -> bool:
+        """Check if user has permission to perform action on this contact.
+
+        Args:
+            user: The user attempting the action
+            action: The action being attempted (read, create, update, delete)
+
+        Returns:
+            True if user has permission, False otherwise
+        """
+        # Owner has all permissions
+        if self.owner_email == user.email:
+            return True
+
+        # Check admin permissions
+        if user.permissions:
+            for permission in user.permissions:
+                if permission.model == '*' and permission.action in ('*', action):
+                    return True
+                if permission.model == 'Contact' and permission.action in ('*', action):
+                    return True
+
+        return False
+
+    def pre_create(self) -> None:
+        """Hook called before creating contact."""
+        if self.custom_fields:
+            from amsdal_crm.services.custom_field_service import CustomFieldService
+
+            self.custom_fields = CustomFieldService.validate_custom_fields('Contact', self.custom_fields)
+        super().pre_create()
+
+    async def apre_create(self) -> None:
+        """Async hook called before creating contact."""
+        if self.custom_fields:
+            from amsdal_crm.services.custom_field_service import CustomFieldService
+
+            self.custom_fields = CustomFieldService.validate_custom_fields('Contact', self.custom_fields)
+        await super().apre_create()
+
+    def pre_update(self) -> None:
+        """Hook called before updating contact."""
+        # Validate custom fields first
+        if self.custom_fields:
+            from amsdal_crm.services.custom_field_service import CustomFieldService
+
+            self.custom_fields = CustomFieldService.validate_custom_fields('Contact', self.custom_fields)
+
+        # Call parent to handle timestamps
+        super().pre_update()
+
+    async def apre_update(self) -> None:
+        """Async hook called before updating contact."""
+        # Validate custom fields first
+        if self.custom_fields:
+            from amsdal_crm.services.custom_field_service import CustomFieldService
+
+            self.custom_fields = CustomFieldService.validate_custom_fields('Contact', self.custom_fields)
+
+        # Call parent to handle timestamps
+        await super().apre_update()
+
+    def post_update(self) -> None:
+        """Hook called after updating contact."""
+        from amsdal_crm.services.workflow_service import WorkflowService
+
+        WorkflowService.execute_rules('Contact', 'update', self)
+
+    async def apost_update(self) -> None:
+        """Async hook called after updating contact."""
+        from amsdal_crm.services.workflow_service import WorkflowService
+
+        WorkflowService.execute_rules('Contact', 'update', self)
+
+
+from amsdal_crm.models.account import Account
+
+Contact.model_rebuild()

amsdal_crm/models/custom_field_definition.py

@@ -0,0 +1,44 @@
+"""CustomFieldDefinition Model."""
+
+from typing import Any
+from typing import ClassVar
+from typing import Literal
+
+from amsdal_models.classes.data_models.constraints import UniqueConstraint
+from amsdal_models.classes.model import Model
+from amsdal_utils.models.enums import ModuleType
+from pydantic.fields import Field
+
+
+class CustomFieldDefinition(Model):
+    """Metadata about custom fields available for CRM entities.
+
+    Defines custom fields that users can add to Contacts, Accounts, or Deals.
+    Field values are stored in the entity's custom_fields JSON dict.
+    """
+
+    __module_type__: ClassVar[ModuleType] = ModuleType.CONTRIB
+    __constraints__: ClassVar[list[UniqueConstraint]] = [
+        UniqueConstraint(name='unq_custom_field_entity_name', fields=['entity_type', 'field_name'])
+    ]
+
+    entity_type: Literal['Contact', 'Account', 'Deal'] = Field(title='Entity Type')
+    field_name: str = Field(title='Field Name')
+    field_label: str = Field(title='Field Label')
+    field_type: Literal['text', 'number', 'date', 'choice'] = Field(title='Field Type')
+
+    # For choice fields
+    choices: list[str] | None = Field(default=None, title='Choices (for choice type)')
+
+    # Validation
+    is_required: bool = Field(default=False, title='Is Required')
+    default_value: Any | None = Field(default=None, title='Default Value')
+
+    # Display
+    help_text: str | None = Field(default=None, title='Help Text')
+    display_order: int = Field(default=0, title='Display Order')
+
+    @property
+    def display_name(self) -> str:
+        """Return display name for the custom field definition."""
+        return f'{self.entity_type}.{self.field_name}'