TorbatYar/backend/services/experience/app/api/v1/surveys.py
Mortezakoohjani 203671a7bf feat(experience): ship Experience Platform phases 11.0-11.10
Add the experience service with sites through analytics/AI hooks, migrations through 0011, and phase docs/manifests marking the track complete.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-27 11:43:10 +03:30

114 lines
3.8 KiB
Python

"""Survey definition APIs — Phase 11.6."""
from __future__ import annotations
from uuid import UUID
from fastapi import APIRouter, Depends, Query, status
from sqlalchemy.ext.asyncio import AsyncSession
from app.api.deps import get_db, get_pagination, require_tenant
from app.api.permissions import require_permissions
from app.commands.forms import FormsCommands
from app.permissions.definitions import (
SURVEYS_CREATE,
SURVEYS_DELETE,
SURVEYS_UPDATE,
SURVEYS_VIEW,
)
from app.queries.forms import FormsQueries
from app.schemas.forms import (
ExperienceSurveyCreate,
ExperienceSurveyListResponse,
ExperienceSurveyRead,
ExperienceSurveyUpdate,
)
from app.specifications.forms import SURVEY_SORT_FIELDS, SurveyListSpec
from shared.pagination import PaginationParams
from shared.security import CurrentUser
router = APIRouter()
_STATUSES = {"draft", "active", "archived"}
def _list_spec(
workspace_id: UUID | None = Query(default=None),
site_id: UUID | None = Query(default=None),
page_id: UUID | None = Query(default=None),
status_filter: str | None = Query(default=None, alias="status"),
q: str | None = Query(default=None, max_length=100),
sort_by: str = Query(default="created_at"),
sort_dir: str = Query(default="desc", pattern="^(?i)(asc|desc)$"),
) -> SurveyListSpec:
if sort_by not in SURVEY_SORT_FIELDS:
sort_by = "created_at"
return SurveyListSpec(
workspace_id=workspace_id,
site_id=site_id,
page_id=page_id,
status=status_filter if status_filter in _STATUSES else None,
q=q,
sort_by=sort_by,
sort_dir=sort_dir.lower(),
)
@router.post(
"", response_model=ExperienceSurveyRead, status_code=status.HTTP_201_CREATED
)
async def create_survey(
body: ExperienceSurveyCreate,
tenant_id: UUID = Depends(require_tenant),
db: AsyncSession = Depends(get_db),
user: CurrentUser = Depends(require_permissions(SURVEYS_CREATE)),
):
return await FormsCommands(db).create_survey(tenant_id, body, actor=user)
@router.get("", response_model=ExperienceSurveyListResponse)
async def list_surveys(
tenant_id: UUID = Depends(require_tenant),
pagination: PaginationParams = Depends(get_pagination),
spec: SurveyListSpec = Depends(_list_spec),
db: AsyncSession = Depends(get_db),
_user: CurrentUser = Depends(require_permissions(SURVEYS_VIEW)),
):
items, total = await FormsQueries(db).list_surveys(
tenant_id, offset=pagination.offset, limit=pagination.page_size, spec=spec
)
return ExperienceSurveyListResponse(
items=items, total=total, page=pagination.page, page_size=pagination.page_size
)
@router.get("/{survey_id}", response_model=ExperienceSurveyRead)
async def get_survey(
survey_id: UUID,
tenant_id: UUID = Depends(require_tenant),
db: AsyncSession = Depends(get_db),
_user: CurrentUser = Depends(require_permissions(SURVEYS_VIEW)),
):
return await FormsQueries(db).get_survey(tenant_id, survey_id)
@router.patch("/{survey_id}", response_model=ExperienceSurveyRead)
async def update_survey(
survey_id: UUID,
body: ExperienceSurveyUpdate,
tenant_id: UUID = Depends(require_tenant),
db: AsyncSession = Depends(get_db),
user: CurrentUser = Depends(require_permissions(SURVEYS_UPDATE)),
):
return await FormsCommands(db).update_survey(
tenant_id, survey_id, body, actor=user
)
@router.delete("/{survey_id}", response_model=ExperienceSurveyRead)
async def delete_survey(
survey_id: UUID,
tenant_id: UUID = Depends(require_tenant),
db: AsyncSession = Depends(get_db),
user: CurrentUser = Depends(require_permissions(SURVEYS_DELETE)),
):
return await FormsCommands(db).soft_delete_survey(tenant_id, survey_id, actor=user)