Spaces:
Sleeping
Sleeping
File size: 5,778 Bytes
b84ea83 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 | """
Visit Model — ORM + Pydantic Schemas
ORM: Visit (SQLAlchemy table: visits)
Schemas: VisitCreate, VisitUpdate, VisitResponse, VisitListResponse
Enhanced for Ghost Shopper program:
- outlet_id: Links to the coffee-shop outlet being evaluated
- ghost_shopper: Name / initials of the Ghost Shopper
- visit_type: dine_in, take_away, drive_thru, delivery
- comments: Ghost Shopper comments (Komentar)
- suggestions: Ghost Shopper suggestions (Saran)
"""
import uuid
from datetime import datetime
from typing import Optional
from sqlalchemy import String, Text, DateTime, ForeignKey, func
from sqlalchemy.dialects.postgresql import UUID
from sqlalchemy.orm import Mapped, mapped_column, relationship
from pydantic import BaseModel, Field, ConfigDict
from models.base import Base
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
# ORM Model
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
class Visit(Base):
"""SQLAlchemy ORM model for the 'visits' table."""
__tablename__ = "visits"
id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True), primary_key=True, default=uuid.uuid4
)
title: Mapped[str] = mapped_column(String(255), nullable=False)
description: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
location: Mapped[Optional[str]] = mapped_column(String(255), nullable=True)
visit_date: Mapped[datetime] = mapped_column(DateTime, nullable=False)
status: Mapped[str] = mapped_column(
String(50), nullable=False, default="pending"
)
# ── Ghost Shopper fields (nullable for backward compatibility) ──
outlet_id: Mapped[Optional[uuid.UUID]] = mapped_column(
UUID(as_uuid=True),
ForeignKey("outlets.id", ondelete="SET NULL"),
nullable=True,
)
ghost_shopper: Mapped[Optional[str]] = mapped_column(
String(255), nullable=True,
comment="Ghost Shopper name or initials"
)
visit_type: Mapped[Optional[str]] = mapped_column(
String(50), nullable=True,
comment="dine_in, take_away, drive_thru, delivery"
)
comments: Mapped[Optional[str]] = mapped_column(
Text, nullable=True,
comment="Ghost Shopper Komentar"
)
suggestions: Mapped[Optional[str]] = mapped_column(
Text, nullable=True,
comment="Ghost Shopper Saran"
)
created_at: Mapped[datetime] = mapped_column(
DateTime, server_default=func.now()
)
updated_at: Mapped[datetime] = mapped_column(
DateTime, server_default=func.now(), onupdate=func.now()
)
# Relationships
outlet = relationship("Outlet", back_populates="visits")
checklists = relationship(
"Checklist", back_populates="visit", cascade="all, delete-orphan"
)
photos = relationship(
"Photo", back_populates="visit", cascade="all, delete-orphan"
)
assessments = relationship(
"Assessment", back_populates="visit", cascade="all, delete-orphan"
)
def __repr__(self) -> str:
return f"<Visit(id={self.id}, title='{self.title}', status='{self.status}')>"
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
# Pydantic Schemas (Request / Response)
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
class VisitCreate(BaseModel):
"""Schema for creating a new visit."""
title: str = Field(..., min_length=1, max_length=255, description="Visit title")
description: Optional[str] = Field(None, description="Visit description")
location: Optional[str] = Field(None, max_length=255, description="Visit location")
visit_date: datetime = Field(..., description="Scheduled visit date & time")
status: Optional[str] = Field("pending", description="Visit status")
outlet_id: Optional[uuid.UUID] = Field(None, description="Outlet UUID")
ghost_shopper: Optional[str] = Field(None, max_length=255, description="Ghost Shopper name")
visit_type: Optional[str] = Field(None, max_length=50, description="dine_in, take_away, etc.")
comments: Optional[str] = Field(None, description="Komentar")
suggestions: Optional[str] = Field(None, description="Saran")
class VisitUpdate(BaseModel):
"""Schema for updating an existing visit (all fields optional)."""
title: Optional[str] = Field(None, min_length=1, max_length=255)
description: Optional[str] = None
location: Optional[str] = Field(None, max_length=255)
visit_date: Optional[datetime] = None
status: Optional[str] = Field(None, max_length=50)
outlet_id: Optional[uuid.UUID] = None
ghost_shopper: Optional[str] = Field(None, max_length=255)
visit_type: Optional[str] = Field(None, max_length=50)
comments: Optional[str] = None
suggestions: Optional[str] = None
class VisitResponse(BaseModel):
"""Schema for a single visit in API responses."""
model_config = ConfigDict(from_attributes=True)
id: uuid.UUID
title: str
description: Optional[str]
location: Optional[str]
visit_date: datetime
status: str
outlet_id: Optional[uuid.UUID]
ghost_shopper: Optional[str]
visit_type: Optional[str]
comments: Optional[str]
suggestions: Optional[str]
created_at: datetime
updated_at: datetime
class VisitListResponse(BaseModel):
"""Schema for paginated visit list."""
status: str = "success"
data: list[VisitResponse]
meta: dict
|