e3b5181b19
- Updated comments in LeadsListScreen, MoreScreen, TaskDetailScreen, TaskFormScreen, TasksListScreen, TicketAnalyticsScreen, TicketDetailScreen, TicketsListScreen, ApiService, AuthService, CrashReporting, DealCard, TicketCard, MultiSelectSheet, KanbanColumn, StageStepper, TicketApprovalPanel, TicketPropertiesCard, and TicketTimePanel to improve readability and maintain a consistent style. - Adjusted punctuation and phrasing for better flow and understanding.
149 lines
5.1 KiB
Python
149 lines
5.1 KiB
Python
"""REST endpoints for the business-hours settings page.
|
|
|
|
Routes (all under /api/business-hours/):
|
|
GET /calendar/: fetch (and create-on-demand) the
|
|
org's default calendar with its
|
|
holidays.
|
|
PUT /calendar/<pk>/: admin update of weekday hours,
|
|
timezone, name. Holidays are
|
|
managed via the nested endpoints
|
|
below to keep payloads small.
|
|
POST /calendar/<pk>/holidays/: add a single holiday.
|
|
DELETE /calendar/<pk>/holidays/<hid>/, remove a single holiday.
|
|
"""
|
|
|
|
from datetime import time
|
|
|
|
from django.shortcuts import get_object_or_404
|
|
from rest_framework import status
|
|
from rest_framework.permissions import IsAuthenticated
|
|
from rest_framework.response import Response
|
|
from rest_framework.views import APIView
|
|
|
|
from business_hours.models import BusinessCalendar, BusinessHoliday
|
|
from business_hours.serializers import (
|
|
BusinessCalendarSerializer,
|
|
BusinessHolidaySerializer,
|
|
)
|
|
from common.permissions import HasOrgContext
|
|
|
|
|
|
def _is_admin(profile) -> bool:
|
|
if profile is None:
|
|
return False
|
|
if getattr(profile, "is_admin", False):
|
|
return True
|
|
return getattr(profile, "role", None) == "ADMIN"
|
|
|
|
|
|
def _get_or_create_default(org):
|
|
"""Return the org's default calendar, materializing one if missing.
|
|
|
|
Older orgs created before this migration ran will hit this path the
|
|
first time an admin opens the settings page; the data migration covers
|
|
every org present at deploy time.
|
|
"""
|
|
cal = (
|
|
BusinessCalendar.objects.filter(org=org, is_default=True)
|
|
.prefetch_related("holidays")
|
|
.first()
|
|
)
|
|
if cal is not None:
|
|
return cal
|
|
nine = time(9, 0)
|
|
five = time(17, 0)
|
|
return BusinessCalendar.objects.create(
|
|
org=org,
|
|
name="Default",
|
|
timezone="UTC",
|
|
is_default=True,
|
|
monday_open=nine,
|
|
monday_close=five,
|
|
tuesday_open=nine,
|
|
tuesday_close=five,
|
|
wednesday_open=nine,
|
|
wednesday_close=five,
|
|
thursday_open=nine,
|
|
thursday_close=five,
|
|
friday_open=nine,
|
|
friday_close=five,
|
|
)
|
|
|
|
|
|
class BusinessCalendarView(APIView):
|
|
"""GET (everyone) / PUT (admin) the org's default BusinessCalendar."""
|
|
|
|
permission_classes = (IsAuthenticated, HasOrgContext)
|
|
|
|
def get(self, request, *args, **kwargs):
|
|
cal = _get_or_create_default(request.profile.org)
|
|
return Response(BusinessCalendarSerializer(cal).data)
|
|
|
|
def put(self, request, pk, *args, **kwargs):
|
|
if not _is_admin(request.profile):
|
|
return Response(
|
|
{"error": "Only admins can update business hours."},
|
|
status=status.HTTP_403_FORBIDDEN,
|
|
)
|
|
cal = get_object_or_404(BusinessCalendar, pk=pk, org=request.profile.org)
|
|
serializer = BusinessCalendarSerializer(cal, data=request.data, partial=True)
|
|
serializer.is_valid(raise_exception=True)
|
|
serializer.save()
|
|
# Re-fetch to include the prefetched holidays in the response.
|
|
cal.refresh_from_db()
|
|
return Response(BusinessCalendarSerializer(cal).data)
|
|
|
|
|
|
class BusinessHolidayListView(APIView):
|
|
"""POST a holiday for the calendar (admin-only)."""
|
|
|
|
permission_classes = (IsAuthenticated, HasOrgContext)
|
|
|
|
def post(self, request, pk, *args, **kwargs):
|
|
if not _is_admin(request.profile):
|
|
return Response(
|
|
{"error": "Only admins can update business hours."},
|
|
status=status.HTTP_403_FORBIDDEN,
|
|
)
|
|
cal = get_object_or_404(BusinessCalendar, pk=pk, org=request.profile.org)
|
|
serializer = BusinessHolidaySerializer(data=request.data)
|
|
serializer.is_valid(raise_exception=True)
|
|
# Idempotent on (calendar, date): swallow duplicate.
|
|
existing = BusinessHoliday.objects.filter(
|
|
calendar=cal, date=serializer.validated_data["date"]
|
|
).first()
|
|
if existing is not None:
|
|
return Response(
|
|
BusinessHolidaySerializer(existing).data,
|
|
status=status.HTTP_200_OK,
|
|
)
|
|
holiday = BusinessHoliday.objects.create(
|
|
calendar=cal,
|
|
org=cal.org,
|
|
**serializer.validated_data,
|
|
)
|
|
return Response(
|
|
BusinessHolidaySerializer(holiday).data,
|
|
status=status.HTTP_201_CREATED,
|
|
)
|
|
|
|
|
|
class BusinessHolidayDetailView(APIView):
|
|
"""DELETE a single holiday (admin-only)."""
|
|
|
|
permission_classes = (IsAuthenticated, HasOrgContext)
|
|
|
|
def delete(self, request, pk, hid, *args, **kwargs):
|
|
if not _is_admin(request.profile):
|
|
return Response(
|
|
{"error": "Only admins can update business hours."},
|
|
status=status.HTTP_403_FORBIDDEN,
|
|
)
|
|
holiday = get_object_or_404(
|
|
BusinessHoliday,
|
|
pk=hid,
|
|
calendar_id=pk,
|
|
org=request.profile.org,
|
|
)
|
|
holiday.delete()
|
|
return Response(status=status.HTTP_204_NO_CONTENT)
|